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@18:b3c9f16cbb96, 2010-05-17 (annotated)

Committer:
simon.ford@mbed.co.uk
Date:
Mon May 17 14:18:54 2010 +0000
Revision:
18:b3c9f16cbb96
Child:
24:e2ac27c8e93e
* Digital I/O speed improved

 * Added Port

 * Added OpenDrain mode

 * Fixes

Who changed what in which revision?

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