ST / stm-spirit1-rf-driver

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

source/libs/spirit1/SPIRIT1_Library/Inc/SPIRIT_DirectRF.h@67:93bec0baf1de, 2017-07-06 (annotated)

Committer:
Wolfgang Betz
Date:
Thu Jul 06 11:13:31 2017 +0200
Revision:
67:93bec0baf1de
Parent:
34:edda6a7238ec 
Clarify some comments

Who changed what in which revision?

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