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@172:65be27845400, 2019-02-20 (annotated)

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