re-enabling serial

[clinton/Smoothieware.git] / gcc4mbed / external / mbed / .svn / text-base / DigitalInOut.h.svn-base

/* mbed Microcontroller Library - DigitalInOut\r
 * Copyright (c) 2006-2009 ARM Limited. All rights reserved.\r
 * sford\r
 */ \r
 \r
#ifndef MBED_DIGITALINOUT_H\r
#define MBED_DIGITALINOUT_H\r
\r
#include "platform.h"\r
#include "PinNames.h"\r
#include "PeripheralNames.h"\r
#include "Base.h"\r
\r
namespace mbed {\r
\r
/* Class: DigitalInOut\r
 *  A digital input/output, used for setting or reading a bi-directional pin\r
 */\r
class DigitalInOut : public Base {\r
\r
public:\r
\r
    /* Constructor: DigitalInOut\r
     *  Create a DigitalInOut connected to the specified pin\r
     *\r
     * Variables:\r
     *  pin - DigitalInOut pin to connect to\r
     */\r
    DigitalInOut(PinName pin, const char* name = NULL);\r
\r
    /* Function: write\r
     *  Set the output, specified as 0 or 1 (int)\r
     *\r
     * Variables:\r
     *  value - An integer specifying the pin output value, \r
     *      0 for logical 0 and 1 (or any other non-zero value) for logical 1 \r
     */\r
    void write(int value) {\r
        if(value) {\r
            _gpio->FIOSET = _mask;\r
        } else {\r
            _gpio->FIOCLR = _mask;\r
        }\r
    }\r
\r
    /* Function: read\r
     *  Return the output setting, represented as 0 or 1 (int)\r
     *\r
     * Variables:\r
     *  returns - An integer representing the output setting of the pin if it is an output, \r
     *      or read the input if set as an input\r
     */\r
    int read() {\r
        return ((_gpio->FIOPIN & _mask) ? 1 : 0);\r
    }\r
\r
\r
    /* Function: output\r
     *  Set as an output\r
     */\r
    void output();\r
\r
    /* Function: input\r
     *  Set as an input\r
     */\r
    void input();\r
\r
    /* Function: mode\r
     *  Set the input pin mode\r
     *\r
     * Variables:\r
     *  mode - PullUp, PullDown, PullNone, OpenDrain\r
     */\r
    void mode(PinMode pull);\r
    \r
#ifdef MBED_OPERATORS\r
    /* Function: operator=\r
     *  A shorthand for <write>\r
     */\r
    DigitalInOut& operator= (int value) {\r
        write(value);\r
        return *this;\r
    }\r
\r
    DigitalInOut& operator= (DigitalInOut& 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
#endif\r
\r
#ifdef MBED_RPC\r
    virtual const struct rpc_method *get_rpc_methods();\r
    static struct rpc_class *get_rpc_class();\r
#endif\r
\r
protected:\r
\r
    PinName             _pin;\r
    LPC_GPIO_TypeDef    *_gpio;\r
    uint32_t            _mask;\r
\r
};\r
\r
} // namespace mbed \r
\r
#endif \r