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_PktMbus.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_PktMbus.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 MBUS packets.
Wolfgang Betz 34:edda6a7238ec 8 *
Wolfgang Betz 34:edda6a7238ec 9 * @details
Wolfgang Betz 34:edda6a7238ec 10 *
Wolfgang Betz 34:edda6a7238ec 11 * This module can be used to manage the configuration of Spirit MBUS
Wolfgang Betz 34:edda6a7238ec 12 * packets.
Wolfgang Betz 34:edda6a7238ec 13 * The user can obtain a packet configuration filling the structure
Wolfgang Betz 34:edda6a7238ec 14 * <i>@ref PktMbusInit</i>, defining in it some general parameters
Wolfgang Betz 34:edda6a7238ec 15 * for the Spirit MBUS packet format.
Wolfgang Betz 34:edda6a7238ec 16 * Since the MBUS protocol is a standard, the configuration of a MBUS
Wolfgang Betz 34:edda6a7238ec 17 * packet is very simple to do.
Wolfgang Betz 34:edda6a7238ec 18 *
Wolfgang Betz 34:edda6a7238ec 19 * <b>Example:</b>
Wolfgang Betz 34:edda6a7238ec 20 * @code
Wolfgang Betz 34:edda6a7238ec 21 *
Wolfgang Betz 34:edda6a7238ec 22 * PktMbusInit mbusInit={
Wolfgang Betz 34:edda6a7238ec 23 * MBUS_SUBMODE_S1_S2_LONG_HEADER, // MBUS submode selection
Wolfgang Betz 34:edda6a7238ec 24 * 36, // added "01" chips on preamble
Wolfgang Betz 34:edda6a7238ec 25 * 16 // postamble length in "01" chips
Wolfgang Betz 34:edda6a7238ec 26 * };
Wolfgang Betz 34:edda6a7238ec 27 *
Wolfgang Betz 34:edda6a7238ec 28 * ...
Wolfgang Betz 34:edda6a7238ec 29 *
Wolfgang Betz 34:edda6a7238ec 30 * SpiritPktMbusInit(&mbusInit);
Wolfgang Betz 34:edda6a7238ec 31 *
Wolfgang Betz 34:edda6a7238ec 32 * ...
Wolfgang Betz 34:edda6a7238ec 33 *
Wolfgang Betz 34:edda6a7238ec 34 * @endcode
Wolfgang Betz 34:edda6a7238ec 35 *
Wolfgang Betz 34:edda6a7238ec 36 * The module provides some other functions that can be used to modify
Wolfgang Betz 34:edda6a7238ec 37 * or read only some configuration parameters.
Wolfgang Betz 34:edda6a7238ec 38 *
Wolfgang Betz 34:edda6a7238ec 39 *
Wolfgang Betz 34:edda6a7238ec 40 * @attention
Wolfgang Betz 34:edda6a7238ec 41 *
Wolfgang Betz 34:edda6a7238ec 42 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 34:edda6a7238ec 43 *
Wolfgang Betz 34:edda6a7238ec 44 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 34:edda6a7238ec 45 * are permitted provided that the following conditions are met:
Wolfgang Betz 34:edda6a7238ec 46 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 34:edda6a7238ec 47 * this list of conditions and the following disclaimer.
Wolfgang Betz 34:edda6a7238ec 48 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 34:edda6a7238ec 49 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 34:edda6a7238ec 50 * and/or other materials provided with the distribution.
Wolfgang Betz 34:edda6a7238ec 51 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 34:edda6a7238ec 52 * may be used to endorse or promote products derived from this software
Wolfgang Betz 34:edda6a7238ec 53 * without specific prior written permission.
Wolfgang Betz 34:edda6a7238ec 54 *
Wolfgang Betz 34:edda6a7238ec 55 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 34:edda6a7238ec 56 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 34:edda6a7238ec 57 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 34:edda6a7238ec 58 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 34:edda6a7238ec 59 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 34:edda6a7238ec 60 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 34:edda6a7238ec 61 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 34:edda6a7238ec 62 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 34:edda6a7238ec 63 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 34:edda6a7238ec 64 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 34:edda6a7238ec 65 *
Wolfgang Betz 34:edda6a7238ec 66 ******************************************************************************
Wolfgang Betz 34:edda6a7238ec 67 */
Wolfgang Betz 34:edda6a7238ec 68
Wolfgang Betz 34:edda6a7238ec 69 /* Define to prevent recursive inclusion -------------------------------------*/
Wolfgang Betz 34:edda6a7238ec 70 #ifndef __SPIRIT_PACKET_MBUS_H
Wolfgang Betz 34:edda6a7238ec 71 #define __SPIRIT_PACKET_MBUS_H
Wolfgang Betz 34:edda6a7238ec 72
Wolfgang Betz 34:edda6a7238ec 73
Wolfgang Betz 34:edda6a7238ec 74
Wolfgang Betz 34:edda6a7238ec 75 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 34:edda6a7238ec 76
Wolfgang Betz 34:edda6a7238ec 77 #include "SPIRIT_Regs.h"
Wolfgang Betz 34:edda6a7238ec 78 #include "SPIRIT_Types.h"
Wolfgang Betz 34:edda6a7238ec 79 #include "SPIRIT_PktCommon.h"
Wolfgang Betz 34:edda6a7238ec 80
Wolfgang Betz 34:edda6a7238ec 81 #ifdef __cplusplus
Wolfgang Betz 34:edda6a7238ec 82 extern "C" {
Wolfgang Betz 34:edda6a7238ec 83 #endif
Wolfgang Betz 34:edda6a7238ec 84
Wolfgang Betz 34:edda6a7238ec 85
Wolfgang Betz 34:edda6a7238ec 86
Wolfgang Betz 34:edda6a7238ec 87 /**
Wolfgang Betz 34:edda6a7238ec 88 * @addtogroup SPIRIT_Libraries
Wolfgang Betz 34:edda6a7238ec 89 * @{
Wolfgang Betz 34:edda6a7238ec 90 */
Wolfgang Betz 34:edda6a7238ec 91
Wolfgang Betz 34:edda6a7238ec 92
Wolfgang Betz 34:edda6a7238ec 93 /**
Wolfgang Betz 34:edda6a7238ec 94 * @defgroup SPIRIT_PktMbus Pkt MBUS
Wolfgang Betz 34:edda6a7238ec 95 * @brief Configuration and management of SPIRIT MBUS packets.
Wolfgang Betz 34:edda6a7238ec 96 * @details See the file <i>@ref SPIRIT_PktMbus.h</i> for more details.
Wolfgang Betz 34:edda6a7238ec 97 * @{
Wolfgang Betz 34:edda6a7238ec 98 */
Wolfgang Betz 34:edda6a7238ec 99
Wolfgang Betz 34:edda6a7238ec 100 /**
Wolfgang Betz 34:edda6a7238ec 101 * @defgroup PktMbus_Exported_Types Pkt MBUS Exported Types
Wolfgang Betz 34:edda6a7238ec 102 * @{
Wolfgang Betz 34:edda6a7238ec 103 */
Wolfgang Betz 34:edda6a7238ec 104
Wolfgang Betz 34:edda6a7238ec 105
Wolfgang Betz 34:edda6a7238ec 106
Wolfgang Betz 34:edda6a7238ec 107 /**
Wolfgang Betz 34:edda6a7238ec 108 * @brief MBUS submode enumeration.
Wolfgang Betz 34:edda6a7238ec 109 */
Wolfgang Betz 34:edda6a7238ec 110
Wolfgang Betz 34:edda6a7238ec 111 typedef enum
Wolfgang Betz 34:edda6a7238ec 112 {
Wolfgang Betz 34:edda6a7238ec 113 MBUS_SUBMODE_S1_S2_LONG_HEADER = MBUS_CTRL_MBUS_SUBMODE_S1_S2L, /*!< MBUS submode S1, S2 (long header) - Header length = mbus_prmbl_ctrl + 279 (in "01" bit pairs) , Sync word = 0x7696 (length 18 bits) */
Wolfgang Betz 34:edda6a7238ec 114 MBUS_SUBMODE_S1_M_S2_T2_OTHER_TO_METER = MBUS_CTRL_MBUS_SUBMODE_S2_S1M_T2_OTHER, /*!< MBUS submode S1-m, S2, T2 (other to meter) - Header length = mbus_prmbl_ctrl + 15 (in "01" bit pairs) , Sync word = 0x7696 (length 18 bits)*/
Wolfgang Betz 34:edda6a7238ec 115 MBUS_SUBMODE_T1_T2_METER_TO_OTHER = MBUS_CTRL_MBUS_SUBMODE_T1_T2_METER, /*!< MBUS submode T1, T2 (meter to other) - Header length = mbus_prmbl_ctrl + 19 (in "01" bit pairs) , Sync word = 0x3D (length 10 bits)*/
Wolfgang Betz 34:edda6a7238ec 116 MBUS_SUBMODE_R2_SHORT_HEADER = MBUS_CTRL_MBUS_SUBMODE_R2, /*!< MBUS submode R2, short header - Header length = mbus_prmbl_ctrl + 39 (in "01" bit pairs) , Sync word = 0x7696 (length 18 bits)*/
Wolfgang Betz 34:edda6a7238ec 117
Wolfgang Betz 34:edda6a7238ec 118 }MbusSubmode;
Wolfgang Betz 34:edda6a7238ec 119
Wolfgang Betz 34:edda6a7238ec 120 #define IS_MBUS_SUBMODE(MODE) (((MODE) == MBUS_SUBMODE_S1_S2_LONG_HEADER) || \
Wolfgang Betz 34:edda6a7238ec 121 ((MODE) == MBUS_SUBMODE_S1_M_S2_T2_OTHER_TO_METER) || \
Wolfgang Betz 34:edda6a7238ec 122 ((MODE) == MBUS_SUBMODE_T1_T2_METER_TO_OTHER) || \
Wolfgang Betz 34:edda6a7238ec 123 ((MODE) == MBUS_SUBMODE_R2_SHORT_HEADER))
Wolfgang Betz 34:edda6a7238ec 124
Wolfgang Betz 34:edda6a7238ec 125
Wolfgang Betz 34:edda6a7238ec 126 /**
Wolfgang Betz 34:edda6a7238ec 127 * @brief SPIRIT MBUS Packet Init structure definition
Wolfgang Betz 34:edda6a7238ec 128 */
Wolfgang Betz 34:edda6a7238ec 129 typedef struct
Wolfgang Betz 34:edda6a7238ec 130 {
Wolfgang Betz 34:edda6a7238ec 131 MbusSubmode xMbusSubmode; /*!< Specifies the SUBMODE to be configured.
Wolfgang Betz 34:edda6a7238ec 132 This parameter can be a value of @ref MbusSubmode */
Wolfgang Betz 34:edda6a7238ec 133
Wolfgang Betz 34:edda6a7238ec 134 uint8_t cPreambleLength; /*!< Specifies the PREAMBLE length.
Wolfgang Betz 34:edda6a7238ec 135 This parameter can be any value between 0 and 255 chip sequence '01' */
Wolfgang Betz 34:edda6a7238ec 136
Wolfgang Betz 34:edda6a7238ec 137 uint8_t cPostambleLength; /*!< Specifies the POSTAMBLE length.
Wolfgang Betz 34:edda6a7238ec 138 This parameter can be any value between 0 and 255 chip sequence '01' */
Wolfgang Betz 34:edda6a7238ec 139
Wolfgang Betz 34:edda6a7238ec 140 }PktMbusInit;
Wolfgang Betz 34:edda6a7238ec 141
Wolfgang Betz 34:edda6a7238ec 142 /**
Wolfgang Betz 34:edda6a7238ec 143 *@}
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 * @defgroup PktMbus_Exported_Constants Pkt MBUS Exported Constants
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 * @defgroup PktMbus_Exported_Macros Pkt MBUS Exported Macros
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 */
Wolfgang Betz 34:edda6a7238ec 167
Wolfgang Betz 34:edda6a7238ec 168
Wolfgang Betz 34:edda6a7238ec 169 /**
Wolfgang Betz 34:edda6a7238ec 170 * @defgroup PktMbus_Exported_Functions Pkt MBUS Exported Functions
Wolfgang Betz 34:edda6a7238ec 171 * @{
Wolfgang Betz 34:edda6a7238ec 172 */
Wolfgang Betz 34:edda6a7238ec 173 void SpiritPktMbusInit(PktMbusInit* pxPktMbusInit);
Wolfgang Betz 34:edda6a7238ec 174 void SpiritPktMbusGetInfo(PktMbusInit* pxPktMbusInit);
Wolfgang Betz 34:edda6a7238ec 175 void SpiritPktMbusSetFormat(void);
Wolfgang Betz 34:edda6a7238ec 176 void SpiritPktMbusSetPreamble(uint8_t cPreamble);
Wolfgang Betz 34:edda6a7238ec 177 uint8_t SpiritPktMbusGetPreamble(void);
Wolfgang Betz 34:edda6a7238ec 178 void SpiritPktMbusSetPostamble(uint8_t cPostamble);
Wolfgang Betz 34:edda6a7238ec 179 uint8_t SpiritPktMbusGetPostamble(void);
Wolfgang Betz 34:edda6a7238ec 180 void SpiritPktMbusSetSubmode(MbusSubmode xMbusSubmode);
Wolfgang Betz 34:edda6a7238ec 181 MbusSubmode SpiritPktMbusGetSubmode(void);
Wolfgang Betz 34:edda6a7238ec 182 void SpiritPktMbusSetPayloadLength(uint16_t nPayloadLength);
Wolfgang Betz 34:edda6a7238ec 183 uint16_t SpiritPktMbusGetPayloadLength(void);
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
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
Wolfgang Betz 34:edda6a7238ec 195 /**
Wolfgang Betz 34:edda6a7238ec 196 *@}
Wolfgang Betz 34:edda6a7238ec 197 */
Wolfgang Betz 34:edda6a7238ec 198
Wolfgang Betz 34:edda6a7238ec 199
Wolfgang Betz 34:edda6a7238ec 200 #ifdef __cplusplus
Wolfgang Betz 34:edda6a7238ec 201 }
Wolfgang Betz 34:edda6a7238ec 202 #endif
Wolfgang Betz 34:edda6a7238ec 203
Wolfgang Betz 34:edda6a7238ec 204 #endif
Wolfgang Betz 34:edda6a7238ec 205
Wolfgang Betz 34:edda6a7238ec 206 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/