Jhon Plantikow / mbed

.

Dependents:   RTC

BusIn.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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