Mateusz Kowalik / Application_danix

,,

Fork of Application by Daniel Sygut

mbed-dev/drivers/BusIn.h@10:41552d038a69, 2017-01-10 (annotated)

Committer:
Zaitsev
Date:
Tue Jan 10 20:42:26 2017 +0000
Revision:
10:41552d038a69
USB Serial bi-directional bridge

Who changed what in which revision?

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