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

PortOut.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 - PortOut
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_PORTOUT_H
simon.ford@mbed.co.uk 18:b3c9f16cbb96 6 #define MBED_PORTOUT_H
simon.ford@mbed.co.uk 18:b3c9f16cbb96 7
simon.ford@mbed.co.uk 18:b3c9f16cbb96 8 #include "platform.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 9 #include "PinNames.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 10 #include "Base.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 11
simon.ford@mbed.co.uk 18:b3c9f16cbb96 12 #include "PortNames.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 13
simon.ford@mbed.co.uk 18:b3c9f16cbb96 14 namespace mbed {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 15 /* Class: PortOut
simon.ford@mbed.co.uk 18:b3c9f16cbb96 16 * A multiple pin digital out
simon.ford@mbed.co.uk 18:b3c9f16cbb96 17 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 18 * Example:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 19 * > // Toggle all four LEDs
simon.ford@mbed.co.uk 18:b3c9f16cbb96 20 * >
simon.ford@mbed.co.uk 18:b3c9f16cbb96 21 * > #include "mbed.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 22 * >
simon.ford@mbed.co.uk 18:b3c9f16cbb96 23 * > // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
simon.ford@mbed.co.uk 18:b3c9f16cbb96 24 * > #define LED_MASK 0x00B40000
simon.ford@mbed.co.uk 18:b3c9f16cbb96 25 * >
simon.ford@mbed.co.uk 18:b3c9f16cbb96 26 * > PortOut ledport(Port1, LED_MASK);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 27 * >
simon.ford@mbed.co.uk 18:b3c9f16cbb96 28 * > int main() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 29 * > while(1) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 30 * > ledport = LED_MASK;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 31 * > wait(1);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 32 * > ledport = 0;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 33 * > wait(1);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 34 * > }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 35 * > }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 36 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 37 class PortOut {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 38 public:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 39
simon.ford@mbed.co.uk 18:b3c9f16cbb96 40 /* Constructor: PortOut
simon.ford@mbed.co.uk 18:b3c9f16cbb96 41 * Create an PortOut, connected to the specified port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 42 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 43 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 44 * port - Port to connect to (Port0-Port5)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 45 * mask - A bitmask to identify which bits in the port should be included (0 - ignore)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 46 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 47 PortOut(PortName port, int mask = 0xFFFFFFFF);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 48
simon.ford@mbed.co.uk 18:b3c9f16cbb96 49 /* Function: write
simon.ford@mbed.co.uk 18:b3c9f16cbb96 50 * Write the value to the output port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 51 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 52 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 53 * value - An integer specifying a bit to write for every corresponding PortOut pin
simon.ford@mbed.co.uk 18:b3c9f16cbb96 54 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 55 void write(int value) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 56 _gpio->FIOSET = value & _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 57 _gpio->FIOCLR = ~(value) & _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 58 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 59
simon.ford@mbed.co.uk 18:b3c9f16cbb96 60 /* Function: read
simon.ford@mbed.co.uk 18:b3c9f16cbb96 61 * Read the value currently output on the port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 62 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 63 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 64 * returns - An integer with each bit corresponding to associated PortOut pin setting
simon.ford@mbed.co.uk 18:b3c9f16cbb96 65 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 66 int read() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 67 return _gpio->FIOPIN & _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 68 }
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 PortOut& 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 PortOut& operator= (PortOut& 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