Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/drivers/BusIn.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

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