Vergil Cola / Mbed OS MQTTGateway2

Fork of my original MQTTGateway

Dependencies:   mbed-http

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

Committer:
vpcola
Date:
Sat Apr 08 14:43:14 2017 +0000
Revision:
0:a1734fe1ec4b
Initial commit

Who changed what in which revision?

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