/****************************************************************************//** * @file spi.h * @version V1.00 * $Revision: 21 $ * $Date: 15/06/18 4:12p $ * @brief NUC472/NUC442 SPI driver header file * * @note * Copyright (C) 2014 Nuvoton Technology Corp. All rights reserved. *****************************************************************************/ #ifndef __SPI_H__ #define __SPI_H__ #ifdef __cplusplus extern "C" { #endif /** @addtogroup NUC472_442_Device_Driver NUC472/NUC442 Device Driver @{ */ /** @addtogroup NUC472_442_SPI_Driver SPI Driver @{ */ /** @addtogroup NUC472_442_SPI_EXPORTED_CONSTANTS SPI Exported Constants @{ */ #define SPI_MODE_0 (SPI_CTL_TXNEG_Msk) /*!< CLKP=0; RX_NEG=0; TX_NEG=1 \hideinitializer */ #define SPI_MODE_1 (SPI_CTL_RXNEG_Msk) /*!< CLKP=0; RX_NEG=1; TX_NEG=0 \hideinitializer */ #define SPI_MODE_2 (SPI_CTL_CLKPOL_Msk | SPI_CTL_RXNEG_Msk) /*!< CLKP=1; RX_NEG=1; TX_NEG=0 \hideinitializer */ #define SPI_MODE_3 (SPI_CTL_CLKPOL_Msk | SPI_CTL_TXNEG_Msk) /*!< CLKP=1; RX_NEG=0; TX_NEG=1 \hideinitializer */ #define SPI_SLAVE (SPI_CTL_SLAVE_Msk) /*!< Set as slave \hideinitializer */ #define SPI_MASTER (0x0) /*!< Set as master \hideinitializer */ #define SPI_SS0 (0x1) /*!< Set SS0 \hideinitializer */ #define SPI_SS1 (0x2) /*!< Set SS1 \hideinitializer */ #define SPI_SS_ACTIVE_HIGH (SPI_SSCTL_SSACTPOL_Msk) /*!< SS active high \hideinitializer */ #define SPI_SS_ACTIVE_LOW (0x0) /*!< SS active low \hideinitializer */ #define SPI_UNITIEN_MASK (0x001) /*!< Interrupt enable mask \hideinitializer */ #define SPI_SSINAIEN_MASK (0x002) /*!< Slave Slave Inactive interrupt enable mask \hideinitializer */ #define SPI_SSACTIEN_MASK (0x004) /*!< Slave Slave Active interrupt enable mask \hideinitializer */ #define SPI_SLVURIEN_MASK (0x008) /*!< Slave Mode Error 1 interrupt enable mask \hideinitializer */ #define SPI_SLVBEIEN_MASK (0x010) /*!< Slave Mode Error 0 interrupt enable mask \hideinitializer */ #define SPI_SLVTOIEN_MASK (0x020) /*!< Slave Mode Time-out interrupt enable mask \hideinitializer */ #define SPI_FIFO_TXTHIEN_MASK (0x040) /*!< Transmit FIFO Threshold interrupt enable mask \hideinitializer */ #define SPI_FIFO_RXTHIEN_MASK (0x080) /*!< Receive FIFO Threshold interrupt enable mask \hideinitializer */ #define SPI_FIFO_RXOVIEN_MASK (0x100) /*!< Receive FIFO Overrun interrupt enable mask \hideinitializer */ #define SPI_FIFO_TXUFIEN_MASK (0x200) /*!< Slave Transmit Under Run interrupt enable mask \hideinitializer */ #define SPI_FIFO_RXTOIEN_MASK (0x400) /*!< Slave Receive Time-out interrupt enable mask \hideinitializer */ /*@}*/ /* end of group NUC472_442_SPI_EXPORTED_CONSTANTS */ /** @addtogroup NUC472_442_SPI_EXPORTED_FUNCTIONS SPI Exported Functions @{ */ /** * @brief Set time out period for slave. * @note Before calling this function, SPI must be stopped first. \ref SPI_DISABLE must be called. * @param[in] spi is the base address of SPI module. * @param[in] u32TimeoutPeriod is the period of time out. * @return none * \hideinitializer */ #define SPI_SET_SLAVE_TIMEOUT_PERIOD(spi, u32TimeoutPeriod) ( (spi)->SSCTL = ((spi)->SSCTL & ~SPI_SSCTL_SLVTOCNT_Msk) | (((uint32_t)u32TimeoutPeriod & 0xFFFF) << SPI_SSCTL_SLVTOCNT_Pos) ) /** * @brief Enable time out clear function for FIFO mode. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_ENABLE_TIMEOUT_FIFO_CLEAR(spi) ( (spi)->SSCTL |= SPI_SSCTL_SLVTORST_Msk ) /** * @brief Disable time out clear function for FIFO mode. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_DISABLE_TIMEOUT_FIFO_CLEAR(spi) ( (spi)->SSCTL &= ~SPI_SSCTL_SLVTORST_Msk ) /** * @brief Set data out signal to low (0) if transmit under-run occurs. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_SET_TX_UNDERRUN_DATA_LOW(spi) ( (spi)->FIFOCTL &= ~SPI_FIFOCTL_TXUFPOL_Msk ) /** * @brief Set data out signal to high (1) if transmit under-run occurs. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_SET_TX_UNDERRUN_DATA_HIGH(spi) ( (spi)->FIFOCTL |= SPI_FIFOCTL_TXUFPOL_Msk ) /** * @brief Get the status flags. * @param spi is the base address of SPI module. * @return status flags * \hideinitializer */ #define SPI_GET_STATUS(spi) ( (spi)->STATUS ) /** * @brief Clear the unit transfer interrupt flag. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_CLR_UNIT_TRANS_INT_FLAG(spi) ( (spi)->STATUS = SPI_STATUS_UNITIF_Msk ) /** * @brief Disable slave 3-wire mode. * @note Before calling this function, SPI must be stopped first. \ref SPI_DISABLE must be called. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_DISABLE_3WIRE_MODE(spi) ( (spi)->SSCTL &= ~SPI_SSCTL_SLV3WIRE_Msk ) /** * @brief Enable slave 3-wire mode. * @note Before calling this function, SPI must be stopped first. \ref SPI_DISABLE must be called. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_ENABLE_3WIRE_MODE(spi) ( (spi)->SSCTL |= SPI_SSCTL_SLV3WIRE_Msk ) /** * @brief Get the count of available data in RX FIFO. * @param[in] spi is the base address of SPI module. * @return The count of available data in RX FIFO. * \hideinitializer */ #define SPI_GET_RX_FIFO_COUNT(spi) ( (((spi)->STATUS & SPI_STATUS_RXCNT_Msk) >> SPI_STATUS_RXCNT_Pos) & 0xf ) /** * @brief Get the Rx FIFO empty flag. * @param[in] spi is the base address of SPI module. * @return Rx FIFO flag * @retval 0: Rx FIFO is not empty * @retval 1: Rx FIFO is empty * \hideinitializer */ #define SPI_GET_RX_FIFO_EMPTY_FLAG(spi) ( ((spi)->STATUS & SPI_STATUS_RXEMPTY_Msk) == SPI_STATUS_RXEMPTY_Msk ? 1:0 ) /** * @brief Get the Tx FIFO empty flag. * @param[in] spi is the base address of SPI module. * @return Tx FIFO flag * @retval 0: Tx FIFO is not empty * @retval 1: Tx FIFO is empty * \hideinitializer */ #define SPI_GET_TX_FIFO_EMPTY_FLAG(spi) ( ((spi)->STATUS & SPI_STATUS_TXEMPTY_Msk) == SPI_STATUS_TXEMPTY_Msk ? 1:0 ) /** * @brief Get the Tx FIFO full flag. * @param[in] spi is the base address of SPI module. * @return Tx FIFO flag * @retval 0: Tx FIFO is not full * @retval 1: Tx FIFO is full * \hideinitializer */ #define SPI_GET_TX_FIFO_FULL_FLAG(spi) ( ((spi)->STATUS & SPI_STATUS_TXFULL_Msk) == SPI_STATUS_TXFULL_Msk ? 1:0 ) /** * @brief Get the datum read from R0 FIFO. * @param[in] spi is the base address of SPI module. * @return data in Rx register * \hideinitializer */ #define SPI_READ_RX(spi) ((spi)->RX) /** * @brief Write datum to TX register. * @param[in] spi is the base address of SPI module. * @param[in] u32TxData is the datum which user attempt to transfer through SPI bus. * @return none * \hideinitializer */ #define SPI_WRITE_TX(spi, u32TxData) ( (spi)->TX = u32TxData ) /** * @brief Set SPIn_SS0 pin to high state. * @param[in] spi The pointer of the specified SPI module. * @return None. * @details Disable automatic slave selection function and set SPIn_SS0 pin to high state. Only available in Master mode. * \hideinitializer */ #define SPI_SET_SS0_HIGH(spi) ((spi)->SSCTL = ((spi)->SSCTL & ~(SPI_SSCTL_AUTOSS_Msk|SPI_SSCTL_SSACTPOL_Msk|SPI_SS0))) /** * @brief Set SPIn_SS0 pin to low state. * @param[in] spi The pointer of the specified SPI module. * @return None. * @details Disable automatic slave selection function and set SPIn_SS0 pin to low state. Only available in Master mode. * \hideinitializer */ #define SPI_SET_SS0_LOW(spi) ((spi)->SSCTL = ((spi)->SSCTL & ~(SPI_SSCTL_AUTOSS_Msk|SPI_SSCTL_SSACTPOL_Msk|SPI_SS0)) | SPI_SS0) /** * @brief Set SPIn_SS1 pin to high state. * @param[in] spi The pointer of the specified SPI module. * @return None. * @details Disable automatic slave selection function and set SPIn_SS1 pin to high state. Only available in Master mode. * \hideinitializer */ #define SPI_SET_SS1_HIGH(spi) ((spi)->SSCTL = ((spi)->SSCTL & ~(SPI_SSCTL_AUTOSS_Msk|SPI_SSCTL_SSACTPOL_Msk|SPI_SS1))) /** * @brief Set SPIn_SS1 pin to low state. * @param[in] spi The pointer of the specified SPI module. * @return None. * @details Disable automatic slave selection function and set SPIn_SS1 pin to low state. Only available in Master mode. * \hideinitializer */ #define SPI_SET_SS1_LOW(spi) ((spi)->SSCTL = ((spi)->SSCTL & ~(SPI_SSCTL_AUTOSS_Msk|SPI_SSCTL_SSACTPOL_Msk|SPI_SS1)) | SPI_SS1) /** * @brief Enable byte reorder function. * @note Before calling this function, SPI must be stopped first. \ref SPI_DISABLE must be called. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_ENABLE_BYTE_REORDER(spi) ( (spi)->CTL |= SPI_CTL_REORDER_Msk ) /** * @brief Disable byte reorder function. * @note Before calling this function, SPI must be stopped first. \ref SPI_DISABLE must be called. * @param [in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_DISABLE_BYTE_REORDER(spi) ( (spi)->CTL &= ~SPI_CTL_REORDER_Msk ) /** * @brief Set the length of suspend interval. * @note Before calling this function, SPI must be stopped first. \ref SPI_DISABLE must be called. * @param[in] spi is the base address of SPI module. * @param[in] u32SuspCycle decides the length of suspend interval. * @return none * \hideinitializer */ #define SPI_SET_SUSPEND_CYCLE(spi, u32SuspCycle) ( (spi)->CTL = ((spi)->CTL & ~SPI_CTL_SUSPITV_Msk) | (u32SuspCycle << SPI_CTL_SUSPITV_Pos) ) /** * @brief Set the SPI transfer sequence with LSB first. * @note Before calling this function, SPI must be stopped first. \ref SPI_DISABLE must be called. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_SET_LSB_FIRST(spi) ( (spi)->CTL |= SPI_CTL_LSB_Msk ) /** * @brief Set the SPI transfer sequence with MSB first. * @note Before calling this function, SPI must be stopped first. \ref SPI_DISABLE must be called. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_SET_MSB_FIRST(spi) ( (spi)->CTL &= ~SPI_CTL_LSB_Msk ) /** * @brief Set the data width of a SPI transaction. * @note Before calling this function, SPI must be stopped first. \ref SPI_DISABLE must be called. * @param[in] spi is the base address of SPI module. * @param[in] u32Width data width * @return none * \hideinitializer */ static __INLINE void SPI_SET_DATA_WIDTH(SPI_T *spi, uint32_t u32Width) { if(u32Width == 32) u32Width = 0; spi->CTL = (spi->CTL & ~SPI_CTL_DWIDTH_Msk) | (u32Width << SPI_CTL_DWIDTH_Pos); } /** * @brief Get the SPI busy state. * @param[in] spi is the base address of SPI module. * @return SPI busy status * @retval 0: SPI module is not busy * @retval 1: SPI module is busy * \hideinitializer */ #define SPI_IS_BUSY(spi) ( ((spi)->STATUS & SPI_STATUS_BUSY_Msk) == SPI_STATUS_BUSY_Msk ? 1:0 ) /** * @brief Set the SPIEN bit to trigger SPI transfer. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_TRIGGER(spi) ( (spi)->CTL |= SPI_CTL_SPIEN_Msk ) /** * @brief Set the SPIEN bit to trigger SPI transfer. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_ENABLE(spi) ( (spi)->CTL |= SPI_CTL_SPIEN_Msk ) /** * @brief Disable SPI function. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_DISABLE(spi) ( (spi)->CTL &= ~SPI_CTL_SPIEN_Msk ) /** * @brief Disable SPI Dual IO function. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_DISABLE_DUAL_MODE(spi) ( (spi)->CTL &= ~SPI_CTL_DUALIOEN_Msk ) /** * @brief Enable Dual IO function and set SPI Dual IO direction to input. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_ENABLE_DUAL_INPUT_MODE(spi) ( (spi)->CTL = ((spi)->CTL & ~SPI_CTL_QDIODIR_Msk) | SPI_CTL_DUALIOEN_Msk ) /** * @brief Enable Dual IO function and set SPI Dual IO direction to output. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_ENABLE_DUAL_OUTPUT_MODE(spi) ( (spi)->CTL |= SPI_CTL_QDIODIR_Msk | SPI_CTL_DUALIOEN_Msk ) /** * @brief Disable SPI Dual IO function. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_DISABLE_QUAD_MODE(spi) ( (spi)->CTL &= ~SPI_CTL_QUADIOEN_Msk ) /** * @brief Set SPI Quad IO direction to input. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_ENABLE_QUAD_INPUT_MODE(spi) ( (spi)->CTL = ((spi)->CTL & ~SPI_CTL_QDIODIR_Msk) | SPI_CTL_QUADIOEN_Msk ) /** * @brief Set SPI Quad IO direction to output. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_ENABLE_QUAD_OUTPUT_MODE(spi) ( (spi)->CTL |= SPI_CTL_QDIODIR_Msk | SPI_CTL_QUADIOEN_Msk ) /** * @brief Trigger RX PDMA transfer. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_TRIGGER_RX_PDMA(spi) ( (spi)->PDMACTL |= SPI_PDMACTL_RXPDMAEN_Msk ) /** * @brief Trigger TX PDMA transfer. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_TRIGGER_TX_PDMA(spi) ( (spi)->PDMACTL |= SPI_PDMACTL_TXPDMAEN_Msk ) /** * @brief Trigger TX/RX PDMA transfer at the same time. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_TRIGGER_TXRX_PDMA(spi) ( (spi)->PDMACTL |= (SPI_PDMACTL_TXPDMAEN_Msk | SPI_PDMACTL_RXPDMAEN_Msk) ) /** * @brief Disable RX PDMA transfer. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_DISABLE_RX_PDMA(spi) ( (spi)->PDMACTL &= ~SPI_PDMACTL_RXPDMAEN_Msk ) /** * @brief Trigger TX PDMA transfer. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_DISABLE_TX_PDMA(spi) ( (spi)->PDMACTL &= ~SPI_PDMACTL_TXPDMAEN_Msk ) /** * @brief Enable 2-bit transfer mode. * @note Before calling this function, SPI must be stopped first. \ref SPI_DISABLE must be called. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_ENABLE_2BIT_MODE(spi) ( (spi)->CTL |= SPI_CTL_TWOBIT_Msk ) /** * @brief Disable 2-bit transfer mode. * @note Before calling this function, SPI must be stopped first. \ref SPI_DISABLE must be called. * @param[in] spi is the base address of SPI module. * @return none * \hideinitializer */ #define SPI_DISABLE_2BIT_MODE(spi) ( (spi)->CTL &= ~SPI_CTL_TWOBIT_Msk ) uint32_t SPI_Open(SPI_T *spi,uint32_t u32MasterSlave, uint32_t u32SPIMode, uint32_t u32DataWidth, uint32_t u32BusClock); void SPI_Close(SPI_T *spi); void SPI_ClearRxFIFO(SPI_T *spi); void SPI_ClearTxFIFO(SPI_T *spi); void SPI_DisableAutoSS(SPI_T *spi); void SPI_EnableAutoSS(SPI_T *spi, uint32_t u32SSPinMask, uint32_t u32ActiveLevel); uint32_t SPI_SetBusClock(SPI_T *spi, uint32_t u32BusClock); void SPI_SetFIFOThreshold(SPI_T *spi, uint32_t u32TxThreshold, uint32_t u32RxThreshold); uint32_t SPI_GetBusClock(SPI_T *spi); void SPI_EnableInt(SPI_T *spi, uint32_t u32Mask); void SPI_DisableInt(SPI_T *spi, uint32_t u32Mask); /*@}*/ /* end of group NUC472_442_SPI_EXPORTED_FUNCTIONS */ /*@}*/ /* end of group NUC472_442_SPI_Driver */ /*@}*/ /* end of group NUC472_442_Device_Driver */ #ifdef __cplusplus } #endif #endif //__SPI_H__ /*** (C) COPYRIGHT 2014 Nuvoton Technology Corp. ***/