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@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
188:bcfe06ba3d64 
mbed library release version 165

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