Upgrade gcc4mbed project used by Smoothie.

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

/* mbed Microcontroller Library - PortOut\r
 * Copyright (c) 2006-2011 ARM Limited. All rights reserved.\r
 */ \r
 \r
#ifndef MBED_PORTOUT_H\r
#define MBED_PORTOUT_H\r
\r
#include "device.h"\r
\r
#if DEVICE_PORTOUT\r
\r
#include "platform.h"\r
#include "PinNames.h"\r
#include "Base.h"\r
\r
#include "PortNames.h"\r
\r
namespace mbed {\r
/* Class: PortOut\r
 *   A multiple pin digital out\r
 *\r
 * Example:\r
 * > // Toggle all four LEDs\r
 * >\r
 * > #include "mbed.h"\r
 * >\r
 * > // LED1 = P1.18  LED2 = P1.20  LED3 = P1.21  LED4 = P1.23\r
 * > #define LED_MASK 0x00B40000\r
 * >\r
 * > PortOut ledport(Port1, LED_MASK);\r
 * >\r
 * > int main() {\r
 * >     while(1) {\r
 * >         ledport = LED_MASK;\r
 * >         wait(1);\r
 * >         ledport = 0;\r
 * >         wait(1);\r
 * >     }\r
 * > }\r
 */  \r
class PortOut {\r
public:\r
\r
    /* Constructor: PortOut\r
     *  Create an PortOut, 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
    PortOut(PortName port, int mask = 0xFFFFFFFF);\r
\r
    /* Function: write\r
     *  Write the value to the output port\r
     *\r
     * Variables:\r
     *  value - An integer specifying a bit to write for every corresponding PortOut pin\r
     */    \r
    void write(int value);\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 PortOut pin setting\r
     */\r
    int read();\r
\r
    /* Function: operator=\r
     *  A shorthand for <write>\r
     */    \r
    PortOut& operator= (int value) { \r
    	write(value);\r
	    return *this;\r
    }\r
    \r
    PortOut& operator= (PortOut& rhs) { \r
    	write(rhs.read());\r
	    return *this;\r
    }\r
    \r
    /* Function: operator int()\r
     *  A shorthand for <read>\r
     */\r
    operator int() { \r
	    return read();\r
    }\r
\r
private:\r
#if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)\r
    LPC_GPIO_TypeDef    *_gpio;\r
#endif\r
    PortName            _port;\r
    uint32_t            _mask;\r
};\r
\r
} // namespace mbed\r
\r
#endif\r
\r
#endif\r