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@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?

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