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_Config.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_Config.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 Spirit Configuration and useful defines
Wolfgang Betz 67:93bec0baf1de 8 *
Wolfgang Betz 67:93bec0baf1de 9 * @details
Wolfgang Betz 67:93bec0baf1de 10 *
Wolfgang Betz 67:93bec0baf1de 11 * This file is used to include all or a part of the Spirit
Wolfgang Betz 67:93bec0baf1de 12 * libraries into the application program which will be used.
Wolfgang Betz 67:93bec0baf1de 13 * Moreover some important parameters are defined here and the
Wolfgang Betz 67:93bec0baf1de 14 * user is allowed to edit them.
Wolfgang Betz 67:93bec0baf1de 15 *
Wolfgang Betz 67:93bec0baf1de 16 * @attention
Wolfgang Betz 67:93bec0baf1de 17 *
Wolfgang Betz 67:93bec0baf1de 18 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 67:93bec0baf1de 19 *
Wolfgang Betz 67:93bec0baf1de 20 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 67:93bec0baf1de 21 * are permitted provided that the following conditions are met:
Wolfgang Betz 67:93bec0baf1de 22 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 67:93bec0baf1de 23 * this list of conditions and the following disclaimer.
Wolfgang Betz 67:93bec0baf1de 24 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 67:93bec0baf1de 25 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 67:93bec0baf1de 26 * and/or other materials provided with the distribution.
Wolfgang Betz 67:93bec0baf1de 27 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 67:93bec0baf1de 28 * may be used to endorse or promote products derived from this software
Wolfgang Betz 67:93bec0baf1de 29 * without specific prior written permission.
Wolfgang Betz 67:93bec0baf1de 30 *
Wolfgang Betz 67:93bec0baf1de 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 67:93bec0baf1de 32 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 67:93bec0baf1de 33 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 67:93bec0baf1de 34 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 67:93bec0baf1de 35 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 67:93bec0baf1de 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 67:93bec0baf1de 37 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 67:93bec0baf1de 38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 67:93bec0baf1de 39 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 67:93bec0baf1de 40 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 67:93bec0baf1de 41 *
Wolfgang Betz 67:93bec0baf1de 42 ******************************************************************************
Wolfgang Betz 67:93bec0baf1de 43 */
Wolfgang Betz 67:93bec0baf1de 44
Wolfgang Betz 67:93bec0baf1de 45 /* Define to prevent recursive inclusion -------------------------------------*/
Wolfgang Betz 67:93bec0baf1de 46 #ifndef __SPIRIT_CONFIG_H
Wolfgang Betz 67:93bec0baf1de 47 #define __SPIRIT_CONFIG_H
Wolfgang Betz 67:93bec0baf1de 48
Wolfgang Betz 67:93bec0baf1de 49
Wolfgang Betz 67:93bec0baf1de 50 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 67:93bec0baf1de 51 #include "SPIRIT_Regs.h"
Wolfgang Betz 67:93bec0baf1de 52 #include "SPIRIT_Aes.h"
Wolfgang Betz 67:93bec0baf1de 53 #include "SPIRIT_Calibration.h"
Wolfgang Betz 67:93bec0baf1de 54 #include "SPIRIT_Commands.h"
Wolfgang Betz 67:93bec0baf1de 55 #include "SPIRIT_Csma.h"
Wolfgang Betz 67:93bec0baf1de 56 #include "SPIRIT_DirectRF.h"
Wolfgang Betz 67:93bec0baf1de 57 #include "SPIRIT_General.h"
Wolfgang Betz 67:93bec0baf1de 58 #include "SPIRIT_Gpio.h"
Wolfgang Betz 67:93bec0baf1de 59 #include "SPIRIT_Irq.h"
Wolfgang Betz 67:93bec0baf1de 60 #include "SPIRIT_Timer.h"
Wolfgang Betz 67:93bec0baf1de 61 #include "SPIRIT_LinearFifo.h"
Wolfgang Betz 67:93bec0baf1de 62 #include "SPIRIT_PktBasic.h"
Wolfgang Betz 67:93bec0baf1de 63 #include "SPIRIT_PktMbus.h"
Wolfgang Betz 67:93bec0baf1de 64 #include "SPIRIT_PktStack.h"
Wolfgang Betz 67:93bec0baf1de 65
Wolfgang Betz 67:93bec0baf1de 66 #include "SPIRIT_Qi.h"
Wolfgang Betz 67:93bec0baf1de 67 #include "SPIRIT_Radio.h"
Wolfgang Betz 67:93bec0baf1de 68 #include "MCU_Interface.h"
Wolfgang Betz 67:93bec0baf1de 69 #include "SPIRIT_Types.h"
Wolfgang Betz 67:93bec0baf1de 70 #include "SPIRIT_Management.h"
Wolfgang Betz 67:93bec0baf1de 71
Wolfgang Betz 67:93bec0baf1de 72
Wolfgang Betz 67:93bec0baf1de 73 #ifdef __cplusplus
Wolfgang Betz 67:93bec0baf1de 74 extern "C" {
Wolfgang Betz 67:93bec0baf1de 75 #endif
Wolfgang Betz 67:93bec0baf1de 76
Wolfgang Betz 67:93bec0baf1de 77
Wolfgang Betz 67:93bec0baf1de 78 /** @addtogroup SPIRIT_Libraries SPIRIT Libraries
Wolfgang Betz 67:93bec0baf1de 79 * @brief This firmware implements libraries which allow the user
Wolfgang Betz 67:93bec0baf1de 80 * to manage the features of Spirit without knowing the hardware details.
Wolfgang Betz 67:93bec0baf1de 81 * @details The <i>SPIRIT_Libraries</i> modules are totally platform independent. The library provides one
Wolfgang Betz 67:93bec0baf1de 82 * module for each device feature. Each module refers to some functions whose prototypes are located in the
Wolfgang Betz 67:93bec0baf1de 83 * header file <i>@ref MCU_Interface.h</i>. The user who want to use these libraries on a particular
Wolfgang Betz 67:93bec0baf1de 84 * platform has to implement these functions respecting them signatures.
Wolfgang Betz 67:93bec0baf1de 85 * @{
Wolfgang Betz 67:93bec0baf1de 86 */
Wolfgang Betz 67:93bec0baf1de 87
Wolfgang Betz 67:93bec0baf1de 88 /** @defgroup SPIRIT_Configuration Configuration
Wolfgang Betz 67:93bec0baf1de 89 * @brief Spirit Configuration and useful defines.
Wolfgang Betz 67:93bec0baf1de 90 * @details See the file <i>@ref SPIRIT_Config.h</i> for more details.
Wolfgang Betz 67:93bec0baf1de 91 * @{
Wolfgang Betz 67:93bec0baf1de 92 */
Wolfgang Betz 67:93bec0baf1de 93
Wolfgang Betz 67:93bec0baf1de 94
Wolfgang Betz 67:93bec0baf1de 95 /** @defgroup Configuration_Exported_Types Configuration Exported Types
Wolfgang Betz 67:93bec0baf1de 96 * @{
Wolfgang Betz 67:93bec0baf1de 97 */
Wolfgang Betz 67:93bec0baf1de 98
Wolfgang Betz 67:93bec0baf1de 99 /**
Wolfgang Betz 67:93bec0baf1de 100 * @}
Wolfgang Betz 67:93bec0baf1de 101 */
Wolfgang Betz 67:93bec0baf1de 102
Wolfgang Betz 67:93bec0baf1de 103
Wolfgang Betz 67:93bec0baf1de 104 /** @defgroup Configuration_Exported_Constants Configuration Exported Constants
Wolfgang Betz 67:93bec0baf1de 105 * @{
Wolfgang Betz 67:93bec0baf1de 106 */
Wolfgang Betz 67:93bec0baf1de 107 #define DOUBLE_XTAL_THR 30000000
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 Configuration_Exported_Macros Configuration Exported Macros
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 /** @defgroup Configuration_Exported_Functions Configuration Exported Functions
Wolfgang Betz 67:93bec0baf1de 124 * @{
Wolfgang Betz 67:93bec0baf1de 125 */
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 /**
Wolfgang Betz 67:93bec0baf1de 137 * @}
Wolfgang Betz 67:93bec0baf1de 138 */
Wolfgang Betz 67:93bec0baf1de 139
Wolfgang Betz 67:93bec0baf1de 140
Wolfgang Betz 67:93bec0baf1de 141 #ifdef __cplusplus
Wolfgang Betz 67:93bec0baf1de 142 }
Wolfgang Betz 67:93bec0baf1de 143 #endif
Wolfgang Betz 67:93bec0baf1de 144
Wolfgang Betz 67:93bec0baf1de 145 #endif
Wolfgang Betz 67:93bec0baf1de 146
Wolfgang Betz 67:93bec0baf1de 147 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/