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@147:a97add6d7e64, 2017-07-19 (annotated)
- Committer:
- Kojto
- Date:
- Wed Jul 19 16:46:19 2017 +0100
- Revision:
- 147:a97add6d7e64
- Parent:
- 146:22da6e220af6
Release 147 of the mbed library.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
<> | 128:9bcdf88f62b0 | 1 | /* mbed Microcontroller Library |
<> | 128:9bcdf88f62b0 | 2 | * Copyright (c) 2006-2013 ARM Limited |
<> | 128:9bcdf88f62b0 | 3 | * |
<> | 128:9bcdf88f62b0 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
<> | 128:9bcdf88f62b0 | 5 | * you may not use this file except in compliance with the License. |
<> | 128:9bcdf88f62b0 | 6 | * You may obtain a copy of the License at |
<> | 128:9bcdf88f62b0 | 7 | * |
<> | 128:9bcdf88f62b0 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
<> | 128:9bcdf88f62b0 | 9 | * |
<> | 128:9bcdf88f62b0 | 10 | * Unless required by applicable law or agreed to in writing, software |
<> | 128:9bcdf88f62b0 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
<> | 128:9bcdf88f62b0 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
<> | 128:9bcdf88f62b0 | 13 | * See the License for the specific language governing permissions and |
<> | 128:9bcdf88f62b0 | 14 | * limitations under the License. |
<> | 128:9bcdf88f62b0 | 15 | */ |
<> | 128:9bcdf88f62b0 | 16 | #ifndef MBED_BUSINOUT_H |
<> | 128:9bcdf88f62b0 | 17 | #define MBED_BUSINOUT_H |
<> | 128:9bcdf88f62b0 | 18 | |
<> | 128:9bcdf88f62b0 | 19 | #include "drivers/DigitalInOut.h" |
<> | 128:9bcdf88f62b0 | 20 | #include "platform/PlatformMutex.h" |
AnnaBridge | 146:22da6e220af6 | 21 | #include "platform/NonCopyable.h" |
<> | 128:9bcdf88f62b0 | 22 | |
<> | 128:9bcdf88f62b0 | 23 | namespace mbed { |
<> | 128:9bcdf88f62b0 | 24 | /** \addtogroup drivers */ |
<> | 128:9bcdf88f62b0 | 25 | |
<> | 128:9bcdf88f62b0 | 26 | /** A digital input output bus, used for setting the state of a collection of pins |
<> | 128:9bcdf88f62b0 | 27 | * |
AnnaBridge | 145:64910690c574 | 28 | * @note Synchronization level: Thread safe |
AnnaBridge | 145:64910690c574 | 29 | * @ingroup drivers |
<> | 128:9bcdf88f62b0 | 30 | */ |
AnnaBridge | 146:22da6e220af6 | 31 | class BusInOut : private NonCopyable<BusInOut> { |
<> | 128:9bcdf88f62b0 | 32 | |
<> | 128:9bcdf88f62b0 | 33 | public: |
<> | 128:9bcdf88f62b0 | 34 | |
<> | 128:9bcdf88f62b0 | 35 | /** Create an BusInOut, connected to the specified pins |
<> | 128:9bcdf88f62b0 | 36 | * |
AnnaBridge | 145:64910690c574 | 37 | * @param p0 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 38 | * @param p1 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 39 | * @param p2 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 40 | * @param p3 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 41 | * @param p4 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 42 | * @param p5 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 43 | * @param p6 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 44 | * @param p7 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 45 | * @param p8 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 46 | * @param p9 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 47 | * @param p10 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 48 | * @param p11 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 49 | * @param p12 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 50 | * @param p13 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 51 | * @param p14 DigitalInOut pin to connect to bus bit |
AnnaBridge | 145:64910690c574 | 52 | * @param p15 DigitalInOut pin to connect to bus bit |
<> | 128:9bcdf88f62b0 | 53 | * |
<> | 128:9bcdf88f62b0 | 54 | * @note |
<> | 128:9bcdf88f62b0 | 55 | * It is only required to specify as many pin variables as is required |
<> | 128:9bcdf88f62b0 | 56 | * for the bus; the rest will default to NC (not connected) |
<> | 128:9bcdf88f62b0 | 57 | */ |
<> | 128:9bcdf88f62b0 | 58 | BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC, |
<> | 128:9bcdf88f62b0 | 59 | PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC, |
<> | 128:9bcdf88f62b0 | 60 | PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC, |
<> | 128:9bcdf88f62b0 | 61 | PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC); |
<> | 128:9bcdf88f62b0 | 62 | |
AnnaBridge | 145:64910690c574 | 63 | /** Create an BusInOut, connected to the specified pins |
AnnaBridge | 145:64910690c574 | 64 | * |
AnnaBridge | 145:64910690c574 | 65 | * @param pins An array of pins to construct a BusInOut from |
AnnaBridge | 145:64910690c574 | 66 | */ |
<> | 128:9bcdf88f62b0 | 67 | BusInOut(PinName pins[16]); |
<> | 128:9bcdf88f62b0 | 68 | |
<> | 128:9bcdf88f62b0 | 69 | virtual ~BusInOut(); |
<> | 128:9bcdf88f62b0 | 70 | |
<> | 128:9bcdf88f62b0 | 71 | /* Group: Access Methods */ |
<> | 128:9bcdf88f62b0 | 72 | |
<> | 128:9bcdf88f62b0 | 73 | /** Write the value to the output bus |
<> | 128:9bcdf88f62b0 | 74 | * |
<> | 128:9bcdf88f62b0 | 75 | * @param value An integer specifying a bit to write for every corresponding DigitalInOut pin |
<> | 128:9bcdf88f62b0 | 76 | */ |
<> | 128:9bcdf88f62b0 | 77 | void write(int value); |
<> | 128:9bcdf88f62b0 | 78 | |
<> | 128:9bcdf88f62b0 | 79 | /** Read the value currently output on the bus |
<> | 128:9bcdf88f62b0 | 80 | * |
<> | 128:9bcdf88f62b0 | 81 | * @returns |
<> | 128:9bcdf88f62b0 | 82 | * An integer with each bit corresponding to associated DigitalInOut pin setting |
<> | 128:9bcdf88f62b0 | 83 | */ |
<> | 128:9bcdf88f62b0 | 84 | int read(); |
<> | 128:9bcdf88f62b0 | 85 | |
<> | 128:9bcdf88f62b0 | 86 | /** Set as an output |
<> | 128:9bcdf88f62b0 | 87 | */ |
<> | 128:9bcdf88f62b0 | 88 | void output(); |
<> | 128:9bcdf88f62b0 | 89 | |
<> | 128:9bcdf88f62b0 | 90 | /** Set as an input |
<> | 128:9bcdf88f62b0 | 91 | */ |
<> | 128:9bcdf88f62b0 | 92 | void input(); |
<> | 128:9bcdf88f62b0 | 93 | |
<> | 128:9bcdf88f62b0 | 94 | /** Set the input pin mode |
<> | 128:9bcdf88f62b0 | 95 | * |
AnnaBridge | 145:64910690c574 | 96 | * @param pull PullUp, PullDown, PullNone |
<> | 128:9bcdf88f62b0 | 97 | */ |
<> | 128:9bcdf88f62b0 | 98 | void mode(PinMode pull); |
<> | 128:9bcdf88f62b0 | 99 | |
<> | 128:9bcdf88f62b0 | 100 | /** Binary mask of bus pins connected to actual pins (not NC pins) |
<> | 128:9bcdf88f62b0 | 101 | * If bus pin is in NC state make corresponding bit will be cleared (set to 0), else bit will be set to 1 |
<> | 128:9bcdf88f62b0 | 102 | * |
<> | 128:9bcdf88f62b0 | 103 | * @returns |
<> | 128:9bcdf88f62b0 | 104 | * Binary mask of connected pins |
<> | 128:9bcdf88f62b0 | 105 | */ |
<> | 128:9bcdf88f62b0 | 106 | int mask() { |
<> | 128:9bcdf88f62b0 | 107 | // No lock needed since _nc_mask is not modified outside the constructor |
<> | 128:9bcdf88f62b0 | 108 | return _nc_mask; |
<> | 128:9bcdf88f62b0 | 109 | } |
<> | 128:9bcdf88f62b0 | 110 | |
<> | 128:9bcdf88f62b0 | 111 | /** A shorthand for write() |
AnnaBridge | 145:64910690c574 | 112 | * \sa BusInOut::write() |
AnnaBridge | 145:64910690c574 | 113 | */ |
<> | 128:9bcdf88f62b0 | 114 | BusInOut& operator= (int v); |
<> | 128:9bcdf88f62b0 | 115 | BusInOut& operator= (BusInOut& rhs); |
<> | 128:9bcdf88f62b0 | 116 | |
<> | 128:9bcdf88f62b0 | 117 | /** Access to particular bit in random-iterator fashion |
AnnaBridge | 145:64910690c574 | 118 | * @param index Bit Position |
AnnaBridge | 145:64910690c574 | 119 | */ |
<> | 128:9bcdf88f62b0 | 120 | DigitalInOut& operator[] (int index); |
<> | 128:9bcdf88f62b0 | 121 | |
<> | 128:9bcdf88f62b0 | 122 | /** A shorthand for read() |
AnnaBridge | 145:64910690c574 | 123 | * \sa BusInOut::read() |
<> | 128:9bcdf88f62b0 | 124 | */ |
<> | 128:9bcdf88f62b0 | 125 | operator int(); |
<> | 128:9bcdf88f62b0 | 126 | |
<> | 128:9bcdf88f62b0 | 127 | protected: |
<> | 128:9bcdf88f62b0 | 128 | virtual void lock(); |
<> | 128:9bcdf88f62b0 | 129 | virtual void unlock(); |
<> | 128:9bcdf88f62b0 | 130 | DigitalInOut* _pin[16]; |
<> | 128:9bcdf88f62b0 | 131 | |
AnnaBridge | 145:64910690c574 | 132 | /* Mask of bus's NC pins |
<> | 128:9bcdf88f62b0 | 133 | * If bit[n] is set to 1 - pin is connected |
<> | 128:9bcdf88f62b0 | 134 | * if bit[n] is cleared - pin is not connected (NC) |
<> | 128:9bcdf88f62b0 | 135 | */ |
<> | 128:9bcdf88f62b0 | 136 | int _nc_mask; |
<> | 128:9bcdf88f62b0 | 137 | |
<> | 128:9bcdf88f62b0 | 138 | PlatformMutex _mutex; |
<> | 128:9bcdf88f62b0 | 139 | }; |
<> | 128:9bcdf88f62b0 | 140 | |
<> | 128:9bcdf88f62b0 | 141 | } // namespace mbed |
<> | 128:9bcdf88f62b0 | 142 | |
<> | 128:9bcdf88f62b0 | 143 | #endif |