zouhaitao/TAIXIN
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
e76462eeb7733d4fca46c92e4b9c1b5d99fc049a
TAIXIN/sdk/include/hal/uart.h

322 lines
7.6 KiB
C
Raw Blame History

/**
* @file uart.h
* @author HUGE-IC Application Team
* @brief UART HAL driver
* @version 1.0.0
* @date 2021-8-30
*
* @copyright Copyright (c) 2021 HUGE-IC
*/
#ifndef _HAL_UART_H_
#define _HAL_UART_H_
#include "typesdef.h"
#ifdef __cplusplus
extern "C" {
#endif
/** @defgroup Docxygenid_UART_enum UART enum
* @ingroup Docxygenid_UART_Driver
* @brief UART enumeration description.
* @{
*/
/**
* @brief Enumeration constant for UART mode.
*/
enum uart_mode {
/*! Set UART to full duplex mode.
*/
UART_MODE_DUPLEX,
/*! Set UART to simplex_tx mode.
*/
UART_MODE_SIMPLEX_TX,
/*! Set UART to simplex_rx mode.
*/
UART_MODE_SIMPLEX_RX,
};
/**
* @brief Enumeration constant for UART parity.
*/
enum uart_parity {
/*! Set UART to no parity mode.
*/
UART_PARITY_NONE,
/*! Set UART to odd parity mode.
*/
UART_PARITY_ODD,
/*! Set UART to even parity mode.
*/
UART_PARITY_EVEN,
};
/**
* @brief Enumeration constant for UART stop bit.
*/
enum uart_stop_bit {
/*! Set UART stop bit to 1bit.
*/
UART_STOP_BIT_1,
/*! Set UART stop bit to 1.5bit.
*/
UART_STOP_BIT_1_5,
/*! Set UART stop bit to 2bit.
*/
UART_STOP_BIT_2,
};
/**
* @brief Enumeration constant for UART data bit.
*/
enum uart_data_bit {
/*! Set UART data bit to 5bit.
*/
UART_DATA_BIT_5,
/*! Set UART data bit to 6bit.
*/
UART_DATA_BIT_6,
/*! Set UART data bit to 7bit.
*/
UART_DATA_BIT_7,
/*! Set UART data bit to 8bit.
*/
UART_DATA_BIT_8,
/*! Set UART data bit to 9bit.
*/
UART_DATA_BIT_9,
};
/**
* @brief Enumeration constant for UART irq flag.
*/
enum uart_irq_flag {
/*!
* @brief Interrupt: send a frame of data done.
* @note
* If the UART configuration data bit is 8bit, one frame of data is 8bit;\n
* if the data bit is 9bit, one frame of data is 9bit.
*/
UART_IRQ_FLAG_TX_BYTE = BIT(0),
/*!
* @brief Interrupt: time is up, no data has been received yet.
* @note
* This interrupt is only used for UART receive.
*/
UART_IRQ_FLAG_TIME_OUT = BIT(1),
/*!
* @brief Interrupt: UART send done using DMA.
* @note
* Before configuring this interrupt,\n
* you need to use @ref uart_ioctl() function to enable DMA.
*/
UART_IRQ_FLAG_DMA_TX_DONE = BIT(2),
/*!
* @brief Interrupt: UART receive done using DMA.
* @note
* Before configuring this interrupt,\n
* you need to use @ref uart_ioctl() function to enable DMA.
*/
UART_IRQ_FLAG_DMA_RX_DONE = BIT(3),
/*!
* @brief Interrupt: UART receives a frame of data error.
* @note
* - If the UART configuration data bit is 8bit, one frame of data is 8bit;\n
* if the data bit is 9bit, one frame of data is 9bit.
* - A frame of data error, usually means that the number of stop bits of \n
* a frame of data does not match the expected number of bits.
*/
UART_IRQ_FLAG_FRAME_ERR = BIT(4),
/*!
* @brief Interrupt: UART receives a frame of data done.
* @note
* If the UART configuration data bit is 8bit, one frame of data is 8bit;\n
* if the data bit is 9bit, one frame of data is 9bit.
*/
UART_IRQ_FLAG_RX_BYTE = BIT(5),
/*!
* @brief Interrupt: UART receives has been reset.
* @note
* Possible need to reset parameters or resend data.
*/
UART_IRQ_FLAG_RESET = BIT(6),
};
/**
* @brief Enumeration constant for UART irq flag
*/
enum uart_ioctl_cmd {
/*!
* @brief Set the baudrate of the UART.
*/
UART_IOCTL_CMD_SET_BAUDRATE,
/*!
* @brief Set the UART data bits.
* @note
* reference @ref uart_data_bit.
*/
UART_IOCTL_CMD_SET_DATA_BIT,
/*!
* @brief Set the UART parity mode.
* @note
* reference @ref uart_parity.
*/
UART_IOCTL_CMD_SET_PARITY,
/*!
* @brief Set the UART stop bit.
* @note
* reference @ref uart_stop_bit.
*/
UART_IOCTL_CMD_SET_STOP_BIT,
/*!
* @brief Set the timeout.
*/
UART_IOCTL_CMD_SET_TIME_OUT,
/*!
* @brief Set whether the UART uses DMA to send.
*/
UART_IOCTL_CMD_USE_DMA,
/*!
* @brief Set UART work mode.
* @note
* reference @ref uart_mode.
*/
UART_IOCTL_CMD_SET_WORK_MODE,
/*!
* @brief Query whether the UART DATA reg ready.
*/
UART_IOCTL_CMD_DATA_RDY,
/*!
* @brief
* Disable this uart tx by cpu, and turn to use dma.
* @note
* Only use for UART4/5.
*/
UART_IOCTL_CMD_DISABLE_DEBUG_SELECTION,
/*!
* @brief Enable the UART rs485 mode.
*/
UART_IOCTL_CMD_SET_RS485_EN,
/*!
* @brief Set the UART rs485 DET.
*/
UART_IOCTL_CMD_SET_RS485_DET,
/*!
* @brief Set the UART rs485 TAT.
*/
UART_IOCTL_CMD_SET_RS485_TAT,
/*!
* @brief Set the UART rs485 DE and RE polarity.
*/
UART_IOCTL_CMD_SET_RS485DRE_POL,
};
/** @} Docxygenid_UART_enum*/
/* User interrupt handle */
typedef int32(*uart_irq_hdl)(uint32 irq, uint32 irq_data, uint32 param1, uint32 param2);
/** @defgroup Docxygenid_UART_structure UART structure
* @ingroup Docxygenid_UART_Driver
* @brief UART structure description
* @note
* User better not modify the structure.
* @{
*/
struct uart_device {
struct dev_obj dev;
};
struct uart_hal_ops {
struct devobj_ops ops;
int32(*open)(struct uart_device *uart, uint32 baudrate);
int32(*close)(struct uart_device *uart);
int32(*putc)(struct uart_device *uart, int8 value);
uint8(*getc)(struct uart_device *uart);
int32(*puts)(struct uart_device *uart, uint8 *buf, uint32 len);
int32(*gets)(struct uart_device *uart, uint8 *buf, uint32 len);
int32(*ioctl)(struct uart_device *uart, enum uart_ioctl_cmd ioctl_cmd, uint32 param1, uint32 param2);
int32(*request_irq)(struct uart_device *uart, uart_irq_hdl irq_hdl, uint32 irq_flag, uint32 irq_data);
int32(*release_irq)(struct uart_device *uart, uint32 irq_flag);
};
/** @} Docxygenid_UART_structure*/
/** @addtogroup Docxygenid_UART_Driver
* @{
*/
/**
* @brief Open uart with baudrate and the default configuration.
* @param uart : UART handle. Usually use @ref dev_get() function to get the handle.
* @param baudrate : Configure the baudrate for UART.
* @return
* - RET_OK : UART module open successfully.
* - RET_ERR : UART module open unsuccessfully.
* @note
* The default configuration is full duplex mode, no parity mode,\n
* data bit is 8bit, stop bit is 1bit.If you need to change the configuration,\n
* you can use the @ref uart_ioctl function to make changes after initialization is complete.
*/
int32 uart_open(struct uart_device *uart, uint32 baudrate);
int32 uart_close(struct uart_device *uart);
int32 uart_putc(struct uart_device *uart, int8 value);
uint8 uart_getc(struct uart_device *uart);
int32 uart_puts(struct uart_device *uart, uint8 *buf, uint32 len);
int32 uart_gets(struct uart_device *uart, uint8 *buf, uint32 len);
int32 uart_ioctl(struct uart_device *uart, enum uart_ioctl_cmd ioctl_cmd, uint32 param1, uint32 param2);
int32 uart_request_irq(struct uart_device *uart, uart_irq_hdl irq_hdl, uint32 irq_flag, uint32 irq_data);
int32 uart_release_irq(struct uart_device *uart, uint32 irq_flag);
/** @} Docxygenid_UART_functions*/
#ifdef __cplusplus
}
#endif
#endif
Reference in New Issue View Git Blame Copy Permalink