zpal_uart.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Silicon Laboratories Inc. <https://www.silabs.com/>
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef ZPAL_UART_H_
#define ZPAL_UART_H_
 
#include <stdbool.h>
#include <stddef.h>
#include "zpal_status.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define ZPAL_UART_CONFIG_FLAG_BLOCKING (1 << 1)
 
typedef enum
{
  ZPAL_UART0 = 0, 
  ZPAL_UART1,     
  ZPAL_UART2,     
} zpal_uart_id_t;
 
typedef enum
{
  ZPAL_UART_NO_PARITY,      
  ZPAL_UART_EVEN_PARITY,    
  ZPAL_UART_ODD_PARITY,     
} zpal_uart_parity_bit_t;
 
typedef enum
{
  ZPAL_UART_STOP_BITS_0P5,  
  ZPAL_UART_STOP_BITS_1,    
  ZPAL_UART_STOP_BITS_1P5,  
  ZPAL_UART_STOP_BITS_2,    
} zpal_uart_stop_bits_t;
 
typedef void * zpal_uart_handle_t;
 
typedef void (*zpal_uart_receive_callback_t)(zpal_uart_handle_t handle, size_t length);
 
typedef void (*zpal_uart_transmit_done_t)(zpal_uart_handle_t handle);
 
typedef struct {
  zpal_uart_id_t id;                              
  uint8_t *tx_buffer;                             
  size_t tx_buffer_len;                           
  uint8_t *rx_buffer;                             
  size_t rx_buffer_len;                           
  uint32_t baud_rate;                             
  uint8_t data_bits;                              
  zpal_uart_parity_bit_t parity_bit;              
  zpal_uart_stop_bits_t stop_bits;                
  zpal_uart_receive_callback_t receive_callback;  
  const void *ptr;                                
  uint8_t flags;                                  
} zpal_uart_config_t;
 
zpal_status_t zpal_uart_init(const zpal_uart_config_t *config, zpal_uart_handle_t *handle);
 
zpal_status_t zpal_uart_enable(zpal_uart_handle_t handle);
 
zpal_status_t zpal_uart_disable(zpal_uart_handle_t handle);
 
zpal_status_t zpal_uart_transmit(zpal_uart_handle_t handle, const uint8_t *data, size_t length,
                                 zpal_uart_transmit_done_t tx_cb);
 
bool zpal_uart_transmit_in_progress(zpal_uart_handle_t handle);
 
size_t zpal_uart_get_available(zpal_uart_handle_t handle);
 
size_t zpal_uart_receive(zpal_uart_handle_t handle, uint8_t *data, size_t length);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZPAL_UART_H_ */