298 lines
12 KiB
C
298 lines
12 KiB
C
|
/******************************************************************************
|
|||
|
|
* Copyright (C) 2017, Huada Semiconductor Co.,Ltd All rights reserved.
|
|||
|
|
*
|
|||
|
|
* This software is owned and published by:
|
|||
|
|
* Huada Semiconductor Co.,Ltd ("HDSC").
|
|||
|
|
*
|
|||
|
|
* BY DOWNLOADING, INSTALLING OR USING THIS SOFTWARE, YOU AGREE TO BE BOUND
|
|||
|
|
* BY ALL THE TERMS AND CONDITIONS OF THIS AGREEMENT.
|
|||
|
|
*
|
|||
|
|
* This software contains source code for use with HDSC
|
|||
|
|
* components. This software is licensed by HDSC to be adapted only
|
|||
|
|
* for use in systems utilizing HDSC components. HDSC shall not be
|
|||
|
|
* responsible for misuse or illegal use of this software for devices not
|
|||
|
|
* supported herein. HDSC is providing this software "AS IS" and will
|
|||
|
|
* not be responsible for issues arising from incorrect user implementation
|
|||
|
|
* of the software.
|
|||
|
|
*
|
|||
|
|
* Disclaimer:
|
|||
|
|
* HDSC MAKES NO WARRANTY, EXPRESS OR IMPLIED, ARISING BY LAW OR OTHERWISE,
|
|||
|
|
* REGARDING THE SOFTWARE (INCLUDING ANY ACOOMPANYING WRITTEN MATERIALS),
|
|||
|
|
* ITS PERFORMANCE OR SUITABILITY FOR YOUR INTENDED USE, INCLUDING,
|
|||
|
|
* WITHOUT LIMITATION, THE IMPLIED WARRANTY OF MERCHANTABILITY, THE IMPLIED
|
|||
|
|
* WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR USE, AND THE IMPLIED
|
|||
|
|
* WARRANTY OF NONINFRINGEMENT.
|
|||
|
|
* HDSC SHALL HAVE NO LIABILITY (WHETHER IN CONTRACT, WARRANTY, TORT,
|
|||
|
|
* NEGLIGENCE OR OTHERWISE) FOR ANY DAMAGES WHATSOEVER (INCLUDING, WITHOUT
|
|||
|
|
* LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION,
|
|||
|
|
* LOSS OF BUSINESS INFORMATION, OR OTHER PECUNIARY LOSS) ARISING FROM USE OR
|
|||
|
|
* INABILITY TO USE THE SOFTWARE, INCLUDING, WITHOUT LIMITATION, ANY DIRECT,
|
|||
|
|
* INDIRECT, INCIDENTAL, SPECIAL OR CONSEQUENTIAL DAMAGES OR LOSS OF DATA,
|
|||
|
|
* SAVINGS OR PROFITS,
|
|||
|
|
* EVEN IF Disclaimer HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
|||
|
|
* YOU ASSUME ALL RESPONSIBILITIES FOR SELECTION OF THE SOFTWARE TO ACHIEVE YOUR
|
|||
|
|
* INTENDED RESULTS, AND FOR THE INSTALLATION OF, USE OF, AND RESULTS OBTAINED
|
|||
|
|
* FROM, THE SOFTWARE.
|
|||
|
|
*
|
|||
|
|
* This software may be replicated in part or whole for the licensed use,
|
|||
|
|
* with the restriction that this Disclaimer and Copyright notice must be
|
|||
|
|
* included with each copy of this software, whether used in part or whole,
|
|||
|
|
* at all times.
|
|||
|
|
*/
|
|||
|
|
/*****************************************************************************/
|
|||
|
|
/** \file uart.h
|
|||
|
|
**
|
|||
|
|
** Headerfile for UART functions
|
|||
|
|
**
|
|||
|
|
**
|
|||
|
|
** History:
|
|||
|
|
** - 2017-05-10 Cathy First Version
|
|||
|
|
**
|
|||
|
|
*****************************************************************************/
|
|||
|
|
|
|||
|
|
#ifndef __UART_H__
|
|||
|
|
#define __UART_H__
|
|||
|
|
/*****************************************************************************
|
|||
|
|
* Include files
|
|||
|
|
*****************************************************************************/
|
|||
|
|
#include "ddl.h"
|
|||
|
|
#include "interrupts_hc32l136.h"
|
|||
|
|
|
|||
|
|
#ifdef __cplusplus
|
|||
|
|
extern "C"
|
|||
|
|
{
|
|||
|
|
#endif
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
** \defgroup UartGroup Universal Asynchronous Receiver/Transmitter (UART)
|
|||
|
|
**
|
|||
|
|
******************************************************************************/
|
|||
|
|
//@{
|
|||
|
|
|
|||
|
|
/******************************************************************************/
|
|||
|
|
/* Global pre-processor symbols/macros ('#define') */
|
|||
|
|
/******************************************************************************/
|
|||
|
|
|
|||
|
|
/******************************************************************************
|
|||
|
|
* Global type definitions
|
|||
|
|
******************************************************************************/
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
**\brief uart通道选择
|
|||
|
|
******************************************************************************/
|
|||
|
|
|
|||
|
|
typedef enum en_uart_channel
|
|||
|
|
{
|
|||
|
|
UARTCH0 = 0u, ///<串口0
|
|||
|
|
UARTCH1 = 1u, ///<串口1
|
|||
|
|
}en_uart_channel_t;
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
** \brief uart多主机模式地址帧/数据帧或者奇偶校验
|
|||
|
|
******************************************************************************/
|
|||
|
|
typedef enum en_uart_mmdorck
|
|||
|
|
{
|
|||
|
|
UartDataOrAddr = 0u, ///<多主机模式时，通过读写SBUF[8]决定帧为数据帧或地址帧
|
|||
|
|
UartEven = 1u, ///<非多主机模式偶校验
|
|||
|
|
UartOdd = 2u, ///<非多主机模式奇校验
|
|||
|
|
}en_uart_mmdorck_t;
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
** \brief uart多主机模式配置
|
|||
|
|
******************************************************************************/
|
|||
|
|
typedef enum en_uart_multimode
|
|||
|
|
{
|
|||
|
|
UartNormal = 0u, ///<正常工作模式
|
|||
|
|
UartMulti = 1u, ///<多主机工作模式
|
|||
|
|
}en_uart_multimode_t;
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
** \brief uart多主机模式及从机地址和地址掩码配置
|
|||
|
|
******************************************************************************/
|
|||
|
|
|
|||
|
|
typedef struct stc_uart_multimode
|
|||
|
|
{
|
|||
|
|
en_uart_multimode_t enMulti_mode; ///<多主机模式配置
|
|||
|
|
uint8_t u8SlaveAddr; ///<从机地址
|
|||
|
|
uint8_t u8SaddEn; ///<从及地址掩码
|
|||
|
|
}stc_uart_multimode_t;
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
** \brief uart 四种工作模式选择
|
|||
|
|
******************************************************************************/
|
|||
|
|
|
|||
|
|
typedef enum en_uart_mode
|
|||
|
|
{
|
|||
|
|
UartMode0 = 0u, ///<模式0
|
|||
|
|
UartMode1 = 1u, ///<模式1
|
|||
|
|
UartMode2 = 2u, ///<模式2
|
|||
|
|
UartMode3 = 3u, ///<模式3
|
|||
|
|
} en_uart_mode_t;
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
** \brief uart stop长度选择
|
|||
|
|
******************************************************************************/
|
|||
|
|
|
|||
|
|
typedef enum en_uart_stop
|
|||
|
|
{
|
|||
|
|
Uart1bit = 0u, ///<1位停止位
|
|||
|
|
Uart15bit = 1u, ///<1.5位停止位
|
|||
|
|
Uart2bit = 2u, ///<2位停止位
|
|||
|
|
} en_uart_stop_t;
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
** \brief uart 功能使能
|
|||
|
|
******************************************************************************/
|
|||
|
|
typedef enum en_uart_func
|
|||
|
|
{
|
|||
|
|
UartTx = 0u, ///<mode0模式代表TX
|
|||
|
|
UartRx = 1u, ///<非mode0模式代表RX and TX ,mode0模式代表RX
|
|||
|
|
UartDmaTx = 3u, ///<DMA发送使能
|
|||
|
|
UartDmaRx = 4u, ///<DMA接收使能
|
|||
|
|
UartCtsRts = 5u, ///<硬件流使能
|
|||
|
|
}en_uart_func_t;
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
** \brief uart中断使能控制
|
|||
|
|
******************************************************************************/
|
|||
|
|
typedef enum en_uart_irq_sel
|
|||
|
|
{
|
|||
|
|
UartTxIrq = 0u, ///<发送中断使能
|
|||
|
|
UartRxIrq = 1u, ///<接收中断使能
|
|||
|
|
UartFEIrq = 3u, ///<帧错误中断使能
|
|||
|
|
UartCtsIrq = 4u, ///<CTS信号翻转中断使能
|
|||
|
|
UartPEIrq = 5u, ///<奇偶校验中断使能
|
|||
|
|
UartTxEIrq = 6u, ///<TX空中断使能
|
|||
|
|
}en_uart_irq_sel_t;
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
** \brief uart发送接收中断处理函数接口
|
|||
|
|
******************************************************************************/
|
|||
|
|
|
|||
|
|
typedef struct stc_uart_irq_cb
|
|||
|
|
{
|
|||
|
|
func_ptr_t pfnTxIrqCb; ///<发送中断服务函数
|
|||
|
|
func_ptr_t pfnRxFEIrqCb; ///<接收帧错误中断服务函数
|
|||
|
|
func_ptr_t pfnRxIrqCb; ///<接收中断服务函数
|
|||
|
|
func_ptr_t pfnCtsIrqCb; ///<CTS信号翻转中断服务函数
|
|||
|
|
func_ptr_t pfnPEIrqCb; ///<奇偶校验错误中断服务函数
|
|||
|
|
}stc_uart_irq_cb_t;
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
** \brief uart 状态标志位
|
|||
|
|
******************************************************************************/
|
|||
|
|
typedef enum en_uart_status
|
|||
|
|
{
|
|||
|
|
UartCts = 0u, ///<CTS信号标记
|
|||
|
|
UartRC = 1u, ///<接收数据完成标记
|
|||
|
|
UartTC = 2u, ///<发送数据完成标记
|
|||
|
|
UartPE = 3u, ///<奇偶校验错误标记
|
|||
|
|
UartFE = 4u, ///<帧错误标记
|
|||
|
|
UartCtsIf = 5u, ///<CTS中断标记
|
|||
|
|
UartTxe = 6u, ///<TXbuff空标记
|
|||
|
|
}en_uart_status_t;
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
** \brief uart 通道地址及中断函数地址结构
|
|||
|
|
******************************************************************************/
|
|||
|
|
typedef struct stc_uart_instance_data
|
|||
|
|
{
|
|||
|
|
uint32_t u32Idx; ///< 通道号
|
|||
|
|
M0P_UART_TypeDef *pstcInstance; ///< 通道寄存器地址
|
|||
|
|
stc_uart_irq_cb_t stcUartInternIrqCb; ///< 通道中断服务函数
|
|||
|
|
} stc_uart_instance_data_t;
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
** \brief uart 通道波特率配置
|
|||
|
|
******************************************************************************/
|
|||
|
|
typedef enum en_uart_clkdiv
|
|||
|
|
{
|
|||
|
|
Uart16Or32Div = 0u,///<模式0无效，模式1/3为16分频，模式2为32分频
|
|||
|
|
Uart8Or16Div = 1u,///<模式0无效，模式1/3为8分频，模式2为16分频
|
|||
|
|
}en_uart_clkdiv_t;
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
** \brief uart 通道波特率计算参数
|
|||
|
|
******************************************************************************/
|
|||
|
|
typedef struct stc_uart_baud
|
|||
|
|
{
|
|||
|
|
uint32_t u32Pclk; ///<pclk
|
|||
|
|
en_uart_mode_t enRunMode; ///< 四种模式配置
|
|||
|
|
uint32_t u32Baud; ///< 波特率
|
|||
|
|
} stc_uart_baud_t;
|
|||
|
|
/**
|
|||
|
|
******************************************************************************
|
|||
|
|
** \uart 总体配置
|
|||
|
|
******************************************************************************/
|
|||
|
|
|
|||
|
|
typedef struct stc_uart_config
|
|||
|
|
{
|
|||
|
|
en_uart_mode_t enRunMode; ///< 四种模式配置
|
|||
|
|
en_uart_stop_t enStopBit; ///<停止位长度
|
|||
|
|
stc_uart_multimode_t* pstcMultiMode; ///<多主机模式配置
|
|||
|
|
stc_uart_irq_cb_t* pstcIrqCb; ///<中断服务函数
|
|||
|
|
boolean_t bTouchNvic; ///<NVIC中断使能
|
|||
|
|
} stc_uart_config_t;
|
|||
|
|
//中断相关设置函数
|
|||
|
|
en_result_t Uart_EnableIrq(uint8_t u8Idx,
|
|||
|
|
en_uart_irq_sel_t enIrqSel);
|
|||
|
|
en_result_t Uart_DisableIrq(uint8_t u8Idx,
|
|||
|
|
en_uart_irq_sel_t enIrqSel);
|
|||
|
|
//void Uart_IrqHandler(uint8_t u8Idx);
|
|||
|
|
// 总初始化处理
|
|||
|
|
en_result_t Uart_Init(uint8_t u8Idx,
|
|||
|
|
stc_uart_config_t* pstcConfig);
|
|||
|
|
en_result_t Uart_DeInit(uint8_t u8Idx, boolean_t bTouchNvic);
|
|||
|
|
//UART模块工作模式设置函数
|
|||
|
|
en_result_t Uart_SetMode(uint8_t u8Idx,en_uart_mode_t enMode);
|
|||
|
|
//UART模块多主机模式设置函数
|
|||
|
|
en_result_t Uart_SetMultiMode(uint8_t u8Idx,stc_uart_multimode_t* pstcMultiConfig);
|
|||
|
|
//UART通道多主机模式发送数据/地址帧或者奇偶校验配置TB8
|
|||
|
|
en_result_t Uart_SetMMDOrCk(uint8_t u8Idx,en_uart_mmdorck_t enTb8);
|
|||
|
|
//从机地址配置
|
|||
|
|
en_result_t Uart_SetSaddr(uint8_t u8Idx,uint8_t u8Addr);
|
|||
|
|
//从机地址掩码配置
|
|||
|
|
en_result_t Uart_SetSaddrEn(uint8_t u8Idx,uint8_t u8Addren);
|
|||
|
|
//停止位长度设置
|
|||
|
|
en_result_t Uart_SetStopBit(uint8_t u8Idx,uint8_t u8Len);
|
|||
|
|
//RB8数据获取
|
|||
|
|
boolean_t Uart_GetRb8(uint8_t u8Idx);
|
|||
|
|
|
|||
|
|
//采样分频设置
|
|||
|
|
en_result_t Uart_SetClkDiv(uint8_t u8Idx,en_uart_clkdiv_t enClkDiv);
|
|||
|
|
//波特率设置值计算
|
|||
|
|
uint16_t Uart_CalScnt(uint8_t u8Idx,stc_uart_baud_t *pstcBaud);
|
|||
|
|
//波特率设置
|
|||
|
|
en_result_t Uart_SetBaud(uint8_t u8Idx,uint16_t u16Scnt);
|
|||
|
|
//获取波特率
|
|||
|
|
uint32_t Uart_GetBaud(uint8_t u8Idx,uint8_t u8Mode,uint32_t u32Pclk);
|
|||
|
|
|
|||
|
|
// 功能使能和禁止
|
|||
|
|
en_result_t Uart_EnableFunc(uint8_t u8Idx, en_uart_func_t enFunc);
|
|||
|
|
en_result_t Uart_DisableFunc(uint8_t u8Idx, en_uart_func_t enFunc);
|
|||
|
|
//状态位的获取和清除
|
|||
|
|
uint8_t Uart_GetIsr(uint8_t u8Idx);
|
|||
|
|
boolean_t Uart_GetStatus(uint8_t u8Idx,en_uart_status_t enStatus);
|
|||
|
|
en_result_t Uart_ClrIsr(uint8_t u8Idx);
|
|||
|
|
en_result_t Uart_ClrStatus(uint8_t u8Idx,en_uart_status_t enStatus);
|
|||
|
|
//数据查询方式的收发操作
|
|||
|
|
//en_result_t Uart_MultiSendFirstData(uint8_t U8Addr);
|
|||
|
|
en_result_t Uart_SendData(uint8_t u8Idx, uint8_t u8Data);
|
|||
|
|
int Uart_ReceiveData(uint8_t u8Idx);
|
|||
|
|
|
|||
|
|
//@} // UartGroup
|
|||
|
|
|
|||
|
|
#ifdef __cplusplus
|
|||
|
|
#endif
|
|||
|
|
|
|||
|
|
#endif /* __UART_H__ */
|
|||
|
|
/******************************************************************************
|
|||
|
|
* EOF (not truncated)
|
|||
|
|
*****************************************************************************/
|
|||
|
|
|
|||
|
|
|
|||
|
|
|