lzbp li / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/BusIn.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 10:3bc89ef62ce7 1 /* mbed Microcontroller Library
emilmont 10:3bc89ef62ce7 2 * Copyright (c) 2006-2013 ARM Limited
emilmont 10:3bc89ef62ce7 3 *
emilmont 10:3bc89ef62ce7 4 * Licensed under the Apache License, Version 2.0 (the "License");
emilmont 10:3bc89ef62ce7 5 * you may not use this file except in compliance with the License.
emilmont 10:3bc89ef62ce7 6 * You may obtain a copy of the License at
emilmont 10:3bc89ef62ce7 7 *
emilmont 10:3bc89ef62ce7 8 * http://www.apache.org/licenses/LICENSE-2.0
emilmont 10:3bc89ef62ce7 9 *
emilmont 10:3bc89ef62ce7 10 * Unless required by applicable law or agreed to in writing, software
emilmont 10:3bc89ef62ce7 11 * distributed under the License is distributed on an "AS IS" BASIS,
emilmont 10:3bc89ef62ce7 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
emilmont 10:3bc89ef62ce7 13 * See the License for the specific language governing permissions and
emilmont 10:3bc89ef62ce7 14 * limitations under the License.
emilmont 10:3bc89ef62ce7 15 */
emilmont 10:3bc89ef62ce7 16 #ifndef MBED_BUSIN_H
emilmont 10:3bc89ef62ce7 17 #define MBED_BUSIN_H
emilmont 10:3bc89ef62ce7 18
emilmont 10:3bc89ef62ce7 19 #include "platform.h"
emilmont 10:3bc89ef62ce7 20 #include "DigitalIn.h"
emilmont 10:3bc89ef62ce7 21
emilmont 10:3bc89ef62ce7 22 namespace mbed {
emilmont 10:3bc89ef62ce7 23
emilmont 10:3bc89ef62ce7 24 /** A digital input bus, used for reading the state of a collection of pins
emilmont 10:3bc89ef62ce7 25 */
emilmont 10:3bc89ef62ce7 26 class BusIn {
emilmont 10:3bc89ef62ce7 27
emilmont 10:3bc89ef62ce7 28 public:
emilmont 10:3bc89ef62ce7 29 /* Group: Configuration Methods */
emilmont 10:3bc89ef62ce7 30
emilmont 10:3bc89ef62ce7 31 /** Create an BusIn, connected to the specified pins
emilmont 10:3bc89ef62ce7 32 *
emilmont 10:3bc89ef62ce7 33 * @param <n> DigitalIn pin to connect to bus bit <n> (p5-p30, NC)
emilmont 10:3bc89ef62ce7 34 *
emilmont 10:3bc89ef62ce7 35 * @note
emilmont 10:3bc89ef62ce7 36 * It is only required to specify as many pin variables as is required
emilmont 10:3bc89ef62ce7 37 * for the bus; the rest will default to NC (not connected)
emilmont 10:3bc89ef62ce7 38 */
emilmont 10:3bc89ef62ce7 39 BusIn(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
emilmont 10:3bc89ef62ce7 40 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
emilmont 10:3bc89ef62ce7 41 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
emilmont 10:3bc89ef62ce7 42 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
emilmont 10:3bc89ef62ce7 43
emilmont 10:3bc89ef62ce7 44 BusIn(PinName pins[16]);
emilmont 10:3bc89ef62ce7 45
emilmont 10:3bc89ef62ce7 46 virtual ~BusIn();
emilmont 10:3bc89ef62ce7 47
emilmont 10:3bc89ef62ce7 48 /** Read the value of the input bus
emilmont 10:3bc89ef62ce7 49 *
emilmont 10:3bc89ef62ce7 50 * @returns
emilmont 10:3bc89ef62ce7 51 * An integer with each bit corresponding to the value read from the associated DigitalIn pin
emilmont 10:3bc89ef62ce7 52 */
emilmont 10:3bc89ef62ce7 53 int read();
emilmont 10:3bc89ef62ce7 54
emilmont 10:3bc89ef62ce7 55 #ifdef MBED_OPERATORS
emilmont 10:3bc89ef62ce7 56 /** A shorthand for read()
emilmont 10:3bc89ef62ce7 57 */
emilmont 10:3bc89ef62ce7 58 operator int();
emilmont 10:3bc89ef62ce7 59 #endif
emilmont 10:3bc89ef62ce7 60
emilmont 10:3bc89ef62ce7 61 protected:
emilmont 10:3bc89ef62ce7 62 DigitalIn* _pin[16];
emilmont 10:3bc89ef62ce7 63 };
emilmont 10:3bc89ef62ce7 64
emilmont 10:3bc89ef62ce7 65 } // namespace mbed
emilmont 10:3bc89ef62ce7 66
emilmont 10:3bc89ef62ce7 67 #endif