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