Matthew Sims / mbed

Lab 1 Program C

Dependents:   Lab1C

Fork of mbed by -deleted-

DigitalOut.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
simon.ford@mbed.co.uk 0:82220227f4fa 1 /* mbed Microcontroller Library - DigitalOut
emilmont 27:7110ebee3484 2 * Copyright (c) 2006-2011 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 */
simon.ford@mbed.co.uk 0:82220227f4fa 4
simon.ford@mbed.co.uk 0:82220227f4fa 5 #ifndef MBED_DIGITALOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 6 #define MBED_DIGITALOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 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"
simon.ford@mbed.co.uk 0:82220227f4fa 11 #include "Base.h"
simon.ford@mbed.co.uk 0:82220227f4fa 12
simon.ford@mbed.co.uk 0:82220227f4fa 13 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 14
screamer 43:aff670d0d510 15 /** A digital output, used for setting the state of a pin
rolf.meyer@arm.com 11:1c1ebd0324fa 16 *
rolf.meyer@arm.com 11:1c1ebd0324fa 17 * Example:
screamer 43:aff670d0d510 18 * @code
screamer 43:aff670d0d510 19 * // Toggle a LED
screamer 43:aff670d0d510 20 * #include "mbed.h"
screamer 43:aff670d0d510 21 *
screamer 43:aff670d0d510 22 * DigitalOut led(LED1);
screamer 43:aff670d0d510 23 *
screamer 43:aff670d0d510 24 * int main() {
screamer 43:aff670d0d510 25 * while(1) {
screamer 43:aff670d0d510 26 * led = !led;
screamer 43:aff670d0d510 27 * wait(0.2);
screamer 43:aff670d0d510 28 * }
screamer 43:aff670d0d510 29 * }
screamer 43:aff670d0d510 30 * @endcode
simon.ford@mbed.co.uk 0:82220227f4fa 31 */
simon.ford@mbed.co.uk 0:82220227f4fa 32 class DigitalOut : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 33
simon.ford@mbed.co.uk 0:82220227f4fa 34 public:
simon.ford@mbed.co.uk 0:82220227f4fa 35
screamer 43:aff670d0d510 36 /** Create a DigitalOut connected to the specified pin
rolf.meyer@arm.com 11:1c1ebd0324fa 37 *
screamer 43:aff670d0d510 38 * @param pin DigitalOut pin to connect to
rolf.meyer@arm.com 11:1c1ebd0324fa 39 */
rolf.meyer@arm.com 11:1c1ebd0324fa 40 DigitalOut(PinName pin, const char* name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 41
screamer 43:aff670d0d510 42 /** Set the output, specified as 0 or 1 (int)
rolf.meyer@arm.com 11:1c1ebd0324fa 43 *
screamer 43:aff670d0d510 44 * @param value An integer specifying the pin output value,
screamer 43:aff670d0d510 45 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
rolf.meyer@arm.com 11:1c1ebd0324fa 46 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 47 void write(int value) {
emilmont 27:7110ebee3484 48
emilmont 27:7110ebee3484 49 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
emilmont 27:7110ebee3484 50
simon.ford@mbed.co.uk 18:b3c9f16cbb96 51 if(value) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 52 _gpio->FIOSET = _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 53 } else {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 54 _gpio->FIOCLR = _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 55 }
emilmont 27:7110ebee3484 56
emilmont 27:7110ebee3484 57 #elif defined(TARGET_LPC11U24)
emilmont 27:7110ebee3484 58
emilmont 27:7110ebee3484 59 if(value) {
emilmont 27:7110ebee3484 60 LPC_GPIO->SET[_index] = _mask;
emilmont 27:7110ebee3484 61 } else {
emilmont 27:7110ebee3484 62 LPC_GPIO->CLR[_index] = _mask;
emilmont 27:7110ebee3484 63 }
emilmont 27:7110ebee3484 64 #endif
emilmont 27:7110ebee3484 65
simon.ford@mbed.co.uk 18:b3c9f16cbb96 66 }
simon.ford@mbed.co.uk 0:82220227f4fa 67
screamer 43:aff670d0d510 68 /** Return the output setting, represented as 0 or 1 (int)
rolf.meyer@arm.com 11:1c1ebd0324fa 69 *
screamer 43:aff670d0d510 70 * @returns
screamer 43:aff670d0d510 71 * an integer representing the output setting of the pin,
screamer 43:aff670d0d510 72 * 0 for logical 0, 1 for logical 1
rolf.meyer@arm.com 11:1c1ebd0324fa 73 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 74 int read() {
emilmont 27:7110ebee3484 75 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 76 return ((_gpio->FIOPIN & _mask) ? 1 : 0);
emilmont 27:7110ebee3484 77 #elif defined(TARGET_LPC11U24)
emilmont 27:7110ebee3484 78 return ((LPC_GPIO->PIN[_index] & _mask) ? 1 : 0);
emilmont 27:7110ebee3484 79 #endif
emilmont 27:7110ebee3484 80
simon.ford@mbed.co.uk 18:b3c9f16cbb96 81 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 82
simon.ford@mbed.co.uk 4:5d1359a283bc 83
rolf.meyer@arm.com 11:1c1ebd0324fa 84 #ifdef MBED_OPERATORS
screamer 43:aff670d0d510 85 /** A shorthand for write()
rolf.meyer@arm.com 11:1c1ebd0324fa 86 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 87 DigitalOut& operator= (int value) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 88 write(value);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 89 return *this;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 90 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 91
simon.ford@mbed.co.uk 18:b3c9f16cbb96 92 DigitalOut& operator= (DigitalOut& rhs) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 93 write(rhs.read());
simon.ford@mbed.co.uk 18:b3c9f16cbb96 94 return *this;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 95 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 96
rolf.meyer@arm.com 11:1c1ebd0324fa 97
screamer 43:aff670d0d510 98 /** A shorthand for read()
simon.ford@mbed.co.uk 0:82220227f4fa 99 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 100 operator int() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 101 return read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 102 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 103
rolf.meyer@arm.com 11:1c1ebd0324fa 104 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 105
rolf.meyer@arm.com 11:1c1ebd0324fa 106 #ifdef MBED_RPC
rolf.meyer@arm.com 11:1c1ebd0324fa 107 virtual const struct rpc_method *get_rpc_methods();
rolf.meyer@arm.com 11:1c1ebd0324fa 108 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 109 #endif
simon.ford@mbed.co.uk 0:82220227f4fa 110
simon.ford@mbed.co.uk 0:82220227f4fa 111 protected:
rolf.meyer@arm.com 11:1c1ebd0324fa 112
simon.ford@mbed.co.uk 18:b3c9f16cbb96 113 PinName _pin;
emilmont 27:7110ebee3484 114
emilmont 27:7110ebee3484 115 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 116 LPC_GPIO_TypeDef *_gpio;
emilmont 27:7110ebee3484 117 #elif defined(TARGET_LPC11U24)
emilmont 27:7110ebee3484 118 int _index;
emilmont 27:7110ebee3484 119 #endif
emilmont 27:7110ebee3484 120
simon.ford@mbed.co.uk 18:b3c9f16cbb96 121 uint32_t _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 122
rolf.meyer@arm.com 11:1c1ebd0324fa 123
simon.ford@mbed.co.uk 0:82220227f4fa 124 };
simon.ford@mbed.co.uk 0:82220227f4fa 125
rolf.meyer@arm.com 11:1c1ebd0324fa 126 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 127
rolf.meyer@arm.com 11:1c1ebd0324fa 128 #endif