Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/mbed-dev-bin/BusIn.h@0:b9164b348919, 2016-10-17 (annotated)

Committer:
MrBedfordVan
Date:
Mon Oct 17 12:41:20 2016 +0000
Revision:
0:b9164b348919
Official Sheffield ARMBand Micro:bit program

Who changed what in which revision?

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