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@27:7110ebee3484, 2011-11-29 (annotated)

Committer:
emilmont
Date:
Tue Nov 29 14:59:27 2011 +0000
Revision:
27:7110ebee3484
Parent:
24:e2ac27c8e93e
Child:
28:667d61c9177b
New Libraries 11.11

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
simon.ford@mbed.co.uk 18:b3c9f16cbb96 17 /* Class: PortInOut
simon.ford@mbed.co.uk 18:b3c9f16cbb96 18 * A multiple pin digital in/out used to set/read multiple bi-directional pins
simon.ford@mbed.co.uk 18:b3c9f16cbb96 19 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 20 class PortInOut {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 21 public:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 22
simon.ford@mbed.co.uk 18:b3c9f16cbb96 23 /* Constructor: PortInOut
simon.ford@mbed.co.uk 18:b3c9f16cbb96 24 * Create an PortInOut, connected to the specified port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 25 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 26 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 27 * port - Port to connect to (Port0-Port5)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 28 * mask - A bitmask to identify which bits in the port should be included (0 - ignore)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 29 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 30 PortInOut(PortName port, int mask = 0xFFFFFFFF);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 31
simon.ford@mbed.co.uk 18:b3c9f16cbb96 32 /* Function: write
simon.ford@mbed.co.uk 18:b3c9f16cbb96 33 * Write the value to the output port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 34 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 35 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 36 * value - An integer specifying a bit to write for every corresponding port pin
simon.ford@mbed.co.uk 18:b3c9f16cbb96 37 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 38 void write(int value) {
simon 24:e2ac27c8e93e 39 _gpio->FIOPIN = (_gpio->FIOPIN & ~_mask) | (value & _mask);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 40 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 41
simon.ford@mbed.co.uk 18:b3c9f16cbb96 42 /* Function: read
simon.ford@mbed.co.uk 18:b3c9f16cbb96 43 * Read the value currently output on the port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 44 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 45 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 46 * returns - An integer with each bit corresponding to associated port pin setting
simon.ford@mbed.co.uk 18:b3c9f16cbb96 47 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 48 int read() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 49 return _gpio->FIOPIN & _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 50 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 51
simon.ford@mbed.co.uk 18:b3c9f16cbb96 52 /* Function: output
simon.ford@mbed.co.uk 18:b3c9f16cbb96 53 * Set as an output
simon.ford@mbed.co.uk 18:b3c9f16cbb96 54 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 55 void output();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 56
simon.ford@mbed.co.uk 18:b3c9f16cbb96 57 /* Function: input
simon.ford@mbed.co.uk 18:b3c9f16cbb96 58 * Set as an input
simon.ford@mbed.co.uk 18:b3c9f16cbb96 59 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 60 void input();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 61
simon.ford@mbed.co.uk 18:b3c9f16cbb96 62 /* Function: mode
simon.ford@mbed.co.uk 18:b3c9f16cbb96 63 * Set the input pin mode
simon.ford@mbed.co.uk 18:b3c9f16cbb96 64 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 65 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 66 * mode - PullUp, PullDown, PullNone, OpenDrain
simon.ford@mbed.co.uk 18:b3c9f16cbb96 67 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 68 void mode(PinMode mode);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 69
simon.ford@mbed.co.uk 18:b3c9f16cbb96 70 /* Function: operator=
simon.ford@mbed.co.uk 18:b3c9f16cbb96 71 * A shorthand for <write>
simon.ford@mbed.co.uk 18:b3c9f16cbb96 72 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 73 PortInOut& operator= (int value) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 74 write(value);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 75 return *this;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 76 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 77
simon.ford@mbed.co.uk 18:b3c9f16cbb96 78 PortInOut& operator= (PortInOut& rhs) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 79 write(rhs.read());
simon.ford@mbed.co.uk 18:b3c9f16cbb96 80 return *this;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 81 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 82
simon.ford@mbed.co.uk 18:b3c9f16cbb96 83 /* Function: operator int()
simon.ford@mbed.co.uk 18:b3c9f16cbb96 84 * A shorthand for <read>
simon.ford@mbed.co.uk 18:b3c9f16cbb96 85 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 86 operator int() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 87 return read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 88 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 89
simon.ford@mbed.co.uk 18:b3c9f16cbb96 90 private:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 91 LPC_GPIO_TypeDef *_gpio;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 92 PortName _port;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 93 uint32_t _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 94 };
simon.ford@mbed.co.uk 18:b3c9f16cbb96 95
simon.ford@mbed.co.uk 18:b3c9f16cbb96 96 } // namespace mbed
simon.ford@mbed.co.uk 18:b3c9f16cbb96 97
simon.ford@mbed.co.uk 18:b3c9f16cbb96 98 #endif
emilmont 27:7110ebee3484 99
emilmont 27:7110ebee3484 100 #endif