Matthew Sims / mbed

Lab 1 Program C

Dependents:   Lab1C

Fork of mbed by -deleted-

BusInOut.h@11:1c1ebd0324fa, 2009-08-28 (annotated)

Committer:
rolf.meyer@arm.com
Date:
Fri Aug 28 12:10:11 2009 +0000
Revision:
11:1c1ebd0324fa
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 - BusInOut
rolf.meyer@arm.com 11:1c1ebd0324fa 2 * Copyright (c) 2009 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 * sford, rmeyer
rolf.meyer@arm.com 11:1c1ebd0324fa 4 */
rolf.meyer@arm.com 11:1c1ebd0324fa 5
rolf.meyer@arm.com 11:1c1ebd0324fa 6 #ifndef MBED_BUSINOUT_H
rolf.meyer@arm.com 11:1c1ebd0324fa 7 #define MBED_BUSINOUT_H
rolf.meyer@arm.com 11:1c1ebd0324fa 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"
rolf.meyer@arm.com 11:1c1ebd0324fa 12 #include "Base.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 13 #include "DigitalInOut.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 14
rolf.meyer@arm.com 11:1c1ebd0324fa 15 namespace mbed {
rolf.meyer@arm.com 11:1c1ebd0324fa 16
rolf.meyer@arm.com 11:1c1ebd0324fa 17 /* Class: BusInOut
rolf.meyer@arm.com 11:1c1ebd0324fa 18 * A digital input output bus, used for setting the state of a collection of pins
rolf.meyer@arm.com 11:1c1ebd0324fa 19 */
rolf.meyer@arm.com 11:1c1ebd0324fa 20 class BusInOut : public Base {
rolf.meyer@arm.com 11:1c1ebd0324fa 21
rolf.meyer@arm.com 11:1c1ebd0324fa 22 public:
rolf.meyer@arm.com 11:1c1ebd0324fa 23
rolf.meyer@arm.com 11:1c1ebd0324fa 24 /* Group: Configuration Methods */
rolf.meyer@arm.com 11:1c1ebd0324fa 25
rolf.meyer@arm.com 11:1c1ebd0324fa 26 /* Constructor: BusInOut
rolf.meyer@arm.com 11:1c1ebd0324fa 27 * Create an BusInOut, 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> - DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)
rolf.meyer@arm.com 11:1c1ebd0324fa 31 *
rolf.meyer@arm.com 11:1c1ebd0324fa 32 * Note:
rolf.meyer@arm.com 11:1c1ebd0324fa 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 BusInOut(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,
rolf.meyer@arm.com 11:1c1ebd0324fa 40 const char *name = NULL);
rolf.meyer@arm.com 11:1c1ebd0324fa 41
rolf.meyer@arm.com 11:1c1ebd0324fa 42 BusInOut(PinName pins[16], const char *name = NULL);
rolf.meyer@arm.com 11:1c1ebd0324fa 43
rolf.meyer@arm.com 11:1c1ebd0324fa 44 virtual ~BusInOut();
rolf.meyer@arm.com 11:1c1ebd0324fa 45
rolf.meyer@arm.com 11:1c1ebd0324fa 46 /* Group: Access Methods */
rolf.meyer@arm.com 11:1c1ebd0324fa 47
rolf.meyer@arm.com 11:1c1ebd0324fa 48 /* Function: write
rolf.meyer@arm.com 11:1c1ebd0324fa 49 * Write the value to the output bus
rolf.meyer@arm.com 11:1c1ebd0324fa 50 *
rolf.meyer@arm.com 11:1c1ebd0324fa 51 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 52 * value - An integer specifying a bit to write for every corresponding DigitalInOut pin
rolf.meyer@arm.com 11:1c1ebd0324fa 53 */
rolf.meyer@arm.com 11:1c1ebd0324fa 54 void write(int value);
rolf.meyer@arm.com 11:1c1ebd0324fa 55
rolf.meyer@arm.com 11:1c1ebd0324fa 56
rolf.meyer@arm.com 11:1c1ebd0324fa 57 /* Function: read
rolf.meyer@arm.com 11:1c1ebd0324fa 58 * Read the value currently output on the bus
rolf.meyer@arm.com 11:1c1ebd0324fa 59 *
rolf.meyer@arm.com 11:1c1ebd0324fa 60 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 61 * returns - An integer with each bit corresponding to associated DigitalInOut pin setting
rolf.meyer@arm.com 11:1c1ebd0324fa 62 */
rolf.meyer@arm.com 11:1c1ebd0324fa 63 int read();
rolf.meyer@arm.com 11:1c1ebd0324fa 64
rolf.meyer@arm.com 11:1c1ebd0324fa 65 /* Function: output
rolf.meyer@arm.com 11:1c1ebd0324fa 66 * Set as an output
rolf.meyer@arm.com 11:1c1ebd0324fa 67 */
rolf.meyer@arm.com 11:1c1ebd0324fa 68 void output();
rolf.meyer@arm.com 11:1c1ebd0324fa 69
rolf.meyer@arm.com 11:1c1ebd0324fa 70 /* Function: input
rolf.meyer@arm.com 11:1c1ebd0324fa 71 * Set as an input
rolf.meyer@arm.com 11:1c1ebd0324fa 72 */
rolf.meyer@arm.com 11:1c1ebd0324fa 73 void input();
rolf.meyer@arm.com 11:1c1ebd0324fa 74
rolf.meyer@arm.com 11:1c1ebd0324fa 75 /* Function: mode
rolf.meyer@arm.com 11:1c1ebd0324fa 76 * Set the input pin mode
rolf.meyer@arm.com 11:1c1ebd0324fa 77 *
rolf.meyer@arm.com 11:1c1ebd0324fa 78 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 79 * mode - PullUp, PullDown, PullNone
rolf.meyer@arm.com 11:1c1ebd0324fa 80 */
rolf.meyer@arm.com 11:1c1ebd0324fa 81 void mode(PinMode pull);
rolf.meyer@arm.com 11:1c1ebd0324fa 82
rolf.meyer@arm.com 11:1c1ebd0324fa 83 #ifdef MBED_OPERATORS
rolf.meyer@arm.com 11:1c1ebd0324fa 84 /* Group: Access Method Shorthand */
rolf.meyer@arm.com 11:1c1ebd0324fa 85
rolf.meyer@arm.com 11:1c1ebd0324fa 86 /* Function: operator=
rolf.meyer@arm.com 11:1c1ebd0324fa 87 * A shorthand for <write>
rolf.meyer@arm.com 11:1c1ebd0324fa 88 */
rolf.meyer@arm.com 11:1c1ebd0324fa 89 BusInOut& operator= (int v);
rolf.meyer@arm.com 11:1c1ebd0324fa 90 BusInOut& operator= (BusInOut& rhs);
rolf.meyer@arm.com 11:1c1ebd0324fa 91
rolf.meyer@arm.com 11:1c1ebd0324fa 92 /* Function: operator int()
rolf.meyer@arm.com 11:1c1ebd0324fa 93 * A shorthand for <read>
rolf.meyer@arm.com 11:1c1ebd0324fa 94 */
rolf.meyer@arm.com 11:1c1ebd0324fa 95 operator int();
rolf.meyer@arm.com 11:1c1ebd0324fa 96 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 97
rolf.meyer@arm.com 11:1c1ebd0324fa 98 #ifdef MBED_RPC
rolf.meyer@arm.com 11:1c1ebd0324fa 99 virtual const struct rpc_method *get_rpc_methods();
rolf.meyer@arm.com 11:1c1ebd0324fa 100 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 101 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 102
rolf.meyer@arm.com 11:1c1ebd0324fa 103 protected:
rolf.meyer@arm.com 11:1c1ebd0324fa 104
rolf.meyer@arm.com 11:1c1ebd0324fa 105 DigitalInOut* _pin[16];
rolf.meyer@arm.com 11:1c1ebd0324fa 106
rolf.meyer@arm.com 11:1c1ebd0324fa 107 #ifdef MBED_RPC
rolf.meyer@arm.com 11:1c1ebd0324fa 108 static void construct(const char *arguments, char *res);
rolf.meyer@arm.com 11:1c1ebd0324fa 109 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 110
rolf.meyer@arm.com 11:1c1ebd0324fa 111 };
rolf.meyer@arm.com 11:1c1ebd0324fa 112
rolf.meyer@arm.com 11:1c1ebd0324fa 113 } // namespace mbed
rolf.meyer@arm.com 11:1c1ebd0324fa 114
rolf.meyer@arm.com 11:1c1ebd0324fa 115 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 116