Sertel_Srinath Gopalan / USB_SERTEL_LOG

Soundharrajan

Fork of mbed by mbed official

BusInOut.h@92:f7fcbaa5f1b5, 2016-06-12 (annotated)

Committer:
mrsoundhar
Date:
Sun Jun 12 16:45:04 2016 +0000
Revision:
92:f7fcbaa5f1b5
Parent:
27:7110ebee3484
Child:
43:e2ed12d17f06
Soundharrajan

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 */
rolf.meyer@arm.com 11:1c1ebd0324fa 4
rolf.meyer@arm.com 11:1c1ebd0324fa 5 #ifndef MBED_BUSINOUT_H
rolf.meyer@arm.com 11:1c1ebd0324fa 6 #define MBED_BUSINOUT_H
rolf.meyer@arm.com 11:1c1ebd0324fa 7
rolf.meyer@arm.com 11:1c1ebd0324fa 8 #include "platform.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 9 #include "PinNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 10 #include "PeripheralNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 11 #include "Base.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 12 #include "DigitalInOut.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 13
rolf.meyer@arm.com 11:1c1ebd0324fa 14 namespace mbed {
rolf.meyer@arm.com 11:1c1ebd0324fa 15
rolf.meyer@arm.com 11:1c1ebd0324fa 16 /* Class: BusInOut
rolf.meyer@arm.com 11:1c1ebd0324fa 17 * A digital input output bus, used for setting the state of a collection of pins
rolf.meyer@arm.com 11:1c1ebd0324fa 18 */
rolf.meyer@arm.com 11:1c1ebd0324fa 19 class BusInOut : public Base {
rolf.meyer@arm.com 11:1c1ebd0324fa 20
rolf.meyer@arm.com 11:1c1ebd0324fa 21 public:
rolf.meyer@arm.com 11:1c1ebd0324fa 22
rolf.meyer@arm.com 11:1c1ebd0324fa 23 /* Group: Configuration Methods */
rolf.meyer@arm.com 11:1c1ebd0324fa 24
rolf.meyer@arm.com 11:1c1ebd0324fa 25 /* Constructor: BusInOut
rolf.meyer@arm.com 11:1c1ebd0324fa 26 * Create an BusInOut, connected to the specified pins
rolf.meyer@arm.com 11:1c1ebd0324fa 27 *
rolf.meyer@arm.com 11:1c1ebd0324fa 28 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 29 * p<n> - DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)
rolf.meyer@arm.com 11:1c1ebd0324fa 30 *
rolf.meyer@arm.com 11:1c1ebd0324fa 31 * Note:
rolf.meyer@arm.com 11:1c1ebd0324fa 32 * It is only required to specify as many pin variables as is required
rolf.meyer@arm.com 11:1c1ebd0324fa 33 * for the bus; the rest will default to NC (not connected)
rolf.meyer@arm.com 11:1c1ebd0324fa 34 */
rolf.meyer@arm.com 11:1c1ebd0324fa 35 BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
rolf.meyer@arm.com 11:1c1ebd0324fa 36 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
rolf.meyer@arm.com 11:1c1ebd0324fa 37 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
rolf.meyer@arm.com 11:1c1ebd0324fa 38 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC,
rolf.meyer@arm.com 11:1c1ebd0324fa 39 const char *name = NULL);
rolf.meyer@arm.com 11:1c1ebd0324fa 40
rolf.meyer@arm.com 11:1c1ebd0324fa 41 BusInOut(PinName pins[16], const char *name = NULL);
rolf.meyer@arm.com 11:1c1ebd0324fa 42
rolf.meyer@arm.com 11:1c1ebd0324fa 43 virtual ~BusInOut();
rolf.meyer@arm.com 11:1c1ebd0324fa 44
rolf.meyer@arm.com 11:1c1ebd0324fa 45 /* Group: Access Methods */
rolf.meyer@arm.com 11:1c1ebd0324fa 46
rolf.meyer@arm.com 11:1c1ebd0324fa 47 /* Function: write
rolf.meyer@arm.com 11:1c1ebd0324fa 48 * Write the value to the output bus
rolf.meyer@arm.com 11:1c1ebd0324fa 49 *
rolf.meyer@arm.com 11:1c1ebd0324fa 50 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 51 * value - An integer specifying a bit to write for every corresponding DigitalInOut pin
rolf.meyer@arm.com 11:1c1ebd0324fa 52 */
rolf.meyer@arm.com 11:1c1ebd0324fa 53 void write(int value);
rolf.meyer@arm.com 11:1c1ebd0324fa 54
rolf.meyer@arm.com 11:1c1ebd0324fa 55
rolf.meyer@arm.com 11:1c1ebd0324fa 56 /* Function: read
rolf.meyer@arm.com 11:1c1ebd0324fa 57 * Read the value currently output on the bus
rolf.meyer@arm.com 11:1c1ebd0324fa 58 *
rolf.meyer@arm.com 11:1c1ebd0324fa 59 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 60 * returns - An integer with each bit corresponding to associated DigitalInOut pin setting
rolf.meyer@arm.com 11:1c1ebd0324fa 61 */
rolf.meyer@arm.com 11:1c1ebd0324fa 62 int read();
rolf.meyer@arm.com 11:1c1ebd0324fa 63
rolf.meyer@arm.com 11:1c1ebd0324fa 64 /* Function: output
rolf.meyer@arm.com 11:1c1ebd0324fa 65 * Set as an output
rolf.meyer@arm.com 11:1c1ebd0324fa 66 */
rolf.meyer@arm.com 11:1c1ebd0324fa 67 void output();
rolf.meyer@arm.com 11:1c1ebd0324fa 68
rolf.meyer@arm.com 11:1c1ebd0324fa 69 /* Function: input
rolf.meyer@arm.com 11:1c1ebd0324fa 70 * Set as an input
rolf.meyer@arm.com 11:1c1ebd0324fa 71 */
rolf.meyer@arm.com 11:1c1ebd0324fa 72 void input();
rolf.meyer@arm.com 11:1c1ebd0324fa 73
rolf.meyer@arm.com 11:1c1ebd0324fa 74 /* Function: mode
rolf.meyer@arm.com 11:1c1ebd0324fa 75 * Set the input pin mode
rolf.meyer@arm.com 11:1c1ebd0324fa 76 *
rolf.meyer@arm.com 11:1c1ebd0324fa 77 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 78 * mode - PullUp, PullDown, PullNone
rolf.meyer@arm.com 11:1c1ebd0324fa 79 */
rolf.meyer@arm.com 11:1c1ebd0324fa 80 void mode(PinMode pull);
rolf.meyer@arm.com 11:1c1ebd0324fa 81
rolf.meyer@arm.com 11:1c1ebd0324fa 82 #ifdef MBED_OPERATORS
rolf.meyer@arm.com 11:1c1ebd0324fa 83 /* Group: Access Method Shorthand */
rolf.meyer@arm.com 11:1c1ebd0324fa 84
rolf.meyer@arm.com 11:1c1ebd0324fa 85 /* Function: operator=
rolf.meyer@arm.com 11:1c1ebd0324fa 86 * A shorthand for <write>
rolf.meyer@arm.com 11:1c1ebd0324fa 87 */
rolf.meyer@arm.com 11:1c1ebd0324fa 88 BusInOut& operator= (int v);
rolf.meyer@arm.com 11:1c1ebd0324fa 89 BusInOut& operator= (BusInOut& rhs);
rolf.meyer@arm.com 11:1c1ebd0324fa 90
rolf.meyer@arm.com 11:1c1ebd0324fa 91 /* Function: operator int()
rolf.meyer@arm.com 11:1c1ebd0324fa 92 * A shorthand for <read>
rolf.meyer@arm.com 11:1c1ebd0324fa 93 */
rolf.meyer@arm.com 11:1c1ebd0324fa 94 operator int();
rolf.meyer@arm.com 11:1c1ebd0324fa 95 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 96
rolf.meyer@arm.com 11:1c1ebd0324fa 97 #ifdef MBED_RPC
rolf.meyer@arm.com 11:1c1ebd0324fa 98 virtual const struct rpc_method *get_rpc_methods();
rolf.meyer@arm.com 11:1c1ebd0324fa 99 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 100 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 101
rolf.meyer@arm.com 11:1c1ebd0324fa 102 protected:
rolf.meyer@arm.com 11:1c1ebd0324fa 103
rolf.meyer@arm.com 11:1c1ebd0324fa 104 DigitalInOut* _pin[16];
rolf.meyer@arm.com 11:1c1ebd0324fa 105
rolf.meyer@arm.com 11:1c1ebd0324fa 106 #ifdef MBED_RPC
rolf.meyer@arm.com 11:1c1ebd0324fa 107 static void construct(const char *arguments, char *res);
rolf.meyer@arm.com 11:1c1ebd0324fa 108 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 109
rolf.meyer@arm.com 11:1c1ebd0324fa 110 };
rolf.meyer@arm.com 11:1c1ebd0324fa 111
rolf.meyer@arm.com 11:1c1ebd0324fa 112 } // namespace mbed
rolf.meyer@arm.com 11:1c1ebd0324fa 113
rolf.meyer@arm.com 11:1c1ebd0324fa 114 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 115