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).
Diff: source/libs/spirit1/SPIRIT1_Library/Src/SPIRIT_General.c
- Revision:
- 67:93bec0baf1de
- Parent:
- 34:edda6a7238ec
--- a/source/libs/spirit1/SPIRIT1_Library/Src/SPIRIT_General.c Wed Jul 05 14:02:16 2017 +0200
+++ b/source/libs/spirit1/SPIRIT1_Library/Src/SPIRIT_General.c Thu Jul 06 11:13:31 2017 +0200
@@ -1,449 +1,449 @@
-/**
- ******************************************************************************
- * @file SPIRIT_General.c
- * @author VMA division - AMS
- * @version 3.2.2
- * @date 08-July-2015
- * @brief Configuration and management of SPIRIT General functionalities.
- * @details
- *
- * @attention
- *
- * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- * 1. Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution.
- * 3. Neither the name of STMicroelectronics nor the names of its contributors
- * may be used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- ******************************************************************************
- */
-
-/* Includes ------------------------------------------------------------------*/
-#include "SPIRIT_General.h"
-#include "MCU_Interface.h"
-
-
-/**
- * @addtogroup SPIRIT_Libraries
- * @{
- */
-
-
-/**
- * @addtogroup SPIRIT_General
- * @{
- */
-
-
-/**
- * @defgroup General_Private_TypesDefinitions General Private Types Definitions
- * @{
- */
-
-/**
- *@}
- */
-
-
-/**
- * @defgroup General_Private_Defines General Private Defines
- * @{
- */
-
-/**
- *@}
- */
-
-
-/**
- * @defgroup General_Private_Macros General Private Macros
- * @{
- */
-
-/**
- *@}
- */
-
-
-/**
- * @defgroup General_Private_Variables General Private Variables
- * @{
- */
-
-
-/**
- *@}
- */
-
-
-/**
- * @defgroup General_Private_FunctionPrototypes General Private Function Prototypes
- * @{
- */
-
-/**
- *@}
- */
-
-
-/**
- * @defgroup General_Private_Functions General Private Functions
- * @{
- */
-
-/**
- * @brief Enables or Disables the output of battery level detector.
- * @param xNewState new state for battery level detector.
- * This parameter can be: S_ENABLE or S_DISABLE.
- * @retval None
- */
-void SpiritGeneralBatteryLevel(SpiritFunctionalState xNewState)
-{
- uint8_t tempRegValue;
-
- /* Check the parameters */
- s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
-
- /* Reads the ANA_FUNC_CONF0_BASE register value */
- g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
-
- /* Build the value to be stored */
- if(xNewState == S_ENABLE)
- {
- tempRegValue |= BATTERY_LEVEL_MASK;
- }
- else
- {
- tempRegValue &= ~BATTERY_LEVEL_MASK;
- }
-
- /* Writes the new value */
- g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
-
-}
-
-
-/**
- * @brief Sets the battery level.
- * @param xBatteryLevel new state for battery level.
- * This parameter can be a value of @ref BatteryLevel.
- * @retval None.
- */
-void SpiritGeneralSetBatteryLevel(BatteryLevel xBatteryLevel)
-{
- uint8_t tempRegValue;
-
- /* Check the parameters */
- s_assert_param(IS_BLD_LVL(xBatteryLevel));
-
- /* Reads the ANA_FUNC_CONF1_BASE register value */
- g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
-
- /* Build the value to be stored */
- tempRegValue &= ~ANA_FUNC_CONF1_SET_BLD_LVL_MASK;
- switch(xBatteryLevel)
- {
- case BLD_LVL_2_7_V:
- tempRegValue |= BLD_LVL_2_7;
- break;
- case BLD_LVL_2_5_V:
- tempRegValue |= BLD_LVL_2_5;
- break;
- case BLD_LVL_2_3_V:
- tempRegValue |= BLD_LVL_2_3;
- break;
- case BLD_LVL_2_1_V:
- tempRegValue |= BLD_LVL_2_1;
- break;
- }
-
- /* Writes the new value */
- g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
-
-}
-
-
-/**
- * @brief Returns the settled battery level.
- * @param None.
- * @retval BatteryLevel Settled battery level. This parameter can be a value of @ref BatteryLevel.
- */
-BatteryLevel SpiritGeneralGetBatteryLevel(void)
-{
- uint8_t tempRegValue;
-
- /* Reads the ANA_FUNC_CONF1_BASE register value */
- g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
-
- /* Mask the battery level field and returns the settled battery level */
- return ((BatteryLevel)(tempRegValue & ANA_FUNC_CONF1_SET_BLD_LVL_MASK));
-
-}
-
-
-/**
- * @brief Enables or Disables the output of brown out detector.
- * @param xNewState new state for brown out detector.
- * This parameter can be: S_ENABLE or S_DISABLE.
- * @retval None.
- */
-void SpiritGeneralBrownOut(SpiritFunctionalState xNewState)
-{
- uint8_t tempRegValue;
-
- /* Check the parameters */
- s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
-
- /* Reads the ANA_FUNC_CONF0_BASE register value */
- g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
-
- /* Build the value to be stored */
- if(xNewState == S_ENABLE)
- {
- tempRegValue |= BROWN_OUT_MASK;
- }
- else
- {
- tempRegValue &= ~BROWN_OUT_MASK;
- }
-
- /* Writes value on register */
- g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
-
-}
-
-
-/**
- * @brief Sets High Power Mode.
- * @param xNewState new state for High Power Mode.
- * This parameter can be: S_ENABLE or S_DISABLE.
- * @retval None.
- */
-void SpiritGeneralHighPwr(SpiritFunctionalState xNewState)
-{
- uint8_t tempRegValue;
-
- /* Check the parameters */
- s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
-
- /* Reads the ANA_FUNC_CONF0_BASE register value */
- g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
-
- /* Build the value to write */
- if(xNewState == S_ENABLE)
- {
- tempRegValue |= HIGH_POWER_MODE_MASK;
- }
- else
- {
- tempRegValue &= ~HIGH_POWER_MODE_MASK;
- }
-
- /* Writes the new value on register */
- g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
-
-}
-
-
-/**
- * @brief Sets External Reference.
- * @param xExtMode new state for the external reference.
- * This parameter can be: MODE_EXT_XO or MODE_EXT_XIN.
- * @retval None.
- */
-void SpiritGeneralSetExtRef(ModeExtRef xExtMode)
-{
- uint8_t tempRegValue;
-
- /* Check the parameters */
- s_assert_param(IS_MODE_EXT(xExtMode));
-
- /* Reads the ANA_FUNC_CONF0_BASE register value */
- SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
-
- /* Build the value to write */
- if(xExtMode == MODE_EXT_XO)
- {
- tempRegValue &= ~EXT_REF_MASK;
- }
- else
- {
- tempRegValue |= EXT_REF_MASK;
- }
-
- /* Writes value on register */
- g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
-
-}
-
-
-/**
- * @brief Returns External Reference.
- * @param None.
- * @retval ModeExtRef Settled external reference.
- * This parameter can be: MODE_EXT_XO or MODE_EXT_XIN.
- */
-ModeExtRef SpiritGeneralGetExtRef(void)
-{
- uint8_t tempRegValue;
-
- /* Reads the ANA_FUNC_CONF0_BASE register value and return the result */
- g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
-
- /* Mask the EXT_REF field field and returns the settled reference signal */
- return ((ModeExtRef)((tempRegValue & 0x10)>>4));
-
-}
-
-
-/**
- * @brief Sets XO gm at startup.
- * @param xGm transconductance value of XO at startup.
- * This parameter can be a value of @ref GmConf.
- * @retval None.
- */
-void SpiritGeneralSetXoGm(GmConf xGm)
-{
- uint8_t tempRegValue;
-
- /* Check the parameters */
- s_assert_param(IS_GM_CONF(xGm));
-
- /* Reads the ANA_FUNC_CONF1_BASE register value */
- g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
-
- /* Build the value to write */
- tempRegValue &= ~ANA_FUNC_CONF1_GMCONF_MASK;
- switch(xGm)
- {
- case GM_SU_13_2:
- tempRegValue |= GM_13_2;
- break;
- case GM_SU_18_2:
- tempRegValue |= GM_18_2;
- break;
- case GM_SU_21_5:
- tempRegValue |= GM_21_5;
- break;
- case GM_SU_25_6:
- tempRegValue |= GM_25_6;
- break;
- case GM_SU_28_8:
- tempRegValue |= GM_28_8;
- break;
- case GM_SU_33_9:
- tempRegValue |= GM_33_9;
- break;
- case GM_SU_38_5:
- tempRegValue |= GM_38_5;
- break;
- case GM_SU_43_0:
- tempRegValue |= GM_43_0;
- break;
- }
-
- /* Writes new value on register */
- g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
-
-}
-
-
-/**
- * @brief Returns the configured XO gm at startup.
- * @param None.
- * @retval GmConf Settled XO gm. This parameter can be a value of @ref GmConf.
- */
-GmConf SpiritGeneralGetXoGm(void)
-{
- uint8_t tempRegValue;
-
- /* Reads the ANA_FUNC_CONF1_BASE register value */
- g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
-
- /* Mask the GM_CONF field field and returns the settled transconductance of the XO at startup */
- return ((GmConf)((tempRegValue & 0x1C)>>2));
-
-}
-
-
-/**
- * @brief Returns the settled packet format.
- * @param None.
- * @retval PacketType Settled packet type. This parameter can be a value of @ref PacketType.
- */
-PacketType SpiritGeneralGetPktType(void)
-{
- uint8_t tempRegValue;
-
- /* Reads the PROTOCOL1 register */
- g_xStatus = SpiritSpiReadRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
-
- /* cast and return value */
- return (PacketType)(tempRegValue>>6);
-
-}
-
-
-
-/**
- * @brief Returns device part number.
- * @param None.
- * @retval uint16_t Device part number.
- */
-uint16_t SpiritGeneralGetDevicePartNumber(void)
-{
- uint8_t tempRegValue[2];
-
- /* Reads the register value containing the device part number */
- g_xStatus = SpiritSpiReadRegisters(DEVICE_INFO1_PARTNUM, 2, tempRegValue);
-
- return ((((uint16_t)tempRegValue[0])<<8) | ((uint16_t)tempRegValue[1]));
-
-}
-
-/**
- * @brief Returns SPIRIT RF board version.
- * @param None.
- * @retval SPIRIT RF board version: 0x30 is the only admitted value
- */
-uint8_t SpiritGeneralGetSpiritVersion(void)
-{
- uint8_t ver;
- SpiritSpiReadRegisters(DEVICE_INFO0_VERSION, 1, &ver);
- return ver;
-}
-
-/**
- *@}
- */
-
-
-/**
- *@}
- */
-
-
-/**
- *@}
- */
-
-
-/******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/
+/**
+ ******************************************************************************
+ * @file SPIRIT_General.c
+ * @author VMA division - AMS
+ * @version 3.2.2
+ * @date 08-July-2015
+ * @brief Configuration and management of SPIRIT General functionalities.
+ * @details
+ *
+ * @attention
+ *
+ * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * 3. Neither the name of STMicroelectronics nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ ******************************************************************************
+ */
+
+/* Includes ------------------------------------------------------------------*/
+#include "SPIRIT_General.h"
+#include "MCU_Interface.h"
+
+
+/**
+ * @addtogroup SPIRIT_Libraries
+ * @{
+ */
+
+
+/**
+ * @addtogroup SPIRIT_General
+ * @{
+ */
+
+
+/**
+ * @defgroup General_Private_TypesDefinitions General Private Types Definitions
+ * @{
+ */
+
+/**
+ *@}
+ */
+
+
+/**
+ * @defgroup General_Private_Defines General Private Defines
+ * @{
+ */
+
+/**
+ *@}
+ */
+
+
+/**
+ * @defgroup General_Private_Macros General Private Macros
+ * @{
+ */
+
+/**
+ *@}
+ */
+
+
+/**
+ * @defgroup General_Private_Variables General Private Variables
+ * @{
+ */
+
+
+/**
+ *@}
+ */
+
+
+/**
+ * @defgroup General_Private_FunctionPrototypes General Private Function Prototypes
+ * @{
+ */
+
+/**
+ *@}
+ */
+
+
+/**
+ * @defgroup General_Private_Functions General Private Functions
+ * @{
+ */
+
+/**
+ * @brief Enables or Disables the output of battery level detector.
+ * @param xNewState new state for battery level detector.
+ * This parameter can be: S_ENABLE or S_DISABLE.
+ * @retval None
+ */
+void SpiritGeneralBatteryLevel(SpiritFunctionalState xNewState)
+{
+ uint8_t tempRegValue;
+
+ /* Check the parameters */
+ s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
+
+ /* Reads the ANA_FUNC_CONF0_BASE register value */
+ g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
+
+ /* Build the value to be stored */
+ if(xNewState == S_ENABLE)
+ {
+ tempRegValue |= BATTERY_LEVEL_MASK;
+ }
+ else
+ {
+ tempRegValue &= ~BATTERY_LEVEL_MASK;
+ }
+
+ /* Writes the new value */
+ g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
+
+}
+
+
+/**
+ * @brief Sets the battery level.
+ * @param xBatteryLevel new state for battery level.
+ * This parameter can be a value of @ref BatteryLevel.
+ * @retval None.
+ */
+void SpiritGeneralSetBatteryLevel(BatteryLevel xBatteryLevel)
+{
+ uint8_t tempRegValue;
+
+ /* Check the parameters */
+ s_assert_param(IS_BLD_LVL(xBatteryLevel));
+
+ /* Reads the ANA_FUNC_CONF1_BASE register value */
+ g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
+
+ /* Build the value to be stored */
+ tempRegValue &= ~ANA_FUNC_CONF1_SET_BLD_LVL_MASK;
+ switch(xBatteryLevel)
+ {
+ case BLD_LVL_2_7_V:
+ tempRegValue |= BLD_LVL_2_7;
+ break;
+ case BLD_LVL_2_5_V:
+ tempRegValue |= BLD_LVL_2_5;
+ break;
+ case BLD_LVL_2_3_V:
+ tempRegValue |= BLD_LVL_2_3;
+ break;
+ case BLD_LVL_2_1_V:
+ tempRegValue |= BLD_LVL_2_1;
+ break;
+ }
+
+ /* Writes the new value */
+ g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
+
+}
+
+
+/**
+ * @brief Returns the settled battery level.
+ * @param None.
+ * @retval BatteryLevel Settled battery level. This parameter can be a value of @ref BatteryLevel.
+ */
+BatteryLevel SpiritGeneralGetBatteryLevel(void)
+{
+ uint8_t tempRegValue;
+
+ /* Reads the ANA_FUNC_CONF1_BASE register value */
+ g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
+
+ /* Mask the battery level field and returns the settled battery level */
+ return ((BatteryLevel)(tempRegValue & ANA_FUNC_CONF1_SET_BLD_LVL_MASK));
+
+}
+
+
+/**
+ * @brief Enables or Disables the output of brown out detector.
+ * @param xNewState new state for brown out detector.
+ * This parameter can be: S_ENABLE or S_DISABLE.
+ * @retval None.
+ */
+void SpiritGeneralBrownOut(SpiritFunctionalState xNewState)
+{
+ uint8_t tempRegValue;
+
+ /* Check the parameters */
+ s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
+
+ /* Reads the ANA_FUNC_CONF0_BASE register value */
+ g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
+
+ /* Build the value to be stored */
+ if(xNewState == S_ENABLE)
+ {
+ tempRegValue |= BROWN_OUT_MASK;
+ }
+ else
+ {
+ tempRegValue &= ~BROWN_OUT_MASK;
+ }
+
+ /* Writes value on register */
+ g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
+
+}
+
+
+/**
+ * @brief Sets High Power Mode.
+ * @param xNewState new state for High Power Mode.
+ * This parameter can be: S_ENABLE or S_DISABLE.
+ * @retval None.
+ */
+void SpiritGeneralHighPwr(SpiritFunctionalState xNewState)
+{
+ uint8_t tempRegValue;
+
+ /* Check the parameters */
+ s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
+
+ /* Reads the ANA_FUNC_CONF0_BASE register value */
+ g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
+
+ /* Build the value to write */
+ if(xNewState == S_ENABLE)
+ {
+ tempRegValue |= HIGH_POWER_MODE_MASK;
+ }
+ else
+ {
+ tempRegValue &= ~HIGH_POWER_MODE_MASK;
+ }
+
+ /* Writes the new value on register */
+ g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
+
+}
+
+
+/**
+ * @brief Sets External Reference.
+ * @param xExtMode new state for the external reference.
+ * This parameter can be: MODE_EXT_XO or MODE_EXT_XIN.
+ * @retval None.
+ */
+void SpiritGeneralSetExtRef(ModeExtRef xExtMode)
+{
+ uint8_t tempRegValue;
+
+ /* Check the parameters */
+ s_assert_param(IS_MODE_EXT(xExtMode));
+
+ /* Reads the ANA_FUNC_CONF0_BASE register value */
+ SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
+
+ /* Build the value to write */
+ if(xExtMode == MODE_EXT_XO)
+ {
+ tempRegValue &= ~EXT_REF_MASK;
+ }
+ else
+ {
+ tempRegValue |= EXT_REF_MASK;
+ }
+
+ /* Writes value on register */
+ g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
+
+}
+
+
+/**
+ * @brief Returns External Reference.
+ * @param None.
+ * @retval ModeExtRef Settled external reference.
+ * This parameter can be: MODE_EXT_XO or MODE_EXT_XIN.
+ */
+ModeExtRef SpiritGeneralGetExtRef(void)
+{
+ uint8_t tempRegValue;
+
+ /* Reads the ANA_FUNC_CONF0_BASE register value and return the result */
+ g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
+
+ /* Mask the EXT_REF field field and returns the settled reference signal */
+ return ((ModeExtRef)((tempRegValue & 0x10)>>4));
+
+}
+
+
+/**
+ * @brief Sets XO gm at startup.
+ * @param xGm transconductance value of XO at startup.
+ * This parameter can be a value of @ref GmConf.
+ * @retval None.
+ */
+void SpiritGeneralSetXoGm(GmConf xGm)
+{
+ uint8_t tempRegValue;
+
+ /* Check the parameters */
+ s_assert_param(IS_GM_CONF(xGm));
+
+ /* Reads the ANA_FUNC_CONF1_BASE register value */
+ g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
+
+ /* Build the value to write */
+ tempRegValue &= ~ANA_FUNC_CONF1_GMCONF_MASK;
+ switch(xGm)
+ {
+ case GM_SU_13_2:
+ tempRegValue |= GM_13_2;
+ break;
+ case GM_SU_18_2:
+ tempRegValue |= GM_18_2;
+ break;
+ case GM_SU_21_5:
+ tempRegValue |= GM_21_5;
+ break;
+ case GM_SU_25_6:
+ tempRegValue |= GM_25_6;
+ break;
+ case GM_SU_28_8:
+ tempRegValue |= GM_28_8;
+ break;
+ case GM_SU_33_9:
+ tempRegValue |= GM_33_9;
+ break;
+ case GM_SU_38_5:
+ tempRegValue |= GM_38_5;
+ break;
+ case GM_SU_43_0:
+ tempRegValue |= GM_43_0;
+ break;
+ }
+
+ /* Writes new value on register */
+ g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
+
+}
+
+
+/**
+ * @brief Returns the configured XO gm at startup.
+ * @param None.
+ * @retval GmConf Settled XO gm. This parameter can be a value of @ref GmConf.
+ */
+GmConf SpiritGeneralGetXoGm(void)
+{
+ uint8_t tempRegValue;
+
+ /* Reads the ANA_FUNC_CONF1_BASE register value */
+ g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
+
+ /* Mask the GM_CONF field field and returns the settled transconductance of the XO at startup */
+ return ((GmConf)((tempRegValue & 0x1C)>>2));
+
+}
+
+
+/**
+ * @brief Returns the settled packet format.
+ * @param None.
+ * @retval PacketType Settled packet type. This parameter can be a value of @ref PacketType.
+ */
+PacketType SpiritGeneralGetPktType(void)
+{
+ uint8_t tempRegValue;
+
+ /* Reads the PROTOCOL1 register */
+ g_xStatus = SpiritSpiReadRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
+
+ /* cast and return value */
+ return (PacketType)(tempRegValue>>6);
+
+}
+
+
+
+/**
+ * @brief Returns device part number.
+ * @param None.
+ * @retval uint16_t Device part number.
+ */
+uint16_t SpiritGeneralGetDevicePartNumber(void)
+{
+ uint8_t tempRegValue[2];
+
+ /* Reads the register value containing the device part number */
+ g_xStatus = SpiritSpiReadRegisters(DEVICE_INFO1_PARTNUM, 2, tempRegValue);
+
+ return ((((uint16_t)tempRegValue[0])<<8) | ((uint16_t)tempRegValue[1]));
+
+}
+
+/**
+ * @brief Returns SPIRIT RF board version.
+ * @param None.
+ * @retval SPIRIT RF board version: 0x30 is the only admitted value
+ */
+uint8_t SpiritGeneralGetSpiritVersion(void)
+{
+ uint8_t ver;
+ SpiritSpiReadRegisters(DEVICE_INFO0_VERSION, 1, &ver);
+ return ver;
+}
+
+/**
+ *@}
+ */
+
+
+/**
+ *@}
+ */
+
+
+/**
+ *@}
+ */
+
+
+/******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/
X-NUCLEO-IDS01A4 Sub-1GHz RF Expansion Board