no-OS
Macros | Functions
no_os_uart.c File Reference
#include <xparameters.h>
#include <stdio.h>
#include <stdlib.h>
#include "no_os_error.h"
#include "no_os_uart.h"
#include "uart_extra.h"
Include dependency graph for no_os_uart.c:

Macros

#define WRITE_SIZE   255
 

Functions

int32_t no_os_uart_read (struct no_os_uart_desc *desc, uint8_t *data, uint32_t bytes_number)
 Read data from UART device. More...
 
int32_t no_os_uart_write (struct no_os_uart_desc *desc, const uint8_t *data, uint32_t bytes_number)
 Write data to UART device. More...
 
int32_t no_os_uart_init (struct no_os_uart_desc **desc, struct no_os_uart_init_param *param)
 Initialize the UART communication peripheral. More...
 
int32_t no_os_uart_remove (struct no_os_uart_desc *desc)
 Free the resources allocated by no_os_uart_init(). More...
 
uint32_t no_os_uart_get_errors (struct no_os_uart_desc *desc)
 Get number of UART errors. More...
 
int32_t no_os_uart_read_nonblocking (struct no_os_uart_desc *desc, uint8_t *data, uint32_t bytes_number)
 Submit reading buffer to the UART driver. More...
 

Macro Definition Documentation

◆ WRITE_SIZE

#define WRITE_SIZE   255

Function Documentation

◆ no_os_uart_get_errors()

uint32_t no_os_uart_get_errors ( struct no_os_uart_desc desc)

Get number of UART errors.

Free the resources allocated by no_os_uart_init().

Parameters
desc- The UART descriptor.
Returns
number of errors.

◆ no_os_uart_init()

int32_t no_os_uart_init ( struct no_os_uart_desc **  desc,
struct no_os_uart_init_param param 
)

Initialize the UART communication peripheral.

Parameters
desc- The UART descriptor.
param- The structure that contains the UART parameters.
Returns
0 in case of success, -1 otherwise.
Here is the caller graph for this function:

◆ no_os_uart_read()

int32_t no_os_uart_read ( struct no_os_uart_desc desc,
uint8_t *  data,
uint32_t  bytes_number 
)

Read data from UART device.

Read data from UART. Blocking function.

Parameters
desc- Instance of UART.
data- Pointer to buffer containing data.
bytes_number- Number of bytes to read.
Returns
0 in case of success, -1 otherwise.
Here is the caller graph for this function:

◆ no_os_uart_read_nonblocking()

int32_t no_os_uart_read_nonblocking ( struct no_os_uart_desc desc,
uint8_t *  data,
uint32_t  bytes_number 
)

Submit reading buffer to the UART driver.

Buffer is used until bytes_number bytes are read.

Parameters
descDescriptor of the UART device
dataBuffer where data will be read
bytes_numberNumber of bytes to be read
Returns
0 in case of success, -1 otherwise.

Buffer is used until bytes_number bytes are read.

Parameters
descDescriptor of the UART device
dataBuffer where data will be read
bytes_numberNumber of bytes to be read.
Returns
0 in case of success, -1 otherwise.

Submit reading buffer to the UART driver.

Parameters
desc- Instance of UART.
data- Pointer to buffer containing data.
bytes_number- Number of bytes to read.
Returns
positive number of received bytes in case of success, negative error code otherwise.

◆ no_os_uart_remove()

int32_t no_os_uart_remove ( struct no_os_uart_desc desc)

Free the resources allocated by no_os_uart_init().

Free the resources allocated by no_os_uart_init().

Parameters
desc- The UART descriptor.
Returns
0 in case of success, -1 otherwise.

Unregistering the callback is necessary only for this target because this operation is not done by the driver on init.

Here is the caller graph for this function:

◆ no_os_uart_write()

int32_t no_os_uart_write ( struct no_os_uart_desc desc,
const uint8_t *  data,
uint32_t  bytes_number 
)

Write data to UART device.

Write data to UART. Blocking function.

Parameters
desc- Instance of UART.
data- Pointer to buffer containing data.
bytes_number- Number of bytes to read.
Returns
0 in case of success, -1 otherwise.
Here is the caller graph for this function: