Home
3 API
3.3 Safe PLIB
Safe PLIBs are used for setting up and controlling the operation of the peripherals.
3.3.13 SAFE_PLIB_SERCOM_USART
Set of safe functions for setting up and controlling the USART peripheral.
3.3.13.3 SERCOMx_USART_Read
Submits a read buffer to the given USART peripheral to process

1 Preface
2 Diagnostic Library for SAM C21
3 API
- 3.1 API Overview
- 3.2 Diagnostic Mechanisms
- 3.3 Safe PLIB
  Safe PLIBs are used for setting up and controlling the operation of the peripherals.
  - 3.3.1 SAFE_PLIB_ADC
    Set of safe functions for setting up and controlling the ADC peripheral.
  - 3.3.2 SAFE_PLIB_CAN
    Set of safe functions for setting up and controlling the CAN peripheral.
  - 3.3.3 SAFE_PLIB_DAC
    Set of safe functions for setting up and controlling the DAC peripheral.
  - 3.3.4 SAFE_PLIB_DIVAS
    Set of safe functions for setting up and controlling the DIVAS peripheral.
  - 3.3.5 SAFE_PLIB_DMAC
    Set of safe functions for setting up and controlling the DMAC peripheral.
  - 3.3.6 SAFE_PLIB_EIC
    Set of safe functions for setting up and controlling the EIC peripheral.
  - 3.3.7 SAFE_PLIB_FREQM
    Set of safe functions for setting up and controlling the FREQM peripheral.
  - 3.3.8 SAFE_PLIB_NVMCTRL
    Set of safe functions for setting up and controlling the NVMCTRL peripheral.
  - 3.3.9 SAFE_PLIB_PAC
    Set of safe functions for setting up and controlling the PAC peripheral.
  - 3.3.10 SAFE_PLIB_RSTC
    Set of safe functions for setting up and controlling the RSTC peripheral.
  - 3.3.11 SAFE_PLIB_RTC
    Set of safe functions for setting up and controlling the RTC peripheral.
  - 3.3.12 SAFE_PLIB_SDADC
    Set of safe functions for setting up and controlling the SDADC peripheral.
  - 3.3.13 SAFE_PLIB_SERCOM_USART
    Set of safe functions for setting up and controlling the USART peripheral.
    - 3.3.13.1 SERCOMx_USART_ErrorGet
      Gets the error of the given USART peripheral instance.
    - 3.3.13.2 SERCOMx_USART_Initialize
      Initializes given instance of the USART peripheral.
    - 3.3.13.3 SERCOMx_USART_Read
      Submits a read buffer to the given USART peripheral to process
    - 3.3.13.4 SERCOMx_USART_ReadCallbackRegister
      Sets the pointer to the function (and it's context) to be called when the given USART's read events occur.
    - 3.3.13.5 SERCOMx_USART_Write
      Submits a write buffer to the given USART peripheral to transfer
  - 3.3.14 SAFE_PLIB_TC
    Set of safe functions for setting up and controlling the TC peripheral.
  - 3.3.15 SAFE_PLIB_TCC
    Set of safe functions for setting up and controlling the TCC peripheral.
  - 3.3.16 SAFE_PLIB_WDT
    Set of safe functions for setting up and controlling the WDT peripheral.
4 Appendix - FMEDA to Diagnostic API Mapping
5 Known Issues
6 Revision History
Microchip Information

3.3.13.3 SERCOMx_USART_Read

Submits a read buffer to the given USART peripheral to process

This function submits a read buffer to the USART peripheral to process. A call to this function submits the buffer and the size to the peripheral library and returns immediately. The transfer completion status can either be checked through the callback mechanism or by calling the SERCOMx_USART_ReadIsBusy function. The success of the operation can be obtained by calling the SERCOMx_USART_ErrorGet function. If the SERCOMx_USART_ErrorGet function returns no error, then this means that the requested number of bytes have been processed. If the function returns some error, the SERCOMx_USART_ReadCountGet function can be called to know the number of bytes that were received till the error occurred.

bool 
SERCOMx_USART_Read
(
    void
);

Precondition

SERCOMx_USART_Initialize must have been called for the associated USART instance.

Parameters

void

Returns

bool - true - if the Read transaction is successful or if the requested size is 0, otherwise, false if the arguments are not valid or if the device is busy or if an error occurred while receiving data.