Vergil Cola
/
MQTTGateway2
Fork of my original MQTTGateway
Diff: easy-connect/stm-spirit1-rf-driver/source/libs/spirit1/SPIRIT1_Library/Inc/MCU_Interface.h
- Revision:
- 0:a1734fe1ec4b
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/easy-connect/stm-spirit1-rf-driver/source/libs/spirit1/SPIRIT1_Library/Inc/MCU_Interface.h Sat Apr 08 14:43:14 2017 +0000 @@ -0,0 +1,152 @@ +/** + * @file MCU_Interface.h + * @author VMA division - AMS + * @version V2.0.2 + * @date Febrary 7, 2015 + * @brief Header file for low level SPIRIT SPI driver. + * @details + * + * This header file constitutes an interface to the SPI driver used to + * communicate with Spirit. + * It exports some function prototypes to write/read registers and FIFOs + * and to send command strobes. + * Since the Spirit libraries are totally platform independent, the implementation + * of these functions are not provided here. The user have to implement these functions + * taking care to keep the exported prototypes. + * + * These functions are: + * + * <ul> + * <li>SpiritSpiInit</i> + * <li>SpiritSpiWriteRegisters</i> + * <li>SpiritSpiReadRegisters</i> + * <li>SpiritSpiCommandStrobes</i> + * <li>SpiritSpiWriteLinearFifo</i> + * <li>SpiritSpiReadLinearFifo</i> + * </ul> + * + * @note An example of SPI driver implementation is available in the <i>Sdk_Eval</i> library. + * + * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS + * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE + * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY + * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING + * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE + * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS. + * + * THIS SOURCE CODE IS PROTECTED BY A LICENSE. + * FOR MORE INFORMATION PLEASE CAREFULLY READ THE LICENSE AGREEMENT FILE LOCATED + * IN THE ROOT DIRECTORY OF THIS FIRMWARE PACKAGE. + * + * <h2><center>© COPYRIGHT 2015 STMicroelectronics</center></h2> + */ + + +/* Define to prevent recursive inclusion -------------------------------------*/ +#ifndef __MCU_INTERFACE_H +#define __MCU_INTERFACE_H + + +/* Includes ------------------------------------------------------------------*/ +#include "SPIRIT_Types.h" + + +#ifdef __cplusplus +extern "C" { +#endif + + +/** @addtogroup SPIRIT_Libraries + * @{ + */ + + +/** @defgroup SPIRIT_SPI_Driver SPI Driver + * @brief Header file for low level SPIRIT SPI driver. + * @details See the file <i>@ref MCU_Interface.h</i> for more details. + * @{ + */ + + + +/** @defgroup SPI_Exported_Types SPI Exported Types + * @{ + */ + +/** + * @} + */ + + + +/** @defgroup SPI_Exported_Constants SPI Exported Constants + * @{ + */ + +/** + * @} + */ + + + +/** @defgroup SPI_Exported_Macros SPI Exported Macros + * @{ + */ + +/** + * @} + */ + + + +/** @defgroup SPI_Exported_Functions SPI Exported Functions + * @{ + */ + +typedef SpiritStatus StatusBytes; + +void SdkEvalSpiInit(void); +StatusBytes SdkEvalSpiWriteRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer); +StatusBytes SdkEvalSpiReadRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer); +StatusBytes SdkEvalSpiCommandStrobes(uint8_t cCommandCode); +StatusBytes SdkEvalSpiWriteFifo(uint8_t cNbBytes, uint8_t* pcBuffer); +StatusBytes SdkEvalSpiReadFifo(uint8_t cNbBytes, uint8_t* pcBuffer); + +void SdkEvalEnterShutdown(void); +void SdkEvalExitShutdown(void); +SpiritFlagStatus SdkEvalCheckShutdown(void); + +#define SpiritEnterShutdown SdkEvalEnterShutdown +#define SpiritExitShutdown SdkEvalExitShutdown +#define SpiritCheckShutdown (SpiritFlagStatus)SdkEvalCheckShutdown + + +#define SpiritSpiInit SdkEvalSpiInit +#define SpiritSpiWriteRegisters(cRegAddress, cNbBytes, pcBuffer) SdkEvalSpiWriteRegisters(cRegAddress, cNbBytes, pcBuffer) +#define SpiritSpiReadRegisters(cRegAddress, cNbBytes, pcBuffer) SdkEvalSpiReadRegisters(cRegAddress, cNbBytes, pcBuffer) +#define SpiritSpiCommandStrobes(cCommandCode) SdkEvalSpiCommandStrobes(cCommandCode) +#define SpiritSpiWriteLinearFifo(cNbBytes, pcBuffer) SdkEvalSpiWriteFifo(cNbBytes, pcBuffer) +#define SpiritSpiReadLinearFifo(cNbBytes, pcBuffer) SdkEvalSpiReadFifo(cNbBytes, pcBuffer) + +/** + * @} + */ + +/** + * @} + */ + + +/** + * @} + */ + + + +#ifdef __cplusplus +} +#endif + +#endif + +/******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/