Vergil Cola / Mbed OS MQTTGatewayK64

Fork of my MQTTGateway

Dependencies:   mbed-http

easy-connect/stm-spirit1-rf-driver/source/libs/spirit1/SPIRIT1_Library/Src/SPIRIT_DirectRF.c@0:f1d3878b8dd9, 2017-04-08 (annotated)

Committer:
vpcola
Date:
Sat Apr 08 14:45:51 2017 +0000
Revision:
0:f1d3878b8dd9
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vpcola 0:f1d3878b8dd9 1 /**
vpcola 0:f1d3878b8dd9 2 ******************************************************************************
vpcola 0:f1d3878b8dd9 3 * @file SPIRIT_DirectRF.c
vpcola 0:f1d3878b8dd9 4 * @author VMA division - AMS
vpcola 0:f1d3878b8dd9 5 * @version 3.2.2
vpcola 0:f1d3878b8dd9 6 * @date 08-July-2015
vpcola 0:f1d3878b8dd9 7 * @brief Configuration and management of SPIRIT direct transmission / receive modes.
vpcola 0:f1d3878b8dd9 8 * @details
vpcola 0:f1d3878b8dd9 9 * @attention
vpcola 0:f1d3878b8dd9 10 *
vpcola 0:f1d3878b8dd9 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
vpcola 0:f1d3878b8dd9 12 *
vpcola 0:f1d3878b8dd9 13 * Redistribution and use in source and binary forms, with or without modification,
vpcola 0:f1d3878b8dd9 14 * are permitted provided that the following conditions are met:
vpcola 0:f1d3878b8dd9 15 * 1. Redistributions of source code must retain the above copyright notice,
vpcola 0:f1d3878b8dd9 16 * this list of conditions and the following disclaimer.
vpcola 0:f1d3878b8dd9 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
vpcola 0:f1d3878b8dd9 18 * this list of conditions and the following disclaimer in the documentation
vpcola 0:f1d3878b8dd9 19 * and/or other materials provided with the distribution.
vpcola 0:f1d3878b8dd9 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
vpcola 0:f1d3878b8dd9 21 * may be used to endorse or promote products derived from this software
vpcola 0:f1d3878b8dd9 22 * without specific prior written permission.
vpcola 0:f1d3878b8dd9 23 *
vpcola 0:f1d3878b8dd9 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
vpcola 0:f1d3878b8dd9 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
vpcola 0:f1d3878b8dd9 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
vpcola 0:f1d3878b8dd9 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
vpcola 0:f1d3878b8dd9 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
vpcola 0:f1d3878b8dd9 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
vpcola 0:f1d3878b8dd9 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
vpcola 0:f1d3878b8dd9 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
vpcola 0:f1d3878b8dd9 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
vpcola 0:f1d3878b8dd9 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
vpcola 0:f1d3878b8dd9 34 *
vpcola 0:f1d3878b8dd9 35 ******************************************************************************
vpcola 0:f1d3878b8dd9 36 */
vpcola 0:f1d3878b8dd9 37
vpcola 0:f1d3878b8dd9 38 /* Includes ------------------------------------------------------------------*/
vpcola 0:f1d3878b8dd9 39 #include "SPIRIT_DirectRF.h"
vpcola 0:f1d3878b8dd9 40 #include "MCU_Interface.h"
vpcola 0:f1d3878b8dd9 41
vpcola 0:f1d3878b8dd9 42
vpcola 0:f1d3878b8dd9 43
vpcola 0:f1d3878b8dd9 44 /**
vpcola 0:f1d3878b8dd9 45 * @addtogroup SPIRIT_Libraries
vpcola 0:f1d3878b8dd9 46 * @{
vpcola 0:f1d3878b8dd9 47 */
vpcola 0:f1d3878b8dd9 48
vpcola 0:f1d3878b8dd9 49
vpcola 0:f1d3878b8dd9 50 /**
vpcola 0:f1d3878b8dd9 51 * @addtogroup SPIRIT_DirectRf
vpcola 0:f1d3878b8dd9 52 * @{
vpcola 0:f1d3878b8dd9 53 */
vpcola 0:f1d3878b8dd9 54
vpcola 0:f1d3878b8dd9 55
vpcola 0:f1d3878b8dd9 56 /**
vpcola 0:f1d3878b8dd9 57 * @defgroup DirectRf_Private_TypesDefinitions Direct RF Private Types Definitions
vpcola 0:f1d3878b8dd9 58 * @{
vpcola 0:f1d3878b8dd9 59 */
vpcola 0:f1d3878b8dd9 60
vpcola 0:f1d3878b8dd9 61 /**
vpcola 0:f1d3878b8dd9 62 *@}
vpcola 0:f1d3878b8dd9 63 */
vpcola 0:f1d3878b8dd9 64
vpcola 0:f1d3878b8dd9 65
vpcola 0:f1d3878b8dd9 66 /**
vpcola 0:f1d3878b8dd9 67 * @defgroup DirectRf_Private_Defines Direct RF Private Defines
vpcola 0:f1d3878b8dd9 68 * @{
vpcola 0:f1d3878b8dd9 69 */
vpcola 0:f1d3878b8dd9 70
vpcola 0:f1d3878b8dd9 71 /**
vpcola 0:f1d3878b8dd9 72 *@}
vpcola 0:f1d3878b8dd9 73 */
vpcola 0:f1d3878b8dd9 74
vpcola 0:f1d3878b8dd9 75
vpcola 0:f1d3878b8dd9 76 /**
vpcola 0:f1d3878b8dd9 77 * @defgroup DirectRf_Private_Macros Direct RF Private Macros
vpcola 0:f1d3878b8dd9 78 * @{
vpcola 0:f1d3878b8dd9 79 */
vpcola 0:f1d3878b8dd9 80
vpcola 0:f1d3878b8dd9 81 /**
vpcola 0:f1d3878b8dd9 82 *@}
vpcola 0:f1d3878b8dd9 83 */
vpcola 0:f1d3878b8dd9 84
vpcola 0:f1d3878b8dd9 85
vpcola 0:f1d3878b8dd9 86 /**
vpcola 0:f1d3878b8dd9 87 * @defgroup DirectRf_Private_Variables Direct RF Private Variables
vpcola 0:f1d3878b8dd9 88 * @{
vpcola 0:f1d3878b8dd9 89 */
vpcola 0:f1d3878b8dd9 90
vpcola 0:f1d3878b8dd9 91 /**
vpcola 0:f1d3878b8dd9 92 *@}
vpcola 0:f1d3878b8dd9 93 */
vpcola 0:f1d3878b8dd9 94
vpcola 0:f1d3878b8dd9 95
vpcola 0:f1d3878b8dd9 96
vpcola 0:f1d3878b8dd9 97 /**
vpcola 0:f1d3878b8dd9 98 * @defgroup DirectRf_Private_FunctionPrototypes Direct RF Private Function Prototypes
vpcola 0:f1d3878b8dd9 99 * @{
vpcola 0:f1d3878b8dd9 100 */
vpcola 0:f1d3878b8dd9 101
vpcola 0:f1d3878b8dd9 102 /**
vpcola 0:f1d3878b8dd9 103 *@}
vpcola 0:f1d3878b8dd9 104 */
vpcola 0:f1d3878b8dd9 105
vpcola 0:f1d3878b8dd9 106
vpcola 0:f1d3878b8dd9 107 /**
vpcola 0:f1d3878b8dd9 108 * @defgroup DirectRf_Private_Functions Direct RF Private Functions
vpcola 0:f1d3878b8dd9 109 * @{
vpcola 0:f1d3878b8dd9 110 */
vpcola 0:f1d3878b8dd9 111
vpcola 0:f1d3878b8dd9 112 /**
vpcola 0:f1d3878b8dd9 113 * @brief Sets the DirectRF RX mode of SPIRIT.
vpcola 0:f1d3878b8dd9 114 * @param xDirectRx code of the desired mode.
vpcola 0:f1d3878b8dd9 115 * This parameter can be any value of @ref DirectRx.
vpcola 0:f1d3878b8dd9 116 * @retval None.
vpcola 0:f1d3878b8dd9 117 */
vpcola 0:f1d3878b8dd9 118 void SpiritDirectRfSetRxMode(DirectRx xDirectRx)
vpcola 0:f1d3878b8dd9 119 {
vpcola 0:f1d3878b8dd9 120 uint8_t tempRegValue;
vpcola 0:f1d3878b8dd9 121
vpcola 0:f1d3878b8dd9 122 /* Check the parameters */
vpcola 0:f1d3878b8dd9 123 s_assert_param(IS_DIRECT_RX(xDirectRx));
vpcola 0:f1d3878b8dd9 124
vpcola 0:f1d3878b8dd9 125 /* Reads the register value */
vpcola 0:f1d3878b8dd9 126 SpiritSpiReadRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
vpcola 0:f1d3878b8dd9 127
vpcola 0:f1d3878b8dd9 128 /* Build the value to be stored */
vpcola 0:f1d3878b8dd9 129 tempRegValue &= ~PCKTCTRL3_RX_MODE_MASK;
vpcola 0:f1d3878b8dd9 130 tempRegValue |= (uint8_t)xDirectRx;
vpcola 0:f1d3878b8dd9 131
vpcola 0:f1d3878b8dd9 132 /* Writes value on register */
vpcola 0:f1d3878b8dd9 133 g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
vpcola 0:f1d3878b8dd9 134
vpcola 0:f1d3878b8dd9 135 }
vpcola 0:f1d3878b8dd9 136
vpcola 0:f1d3878b8dd9 137
vpcola 0:f1d3878b8dd9 138 /**
vpcola 0:f1d3878b8dd9 139 * @brief Returns the DirectRF RX mode of SPIRIT.
vpcola 0:f1d3878b8dd9 140 * @param None.
vpcola 0:f1d3878b8dd9 141 * @retval DirectRx Direct Rx mode.
vpcola 0:f1d3878b8dd9 142 */
vpcola 0:f1d3878b8dd9 143 DirectRx SpiritDirectRfGetRxMode(void)
vpcola 0:f1d3878b8dd9 144 {
vpcola 0:f1d3878b8dd9 145 uint8_t tempRegValue;
vpcola 0:f1d3878b8dd9 146
vpcola 0:f1d3878b8dd9 147 /* Reads the register value and mask the RX_Mode field */
vpcola 0:f1d3878b8dd9 148 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
vpcola 0:f1d3878b8dd9 149
vpcola 0:f1d3878b8dd9 150 /* Rebuild and return value */
vpcola 0:f1d3878b8dd9 151 return (DirectRx)(tempRegValue & 0x30);
vpcola 0:f1d3878b8dd9 152
vpcola 0:f1d3878b8dd9 153 }
vpcola 0:f1d3878b8dd9 154
vpcola 0:f1d3878b8dd9 155
vpcola 0:f1d3878b8dd9 156 /**
vpcola 0:f1d3878b8dd9 157 * @brief Sets the TX mode of SPIRIT.
vpcola 0:f1d3878b8dd9 158 * @param xDirectTx code of the desired source.
vpcola 0:f1d3878b8dd9 159 * This parameter can be any value of @ref DirectTx.
vpcola 0:f1d3878b8dd9 160 * @retval None.
vpcola 0:f1d3878b8dd9 161 */
vpcola 0:f1d3878b8dd9 162 void SpiritDirectRfSetTxMode(DirectTx xDirectTx)
vpcola 0:f1d3878b8dd9 163 {
vpcola 0:f1d3878b8dd9 164 uint8_t tempRegValue;
vpcola 0:f1d3878b8dd9 165
vpcola 0:f1d3878b8dd9 166 /* Check the parameters */
vpcola 0:f1d3878b8dd9 167 s_assert_param(IS_DIRECT_TX(xDirectTx));
vpcola 0:f1d3878b8dd9 168
vpcola 0:f1d3878b8dd9 169 /* Reads the register value */
vpcola 0:f1d3878b8dd9 170 SpiritSpiReadRegisters(PCKTCTRL1_BASE, 1, &tempRegValue);
vpcola 0:f1d3878b8dd9 171
vpcola 0:f1d3878b8dd9 172 /* Build the value to be stored */
vpcola 0:f1d3878b8dd9 173 tempRegValue &= ~PCKTCTRL1_TX_SOURCE_MASK;
vpcola 0:f1d3878b8dd9 174 tempRegValue |= (uint8_t)xDirectTx;
vpcola 0:f1d3878b8dd9 175
vpcola 0:f1d3878b8dd9 176 /* Writes value on register */
vpcola 0:f1d3878b8dd9 177 g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL1_BASE, 1, &tempRegValue);
vpcola 0:f1d3878b8dd9 178
vpcola 0:f1d3878b8dd9 179 }
vpcola 0:f1d3878b8dd9 180
vpcola 0:f1d3878b8dd9 181
vpcola 0:f1d3878b8dd9 182 /**
vpcola 0:f1d3878b8dd9 183 * @brief Returns the DirectRF TX mode of SPIRIT.
vpcola 0:f1d3878b8dd9 184 * @param None.
vpcola 0:f1d3878b8dd9 185 * @retval DirectTx Direct Tx mode.
vpcola 0:f1d3878b8dd9 186 */
vpcola 0:f1d3878b8dd9 187 DirectTx SpiritDirectRfGetTxMode(void)
vpcola 0:f1d3878b8dd9 188 {
vpcola 0:f1d3878b8dd9 189 uint8_t tempRegValue;
vpcola 0:f1d3878b8dd9 190
vpcola 0:f1d3878b8dd9 191 /* Reads the register value and mask the RX_Mode field */
vpcola 0:f1d3878b8dd9 192 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL1_BASE, 1, &tempRegValue);
vpcola 0:f1d3878b8dd9 193
vpcola 0:f1d3878b8dd9 194 /* Returns value */
vpcola 0:f1d3878b8dd9 195 return (DirectTx)(tempRegValue & 0x0C);
vpcola 0:f1d3878b8dd9 196
vpcola 0:f1d3878b8dd9 197 }
vpcola 0:f1d3878b8dd9 198
vpcola 0:f1d3878b8dd9 199
vpcola 0:f1d3878b8dd9 200 /**
vpcola 0:f1d3878b8dd9 201 *@}
vpcola 0:f1d3878b8dd9 202 */
vpcola 0:f1d3878b8dd9 203
vpcola 0:f1d3878b8dd9 204 /**
vpcola 0:f1d3878b8dd9 205 *@}
vpcola 0:f1d3878b8dd9 206 */
vpcola 0:f1d3878b8dd9 207
vpcola 0:f1d3878b8dd9 208
vpcola 0:f1d3878b8dd9 209 /**
vpcola 0:f1d3878b8dd9 210 *@}
vpcola 0:f1d3878b8dd9 211 */
vpcola 0:f1d3878b8dd9 212
vpcola 0:f1d3878b8dd9 213
vpcola 0:f1d3878b8dd9 214
vpcola 0:f1d3878b8dd9 215 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/