Upgrade gcc4mbed project used by Smoothie.

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

/* mbed Microcontroller Library - Serial\r
 * Copyright (c) 2007-2011 ARM Limited. All rights reserved.\r
 */ \r
 \r
#ifndef MBED_SERIAL_H\r
#define MBED_SERIAL_H\r
\r
#include "device.h"\r
\r
#if DEVICE_SERIAL\r
\r
#include "platform.h"\r
#include "PinNames.h"\r
#include "PeripheralNames.h"\r
#include "Stream.h"\r
#include "FunctionPointer.h"\r
\r
namespace mbed {\r
\r
/* Class: Serial\r
 *  A serial port (UART) for communication with other serial devices\r
 *\r
 * Can be used for Full Duplex communication, or Simplex by specifying \r
 * one pin as NC (Not Connected)\r
 *\r
 * Example:\r
 * > // Print "Hello World" to the PC\r
 * >\r
 * > #include "mbed.h"\r
 * >\r
 * > Serial pc(USBTX, USBRX);\r
 * >\r
 * > int main() {\r
 * >     pc.printf("Hello World\n");\r
 * > }\r
 */\r
class Serial : public Stream {\r
\r
public:\r
\r
    /* Constructor: Serial\r
     *  Create a Serial port, connected to the specified transmit and receive pins\r
     *\r
     * Variables:\r
     *  tx - Transmit pin \r
     *  rx - Receive pin\r
     *\r
     *  Note: Either tx or rx may be specified as NC if unused\r
     */\r
    Serial(PinName tx, PinName rx, const char *name = NULL);\r
\r
    /* Function: baud\r
     *  Set the baud rate of the serial port\r
     *  \r
     * Variables:\r
     *  baudrate - The baudrate of the serial port (default = 9600).\r
     */\r
    void baud(int baudrate);\r
\r
    enum Parity {\r
        None = 0\r
        , Odd\r
        , Even\r
        , Forced1    \r
        , Forced0\r
    };\r
\r
    enum IrqType {\r
        RxIrq = 0\r
        , TxIrq\r
    };\r
\r
    /* Function: format\r
     *  Set the transmission format used by the Serial port\r
     *\r
     * Variables:\r
     *  bits - The number of bits in a word (5-8; default = 8)\r
     *  parity - The parity used (Serial::None, Serial::Odd, Serial::Even, Serial::Forced1, Serial::Forced0; default = Serial::None)\r
     *  stop - The number of stop bits (1 or 2; default = 1)\r
     */\r
    void format(int bits = 8, Parity parity = Serial::None, int stop_bits = 1); \r
\r
#if 0 // Inhereted from Stream, for documentation only\r
\r
    /* Function: putc\r
     *  Write a character\r
     *\r
     * Variables:\r
     *  c - The character to write to the serial port\r
     */\r
    int putc(int c);\r
\r
    /* Function: getc\r
     *  Read a character\r
     *\r
     * Reads a character from the serial port. This will block until \r
     * a character is available. To see if a character is available, \r
     * see <readable>\r
     *\r
     * Variables:\r
     *  returns - The character read from the serial port\r
     */\r
    int getc();\r
\r
    /* Function: printf\r
     *  Write a formated string\r
     *\r
     * Variables:\r
     *  format - A printf-style format string, followed by the \r
     *      variables to use in formating the string.\r
     */\r
    int printf(const char* format, ...);\r
\r
    /* Function: scanf\r
     *  Read a formated string \r
     *\r
     * Variables:\r
     *  format - A scanf-style format string,\r
     *      followed by the pointers to variables to store the results. \r
     */\r
    int scanf(const char* format, ...);\r
 \r
#endif\r
 \r
    /* Function: readable\r
     *  Determine if there is a character available to read\r
     *\r
     * Variables:\r
     *  returns - 1 if there is a character available to read, else 0\r
     */\r
    int readable();\r
\r
    /* Function: writeable\r
     *  Determine if there is space available to write a character\r
     * \r
     * Variables:\r
     *  returns - 1 if there is space to write a character, else 0\r
     */\r
    int writeable();\r
\r
    /* Function: attach\r
     *  Attach a function to call whenever a serial interrupt is generated\r
     *\r
     * Variables:\r
     *  fptr - A pointer to a void function, or 0 to set as none\r
     *  type - Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)\r
     */\r
    void attach(void (*fptr)(void), IrqType type = RxIrq);\r
\r
    /* Function: attach\r
     *  Attach a member function to call whenever a serial interrupt is generated\r
     *     \r
     * Variables:\r
     *  tptr - pointer to the object to call the member function on\r
     *  mptr - pointer to the member function to be called\r
     *  type - Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)\r
     */\r
    template<typename T>\r
    void attach(T* tptr, void (T::*mptr)(void), IrqType type = RxIrq) {\r
        if((mptr != NULL) && (tptr != NULL)) {\r
            _irq[type].attach(tptr, mptr);\r
            setup_interrupt(type);\r
        }\r
    }\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
    void setup_interrupt(IrqType type);\r
    void remove_interrupt(IrqType type);\r
\r
    virtual int _getc();\r
    virtual int _putc(int c);\r
\r
    UARTName _uart;\r
    FunctionPointer _irq[2];\r
    int _uidx;\r
\r
};\r
\r
} // namespace mbed\r
\r
#endif\r
\r
#endif\r