Bei Chen Liu / mbed-src

mbed library sources

Fork of mbed-src by mbed official

cpp/PortOut.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
2:143cac498751
mbed sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:fd0d7bdfcdc2 1 /* mbed Microcontroller Library
mbed_official 0:fd0d7bdfcdc2 2 * Copyright (c) 2006-2012 ARM Limited
mbed_official 0:fd0d7bdfcdc2 3 *
mbed_official 0:fd0d7bdfcdc2 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
mbed_official 0:fd0d7bdfcdc2 5 * of this software and associated documentation files (the "Software"), to deal
mbed_official 0:fd0d7bdfcdc2 6 * in the Software without restriction, including without limitation the rights
mbed_official 0:fd0d7bdfcdc2 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
mbed_official 0:fd0d7bdfcdc2 8 * copies of the Software, and to permit persons to whom the Software is
mbed_official 0:fd0d7bdfcdc2 9 * furnished to do so, subject to the following conditions:
mbed_official 0:fd0d7bdfcdc2 10 *
mbed_official 0:fd0d7bdfcdc2 11 * The above copyright notice and this permission notice shall be included in
mbed_official 0:fd0d7bdfcdc2 12 * all copies or substantial portions of the Software.
mbed_official 0:fd0d7bdfcdc2 13 *
mbed_official 0:fd0d7bdfcdc2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
mbed_official 0:fd0d7bdfcdc2 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mbed_official 0:fd0d7bdfcdc2 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mbed_official 0:fd0d7bdfcdc2 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mbed_official 0:fd0d7bdfcdc2 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:fd0d7bdfcdc2 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
mbed_official 0:fd0d7bdfcdc2 20 * SOFTWARE.
mbed_official 0:fd0d7bdfcdc2 21 */
mbed_official 0:fd0d7bdfcdc2 22 #ifndef MBED_PORTOUT_H
mbed_official 0:fd0d7bdfcdc2 23 #define MBED_PORTOUT_H
mbed_official 0:fd0d7bdfcdc2 24
mbed_official 0:fd0d7bdfcdc2 25 #include "platform.h"
mbed_official 0:fd0d7bdfcdc2 26
mbed_official 0:fd0d7bdfcdc2 27 #if DEVICE_PORTOUT
mbed_official 0:fd0d7bdfcdc2 28
mbed_official 0:fd0d7bdfcdc2 29 #include "port_api.h"
mbed_official 0:fd0d7bdfcdc2 30
mbed_official 0:fd0d7bdfcdc2 31 namespace mbed {
mbed_official 0:fd0d7bdfcdc2 32 /** A multiple pin digital out
mbed_official 0:fd0d7bdfcdc2 33 *
mbed_official 0:fd0d7bdfcdc2 34 * Example:
mbed_official 0:fd0d7bdfcdc2 35 * @code
mbed_official 0:fd0d7bdfcdc2 36 * // Toggle all four LEDs
mbed_official 0:fd0d7bdfcdc2 37 *
mbed_official 0:fd0d7bdfcdc2 38 * #include "mbed.h"
mbed_official 0:fd0d7bdfcdc2 39 *
mbed_official 0:fd0d7bdfcdc2 40 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
mbed_official 0:fd0d7bdfcdc2 41 * #define LED_MASK 0x00B40000
mbed_official 0:fd0d7bdfcdc2 42 *
mbed_official 0:fd0d7bdfcdc2 43 * PortOut ledport(Port1, LED_MASK);
mbed_official 0:fd0d7bdfcdc2 44 *
mbed_official 0:fd0d7bdfcdc2 45 * int main() {
mbed_official 0:fd0d7bdfcdc2 46 * while(1) {
mbed_official 0:fd0d7bdfcdc2 47 * ledport = LED_MASK;
mbed_official 0:fd0d7bdfcdc2 48 * wait(1);
mbed_official 0:fd0d7bdfcdc2 49 * ledport = 0;
mbed_official 0:fd0d7bdfcdc2 50 * wait(1);
mbed_official 0:fd0d7bdfcdc2 51 * }
mbed_official 0:fd0d7bdfcdc2 52 * }
mbed_official 0:fd0d7bdfcdc2 53 * @endcode
mbed_official 0:fd0d7bdfcdc2 54 */
mbed_official 0:fd0d7bdfcdc2 55 class PortOut {
mbed_official 0:fd0d7bdfcdc2 56 public:
mbed_official 0:fd0d7bdfcdc2 57
mbed_official 0:fd0d7bdfcdc2 58 /** Create an PortOut, connected to the specified port
mbed_official 0:fd0d7bdfcdc2 59 *
mbed_official 0:fd0d7bdfcdc2 60 * @param port Port to connect to (Port0-Port5)
mbed_official 0:fd0d7bdfcdc2 61 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
mbed_official 0:fd0d7bdfcdc2 62 */
mbed_official 0:fd0d7bdfcdc2 63 PortOut(PortName port, int mask = 0xFFFFFFFF) {
mbed_official 0:fd0d7bdfcdc2 64 port_init(&_port, port, mask, PIN_OUTPUT);
mbed_official 0:fd0d7bdfcdc2 65 }
mbed_official 0:fd0d7bdfcdc2 66
mbed_official 0:fd0d7bdfcdc2 67 /** Write the value to the output port
mbed_official 0:fd0d7bdfcdc2 68 *
mbed_official 0:fd0d7bdfcdc2 69 * @param value An integer specifying a bit to write for every corresponding PortOut pin
mbed_official 0:fd0d7bdfcdc2 70 */
mbed_official 0:fd0d7bdfcdc2 71 void write(int value) {
mbed_official 0:fd0d7bdfcdc2 72 port_write(&_port, value);
mbed_official 0:fd0d7bdfcdc2 73 }
mbed_official 0:fd0d7bdfcdc2 74
mbed_official 0:fd0d7bdfcdc2 75 /** Read the value currently output on the port
mbed_official 0:fd0d7bdfcdc2 76 *
mbed_official 0:fd0d7bdfcdc2 77 * @returns
mbed_official 0:fd0d7bdfcdc2 78 * An integer with each bit corresponding to associated PortOut pin setting
mbed_official 0:fd0d7bdfcdc2 79 */
mbed_official 0:fd0d7bdfcdc2 80 int read() {
mbed_official 0:fd0d7bdfcdc2 81 return port_read(&_port);
mbed_official 0:fd0d7bdfcdc2 82 }
mbed_official 0:fd0d7bdfcdc2 83
mbed_official 0:fd0d7bdfcdc2 84 /** A shorthand for write()
mbed_official 0:fd0d7bdfcdc2 85 */
mbed_official 0:fd0d7bdfcdc2 86 PortOut& operator= (int value) {
mbed_official 0:fd0d7bdfcdc2 87 write(value);
mbed_official 0:fd0d7bdfcdc2 88 return *this;
mbed_official 0:fd0d7bdfcdc2 89 }
mbed_official 0:fd0d7bdfcdc2 90
mbed_official 0:fd0d7bdfcdc2 91 PortOut& operator= (PortOut& rhs) {
mbed_official 0:fd0d7bdfcdc2 92 write(rhs.read());
mbed_official 0:fd0d7bdfcdc2 93 return *this;
mbed_official 0:fd0d7bdfcdc2 94 }
mbed_official 0:fd0d7bdfcdc2 95
mbed_official 0:fd0d7bdfcdc2 96 /** A shorthand for read()
mbed_official 0:fd0d7bdfcdc2 97 */
mbed_official 0:fd0d7bdfcdc2 98 operator int() {
mbed_official 0:fd0d7bdfcdc2 99 return read();
mbed_official 0:fd0d7bdfcdc2 100 }
mbed_official 0:fd0d7bdfcdc2 101
mbed_official 0:fd0d7bdfcdc2 102 private:
mbed_official 0:fd0d7bdfcdc2 103 port_t _port;
mbed_official 0:fd0d7bdfcdc2 104 };
mbed_official 0:fd0d7bdfcdc2 105
mbed_official 0:fd0d7bdfcdc2 106 } // namespace mbed
mbed_official 0:fd0d7bdfcdc2 107
mbed_official 0:fd0d7bdfcdc2 108 #endif
mbed_official 0:fd0d7bdfcdc2 109
mbed_official 0:fd0d7bdfcdc2 110 #endif