mbed libraries for KL25Z
Diff: Serial.h
- Revision:
- 8:c14af7958ef5
- Parent:
- 7:73c5efe92a6c
- Child:
- 9:663789d7729f
--- a/Serial.h Tue Oct 23 09:20:18 2012 +0000 +++ b/Serial.h Fri Nov 09 11:33:53 2012 +0000 @@ -4,140 +4,90 @@ #ifndef MBED_SERIAL_H #define MBED_SERIAL_H -#include "device.h" +#include "platform.h" #if DEVICE_SERIAL -#include "platform.h" #include "Stream.h" #include "FunctionPointer.h" #include "serial_api.h" namespace mbed { -/* Class: Serial - * A serial port (UART) for communication with other serial devices +/** A serial port (UART) for communication with other serial devices * * Can be used for Full Duplex communication, or Simplex by specifying * one pin as NC (Not Connected) * * Example: - * > // Print "Hello World" to the PC - * > - * > #include "mbed.h" - * > - * > Serial pc(USBTX, USBRX); - * > - * > int main() { - * > pc.printf("Hello World\n"); - * > } + * @code + * // Print "Hello World" to the PC + * + * #include "mbed.h" + * + * Serial pc(USBTX, USBRX); + * + * int main() { + * pc.printf("Hello World\n"); + * } + * @endcode */ class Serial : public Stream { public: - /* Constructor: Serial - * Create a Serial port, connected to the specified transmit and receive pins + + /** Create a Serial port, connected to the specified transmit and receive pins * - * Variables: - * tx - Transmit pin - * rx - Receive pin + * @param tx Transmit pin + * @param rx Receive pin * - * Note: Either tx or rx may be specified as NC if unused + * @note + * Either tx or rx may be specified as NC if unused */ - Serial(PinName tx, PinName rx, const char *name = NULL); + Serial(PinName tx, PinName rx); - /* Function: baud - * Set the baud rate of the serial port + /** Set the baud rate of the serial port * - * Variables: - * baudrate - The baudrate of the serial port (default = 9600). + * @param baudrate The baudrate of the serial port (default = 9600). */ void baud(int baudrate); - /* Function: format - * Set the transmission format used by the Serial port - * - * Variables: - * bits - The number of bits in a word (5-8; default = 8) - * parity - The parity used (Serial::None, Serial::Odd, Serial::Even, Serial::Forced1, Serial::Forced0; default = Serial::None) - * stop - The number of stop bits (1 or 2; default = 1) - */ - void format(int bits = 8, SerialParity parity=ParityNone, int stop_bits=1); - -#if 0 // Inhereted from Stream, for documentation only - - /* Function: putc - * Write a character - * - * Variables: - * c - The character to write to the serial port - */ - int putc(int c); - - /* Function: getc - * Read a character - * - * Reads a character from the serial port. This will block until - * a character is available. To see if a character is available, - * see <readable> + /** Set the transmission format used by the Serial port * - * Variables: - * returns - The character read from the serial port + * @param bits The number of bits in a word (5-8; default = 8) + * @param parity The parity used (Serial::None, Serial::Odd, Serial::Even, Serial::Forced1, Serial::Forced0; default = Serial::None) + * @param stop The number of stop bits (1 or 2; default = 1) */ - int getc(); - - /* Function: printf - * Write a formated string - * - * Variables: - * format - A printf-style format string, followed by the - * variables to use in formating the string. - */ - int printf(const char* format, ...); + void format(int bits = 8, SerialParity parity=ParityNone, int stop_bits=1); - /* Function: scanf - * Read a formated string + /** Determine if there is a character available to read * - * Variables: - * format - A scanf-style format string, - * followed by the pointers to variables to store the results. - */ - int scanf(const char* format, ...); - -#endif - - /* Function: readable - * Determine if there is a character available to read - * - * Variables: - * returns - 1 if there is a character available to read, else 0 + * @returns + * 1 if there is a character available to read, + * 0 otherwise */ int readable(); - /* Function: writeable - * Determine if there is space available to write a character + /** Determine if there is space available to write a character * - * Variables: - * returns - 1 if there is space to write a character, else 0 + * @returns + * 1 if there is space to write a character, + * 0 otherwise */ int writeable(); - /* Function: attach - * Attach a function to call whenever a serial interrupt is generated + /** Attach a function to call whenever a serial interrupt is generated * - * Variables: - * fptr - A pointer to a void function, or 0 to set as none - * type - Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty) + * @param fptr A pointer to a void function, or 0 to set as none + * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty) */ void attach(void (*fptr)(void), SerialIrq type=RxIrq); - /* Function: attach - * Attach a member function to call whenever a serial interrupt is generated + /** Attach a member function to call whenever a serial interrupt is generated * - * Variables: - * tptr - pointer to the object to call the member function on - * mptr - pointer to the member function to be called - * type - Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty) + * @param tptr pointer to the object to call the member function on + * @param mptr pointer to the member function to be called + * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty) */ template<typename T> void attach(T* tptr, void (T::*mptr)(void), SerialIrq type=RxIrq) { @@ -147,11 +97,6 @@ } } -#ifdef MBED_RPC - virtual const struct rpc_method *get_rpc_methods(); - static struct rpc_class *get_rpc_class(); -#endif - static void _irq_handler(uint32_t id, SerialIrq irq_type); protected: