Jim Flynn / Mbed OS wifi_Example

wifi test

Dependencies:   X_NUCLEO_IKS01A2 mbed-http

easy-connect/stm-spirit1-rf-driver/source/libs/spirit1/SPIRIT1_Library/Inc/SPIRIT_General.h@0:24d3eb812fd4, 2018-09-05 (annotated)

Committer:
JMF
Date:
Wed Sep 05 14:28:24 2018 +0000
Revision:
0:24d3eb812fd4
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
JMF 0:24d3eb812fd4 1 /**
JMF 0:24d3eb812fd4 2 ******************************************************************************
JMF 0:24d3eb812fd4 3 * @file SPIRIT_General.h
JMF 0:24d3eb812fd4 4 * @author VMA division - AMS
JMF 0:24d3eb812fd4 5 * @version 3.2.2
JMF 0:24d3eb812fd4 6 * @date 08-July-2015
JMF 0:24d3eb812fd4 7 * @brief Configuration and management of SPIRIT General functionalities.
JMF 0:24d3eb812fd4 8 * @details
JMF 0:24d3eb812fd4 9 *
JMF 0:24d3eb812fd4 10 * @attention
JMF 0:24d3eb812fd4 11 *
JMF 0:24d3eb812fd4 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
JMF 0:24d3eb812fd4 13 *
JMF 0:24d3eb812fd4 14 * Redistribution and use in source and binary forms, with or without modification,
JMF 0:24d3eb812fd4 15 * are permitted provided that the following conditions are met:
JMF 0:24d3eb812fd4 16 * 1. Redistributions of source code must retain the above copyright notice,
JMF 0:24d3eb812fd4 17 * this list of conditions and the following disclaimer.
JMF 0:24d3eb812fd4 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
JMF 0:24d3eb812fd4 19 * this list of conditions and the following disclaimer in the documentation
JMF 0:24d3eb812fd4 20 * and/or other materials provided with the distribution.
JMF 0:24d3eb812fd4 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
JMF 0:24d3eb812fd4 22 * may be used to endorse or promote products derived from this software
JMF 0:24d3eb812fd4 23 * without specific prior written permission.
JMF 0:24d3eb812fd4 24 *
JMF 0:24d3eb812fd4 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
JMF 0:24d3eb812fd4 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
JMF 0:24d3eb812fd4 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
JMF 0:24d3eb812fd4 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
JMF 0:24d3eb812fd4 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
JMF 0:24d3eb812fd4 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
JMF 0:24d3eb812fd4 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
JMF 0:24d3eb812fd4 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
JMF 0:24d3eb812fd4 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
JMF 0:24d3eb812fd4 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
JMF 0:24d3eb812fd4 35 *
JMF 0:24d3eb812fd4 36 ******************************************************************************
JMF 0:24d3eb812fd4 37 */
JMF 0:24d3eb812fd4 38
JMF 0:24d3eb812fd4 39 /* Define to prevent recursive inclusion -------------------------------------*/
JMF 0:24d3eb812fd4 40 #ifndef __SPIRIT_GENERAL_H
JMF 0:24d3eb812fd4 41 #define __SPIRIT_GENERAL_H
JMF 0:24d3eb812fd4 42
JMF 0:24d3eb812fd4 43
JMF 0:24d3eb812fd4 44 /* Includes ------------------------------------------------------------------*/
JMF 0:24d3eb812fd4 45
JMF 0:24d3eb812fd4 46 #include "SPIRIT_Regs.h"
JMF 0:24d3eb812fd4 47 #include "SPIRIT_Types.h"
JMF 0:24d3eb812fd4 48
JMF 0:24d3eb812fd4 49
JMF 0:24d3eb812fd4 50 #ifdef __cplusplus
JMF 0:24d3eb812fd4 51 extern "C" {
JMF 0:24d3eb812fd4 52 #endif
JMF 0:24d3eb812fd4 53
JMF 0:24d3eb812fd4 54 /**
JMF 0:24d3eb812fd4 55 * @addtogroup SPIRIT_Libraries
JMF 0:24d3eb812fd4 56 * @{
JMF 0:24d3eb812fd4 57 */
JMF 0:24d3eb812fd4 58
JMF 0:24d3eb812fd4 59
JMF 0:24d3eb812fd4 60 /**
JMF 0:24d3eb812fd4 61 * @defgroup SPIRIT_General General
JMF 0:24d3eb812fd4 62 * @brief Configuration and management of SPIRIT General functionalities.
JMF 0:24d3eb812fd4 63 * @details See the file <i>@ref SPIRIT_General.h</i> for more details.
JMF 0:24d3eb812fd4 64 * @{
JMF 0:24d3eb812fd4 65 */
JMF 0:24d3eb812fd4 66
JMF 0:24d3eb812fd4 67 /**
JMF 0:24d3eb812fd4 68 * @defgroup General_Exported_Types General Exported Types
JMF 0:24d3eb812fd4 69 * @{
JMF 0:24d3eb812fd4 70 */
JMF 0:24d3eb812fd4 71
JMF 0:24d3eb812fd4 72
JMF 0:24d3eb812fd4 73 /**
JMF 0:24d3eb812fd4 74 * @brief SPIRIT ModeExtRef enumeration
JMF 0:24d3eb812fd4 75 */
JMF 0:24d3eb812fd4 76
JMF 0:24d3eb812fd4 77 typedef enum
JMF 0:24d3eb812fd4 78 {
JMF 0:24d3eb812fd4 79 MODE_EXT_XO = 0,
JMF 0:24d3eb812fd4 80 MODE_EXT_XIN = !MODE_EXT_XO
JMF 0:24d3eb812fd4 81 } ModeExtRef;
JMF 0:24d3eb812fd4 82
JMF 0:24d3eb812fd4 83 #define IS_MODE_EXT(MODE) (MODE == MODE_EXT_XO || \
JMF 0:24d3eb812fd4 84 MODE == MODE_EXT_XIN)
JMF 0:24d3eb812fd4 85
JMF 0:24d3eb812fd4 86
JMF 0:24d3eb812fd4 87 /**
JMF 0:24d3eb812fd4 88 * @brief SPIRIT BatteryLevel enumeration
JMF 0:24d3eb812fd4 89 */
JMF 0:24d3eb812fd4 90
JMF 0:24d3eb812fd4 91 typedef enum
JMF 0:24d3eb812fd4 92 {
JMF 0:24d3eb812fd4 93 BLD_LVL_2_7_V = 0,
JMF 0:24d3eb812fd4 94 BLD_LVL_2_5_V = 1,
JMF 0:24d3eb812fd4 95 BLD_LVL_2_3_V = 2,
JMF 0:24d3eb812fd4 96 BLD_LVL_2_1_V = 3
JMF 0:24d3eb812fd4 97 } BatteryLevel;
JMF 0:24d3eb812fd4 98
JMF 0:24d3eb812fd4 99 #define IS_BLD_LVL(MODE) (MODE == BLD_LVL_2_7_V || \
JMF 0:24d3eb812fd4 100 MODE == BLD_LVL_2_5_V || \
JMF 0:24d3eb812fd4 101 MODE == BLD_LVL_2_3_V || \
JMF 0:24d3eb812fd4 102 MODE == BLD_LVL_2_1_V)
JMF 0:24d3eb812fd4 103
JMF 0:24d3eb812fd4 104
JMF 0:24d3eb812fd4 105 /**
JMF 0:24d3eb812fd4 106 * @brief SPIRIT GmConf enumeration
JMF 0:24d3eb812fd4 107 */
JMF 0:24d3eb812fd4 108
JMF 0:24d3eb812fd4 109 typedef enum
JMF 0:24d3eb812fd4 110 {
JMF 0:24d3eb812fd4 111 GM_SU_13_2 = 0,
JMF 0:24d3eb812fd4 112 GM_SU_18_2,
JMF 0:24d3eb812fd4 113 GM_SU_21_5,
JMF 0:24d3eb812fd4 114 GM_SU_25_6,
JMF 0:24d3eb812fd4 115 GM_SU_28_8,
JMF 0:24d3eb812fd4 116 GM_SU_33_9,
JMF 0:24d3eb812fd4 117 GM_SU_38_5,
JMF 0:24d3eb812fd4 118 GM_SU_43_0
JMF 0:24d3eb812fd4 119 } GmConf;
JMF 0:24d3eb812fd4 120
JMF 0:24d3eb812fd4 121 #define IS_GM_CONF(MODE) (MODE == GM_SU_13_2 || \
JMF 0:24d3eb812fd4 122 MODE == GM_SU_18_2 || \
JMF 0:24d3eb812fd4 123 MODE == GM_SU_21_5 || \
JMF 0:24d3eb812fd4 124 MODE == GM_SU_25_6 || \
JMF 0:24d3eb812fd4 125 MODE == GM_SU_28_8 || \
JMF 0:24d3eb812fd4 126 MODE == GM_SU_33_9 || \
JMF 0:24d3eb812fd4 127 MODE == GM_SU_38_5 || \
JMF 0:24d3eb812fd4 128 MODE == GM_SU_43_0)
JMF 0:24d3eb812fd4 129
JMF 0:24d3eb812fd4 130
JMF 0:24d3eb812fd4 131 /**
JMF 0:24d3eb812fd4 132 * @brief SPIRIT packet type enumeration
JMF 0:24d3eb812fd4 133 */
JMF 0:24d3eb812fd4 134
JMF 0:24d3eb812fd4 135 typedef enum
JMF 0:24d3eb812fd4 136 {
JMF 0:24d3eb812fd4 137 PKT_BASIC = 0x00,
JMF 0:24d3eb812fd4 138 PKT_MBUS = 0x02,
JMF 0:24d3eb812fd4 139 PKT_STACK
JMF 0:24d3eb812fd4 140
JMF 0:24d3eb812fd4 141 } PacketType;
JMF 0:24d3eb812fd4 142
JMF 0:24d3eb812fd4 143 #define IS_PKT_TYPE(TYPE) (TYPE == PKT_BASIC || \
JMF 0:24d3eb812fd4 144 TYPE == PKT_MBUS || \
JMF 0:24d3eb812fd4 145 TYPE == PKT_STACK || \
JMF 0:24d3eb812fd4 146 )
JMF 0:24d3eb812fd4 147
JMF 0:24d3eb812fd4 148
JMF 0:24d3eb812fd4 149 /**
JMF 0:24d3eb812fd4 150 * @brief SPIRIT version type enumeration
JMF 0:24d3eb812fd4 151 */
JMF 0:24d3eb812fd4 152
JMF 0:24d3eb812fd4 153 typedef enum
JMF 0:24d3eb812fd4 154 {
JMF 0:24d3eb812fd4 155 SPIRIT_VERSION_2_1 = 0x01, /* Deprecated */
JMF 0:24d3eb812fd4 156 SPIRIT_VERSION_3_0, /* The only version of SPIRIT1 */
JMF 0:24d3eb812fd4 157 } SpiritVersion;
JMF 0:24d3eb812fd4 158
JMF 0:24d3eb812fd4 159
JMF 0:24d3eb812fd4 160 /**
JMF 0:24d3eb812fd4 161 * @}
JMF 0:24d3eb812fd4 162 */
JMF 0:24d3eb812fd4 163
JMF 0:24d3eb812fd4 164
JMF 0:24d3eb812fd4 165 /**
JMF 0:24d3eb812fd4 166 * @defgroup General_Exported_Constants General Exported Constants
JMF 0:24d3eb812fd4 167 * @{
JMF 0:24d3eb812fd4 168 */
JMF 0:24d3eb812fd4 169
JMF 0:24d3eb812fd4 170
JMF 0:24d3eb812fd4 171 /**
JMF 0:24d3eb812fd4 172 * @}
JMF 0:24d3eb812fd4 173 */
JMF 0:24d3eb812fd4 174
JMF 0:24d3eb812fd4 175
JMF 0:24d3eb812fd4 176 /**
JMF 0:24d3eb812fd4 177 * @defgroup General_Exported_Macros General Exported Macros
JMF 0:24d3eb812fd4 178 * @{
JMF 0:24d3eb812fd4 179 */
JMF 0:24d3eb812fd4 180 #define SpiritGeneralLibraryVersion() "Spirit1_Libraries_v.3.2.0"
JMF 0:24d3eb812fd4 181
JMF 0:24d3eb812fd4 182
JMF 0:24d3eb812fd4 183 /**
JMF 0:24d3eb812fd4 184 * @}
JMF 0:24d3eb812fd4 185 */
JMF 0:24d3eb812fd4 186
JMF 0:24d3eb812fd4 187
JMF 0:24d3eb812fd4 188 /**
JMF 0:24d3eb812fd4 189 * @defgroup General_Exported_Functions General Exported Functions
JMF 0:24d3eb812fd4 190 * @{
JMF 0:24d3eb812fd4 191 */
JMF 0:24d3eb812fd4 192
JMF 0:24d3eb812fd4 193
JMF 0:24d3eb812fd4 194 void SpiritGeneralBatteryLevel(SpiritFunctionalState xNewState);
JMF 0:24d3eb812fd4 195 void SpiritGeneralSetBatteryLevel(BatteryLevel xBatteryLevel);
JMF 0:24d3eb812fd4 196 BatteryLevel SpiritGeneralGetBatteryLevel(void);
JMF 0:24d3eb812fd4 197 void SpiritGeneralBrownOut(SpiritFunctionalState xNewState);
JMF 0:24d3eb812fd4 198 void SpiritGeneralHighPwr(SpiritFunctionalState xNewState);
JMF 0:24d3eb812fd4 199 void SpiritGeneralSetExtRef(ModeExtRef xExtMode);
JMF 0:24d3eb812fd4 200 ModeExtRef SpiritGeneralGetExtRef(void);
JMF 0:24d3eb812fd4 201 void SpiritGeneralSetXoGm(GmConf xGm);
JMF 0:24d3eb812fd4 202 GmConf SpiritGeneralGetXoGm(void);
JMF 0:24d3eb812fd4 203 PacketType SpiritGeneralGetPktType(void);
JMF 0:24d3eb812fd4 204 uint16_t SpiritGeneralGetDevicePartNumber(void);
JMF 0:24d3eb812fd4 205 uint8_t SpiritGeneralGetSpiritVersion(void);
JMF 0:24d3eb812fd4 206
JMF 0:24d3eb812fd4 207 /**
JMF 0:24d3eb812fd4 208 * @}
JMF 0:24d3eb812fd4 209 */
JMF 0:24d3eb812fd4 210
JMF 0:24d3eb812fd4 211 /**
JMF 0:24d3eb812fd4 212 * @}
JMF 0:24d3eb812fd4 213 */
JMF 0:24d3eb812fd4 214
JMF 0:24d3eb812fd4 215
JMF 0:24d3eb812fd4 216 /**
JMF 0:24d3eb812fd4 217 * @}
JMF 0:24d3eb812fd4 218 */
JMF 0:24d3eb812fd4 219
JMF 0:24d3eb812fd4 220
JMF 0:24d3eb812fd4 221 #ifdef __cplusplus
JMF 0:24d3eb812fd4 222 }
JMF 0:24d3eb812fd4 223 #endif
JMF 0:24d3eb812fd4 224
JMF 0:24d3eb812fd4 225 #endif
JMF 0:24d3eb812fd4 226
JMF 0:24d3eb812fd4 227 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/