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@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Parent:
156:ff21514d8981
Child:
170:e95d10626187
Release 155 of the mbed library.

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