Gan likun / mbed1-dev

001

drivers/BusIn.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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