Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/BusIn.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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