first commit

[clinton/Smoothieware.git] / gcc4mbed / external / mbed / PortIn.h

/* mbed Microcontroller Library - PortInOut\r
 * Copyright (c) 2006-2009 ARM Limited. All rights reserved.\r
 */ \r
 \r
#ifndef MBED_PORTIN_H\r
#define MBED_PORTIN_H\r
\r
#include "PortNames.h"\r
#include "PinNames.h"\r
\r
namespace mbed {\r
\r
/* Class: PortIn\r
 *  A multiple pin digital input\r
 *\r
 *  Example:\r
 *  > // Switch on an LED if any of mbed pins 21-26 is high\r
 *  >\r
 *  > #include "mbed.h"\r
 *  >\r
 *  > PortIn     p(Port2, 0x0000003F);   // p21-p26\r
 *  > DigitalOut ind(LED4);\r
 *  >\r
 *  > int main() {\r
 *  >     while(1) {\r
 *  >         int pins = p.read();\r
 *  >         if(pins) {\r
 *  >             ind = 1;\r
 *  >         } else {\r
 *  >             ind = 0;\r
 *  >         }\r
 *  >     }\r
 *  > }\r
 */\r
class PortIn {\r
public:\r
\r
    /* Constructor: PortIn\r
     *  Create an PortIn, connected to the specified port\r
     *\r
     * Variables:\r
     *  port - Port to connect to (Port0-Port5)\r
     *  mask - A bitmask to identify which bits in the port should be included (0 - ignore)\r
   	 */ \r
    PortIn(PortName port, int mask = 0xFFFFFFFF);\r
\r
    /* Function: read\r
     *  Read the value currently output on the port\r
     *\r
     * Variables:\r
     *  returns - An integer with each bit corresponding to associated port pin setting\r
     */\r
    int read() {\r
        return _gpio->FIOPIN & _mask;\r
    }\r
\r
    /* Function: mode\r
     *  Set the input pin mode\r
     *\r
     * Variables:\r
     *  mode - PullUp, PullDown, PullNone, OpenDrain\r
     */\r
    void mode(PinMode mode);\r
    \r
    /* Function: operator int()\r
     *  A shorthand for <read>\r
     */\r
    operator int() { \r
	    return read();\r
    }\r
\r
private:\r
    LPC_GPIO_TypeDef    *_gpio;\r
    PortName            _port;\r
    uint32_t            _mask;    \r
};\r
\r
} // namespace mbed\r
\r
#endif\r