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