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/PortInOut.h@170:e95d10626187, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:39:34 2018 +0100
Revision:
170:e95d10626187
Parent:
156:ff21514d8981
Child:
172:65be27845400
mbed library. Release version 163

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_PORTINOUT_H
AnnaBridge 156:ff21514d8981 17 #define MBED_PORTINOUT_H
AnnaBridge 156:ff21514d8981 18
AnnaBridge 156:ff21514d8981 19 #include "platform/platform.h"
AnnaBridge 156:ff21514d8981 20
AnnaBridge 156:ff21514d8981 21 #if defined (DEVICE_PORTINOUT) || 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
AnnaBridge 156:ff21514d8981 29 /** A multiple pin digital in/out used to set/read multiple bi-directional pins
AnnaBridge 156:ff21514d8981 30 *
AnnaBridge 156:ff21514d8981 31 * @note Synchronization level: Interrupt safe
AnnaBridge 156:ff21514d8981 32 * @ingroup drivers
AnnaBridge 156:ff21514d8981 33 */
AnnaBridge 156:ff21514d8981 34 class PortInOut {
AnnaBridge 156:ff21514d8981 35 public:
AnnaBridge 156:ff21514d8981 36
AnnaBridge 156:ff21514d8981 37 /** Create an PortInOut, connected to the specified port
AnnaBridge 156:ff21514d8981 38 *
AnnaBridge 156:ff21514d8981 39 * @param port Port to connect to (Port0-Port5)
AnnaBridge 156:ff21514d8981 40 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
AnnaBridge 156:ff21514d8981 41 */
AnnaBridge 170:e95d10626187 42 PortInOut(PortName port, int mask = 0xFFFFFFFF)
AnnaBridge 170:e95d10626187 43 {
AnnaBridge 156:ff21514d8981 44 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 45 port_init(&_port, port, mask, PIN_INPUT);
AnnaBridge 156:ff21514d8981 46 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 47 }
AnnaBridge 156:ff21514d8981 48
AnnaBridge 156:ff21514d8981 49 /** Write the value to the output port
AnnaBridge 156:ff21514d8981 50 *
AnnaBridge 156:ff21514d8981 51 * @param value An integer specifying a bit to write for every corresponding port pin
AnnaBridge 156:ff21514d8981 52 */
AnnaBridge 170:e95d10626187 53 void write(int value)
AnnaBridge 170:e95d10626187 54 {
AnnaBridge 156:ff21514d8981 55 port_write(&_port, value);
AnnaBridge 156:ff21514d8981 56 }
AnnaBridge 156:ff21514d8981 57
AnnaBridge 156:ff21514d8981 58 /** Read the value currently output on the port
AnnaBridge 156:ff21514d8981 59 *
AnnaBridge 156:ff21514d8981 60 * @returns
AnnaBridge 156:ff21514d8981 61 * An integer with each bit corresponding to associated port pin setting
AnnaBridge 156:ff21514d8981 62 */
AnnaBridge 170:e95d10626187 63 int read()
AnnaBridge 170:e95d10626187 64 {
AnnaBridge 156:ff21514d8981 65 return port_read(&_port);
AnnaBridge 156:ff21514d8981 66 }
AnnaBridge 156:ff21514d8981 67
AnnaBridge 156:ff21514d8981 68 /** Set as an output
AnnaBridge 156:ff21514d8981 69 */
AnnaBridge 170:e95d10626187 70 void output()
AnnaBridge 170:e95d10626187 71 {
AnnaBridge 156:ff21514d8981 72 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 73 port_dir(&_port, PIN_OUTPUT);
AnnaBridge 156:ff21514d8981 74 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 75 }
AnnaBridge 156:ff21514d8981 76
AnnaBridge 156:ff21514d8981 77 /** Set as an input
AnnaBridge 156:ff21514d8981 78 */
AnnaBridge 170:e95d10626187 79 void input()
AnnaBridge 170:e95d10626187 80 {
AnnaBridge 156:ff21514d8981 81 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 82 port_dir(&_port, PIN_INPUT);
AnnaBridge 156:ff21514d8981 83 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 84 }
AnnaBridge 156:ff21514d8981 85
AnnaBridge 156:ff21514d8981 86 /** Set the input pin mode
AnnaBridge 156:ff21514d8981 87 *
AnnaBridge 156:ff21514d8981 88 * @param mode PullUp, PullDown, PullNone, OpenDrain
AnnaBridge 156:ff21514d8981 89 */
AnnaBridge 170:e95d10626187 90 void mode(PinMode mode)
AnnaBridge 170:e95d10626187 91 {
AnnaBridge 156:ff21514d8981 92 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 93 port_mode(&_port, mode);
AnnaBridge 156:ff21514d8981 94 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 95 }
AnnaBridge 156:ff21514d8981 96
AnnaBridge 156:ff21514d8981 97 /** A shorthand for write()
AnnaBridge 156:ff21514d8981 98 * \sa PortInOut::write()
AnnaBridge 156:ff21514d8981 99 */
AnnaBridge 170:e95d10626187 100 PortInOut &operator= (int value)
AnnaBridge 170:e95d10626187 101 {
AnnaBridge 156:ff21514d8981 102 write(value);
AnnaBridge 156:ff21514d8981 103 return *this;
AnnaBridge 156:ff21514d8981 104 }
AnnaBridge 156:ff21514d8981 105
AnnaBridge 156:ff21514d8981 106 /** A shorthand for write()
AnnaBridge 156:ff21514d8981 107 * \sa PortInOut::write()
AnnaBridge 156:ff21514d8981 108 */
AnnaBridge 170:e95d10626187 109 PortInOut &operator= (PortInOut &rhs)
AnnaBridge 170:e95d10626187 110 {
AnnaBridge 156:ff21514d8981 111 write(rhs.read());
AnnaBridge 156:ff21514d8981 112 return *this;
AnnaBridge 156:ff21514d8981 113 }
AnnaBridge 156:ff21514d8981 114
AnnaBridge 156:ff21514d8981 115 /** A shorthand for read()
AnnaBridge 156:ff21514d8981 116 * \sa PortInOut::read()
AnnaBridge 156:ff21514d8981 117 */
AnnaBridge 170:e95d10626187 118 operator int()
AnnaBridge 170:e95d10626187 119 {
AnnaBridge 156:ff21514d8981 120 return read();
AnnaBridge 156:ff21514d8981 121 }
AnnaBridge 156:ff21514d8981 122
AnnaBridge 156:ff21514d8981 123 private:
AnnaBridge 156:ff21514d8981 124 port_t _port;
AnnaBridge 156:ff21514d8981 125 };
AnnaBridge 156:ff21514d8981 126
AnnaBridge 156:ff21514d8981 127 } // namespace mbed
AnnaBridge 156:ff21514d8981 128
AnnaBridge 156:ff21514d8981 129 #endif
AnnaBridge 156:ff21514d8981 130
AnnaBridge 156:ff21514d8981 131 #endif