/*================================================================
  Copyright (c) 2021, Quectel Wireless Solutions Co., Ltd. All rights reserved.
  Quectel Wireless Solutions Proprietary and Confidential.
=================================================================*/
#ifndef _QL_UART_H_
#define _QL_UART_H_

#include "ql_type.h"
#ifdef __cplusplus
	 extern "C" {
#endif


typedef enum QL_UART_PORT_NUMBER_ENUM 
{
	QL_DEBUG_UART_PORT, 	//debug uart(GPIO29,30,31,32)
	QL_BT_UART_PORT,		//UART3(GPIO35,36/GPIO53,54)
	QL_MAIN_UART_PORT,		//main uart(GPIO51,52,53,54)
	QL_USB_CDC_PORT,
	QL_U4_UART_PORT,        //UART4
    QL_MAX_UART_PORT,
}QL_UART_PORT_NUMBER_E;

typedef enum QL_UART_FLOWCTRL_ENUM
{
	QL_FC_NONE = 0,
	QL_FC_HW,
}QL_UART_FLOWCTRL_E;

typedef enum QL_UART_BAUD_ENUM
{
	QL_UART_BAUD_300 		= 300,
	QL_UART_BAUD_600    	= 600,
    QL_UART_BAUD_1200       = 1200,
    QL_UART_BAUD_2400       = 2400,
    QL_UART_BAUD_3600       = 3600,
    QL_UART_BAUD_4800       = 4800,
    QL_UART_BAUD_7200       = 7200,
    QL_UART_BAUD_9600       = 9600,
    QL_UART_BAUD_14400      = 14400,
    QL_UART_BAUD_19200      = 19200,
    QL_UART_BAUD_28800      = 28800,
    QL_UART_BAUD_38400      = 38400,
    QL_UART_BAUD_57600      = 57600,
    QL_UART_BAUD_115200     = 115200,
    QL_UART_BAUD_230400     = 230400,
	QL_UART_BAUD_256000     = 256000,
    QL_UART_BAUD_460800     = 460800,
    QL_UART_BAUD_921600     = 921600,
	QL_UART_BAUD_1000000	= 1000000,
	QL_UART_BAUD_1500000	= 1500000,
	QL_UART_BAUD_1842000	= 1842000,
	QL_UART_BAUD_3000000	= 3000000,
	QL_UART_BAUD_3686400	= 3686400,
}QL_UART_BAUD_E;

typedef enum QL_UART_DATABIT_ENUM
{
	QL_UART_DATABIT_5,
	QL_UART_DATABIT_6,
	QL_UART_DATABIT_7,
	QL_UART_DATABIT_8,
}QL_UART_DATABIT_E;

typedef enum QL_UART_STOPBIT_ENUM
{
	QL_UART_STOP_1,
	QL_UART_STOP_2,
}QL_UART_STOPBIT_E;

typedef enum QL_UART_PARITYBIT_ENUM
{
	QL_UART_PARITY_NONE,
	QL_UART_PARITY_EVEN,
	QL_UART_PARITY_ODD,
}QL_UART_PARITYBIT_E;

typedef struct ql_uart_config_struct
{
	QL_UART_BAUD_E baudrate;
	QL_UART_DATABIT_E data_bit;
	QL_UART_STOPBIT_E stop_bit;
	QL_UART_PARITYBIT_E parity_bit;
	QL_UART_FLOWCTRL_E flow_ctrl;
}ql_uart_config_t;

enum
{
 QL_UART_SUCCESS         =     0,
 QL_UART_OPEN_FAILED     =    -1,
 QL_UART_ALREAD_OPEN     =    -2,
 QL_UART_ONT_OPEN        =    -3,
 QL_UART_ILLEGAL_PORT    =    -4,
 QL_UART_RB_CFG_FAILED   =    -5,
 QL_UART_DCB_PRAM_ERR    =    -6,
 QL_UART_DCB_CFG_ERR     =    -7,
 QL_UART_WRITE_ERR       =    -8,
 QL_UART_WRITE_PRAM_ERR  =    -9,
 QL_UART_WRITE_MALLOC_ERR =   -10,
 QL_UART_READ_ERR         =  -11,
 QL_UART_CTS_HIGH         =  -12,
 QL_UART_IS_SENDING       =   1,
 QL_UART_NOT_SENDING      =   0
};
typedef void (*uart_callback)(QL_UART_PORT_NUMBER_E port, void *para);
typedef void (*uart_callback_ex)(QL_UART_PORT_NUMBER_E port, int len, void *private);
typedef void (*uart_tx_fwctrl_callback)(QL_UART_PORT_NUMBER_E port, char flow_status);

/***********************************************************************
 *
 * Name:   ql_uart_open    
 *
 * Description: 打开对应串口
 *
 * Parameters:  baudrate:设置波特率
 *              flow_ctrl:是否使能流控
 * Returns:     0：打开成功
 *              
 * Notes:
 *
 ***********************************************************************/
int ql_uart_open(QL_UART_PORT_NUMBER_E port, QL_UART_BAUD_E baudrate, QL_UART_FLOWCTRL_E flow_ctrl);
/***********************************************************************
 *
 * Name:   ql_uart_close    
 *
 * Description: 关闭对应串口
 *
 * Parameters:  port:要关闭的port口
 *             
 * Returns:     0：关闭成功
 *              other: faile
 * Notes:
 *
 ***********************************************************************/
int ql_uart_close(QL_UART_PORT_NUMBER_E port);
/***********************************************************************
 *
 * Name:   ql_uart_set_dcbconfig   
 *
 * Description: 设置对应串口模式
 *
 * Parameters:  port:对应的串口，cdc口无需设置
 *              dcb:模式对象
 * Returns:     0：send_success
 *              other: faile
 * Notes:
 *
 ***********************************************************************/
int ql_uart_set_dcbconfig(QL_UART_PORT_NUMBER_E port, ql_uart_config_t *dcb);
/***********************************************************************
 *
 * Name:   ql_uart_get_dcbconfig   
 *
 * Description: 获取对应串口当前的模式
 *
 * Parameters:  port:要获取模式的串口
 *              dcb:存方模式的内存
 * Returns:     0：send_success
 *              other: faile
 * Notes:
 *
 ***********************************************************************/

int ql_uart_get_dcbconfig(QL_UART_PORT_NUMBER_E port, ql_uart_config_t *dcb);
/***********************************************************************
 *
 * Name:  ql_uart_write  
 *
 * Description: 往外部发送数据
 *
 * Parameters:  data:要发送的数据首地址
 *              len:要发送的数据长度
 * Returns:     0：send_success
 *              other: faile
 * Notes:
 *
 ***********************************************************************/
int ql_uart_write(QL_UART_PORT_NUMBER_E port, unsigned char *data, int len);
/***********************************************************************
 *
 * Name:   ql_uart_read    
 *
 * Description: 接收串口数据
 *
 * Parameters:  data:要接收的数据存放位置首地址
 *              len:要接收的数据长度
 * Returns:     0：send_success
 *              other: faile
 * Notes:
 *
 ***********************************************************************/
int ql_uart_read(QL_UART_PORT_NUMBER_E port, unsigned char *data, int len);
/***********************************************************************
 *
 * Name:   ql_uart_register_cb    
 *
 * Description: 注册接收回调不带参数
 *
 * Parameters:  port:注册回调的串口号
 *              uart_cb:客户回调函数
 * Returns:     
 *              
 * Notes:
 *
 ***********************************************************************/
void ql_uart_register_cb(QL_UART_PORT_NUMBER_E port, uart_callback uart_cb);
/***********************************************************************
 *
 * Name:   ql_uart_register_cb_ex    
 *
 * Description: 注册回调函数带参
 *
 * Parameters:  port:注册回调的串口号
 *              uart_cb:客户回调函数
 *              private ：参数
 * Returns:     
 *              
 * Notes:
 *
 ***********************************************************************/

void ql_uart_register_cb_ex(QL_UART_PORT_NUMBER_E port, uart_callback_ex uart_cb, void *private);

/***********************************************************************
 *
 * Name:   ql_uart_register_txfwctrl_ex   
 *
 * Description: Register TX flow control callback
 *
 * Parameters:  port:Register the port for tx flow control callback
 *              
 * Returns:     none
 *              
 * Notes:
 *
 ***********************************************************************/

void ql_uart_register_txfwctrl(QL_UART_PORT_NUMBER_E port, uart_tx_fwctrl_callback uart_cb);


/***********************************************************************
 *
 * Name:   ql_uart_flush_fifo   
 *
 * Description: 清空串口fifo
 *
 * Parameters:  port:要清空的串口fifo端口号
 *              
 * Returns:     none
 *              
 * Notes:
 *
 ***********************************************************************/
 
void ql_uart_flush_fifo(QL_UART_PORT_NUMBER_E port);

/*****************************************************************
* Function:     ql_uart_is_sending 
* 
* Description:
*               Return the status of the serial port is sending data or not.
*
* Parameters:
*               port:
*               [in]   uart port.
* Return:        
*               FALSE, not sending.
*               TRUE,  is sending.
*****************************************************************/
unsigned char ql_uart_is_sending(QL_UART_PORT_NUMBER_E port);

/*****************************************************************
* Function:     ql_uart_get_rx_data_len
* 
* Description:
*               返回rx的fifo还剩多少字节数据.
*
* Parameters:
*               port:
*               [in]   uart port.
* Return:        
*               rx fifo剩余字节数.
*               .
*****************************************************************/

unsigned int ql_uart_get_rxrb_data_len(QL_UART_PORT_NUMBER_E port);
/*****************************************************************
* Function:     ql_uart_pin_set_func
* 
* Description:
*               用于设置uart pin脚的复用功能,方便客户自行配置uart pin.
*
* Parameters:
*               port:
*               [in]   uart port.
*				PIN_NUM:
*				[in]   gpio_num
*				func_num:
*				[in]   复用功能号
* Return:        
*               0.
*               .
*****************************************************************/

int ql_uart_pin_set_func(QL_UART_PORT_NUMBER_E port,       UINT32 PIN_NUM,unsigned int func_num);
/*****************************************************************
* Function:     ql_uart_pin_get_func
* 
* Description:
*               获取uart pin脚的复用功能号.
*
* Parameters:
*               PIN_NUM:
*               [in]   gpio_num.
* Return:        
*               uart pin脚的复用功能号.
*               .
*****************************************************************/

int ql_uart_rx_dma_size_set(QL_UART_PORT_NUMBER_E port, UINT32 size);
/*****************************************************************
* Function:     ql_uart_rx_dma_size_set
* 
* Description:
*               Set the runtime DMA RX size for a specific UART port.
*               - Default value: 8192 bytes
*               - Maximum: 8192 bytes
*               - Minimum: 1024 bytes
*
* Parameters:
*               port:
*                   [in] UART port number, QL_UART_PORT_NUMBER_E
*               size:
*                   [in] Desired DMA RX size in bytes
*                        - If size = 0, restores default 8192 bytes
*                        - If size > 8192, auto set to 8192
*                        - If size < 1024, auto set to 1024
*
* Return:        
*               0 : Success
*               <0: Error code (e.g., invalid port)
*
* Example:
*               // Set UART_STUART DMA size to 4096 bytes
*               ql_uart_rx_dma_size_set(UART_PORT_STUART, 4096);
*
*               // Restore default size (8192 bytes)
*               ql_uart_rx_dma_size_set(UART_PORT_STUART, 0);
*****************************************************************/

int ql_uart_rx_dma_size_get(QL_UART_PORT_NUMBER_E port);
/*****************************************************************
* Function:     ql_uart_rx_dma_size_get
* 
* Description:
*               Get the current runtime DMA RX size of a specific UART port.
*
* Parameters:
*               port:
*                   [in] UART port number, QL_UART_PORT_NUMBER_E
*
* Return:        
*               Current DMA RX size in bytes
*               <0: Error code (invalid port)
*
* Example:
*               UINT32 size;
*               size = ql_uart_rx_dma_size_get(UART_PORT_STUART);
*               test_log("UART_STUART DMA size = %u bytes\r\n", size);
*****************************************************************/
int ql_usbcdc_set_rx_buf(int size);
/*****************************************************************
* Function:     ql_usbcdc_set_rx_buf
* 
* Description:
*               Set USB CDC RX buffer size (must be positive power of 2).
*
* Parameters:
*               size:
*                   [in] RX buffer size (positive power of 2 required)
*
* Return:        
*               0: Success
*               -1: Invalid size (≤0 or not power of 2)
*
* Example:
*               int ret = ql_usbcdc_set_rx_buf(16*1024); 
*               if (ret != 0) 
*               test_log("Set CDC RX buf size failed\r\n");
*****************************************************************/
int ql_uart_pin_get_func(      UINT32 PIN_NUM);

int ql_uart_wakeup_mode_enable(QL_UART_PORT_NUMBER_E port);

int ql_uart_wakeup_mode_disable(QL_UART_PORT_NUMBER_E port);



#ifdef __cplusplus
	} /*"C" */
#endif

#endif /* _QL_UART_H_ */