Added support for the WNC M14A2A Cellular LTE Data Module.
Dependencies: WNC14A2AInterface
MCU_Interface.h
00001 /** 00002 * @file MCU_Interface.h 00003 * @author VMA division - AMS 00004 * @version V2.0.2 00005 * @date Febrary 7, 2015 00006 * @brief Header file for low level SPIRIT SPI driver. 00007 * @details 00008 * 00009 * This header file constitutes an interface to the SPI driver used to 00010 * communicate with Spirit. 00011 * It exports some function prototypes to write/read registers and FIFOs 00012 * and to send command strobes. 00013 * Since the Spirit libraries are totally platform independent, the implementation 00014 * of these functions are not provided here. The user have to implement these functions 00015 * taking care to keep the exported prototypes. 00016 * 00017 * These functions are: 00018 * 00019 * <ul> 00020 * <li>SpiritSpiInit</i> 00021 * <li>SpiritSpiWriteRegisters</i> 00022 * <li>SpiritSpiReadRegisters</i> 00023 * <li>SpiritSpiCommandStrobes</i> 00024 * <li>SpiritSpiWriteLinearFifo</i> 00025 * <li>SpiritSpiReadLinearFifo</i> 00026 * </ul> 00027 * 00028 * @note An example of SPI driver implementation is available in the <i>Sdk_Eval</i> library. 00029 * 00030 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS 00031 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE 00032 * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY 00033 * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING 00034 * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE 00035 * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS. 00036 * 00037 * THIS SOURCE CODE IS PROTECTED BY A LICENSE. 00038 * FOR MORE INFORMATION PLEASE CAREFULLY READ THE LICENSE AGREEMENT FILE LOCATED 00039 * IN THE ROOT DIRECTORY OF THIS FIRMWARE PACKAGE. 00040 * 00041 * <h2><center>© COPYRIGHT 2015 STMicroelectronics</center></h2> 00042 */ 00043 00044 00045 /* Define to prevent recursive inclusion -------------------------------------*/ 00046 #ifndef __MCU_INTERFACE_H 00047 #define __MCU_INTERFACE_H 00048 00049 00050 /* Includes ------------------------------------------------------------------*/ 00051 #include "SPIRIT_Types.h" 00052 00053 00054 #ifdef __cplusplus 00055 extern "C" { 00056 #endif 00057 00058 00059 /** @addtogroup SPIRIT_Libraries 00060 * @{ 00061 */ 00062 00063 00064 /** @defgroup SPIRIT_SPI_Driver SPI Driver 00065 * @brief Header file for low level SPIRIT SPI driver. 00066 * @details See the file <i>@ref MCU_Interface.h</i> for more details. 00067 * @{ 00068 */ 00069 00070 00071 00072 /** @defgroup SPI_Exported_Types SPI Exported Types 00073 * @{ 00074 */ 00075 00076 /** 00077 * @} 00078 */ 00079 00080 00081 00082 /** @defgroup SPI_Exported_Constants SPI Exported Constants 00083 * @{ 00084 */ 00085 00086 /** 00087 * @} 00088 */ 00089 00090 00091 00092 /** @defgroup SPI_Exported_Macros SPI Exported Macros 00093 * @{ 00094 */ 00095 00096 /** 00097 * @} 00098 */ 00099 00100 00101 00102 /** @defgroup SPI_Exported_Functions SPI Exported Functions 00103 * @{ 00104 */ 00105 00106 typedef SpiritStatus StatusBytes; 00107 00108 void SdkEvalSpiInit(void); 00109 StatusBytes SdkEvalSpiWriteRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer); 00110 StatusBytes SdkEvalSpiReadRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer); 00111 StatusBytes SdkEvalSpiCommandStrobes(uint8_t cCommandCode); 00112 StatusBytes SdkEvalSpiWriteFifo(uint8_t cNbBytes, uint8_t* pcBuffer); 00113 StatusBytes SdkEvalSpiReadFifo(uint8_t cNbBytes, uint8_t* pcBuffer); 00114 00115 void SdkEvalEnterShutdown(void); 00116 void SdkEvalExitShutdown(void); 00117 SpiritFlagStatus SdkEvalCheckShutdown(void); 00118 00119 #define SpiritEnterShutdown SdkEvalEnterShutdown 00120 #define SpiritExitShutdown SdkEvalExitShutdown 00121 #define SpiritCheckShutdown (SpiritFlagStatus)SdkEvalCheckShutdown 00122 00123 00124 #define SpiritSpiInit SdkEvalSpiInit 00125 #define SpiritSpiWriteRegisters(cRegAddress, cNbBytes, pcBuffer) SdkEvalSpiWriteRegisters(cRegAddress, cNbBytes, pcBuffer) 00126 #define SpiritSpiReadRegisters(cRegAddress, cNbBytes, pcBuffer) SdkEvalSpiReadRegisters(cRegAddress, cNbBytes, pcBuffer) 00127 #define SpiritSpiCommandStrobes(cCommandCode) SdkEvalSpiCommandStrobes(cCommandCode) 00128 #define SpiritSpiWriteLinearFifo(cNbBytes, pcBuffer) SdkEvalSpiWriteFifo(cNbBytes, pcBuffer) 00129 #define SpiritSpiReadLinearFifo(cNbBytes, pcBuffer) SdkEvalSpiReadFifo(cNbBytes, pcBuffer) 00130 00131 /** 00132 * @} 00133 */ 00134 00135 /** 00136 * @} 00137 */ 00138 00139 00140 /** 00141 * @} 00142 */ 00143 00144 00145 00146 #ifdef __cplusplus 00147 } 00148 #endif 00149 00150 #endif 00151 00152 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/
Generated on Tue Jul 12 2022 19:09:03 by 1.7.2