Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
PortOut.h
00001 /* mbed Microcontroller Library 00002 * Copyright (c) 2006-2013 ARM Limited 00003 * 00004 * Permission is hereby granted, free of charge, to any person obtaining a copy 00005 * of this software and associated documentation files (the "Software"), to deal 00006 * in the Software without restriction, including without limitation the rights 00007 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 00008 * copies of the Software, and to permit persons to whom the Software is 00009 * furnished to do so, subject to the following conditions: 00010 * 00011 * The above copyright notice and this permission notice shall be included in 00012 * all copies or substantial portions of the Software. 00013 * 00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 00015 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 00016 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 00017 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 00018 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 00019 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 00020 * SOFTWARE. 00021 */ 00022 #ifndef MBED_PORTOUT_H 00023 #define MBED_PORTOUT_H 00024 00025 #include "platform.h" 00026 00027 #if DEVICE_PORTOUT 00028 00029 #include "port_api.h" 00030 00031 namespace mbed { 00032 /** A multiple pin digital out 00033 * 00034 * Example: 00035 * @code 00036 * // Toggle all four LEDs 00037 * 00038 * #include "mbed.h" 00039 * 00040 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23 00041 * #define LED_MASK 0x00B40000 00042 * 00043 * PortOut ledport(Port1, LED_MASK); 00044 * 00045 * int main() { 00046 * while(1) { 00047 * ledport = LED_MASK; 00048 * wait(1); 00049 * ledport = 0; 00050 * wait(1); 00051 * } 00052 * } 00053 * @endcode 00054 */ 00055 class PortOut { 00056 public: 00057 00058 /** Create an PortOut, connected to the specified port 00059 * 00060 * @param port Port to connect to (Port0-Port5) 00061 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore) 00062 */ 00063 PortOut(PortName port, int mask = 0xFFFFFFFF) { 00064 port_init(&_port, port, mask, PIN_OUTPUT); 00065 } 00066 00067 /** Write the value to the output port 00068 * 00069 * @param value An integer specifying a bit to write for every corresponding PortOut pin 00070 */ 00071 void write(int value) { 00072 port_write(&_port, value); 00073 } 00074 00075 /** Read the value currently output on the port 00076 * 00077 * @returns 00078 * An integer with each bit corresponding to associated PortOut pin setting 00079 */ 00080 int read() { 00081 return port_read(&_port); 00082 } 00083 00084 /** A shorthand for write() 00085 */ 00086 PortOut& operator= (int value) { 00087 write(value); 00088 return *this; 00089 } 00090 00091 PortOut& operator= (PortOut& rhs) { 00092 write(rhs.read()); 00093 return *this; 00094 } 00095 00096 /** A shorthand for read() 00097 */ 00098 operator int() { 00099 return read(); 00100 } 00101 00102 private: 00103 port_t _port; 00104 }; 00105 00106 } // namespace mbed 00107 00108 #endif 00109 00110 #endif 00111
Generated on Wed Jul 13 2022 02:59:12 by
