mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

cmsis/BUILD/mbed/drivers/PortOut.h@189:f392fc9709a3, 2019-02-20 (annotated)

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

Who changed what in which revision?

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