Uart3 Class Reference
#include <uart3.hpp>
Inheritance diagram for Uart3:
Collaboration diagram for Uart3:
Public Member Functions | |
| bool | init (unsigned int baudRate, int rxQSize=32, int txQSize=64) |
 Public Member Functions inherited from UartDev | |
| void | setBaudRate (unsigned int baudRate) |
| Reset the baud-rate after UART has been initialized. More... | |
| bool | getChar (char *pInputChar, unsigned int timeout=portMAX_DELAY) |
| bool | putChar (char out, unsigned int timeout=portMAX_DELAY) |
| bool | flush (void) |
| Flushed all pending transmission of the uart queue. More... | |
| void | handleInterrupt () |
| unsigned int | getRxQueueSize () const |
| unsigned int | getTxQueueSize () const |
| unsigned int | getRxQueueWatermark () const |
| unsigned int | getTxQueueWatermark () const |
| bool | recentlyActive (unsigned int ms=3000) const |
| TickType_t | getLastActivityTime (void) const |
| void | resetActivity (void) |
| Public Member Functions inherited from CharDev | |
| bool | gets (char *pBuff, int maxLen, unsigned int timeout=0xffffffff) |
| int | printf (const char *format,...) |
| int | scanf (const char *format,...) |
| uint16_t | getPrintfMemSize (void) const |
| bool | put (const char *pString, unsigned int timeout=0xffffffff) |
| void | putline (const char *pBuff, unsigned int timeout=0xffffffff) |
| bool | isReady (void) |
| void | setReady (bool r) |
Friends | |
| class | SingletonTemplate< Uart3 > |
| Friend class used for Singleton Template. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from SingletonTemplate< Uart3 > | |
| static Uart3 & | getInstance () |
| Public member to get instance of this SINGLETON class. More... | |
| Protected Member Functions inherited from UartDev | |
| bool | init (unsigned int pclk, unsigned int baudRate, int rxQSize=32, int txQSize=32) |
| UartDev (unsigned int *pUARTBaseAddr) | |
| ~UartDev () | |
| Protected Member Functions inherited from CharDev | |
| CharDev () | |
| virtual | ~CharDev () |
| Protected Member Functions inherited from SingletonTemplate< Uart3 > | |
| SingletonTemplate () | |
| Static Protected Attributes inherited from SingletonTemplate< Uart3 > | |
| static SingletonTemplate * | mpSingletonInstance |
Detailed Description
UART3 Interrupt Driven Driver This simply uses UartDev, and forwards the UART3 IRQ to UartDev::handleInterrupt() This enforces Singleton class, otherwise it's a thin wrapper around UartDev class.
Member Function Documentation
| bool Uart3::init | ( | unsigned int | baudRate, |
| int | rxQSize = 32, |
||
| int | txQSize = 64 |
||
| ) |
Initializes UART3 at the given
- Parameters
-
baudRate rxQSize The size of the receive queue (optional, defaults to 32) txQSize The size of the transmit queue (optional, defaults to 64)
Friends And Related Function Documentation
|
friend |
Friend class used for Singleton Template.
The documentation for this class was generated from the following files:
