Kev Mann / mbed-dev-OS5_10_4

RTC auf true

drivers/BusIn.h@0:38ceb79fef03, 2018-11-28 (annotated)

Committer:
kevman
Date:
Wed Nov 28 15:10:15 2018 +0000
Revision:
0:38ceb79fef03
RTC modified

Who changed what in which revision?

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