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