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

libs/spirit1/SPIRIT1_Library/Src/SPIRIT_Types.c@0:4fb29d9ee571, 2016-10-13 (annotated)

Committer:
Wolfgang Betz
Date:
Thu Oct 13 15:41:39 2016 +0200
Revision:
0:4fb29d9ee571
Child:
2:45642c5198a2
First compiling version (without warnings)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 0:4fb29d9ee571 1 /**
Wolfgang Betz 0:4fb29d9ee571 2 ******************************************************************************
Wolfgang Betz 0:4fb29d9ee571 3 * @file SPIRIT_Types.c
Wolfgang Betz 0:4fb29d9ee571 4 * @author VMA division - AMS
Wolfgang Betz 0:4fb29d9ee571 5 * @version 3.2.2
Wolfgang Betz 0:4fb29d9ee571 6 * @date 08-July-2015
Wolfgang Betz 0:4fb29d9ee571 7 * @brief File for SPIRIT types.
Wolfgang Betz 0:4fb29d9ee571 8 * @details
Wolfgang Betz 0:4fb29d9ee571 9 *
Wolfgang Betz 0:4fb29d9ee571 10 * @attention
Wolfgang Betz 0:4fb29d9ee571 11 *
Wolfgang Betz 0:4fb29d9ee571 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 0:4fb29d9ee571 13 *
Wolfgang Betz 0:4fb29d9ee571 14 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 0:4fb29d9ee571 15 * are permitted provided that the following conditions are met:
Wolfgang Betz 0:4fb29d9ee571 16 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 0:4fb29d9ee571 17 * this list of conditions and the following disclaimer.
Wolfgang Betz 0:4fb29d9ee571 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 0:4fb29d9ee571 19 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 0:4fb29d9ee571 20 * and/or other materials provided with the distribution.
Wolfgang Betz 0:4fb29d9ee571 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 0:4fb29d9ee571 22 * may be used to endorse or promote products derived from this software
Wolfgang Betz 0:4fb29d9ee571 23 * without specific prior written permission.
Wolfgang Betz 0:4fb29d9ee571 24 *
Wolfgang Betz 0:4fb29d9ee571 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 0:4fb29d9ee571 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 0:4fb29d9ee571 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 0:4fb29d9ee571 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 0:4fb29d9ee571 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 0:4fb29d9ee571 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 0:4fb29d9ee571 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 0:4fb29d9ee571 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 0:4fb29d9ee571 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 0:4fb29d9ee571 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 0:4fb29d9ee571 35 *
Wolfgang Betz 0:4fb29d9ee571 36 ******************************************************************************
Wolfgang Betz 0:4fb29d9ee571 37 */
Wolfgang Betz 0:4fb29d9ee571 38
Wolfgang Betz 0:4fb29d9ee571 39 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 0:4fb29d9ee571 40 #include "SPIRIT_Types.h"
Wolfgang Betz 0:4fb29d9ee571 41 #include "MCU_Interface.h"
Wolfgang Betz 0:4fb29d9ee571 42
Wolfgang Betz 0:4fb29d9ee571 43
Wolfgang Betz 0:4fb29d9ee571 44 /** @addtogroup SPIRIT_Libraries
Wolfgang Betz 0:4fb29d9ee571 45 * @{
Wolfgang Betz 0:4fb29d9ee571 46 */
Wolfgang Betz 0:4fb29d9ee571 47
Wolfgang Betz 0:4fb29d9ee571 48
Wolfgang Betz 0:4fb29d9ee571 49 /** @addtogroup SPIRIT_Types
Wolfgang Betz 0:4fb29d9ee571 50 * @{
Wolfgang Betz 0:4fb29d9ee571 51 */
Wolfgang Betz 0:4fb29d9ee571 52
Wolfgang Betz 0:4fb29d9ee571 53
Wolfgang Betz 0:4fb29d9ee571 54 /** @defgroup Types_Private_TypesDefinitions Types Private Types Definitions
Wolfgang Betz 0:4fb29d9ee571 55 * @{
Wolfgang Betz 0:4fb29d9ee571 56 */
Wolfgang Betz 0:4fb29d9ee571 57
Wolfgang Betz 0:4fb29d9ee571 58
Wolfgang Betz 0:4fb29d9ee571 59 /**
Wolfgang Betz 0:4fb29d9ee571 60 * @}
Wolfgang Betz 0:4fb29d9ee571 61 */
Wolfgang Betz 0:4fb29d9ee571 62
Wolfgang Betz 0:4fb29d9ee571 63
Wolfgang Betz 0:4fb29d9ee571 64
Wolfgang Betz 0:4fb29d9ee571 65 /** @defgroup Types_Private_Defines Types Private Defines
Wolfgang Betz 0:4fb29d9ee571 66 * @{
Wolfgang Betz 0:4fb29d9ee571 67 */
Wolfgang Betz 0:4fb29d9ee571 68
Wolfgang Betz 0:4fb29d9ee571 69
Wolfgang Betz 0:4fb29d9ee571 70 /**
Wolfgang Betz 0:4fb29d9ee571 71 * @}
Wolfgang Betz 0:4fb29d9ee571 72 */
Wolfgang Betz 0:4fb29d9ee571 73
Wolfgang Betz 0:4fb29d9ee571 74
Wolfgang Betz 0:4fb29d9ee571 75
Wolfgang Betz 0:4fb29d9ee571 76 /** @defgroup Types_Private_Macros Types Private Macros
Wolfgang Betz 0:4fb29d9ee571 77 * @{
Wolfgang Betz 0:4fb29d9ee571 78 */
Wolfgang Betz 0:4fb29d9ee571 79
Wolfgang Betz 0:4fb29d9ee571 80
Wolfgang Betz 0:4fb29d9ee571 81 /**
Wolfgang Betz 0:4fb29d9ee571 82 * @}
Wolfgang Betz 0:4fb29d9ee571 83 */
Wolfgang Betz 0:4fb29d9ee571 84
Wolfgang Betz 0:4fb29d9ee571 85
Wolfgang Betz 0:4fb29d9ee571 86
Wolfgang Betz 0:4fb29d9ee571 87 /** @defgroup Types_Private_Variables Types Private Variables
Wolfgang Betz 0:4fb29d9ee571 88 * @{
Wolfgang Betz 0:4fb29d9ee571 89 */
Wolfgang Betz 0:4fb29d9ee571 90
Wolfgang Betz 0:4fb29d9ee571 91 /**
Wolfgang Betz 0:4fb29d9ee571 92 * @brief Spirit Status global variable.
Wolfgang Betz 0:4fb29d9ee571 93 * This global variable of @ref SpiritStatus type is updated on every SPI transaction
Wolfgang Betz 0:4fb29d9ee571 94 * to maintain memory of Spirit Status.
Wolfgang Betz 0:4fb29d9ee571 95 */
Wolfgang Betz 0:4fb29d9ee571 96
Wolfgang Betz 0:4fb29d9ee571 97 volatile SpiritStatus g_xStatus;
Wolfgang Betz 0:4fb29d9ee571 98
Wolfgang Betz 0:4fb29d9ee571 99 /**
Wolfgang Betz 0:4fb29d9ee571 100 * @}
Wolfgang Betz 0:4fb29d9ee571 101 */
Wolfgang Betz 0:4fb29d9ee571 102
Wolfgang Betz 0:4fb29d9ee571 103
Wolfgang Betz 0:4fb29d9ee571 104
Wolfgang Betz 0:4fb29d9ee571 105 /** @defgroup Types_Private_FunctionPrototypes Types Private FunctionPrototypes
Wolfgang Betz 0:4fb29d9ee571 106 * @{
Wolfgang Betz 0:4fb29d9ee571 107 */
Wolfgang Betz 0:4fb29d9ee571 108
Wolfgang Betz 0:4fb29d9ee571 109
Wolfgang Betz 0:4fb29d9ee571 110
Wolfgang Betz 0:4fb29d9ee571 111 /**
Wolfgang Betz 0:4fb29d9ee571 112 * @}
Wolfgang Betz 0:4fb29d9ee571 113 */
Wolfgang Betz 0:4fb29d9ee571 114
Wolfgang Betz 0:4fb29d9ee571 115
Wolfgang Betz 0:4fb29d9ee571 116
Wolfgang Betz 0:4fb29d9ee571 117 /** @defgroup Types_Private_Functions Types Private Functions
Wolfgang Betz 0:4fb29d9ee571 118 * @{
Wolfgang Betz 0:4fb29d9ee571 119 */
Wolfgang Betz 0:4fb29d9ee571 120
Wolfgang Betz 0:4fb29d9ee571 121 #ifdef SPIRIT_USE_FULL_ASSERT
Wolfgang Betz 0:4fb29d9ee571 122 /**
Wolfgang Betz 0:4fb29d9ee571 123 * @brief Reports the name of the source file and the source line number
Wolfgang Betz 0:4fb29d9ee571 124 * where the assert_param error has occurred.
Wolfgang Betz 0:4fb29d9ee571 125 * @param file pointer to the source file name
Wolfgang Betz 0:4fb29d9ee571 126 * @param line assert_param error line source number
Wolfgang Betz 0:4fb29d9ee571 127 * @retval : None
Wolfgang Betz 0:4fb29d9ee571 128 */
Wolfgang Betz 0:4fb29d9ee571 129 void s_assert_failed(uint8_t* file, uint32_t line)
Wolfgang Betz 0:4fb29d9ee571 130 {
Wolfgang Betz 0:4fb29d9ee571 131 /* User can add his own implementation to report the file name and line number */
Wolfgang Betz 0:4fb29d9ee571 132 printf("Wrong parameters value: file %s on line %d\r\n", file, line);
Wolfgang Betz 0:4fb29d9ee571 133
Wolfgang Betz 0:4fb29d9ee571 134 /* Infinite loop */
Wolfgang Betz 0:4fb29d9ee571 135 while (1)
Wolfgang Betz 0:4fb29d9ee571 136 {
Wolfgang Betz 0:4fb29d9ee571 137 }
Wolfgang Betz 0:4fb29d9ee571 138 }
Wolfgang Betz 0:4fb29d9ee571 139 #elif SPIRIT_USE_VCOM_ASSERT
Wolfgang Betz 0:4fb29d9ee571 140
Wolfgang Betz 0:4fb29d9ee571 141 #include "SDK_EVAL_VC_General.h"
Wolfgang Betz 0:4fb29d9ee571 142
Wolfgang Betz 0:4fb29d9ee571 143 /**
Wolfgang Betz 0:4fb29d9ee571 144 * @brief Reports the name of the source file and the source line number
Wolfgang Betz 0:4fb29d9ee571 145 * where the assert_param error has occurred.
Wolfgang Betz 0:4fb29d9ee571 146 * @param file pointer to the source file name
Wolfgang Betz 0:4fb29d9ee571 147 * @param line assert_param error line source number
Wolfgang Betz 0:4fb29d9ee571 148 * @param expression: string representing the assert failed expression
Wolfgang Betz 0:4fb29d9ee571 149 * @retval : None
Wolfgang Betz 0:4fb29d9ee571 150 */
Wolfgang Betz 0:4fb29d9ee571 151 void s_assert_failed(uint8_t* file, uint32_t line, char* expression)
Wolfgang Betz 0:4fb29d9ee571 152 {
Wolfgang Betz 0:4fb29d9ee571 153
Wolfgang Betz 0:4fb29d9ee571 154 printf("\n\rVCOM DEBUG: Incorrect parameter. Please reboot.\n\r");
Wolfgang Betz 0:4fb29d9ee571 155 printf("%s:%d \n\r",file,line);
Wolfgang Betz 0:4fb29d9ee571 156 printf("The expression %s returned FALSE.\n\r", expression);
Wolfgang Betz 0:4fb29d9ee571 157
Wolfgang Betz 0:4fb29d9ee571 158 /* Infinite loop */
Wolfgang Betz 0:4fb29d9ee571 159 while (1)
Wolfgang Betz 0:4fb29d9ee571 160 {
Wolfgang Betz 0:4fb29d9ee571 161 }
Wolfgang Betz 0:4fb29d9ee571 162 }
Wolfgang Betz 0:4fb29d9ee571 163
Wolfgang Betz 0:4fb29d9ee571 164 #elif SPIRIT_USE_FRAME_ASSERT
Wolfgang Betz 0:4fb29d9ee571 165
Wolfgang Betz 0:4fb29d9ee571 166 #include "SdkUsbProtocol.h"
Wolfgang Betz 0:4fb29d9ee571 167
Wolfgang Betz 0:4fb29d9ee571 168 /**
Wolfgang Betz 0:4fb29d9ee571 169 * @brief Sends a notify frame with a payload indicating the name
Wolfgang Betz 0:4fb29d9ee571 170 * of the assert failed.
Wolfgang Betz 0:4fb29d9ee571 171 * @param expression: string representing the assert failed expression
Wolfgang Betz 0:4fb29d9ee571 172 * @retval : None
Wolfgang Betz 0:4fb29d9ee571 173 */
Wolfgang Betz 0:4fb29d9ee571 174 void s_assert_failed(char* expression)
Wolfgang Betz 0:4fb29d9ee571 175 {
Wolfgang Betz 0:4fb29d9ee571 176 char pcPayload[100];
Wolfgang Betz 0:4fb29d9ee571 177 uint16_t i;
Wolfgang Betz 0:4fb29d9ee571 178
Wolfgang Betz 0:4fb29d9ee571 179 for(i = 0 ; expression[i]!='(' ; i++);
Wolfgang Betz 0:4fb29d9ee571 180 expression[i]='\0';
Wolfgang Betz 0:4fb29d9ee571 181
Wolfgang Betz 0:4fb29d9ee571 182 strcpy(pcPayload, &expression[3]);
Wolfgang Betz 0:4fb29d9ee571 183
Wolfgang Betz 0:4fb29d9ee571 184 //sprintf(pcPayload, "The expression %s returned FALSE.\n\r", expression);
Wolfgang Betz 0:4fb29d9ee571 185 SpiritNotifyAssertFailed(pcPayload);
Wolfgang Betz 0:4fb29d9ee571 186
Wolfgang Betz 0:4fb29d9ee571 187 }
Wolfgang Betz 0:4fb29d9ee571 188
Wolfgang Betz 0:4fb29d9ee571 189 #endif
Wolfgang Betz 0:4fb29d9ee571 190
Wolfgang Betz 0:4fb29d9ee571 191
Wolfgang Betz 0:4fb29d9ee571 192 /**
Wolfgang Betz 0:4fb29d9ee571 193 * @brief Updates the gState (the global variable used to maintain memory of Spirit Status)
Wolfgang Betz 0:4fb29d9ee571 194 * reading the MC_STATE register of SPIRIT.
Wolfgang Betz 0:4fb29d9ee571 195 * @param None
Wolfgang Betz 0:4fb29d9ee571 196 * @retval None
Wolfgang Betz 0:4fb29d9ee571 197 */
Wolfgang Betz 0:4fb29d9ee571 198 void SpiritRefreshStatus(void)
Wolfgang Betz 0:4fb29d9ee571 199 {
Wolfgang Betz 0:4fb29d9ee571 200 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 201
Wolfgang Betz 0:4fb29d9ee571 202 /* Reads the MC_STATUS register to update the g_xStatus */
Wolfgang Betz 0:4fb29d9ee571 203 g_xStatus = SpiritSpiReadRegisters(MC_STATE1_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 204
Wolfgang Betz 0:4fb29d9ee571 205 }
Wolfgang Betz 0:4fb29d9ee571 206
Wolfgang Betz 0:4fb29d9ee571 207
Wolfgang Betz 0:4fb29d9ee571 208 /**
Wolfgang Betz 0:4fb29d9ee571 209 * @}
Wolfgang Betz 0:4fb29d9ee571 210 */
Wolfgang Betz 0:4fb29d9ee571 211
Wolfgang Betz 0:4fb29d9ee571 212
Wolfgang Betz 0:4fb29d9ee571 213
Wolfgang Betz 0:4fb29d9ee571 214 /**
Wolfgang Betz 0:4fb29d9ee571 215 * @}
Wolfgang Betz 0:4fb29d9ee571 216 */
Wolfgang Betz 0:4fb29d9ee571 217
Wolfgang Betz 0:4fb29d9ee571 218
Wolfgang Betz 0:4fb29d9ee571 219
Wolfgang Betz 0:4fb29d9ee571 220 /**
Wolfgang Betz 0:4fb29d9ee571 221 * @}
Wolfgang Betz 0:4fb29d9ee571 222 */
Wolfgang Betz 0:4fb29d9ee571 223
Wolfgang Betz 0:4fb29d9ee571 224
Wolfgang Betz 0:4fb29d9ee571 225
Wolfgang Betz 0:4fb29d9ee571 226 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/