mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/PortOut.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

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