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_LinearFifo.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_LinearFifo.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 Fifo.
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_LINEAR_FIFO_H
Wolfgang Betz 67:93bec0baf1de 41 #define __SPIRIT_LINEAR_FIFO_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 /**
Wolfgang Betz 67:93bec0baf1de 56 * @addtogroup SPIRIT_Libraries
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 /**
Wolfgang Betz 67:93bec0baf1de 62 * @defgroup SPIRIT_LinearFifo Linear FIFO
Wolfgang Betz 67:93bec0baf1de 63 * @brief Configuration and management of SPIRIT FIFO.
Wolfgang Betz 67:93bec0baf1de 64 * @details See the file <i>@ref SPIRIT_LinearFifo.h</i> for more details.
Wolfgang Betz 67:93bec0baf1de 65 * @{
Wolfgang Betz 67:93bec0baf1de 66 */
Wolfgang Betz 67:93bec0baf1de 67
Wolfgang Betz 67:93bec0baf1de 68 /**
Wolfgang Betz 67:93bec0baf1de 69 * @defgroup LinearFifo_Exported_Types Linear FIFO Exported Types
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 /**
Wolfgang Betz 67:93bec0baf1de 75 * @}
Wolfgang Betz 67:93bec0baf1de 76 */
Wolfgang Betz 67:93bec0baf1de 77
Wolfgang Betz 67:93bec0baf1de 78
Wolfgang Betz 67:93bec0baf1de 79 /**
Wolfgang Betz 67:93bec0baf1de 80 * @defgroup LinearFifo_Exported_Constants Linear FIFO Exported Constants
Wolfgang Betz 67:93bec0baf1de 81 * @{
Wolfgang Betz 67:93bec0baf1de 82 */
Wolfgang Betz 67:93bec0baf1de 83 #define IS_FIFO_THR(VAL) (VAL<=96)
Wolfgang Betz 67:93bec0baf1de 84
Wolfgang Betz 67:93bec0baf1de 85 /**
Wolfgang Betz 67:93bec0baf1de 86 * @}
Wolfgang Betz 67:93bec0baf1de 87 */
Wolfgang Betz 67:93bec0baf1de 88
Wolfgang Betz 67:93bec0baf1de 89
Wolfgang Betz 67:93bec0baf1de 90 /**
Wolfgang Betz 67:93bec0baf1de 91 * @defgroup LinearFifo_Exported_Macros Linear FIFO Exported Macros
Wolfgang Betz 67:93bec0baf1de 92 * @{
Wolfgang Betz 67:93bec0baf1de 93 */
Wolfgang Betz 67:93bec0baf1de 94
Wolfgang Betz 67:93bec0baf1de 95
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 * @defgroup LinearFifo_Exported_Functions Linear FIFO Exported Functions
Wolfgang Betz 67:93bec0baf1de 103 * @{
Wolfgang Betz 67:93bec0baf1de 104 */
Wolfgang Betz 67:93bec0baf1de 105
Wolfgang Betz 67:93bec0baf1de 106 uint8_t SpiritLinearFifoReadNumElementsRxFifo(void);
Wolfgang Betz 67:93bec0baf1de 107 uint8_t SpiritLinearFifoReadNumElementsTxFifo(void);
Wolfgang Betz 67:93bec0baf1de 108 void SpiritLinearFifoSetAlmostFullThresholdRx(uint8_t cThrRxFifo);
Wolfgang Betz 67:93bec0baf1de 109 uint8_t SpiritLinearFifoGetAlmostFullThresholdRx(void);
Wolfgang Betz 67:93bec0baf1de 110 void SpiritLinearFifoSetAlmostEmptyThresholdRx(uint8_t cThrRxFifo);
Wolfgang Betz 67:93bec0baf1de 111 uint8_t SpiritLinearFifoGetAlmostEmptyThresholdRx(void);
Wolfgang Betz 67:93bec0baf1de 112 void SpiritLinearFifoSetAlmostFullThresholdTx(uint8_t cThrTxFifo);
Wolfgang Betz 67:93bec0baf1de 113 uint8_t SpiritLinearFifoGetAlmostFullThresholdTx(void);
Wolfgang Betz 67:93bec0baf1de 114 void SpiritLinearFifoSetAlmostEmptyThresholdTx(uint8_t cThrTxFifo);
Wolfgang Betz 67:93bec0baf1de 115 uint8_t SpiritLinearFifoGetAlmostEmptyThresholdTx(void);
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 */
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 #ifdef __cplusplus
Wolfgang Betz 67:93bec0baf1de 131 }
Wolfgang Betz 67:93bec0baf1de 132 #endif
Wolfgang Betz 67:93bec0baf1de 133
Wolfgang Betz 67:93bec0baf1de 134 #endif
Wolfgang Betz 67:93bec0baf1de 135
Wolfgang Betz 67:93bec0baf1de 136 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/