Thomas Lyp / DevLibMemoryController

Initial commit

Dependencies:   FastPWM

mbed-dev-master/drivers/BusIn.h@0:bb348c97df44, 2020-09-16 (annotated)

Committer:
lypinator
Date:
Wed Sep 16 01:11:49 2020 +0000
Revision:
0:bb348c97df44
Added PWM

Who changed what in which revision?

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