Christopher Haster / mbed-hal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   target-freescale

Fork of mbed-hal by Morpheus

api/BusIn.h@20:fbc6173aa5b2, 2016-04-06 (annotated)

Committer:
Christopher Haster
Date:
Wed Apr 06 09:41:33 2016 -0500
Revision:
20:fbc6173aa5b2
Parent:
0:9c59db1fbc9e 
Added Binder class for statically allocated function binding

Who changed what in which revision?

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