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