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@11:1c1ebd0324fa, 2009-08-28 (annotated)

Committer:
rolf.meyer@arm.com
Date:
Fri Aug 28 12:10:11 2009 +0000
Revision:
11:1c1ebd0324fa
Parent:
5:62573be585e9
Child:
27:7110ebee3484
A shiny new version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rolf.meyer@arm.com 11:1c1ebd0324fa 1 /* mbed Microcontroller Library - DigitalIn
rolf.meyer@arm.com 11:1c1ebd0324fa 2 * Copyright (c) 2007-2009 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 * sford, rmeyer
simon.ford@mbed.co.uk 0:82220227f4fa 4 */
simon.ford@mbed.co.uk 0:82220227f4fa 5
simon.ford@mbed.co.uk 0:82220227f4fa 6 #ifndef MBED_BUSIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 7 #define MBED_BUSIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 8
rolf.meyer@arm.com 11:1c1ebd0324fa 9 #include "platform.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 10 #include "PinNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 11 #include "PeripheralNames.h"
simon.ford@mbed.co.uk 0:82220227f4fa 12 #include "Base.h"
simon.ford@mbed.co.uk 0:82220227f4fa 13 #include "DigitalIn.h"
simon.ford@mbed.co.uk 0:82220227f4fa 14
simon.ford@mbed.co.uk 0:82220227f4fa 15 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 16
simon.ford@mbed.co.uk 0:82220227f4fa 17 /* Class: BusIn
simon.ford@mbed.co.uk 0:82220227f4fa 18 * A digital input bus, used for reading the state of a collection of pins
simon.ford@mbed.co.uk 0:82220227f4fa 19 */
simon.ford@mbed.co.uk 0:82220227f4fa 20 class BusIn : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 21
simon.ford@mbed.co.uk 0:82220227f4fa 22 public:
simon.ford@mbed.co.uk 0:82220227f4fa 23
rolf.meyer@arm.com 11:1c1ebd0324fa 24 /* Group: Configuration Methods */
simon.ford@mbed.co.uk 0:82220227f4fa 25
rolf.meyer@arm.com 11:1c1ebd0324fa 26 /* Constructor: BusIn
rolf.meyer@arm.com 11:1c1ebd0324fa 27 * Create an BusIn, connected to the specified pins
rolf.meyer@arm.com 11:1c1ebd0324fa 28 *
rolf.meyer@arm.com 11:1c1ebd0324fa 29 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 30 * p<n> - DigitalIn pin to connect to bus bit <n> (p5-p30, NC)
simon.ford@mbed.co.uk 0:82220227f4fa 31 *
simon.ford@mbed.co.uk 0:82220227f4fa 32 * Note:
simon.ford@mbed.co.uk 0:82220227f4fa 33 * It is only required to specify as many pin variables as is required
rolf.meyer@arm.com 11:1c1ebd0324fa 34 * for the bus; the rest will default to NC (not connected)
rolf.meyer@arm.com 11:1c1ebd0324fa 35 */
rolf.meyer@arm.com 11:1c1ebd0324fa 36 BusIn(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
rolf.meyer@arm.com 11:1c1ebd0324fa 37 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
rolf.meyer@arm.com 11:1c1ebd0324fa 38 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
rolf.meyer@arm.com 11:1c1ebd0324fa 39 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC,
simon.ford@mbed.co.uk 4:5d1359a283bc 40 const char *name = NULL);
simon.ford@mbed.co.uk 5:62573be585e9 41
rolf.meyer@arm.com 11:1c1ebd0324fa 42 BusIn(PinName pins[16], const char *name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 43
simon.ford@mbed.co.uk 0:82220227f4fa 44 virtual ~BusIn();
simon.ford@mbed.co.uk 0:82220227f4fa 45
simon.ford@mbed.co.uk 0:82220227f4fa 46 /* Group: Access Methods */
simon.ford@mbed.co.uk 0:82220227f4fa 47
simon.ford@mbed.co.uk 0:82220227f4fa 48 /* Function: read
simon.ford@mbed.co.uk 0:82220227f4fa 49 * Read the value of the input bus
simon.ford@mbed.co.uk 0:82220227f4fa 50 *
simon.ford@mbed.co.uk 0:82220227f4fa 51 * Variables:
simon.ford@mbed.co.uk 0:82220227f4fa 52 * returns - An integer with each bit corresponding to the value read from the associated DigitalIn pin
simon.ford@mbed.co.uk 0:82220227f4fa 53 */
simon.ford@mbed.co.uk 0:82220227f4fa 54 int read();
rolf.meyer@arm.com 11:1c1ebd0324fa 55
rolf.meyer@arm.com 11:1c1ebd0324fa 56 #ifdef MBED_OPERATORS
rolf.meyer@arm.com 11:1c1ebd0324fa 57 /* Group: Access Method Shorthand */
simon.ford@mbed.co.uk 0:82220227f4fa 58
rolf.meyer@arm.com 11:1c1ebd0324fa 59 /* Function: operator int()
rolf.meyer@arm.com 11:1c1ebd0324fa 60 * A shorthand for <read>
rolf.meyer@arm.com 11:1c1ebd0324fa 61 */
rolf.meyer@arm.com 11:1c1ebd0324fa 62 operator int();
rolf.meyer@arm.com 11:1c1ebd0324fa 63 #endif
simon.ford@mbed.co.uk 4:5d1359a283bc 64
rolf.meyer@arm.com 11:1c1ebd0324fa 65 #ifdef MBED_RPC
simon.ford@mbed.co.uk 5:62573be585e9 66 virtual const struct rpc_method *get_rpc_methods();
simon.ford@mbed.co.uk 5:62573be585e9 67 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 68 #endif
simon.ford@mbed.co.uk 5:62573be585e9 69
simon.ford@mbed.co.uk 0:82220227f4fa 70 protected:
simon.ford@mbed.co.uk 0:82220227f4fa 71
rolf.meyer@arm.com 11:1c1ebd0324fa 72 DigitalIn* _pin[16];
simon.ford@mbed.co.uk 5:62573be585e9 73
rolf.meyer@arm.com 11:1c1ebd0324fa 74 #ifdef MBED_RPC
rolf.meyer@arm.com 11:1c1ebd0324fa 75 static void construct(const char *arguments, char *res);
rolf.meyer@arm.com 11:1c1ebd0324fa 76 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 77
simon.ford@mbed.co.uk 0:82220227f4fa 78 };
simon.ford@mbed.co.uk 0:82220227f4fa 79
rolf.meyer@arm.com 11:1c1ebd0324fa 80 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 81
simon.ford@mbed.co.uk 1:6b7f447ca868 82 #endif
simon.ford@mbed.co.uk 1:6b7f447ca868 83