mbed library sources
Fork of mbed-src by
Diff: api/Serial.h
- Revision:
- 15:4892fe388435
- Parent:
- 13:0645d8841f51
diff -r 096882eb0961 -r 4892fe388435 api/Serial.h --- a/api/Serial.h Mon Aug 05 14:54:27 2013 +0000 +++ b/api/Serial.h Wed Aug 07 16:43:59 2013 +0300 @@ -23,6 +23,7 @@ #include "Stream.h" #include "FunctionPointer.h" #include "serial_api.h" +#include "CallChain.h" namespace mbed { @@ -82,7 +83,7 @@ * @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) */ - void format(int bits = 8, Parity parity=Serial::None, int stop_bits=1); + void format(int bits=8, Parity parity=Serial::None, int stop_bits=1); /** Determine if there is a character available to read * @@ -104,23 +105,95 @@ * * @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) + * + * @returns + * The function object created for 'fptr' */ - void attach(void (*fptr)(void), IrqType type=RxIrq); + pFunctionPointer_t attach(void (*fptr)(void), IrqType type=RxIrq); + + /** Add a function to be called when a serial interrupt is generated at the end of the call chain + * + * @param fptr the function to add + * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty) + * + * @returns + * The function object created for 'fptr' + */ + pFunctionPointer_t add_handler(void (*fptr)(void), IrqType type=RxIrq) { + return add_handler_helper(fptr, type); + } + + /** Add a function to be called when a serial interrupt is generated at the beginning of the call chain + * + * @param fptr the function to add + * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty) + * + * @returns + * The function object created for 'fptr' + */ + pFunctionPointer_t add_handler_front(void (*fptr)(void), IrqType type=RxIrq) { + return add_handler_helper(fptr, type, true); + } /** Attach a member function to call whenever a serial interrupt is generated * * @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) + * + * @param + * The function object created for 'tptr' and 'mptr' + */ + template<typename T> + pFunctionPointer_t attach(T* tptr, void (T::*mptr)(void), IrqType type=RxIrq) { + if((mptr != NULL) && (tptr != NULL)) { + _irq[type].clear(); + pFunctionPointer_t pf = _irq[type].add(tptr, mptr); + serial_irq_set(&_serial, (SerialIrq)type, 1); + return pf; + } + else + return NULL; + } + + /** Add a function to be called when a serial interrupt is generated at the end of the call chain + * + * @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) + * + * @returns + * The function object created for 'fptr' */ template<typename T> - void attach(T* tptr, void (T::*mptr)(void), IrqType type=RxIrq) { - if((mptr != NULL) && (tptr != NULL)) { - _irq[type].attach(tptr, mptr); - serial_irq_set(&_serial, (SerialIrq)type, 1); - } + pFunctionPointer_t add_handler(T* tptr, void (T::*mptr)(void), IrqType type=RxIrq) { + return add_handler_helper(tptr, mptr, type); } + /** Add a function to be called when a serial interrupt is generated at the beginning of the call chain + * + * @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) + * + * @returns + * The function object created for 'fptr' + */ + template<typename T> + pFunctionPointer_t add_handler_front(T* tptr, void (T::*mptr)(void), IrqType type=RxIrq) { + return add_handler_helper(tptr, mptr, type, true); + } + + /** Remove a function from the list of functions to be called when a serial interrupt is generated + * + * @param pf the function object to remove + * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty) + * + * @returns + * true if the function was found and removed, false otherwise + */ + bool remove_handler(pFunctionPointer_t pf, IrqType type=RxIrq); + /** Generate a break condition on the serial line */ void send_break(); @@ -130,9 +203,21 @@ protected: virtual int _getc(); virtual int _putc(int c); + pFunctionPointer_t add_handler_helper(void (*function)(void), IrqType type, bool front=false); + + template<typename T> + pFunctionPointer_t add_handler_helper(T* tptr, void (T::*mptr)(void), IrqType type, bool front=false) { + if ((mptr != NULL) && (tptr != NULL)) { + pFunctionPointer_t pf = front ? _irq[type].add_front(tptr, mptr) : _irq[type].add(tptr, mptr); + serial_irq_set(&_serial, (SerialIrq)type, 1); + return pf; + } + else + return NULL; + } serial_t _serial; - FunctionPointer _irq[2]; + CallChain _irq[2]; int _baud; };