lzbp li / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/BusIn.h@9:0ce32e54c9a7, 2013-06-10 (annotated)

Committer:
emilmont
Date:
Mon Jun 10 16:03:00 2013 +0100
Revision:
9:0ce32e54c9a7
Parent:
cpp/BusIn.h@2:143cac498751
Child:
10:3bc89ef62ce7
Refactoring of the mbed SDK:

- Provide a well defined HAL and API

- Keep separated the HAL implementations for the different targets

Who changed what in which revision?

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