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

PortInOut.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 - PortInOut
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_PORTINOUT_H
simon.ford@mbed.co.uk 18:b3c9f16cbb96 6 #define MBED_PORTINOUT_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_PORTINOUT
emilmont 27:7110ebee3484 11
simon.ford@mbed.co.uk 18:b3c9f16cbb96 12 #include "PortNames.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 13 #include "PinNames.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 14
simon.ford@mbed.co.uk 18:b3c9f16cbb96 15 namespace mbed {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 16
screamer 43:aff670d0d510 17 /** A multiple pin digital in/out used to set/read multiple bi-directional pins
simon.ford@mbed.co.uk 18:b3c9f16cbb96 18 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 19 class PortInOut {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 20 public:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 21
screamer 43:aff670d0d510 22 /** Create an PortInOut, connected to the specified port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 23 *
screamer 43:aff670d0d510 24 * @param port Port to connect to (Port0-Port5)
screamer 43:aff670d0d510 25 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
screamer 43:aff670d0d510 26 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 27 PortInOut(PortName port, int mask = 0xFFFFFFFF);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 28
screamer 43:aff670d0d510 29 /** Write the value to the output port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 30 *
screamer 43:aff670d0d510 31 * @param value An integer specifying a bit to write for every corresponding port pin
simon.ford@mbed.co.uk 18:b3c9f16cbb96 32 */
emilmont 28:667d61c9177b 33 void write(int value);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 34
screamer 43:aff670d0d510 35 /** Read the value currently output on the port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 36 *
screamer 43:aff670d0d510 37 * @returns
screamer 43:aff670d0d510 38 * An integer with each bit corresponding to associated port pin setting
simon.ford@mbed.co.uk 18:b3c9f16cbb96 39 */
emilmont 28:667d61c9177b 40 int read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 41
screamer 43:aff670d0d510 42 /** Set as an output
simon.ford@mbed.co.uk 18:b3c9f16cbb96 43 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 44 void output();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 45
screamer 43:aff670d0d510 46 /** Set as an input
simon.ford@mbed.co.uk 18:b3c9f16cbb96 47 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 48 void input();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 49
screamer 43:aff670d0d510 50 /** Set the input pin mode
simon.ford@mbed.co.uk 18:b3c9f16cbb96 51 *
screamer 43:aff670d0d510 52 * @param mode PullUp, PullDown, PullNone, OpenDrain
simon.ford@mbed.co.uk 18:b3c9f16cbb96 53 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 54 void mode(PinMode mode);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 55
screamer 43:aff670d0d510 56 /** A shorthand for write()
simon.ford@mbed.co.uk 18:b3c9f16cbb96 57 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 58 PortInOut& operator= (int value) {
screamer 43:aff670d0d510 59 write(value);
screamer 43:aff670d0d510 60 return *this;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 61 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 62
simon.ford@mbed.co.uk 18:b3c9f16cbb96 63 PortInOut& operator= (PortInOut& rhs) {
screamer 43:aff670d0d510 64 write(rhs.read());
screamer 43:aff670d0d510 65 return *this;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 66 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 67
screamer 43:aff670d0d510 68 /** A shorthand for read()
simon.ford@mbed.co.uk 18:b3c9f16cbb96 69 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 70 operator int() {
screamer 43:aff670d0d510 71 return read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 72 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 73
simon.ford@mbed.co.uk 18:b3c9f16cbb96 74 private:
emilmont 28:667d61c9177b 75 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 76 LPC_GPIO_TypeDef *_gpio;
emilmont 28:667d61c9177b 77 #endif
simon.ford@mbed.co.uk 18:b3c9f16cbb96 78 PortName _port;
emilmont 28:667d61c9177b 79 uint32_t _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 80 };
simon.ford@mbed.co.uk 18:b3c9f16cbb96 81
simon.ford@mbed.co.uk 18:b3c9f16cbb96 82 } // namespace mbed
simon.ford@mbed.co.uk 18:b3c9f16cbb96 83
simon.ford@mbed.co.uk 18:b3c9f16cbb96 84 #endif
emilmont 27:7110ebee3484 85
emilmont 27:7110ebee3484 86 #endif