John Karatka / mbed

mbed

Fork of mbed-dev by mbed official

drivers/BusIn.h@149:156823d33999, 2016-10-28 (annotated)

Committer:
<>
Date:
Fri Oct 28 11:17:30 2016 +0100
Revision:
149:156823d33999
Child:
167:e84263d55307
This updates the lib to the mbed lib v128



NOTE: This release includes a restructuring of the file and directory locations and thus some

include paths in your code may need updating accordingly.

Who changed what in which revision?

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