mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

drivers/PortOut.h@188:bcfe06ba3d64, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:46:34 2018 +0000
Revision:
188:bcfe06ba3d64
Parent:
187:0387e8f68319
Child:
189:f392fc9709a3
mbed-dev library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 149:156823d33999 1 /* mbed Microcontroller Library
<> 149:156823d33999 2 * Copyright (c) 2006-2013 ARM Limited
<> 149:156823d33999 3 *
<> 149:156823d33999 4 * Licensed under the Apache License, Version 2.0 (the "License");
<> 149:156823d33999 5 * you may not use this file except in compliance with the License.
<> 149:156823d33999 6 * You may obtain a copy of the License at
<> 149:156823d33999 7 *
<> 149:156823d33999 8 * http://www.apache.org/licenses/LICENSE-2.0
<> 149:156823d33999 9 *
<> 149:156823d33999 10 * Unless required by applicable law or agreed to in writing, software
<> 149:156823d33999 11 * distributed under the License is distributed on an "AS IS" BASIS,
<> 149:156823d33999 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 149:156823d33999 13 * See the License for the specific language governing permissions and
<> 149:156823d33999 14 * limitations under the License.
<> 149:156823d33999 15 */
<> 149:156823d33999 16 #ifndef MBED_PORTOUT_H
<> 149:156823d33999 17 #define MBED_PORTOUT_H
<> 149:156823d33999 18
<> 149:156823d33999 19 #include "platform/platform.h"
<> 149:156823d33999 20
AnnaBridge 167:e84263d55307 21 #if defined (DEVICE_PORTOUT) || defined(DOXYGEN_ONLY)
<> 149:156823d33999 22
<> 149:156823d33999 23 #include "hal/port_api.h"
<> 160:d5399cc887bb 24 #include "platform/mbed_critical.h"
<> 149:156823d33999 25
<> 149:156823d33999 26 namespace mbed {
<> 149:156823d33999 27 /** \addtogroup drivers */
AnnaBridge 188:bcfe06ba3d64 28 /** A multiple pin digital output
<> 149:156823d33999 29 *
AnnaBridge 167:e84263d55307 30 * @note Synchronization level: Interrupt safe
<> 149:156823d33999 31 *
<> 149:156823d33999 32 * Example:
<> 149:156823d33999 33 * @code
<> 149:156823d33999 34 * // Toggle all four LEDs
<> 149:156823d33999 35 *
<> 149:156823d33999 36 * #include "mbed.h"
<> 149:156823d33999 37 *
<> 149:156823d33999 38 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
<> 149:156823d33999 39 * #define LED_MASK 0x00B40000
<> 149:156823d33999 40 *
<> 149:156823d33999 41 * PortOut ledport(Port1, LED_MASK);
<> 149:156823d33999 42 *
<> 149:156823d33999 43 * int main() {
<> 149:156823d33999 44 * while(1) {
<> 149:156823d33999 45 * ledport = LED_MASK;
<> 149:156823d33999 46 * wait(1);
<> 149:156823d33999 47 * ledport = 0;
<> 149:156823d33999 48 * wait(1);
<> 149:156823d33999 49 * }
<> 149:156823d33999 50 * }
<> 149:156823d33999 51 * @endcode
AnnaBridge 167:e84263d55307 52 * @ingroup drivers
<> 149:156823d33999 53 */
<> 149:156823d33999 54 class PortOut {
<> 149:156823d33999 55 public:
<> 149:156823d33999 56
AnnaBridge 188:bcfe06ba3d64 57 /** Create a PortOut, connected to the specified port
<> 149:156823d33999 58 *
AnnaBridge 188:bcfe06ba3d64 59 * @param port Port to connect to (as defined in target's PortNames.h)
AnnaBridge 188:bcfe06ba3d64 60 * @param mask Bitmask defines which port pins are an output (0 - ignore, 1 - include)
<> 149:156823d33999 61 */
AnnaBridge 187:0387e8f68319 62 PortOut(PortName port, int mask = 0xFFFFFFFF)
AnnaBridge 187:0387e8f68319 63 {
<> 149:156823d33999 64 core_util_critical_section_enter();
<> 149:156823d33999 65 port_init(&_port, port, mask, PIN_OUTPUT);
<> 149:156823d33999 66 core_util_critical_section_exit();
<> 149:156823d33999 67 }
<> 149:156823d33999 68
<> 149:156823d33999 69 /** Write the value to the output port
<> 149:156823d33999 70 *
<> 149:156823d33999 71 * @param value An integer specifying a bit to write for every corresponding PortOut pin
<> 149:156823d33999 72 */
AnnaBridge 187:0387e8f68319 73 void write(int value)
AnnaBridge 187:0387e8f68319 74 {
<> 149:156823d33999 75 port_write(&_port, value);
<> 149:156823d33999 76 }
<> 149:156823d33999 77
<> 149:156823d33999 78 /** Read the value currently output on the port
<> 149:156823d33999 79 *
<> 149:156823d33999 80 * @returns
AnnaBridge 188:bcfe06ba3d64 81 * An integer with each bit corresponding to associated pin value
<> 149:156823d33999 82 */
AnnaBridge 187:0387e8f68319 83 int read()
AnnaBridge 187:0387e8f68319 84 {
<> 149:156823d33999 85 return port_read(&_port);
<> 149:156823d33999 86 }
<> 149:156823d33999 87
<> 149:156823d33999 88 /** A shorthand for write()
AnnaBridge 167:e84263d55307 89 * \sa PortOut::write()
<> 149:156823d33999 90 */
AnnaBridge 187:0387e8f68319 91 PortOut &operator= (int value)
AnnaBridge 187:0387e8f68319 92 {
<> 149:156823d33999 93 write(value);
<> 149:156823d33999 94 return *this;
<> 149:156823d33999 95 }
<> 149:156823d33999 96
AnnaBridge 167:e84263d55307 97 /** A shorthand for read()
AnnaBridge 167:e84263d55307 98 * \sa PortOut::read()
AnnaBridge 167:e84263d55307 99 */
AnnaBridge 187:0387e8f68319 100 PortOut &operator= (PortOut &rhs)
AnnaBridge 187:0387e8f68319 101 {
<> 149:156823d33999 102 write(rhs.read());
<> 149:156823d33999 103 return *this;
<> 149:156823d33999 104 }
<> 149:156823d33999 105
<> 149:156823d33999 106 /** A shorthand for read()
AnnaBridge 167:e84263d55307 107 * \sa PortOut::read()
<> 149:156823d33999 108 */
AnnaBridge 187:0387e8f68319 109 operator int()
AnnaBridge 187:0387e8f68319 110 {
<> 149:156823d33999 111 return read();
<> 149:156823d33999 112 }
<> 149:156823d33999 113
<> 149:156823d33999 114 private:
<> 149:156823d33999 115 port_t _port;
<> 149:156823d33999 116 };
<> 149:156823d33999 117
<> 149:156823d33999 118 } // namespace mbed
<> 149:156823d33999 119
<> 149:156823d33999 120 #endif
<> 149:156823d33999 121
<> 149:156823d33999 122 #endif