VSF Documented
Data Structures | Macros | Typedefs | Functions
usart.c File Reference
#include "./usart.h"
#include "../io/io.h"
#include "../pm/pm.h"
#include "hal/driver/common/usart/usart_template.inc"

Data Structures

struct  vsf_hw_usart_const_t
 include the infrastructure More...
 
struct  vsf_hw_usart_t
 

Macros

#define VSF_USART_CFG_IMP_PREFIX   vsf_hw
 
#define VSF_USART_CFG_IMP_UPCASE_PREFIX   VSF_HW
 
#define VSF_USART_CFG_REQUEST_API   DISABLED
 
#define VSF_USART_CFG_REIMPLEMENT_API_CAPABILITY   DISABLED
 
#define VSF_USART_CFG_REIMPLEMENT_API_REQUEST   ENABLED
 
#define VSF_USART_CFG_IMP_LV0(__IDX, __HAL_OP)
 

Typedefs

typedef struct vsf_hw_usart_const_t vsf_hw_usart_const_t
 include the infrastructure
 
typedef struct vsf_hw_usart_t vsf_hw_usart_t
 

Functions

vsf_err_t vsf_hw_usart_init (vsf_hw_usart_t *usart_ptr, vsf_usart_cfg_t *cfg_ptr)
 
fsm_rt_t vsf_hw_usart_enable (vsf_hw_usart_t *usart_ptr)
 
fsm_rt_t vsf_hw_usart_disable (vsf_hw_usart_t *usart_ptr)
 
vsf_usart_status_t vsf_hw_usart_status (vsf_hw_usart_t *usart_ptr)
 
uint_fast16_t vsf_hw_usart_rxfifo_get_data_count (vsf_hw_usart_t *usart_ptr)
 
uint_fast16_t vsf_hw_usart_rxfifo_read (vsf_hw_usart_t *usart_ptr, void *buffer_ptr, uint_fast16_t count)
 
uint_fast16_t vsf_hw_usart_txfifo_get_free_count (vsf_hw_usart_t *usart_ptr)
 
uint_fast16_t vsf_hw_usart_txfifo_write (vsf_hw_usart_t *usart_ptr, void *buffer_ptr, uint_fast16_t count)
 
bool vsf_hw_usart_fifo_flush (vsf_hw_usart_t *usart_ptr)
 
void vsf_hw_usart_irq_enable (vsf_hw_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask)
 
void vsf_hw_usart_irq_disable (vsf_hw_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask)
 
vsf_err_t vsf_hw_usart_request_rx (vsf_hw_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count)
 
vsf_err_t vsf_hw_usart_request_tx (vsf_hw_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count)
 

Macro Definition Documentation

◆ VSF_USART_CFG_IMP_PREFIX

#define VSF_USART_CFG_IMP_PREFIX   vsf_hw

◆ VSF_USART_CFG_IMP_UPCASE_PREFIX

#define VSF_USART_CFG_IMP_UPCASE_PREFIX   VSF_HW

◆ VSF_USART_CFG_REQUEST_API

#define VSF_USART_CFG_REQUEST_API   DISABLED

◆ VSF_USART_CFG_REIMPLEMENT_API_CAPABILITY

#define VSF_USART_CFG_REIMPLEMENT_API_CAPABILITY   DISABLED

◆ VSF_USART_CFG_REIMPLEMENT_API_REQUEST

#define VSF_USART_CFG_REIMPLEMENT_API_REQUEST   ENABLED

◆ VSF_USART_CFG_IMP_LV0

#define VSF_USART_CFG_IMP_LV0 (   __IDX,
  __HAL_OP 
)
Value:
static const vsf_hw_usart_const_t vsf_hw_usart ## __IDX ## _const = { \
.usart = (UART ## __IDX), \
.irq = (UART ## __IDX ##_IRQn), \
.module = (VSF_HW_USART ## __IDX ##_MODULE), \
.uartx_rst = VSF_HW_USART ## __IDX ##_RST, \
.clock_source = VSF_MCONNECT(VSF_HW_USART, __IDX, SEL_, VSF_CFG_USART_CLOCK_SOURCE), \
}; \
vsf_hw_usart_t vsf_hw_usart ## __IDX = { \
.usart_const = &vsf_hw_usart ## __IDX ## _const, \
__HAL_OP \
};
struct VSF_MCONNECT(VSF_FLASH_CFG_IMP_PREFIX, _flash_t)
Definition flash.c:53
#define VSF_CFG_USART_CLOCK_SOURCE
Definition usart.h:32
include the infrastructure
Definition uart.c:43
UART_T * usart
Definition usart.c:37
Definition uart.c:71
const vsf_hw_usart_const_t * usart_const
Definition uart.c:53

Typedef Documentation

◆ vsf_hw_usart_const_t

include the infrastructure

◆ vsf_hw_usart_t

Function Documentation

◆ vsf_hw_usart_init()

vsf_err_t vsf_hw_usart_init ( vsf_hw_usart_t usart_ptr,
vsf_usart_cfg_t cfg_ptr 
)

◆ vsf_hw_usart_enable()

fsm_rt_t vsf_hw_usart_enable ( vsf_hw_usart_t usart_ptr)

◆ vsf_hw_usart_disable()

fsm_rt_t vsf_hw_usart_disable ( vsf_hw_usart_t usart_ptr)

◆ vsf_hw_usart_status()

vsf_usart_status_t vsf_hw_usart_status ( vsf_hw_usart_t usart_ptr)

◆ vsf_hw_usart_rxfifo_get_data_count()

uint_fast16_t vsf_hw_usart_rxfifo_get_data_count ( vsf_hw_usart_t usart_ptr)

◆ vsf_hw_usart_rxfifo_read()

uint_fast16_t vsf_hw_usart_rxfifo_read ( vsf_hw_usart_t usart_ptr,
void *  buffer_ptr,
uint_fast16_t  count 
)

◆ vsf_hw_usart_txfifo_get_free_count()

uint_fast16_t vsf_hw_usart_txfifo_get_free_count ( vsf_hw_usart_t usart_ptr)

◆ vsf_hw_usart_txfifo_write()

uint_fast16_t vsf_hw_usart_txfifo_write ( vsf_hw_usart_t usart_ptr,
void *  buffer_ptr,
uint_fast16_t  count 
)

◆ vsf_hw_usart_fifo_flush()

bool vsf_hw_usart_fifo_flush ( vsf_hw_usart_t usart_ptr)

◆ vsf_hw_usart_irq_enable()

void vsf_hw_usart_irq_enable ( vsf_hw_usart_t usart_ptr,
vsf_usart_irq_mask_t  irq_mask 
)

◆ vsf_hw_usart_irq_disable()

void vsf_hw_usart_irq_disable ( vsf_hw_usart_t usart_ptr,
vsf_usart_irq_mask_t  irq_mask 
)

◆ vsf_hw_usart_request_rx()

vsf_err_t vsf_hw_usart_request_rx ( vsf_hw_usart_t usart_ptr,
void *  buffer_ptr,
uint_fast32_t  count 
)

◆ vsf_hw_usart_request_tx()

vsf_err_t vsf_hw_usart_request_tx ( vsf_hw_usart_t usart_ptr,
void *  buffer_ptr,
uint_fast32_t  count 
)