Matthew Sims / mbed

Lab 1 Program C

Dependents:   Lab1C

Fork of mbed by -deleted-

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

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 18:b3c9f16cbb96 1 /* mbed Microcontroller Library - PortOut
emilmont 27:7110ebee3484 2 * Copyright (c) 2006-2011 ARM Limited. All rights reserved.
simon.ford@mbed.co.uk 18:b3c9f16cbb96 3 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 4
simon.ford@mbed.co.uk 18:b3c9f16cbb96 5 #ifndef MBED_PORTOUT_H
simon.ford@mbed.co.uk 18:b3c9f16cbb96 6 #define MBED_PORTOUT_H
simon.ford@mbed.co.uk 18:b3c9f16cbb96 7
emilmont 27:7110ebee3484 8 #include "device.h"
emilmont 27:7110ebee3484 9
emilmont 27:7110ebee3484 10 #if DEVICE_PORTOUT
emilmont 27:7110ebee3484 11
simon.ford@mbed.co.uk 18:b3c9f16cbb96 12 #include "platform.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 13 #include "PinNames.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 14 #include "Base.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 15
simon.ford@mbed.co.uk 18:b3c9f16cbb96 16 #include "PortNames.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 17
simon.ford@mbed.co.uk 18:b3c9f16cbb96 18 namespace mbed {
screamer 43:aff670d0d510 19 /** A multiple pin digital out
simon.ford@mbed.co.uk 18:b3c9f16cbb96 20 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 21 * Example:
screamer 43:aff670d0d510 22 * @code
screamer 43:aff670d0d510 23 * // Toggle all four LEDs
screamer 43:aff670d0d510 24 *
screamer 43:aff670d0d510 25 * #include "mbed.h"
screamer 43:aff670d0d510 26 *
screamer 43:aff670d0d510 27 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
screamer 43:aff670d0d510 28 * #define LED_MASK 0x00B40000
screamer 43:aff670d0d510 29 *
screamer 43:aff670d0d510 30 * PortOut ledport(Port1, LED_MASK);
screamer 43:aff670d0d510 31 *
screamer 43:aff670d0d510 32 * int main() {
screamer 43:aff670d0d510 33 * while(1) {
screamer 43:aff670d0d510 34 * ledport = LED_MASK;
screamer 43:aff670d0d510 35 * wait(1);
screamer 43:aff670d0d510 36 * ledport = 0;
screamer 43:aff670d0d510 37 * wait(1);
screamer 43:aff670d0d510 38 * }
screamer 43:aff670d0d510 39 * }
screamer 43:aff670d0d510 40 * @endcode
simon.ford@mbed.co.uk 18:b3c9f16cbb96 41 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 42 class PortOut {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 43 public:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 44
screamer 43:aff670d0d510 45 /** Create an PortOut, connected to the specified port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 46 *
screamer 43:aff670d0d510 47 * @param port Port to connect to (Port0-Port5)
screamer 43:aff670d0d510 48 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
screamer 43:aff670d0d510 49 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 50 PortOut(PortName port, int mask = 0xFFFFFFFF);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 51
screamer 43:aff670d0d510 52 /** Write the value to the output port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 53 *
screamer 43:aff670d0d510 54 * @param value An integer specifying a bit to write for every corresponding PortOut pin
simon.ford@mbed.co.uk 18:b3c9f16cbb96 55 */
emilmont 28:667d61c9177b 56 void write(int value);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 57
screamer 43:aff670d0d510 58 /** Read the value currently output on the port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 59 *
screamer 43:aff670d0d510 60 * @returns
screamer 43:aff670d0d510 61 * An integer with each bit corresponding to associated PortOut pin setting
simon.ford@mbed.co.uk 18:b3c9f16cbb96 62 */
emilmont 28:667d61c9177b 63 int read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 64
screamer 43:aff670d0d510 65 /** A shorthand for write()
simon.ford@mbed.co.uk 18:b3c9f16cbb96 66 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 67 PortOut& operator= (int value) {
screamer 43:aff670d0d510 68 write(value);
screamer 43:aff670d0d510 69 return *this;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 70 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 71
simon.ford@mbed.co.uk 18:b3c9f16cbb96 72 PortOut& operator= (PortOut& rhs) {
screamer 43:aff670d0d510 73 write(rhs.read());
screamer 43:aff670d0d510 74 return *this;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 75 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 76
screamer 43:aff670d0d510 77 /** A shorthand for read()
simon.ford@mbed.co.uk 18:b3c9f16cbb96 78 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 79 operator int() {
screamer 43:aff670d0d510 80 return read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 81 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 82
simon.ford@mbed.co.uk 18:b3c9f16cbb96 83 private:
emilmont 28:667d61c9177b 84 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 85 LPC_GPIO_TypeDef *_gpio;
emilmont 28:667d61c9177b 86 #endif
emilmont 28:667d61c9177b 87 PortName _port;
emilmont 28:667d61c9177b 88 uint32_t _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 89 };
simon.ford@mbed.co.uk 18:b3c9f16cbb96 90
simon.ford@mbed.co.uk 18:b3c9f16cbb96 91 } // namespace mbed
simon.ford@mbed.co.uk 18:b3c9f16cbb96 92
simon.ford@mbed.co.uk 18:b3c9f16cbb96 93 #endif
emilmont 27:7110ebee3484 94
emilmont 27:7110ebee3484 95 #endif