rt-thread-official/bsp/hc32l136/Libraries/HC32L136_StdPeriph_Driver/inc/spi.h

213 lines
8.3 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 spi.h
**
** Headerfile for SPI functions
**
**
** History:
** - 2017-05-17 1.0 Devi First Version
**
*****************************************************************************/
#ifndef __SPI_H__
#define __SPI_H__
/******************************************************************************
* Include files
*****************************************************************************/
#include "ddl.h"
#include "interrupts_hc32l136.h"
/* C binding of definitions if building with C++ compiler */
#ifdef __cplusplus
extern "C"
{
#endif
//@{
/******************************************************************************
* Global type definitions
*****************************************************************************/
/**
******************************************************************************
** \brief SPI 功能通道选择设置
******************************************************************************/
typedef enum en_spi_channel
{
Spi0 = 0u, ///< SPI通道0
Spi1 = 1u, ///< SPI通道1
}en_spi_channel_t;
/**
******************************************************************************
** \brief SPI 功能使能设置
******************************************************************************/
typedef enum en_spi_en
{
SpiEnable = 1u, ///< SPI模块使能
SpiDisable = 0u, ///< SPI模块禁止
}en_spi_en_t;
/**
******************************************************************************
** \brief SPI 模式配置
******************************************************************************/
typedef enum en_spi_mode
{
SpiMaster = 1u, ///<主机
SpiSlave = 0u, ///<从机
}en_spi_mode_t;
/**
******************************************************************************
** \brief SPI 时钟极性设置
******************************************************************************/
typedef enum en_spi_cpol
{
Spicpollow = 0u, ///<极性为低
Spicpolhigh = 1u, ///<极性为高
}en_spi_cpol_t;
/**
******************************************************************************
** \brief SPI 时钟相位设置
******************************************************************************/
typedef enum en_spi_cpha
{
Spicphafirst = 0u, ///<第一边沿采样
Spicphasecond = 1u, ///<第二边沿采样
}en_spi_cpha_t;
/**
******************************************************************************
** \brief SPI 时钟分频配置
*****************************************************************************/
typedef enum en_spi_clk_div
{
SpiClkDiv2 = 0u, ///<2分频
SpiClkDiv4 = 1u, ///<4分频
SpiClkDiv8 = 2u, ///<8分频
SpiClkDiv16 = 3u, ///<16分频
SpiClkDiv32 = 4u, ///<32分频
SpiClkDiv64 = 5u, ///<64分频
SpiClkDiv128 = 6u, ///<128分频
}en_spi_clk_div_t;
/**
******************************************************************************
** \brief SPI 片选脚电平选择
*****************************************************************************/
typedef enum en_spi_cspin
{
SpiCsLow = 0u, ///<片选低电平
SpiCsHigh = 1u, ///<片选高电平
}en_spi_cspin_t;
/**
******************************************************************************
** \brief SPI 状态
*****************************************************************************/
typedef enum en_spi_status
{
SpiIf = 0x80, ///<传输结束中断标志
SpiSserr = 0x20, ///<从机模式错误标志
SpiMdf = 0x10, ///<主机模式错误标志
SpiBusy = 0x08, ///<SPI总线忙标志
SpiTxe = 0x04, ///<发送缓冲器器空标志
SpiRxne = 0x02, ///<接受缓冲器非空标志
}en_spi_status_t;
/**
******************************************************************************
** \brief SPI 功能开启函数
*****************************************************************************/
typedef enum en_spi_func
{
SpiRxNeIe = 0x40, ///<接收缓冲器非空中断使能
SpiTxEIe = 0x20, ///<发送缓冲器空中断使能
SpiDmaTxEn = 0x10, ///<DMA硬件访问发送使能
SpiDmaRxEn = 0x08, ///<DMA硬件访问接收使能
}en_spi_func_t;
/**
******************************************************************************
** \brief SPI 总体配置结构体
*****************************************************************************/
typedef struct stc_spi_config
{
boolean_t bMasterMode; ///< 主从模式选择
uint8_t u8BaudRate; ///< 波特率设置
boolean_t bCPOL; ///< 时钟极性选择
boolean_t bCPHA; ///< 时钟相位选择
boolean_t bIrqEn; ///< 中断使能
func_ptr_t pfnSpi0IrqCb; ///< 中断回调函数
func_ptr_t pfnSpi1IrqCb; ///< 中断回调函数
}stc_spi_config_t;
//SPI 中断
void Spi_IRQHandler(en_spi_channel_t enCh);
//SPI 获取状态
uint8_t Spi_GetState(en_spi_channel_t enCh);
boolean_t Spi_GetStatus(en_spi_channel_t enCh,en_spi_status_t enStatus);
//SPI 清除中断标记
en_result_t Spi_ClearStatus(en_spi_channel_t enCh);
//SPI初始化函数
en_result_t Spi_Init(en_spi_channel_t enCh,stc_spi_config_t* pstcSpiConfig);
//SPI 功能使能禁止函数
en_result_t Spi_FuncEn(en_spi_channel_t enCh,en_spi_func_t enFunc,boolean_t bFlag);
//SPI关闭函数
en_result_t Spi_DeInit(en_spi_channel_t enCh);
//SPI 配置主发送的电平
void Spi_SetCS(en_spi_channel_t enCh,boolean_t bFlag);
//SPI 发送数据
en_result_t Spi_SendData(en_spi_channel_t enCh,uint8_t u8Data);
//SPI 主机接收数据
uint8_t Spi_ReceiveData(en_spi_channel_t enCh,boolean_t bMasterOrSlave);
//@} // Spi Group
#ifdef __cplusplus
}
#endif
#endif /* __SPI_H__ */
/******************************************************************************
* EOF (not truncated)
*****************************************************************************/