uart.c File Reference

#include "../driver.h"
#include "hal/vsf_hal.h"
#include "RP2040.h"
#include "hal/driver/common/usart/usart_template.inc"

Data Structures
struct	vsf_hw_usart_t

Macros
#define	__VSF_HAL_PL011_UART_CLASS_INHERIT__
#define	VSF_HW_USART_CFG_MULTI_CLASS   VSF_USART_CFG_MULTI_CLASS
#define	VSF_USART_CFG_REIMPLEMENT_API_CAPABILITY   ENABLED
#define	VSF_USART_CFG_REIMPLEMENT_API_REQUEST   ENABLED
#define	VSF_USART_CFG_IMP_PREFIX   vsf_hw
#define	VSF_USART_CFG_IMP_UPCASE_PREFIX   VSF_HW
#define	VSF_USART_CFG_IMP_LV0(__IDX, __HAL_OP)

Typedefs
typedef struct vsf_hw_usart_t	vsf_hw_usart_t

Functions
vsf_err_t	vsf_hw_usart_init (vsf_hw_usart_t *hw_usart_ptr, vsf_usart_cfg_t *cfg_ptr)
void	vsf_hw_usart_fini (vsf_hw_usart_t *hw_usart_ptr)
vsf_usart_capability_t	vsf_hw_usart_capability (vsf_hw_usart_t *hw_usart_ptr)
fsm_rt_t	vsf_hw_usart_enable (vsf_hw_usart_t *hw_usart_ptr)
fsm_rt_t	vsf_hw_usart_disable (vsf_hw_usart_t *hw_usart_ptr)
void	vsf_hw_usart_irq_enable (vsf_hw_usart_t *hw_usart_ptr, vsf_usart_irq_mask_t irq_mask)
void	vsf_hw_usart_irq_disable (vsf_hw_usart_t *hw_usart_ptr, vsf_usart_irq_mask_t irq_mask)
vsf_usart_status_t	vsf_hw_usart_status (vsf_hw_usart_t *hw_usart_ptr)
uint_fast16_t	vsf_hw_usart_rxfifo_get_data_count (vsf_hw_usart_t *hw_usart_ptr)
uint_fast16_t	vsf_hw_usart_rxfifo_read (vsf_hw_usart_t *hw_usart_ptr, void *buffer_ptr, uint_fast16_t count)
uint_fast16_t	vsf_hw_usart_txfifo_get_free_count (vsf_hw_usart_t *hw_usart_ptr)
uint_fast16_t	vsf_hw_usart_txfifo_write (vsf_hw_usart_t *hw_usart_ptr, void *buffer_ptr, uint_fast16_t count)
vsf_err_t	vsf_hw_usart_request_rx (vsf_hw_usart_t *hw_usart_ptr, void *buffer_ptr, uint_fast32_t count)
vsf_err_t	vsf_hw_usart_request_tx (vsf_hw_usart_t *hw_usart_ptr, void *buffer_ptr, uint_fast32_t count)
vsf_err_t	vsf_hw_usart_cancel_rx (vsf_hw_usart_t *hw_usart_ptr)
vsf_err_t	vsf_hw_usart_cancel_tx (vsf_hw_usart_t *hw_usart_ptr)
int_fast32_t	vsf_hw_usart_get_rx_count (vsf_hw_usart_t *hw_usart_ptr)
int_fast32_t	vsf_hw_usart_get_tx_count (vsf_hw_usart_t *hw_usart_ptr)

Macro Definition Documentation

__VSF_HAL_PL011_UART_CLASS_INHERIT__

#define __VSF_HAL_PL011_UART_CLASS_INHERIT__

VSF_HW_USART_CFG_MULTI_CLASS

#define VSF_HW_USART_CFG_MULTI_CLASS   VSF_USART_CFG_MULTI_CLASS

VSF_USART_CFG_REIMPLEMENT_API_CAPABILITY

#define VSF_USART_CFG_REIMPLEMENT_API_CAPABILITY   ENABLED

VSF_USART_CFG_REIMPLEMENT_API_REQUEST

#define VSF_USART_CFG_REIMPLEMENT_API_REQUEST   ENABLED

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_IMP_LV0

#define VSF_USART_CFG_IMP_LV0	(		__IDX,
			__HAL_OP
	)

Value:

    vsf_hw_usart_t vsf_hw_usart ## __IDX = {                                    \
        .reg  = (void *)VSF_HW_USART ## __IDX ## _REG,                          \
        .irqn = VSF_HW_USART ## __IDX ## _IRQN,                                 \
        __HAL_OP                                                                \
    };                                                                          \
    void VSF_HW_USART ## __IDX ## _IRQHandler(void)                             \
    {                                                                           \
        uintptr_t ctx = vsf_hal_irq_enter();                                    \
        vsf_pl011_usart_irqhandler(&vsf_hw_usart ## __IDX .use_as__vsf_pl011_usart_t);\
        vsf_hal_irq_leave(ctx);                                                 \
    }

Typedef Documentation

vsf_hw_usart_t

typedef struct vsf_hw_usart_t vsf_hw_usart_t

Function Documentation

vsf_hw_usart_init()

vsf_err_t vsf_hw_usart_init	(	vsf_hw_usart_t *	hw_usart_ptr,
		vsf_usart_cfg_t *	cfg_ptr
	)

vsf_hw_usart_fini()

void vsf_hw_usart_fini

(

vsf_hw_usart_t *

hw_usart_ptr

)

vsf_hw_usart_capability()

vsf_usart_capability_t vsf_hw_usart_capability

(

vsf_hw_usart_t *

hw_usart_ptr

)

vsf_hw_usart_enable()

fsm_rt_t vsf_hw_usart_enable

(

vsf_hw_usart_t *

hw_usart_ptr

)

vsf_hw_usart_disable()

fsm_rt_t vsf_hw_usart_disable

(

vsf_hw_usart_t *

hw_usart_ptr

)

vsf_hw_usart_irq_enable()

void vsf_hw_usart_irq_enable	(	vsf_hw_usart_t *	hw_usart_ptr,
		vsf_usart_irq_mask_t	irq_mask
	)

vsf_hw_usart_irq_disable()

void vsf_hw_usart_irq_disable	(	vsf_hw_usart_t *	hw_usart_ptr,
		vsf_usart_irq_mask_t	irq_mask
	)

vsf_hw_usart_status()

vsf_usart_status_t vsf_hw_usart_status

(

vsf_hw_usart_t *

hw_usart_ptr

)

vsf_hw_usart_rxfifo_get_data_count()

uint_fast16_t vsf_hw_usart_rxfifo_get_data_count

(

vsf_hw_usart_t *

hw_usart_ptr

)

vsf_hw_usart_rxfifo_read()

uint_fast16_t vsf_hw_usart_rxfifo_read	(	vsf_hw_usart_t *	hw_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 *

hw_usart_ptr

)

vsf_hw_usart_txfifo_write()

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

vsf_hw_usart_request_rx()

vsf_err_t vsf_hw_usart_request_rx	(	vsf_hw_usart_t *	hw_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 *	hw_usart_ptr,
		void *	buffer_ptr,
		uint_fast32_t	count
	)

vsf_hw_usart_cancel_rx()

vsf_err_t vsf_hw_usart_cancel_rx

(

vsf_hw_usart_t *

hw_usart_ptr

)

vsf_hw_usart_cancel_tx()

vsf_err_t vsf_hw_usart_cancel_tx

(

vsf_hw_usart_t *

hw_usart_ptr

)

vsf_hw_usart_get_rx_count()

int_fast32_t vsf_hw_usart_get_rx_count

(

vsf_hw_usart_t *

hw_usart_ptr

)

vsf_hw_usart_get_tx_count()

int_fast32_t vsf_hw_usart_get_tx_count

(

vsf_hw_usart_t *

hw_usart_ptr

)