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@160:5571c4ff569f, 2018-01-17 (annotated)

Committer:
Anna Bridge
Date:
Wed Jan 17 16:13:02 2018 +0000
Revision:
160:5571c4ff569f
Parent:
156:ff21514d8981
Child:
170:e95d10626187
mbed library. Release version 158

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