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/MCU_Interface.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 * @file MCU_Interface.h
Wolfgang Betz 34:edda6a7238ec 3 * @author VMA division - AMS
Wolfgang Betz 34:edda6a7238ec 4 * @version V2.0.2
Wolfgang Betz 34:edda6a7238ec 5 * @date Febrary 7, 2015
Wolfgang Betz 34:edda6a7238ec 6 * @brief Header file for low level SPIRIT SPI driver.
Wolfgang Betz 34:edda6a7238ec 7 * @details
Wolfgang Betz 34:edda6a7238ec 8 *
Wolfgang Betz 34:edda6a7238ec 9 * This header file constitutes an interface to the SPI driver used to
Wolfgang Betz 34:edda6a7238ec 10 * communicate with Spirit.
Wolfgang Betz 34:edda6a7238ec 11 * It exports some function prototypes to write/read registers and FIFOs
Wolfgang Betz 34:edda6a7238ec 12 * and to send command strobes.
Wolfgang Betz 34:edda6a7238ec 13 * Since the Spirit libraries are totally platform independent, the implementation
Wolfgang Betz 34:edda6a7238ec 14 * of these functions are not provided here. The user have to implement these functions
Wolfgang Betz 34:edda6a7238ec 15 * taking care to keep the exported prototypes.
Wolfgang Betz 34:edda6a7238ec 16 *
Wolfgang Betz 34:edda6a7238ec 17 * These functions are:
Wolfgang Betz 34:edda6a7238ec 18 *
Wolfgang Betz 34:edda6a7238ec 19 * <ul>
Wolfgang Betz 34:edda6a7238ec 20 * <li>SpiritSpiInit</i>
Wolfgang Betz 34:edda6a7238ec 21 * <li>SpiritSpiWriteRegisters</i>
Wolfgang Betz 34:edda6a7238ec 22 * <li>SpiritSpiReadRegisters</i>
Wolfgang Betz 34:edda6a7238ec 23 * <li>SpiritSpiCommandStrobes</i>
Wolfgang Betz 34:edda6a7238ec 24 * <li>SpiritSpiWriteLinearFifo</i>
Wolfgang Betz 34:edda6a7238ec 25 * <li>SpiritSpiReadLinearFifo</i>
Wolfgang Betz 34:edda6a7238ec 26 * </ul>
Wolfgang Betz 34:edda6a7238ec 27 *
Wolfgang Betz 34:edda6a7238ec 28 * @note An example of SPI driver implementation is available in the <i>Sdk_Eval</i> library.
Wolfgang Betz 34:edda6a7238ec 29 *
Wolfgang Betz 34:edda6a7238ec 30 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
Wolfgang Betz 34:edda6a7238ec 31 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
Wolfgang Betz 34:edda6a7238ec 32 * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
Wolfgang Betz 34:edda6a7238ec 33 * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
Wolfgang Betz 34:edda6a7238ec 34 * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
Wolfgang Betz 34:edda6a7238ec 35 * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
Wolfgang Betz 34:edda6a7238ec 36 *
Wolfgang Betz 34:edda6a7238ec 37 * THIS SOURCE CODE IS PROTECTED BY A LICENSE.
Wolfgang Betz 34:edda6a7238ec 38 * FOR MORE INFORMATION PLEASE CAREFULLY READ THE LICENSE AGREEMENT FILE LOCATED
Wolfgang Betz 34:edda6a7238ec 39 * IN THE ROOT DIRECTORY OF THIS FIRMWARE PACKAGE.
Wolfgang Betz 34:edda6a7238ec 40 *
Wolfgang Betz 34:edda6a7238ec 41 * <h2><center>&copy; COPYRIGHT 2015 STMicroelectronics</center></h2>
Wolfgang Betz 34:edda6a7238ec 42 */
Wolfgang Betz 34:edda6a7238ec 43
Wolfgang Betz 34:edda6a7238ec 44
Wolfgang Betz 34:edda6a7238ec 45 /* Define to prevent recursive inclusion -------------------------------------*/
Wolfgang Betz 34:edda6a7238ec 46 #ifndef __MCU_INTERFACE_H
Wolfgang Betz 34:edda6a7238ec 47 #define __MCU_INTERFACE_H
Wolfgang Betz 34:edda6a7238ec 48
Wolfgang Betz 34:edda6a7238ec 49
Wolfgang Betz 34:edda6a7238ec 50 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 34:edda6a7238ec 51 #include "SPIRIT_Types.h"
Wolfgang Betz 34:edda6a7238ec 52
Wolfgang Betz 34:edda6a7238ec 53
Wolfgang Betz 34:edda6a7238ec 54 #ifdef __cplusplus
Wolfgang Betz 34:edda6a7238ec 55 extern "C" {
Wolfgang Betz 34:edda6a7238ec 56 #endif
Wolfgang Betz 34:edda6a7238ec 57
Wolfgang Betz 34:edda6a7238ec 58
Wolfgang Betz 34:edda6a7238ec 59 /** @addtogroup SPIRIT_Libraries
Wolfgang Betz 34:edda6a7238ec 60 * @{
Wolfgang Betz 34:edda6a7238ec 61 */
Wolfgang Betz 34:edda6a7238ec 62
Wolfgang Betz 34:edda6a7238ec 63
Wolfgang Betz 34:edda6a7238ec 64 /** @defgroup SPIRIT_SPI_Driver SPI Driver
Wolfgang Betz 34:edda6a7238ec 65 * @brief Header file for low level SPIRIT SPI driver.
Wolfgang Betz 34:edda6a7238ec 66 * @details See the file <i>@ref MCU_Interface.h</i> for more details.
Wolfgang Betz 34:edda6a7238ec 67 * @{
Wolfgang Betz 34:edda6a7238ec 68 */
Wolfgang Betz 34:edda6a7238ec 69
Wolfgang Betz 34:edda6a7238ec 70
Wolfgang Betz 34:edda6a7238ec 71
Wolfgang Betz 34:edda6a7238ec 72 /** @defgroup SPI_Exported_Types SPI Exported Types
Wolfgang Betz 34:edda6a7238ec 73 * @{
Wolfgang Betz 34:edda6a7238ec 74 */
Wolfgang Betz 34:edda6a7238ec 75
Wolfgang Betz 34:edda6a7238ec 76 /**
Wolfgang Betz 34:edda6a7238ec 77 * @}
Wolfgang Betz 34:edda6a7238ec 78 */
Wolfgang Betz 34:edda6a7238ec 79
Wolfgang Betz 34:edda6a7238ec 80
Wolfgang Betz 34:edda6a7238ec 81
Wolfgang Betz 34:edda6a7238ec 82 /** @defgroup SPI_Exported_Constants SPI Exported Constants
Wolfgang Betz 34:edda6a7238ec 83 * @{
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 */
Wolfgang Betz 34:edda6a7238ec 89
Wolfgang Betz 34:edda6a7238ec 90
Wolfgang Betz 34:edda6a7238ec 91
Wolfgang Betz 34:edda6a7238ec 92 /** @defgroup SPI_Exported_Macros SPI Exported Macros
Wolfgang Betz 34:edda6a7238ec 93 * @{
Wolfgang Betz 34:edda6a7238ec 94 */
Wolfgang Betz 34:edda6a7238ec 95
Wolfgang Betz 34:edda6a7238ec 96 /**
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
Wolfgang Betz 34:edda6a7238ec 102 /** @defgroup SPI_Exported_Functions SPI Exported Functions
Wolfgang Betz 34:edda6a7238ec 103 * @{
Wolfgang Betz 34:edda6a7238ec 104 */
Wolfgang Betz 34:edda6a7238ec 105
Wolfgang Betz 34:edda6a7238ec 106 typedef SpiritStatus StatusBytes;
Wolfgang Betz 34:edda6a7238ec 107
Wolfgang Betz 34:edda6a7238ec 108 void SdkEvalSpiInit(void);
Wolfgang Betz 34:edda6a7238ec 109 StatusBytes SdkEvalSpiWriteRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
Wolfgang Betz 34:edda6a7238ec 110 StatusBytes SdkEvalSpiReadRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
Wolfgang Betz 34:edda6a7238ec 111 StatusBytes SdkEvalSpiCommandStrobes(uint8_t cCommandCode);
Wolfgang Betz 34:edda6a7238ec 112 StatusBytes SdkEvalSpiWriteFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
Wolfgang Betz 34:edda6a7238ec 113 StatusBytes SdkEvalSpiReadFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
Wolfgang Betz 34:edda6a7238ec 114
Wolfgang Betz 34:edda6a7238ec 115 void SdkEvalEnterShutdown(void);
Wolfgang Betz 34:edda6a7238ec 116 void SdkEvalExitShutdown(void);
Wolfgang Betz 34:edda6a7238ec 117 SpiritFlagStatus SdkEvalCheckShutdown(void);
Wolfgang Betz 34:edda6a7238ec 118
Wolfgang Betz 34:edda6a7238ec 119 #define SpiritEnterShutdown SdkEvalEnterShutdown
Wolfgang Betz 34:edda6a7238ec 120 #define SpiritExitShutdown SdkEvalExitShutdown
Wolfgang Betz 34:edda6a7238ec 121 #define SpiritCheckShutdown (SpiritFlagStatus)SdkEvalCheckShutdown
Wolfgang Betz 34:edda6a7238ec 122
Wolfgang Betz 34:edda6a7238ec 123
Wolfgang Betz 34:edda6a7238ec 124 #define SpiritSpiInit SdkEvalSpiInit
Wolfgang Betz 34:edda6a7238ec 125 #define SpiritSpiWriteRegisters(cRegAddress, cNbBytes, pcBuffer) SdkEvalSpiWriteRegisters(cRegAddress, cNbBytes, pcBuffer)
Wolfgang Betz 34:edda6a7238ec 126 #define SpiritSpiReadRegisters(cRegAddress, cNbBytes, pcBuffer) SdkEvalSpiReadRegisters(cRegAddress, cNbBytes, pcBuffer)
Wolfgang Betz 34:edda6a7238ec 127 #define SpiritSpiCommandStrobes(cCommandCode) SdkEvalSpiCommandStrobes(cCommandCode)
Wolfgang Betz 34:edda6a7238ec 128 #define SpiritSpiWriteLinearFifo(cNbBytes, pcBuffer) SdkEvalSpiWriteFifo(cNbBytes, pcBuffer)
Wolfgang Betz 34:edda6a7238ec 129 #define SpiritSpiReadLinearFifo(cNbBytes, pcBuffer) SdkEvalSpiReadFifo(cNbBytes, pcBuffer)
Wolfgang Betz 34:edda6a7238ec 130
Wolfgang Betz 34:edda6a7238ec 131 /**
Wolfgang Betz 34:edda6a7238ec 132 * @}
Wolfgang Betz 34:edda6a7238ec 133 */
Wolfgang Betz 34:edda6a7238ec 134
Wolfgang Betz 34:edda6a7238ec 135 /**
Wolfgang Betz 34:edda6a7238ec 136 * @}
Wolfgang Betz 34:edda6a7238ec 137 */
Wolfgang Betz 34:edda6a7238ec 138
Wolfgang Betz 34:edda6a7238ec 139
Wolfgang Betz 34:edda6a7238ec 140 /**
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 #ifdef __cplusplus
Wolfgang Betz 34:edda6a7238ec 147 }
Wolfgang Betz 34:edda6a7238ec 148 #endif
Wolfgang Betz 34:edda6a7238ec 149
Wolfgang Betz 34:edda6a7238ec 150 #endif
Wolfgang Betz 34:edda6a7238ec 151
Wolfgang Betz 34:edda6a7238ec 152 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/