PAN3060_CIU32F003_TX/CIU32F003_LIB/Include/ciu32f003_std_spi(3).h

/************************************************************************************************/
/**
* @file               ciu32f003_std_spi.h
* @author             MCU Ecosystem Development Team
* @brief              SPI STD库驱动头文件。
*                     提供SPI相关的STD库操作函数声明、数据类型以及常量的定义。
*
*
**************************************************************************************************
* @attention
* Copyright (c) CEC Huada Electronic Design Co.,Ltd. All rights reserved.
*
**************************************************************************************************
*/

/* 避免头文件重复引用 */
#ifndef CIU32F003_STD_SPI_H
#define CIU32F003_STD_SPI_H

/************************************************************************************************/
/** 
* @addtogroup CIU32F003_STD_Driver
* @{
*/

/**
* @defgroup SPI SPI
* @brief 串行外设接口的STD库驱动 
* @{
*/
/************************************************************************************************/



#ifdef __cplusplus
 extern "C" {
#endif

/*------------------------------------------includes--------------------------------------------*/
#include "ciu32f003_std_common.h"


/*-----------------------------------------type define------------------------------------------*/
/************************************************************************************************/
/**
* @defgroup SPI_Types SPI Types
* @brief  SPI数据类型定义
* @{
*
*/
/************************************************************************************************/

/**
* @brief  SPI初始化配置结构体定义
*/
typedef struct
{
    uint32_t mode;                     /**< SPI工作模式
                                                @arg SPI_MODE_SLAVE
                                                @arg SPI_MODE_MASTER                            */

    uint32_t baud_rate_prescaler;      /**< SPI速率配置参数                                    
                                                @arg  SPI_BAUD_PCLKDIV_2          
                                                @arg  SPI_BAUD_PCLKDIV_4 ...      
                                                @note 主机输出时钟设置，从机不需要设置          */

    uint32_t clk_polarity;             /**< SPI时钟极性                                
                                                @arg SPI_POLARITY_LOW                  
                                                @arg SPI_POLARITY_HIGH                          */

    uint32_t clk_phase;                /**< SPI时钟相位                                
                                                @arg SPI_PHASE_1EDGE                   
                                                @arg SPI_PHASE_2EDGE                            */
    
    uint32_t bitorder;                 /**< SPI数据大小端
                                                @arg SPI_FIRSTBIT_MSB
                                                @arg SPI_FIRSTBIT_LSB                           */
}std_spi_init_t; 


/** 
* @} 
*/


/*--------------------------------------------define--------------------------------------------*/
/************************************************************************************************/
/** 
* @defgroup SPI_Constants SPI Constants
* @brief SPI常量定义及宏定义
* @{
*/
/************************************************************************************************/
/* SPI 工作模式 */
#define SPI_MODE_SLAVE                  (0x00000000U)                      /**< SPI从机模式     */
#define SPI_MODE_MASTER                 SPI_CR1_MSTR                       /**< SPI主机模式     */

/* SPI 速率配置参数 */    
#define SPI_BAUD_PCLKDIV_2              SPI_CR1_BR_PCLK_DIV_2              /**< SPI速率为fPLCK/2   */
#define SPI_BAUD_PCLKDIV_4              SPI_CR1_BR_PCLK_DIV_4              /**< SPI速率为fPLCK/4   */
#define SPI_BAUD_PCLKDIV_8              SPI_CR1_BR_PCLK_DIV_8              /**< SPI速率为fPLCK/8   */
#define SPI_BAUD_PCLKDIV_16             SPI_CR1_BR_PCLK_DIV_16             /**< SPI速率为fPLCK/16  */
#define SPI_BAUD_PCLKDIV_32             SPI_CR1_BR_PCLK_DIV_32             /**< SPI速率为fPLCK/32  */
#define SPI_BAUD_PCLKDIV_64             SPI_CR1_BR_PCLK_DIV_64             /**< SPI速率为fPLCK/64  */
#define SPI_BAUD_PCLKDIV_128            SPI_CR1_BR_PCLK_DIV_128            /**< SPI速率为fPLCK/128 */

/* SPI 时钟极性 */
#define SPI_POLARITY_LOW                (0x00000000U)                      /**< SPI时钟空闲为低 */
#define SPI_POLARITY_HIGH               SPI_CR1_CPOL                       /**< SPI时钟空闲为高 */

/* SPI 时钟相位 */
#define SPI_PHASE_1EDGE                 (0x00000000U)                      /**< SPI数据采样在第一个时钟沿 */
#define SPI_PHASE_2EDGE                 SPI_CR1_CPHA                       /**< SPI数据采样在第二个时钟沿 */

/* SPI 数据大小端 */
#define SPI_FIRSTBIT_MSB                (0x00000000U)                      /**< SPI数据收发为高位优先 */
#define SPI_FIRSTBIT_LSB                SPI_CR1_LSBFIRST                   /**< SPI数据收发为低位优先 */

/* SPI NSS输出状态*/
#define SPI_NSS_OUTPUT_LOW              (0x00000000U)                      /**< SPI片选信号输出低电平 */
#define SPI_NSS_OUTPUT_HIGH             SPI_CR2_NSSO                       /**< SPI片选信号输出高电平 */

/* SPI 中断事件 */
#define SPI_INTERRUPT_TXFE              SPI_CR1_TXFEIE                     /**< SPI发送数据寄存器为空中断使能 */
#define SPI_INTERRUPT_RXFNE             SPI_CR1_RXFNEIE                    /**< SPI接收数据寄存器非空中断使能 */
#define SPI_INTERRUPT_ERR               SPI_CR1_ERRIE                      /**< SPI错误中断使能               */

/* SPI 硬件状态信息 */
#define SPI_FLAG_TXFE                   SPI_ISR_TXFE                       /**< SPI发送数据寄存器空标志   */
#define SPI_FLAG_RXFNE                  SPI_ISR_RXFNE                      /**< SPI接收数据寄存器非空标志 */
#define SPI_FLAG_BUSY                   SPI_ISR_BUSY                       /**< SPI总线传输状态标志       */
#define SPI_FLAG_OVR                    SPI_ISR_OVR                        /**< SPI接收上溢出标志         */
#define SPI_FLAG_MMF                    SPI_ISR_MMF                        /**< SPI主机模式冲突标志       */

/* SPI 状态清除信息 */
#define SPI_CLEAR_FLAG_OVR              SPI_ICR_OVRCF                      /**< SPI主机上溢标志清除     */
#define SPI_CLEAR_FLAG_MMF              SPI_ICR_MMFCF                      /**< SPI主机模式冲突标志清除 */

/** 
* @} 
*/


/*-------------------------------------------functions------------------------------------------*/

/************************************************************************************************/
/**
* @defgroup SPI_External_Functions SPI External Functions
* @brief    SPI对外函数
* @{
*
*/
/************************************************************************************************/
/** 
* @brief  使能SPI
* @retval 无
*/
__STATIC_INLINE void std_spi_enable(void)
{
    SPI1->CR1 |= SPI_CR1_SPE;
}


/** 
* @brief  禁止SPI
* @retval 无
*/
__STATIC_INLINE void std_spi_disable(void)
{
    SPI1->CR1 &= (~SPI_CR1_SPE);
}


/** 
* @brief  设置SPI主从模式
* @param  mode SPI主从模式
*             @arg SPI_MODE_SLAVE
*             @arg SPI_MODE_MASTER   
* @retval 无
*/
__STATIC_INLINE void std_spi_set_mode(uint32_t mode)
{
    MODIFY_REG(SPI1->CR1, SPI_CR1_MSTR, mode);
}


/** 
* @brief  获取SPI主从模式
* @retval uint32_t SPI主从模式
*             @arg SPI_MODE_SLAVE
*             @arg SPI_MODE_MASTER  
*/
__STATIC_INLINE uint32_t std_spi_get_mode(void)
{
    return (SPI1->CR1 & SPI_CR1_MSTR);
}


/** 
* @brief  设置SPI波特率
* @param  baud_rate SPI波特率
*             @arg  SPI_BAUD_PCLKDIV_2      
*             @arg  SPI_BAUD_PCLKDIV_4
*             @arg  ...  
*             @arg  SPI_BAUD_PCLKDIV_128
* @note  主机输出时钟设置，从机不需要设置
* @retval 无
*/
__STATIC_INLINE void std_spi_set_baud_rate(uint32_t baud_rate)
{
    MODIFY_REG(SPI1->CR1, SPI_CR1_BR, baud_rate);
}


/** 
* @brief  获取SPI波特率
* @retval uint32_t  SPI波特率
*             @arg  SPI_BAUD_PCLKDIV_2
*             @arg  SPI_BAUD_PCLKDIV_4
*             @arg  ...  
*             @arg  SPI_BAUD_PCLKDIV_128
*/
__STATIC_INLINE uint32_t std_spi_get_baud_rate(void)
{
    return (SPI1->CR1 & SPI_CR1_BR);
}


/** 
* @brief  设置SPI时钟极性
* @param  polarity SPI时钟极性
*             @arg SPI_POLARITY_LOW
*             @arg SPI_POLARITY_HIGH
* @retval 无
*/
__STATIC_INLINE void std_spi_set_polarity(uint32_t polarity)
{
    MODIFY_REG(SPI1->CR1, SPI_CR1_CPOL, polarity);
}


/**
* @brief  设置SPI时钟相位 
* @param  phase SPI时钟相位
*             @arg SPI_PHASE_1EDGE 
*             @arg SPI_PHASE_2EDGE 
* @retval 无
*/
__STATIC_INLINE void std_spi_set_phase(uint32_t phase)
{
    MODIFY_REG(SPI1->CR1, SPI_CR1_CPHA, phase);
}


/**
* @brief  设置SPI数据大小端
* @param  first_bit SPI数据大小端
*             @arg SPI_FIRSTBIT_MSB 
*             @arg SPI_FIRSTBIT_LSB 
* @note   仅在禁止SPI（SPE为0）时才可对此位执行写操作
* @retval 无
*/
__STATIC_INLINE void std_spi_set_first_bit(uint32_t first_bit)
{
    MODIFY_REG(SPI1->CR1, SPI_CR1_LSBFIRST, first_bit);
}


/**
* @brief  使能NSS软片选
* @note   仅在从机模式下设置有效
* @retval 无
*/
__STATIC_INLINE void std_spi_nss_soft_chip_select_enable(void)
{
    SPI1->CR1 |= SPI_CR1_SSM;
}


/**
* @brief  禁止NSS软片选
* @note   仅在从机模式下设置有效
* @retval 无
*/
__STATIC_INLINE void std_spi_nss_soft_chip_select_disable(void)
{
    SPI1->CR1 &= (~SPI_CR1_SSM);
}


/**
* @brief  使能SPI NSS输出
* @note   仅在主机模式下设置有效
* @retval 无
*/
__STATIC_INLINE void std_spi_nss_output_enable(void)
{
    SPI1->CR1 |= SPI_CR1_NSSOE;
}


/**
* @brief  禁止SPI NSS输出
* @retval 无
*/
__STATIC_INLINE void std_spi_nss_output_disable(void)
{
    SPI1->CR1 &= (~SPI_CR1_NSSOE);
}


/**
* @brief  使能SPI中断
* @param  spi_interrupt SPI中断信息
*             @arg SPI_INTERRUPT_TXFE     
*             @arg SPI_INTERRUPT_RXFNE    
*             @arg SPI_INTERRUPT_ERR      
* @retval 无
*/
__STATIC_INLINE void std_spi_interrupt_enable(uint32_t spi_interrupt)
{
    SPI1->CR1 |= spi_interrupt;
}


/**
* @brief  禁止SPI中断
* @param  spi_interrupt SPI中断信息
*             @arg SPI_INTERRUPT_TXFE     
*             @arg SPI_INTERRUPT_RXFNE    
*             @arg SPI_INTERRUPT_ERR      
* @retval 无
*/
__STATIC_INLINE void std_spi_interrupt_disable(uint32_t spi_interrupt)
{
    SPI1->CR1 &= (~spi_interrupt);
}


/**
* @brief  获取SPI中断使能状态
* @param  spi_interrupt SPI中断信息
*             @arg SPI_INTERRUPT_TXFE     
*             @arg SPI_INTERRUPT_RXFNE    
*             @arg SPI_INTERRUPT_ERR      
* @retval uint32_t 中断使能状态
*             @arg 非0: 使能
*             @arg 0: 禁止
*/
__STATIC_INLINE uint32_t std_spi_get_interrupt_enable(uint32_t spi_interrupt)
{
    return (SPI1->CR1 & (spi_interrupt));
}


/**
* @brief  设置SPI NSS引脚电平
* @param  nss_output NSS输出电平
*             @arg SPI_NSS_OUTPUT_LOW   
*             @arg SPI_NSS_OUTPUT_HIGH  
* @note   仅在主机模式下且SPE使能的情况下设置有效
* @retval 无
*/
__STATIC_INLINE void std_spi_set_nss_output(uint32_t nss_output)
{
    SPI1->CR2 = nss_output;
}


/**
* @brief  获取SPI状态标志位
* @param  flag SPI状态标志位
*             @arg SPI_FLAG_TXFE 
*             @arg SPI_FLAG_RXFNE
*             @arg SPI_FLAG_BUSY 
*             @arg SPI_FLAG_OVR  
*             @arg SPI_FLAG_MMF  
* @retval uint32_t SPI标志位状态
*             @arg 非0: 标志位置位
*             @arg 0:   标志位清除
*/
__STATIC_INLINE uint32_t std_spi_get_flag(uint32_t flag)
{
    return (SPI1->ISR & (flag));
}


/**
* @brief  SPI标志清零
* @param  flag SPI标志
*             @arg SPI_CLEAR_FLAG_OVR
*             @arg SPI_CLEAR_FLAG_MMF
* @retval 无
*/
__STATIC_INLINE void std_spi_clear_flag(uint32_t flag)
{
    SPI1->ICR = (flag);
}


/**
* @brief  SPI读数据
* @retval uint8_t: 返回读取的SPI数据寄存器读取的数据
*/
__STATIC_INLINE uint8_t std_spi_read_data(void)
{
    return (SPI1->DR);
}

/**
* @brief  SPI写数据
* @param  send_data: 写入SPI数据寄存器的数据
* @retval 无
*/
__STATIC_INLINE void std_spi_write_data(uint8_t send_data)
{
    SPI1->DR = send_data;
}


void std_spi_init(std_spi_init_t *spi_init_param);
void std_spi_deinit(void);
void std_spi_struct_init(std_spi_init_t *spi_init_struct);


/** 
* @} 
*/

#ifdef __cplusplus
}
#endif

/** 
* @} 
*/

/** 
* @} 
*/

#endif /* CIU32F003_STD_SPI_H */