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

PortIn.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:
27:7110ebee3484
* 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_PORTIN_H
simon.ford@mbed.co.uk 18:b3c9f16cbb96 6 #define MBED_PORTIN_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: PortIn
simon.ford@mbed.co.uk 18:b3c9f16cbb96 14 * A multiple pin digital input
simon.ford@mbed.co.uk 18:b3c9f16cbb96 15 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 16 * Example:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 17 * > // Switch on an LED if any of mbed pins 21-26 is high
simon.ford@mbed.co.uk 18:b3c9f16cbb96 18 * >
simon.ford@mbed.co.uk 18:b3c9f16cbb96 19 * > #include "mbed.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 20 * >
simon.ford@mbed.co.uk 18:b3c9f16cbb96 21 * > PortIn p(Port2, 0x0000003F); // p21-p26
simon.ford@mbed.co.uk 18:b3c9f16cbb96 22 * > DigitalOut ind(LED4);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 23 * >
simon.ford@mbed.co.uk 18:b3c9f16cbb96 24 * > int main() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 25 * > while(1) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 26 * > int pins = p.read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 27 * > if(pins) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 28 * > ind = 1;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 29 * > } else {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 30 * > ind = 0;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 31 * > }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 32 * > }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 33 * > }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 34 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 35 class PortIn {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 36 public:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 37
simon.ford@mbed.co.uk 18:b3c9f16cbb96 38 /* Constructor: PortIn
simon.ford@mbed.co.uk 18:b3c9f16cbb96 39 * Create an PortIn, connected to the specified port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 40 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 41 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 42 * port - Port to connect to (Port0-Port5)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 43 * mask - A bitmask to identify which bits in the port should be included (0 - ignore)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 44 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 45 PortIn(PortName port, int mask = 0xFFFFFFFF);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 46
simon.ford@mbed.co.uk 18:b3c9f16cbb96 47 /* Function: read
simon.ford@mbed.co.uk 18:b3c9f16cbb96 48 * Read the value currently output on the port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 49 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 50 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 51 * returns - An integer with each bit corresponding to associated port pin setting
simon.ford@mbed.co.uk 18:b3c9f16cbb96 52 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 53 int read() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 54 return _gpio->FIOPIN & _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 55 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 56
simon.ford@mbed.co.uk 18:b3c9f16cbb96 57 /* Function: mode
simon.ford@mbed.co.uk 18:b3c9f16cbb96 58 * Set the input pin mode
simon.ford@mbed.co.uk 18:b3c9f16cbb96 59 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 60 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 61 * mode - PullUp, PullDown, PullNone, OpenDrain
simon.ford@mbed.co.uk 18:b3c9f16cbb96 62 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 63 void mode(PinMode mode);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 64
simon.ford@mbed.co.uk 18:b3c9f16cbb96 65 /* Function: operator int()
simon.ford@mbed.co.uk 18:b3c9f16cbb96 66 * A shorthand for <read>
simon.ford@mbed.co.uk 18:b3c9f16cbb96 67 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 68 operator int() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 69 return read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 70 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 71
simon.ford@mbed.co.uk 18:b3c9f16cbb96 72 private:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 73 LPC_GPIO_TypeDef *_gpio;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 74 PortName _port;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 75 uint32_t _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 76 };
simon.ford@mbed.co.uk 18:b3c9f16cbb96 77
simon.ford@mbed.co.uk 18:b3c9f16cbb96 78 } // namespace mbed
simon.ford@mbed.co.uk 18:b3c9f16cbb96 79
simon.ford@mbed.co.uk 18:b3c9f16cbb96 80 #endif