Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

BusInOut.h@43:aff670d0d510, 2012-10-24 (annotated)

Committer:
screamer
Date:
Wed Oct 24 10:44:49 2012 +0000
Revision:
43:aff670d0d510
Parent:
27:7110ebee3484 
Conversion of the classes documentation to Doxygen format

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