mbed library sources change for ST sensors and ST BLE
Fork of mbed-src by
cpp/PortOut.h
- Committer:
- mbed_official
- Date:
- 2012-11-20
- Revision:
- 0:fd0d7bdfcdc2
- Child:
- 2:143cac498751
File content as of revision 0:fd0d7bdfcdc2:
/* mbed Microcontroller Library * Copyright (c) 2006-2012 ARM Limited * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ #ifndef MBED_PORTOUT_H #define MBED_PORTOUT_H #include "platform.h" #if DEVICE_PORTOUT #include "port_api.h" namespace mbed { /** A multiple pin digital out * * Example: * @code * // Toggle all four LEDs * * #include "mbed.h" * * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23 * #define LED_MASK 0x00B40000 * * PortOut ledport(Port1, LED_MASK); * * int main() { * while(1) { * ledport = LED_MASK; * wait(1); * ledport = 0; * wait(1); * } * } * @endcode */ class PortOut { public: /** Create an PortOut, connected to the specified port * * @param port Port to connect to (Port0-Port5) * @param mask A bitmask to identify which bits in the port should be included (0 - ignore) */ PortOut(PortName port, int mask = 0xFFFFFFFF) { port_init(&_port, port, mask, PIN_OUTPUT); } /** Write the value to the output port * * @param value An integer specifying a bit to write for every corresponding PortOut pin */ void write(int value) { port_write(&_port, value); } /** Read the value currently output on the port * * @returns * An integer with each bit corresponding to associated PortOut pin setting */ int read() { return port_read(&_port); } /** A shorthand for write() */ PortOut& operator= (int value) { write(value); return *this; } PortOut& operator= (PortOut& rhs) { write(rhs.read()); return *this; } /** A shorthand for read() */ operator int() { return read(); } private: port_t _port; }; } // namespace mbed #endif #endif