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_General.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_General.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 General functionalities.
Wolfgang Betz 34:edda6a7238ec 8 * @details
Wolfgang Betz 34:edda6a7238ec 9 *
Wolfgang Betz 34:edda6a7238ec 10 * @attention
Wolfgang Betz 34:edda6a7238ec 11 *
Wolfgang Betz 34:edda6a7238ec 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 34:edda6a7238ec 13 *
Wolfgang Betz 34:edda6a7238ec 14 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 34:edda6a7238ec 15 * are permitted provided that the following conditions are met:
Wolfgang Betz 34:edda6a7238ec 16 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 34:edda6a7238ec 17 * this list of conditions and the following disclaimer.
Wolfgang Betz 34:edda6a7238ec 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 34:edda6a7238ec 19 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 34:edda6a7238ec 20 * and/or other materials provided with the distribution.
Wolfgang Betz 34:edda6a7238ec 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 34:edda6a7238ec 22 * may be used to endorse or promote products derived from this software
Wolfgang Betz 34:edda6a7238ec 23 * without specific prior written permission.
Wolfgang Betz 34:edda6a7238ec 24 *
Wolfgang Betz 34:edda6a7238ec 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 34:edda6a7238ec 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 34:edda6a7238ec 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 34:edda6a7238ec 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 34:edda6a7238ec 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 34:edda6a7238ec 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 34:edda6a7238ec 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 34:edda6a7238ec 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 34:edda6a7238ec 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 34:edda6a7238ec 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 34:edda6a7238ec 35 *
Wolfgang Betz 34:edda6a7238ec 36 ******************************************************************************
Wolfgang Betz 34:edda6a7238ec 37 */
Wolfgang Betz 34:edda6a7238ec 38
Wolfgang Betz 34:edda6a7238ec 39 /* Define to prevent recursive inclusion -------------------------------------*/
Wolfgang Betz 34:edda6a7238ec 40 #ifndef __SPIRIT_GENERAL_H
Wolfgang Betz 34:edda6a7238ec 41 #define __SPIRIT_GENERAL_H
Wolfgang Betz 34:edda6a7238ec 42
Wolfgang Betz 34:edda6a7238ec 43
Wolfgang Betz 34:edda6a7238ec 44 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 34:edda6a7238ec 45
Wolfgang Betz 34:edda6a7238ec 46 #include "SPIRIT_Regs.h"
Wolfgang Betz 34:edda6a7238ec 47 #include "SPIRIT_Types.h"
Wolfgang Betz 34:edda6a7238ec 48
Wolfgang Betz 34:edda6a7238ec 49
Wolfgang Betz 34:edda6a7238ec 50 #ifdef __cplusplus
Wolfgang Betz 34:edda6a7238ec 51 extern "C" {
Wolfgang Betz 34:edda6a7238ec 52 #endif
Wolfgang Betz 34:edda6a7238ec 53
Wolfgang Betz 34:edda6a7238ec 54 /**
Wolfgang Betz 34:edda6a7238ec 55 * @addtogroup SPIRIT_Libraries
Wolfgang Betz 34:edda6a7238ec 56 * @{
Wolfgang Betz 34:edda6a7238ec 57 */
Wolfgang Betz 34:edda6a7238ec 58
Wolfgang Betz 34:edda6a7238ec 59
Wolfgang Betz 34:edda6a7238ec 60 /**
Wolfgang Betz 34:edda6a7238ec 61 * @defgroup SPIRIT_General General
Wolfgang Betz 34:edda6a7238ec 62 * @brief Configuration and management of SPIRIT General functionalities.
Wolfgang Betz 34:edda6a7238ec 63 * @details See the file <i>@ref SPIRIT_General.h</i> for more details.
Wolfgang Betz 34:edda6a7238ec 64 * @{
Wolfgang Betz 34:edda6a7238ec 65 */
Wolfgang Betz 34:edda6a7238ec 66
Wolfgang Betz 34:edda6a7238ec 67 /**
Wolfgang Betz 34:edda6a7238ec 68 * @defgroup General_Exported_Types General Exported Types
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 /**
Wolfgang Betz 34:edda6a7238ec 74 * @brief SPIRIT ModeExtRef enumeration
Wolfgang Betz 34:edda6a7238ec 75 */
Wolfgang Betz 34:edda6a7238ec 76
Wolfgang Betz 34:edda6a7238ec 77 typedef enum
Wolfgang Betz 34:edda6a7238ec 78 {
Wolfgang Betz 34:edda6a7238ec 79 MODE_EXT_XO = 0,
Wolfgang Betz 34:edda6a7238ec 80 MODE_EXT_XIN = !MODE_EXT_XO
Wolfgang Betz 34:edda6a7238ec 81 } ModeExtRef;
Wolfgang Betz 34:edda6a7238ec 82
Wolfgang Betz 34:edda6a7238ec 83 #define IS_MODE_EXT(MODE) (MODE == MODE_EXT_XO || \
Wolfgang Betz 34:edda6a7238ec 84 MODE == MODE_EXT_XIN)
Wolfgang Betz 34:edda6a7238ec 85
Wolfgang Betz 34:edda6a7238ec 86
Wolfgang Betz 34:edda6a7238ec 87 /**
Wolfgang Betz 34:edda6a7238ec 88 * @brief SPIRIT BatteryLevel enumeration
Wolfgang Betz 34:edda6a7238ec 89 */
Wolfgang Betz 34:edda6a7238ec 90
Wolfgang Betz 34:edda6a7238ec 91 typedef enum
Wolfgang Betz 34:edda6a7238ec 92 {
Wolfgang Betz 34:edda6a7238ec 93 BLD_LVL_2_7_V = 0,
Wolfgang Betz 34:edda6a7238ec 94 BLD_LVL_2_5_V = 1,
Wolfgang Betz 34:edda6a7238ec 95 BLD_LVL_2_3_V = 2,
Wolfgang Betz 34:edda6a7238ec 96 BLD_LVL_2_1_V = 3
Wolfgang Betz 34:edda6a7238ec 97 } BatteryLevel;
Wolfgang Betz 34:edda6a7238ec 98
Wolfgang Betz 34:edda6a7238ec 99 #define IS_BLD_LVL(MODE) (MODE == BLD_LVL_2_7_V || \
Wolfgang Betz 34:edda6a7238ec 100 MODE == BLD_LVL_2_5_V || \
Wolfgang Betz 34:edda6a7238ec 101 MODE == BLD_LVL_2_3_V || \
Wolfgang Betz 34:edda6a7238ec 102 MODE == BLD_LVL_2_1_V)
Wolfgang Betz 34:edda6a7238ec 103
Wolfgang Betz 34:edda6a7238ec 104
Wolfgang Betz 34:edda6a7238ec 105 /**
Wolfgang Betz 34:edda6a7238ec 106 * @brief SPIRIT GmConf enumeration
Wolfgang Betz 34:edda6a7238ec 107 */
Wolfgang Betz 34:edda6a7238ec 108
Wolfgang Betz 34:edda6a7238ec 109 typedef enum
Wolfgang Betz 34:edda6a7238ec 110 {
Wolfgang Betz 34:edda6a7238ec 111 GM_SU_13_2 = 0,
Wolfgang Betz 34:edda6a7238ec 112 GM_SU_18_2,
Wolfgang Betz 34:edda6a7238ec 113 GM_SU_21_5,
Wolfgang Betz 34:edda6a7238ec 114 GM_SU_25_6,
Wolfgang Betz 34:edda6a7238ec 115 GM_SU_28_8,
Wolfgang Betz 34:edda6a7238ec 116 GM_SU_33_9,
Wolfgang Betz 34:edda6a7238ec 117 GM_SU_38_5,
Wolfgang Betz 34:edda6a7238ec 118 GM_SU_43_0
Wolfgang Betz 34:edda6a7238ec 119 } GmConf;
Wolfgang Betz 34:edda6a7238ec 120
Wolfgang Betz 34:edda6a7238ec 121 #define IS_GM_CONF(MODE) (MODE == GM_SU_13_2 || \
Wolfgang Betz 34:edda6a7238ec 122 MODE == GM_SU_18_2 || \
Wolfgang Betz 34:edda6a7238ec 123 MODE == GM_SU_21_5 || \
Wolfgang Betz 34:edda6a7238ec 124 MODE == GM_SU_25_6 || \
Wolfgang Betz 34:edda6a7238ec 125 MODE == GM_SU_28_8 || \
Wolfgang Betz 34:edda6a7238ec 126 MODE == GM_SU_33_9 || \
Wolfgang Betz 34:edda6a7238ec 127 MODE == GM_SU_38_5 || \
Wolfgang Betz 34:edda6a7238ec 128 MODE == GM_SU_43_0)
Wolfgang Betz 34:edda6a7238ec 129
Wolfgang Betz 34:edda6a7238ec 130
Wolfgang Betz 34:edda6a7238ec 131 /**
Wolfgang Betz 34:edda6a7238ec 132 * @brief SPIRIT packet type enumeration
Wolfgang Betz 34:edda6a7238ec 133 */
Wolfgang Betz 34:edda6a7238ec 134
Wolfgang Betz 34:edda6a7238ec 135 typedef enum
Wolfgang Betz 34:edda6a7238ec 136 {
Wolfgang Betz 34:edda6a7238ec 137 PKT_BASIC = 0x00,
Wolfgang Betz 34:edda6a7238ec 138 PKT_MBUS = 0x02,
Wolfgang Betz 34:edda6a7238ec 139 PKT_STACK
Wolfgang Betz 34:edda6a7238ec 140
Wolfgang Betz 34:edda6a7238ec 141 } PacketType;
Wolfgang Betz 34:edda6a7238ec 142
Wolfgang Betz 34:edda6a7238ec 143 #define IS_PKT_TYPE(TYPE) (TYPE == PKT_BASIC || \
Wolfgang Betz 34:edda6a7238ec 144 TYPE == PKT_MBUS || \
Wolfgang Betz 34:edda6a7238ec 145 TYPE == PKT_STACK || \
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 * @brief SPIRIT version type enumeration
Wolfgang Betz 34:edda6a7238ec 151 */
Wolfgang Betz 34:edda6a7238ec 152
Wolfgang Betz 34:edda6a7238ec 153 typedef enum
Wolfgang Betz 34:edda6a7238ec 154 {
Wolfgang Betz 34:edda6a7238ec 155 SPIRIT_VERSION_2_1 = 0x01, /* Deprecated */
Wolfgang Betz 34:edda6a7238ec 156 SPIRIT_VERSION_3_0, /* The only version of SPIRIT1 */
Wolfgang Betz 34:edda6a7238ec 157 } SpiritVersion;
Wolfgang Betz 34:edda6a7238ec 158
Wolfgang Betz 34:edda6a7238ec 159
Wolfgang Betz 34:edda6a7238ec 160 /**
Wolfgang Betz 34:edda6a7238ec 161 * @}
Wolfgang Betz 34:edda6a7238ec 162 */
Wolfgang Betz 34:edda6a7238ec 163
Wolfgang Betz 34:edda6a7238ec 164
Wolfgang Betz 34:edda6a7238ec 165 /**
Wolfgang Betz 34:edda6a7238ec 166 * @defgroup General_Exported_Constants General Exported Constants
Wolfgang Betz 34:edda6a7238ec 167 * @{
Wolfgang Betz 34:edda6a7238ec 168 */
Wolfgang Betz 34:edda6a7238ec 169
Wolfgang Betz 34:edda6a7238ec 170
Wolfgang Betz 34:edda6a7238ec 171 /**
Wolfgang Betz 34:edda6a7238ec 172 * @}
Wolfgang Betz 34:edda6a7238ec 173 */
Wolfgang Betz 34:edda6a7238ec 174
Wolfgang Betz 34:edda6a7238ec 175
Wolfgang Betz 34:edda6a7238ec 176 /**
Wolfgang Betz 34:edda6a7238ec 177 * @defgroup General_Exported_Macros General Exported Macros
Wolfgang Betz 34:edda6a7238ec 178 * @{
Wolfgang Betz 34:edda6a7238ec 179 */
Wolfgang Betz 34:edda6a7238ec 180 #define SpiritGeneralLibraryVersion() "Spirit1_Libraries_v.3.2.0"
Wolfgang Betz 34:edda6a7238ec 181
Wolfgang Betz 34:edda6a7238ec 182
Wolfgang Betz 34:edda6a7238ec 183 /**
Wolfgang Betz 34:edda6a7238ec 184 * @}
Wolfgang Betz 34:edda6a7238ec 185 */
Wolfgang Betz 34:edda6a7238ec 186
Wolfgang Betz 34:edda6a7238ec 187
Wolfgang Betz 34:edda6a7238ec 188 /**
Wolfgang Betz 34:edda6a7238ec 189 * @defgroup General_Exported_Functions General Exported Functions
Wolfgang Betz 34:edda6a7238ec 190 * @{
Wolfgang Betz 34:edda6a7238ec 191 */
Wolfgang Betz 34:edda6a7238ec 192
Wolfgang Betz 34:edda6a7238ec 193
Wolfgang Betz 34:edda6a7238ec 194 void SpiritGeneralBatteryLevel(SpiritFunctionalState xNewState);
Wolfgang Betz 34:edda6a7238ec 195 void SpiritGeneralSetBatteryLevel(BatteryLevel xBatteryLevel);
Wolfgang Betz 34:edda6a7238ec 196 BatteryLevel SpiritGeneralGetBatteryLevel(void);
Wolfgang Betz 34:edda6a7238ec 197 void SpiritGeneralBrownOut(SpiritFunctionalState xNewState);
Wolfgang Betz 34:edda6a7238ec 198 void SpiritGeneralHighPwr(SpiritFunctionalState xNewState);
Wolfgang Betz 34:edda6a7238ec 199 void SpiritGeneralSetExtRef(ModeExtRef xExtMode);
Wolfgang Betz 34:edda6a7238ec 200 ModeExtRef SpiritGeneralGetExtRef(void);
Wolfgang Betz 34:edda6a7238ec 201 void SpiritGeneralSetXoGm(GmConf xGm);
Wolfgang Betz 34:edda6a7238ec 202 GmConf SpiritGeneralGetXoGm(void);
Wolfgang Betz 34:edda6a7238ec 203 PacketType SpiritGeneralGetPktType(void);
Wolfgang Betz 34:edda6a7238ec 204 uint16_t SpiritGeneralGetDevicePartNumber(void);
Wolfgang Betz 34:edda6a7238ec 205 uint8_t SpiritGeneralGetSpiritVersion(void);
Wolfgang Betz 34:edda6a7238ec 206
Wolfgang Betz 34:edda6a7238ec 207 /**
Wolfgang Betz 34:edda6a7238ec 208 * @}
Wolfgang Betz 34:edda6a7238ec 209 */
Wolfgang Betz 34:edda6a7238ec 210
Wolfgang Betz 34:edda6a7238ec 211 /**
Wolfgang Betz 34:edda6a7238ec 212 * @}
Wolfgang Betz 34:edda6a7238ec 213 */
Wolfgang Betz 34:edda6a7238ec 214
Wolfgang Betz 34:edda6a7238ec 215
Wolfgang Betz 34:edda6a7238ec 216 /**
Wolfgang Betz 34:edda6a7238ec 217 * @}
Wolfgang Betz 34:edda6a7238ec 218 */
Wolfgang Betz 34:edda6a7238ec 219
Wolfgang Betz 34:edda6a7238ec 220
Wolfgang Betz 34:edda6a7238ec 221 #ifdef __cplusplus
Wolfgang Betz 34:edda6a7238ec 222 }
Wolfgang Betz 34:edda6a7238ec 223 #endif
Wolfgang Betz 34:edda6a7238ec 224
Wolfgang Betz 34:edda6a7238ec 225 #endif
Wolfgang Betz 34:edda6a7238ec 226
Wolfgang Betz 34:edda6a7238ec 227 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/