mbed libraries for KL25Z
Diff: PortIn.h
- Revision:
- 2:e9a661555b58
- Parent:
- 0:8024c367e29f
- Child:
- 7:73c5efe92a6c
--- a/PortIn.h Fri Oct 05 15:45:13 2012 +0000 +++ b/PortIn.h Wed Oct 10 14:14:12 2012 +0000 @@ -1,86 +1,86 @@ -/* mbed Microcontroller Library - PortInOut - * Copyright (c) 2006-2011 ARM Limited. All rights reserved. - */ - -#ifndef MBED_PORTIN_H -#define MBED_PORTIN_H - -#include "device.h" - -#if DEVICE_PORTIN - -#include "PortNames.h" -#include "PinNames.h" - -namespace mbed { - -/* Class: PortIn - * A multiple pin digital input - * - * Example: - * > // Switch on an LED if any of mbed pins 21-26 is high - * > - * > #include "mbed.h" - * > - * > PortIn p(Port2, 0x0000003F); // p21-p26 - * > DigitalOut ind(LED4); - * > - * > int main() { - * > while(1) { - * > int pins = p.read(); - * > if(pins) { - * > ind = 1; - * > } else { - * > ind = 0; - * > } - * > } - * > } - */ -class PortIn { -public: - - /* Constructor: PortIn - * Create an PortIn, connected to the specified port - * - * Variables: - * port - Port to connect to (Port0-Port5) - * mask - A bitmask to identify which bits in the port should be included (0 - ignore) - */ - PortIn(PortName port, int mask = 0xFFFFFFFF); - - /* Function: read - * Read the value currently output on the port - * - * Variables: - * returns - An integer with each bit corresponding to associated port pin setting - */ - int read(); - - /* Function: mode - * Set the input pin mode - * - * Variables: - * mode - PullUp, PullDown, PullNone, OpenDrain - */ - void mode(PinMode mode); - - /* Function: operator int() - * A shorthand for <read> - */ - operator int() { - return read(); - } - -private: -#if defined(TARGET_LPC1768) || defined(TARGET_LPC2368) - LPC_GPIO_TypeDef *_gpio; -#endif - PortName _port; - uint32_t _mask; -}; - -} // namespace mbed - -#endif - -#endif +/* mbed Microcontroller Library - PortInOut + * Copyright (c) 2006-2011 ARM Limited. All rights reserved. + */ + +#ifndef MBED_PORTIN_H +#define MBED_PORTIN_H + +#include "device.h" + +#if DEVICE_PORTIN + +#include "PortNames.h" +#include "PinNames.h" + +namespace mbed { + +/* Class: PortIn + * A multiple pin digital input + * + * Example: + * > // Switch on an LED if any of mbed pins 21-26 is high + * > + * > #include "mbed.h" + * > + * > PortIn p(Port2, 0x0000003F); // p21-p26 + * > DigitalOut ind(LED4); + * > + * > int main() { + * > while(1) { + * > int pins = p.read(); + * > if(pins) { + * > ind = 1; + * > } else { + * > ind = 0; + * > } + * > } + * > } + */ +class PortIn { +public: + + /* Constructor: PortIn + * Create an PortIn, connected to the specified port + * + * Variables: + * port - Port to connect to (Port0-Port5) + * mask - A bitmask to identify which bits in the port should be included (0 - ignore) + */ + PortIn(PortName port, int mask = 0xFFFFFFFF); + + /* Function: read + * Read the value currently output on the port + * + * Variables: + * returns - An integer with each bit corresponding to associated port pin setting + */ + int read(); + + /* Function: mode + * Set the input pin mode + * + * Variables: + * mode - PullUp, PullDown, PullNone, OpenDrain + */ + void mode(PinMode mode); + + /* Function: operator int() + * A shorthand for <read> + */ + operator int() { + return read(); + } + +private: +#if defined(TARGET_LPC1768) || defined(TARGET_LPC2368) + LPC_GPIO_TypeDef *_gpio; +#endif + PortName _port; + uint32_t _mask; +}; + +} // namespace mbed + +#endif + +#endif