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/BusInOut.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_BUSINOUT_H
AnnaBridge 156:ff21514d8981 18 #define MBED_BUSINOUT_H
AnnaBridge 156:ff21514d8981 19
AnnaBridge 156:ff21514d8981 20 #include "drivers/DigitalInOut.h"
AnnaBridge 156:ff21514d8981 21 #include "platform/PlatformMutex.h"
AnnaBridge 156:ff21514d8981 22 #include "platform/NonCopyable.h"
AnnaBridge 156:ff21514d8981 23
AnnaBridge 156:ff21514d8981 24 namespace mbed {
AnnaBridge 156:ff21514d8981 25 /** \addtogroup drivers */
AnnaBridge 156:ff21514d8981 26
AnnaBridge 156:ff21514d8981 27 /** A digital input output bus, used for setting the state of a collection of pins
AnnaBridge 156:ff21514d8981 28 *
AnnaBridge 156:ff21514d8981 29 * @note Synchronization level: Thread safe
AnnaBridge 156:ff21514d8981 30 * @ingroup drivers
AnnaBridge 156:ff21514d8981 31 */
AnnaBridge 156:ff21514d8981 32 class BusInOut : private NonCopyable<BusInOut> {
AnnaBridge 156:ff21514d8981 33
AnnaBridge 156:ff21514d8981 34 public:
AnnaBridge 156:ff21514d8981 35
AnnaBridge 156:ff21514d8981 36 /** Create an BusInOut, connected to the specified pins
AnnaBridge 156:ff21514d8981 37 *
AnnaBridge 156:ff21514d8981 38 * @param p0 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 39 * @param p1 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 40 * @param p2 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 41 * @param p3 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 42 * @param p4 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 43 * @param p5 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 44 * @param p6 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 45 * @param p7 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 46 * @param p8 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 47 * @param p9 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 48 * @param p10 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 49 * @param p11 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 50 * @param p12 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 51 * @param p13 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 52 * @param p14 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 53 * @param p15 DigitalInOut pin to connect to bus bit
AnnaBridge 156:ff21514d8981 54 *
AnnaBridge 156:ff21514d8981 55 * @note
AnnaBridge 156:ff21514d8981 56 * It is only required to specify as many pin variables as is required
AnnaBridge 156:ff21514d8981 57 * for the bus; the rest will default to NC (not connected)
AnnaBridge 156:ff21514d8981 58 */
AnnaBridge 156:ff21514d8981 59 BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
AnnaBridge 156:ff21514d8981 60 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
AnnaBridge 156:ff21514d8981 61 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
AnnaBridge 156:ff21514d8981 62 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
AnnaBridge 156:ff21514d8981 63
AnnaBridge 156:ff21514d8981 64 /** Create an BusInOut, connected to the specified pins
AnnaBridge 156:ff21514d8981 65 *
AnnaBridge 156:ff21514d8981 66 * @param pins An array of pins to construct a BusInOut from
AnnaBridge 156:ff21514d8981 67 */
AnnaBridge 156:ff21514d8981 68 BusInOut(PinName pins[16]);
AnnaBridge 156:ff21514d8981 69
AnnaBridge 156:ff21514d8981 70 virtual ~BusInOut();
AnnaBridge 156:ff21514d8981 71
AnnaBridge 156:ff21514d8981 72 /* Group: Access Methods */
AnnaBridge 156:ff21514d8981 73
AnnaBridge 156:ff21514d8981 74 /** Write the value to the output bus
AnnaBridge 156:ff21514d8981 75 *
AnnaBridge 156:ff21514d8981 76 * @param value An integer specifying a bit to write for every corresponding DigitalInOut pin
AnnaBridge 156:ff21514d8981 77 */
AnnaBridge 156:ff21514d8981 78 void write(int value);
AnnaBridge 156:ff21514d8981 79
AnnaBridge 156:ff21514d8981 80 /** Read the value currently output on the bus
AnnaBridge 156:ff21514d8981 81 *
AnnaBridge 156:ff21514d8981 82 * @returns
AnnaBridge 156:ff21514d8981 83 * An integer with each bit corresponding to associated DigitalInOut pin setting
AnnaBridge 156:ff21514d8981 84 */
AnnaBridge 156:ff21514d8981 85 int read();
AnnaBridge 156:ff21514d8981 86
AnnaBridge 172:65be27845400 87 /** Set all the pins in bus as output
AnnaBridge 156:ff21514d8981 88 */
AnnaBridge 156:ff21514d8981 89 void output();
AnnaBridge 156:ff21514d8981 90
AnnaBridge 172:65be27845400 91 /** Set all the pins in bus as an input
AnnaBridge 156:ff21514d8981 92 */
AnnaBridge 156:ff21514d8981 93 void input();
AnnaBridge 156:ff21514d8981 94
AnnaBridge 172:65be27845400 95 /** Set the input pin mode for all the pins in bus
AnnaBridge 156:ff21514d8981 96 *
AnnaBridge 156:ff21514d8981 97 * @param pull PullUp, PullDown, PullNone
AnnaBridge 156:ff21514d8981 98 */
AnnaBridge 156:ff21514d8981 99 void mode(PinMode pull);
AnnaBridge 156:ff21514d8981 100
AnnaBridge 156:ff21514d8981 101 /** Binary mask of bus pins connected to actual pins (not NC pins)
AnnaBridge 156:ff21514d8981 102 * If bus pin is in NC state make corresponding bit will be cleared (set to 0), else bit will be set to 1
AnnaBridge 156:ff21514d8981 103 *
AnnaBridge 156:ff21514d8981 104 * @returns
AnnaBridge 156:ff21514d8981 105 * Binary mask of connected pins
AnnaBridge 156:ff21514d8981 106 */
AnnaBridge 170:e95d10626187 107 int mask()
AnnaBridge 170:e95d10626187 108 {
AnnaBridge 156:ff21514d8981 109 // No lock needed since _nc_mask is not modified outside the constructor
AnnaBridge 156:ff21514d8981 110 return _nc_mask;
AnnaBridge 156:ff21514d8981 111 }
AnnaBridge 156:ff21514d8981 112
AnnaBridge 170:e95d10626187 113 /** A shorthand for write()
AnnaBridge 156:ff21514d8981 114 * \sa BusInOut::write()
AnnaBridge 170:e95d10626187 115 */
AnnaBridge 170:e95d10626187 116 BusInOut &operator= (int v);
AnnaBridge 170:e95d10626187 117 BusInOut &operator= (BusInOut &rhs);
AnnaBridge 156:ff21514d8981 118
AnnaBridge 156:ff21514d8981 119 /** Access to particular bit in random-iterator fashion
AnnaBridge 156:ff21514d8981 120 * @param index Bit Position
AnnaBridge 156:ff21514d8981 121 */
AnnaBridge 170:e95d10626187 122 DigitalInOut &operator[](int index);
AnnaBridge 156:ff21514d8981 123
AnnaBridge 156:ff21514d8981 124 /** A shorthand for read()
AnnaBridge 156:ff21514d8981 125 * \sa BusInOut::read()
AnnaBridge 156:ff21514d8981 126 */
AnnaBridge 156:ff21514d8981 127 operator int();
AnnaBridge 172:65be27845400 128 #if !defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 129 protected:
AnnaBridge 156:ff21514d8981 130 virtual void lock();
AnnaBridge 156:ff21514d8981 131 virtual void unlock();
AnnaBridge 170:e95d10626187 132 DigitalInOut *_pin[16];
AnnaBridge 156:ff21514d8981 133
AnnaBridge 156:ff21514d8981 134 /* Mask of bus's NC pins
AnnaBridge 156:ff21514d8981 135 * If bit[n] is set to 1 - pin is connected
AnnaBridge 156:ff21514d8981 136 * if bit[n] is cleared - pin is not connected (NC)
AnnaBridge 156:ff21514d8981 137 */
AnnaBridge 156:ff21514d8981 138 int _nc_mask;
AnnaBridge 156:ff21514d8981 139
AnnaBridge 156:ff21514d8981 140 PlatformMutex _mutex;
AnnaBridge 172:65be27845400 141 #endif
AnnaBridge 156:ff21514d8981 142 };
AnnaBridge 156:ff21514d8981 143
AnnaBridge 156:ff21514d8981 144 } // namespace mbed
AnnaBridge 156:ff21514d8981 145
AnnaBridge 156:ff21514d8981 146 #endif