Pedro Correia / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

drivers/BusInOut.h@187:fa51feb62426, 2018-10-09 (annotated)

Committer:
pmcorreia
Date:
Tue Oct 09 14:42:37 2018 +0000
Revision:
187:fa51feb62426
Parent:
168:9672193075cf 
Updated version to work with F446RE

Who changed what in which revision?

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