Bob Seque / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/BusIn.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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