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).

source/libs/spirit1/SPIRIT1_Library/Inc/SPIRIT_DirectRF.h@34:edda6a7238ec, 2016-11-22 (annotated)

Committer:
Wolfgang Betz
Date:
Tue Nov 22 11:40:10 2016 +0100
Revision:
34:edda6a7238ec
Child:
67:93bec0baf1de
Perform re-naming

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 34:edda6a7238ec 1 /**
Wolfgang Betz 34:edda6a7238ec 2 ******************************************************************************
Wolfgang Betz 34:edda6a7238ec 3 * @file SPIRIT_DirectRF.h
Wolfgang Betz 34:edda6a7238ec 4 * @author VMA division - AMS
Wolfgang Betz 34:edda6a7238ec 5 * @version 3.2.2
Wolfgang Betz 34:edda6a7238ec 6 * @date 08-July-2015
Wolfgang Betz 34:edda6a7238ec 7 * @brief Configuration and management of SPIRIT direct transmission / receive modes.
Wolfgang Betz 34:edda6a7238ec 8 * @details
Wolfgang Betz 34:edda6a7238ec 9 *
Wolfgang Betz 34:edda6a7238ec 10 * This module contains functions to manage the direct Tx/Rx mode.
Wolfgang Betz 34:edda6a7238ec 11 * The user can choose the way to send data to Spirit through the
Wolfgang Betz 34:edda6a7238ec 12 * enumerative types <i>@ref DirectTx</i>/<i>@ref DirectRx</i>.
Wolfgang Betz 34:edda6a7238ec 13 *
Wolfgang Betz 34:edda6a7238ec 14 * @attention
Wolfgang Betz 34:edda6a7238ec 15 *
Wolfgang Betz 34:edda6a7238ec 16 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 34:edda6a7238ec 17 *
Wolfgang Betz 34:edda6a7238ec 18 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 34:edda6a7238ec 19 * are permitted provided that the following conditions are met:
Wolfgang Betz 34:edda6a7238ec 20 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 34:edda6a7238ec 21 * this list of conditions and the following disclaimer.
Wolfgang Betz 34:edda6a7238ec 22 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 34:edda6a7238ec 23 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 34:edda6a7238ec 24 * and/or other materials provided with the distribution.
Wolfgang Betz 34:edda6a7238ec 25 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 34:edda6a7238ec 26 * may be used to endorse or promote products derived from this software
Wolfgang Betz 34:edda6a7238ec 27 * without specific prior written permission.
Wolfgang Betz 34:edda6a7238ec 28 *
Wolfgang Betz 34:edda6a7238ec 29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 34:edda6a7238ec 30 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 34:edda6a7238ec 31 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 34:edda6a7238ec 32 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 34:edda6a7238ec 33 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 34:edda6a7238ec 34 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 34:edda6a7238ec 35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 34:edda6a7238ec 36 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 34:edda6a7238ec 37 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 34:edda6a7238ec 38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 34:edda6a7238ec 39 *
Wolfgang Betz 34:edda6a7238ec 40 ******************************************************************************
Wolfgang Betz 34:edda6a7238ec 41 */
Wolfgang Betz 34:edda6a7238ec 42
Wolfgang Betz 34:edda6a7238ec 43 /* Define to prevent recursive inclusion -------------------------------------*/
Wolfgang Betz 34:edda6a7238ec 44 #ifndef __SPIRIT1_DIRECT_RF_H
Wolfgang Betz 34:edda6a7238ec 45 #define __SPIRIT1_DIRECT_RF_H
Wolfgang Betz 34:edda6a7238ec 46
Wolfgang Betz 34:edda6a7238ec 47 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 34:edda6a7238ec 48
Wolfgang Betz 34:edda6a7238ec 49 #include "SPIRIT_Regs.h"
Wolfgang Betz 34:edda6a7238ec 50 #include "SPIRIT_Types.h"
Wolfgang Betz 34:edda6a7238ec 51
Wolfgang Betz 34:edda6a7238ec 52
Wolfgang Betz 34:edda6a7238ec 53
Wolfgang Betz 34:edda6a7238ec 54 #ifdef __cplusplus
Wolfgang Betz 34:edda6a7238ec 55 extern "C" {
Wolfgang Betz 34:edda6a7238ec 56 #endif
Wolfgang Betz 34:edda6a7238ec 57
Wolfgang Betz 34:edda6a7238ec 58
Wolfgang Betz 34:edda6a7238ec 59 /**
Wolfgang Betz 34:edda6a7238ec 60 * @addtogroup SPIRIT_Libraries
Wolfgang Betz 34:edda6a7238ec 61 * @{
Wolfgang Betz 34:edda6a7238ec 62 */
Wolfgang Betz 34:edda6a7238ec 63
Wolfgang Betz 34:edda6a7238ec 64
Wolfgang Betz 34:edda6a7238ec 65 /**
Wolfgang Betz 34:edda6a7238ec 66 * @defgroup SPIRIT_DirectRf Direct RF
Wolfgang Betz 34:edda6a7238ec 67 * @brief Configuration and management of SPIRIT direct transmission / receive modes.
Wolfgang Betz 34:edda6a7238ec 68 * @details See the file <i>@ref SPIRIT_DirectRF.h</i> for more details.
Wolfgang Betz 34:edda6a7238ec 69 * @{
Wolfgang Betz 34:edda6a7238ec 70 */
Wolfgang Betz 34:edda6a7238ec 71
Wolfgang Betz 34:edda6a7238ec 72 /**
Wolfgang Betz 34:edda6a7238ec 73 * @defgroup DirectRf_Exported_Types Direct RF Exported Types
Wolfgang Betz 34:edda6a7238ec 74 * @{
Wolfgang Betz 34:edda6a7238ec 75 */
Wolfgang Betz 34:edda6a7238ec 76
Wolfgang Betz 34:edda6a7238ec 77 /**
Wolfgang Betz 34:edda6a7238ec 78 * @brief Direct transmission mode enumeration for SPIRIT.
Wolfgang Betz 34:edda6a7238ec 79 */
Wolfgang Betz 34:edda6a7238ec 80 typedef enum
Wolfgang Betz 34:edda6a7238ec 81 {
Wolfgang Betz 34:edda6a7238ec 82 NORMAL_TX_MODE = 0x00, /*!< Normal mode, no direct transmission is used */
Wolfgang Betz 34:edda6a7238ec 83 DIRECT_TX_FIFO_MODE = 0x04, /*!< Source is FIFO: payload bits are continuously read from the TX FIFO */
Wolfgang Betz 34:edda6a7238ec 84 DIRECT_TX_GPIO_MODE = 0x08, /*!< Source is GPIO: payload bits are continuously read from one of the GPIO ports and transmitted without any processing */
Wolfgang Betz 34:edda6a7238ec 85 PN9_TX_MODE = 0x0C /*!< A pseudorandom binary sequence is generated internally */
Wolfgang Betz 34:edda6a7238ec 86 }DirectTx;
Wolfgang Betz 34:edda6a7238ec 87
Wolfgang Betz 34:edda6a7238ec 88 #define IS_DIRECT_TX(MODE) (((MODE) == NORMAL_TX_MODE) || \
Wolfgang Betz 34:edda6a7238ec 89 ((MODE) == DIRECT_TX_FIFO_MODE) || \
Wolfgang Betz 34:edda6a7238ec 90 ((MODE) == DIRECT_TX_GPIO_MODE) || \
Wolfgang Betz 34:edda6a7238ec 91 ((MODE) == PN9_TX_MODE))
Wolfgang Betz 34:edda6a7238ec 92
Wolfgang Betz 34:edda6a7238ec 93 /**
Wolfgang Betz 34:edda6a7238ec 94 * @brief Direct receive mode enumeration for SPIRIT.
Wolfgang Betz 34:edda6a7238ec 95 */
Wolfgang Betz 34:edda6a7238ec 96 typedef enum
Wolfgang Betz 34:edda6a7238ec 97 {
Wolfgang Betz 34:edda6a7238ec 98 NORMAL_RX_MODE = 0x00, /*!< Normal mode, no direct reception is used */
Wolfgang Betz 34:edda6a7238ec 99 DIRECT_RX_FIFO_MODE = 0x10, /*!< Destination is FIFO: payload bits are continuously written to the RX FIFO and not subjected to any processing*/
Wolfgang Betz 34:edda6a7238ec 100 DIRECT_RX_GPIO_MODE = 0x20 /*!< Destination is GPIO: payload bits are continuously written to one of the GPIO ports and not subjected to any processing*/
Wolfgang Betz 34:edda6a7238ec 101 }DirectRx;
Wolfgang Betz 34:edda6a7238ec 102
Wolfgang Betz 34:edda6a7238ec 103 #define IS_DIRECT_RX(MODE) (((MODE) == NORMAL_RX_MODE) || \
Wolfgang Betz 34:edda6a7238ec 104 ((MODE) == DIRECT_RX_FIFO_MODE) || \
Wolfgang Betz 34:edda6a7238ec 105 ((MODE) == DIRECT_RX_GPIO_MODE))
Wolfgang Betz 34:edda6a7238ec 106
Wolfgang Betz 34:edda6a7238ec 107
Wolfgang Betz 34:edda6a7238ec 108 /**
Wolfgang Betz 34:edda6a7238ec 109 *@}
Wolfgang Betz 34:edda6a7238ec 110 */
Wolfgang Betz 34:edda6a7238ec 111
Wolfgang Betz 34:edda6a7238ec 112
Wolfgang Betz 34:edda6a7238ec 113 /**
Wolfgang Betz 34:edda6a7238ec 114 * @defgroup DirectRf_Exported_Constants Direct RF Exported Constants
Wolfgang Betz 34:edda6a7238ec 115 * @{
Wolfgang Betz 34:edda6a7238ec 116 */
Wolfgang Betz 34:edda6a7238ec 117
Wolfgang Betz 34:edda6a7238ec 118
Wolfgang Betz 34:edda6a7238ec 119 /**
Wolfgang Betz 34:edda6a7238ec 120 *@}
Wolfgang Betz 34:edda6a7238ec 121 */
Wolfgang Betz 34:edda6a7238ec 122
Wolfgang Betz 34:edda6a7238ec 123
Wolfgang Betz 34:edda6a7238ec 124 /**
Wolfgang Betz 34:edda6a7238ec 125 * @defgroup DirectRf_Exported_Macros Direct RF Exported Macros
Wolfgang Betz 34:edda6a7238ec 126 * @{
Wolfgang Betz 34:edda6a7238ec 127 */
Wolfgang Betz 34:edda6a7238ec 128
Wolfgang Betz 34:edda6a7238ec 129
Wolfgang Betz 34:edda6a7238ec 130 /**
Wolfgang Betz 34:edda6a7238ec 131 *@}
Wolfgang Betz 34:edda6a7238ec 132 */
Wolfgang Betz 34:edda6a7238ec 133
Wolfgang Betz 34:edda6a7238ec 134
Wolfgang Betz 34:edda6a7238ec 135 /**
Wolfgang Betz 34:edda6a7238ec 136 * @defgroup DirectRf_Exported_Functions Direct RF Exported Functions
Wolfgang Betz 34:edda6a7238ec 137 * @{
Wolfgang Betz 34:edda6a7238ec 138 */
Wolfgang Betz 34:edda6a7238ec 139
Wolfgang Betz 34:edda6a7238ec 140 void SpiritDirectRfSetRxMode(DirectRx xDirectRx);
Wolfgang Betz 34:edda6a7238ec 141 DirectRx SpiritDirectRfGetRxMode(void);
Wolfgang Betz 34:edda6a7238ec 142 void SpiritDirectRfSetTxMode(DirectTx xDirectTx);
Wolfgang Betz 34:edda6a7238ec 143 DirectTx SpiritDirectRfGetTxMode(void);
Wolfgang Betz 34:edda6a7238ec 144
Wolfgang Betz 34:edda6a7238ec 145 /**
Wolfgang Betz 34:edda6a7238ec 146 *@}
Wolfgang Betz 34:edda6a7238ec 147 */
Wolfgang Betz 34:edda6a7238ec 148
Wolfgang Betz 34:edda6a7238ec 149 /**
Wolfgang Betz 34:edda6a7238ec 150 *@}
Wolfgang Betz 34:edda6a7238ec 151 */
Wolfgang Betz 34:edda6a7238ec 152
Wolfgang Betz 34:edda6a7238ec 153
Wolfgang Betz 34:edda6a7238ec 154 /**
Wolfgang Betz 34:edda6a7238ec 155 *@}
Wolfgang Betz 34:edda6a7238ec 156 */
Wolfgang Betz 34:edda6a7238ec 157
Wolfgang Betz 34:edda6a7238ec 158
Wolfgang Betz 34:edda6a7238ec 159 #ifdef __cplusplus
Wolfgang Betz 34:edda6a7238ec 160 }
Wolfgang Betz 34:edda6a7238ec 161 #endif
Wolfgang Betz 34:edda6a7238ec 162
Wolfgang Betz 34:edda6a7238ec 163 #endif
Wolfgang Betz 34:edda6a7238ec 164
Wolfgang Betz 34:edda6a7238ec 165 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/