Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

BusIn.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

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