Jim Flynn / easy-connect

Added support for WNC M14A2A Cellular LTE Data Module.

Dependencies:   WNC14A2AInterface

Dependents:   http-example-wnc http-example-wnc-modified

stm-spirit1-rf-driver/stm-spirit1-rf-driver/radio_spi.h@4:daf182af022b, 2017-04-19 (annotated)

Committer:
JMF
Date:
Wed Apr 19 20:58:54 2017 +0000
Revision:
4:daf182af022b
Parent:
0:2563b0415d1f 
json file changes;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
JMF 0:2563b0415d1f 1 /**
JMF 0:2563b0415d1f 2 ******************************************************************************
JMF 0:2563b0415d1f 3 * @file radio_spi.h
JMF 0:2563b0415d1f 4 * @author System Lab - NOIDA
JMF 0:2563b0415d1f 5 * @version V1.0.0
JMF 0:2563b0415d1f 6 * @date 15-May-2014
JMF 0:2563b0415d1f 7 * @brief This file contains all the functions prototypes for SPI .
JMF 0:2563b0415d1f 8 ******************************************************************************
JMF 0:2563b0415d1f 9 * @attention
JMF 0:2563b0415d1f 10 *
JMF 0:2563b0415d1f 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
JMF 0:2563b0415d1f 12 *
JMF 0:2563b0415d1f 13 * Redistribution and use in source and binary forms, with or without modification,
JMF 0:2563b0415d1f 14 * are permitted provided that the following conditions are met:
JMF 0:2563b0415d1f 15 * 1. Redistributions of source code must retain the above copyright notice,
JMF 0:2563b0415d1f 16 * this list of conditions and the following disclaimer.
JMF 0:2563b0415d1f 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
JMF 0:2563b0415d1f 18 * this list of conditions and the following disclaimer in the documentation
JMF 0:2563b0415d1f 19 * and/or other materials provided with the distribution.
JMF 0:2563b0415d1f 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
JMF 0:2563b0415d1f 21 * may be used to endorse or promote products derived from this software
JMF 0:2563b0415d1f 22 * without specific prior written permission.
JMF 0:2563b0415d1f 23 *
JMF 0:2563b0415d1f 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
JMF 0:2563b0415d1f 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
JMF 0:2563b0415d1f 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
JMF 0:2563b0415d1f 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
JMF 0:2563b0415d1f 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
JMF 0:2563b0415d1f 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
JMF 0:2563b0415d1f 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
JMF 0:2563b0415d1f 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
JMF 0:2563b0415d1f 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
JMF 0:2563b0415d1f 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
JMF 0:2563b0415d1f 34 *
JMF 0:2563b0415d1f 35 ******************************************************************************
JMF 0:2563b0415d1f 36 */
JMF 0:2563b0415d1f 37
JMF 0:2563b0415d1f 38
JMF 0:2563b0415d1f 39 /* Define to prevent recursive inclusion -------------------------------------*/
JMF 0:2563b0415d1f 40 #ifndef __RADIO_SPI_H
JMF 0:2563b0415d1f 41 #define __RADIO_SPI_H
JMF 0:2563b0415d1f 42 #ifdef __cplusplus
JMF 0:2563b0415d1f 43 extern "C" {
JMF 0:2563b0415d1f 44 #endif
JMF 0:2563b0415d1f 45
JMF 0:2563b0415d1f 46 /* Includes ------------------------------------------------------------------*/
JMF 0:2563b0415d1f 47 #ifdef USE_STM32L1XX_NUCLEO
JMF 0:2563b0415d1f 48 // #include "stm32l1xx_hal.h"
JMF 0:2563b0415d1f 49 #endif
JMF 0:2563b0415d1f 50
JMF 0:2563b0415d1f 51 #ifdef USE_STM32F4XX_NUCLEO
JMF 0:2563b0415d1f 52 // #include "stm32f4xx_hal.h"
JMF 0:2563b0415d1f 53 #endif
JMF 0:2563b0415d1f 54 #include "SPIRIT_Config.h"
JMF 0:2563b0415d1f 55 #include "radio_spi.h"
JMF 0:2563b0415d1f 56 // #include "spirit1-arch.h"
JMF 0:2563b0415d1f 57
JMF 0:2563b0415d1f 58 /**
JMF 0:2563b0415d1f 59 * @addtogroup BSP
JMF 0:2563b0415d1f 60 * @{
JMF 0:2563b0415d1f 61 */
JMF 0:2563b0415d1f 62
JMF 0:2563b0415d1f 63 /* Exported types ------------------------------------------------------------*/
JMF 0:2563b0415d1f 64
JMF 0:2563b0415d1f 65
JMF 0:2563b0415d1f 66 /* Exported constants --------------------------------------------------------*/
JMF 0:2563b0415d1f 67
JMF 0:2563b0415d1f 68
JMF 0:2563b0415d1f 69 /* Exported macro ------------------------------------------------------------*/
JMF 0:2563b0415d1f 70 /* Define for SPIRIT1 board */
JMF 0:2563b0415d1f 71 #if !defined (USE_SPIRIT1_DEFAULT)
JMF 0:2563b0415d1f 72 #define USE_SPIRIT1_DEFAULT
JMF 0:2563b0415d1f 73 #endif
JMF 0:2563b0415d1f 74
JMF 0:2563b0415d1f 75 /* SPIRIT1_Spi_config */
JMF 0:2563b0415d1f 76 /* SPI1 */
JMF 0:2563b0415d1f 77 #define RADIO_SPI SPI1
JMF 0:2563b0415d1f 78 #define RADIO_SPI_CLK_ENABLE() __SPI1_CLK_ENABLE()
JMF 0:2563b0415d1f 79 #define RADIO_SPI_CLK_DISABLE() __SPI1_CLK_DISABLE()
JMF 0:2563b0415d1f 80
JMF 0:2563b0415d1f 81 #define RADIO_SPI_MISO_PORT GPIOA
JMF 0:2563b0415d1f 82 #define RADIO_SPI_MISO_PIN GPIO_PIN_6
JMF 0:2563b0415d1f 83 #define RADIO_SPI_MISO_CLOCK_ENABLE() __GPIOA_CLK_ENABLE()
JMF 0:2563b0415d1f 84 #define RADIO_SPI_MISO_CLOCK_DISABLE() __GPIOA_CLK_DISABLE()
JMF 0:2563b0415d1f 85
JMF 0:2563b0415d1f 86 #define RADIO_SPI_MOSI_PORT GPIOA
JMF 0:2563b0415d1f 87 #define RADIO_SPI_MOSI_PIN GPIO_PIN_7
JMF 0:2563b0415d1f 88 #define RADIO_SPI_MOSI_CLOCK_ENABLE() __GPIOA_CLK_ENABLE()
JMF 0:2563b0415d1f 89 #define RADIO_SPI_MOSI_CLOCK_DISABLE() __GPIOA_CLK_DISABLE()
JMF 0:2563b0415d1f 90
JMF 0:2563b0415d1f 91
JMF 0:2563b0415d1f 92
JMF 0:2563b0415d1f 93 #ifdef USE_SPIRIT1_DEFAULT
JMF 0:2563b0415d1f 94
JMF 0:2563b0415d1f 95 #define RADIO_SPI_SCK_PORT GPIOB
JMF 0:2563b0415d1f 96 #define RADIO_SPI_SCK_PIN GPIO_PIN_3
JMF 0:2563b0415d1f 97 #define RADIO_SPI_SCK_CLOCK_ENABLE() __GPIOB_CLK_ENABLE()
JMF 0:2563b0415d1f 98 #define RADIO_SPI_SCK_CLOCK_DISABLE() __GPIOB_CLK_DISABLE()
JMF 0:2563b0415d1f 99
JMF 0:2563b0415d1f 100
JMF 0:2563b0415d1f 101 #define RADIO_SPI_CS_PORT GPIOB
JMF 0:2563b0415d1f 102 #define RADIO_SPI_CS_PIN GPIO_PIN_6
JMF 0:2563b0415d1f 103 #define RADIO_SPI_CS_CLOCK_ENABLE() __GPIOB_CLK_ENABLE()
JMF 0:2563b0415d1f 104 #define RADIO_SPI_CS_CLOCK_DISABLE() __GPIOB_CLK_DISABLE()
JMF 0:2563b0415d1f 105
JMF 0:2563b0415d1f 106 #else
JMF 0:2563b0415d1f 107
JMF 0:2563b0415d1f 108 #define RADIO_SPI_SCK_PORT GPIOB
JMF 0:2563b0415d1f 109 #define RADIO_SPI_SCK_PIN GPIO_PIN_3
JMF 0:2563b0415d1f 110 #define RADIO_SPI_SCK_CLOCK_ENABLE() __GPIOB_CLK_ENABLE()
JMF 0:2563b0415d1f 111 #define RADIO_SPI_SCK_CLOCK_DISABLE() __GPIOB_CLK_DISABLE()
JMF 0:2563b0415d1f 112
JMF 0:2563b0415d1f 113
JMF 0:2563b0415d1f 114 #define RADIO_SPI_CS_PORT GPIOB
JMF 0:2563b0415d1f 115 #define RADIO_SPI_CS_PIN GPIO_PIN_6
JMF 0:2563b0415d1f 116 #define RADIO_SPI_CS_CLOCK_ENABLE() __GPIOB_CLK_ENABLE()
JMF 0:2563b0415d1f 117 #define RADIO_SPI_CS_CLOCK_DISABLE() __GPIOB_CLK_DISABLE()
JMF 0:2563b0415d1f 118
JMF 0:2563b0415d1f 119 #endif
JMF 0:2563b0415d1f 120
JMF 0:2563b0415d1f 121 /* Maximum Timeout values for flags waiting loops. These timeouts are not based
JMF 0:2563b0415d1f 122 on accurate values, they just guarantee that the application will not remain
JMF 0:2563b0415d1f 123 stuck if the SPI communication is corrupted.
JMF 0:2563b0415d1f 124 You may modify these timeout values depending on CPU frequency and application
JMF 0:2563b0415d1f 125 conditions (interrupts routines ...) */
JMF 0:2563b0415d1f 126 #define RADIO_SPI_TIMEOUT_MAX ((uint32_t)1000)
JMF 0:2563b0415d1f 127
JMF 0:2563b0415d1f 128 /* SPIRIT1_Spi_config_Private_Defines */
JMF 0:2563b0415d1f 129 #define CS_TO_SCLK_DELAY 0x0200//FIXME what is this doing?
JMF 0:2563b0415d1f 130 #define CLK_TO_CS_DELAY 0x0001
JMF 0:2563b0415d1f 131
JMF 0:2563b0415d1f 132 /* SPIRIT1_Spi_config_Headers */
JMF 0:2563b0415d1f 133 #define HEADER_WRITE_MASK 0x00 /*!< Write mask for header byte*/
JMF 0:2563b0415d1f 134 #define HEADER_READ_MASK 0x01 /*!< Read mask for header byte*/
JMF 0:2563b0415d1f 135 #define HEADER_ADDRESS_MASK 0x00 /*!< Address mask for header byte*/
JMF 0:2563b0415d1f 136 #define HEADER_COMMAND_MASK 0x80 /*!< Command mask for header byte*/
JMF 0:2563b0415d1f 137
JMF 0:2563b0415d1f 138 #define LINEAR_FIFO_ADDRESS 0xFF /*!< Linear FIFO address*/
JMF 0:2563b0415d1f 139
JMF 0:2563b0415d1f 140 /* SPIRIT1_Spi_config_Private_FunctionPrototypes */
JMF 0:2563b0415d1f 141 #define SPI_ENTER_CRITICAL() IRQ_DISABLE()
JMF 0:2563b0415d1f 142 #define SPI_EXIT_CRITICAL() IRQ_ENABLE()
JMF 0:2563b0415d1f 143
JMF 0:2563b0415d1f 144 /* SPIRIT1_Spi_config_Private_Functions */
JMF 0:2563b0415d1f 145 #define RadioSpiCSLow() HAL_GPIO_WritePin(RADIO_SPI_CS_PORT, RADIO_SPI_CS_PIN, GPIO_PIN_RESET)
JMF 0:2563b0415d1f 146 #define RadioSpiCSHigh() HAL_GPIO_WritePin(RADIO_SPI_CS_PORT, RADIO_SPI_CS_PIN, GPIO_PIN_SET)
JMF 0:2563b0415d1f 147
JMF 0:2563b0415d1f 148 /* SPIRIT1_Spi_config_Private_Macros */
JMF 0:2563b0415d1f 149 #define BUILT_HEADER(add_comm, w_r) (add_comm | w_r) /*!< macro to build the header byte*/
JMF 0:2563b0415d1f 150 #define WRITE_HEADER BUILT_HEADER(HEADER_ADDRESS_MASK, HEADER_WRITE_MASK) /*!< macro to build the write
JMF 0:2563b0415d1f 151 header byte*/
JMF 0:2563b0415d1f 152 #define READ_HEADER BUILT_HEADER(HEADER_ADDRESS_MASK, HEADER_READ_MASK) /*!< macro to build the read
JMF 0:2563b0415d1f 153 header byte*/
JMF 0:2563b0415d1f 154 #define COMMAND_HEADER BUILT_HEADER(HEADER_COMMAND_MASK, HEADER_WRITE_MASK) /*!< macro to build the command
JMF 0:2563b0415d1f 155 header byte*/
JMF 0:2563b0415d1f 156
JMF 0:2563b0415d1f 157
JMF 0:2563b0415d1f 158
JMF 0:2563b0415d1f 159 /* Exported Variables --------------------------------------------------------*/
JMF 0:2563b0415d1f 160
JMF 0:2563b0415d1f 161
JMF 0:2563b0415d1f 162 /* Exported functions ------------------------------------------------------- */
JMF 0:2563b0415d1f 163 void SdkEvalSpiInit(void);
JMF 0:2563b0415d1f 164 // void SpiCSGpioSetLevel(GPIO_PinState xState);
JMF 0:2563b0415d1f 165 StatusBytes SdkEvalSpiWriteRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
JMF 0:2563b0415d1f 166 StatusBytes SdkEvalSpiReadRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
JMF 0:2563b0415d1f 167 StatusBytes SdkEvalSpiCommandStrobes(uint8_t cCommandCode);
JMF 0:2563b0415d1f 168 StatusBytes SdkEvalSpiWriteFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
JMF 0:2563b0415d1f 169 StatusBytes SdkEvalSpiReadFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
JMF 0:2563b0415d1f 170
JMF 0:2563b0415d1f 171
JMF 0:2563b0415d1f 172 #ifdef __cplusplus
JMF 0:2563b0415d1f 173 }
JMF 0:2563b0415d1f 174 #endif
JMF 0:2563b0415d1f 175 #endif /*__RADIO_SPI_H */
JMF 0:2563b0415d1f 176
JMF 0:2563b0415d1f 177 /**
JMF 0:2563b0415d1f 178 * @}
JMF 0:2563b0415d1f 179 */
JMF 0:2563b0415d1f 180
JMF 0:2563b0415d1f 181 /**
JMF 0:2563b0415d1f 182 * @}
JMF 0:2563b0415d1f 183 */
JMF 0:2563b0415d1f 184
JMF 0:2563b0415d1f 185 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/