Added support for the WNC M14A2A Cellular LTE Data Module.

Dependencies:   WNC14A2AInterface

Easy Connect

Easily add all supported connectivity methods to your mbed OS project

This project is derived from https://developer.mbed.org/teams/sandbox/code/simple-mbed-client-example/file/dd6231df71bb/easy-connect.lib. It give user the ability to switch between connectivity methods and includes support for the WNC14A2A Data Module. The `NetworkInterface` API makes this easy, but you still need a mechanism for the user to select the connection method, The selection is made by modifying the `mbed_app.json` file and using `easy_connect()` from your application.

Specifying connectivity method

To add support for the WNC14A2A, add the following to your ``mbed_app.json`` file:

mbed_app.json

{
    "config": {
        "network-interface":{
            "help": "options are ETHERNET,WIFI_ESP8266,WIFI_ODIN,MESH_LOWPAN_ND,MESH_THREAD,WNC14A2A",
            "value": "WNC14A2A"
        }
    },
}

After you choose `WNC14A2A` you'll also need to indicate if you want debug output or not by Enabling (true) or Disabling (false) WNC_DEBUG.

If WNC_DEBUG is enabled, there are 3 different levels of debug output (selected via bit settings). These debug levels are set using the following values:

ValueDescription
1Basic WNC driver debug output
2Comprehensive WNC driver debug output
4Network Layer debug output

You can have any combination of these three bit values for a total value of 0 – 7.

WNC Debug Settings

    "config": {
        "WNC_DEBUG": {
            "value": false
        },
        "WNC_DEBUG_SETTING": {
            "value": 4
        },
    }

Using Easy Connect from your application

Easy Connect has just one function which will either return a `NetworkInterface`-pointer or `NULL`:

Sample Code

#include "easy-connect.h"

int main(int, char**) {
    NetworkInterface* network = easy_connect(true); /* has 1 argument, enable_logging (pass in true to log to serial port) */
    if (!network) {
        printf("Connecting to the network failed... See serial output.\r\n");
        return 1;
    }
 
    // Rest of your program
}

Tested on

  • K64F with Ethernet.
  • AT&T Cellular IoT Starter Kit with WNC M14A2A Cellular Data Module

The WNCInterface class currently supports the following version(s):

  • MPSS: M14A2A_v11.50.164451 APSS: M14A2A_v11.53.164451

License

This library is released under the Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License and may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Committer:
group-Avnet
Date:
Wed Apr 19 01:08:11 2017 +0000
Revision:
0:478cfd88041f
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-Avnet 0:478cfd88041f 1 /**
group-Avnet 0:478cfd88041f 2 ******************************************************************************
group-Avnet 0:478cfd88041f 3 * @file SPIRIT_Timer.h
group-Avnet 0:478cfd88041f 4 * @author VMA division - AMS
group-Avnet 0:478cfd88041f 5 * @version 3.2.2
group-Avnet 0:478cfd88041f 6 * @date 08-July-2015
group-Avnet 0:478cfd88041f 7 * @brief Configuration and management of SPIRIT timers.
group-Avnet 0:478cfd88041f 8 * @details
group-Avnet 0:478cfd88041f 9 *
group-Avnet 0:478cfd88041f 10 * This module provides API to configure the Spirit timing mechanisms.
group-Avnet 0:478cfd88041f 11 * They allow the user to set the timer registers using raw values or
group-Avnet 0:478cfd88041f 12 * compute them since the desired timer value is expressed in ms.
group-Avnet 0:478cfd88041f 13 * Moreover the management of the Spirit LDCR mode can be done using
group-Avnet 0:478cfd88041f 14 * these API.
group-Avnet 0:478cfd88041f 15 *
group-Avnet 0:478cfd88041f 16 * <b>Example:</b>
group-Avnet 0:478cfd88041f 17 * @code
group-Avnet 0:478cfd88041f 18 * ...
group-Avnet 0:478cfd88041f 19 *
group-Avnet 0:478cfd88041f 20 * SpiritTimerSetRxTimeoutMs(50.0);
group-Avnet 0:478cfd88041f 21 * SpiritTimerSetWakeUpTimerMs(150.0);
group-Avnet 0:478cfd88041f 22 *
group-Avnet 0:478cfd88041f 23 * // IRQ configuration for RX_TIMEOUT and WAKEUP_TIMEOUT
group-Avnet 0:478cfd88041f 24 * ...
group-Avnet 0:478cfd88041f 25 *
group-Avnet 0:478cfd88041f 26 * SpiritTimerLdcrMode(S_ENABLE);
group-Avnet 0:478cfd88041f 27 *
group-Avnet 0:478cfd88041f 28 * ...
group-Avnet 0:478cfd88041f 29 *
group-Avnet 0:478cfd88041f 30 * @endcode
group-Avnet 0:478cfd88041f 31 *
group-Avnet 0:478cfd88041f 32 *
group-Avnet 0:478cfd88041f 33 * @attention
group-Avnet 0:478cfd88041f 34 *
group-Avnet 0:478cfd88041f 35 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
group-Avnet 0:478cfd88041f 36 *
group-Avnet 0:478cfd88041f 37 * Redistribution and use in source and binary forms, with or without modification,
group-Avnet 0:478cfd88041f 38 * are permitted provided that the following conditions are met:
group-Avnet 0:478cfd88041f 39 * 1. Redistributions of source code must retain the above copyright notice,
group-Avnet 0:478cfd88041f 40 * this list of conditions and the following disclaimer.
group-Avnet 0:478cfd88041f 41 * 2. Redistributions in binary form must reproduce the above copyright notice,
group-Avnet 0:478cfd88041f 42 * this list of conditions and the following disclaimer in the documentation
group-Avnet 0:478cfd88041f 43 * and/or other materials provided with the distribution.
group-Avnet 0:478cfd88041f 44 * 3. Neither the name of STMicroelectronics nor the names of its contributors
group-Avnet 0:478cfd88041f 45 * may be used to endorse or promote products derived from this software
group-Avnet 0:478cfd88041f 46 * without specific prior written permission.
group-Avnet 0:478cfd88041f 47 *
group-Avnet 0:478cfd88041f 48 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
group-Avnet 0:478cfd88041f 49 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
group-Avnet 0:478cfd88041f 50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
group-Avnet 0:478cfd88041f 51 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
group-Avnet 0:478cfd88041f 52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
group-Avnet 0:478cfd88041f 53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
group-Avnet 0:478cfd88041f 54 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
group-Avnet 0:478cfd88041f 55 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
group-Avnet 0:478cfd88041f 56 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
group-Avnet 0:478cfd88041f 57 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
group-Avnet 0:478cfd88041f 58 *
group-Avnet 0:478cfd88041f 59 ******************************************************************************
group-Avnet 0:478cfd88041f 60 */
group-Avnet 0:478cfd88041f 61
group-Avnet 0:478cfd88041f 62 /* Define to prevent recursive inclusion -------------------------------------*/
group-Avnet 0:478cfd88041f 63 #ifndef __SPIRIT1_TIMER_H
group-Avnet 0:478cfd88041f 64 #define __SPIRIT1_TIMER_H
group-Avnet 0:478cfd88041f 65
group-Avnet 0:478cfd88041f 66
group-Avnet 0:478cfd88041f 67 /* Includes ------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 68
group-Avnet 0:478cfd88041f 69 #include "SPIRIT_Regs.h"
group-Avnet 0:478cfd88041f 70 #include "SPIRIT_Types.h"
group-Avnet 0:478cfd88041f 71
group-Avnet 0:478cfd88041f 72
group-Avnet 0:478cfd88041f 73 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 74 extern "C" {
group-Avnet 0:478cfd88041f 75 #endif
group-Avnet 0:478cfd88041f 76
group-Avnet 0:478cfd88041f 77
group-Avnet 0:478cfd88041f 78 /**
group-Avnet 0:478cfd88041f 79 * @addtogroup SPIRIT_Libraries
group-Avnet 0:478cfd88041f 80 * @{
group-Avnet 0:478cfd88041f 81 */
group-Avnet 0:478cfd88041f 82
group-Avnet 0:478cfd88041f 83
group-Avnet 0:478cfd88041f 84 /**
group-Avnet 0:478cfd88041f 85 * @defgroup SPIRIT_Timer Timer
group-Avnet 0:478cfd88041f 86 * @brief Configuration and management of SPIRIT Timers.
group-Avnet 0:478cfd88041f 87 * @details See the file <i>@ref SPIRIT_Timer.h</i> for more details.
group-Avnet 0:478cfd88041f 88 * @{
group-Avnet 0:478cfd88041f 89 */
group-Avnet 0:478cfd88041f 90
group-Avnet 0:478cfd88041f 91
group-Avnet 0:478cfd88041f 92 /**
group-Avnet 0:478cfd88041f 93 * @defgroup Timer_Exported_Types Timer Exported Types
group-Avnet 0:478cfd88041f 94 * @{
group-Avnet 0:478cfd88041f 95 */
group-Avnet 0:478cfd88041f 96
group-Avnet 0:478cfd88041f 97 /**
group-Avnet 0:478cfd88041f 98 * @brief All the possible RX timeout stop conditions enumeration.
group-Avnet 0:478cfd88041f 99 */
group-Avnet 0:478cfd88041f 100 typedef enum{
group-Avnet 0:478cfd88041f 101
group-Avnet 0:478cfd88041f 102 NO_TIMEOUT_STOP = 0x00, /*!< Timeout never stopped */
group-Avnet 0:478cfd88041f 103 TIMEOUT_ALWAYS_STOPPED = 0x08, /*!< Timeout always stopped (default) */
group-Avnet 0:478cfd88041f 104 RSSI_ABOVE_THRESHOLD = 0x04, /*!< Timeout stopped on RSSI above threshold */
group-Avnet 0:478cfd88041f 105 SQI_ABOVE_THRESHOLD = 0x02, /*!< Timeout stopped on SQI above threshold */
group-Avnet 0:478cfd88041f 106 PQI_ABOVE_THRESHOLD = 0x01, /*!< Timeout stopped on PQI above threshold */
group-Avnet 0:478cfd88041f 107 RSSI_AND_SQI_ABOVE_THRESHOLD = 0x06, /*!< Timeout stopped on both RSSI and SQI above threshold */
group-Avnet 0:478cfd88041f 108 RSSI_AND_PQI_ABOVE_THRESHOLD = 0x05, /*!< Timeout stopped on both RSSI and PQI above threshold */
group-Avnet 0:478cfd88041f 109 SQI_AND_PQI_ABOVE_THRESHOLD = 0x03, /*!< Timeout stopped on both SQI and PQI above threshold */
group-Avnet 0:478cfd88041f 110 ALL_ABOVE_THRESHOLD = 0x07, /*!< Timeout stopped only if RSSI, SQI and PQI are above threshold */
group-Avnet 0:478cfd88041f 111 RSSI_OR_SQI_ABOVE_THRESHOLD = 0x0E, /*!< Timeout stopped if one between RSSI or SQI are above threshold */
group-Avnet 0:478cfd88041f 112 RSSI_OR_PQI_ABOVE_THRESHOLD = 0x0D, /*!< Timeout stopped if one between RSSI or PQI are above threshold */
group-Avnet 0:478cfd88041f 113 SQI_OR_PQI_ABOVE_THRESHOLD = 0x0B, /*!< Timeout stopped if one between SQI or PQI are above threshold */
group-Avnet 0:478cfd88041f 114 ANY_ABOVE_THRESHOLD = 0x0F /*!< Timeout stopped if one among RSSI, SQI or SQI are above threshold */
group-Avnet 0:478cfd88041f 115
group-Avnet 0:478cfd88041f 116 } RxTimeoutStopCondition;
group-Avnet 0:478cfd88041f 117
group-Avnet 0:478cfd88041f 118
group-Avnet 0:478cfd88041f 119 #define IS_RX_TIMEOUT_STOP_CONDITION(COND) ( COND == NO_TIMEOUT_STOP || \
group-Avnet 0:478cfd88041f 120 COND == TIMEOUT_ALWAYS_STOPPED || \
group-Avnet 0:478cfd88041f 121 COND == RSSI_ABOVE_THRESHOLD || \
group-Avnet 0:478cfd88041f 122 COND == SQI_ABOVE_THRESHOLD || \
group-Avnet 0:478cfd88041f 123 COND == PQI_ABOVE_THRESHOLD || \
group-Avnet 0:478cfd88041f 124 COND == RSSI_AND_SQI_ABOVE_THRESHOLD || \
group-Avnet 0:478cfd88041f 125 COND == RSSI_AND_PQI_ABOVE_THRESHOLD || \
group-Avnet 0:478cfd88041f 126 COND == SQI_AND_PQI_ABOVE_THRESHOLD || \
group-Avnet 0:478cfd88041f 127 COND == ALL_ABOVE_THRESHOLD || \
group-Avnet 0:478cfd88041f 128 COND == RSSI_OR_SQI_ABOVE_THRESHOLD || \
group-Avnet 0:478cfd88041f 129 COND == RSSI_OR_PQI_ABOVE_THRESHOLD || \
group-Avnet 0:478cfd88041f 130 COND == SQI_OR_PQI_ABOVE_THRESHOLD || \
group-Avnet 0:478cfd88041f 131 COND == ANY_ABOVE_THRESHOLD )
group-Avnet 0:478cfd88041f 132
group-Avnet 0:478cfd88041f 133
group-Avnet 0:478cfd88041f 134
group-Avnet 0:478cfd88041f 135 /**
group-Avnet 0:478cfd88041f 136 * @}
group-Avnet 0:478cfd88041f 137 */
group-Avnet 0:478cfd88041f 138
group-Avnet 0:478cfd88041f 139
group-Avnet 0:478cfd88041f 140 /**
group-Avnet 0:478cfd88041f 141 * @defgroup Timer_Exported_Constants Timer Exported Constants
group-Avnet 0:478cfd88041f 142 * @{
group-Avnet 0:478cfd88041f 143 */
group-Avnet 0:478cfd88041f 144
group-Avnet 0:478cfd88041f 145 /**
group-Avnet 0:478cfd88041f 146 * @brief It represents the Time Step for RX_Timeout timer in case of 24 MHz Crystal, expressed in us.
group-Avnet 0:478cfd88041f 147 * It is equal to 1210/(24*10^6). With this time step it is possible to fix the RX_Timeout to
group-Avnet 0:478cfd88041f 148 * a minimum value of 50.417us to a maximum value of about 3.278 s.
group-Avnet 0:478cfd88041f 149 * Remember that it is possible to have infinite RX_Timeout writing 0 in the RX_Timeout_Counter and/or RX_Timeout_Prescaler registers.
group-Avnet 0:478cfd88041f 150 */
group-Avnet 0:478cfd88041f 151 #define RX_TCLK_24MHz 50.417f
group-Avnet 0:478cfd88041f 152 #define IS_RX_TIMEOUT_24MHz(TIMEOUT) (TIMEOUT*1000)>=RX_TCLK_24MHz
group-Avnet 0:478cfd88041f 153
group-Avnet 0:478cfd88041f 154 /**
group-Avnet 0:478cfd88041f 155 * @brief It represents the Time Step for RX_Timeout timer in case of 26 MHz Crystal, expressed in us.
group-Avnet 0:478cfd88041f 156 * It is equal to 1210/(26*10^6). With this time step it is possible to fix the RX_Timeout to
group-Avnet 0:478cfd88041f 157 * a minimum value of 46.538us to a maximum value of about 3.026 s.
group-Avnet 0:478cfd88041f 158 * Remember that it is possible to have infinite RX_Timeout writing 0 in the RX_Timeout_Counter register.
group-Avnet 0:478cfd88041f 159 */
group-Avnet 0:478cfd88041f 160 #define RX_TCLK_26MHz 46.538f
group-Avnet 0:478cfd88041f 161 #define IS_RX_TIMEOUT_26MHz(TIMEOUT) (TIMEOUT*1000)>=RX_TCLK_26MHz
group-Avnet 0:478cfd88041f 162
group-Avnet 0:478cfd88041f 163 /**
group-Avnet 0:478cfd88041f 164 * @brief It represents the Time Step for RX_Wakeup timer expressed in us. This timer is based on RCO (about 34.7 kHZ).
group-Avnet 0:478cfd88041f 165 * With this time step it is possible to fix the Wakeup_Timeout to a minimum value of 28.818us to a maximum
group-Avnet 0:478cfd88041f 166 * value of about 1.888 s.
group-Avnet 0:478cfd88041f 167 */
group-Avnet 0:478cfd88041f 168 #define WAKEUP_TCLK 28.818f
group-Avnet 0:478cfd88041f 169 #define IS_WKUP_TIMEOUT(TIMEOUT) (TIMEOUT*1000)>=WAKEUP_TCLK
group-Avnet 0:478cfd88041f 170
group-Avnet 0:478cfd88041f 171
group-Avnet 0:478cfd88041f 172
group-Avnet 0:478cfd88041f 173 /**
group-Avnet 0:478cfd88041f 174 * @}
group-Avnet 0:478cfd88041f 175 */
group-Avnet 0:478cfd88041f 176
group-Avnet 0:478cfd88041f 177
group-Avnet 0:478cfd88041f 178 /**
group-Avnet 0:478cfd88041f 179 * @defgroup Timer_Exported_Macros Timer Exported Macros
group-Avnet 0:478cfd88041f 180 * @{
group-Avnet 0:478cfd88041f 181 */
group-Avnet 0:478cfd88041f 182
group-Avnet 0:478cfd88041f 183 #define SET_INFINITE_RX_TIMEOUT() SpiritTimerSetRxTimeoutCounter(0)
group-Avnet 0:478cfd88041f 184
group-Avnet 0:478cfd88041f 185 /**
group-Avnet 0:478cfd88041f 186 * @}
group-Avnet 0:478cfd88041f 187 */
group-Avnet 0:478cfd88041f 188
group-Avnet 0:478cfd88041f 189
group-Avnet 0:478cfd88041f 190 /**
group-Avnet 0:478cfd88041f 191 * @defgroup Timer_Exported_Functions Timer Exported Functions
group-Avnet 0:478cfd88041f 192 * @{
group-Avnet 0:478cfd88041f 193 */
group-Avnet 0:478cfd88041f 194
group-Avnet 0:478cfd88041f 195 void SpiritTimerLdcrMode(SpiritFunctionalState xNewState);
group-Avnet 0:478cfd88041f 196 void SpiritTimerLdcrAutoReload(SpiritFunctionalState xNewState);
group-Avnet 0:478cfd88041f 197 SpiritFunctionalState SpiritTimerLdcrGetAutoReload(void);
group-Avnet 0:478cfd88041f 198 void SpiritTimerSetRxTimeout(uint8_t cCounter , uint8_t cPrescaler);
group-Avnet 0:478cfd88041f 199 void SpiritTimerSetRxTimeoutMs(float fDesiredMsec);
group-Avnet 0:478cfd88041f 200 void SpiritTimerSetRxTimeoutCounter(uint8_t cCounter);
group-Avnet 0:478cfd88041f 201 void SpiritTimerSetRxTimeoutPrescaler(uint8_t cPrescaler);
group-Avnet 0:478cfd88041f 202 void SpiritTimerGetRxTimeout(float* pfTimeoutMsec, uint8_t* pcCounter , uint8_t* pcPrescaler);
group-Avnet 0:478cfd88041f 203 void SpiritTimerSetWakeUpTimer(uint8_t cCounter , uint8_t cPrescaler);
group-Avnet 0:478cfd88041f 204 void SpiritTimerSetWakeUpTimerMs(float fDesiredMsec);
group-Avnet 0:478cfd88041f 205 void SpiritTimerSetWakeUpTimerCounter(uint8_t cCounter);
group-Avnet 0:478cfd88041f 206 void SpiritTimerSetWakeUpTimerPrescaler(uint8_t cPrescaler);
group-Avnet 0:478cfd88041f 207 void SpiritTimerSetWakeUpTimerReloadMs(float fDesiredMsec);
group-Avnet 0:478cfd88041f 208 void SpiritTimerGetWakeUpTimer(float* pfWakeUpMsec, uint8_t* pcCounter , uint8_t* pcPrescaler);
group-Avnet 0:478cfd88041f 209 void SpiritTimerSetWakeUpTimerReload(uint8_t cCounter , uint8_t cPrescaler);
group-Avnet 0:478cfd88041f 210 void SpiritTimerSetWakeUpTimerReloadCounter(uint8_t cCounter);
group-Avnet 0:478cfd88041f 211 void SpiritTimerSetWakeUpTimerReloadPrescaler(uint8_t cPrescaler);
group-Avnet 0:478cfd88041f 212 void SpiritTimerGetWakeUpTimerReload(float* pfWakeUpReloadMsec, uint8_t* pcCounter , uint8_t* pcPrescaler);
group-Avnet 0:478cfd88041f 213 void SpiritTimerComputeWakeUpValues(float fDesiredMsec , uint8_t* pcCounter , uint8_t* pcPrescaler);
group-Avnet 0:478cfd88041f 214 void SpiritTimerComputeRxTimeoutValues(float fDesiredMsec , uint8_t* pcCounter , uint8_t* pcPrescaler);
group-Avnet 0:478cfd88041f 215 void SpiritTimerSetRxTimeoutStopCondition(RxTimeoutStopCondition xStopCondition);
group-Avnet 0:478cfd88041f 216 void SpiritTimerReloadStrobe(void);
group-Avnet 0:478cfd88041f 217 uint16_t SpiritTimerGetRcoFrequency(void);
group-Avnet 0:478cfd88041f 218
group-Avnet 0:478cfd88041f 219 /**
group-Avnet 0:478cfd88041f 220 * @}
group-Avnet 0:478cfd88041f 221 */
group-Avnet 0:478cfd88041f 222
group-Avnet 0:478cfd88041f 223 /**
group-Avnet 0:478cfd88041f 224 * @}
group-Avnet 0:478cfd88041f 225 */
group-Avnet 0:478cfd88041f 226
group-Avnet 0:478cfd88041f 227
group-Avnet 0:478cfd88041f 228 /**
group-Avnet 0:478cfd88041f 229 * @}
group-Avnet 0:478cfd88041f 230 */
group-Avnet 0:478cfd88041f 231
group-Avnet 0:478cfd88041f 232 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 233 }
group-Avnet 0:478cfd88041f 234 #endif
group-Avnet 0:478cfd88041f 235
group-Avnet 0:478cfd88041f 236 #endif
group-Avnet 0:478cfd88041f 237
group-Avnet 0:478cfd88041f 238 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/
group-Avnet 0:478cfd88041f 239