#include <modm/platform/rtt/rtt.hpp>
 | 
| 
static void  | writeBlocking (uint8_t data) | 
|   | 
| 
static void  | writeBlocking (const uint8_t *data, std::size_t length) | 
|   | 
| 
static void  | flushWriteBuffer () | 
|   | 
| 
static bool  | write (uint8_t data) | 
|   | 
| 
static std::size_t  | write (const uint8_t *data, std::size_t length) | 
|   | 
| 
static bool  | isWriteFinished () | 
|   | 
| 
static std::size_t  | transmitBufferSize () | 
|   | 
| 
static std::size_t  | discardTransmitBuffer () | 
|   | 
| 
static bool  | read (uint8_t &data) | 
|   | 
| 
static std::size_t  | read (uint8_t *data, std::size_t length) | 
|   | 
| 
static std::size_t  | receiveBufferSize () | 
|   | 
| 
static std::size_t  | discardReceiveBuffer () | 
|   | 
| 
static bool  | hasError () | 
|   | 
| 
static void  | clearError () | 
|   | 
| static void  | acknowledgeInterruptFlag () | 
|   | 
| template<uint64_t available, uint64_t requested, percent_t tolerance>  | 
| static void  | assertBaudrateInTolerance () | 
|   | 
| 
template<double available, double requested, percent_t tolerance>  | 
| static void  | assertDurationInTolerance () | 
|   | 
| 
static void  | configurePurpose () | 
|   | configures a peripheral for a specific purpose 
  | 
|   | 
| template<class... Signals>  | 
| static void  | connect () | 
|   | 
| 
static bool  | getInterruptFlag () | 
|   | Read an interrupt flag. 
  | 
|   | 
| 
static void  | getParameter () | 
|   | returns a parameter 
  | 
|   | 
| template<class SystemClock , baudrate_t baudrate, percent_t tolerance = 10_pct>  | 
| static void  | initialize () | 
|   | 
| 
static void  | setParameter () | 
|   | sets a parameter 
  | 
|   | 
 | 
| 
static constexpr size_t  | RxBufferSize = 16 | 
|   | Size of the receive buffer. 
  | 
|   | 
| 
static constexpr size_t  | TxBufferSize = 16 | 
|   | Size of the transmit buffer. 
  | 
|   | 
template<uint8_t Channel>
class modm::platform::Rtt< Channel >
Real Time Transfer (RTT) Uart Interface
- Author
 - Niklas Hauser 
 
 
  
  
      
        
          | static void modm::PeripheralDriver::acknowledgeInterruptFlag  | 
          ( | 
           | ) | 
           | 
         
       
   | 
  
inheritedstatic   | 
  
 
Acknowledge an interrupt flag.
We use acknowledge here, since it describes the intention rather than the actual implementation. 
 
 
template<uint64_t available, uint64_t requested, percent_t tolerance> 
  
  
      
        
          | static void modm::PeripheralDriver::assertBaudrateInTolerance  | 
          ( | 
           | ) | 
           | 
         
       
   | 
  
inheritedinlinestatic   | 
  
 
Since baudrates are usually generated by prescaling a system clock, only several distinct values can be generated. This method checks if the user requested baudrate is within error tolerance of the system achievable baudrate. 
 
 
template<class... Signals> 
  
  
      
        
          | static void modm::Uart::connect  | 
          ( | 
           | ) | 
           | 
         
       
   | 
  
inheritedstatic   | 
  
 
Connect GPIOs to the peripheral and configure them.
This configures the Tx and Rx signals as output and input and connects them.
- Template Parameters
 - 
  
    | Signals | One Tx and one Rx signal are required and can be passed out-of-order.  | 
  
   
 
 
template<class SystemClock , baudrate_t baudrate, percent_t tolerance = 10_pct> 
  
  
      
        
          | static void modm::Uart::initialize  | 
          ( | 
           | ) | 
           | 
         
       
   | 
  
inheritedstatic   | 
  
 
Initializes the hardware and sets the baudrate.
- Template Parameters
 - 
  
    | SystemClock | the currently active system clock  | 
    | baudrate | desired baud rate in Hz  | 
    | tolerance | the allowed absolute tolerance for the resulting baudrate  | 
  
   
 
 
The documentation for this class was generated from the following file: