Jim Flynn / Mbed OS wifi_Example

wifi test

Dependencies:   X_NUCLEO_IKS01A2 mbed-http

easy-connect/stm-spirit1-rf-driver/source/libs/spirit1/SPIRIT1_Library/Inc/MCU_Interface.h@0:24d3eb812fd4, 2018-09-05 (annotated)

Committer:
JMF
Date:
Wed Sep 05 14:28:24 2018 +0000
Revision:
0:24d3eb812fd4
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
JMF 0:24d3eb812fd4 1 /**
JMF 0:24d3eb812fd4 2 * @file MCU_Interface.h
JMF 0:24d3eb812fd4 3 * @author VMA division - AMS
JMF 0:24d3eb812fd4 4 * @version V2.0.2
JMF 0:24d3eb812fd4 5 * @date Febrary 7, 2015
JMF 0:24d3eb812fd4 6 * @brief Header file for low level SPIRIT SPI driver.
JMF 0:24d3eb812fd4 7 * @details
JMF 0:24d3eb812fd4 8 *
JMF 0:24d3eb812fd4 9 * This header file constitutes an interface to the SPI driver used to
JMF 0:24d3eb812fd4 10 * communicate with Spirit.
JMF 0:24d3eb812fd4 11 * It exports some function prototypes to write/read registers and FIFOs
JMF 0:24d3eb812fd4 12 * and to send command strobes.
JMF 0:24d3eb812fd4 13 * Since the Spirit libraries are totally platform independent, the implementation
JMF 0:24d3eb812fd4 14 * of these functions are not provided here. The user have to implement these functions
JMF 0:24d3eb812fd4 15 * taking care to keep the exported prototypes.
JMF 0:24d3eb812fd4 16 *
JMF 0:24d3eb812fd4 17 * These functions are:
JMF 0:24d3eb812fd4 18 *
JMF 0:24d3eb812fd4 19 * <ul>
JMF 0:24d3eb812fd4 20 * <li>SpiritSpiInit</i>
JMF 0:24d3eb812fd4 21 * <li>SpiritSpiWriteRegisters</i>
JMF 0:24d3eb812fd4 22 * <li>SpiritSpiReadRegisters</i>
JMF 0:24d3eb812fd4 23 * <li>SpiritSpiCommandStrobes</i>
JMF 0:24d3eb812fd4 24 * <li>SpiritSpiWriteLinearFifo</i>
JMF 0:24d3eb812fd4 25 * <li>SpiritSpiReadLinearFifo</i>
JMF 0:24d3eb812fd4 26 * </ul>
JMF 0:24d3eb812fd4 27 *
JMF 0:24d3eb812fd4 28 * @note An example of SPI driver implementation is available in the <i>Sdk_Eval</i> library.
JMF 0:24d3eb812fd4 29 *
JMF 0:24d3eb812fd4 30 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
JMF 0:24d3eb812fd4 31 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
JMF 0:24d3eb812fd4 32 * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
JMF 0:24d3eb812fd4 33 * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
JMF 0:24d3eb812fd4 34 * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
JMF 0:24d3eb812fd4 35 * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
JMF 0:24d3eb812fd4 36 *
JMF 0:24d3eb812fd4 37 * THIS SOURCE CODE IS PROTECTED BY A LICENSE.
JMF 0:24d3eb812fd4 38 * FOR MORE INFORMATION PLEASE CAREFULLY READ THE LICENSE AGREEMENT FILE LOCATED
JMF 0:24d3eb812fd4 39 * IN THE ROOT DIRECTORY OF THIS FIRMWARE PACKAGE.
JMF 0:24d3eb812fd4 40 *
JMF 0:24d3eb812fd4 41 * <h2><center>&copy; COPYRIGHT 2015 STMicroelectronics</center></h2>
JMF 0:24d3eb812fd4 42 */
JMF 0:24d3eb812fd4 43
JMF 0:24d3eb812fd4 44
JMF 0:24d3eb812fd4 45 /* Define to prevent recursive inclusion -------------------------------------*/
JMF 0:24d3eb812fd4 46 #ifndef __MCU_INTERFACE_H
JMF 0:24d3eb812fd4 47 #define __MCU_INTERFACE_H
JMF 0:24d3eb812fd4 48
JMF 0:24d3eb812fd4 49
JMF 0:24d3eb812fd4 50 /* Includes ------------------------------------------------------------------*/
JMF 0:24d3eb812fd4 51 #include "SPIRIT_Types.h"
JMF 0:24d3eb812fd4 52
JMF 0:24d3eb812fd4 53
JMF 0:24d3eb812fd4 54 #ifdef __cplusplus
JMF 0:24d3eb812fd4 55 extern "C" {
JMF 0:24d3eb812fd4 56 #endif
JMF 0:24d3eb812fd4 57
JMF 0:24d3eb812fd4 58
JMF 0:24d3eb812fd4 59 /** @addtogroup SPIRIT_Libraries
JMF 0:24d3eb812fd4 60 * @{
JMF 0:24d3eb812fd4 61 */
JMF 0:24d3eb812fd4 62
JMF 0:24d3eb812fd4 63
JMF 0:24d3eb812fd4 64 /** @defgroup SPIRIT_SPI_Driver SPI Driver
JMF 0:24d3eb812fd4 65 * @brief Header file for low level SPIRIT SPI driver.
JMF 0:24d3eb812fd4 66 * @details See the file <i>@ref MCU_Interface.h</i> for more details.
JMF 0:24d3eb812fd4 67 * @{
JMF 0:24d3eb812fd4 68 */
JMF 0:24d3eb812fd4 69
JMF 0:24d3eb812fd4 70
JMF 0:24d3eb812fd4 71
JMF 0:24d3eb812fd4 72 /** @defgroup SPI_Exported_Types SPI Exported Types
JMF 0:24d3eb812fd4 73 * @{
JMF 0:24d3eb812fd4 74 */
JMF 0:24d3eb812fd4 75
JMF 0:24d3eb812fd4 76 /**
JMF 0:24d3eb812fd4 77 * @}
JMF 0:24d3eb812fd4 78 */
JMF 0:24d3eb812fd4 79
JMF 0:24d3eb812fd4 80
JMF 0:24d3eb812fd4 81
JMF 0:24d3eb812fd4 82 /** @defgroup SPI_Exported_Constants SPI Exported Constants
JMF 0:24d3eb812fd4 83 * @{
JMF 0:24d3eb812fd4 84 */
JMF 0:24d3eb812fd4 85
JMF 0:24d3eb812fd4 86 /**
JMF 0:24d3eb812fd4 87 * @}
JMF 0:24d3eb812fd4 88 */
JMF 0:24d3eb812fd4 89
JMF 0:24d3eb812fd4 90
JMF 0:24d3eb812fd4 91
JMF 0:24d3eb812fd4 92 /** @defgroup SPI_Exported_Macros SPI Exported Macros
JMF 0:24d3eb812fd4 93 * @{
JMF 0:24d3eb812fd4 94 */
JMF 0:24d3eb812fd4 95
JMF 0:24d3eb812fd4 96 /**
JMF 0:24d3eb812fd4 97 * @}
JMF 0:24d3eb812fd4 98 */
JMF 0:24d3eb812fd4 99
JMF 0:24d3eb812fd4 100
JMF 0:24d3eb812fd4 101
JMF 0:24d3eb812fd4 102 /** @defgroup SPI_Exported_Functions SPI Exported Functions
JMF 0:24d3eb812fd4 103 * @{
JMF 0:24d3eb812fd4 104 */
JMF 0:24d3eb812fd4 105
JMF 0:24d3eb812fd4 106 typedef SpiritStatus StatusBytes;
JMF 0:24d3eb812fd4 107
JMF 0:24d3eb812fd4 108 void SdkEvalSpiInit(void);
JMF 0:24d3eb812fd4 109 StatusBytes SdkEvalSpiWriteRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
JMF 0:24d3eb812fd4 110 StatusBytes SdkEvalSpiReadRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
JMF 0:24d3eb812fd4 111 StatusBytes SdkEvalSpiCommandStrobes(uint8_t cCommandCode);
JMF 0:24d3eb812fd4 112 StatusBytes SdkEvalSpiWriteFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
JMF 0:24d3eb812fd4 113 StatusBytes SdkEvalSpiReadFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
JMF 0:24d3eb812fd4 114
JMF 0:24d3eb812fd4 115 void SdkEvalEnterShutdown(void);
JMF 0:24d3eb812fd4 116 void SdkEvalExitShutdown(void);
JMF 0:24d3eb812fd4 117 SpiritFlagStatus SdkEvalCheckShutdown(void);
JMF 0:24d3eb812fd4 118
JMF 0:24d3eb812fd4 119 #define SpiritEnterShutdown SdkEvalEnterShutdown
JMF 0:24d3eb812fd4 120 #define SpiritExitShutdown SdkEvalExitShutdown
JMF 0:24d3eb812fd4 121 #define SpiritCheckShutdown (SpiritFlagStatus)SdkEvalCheckShutdown
JMF 0:24d3eb812fd4 122
JMF 0:24d3eb812fd4 123
JMF 0:24d3eb812fd4 124 #define SpiritSpiInit SdkEvalSpiInit
JMF 0:24d3eb812fd4 125 #define SpiritSpiWriteRegisters(cRegAddress, cNbBytes, pcBuffer) SdkEvalSpiWriteRegisters(cRegAddress, cNbBytes, pcBuffer)
JMF 0:24d3eb812fd4 126 #define SpiritSpiReadRegisters(cRegAddress, cNbBytes, pcBuffer) SdkEvalSpiReadRegisters(cRegAddress, cNbBytes, pcBuffer)
JMF 0:24d3eb812fd4 127 #define SpiritSpiCommandStrobes(cCommandCode) SdkEvalSpiCommandStrobes(cCommandCode)
JMF 0:24d3eb812fd4 128 #define SpiritSpiWriteLinearFifo(cNbBytes, pcBuffer) SdkEvalSpiWriteFifo(cNbBytes, pcBuffer)
JMF 0:24d3eb812fd4 129 #define SpiritSpiReadLinearFifo(cNbBytes, pcBuffer) SdkEvalSpiReadFifo(cNbBytes, pcBuffer)
JMF 0:24d3eb812fd4 130
JMF 0:24d3eb812fd4 131 /**
JMF 0:24d3eb812fd4 132 * @}
JMF 0:24d3eb812fd4 133 */
JMF 0:24d3eb812fd4 134
JMF 0:24d3eb812fd4 135 /**
JMF 0:24d3eb812fd4 136 * @}
JMF 0:24d3eb812fd4 137 */
JMF 0:24d3eb812fd4 138
JMF 0:24d3eb812fd4 139
JMF 0:24d3eb812fd4 140 /**
JMF 0:24d3eb812fd4 141 * @}
JMF 0:24d3eb812fd4 142 */
JMF 0:24d3eb812fd4 143
JMF 0:24d3eb812fd4 144
JMF 0:24d3eb812fd4 145
JMF 0:24d3eb812fd4 146 #ifdef __cplusplus
JMF 0:24d3eb812fd4 147 }
JMF 0:24d3eb812fd4 148 #endif
JMF 0:24d3eb812fd4 149
JMF 0:24d3eb812fd4 150 #endif
JMF 0:24d3eb812fd4 151
JMF 0:24d3eb812fd4 152 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/