mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/drivers/BusIn.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

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