Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

BusIn.h@44:24d45a770a51, 2012-11-21 (annotated)

Committer:
emilmont
Date:
Wed Nov 21 10:49:56 2012 +0000
Revision:
44:24d45a770a51
Parent:
43:e2ed12d17f06
Child:
54:71b101360fb9
Complete refactoring of the mbed library to move the target dependent code to a thin well defined layer, defining a proper object oriented C API to be implemented by the different silicon vendors.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 44:24d45a770a51 2 * Copyright (c) 2006-2012 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
simon.ford@mbed.co.uk 0:82220227f4fa 21 */
simon.ford@mbed.co.uk 0:82220227f4fa 22 #ifndef MBED_BUSIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 23 #define MBED_BUSIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 24
rolf.meyer@arm.com 11:1c1ebd0324fa 25 #include "platform.h"
simon.ford@mbed.co.uk 0:82220227f4fa 26 #include "DigitalIn.h"
simon.ford@mbed.co.uk 0:82220227f4fa 27
simon.ford@mbed.co.uk 0:82220227f4fa 28 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 29
emilmont 43:e2ed12d17f06 30 /** A digital input bus, used for reading the state of a collection of pins
simon.ford@mbed.co.uk 0:82220227f4fa 31 */
emilmont 44:24d45a770a51 32 class BusIn {
simon.ford@mbed.co.uk 0:82220227f4fa 33
simon.ford@mbed.co.uk 0:82220227f4fa 34 public:
emilmont 44:24d45a770a51 35 /* Group: Configuration Methods */
simon.ford@mbed.co.uk 0:82220227f4fa 36
emilmont 43:e2ed12d17f06 37 /** Create an BusIn, connected to the specified pins
rolf.meyer@arm.com 11:1c1ebd0324fa 38 *
emilmont 43:e2ed12d17f06 39 * @param <n> DigitalIn pin to connect to bus bit <n> (p5-p30, NC)
simon.ford@mbed.co.uk 0:82220227f4fa 40 *
emilmont 43:e2ed12d17f06 41 * @note
simon.ford@mbed.co.uk 0:82220227f4fa 42 * It is only required to specify as many pin variables as is required
rolf.meyer@arm.com 11:1c1ebd0324fa 43 * for the bus; the rest will default to NC (not connected)
rolf.meyer@arm.com 11:1c1ebd0324fa 44 */
rolf.meyer@arm.com 11:1c1ebd0324fa 45 BusIn(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
rolf.meyer@arm.com 11:1c1ebd0324fa 46 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
rolf.meyer@arm.com 11:1c1ebd0324fa 47 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
emilmont 44:24d45a770a51 48 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
simon.ford@mbed.co.uk 5:62573be585e9 49
emilmont 44:24d45a770a51 50 BusIn(PinName pins[16]);
emilmont 44:24d45a770a51 51
emilmont 43:e2ed12d17f06 52 virtual ~BusIn();
emilmont 44:24d45a770a51 53
emilmont 43:e2ed12d17f06 54 /** Read the value of the input bus
emilmont 43:e2ed12d17f06 55 *
emilmont 43:e2ed12d17f06 56 * @returns
emilmont 43:e2ed12d17f06 57 * An integer with each bit corresponding to the value read from the associated DigitalIn pin
emilmont 43:e2ed12d17f06 58 */
simon.ford@mbed.co.uk 0:82220227f4fa 59 int read();
rolf.meyer@arm.com 11:1c1ebd0324fa 60
rolf.meyer@arm.com 11:1c1ebd0324fa 61 #ifdef MBED_OPERATORS
emilmont 43:e2ed12d17f06 62 /** A shorthand for read()
rolf.meyer@arm.com 11:1c1ebd0324fa 63 */
rolf.meyer@arm.com 11:1c1ebd0324fa 64 operator int();
rolf.meyer@arm.com 11:1c1ebd0324fa 65 #endif
simon.ford@mbed.co.uk 4:5d1359a283bc 66
simon.ford@mbed.co.uk 0:82220227f4fa 67 protected:
rolf.meyer@arm.com 11:1c1ebd0324fa 68 DigitalIn* _pin[16];
simon.ford@mbed.co.uk 0:82220227f4fa 69 };
simon.ford@mbed.co.uk 0:82220227f4fa 70
rolf.meyer@arm.com 11:1c1ebd0324fa 71 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 72
simon.ford@mbed.co.uk 1:6b7f447ca868 73 #endif