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_Calibration.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 VCO-RCO calibration.
group-Avnet 0:478cfd88041f 8 *
group-Avnet 0:478cfd88041f 9 * @details
group-Avnet 0:478cfd88041f 10 *
group-Avnet 0:478cfd88041f 11 * This module allows the user to set some parameters which deal
group-Avnet 0:478cfd88041f 12 * with the oscillators calibration.
group-Avnet 0:478cfd88041f 13 * The state machine of Spirit contemplates some optional calibrating operations
group-Avnet 0:478cfd88041f 14 * in the transition between the READY and the LOCK state.
group-Avnet 0:478cfd88041f 15 * The user is allowed to enable or disable the automatic RCO/VCO calibration
group-Avnet 0:478cfd88041f 16 * by calling the functions <i>@ref SpiritCalibrationVco()</i> and <i>@ref SpiritCalibrationRco()</i>.
group-Avnet 0:478cfd88041f 17 * The following example shows how to do an initial calibration of VCO.
group-Avnet 0:478cfd88041f 18 *
group-Avnet 0:478cfd88041f 19 * <b>Example:</b>
group-Avnet 0:478cfd88041f 20 * @code
group-Avnet 0:478cfd88041f 21 * uint8_t calData;
group-Avnet 0:478cfd88041f 22 *
group-Avnet 0:478cfd88041f 23 * SpiritCalibrationVco(S_ENABLE);
group-Avnet 0:478cfd88041f 24 * SpiritCmdStrobeLockTx();
group-Avnet 0:478cfd88041f 25 *
group-Avnet 0:478cfd88041f 26 * while(g_xStatus.MC_STATE != MC_STATE_LOCK){
group-Avnet 0:478cfd88041f 27 * SpiritRefreshStatus();
group-Avnet 0:478cfd88041f 28 * }
group-Avnet 0:478cfd88041f 29 *
group-Avnet 0:478cfd88041f 30 * calData = SpiritCalibrationGetVcoCalDataTx();
group-Avnet 0:478cfd88041f 31 * SpiritCalibrationSetVcoCalDataTx(calData);
group-Avnet 0:478cfd88041f 32 *
group-Avnet 0:478cfd88041f 33 * SpiritCmdStrobeReady();
group-Avnet 0:478cfd88041f 34 * SpiritCalibrationVco(S_DISABLE);
group-Avnet 0:478cfd88041f 35 *
group-Avnet 0:478cfd88041f 36 * @endcode
group-Avnet 0:478cfd88041f 37 *
group-Avnet 0:478cfd88041f 38 * Similar operations can be done for the RCO calibrator.
group-Avnet 0:478cfd88041f 39 *
group-Avnet 0:478cfd88041f 40 * @attention
group-Avnet 0:478cfd88041f 41 *
group-Avnet 0:478cfd88041f 42 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
group-Avnet 0:478cfd88041f 43 *
group-Avnet 0:478cfd88041f 44 * Redistribution and use in source and binary forms, with or without modification,
group-Avnet 0:478cfd88041f 45 * are permitted provided that the following conditions are met:
group-Avnet 0:478cfd88041f 46 * 1. Redistributions of source code must retain the above copyright notice,
group-Avnet 0:478cfd88041f 47 * this list of conditions and the following disclaimer.
group-Avnet 0:478cfd88041f 48 * 2. Redistributions in binary form must reproduce the above copyright notice,
group-Avnet 0:478cfd88041f 49 * this list of conditions and the following disclaimer in the documentation
group-Avnet 0:478cfd88041f 50 * and/or other materials provided with the distribution.
group-Avnet 0:478cfd88041f 51 * 3. Neither the name of STMicroelectronics nor the names of its contributors
group-Avnet 0:478cfd88041f 52 * may be used to endorse or promote products derived from this software
group-Avnet 0:478cfd88041f 53 * without specific prior written permission.
group-Avnet 0:478cfd88041f 54 *
group-Avnet 0:478cfd88041f 55 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
group-Avnet 0:478cfd88041f 56 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
group-Avnet 0:478cfd88041f 57 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
group-Avnet 0:478cfd88041f 58 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
group-Avnet 0:478cfd88041f 59 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
group-Avnet 0:478cfd88041f 60 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
group-Avnet 0:478cfd88041f 61 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
group-Avnet 0:478cfd88041f 62 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
group-Avnet 0:478cfd88041f 63 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
group-Avnet 0:478cfd88041f 64 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
group-Avnet 0:478cfd88041f 65 *
group-Avnet 0:478cfd88041f 66 ******************************************************************************
group-Avnet 0:478cfd88041f 67 */
group-Avnet 0:478cfd88041f 68
group-Avnet 0:478cfd88041f 69 /* Define to prevent recursive inclusion -------------------------------------*/
group-Avnet 0:478cfd88041f 70 #ifndef __SPIRIT_CALIBRATION_H
group-Avnet 0:478cfd88041f 71 #define __SPIRIT_CALIBRATION_H
group-Avnet 0:478cfd88041f 72
group-Avnet 0:478cfd88041f 73
group-Avnet 0:478cfd88041f 74 /* Includes ------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 75
group-Avnet 0:478cfd88041f 76 #include "SPIRIT_Regs.h"
group-Avnet 0:478cfd88041f 77 #include "SPIRIT_Types.h"
group-Avnet 0:478cfd88041f 78
group-Avnet 0:478cfd88041f 79
group-Avnet 0:478cfd88041f 80 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 81 extern "C" {
group-Avnet 0:478cfd88041f 82 #endif
group-Avnet 0:478cfd88041f 83
group-Avnet 0:478cfd88041f 84
group-Avnet 0:478cfd88041f 85 /**
group-Avnet 0:478cfd88041f 86 * @addtogroup SPIRIT_Libraries
group-Avnet 0:478cfd88041f 87 * @{
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 * @defgroup SPIRIT_Calibration Calibration
group-Avnet 0:478cfd88041f 93 * @brief Configuration and management of SPIRIT VCO-RCO calibration.
group-Avnet 0:478cfd88041f 94 * @details See the file <i>@ref SPIRIT_Calibration.h</i> for more details.
group-Avnet 0:478cfd88041f 95 * @{
group-Avnet 0:478cfd88041f 96 */
group-Avnet 0:478cfd88041f 97
group-Avnet 0:478cfd88041f 98 /**
group-Avnet 0:478cfd88041f 99 * @defgroup Calibration_Exported_Types Calibration Exported Types
group-Avnet 0:478cfd88041f 100 * @{
group-Avnet 0:478cfd88041f 101 */
group-Avnet 0:478cfd88041f 102
group-Avnet 0:478cfd88041f 103
group-Avnet 0:478cfd88041f 104 /**
group-Avnet 0:478cfd88041f 105 * @brief VCO / RCO calibration window.
group-Avnet 0:478cfd88041f 106 */
group-Avnet 0:478cfd88041f 107 typedef enum
group-Avnet 0:478cfd88041f 108 {
group-Avnet 0:478cfd88041f 109
group-Avnet 0:478cfd88041f 110 CALIB_TIME_7_33_US_24MHZ = 0x00, /*!< calibration window of 7.33 us with XTAL=24MHz */
group-Avnet 0:478cfd88041f 111 CALIB_TIME_14_67_US_24MHZ, /*!< calibration window of 14.67 us with XTAL=24MHz */
group-Avnet 0:478cfd88041f 112 CALIB_TIME_29_33_US_24MHZ, /*!< calibration window of 29.33 us with XTAL=24MHz */
group-Avnet 0:478cfd88041f 113 CALIB_TIME_58_67_US_24MHZ, /*!< calibration window of 58.67 us with XTAL=24MHz */
group-Avnet 0:478cfd88041f 114
group-Avnet 0:478cfd88041f 115 CALIB_TIME_6_77_US_26MHZ = 0x00, /*!< calibration window of 6.77 us with XTAL=26MHz */
group-Avnet 0:478cfd88041f 116 CALIB_TIME_13_54_US_26MHZ, /*!< calibration window of 13.54 us with XTAL=26MHz */
group-Avnet 0:478cfd88041f 117 CALIB_TIME_27_08_US_26MHZ, /*!< calibration window of 27.08 us with XTAL=26MHz */
group-Avnet 0:478cfd88041f 118 CALIB_TIME_54_15_US_26MHZ /*!< calibration window of 54.15 us with XTAL=26MHz */
group-Avnet 0:478cfd88041f 119
group-Avnet 0:478cfd88041f 120 } VcoWin;
group-Avnet 0:478cfd88041f 121
group-Avnet 0:478cfd88041f 122
group-Avnet 0:478cfd88041f 123 #define IS_VCO_WIN(REF) (REF == CALIB_TIME_7_33_US_24MHZ ||\
group-Avnet 0:478cfd88041f 124 REF == CALIB_TIME_14_67_US_24MHZ ||\
group-Avnet 0:478cfd88041f 125 REF == CALIB_TIME_29_33_US_24MHZ ||\
group-Avnet 0:478cfd88041f 126 REF == CALIB_TIME_58_67_US_24MHZ ||\
group-Avnet 0:478cfd88041f 127 REF == CALIB_TIME_6_77_US_26MHZ ||\
group-Avnet 0:478cfd88041f 128 REF == CALIB_TIME_13_54_US_26MHZ ||\
group-Avnet 0:478cfd88041f 129 REF == CALIB_TIME_27_08_US_26MHZ ||\
group-Avnet 0:478cfd88041f 130 REF == CALIB_TIME_54_15_US_26MHZ \
group-Avnet 0:478cfd88041f 131 )
group-Avnet 0:478cfd88041f 132
group-Avnet 0:478cfd88041f 133 /**
group-Avnet 0:478cfd88041f 134 * @brief VCO_H / VCO_L selection.
group-Avnet 0:478cfd88041f 135 */
group-Avnet 0:478cfd88041f 136 typedef enum
group-Avnet 0:478cfd88041f 137 {
group-Avnet 0:478cfd88041f 138
group-Avnet 0:478cfd88041f 139 VCO_L = 0x00, /*!< VCO lower */
group-Avnet 0:478cfd88041f 140 VCO_H, /*!< VCO higher */
group-Avnet 0:478cfd88041f 141 } VcoSel;
group-Avnet 0:478cfd88041f 142
group-Avnet 0:478cfd88041f 143
group-Avnet 0:478cfd88041f 144 #define IS_VCO_SEL(REF) (REF == VCO_L ||\
group-Avnet 0:478cfd88041f 145 REF == VCO_H \
group-Avnet 0:478cfd88041f 146 )
group-Avnet 0:478cfd88041f 147
group-Avnet 0:478cfd88041f 148
group-Avnet 0:478cfd88041f 149 /**
group-Avnet 0:478cfd88041f 150 * @}
group-Avnet 0:478cfd88041f 151 */
group-Avnet 0:478cfd88041f 152
group-Avnet 0:478cfd88041f 153
group-Avnet 0:478cfd88041f 154 /**
group-Avnet 0:478cfd88041f 155 * @defgroup Calibration_Exported_Constants Calibration Exported Constants
group-Avnet 0:478cfd88041f 156 * @{
group-Avnet 0:478cfd88041f 157 */
group-Avnet 0:478cfd88041f 158
group-Avnet 0:478cfd88041f 159 /**
group-Avnet 0:478cfd88041f 160 * @}
group-Avnet 0:478cfd88041f 161 */
group-Avnet 0:478cfd88041f 162
group-Avnet 0:478cfd88041f 163
group-Avnet 0:478cfd88041f 164
group-Avnet 0:478cfd88041f 165 /** @defgroup VCO_Calibration VCO Calibration
group-Avnet 0:478cfd88041f 166 * @{
group-Avnet 0:478cfd88041f 167 */
group-Avnet 0:478cfd88041f 168
group-Avnet 0:478cfd88041f 169 /**
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 * @defgroup Calibration_Exported_Macros Calibration Exported Macros
group-Avnet 0:478cfd88041f 178 * @{
group-Avnet 0:478cfd88041f 179 */
group-Avnet 0:478cfd88041f 180
group-Avnet 0:478cfd88041f 181
group-Avnet 0:478cfd88041f 182 /**
group-Avnet 0:478cfd88041f 183 * @}
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 * @defgroup Calibration_Exported_Functions Calibration Exported Functions
group-Avnet 0:478cfd88041f 189 * @{
group-Avnet 0:478cfd88041f 190 */
group-Avnet 0:478cfd88041f 191
group-Avnet 0:478cfd88041f 192 void SpiritCalibrationRco(SpiritFunctionalState xNewState);
group-Avnet 0:478cfd88041f 193 void SpiritCalibrationVco(SpiritFunctionalState xNewState);
group-Avnet 0:478cfd88041f 194 void SpiritCalibrationSetRcoCalWords(uint8_t cRwt, uint8_t cRfb);
group-Avnet 0:478cfd88041f 195 void SpiritCalibrationGetRcoCalWords(uint8_t* pcRwt, uint8_t* pcRfb);
group-Avnet 0:478cfd88041f 196 uint8_t SpiritCalibrationGetVcoCalData(void);
group-Avnet 0:478cfd88041f 197 void SpiritCalibrationSetVcoCalDataTx(uint8_t cVcoCalData);
group-Avnet 0:478cfd88041f 198 uint8_t SpiritCalibrationGetVcoCalDataTx(void);
group-Avnet 0:478cfd88041f 199 void SpiritCalibrationSetVcoCalDataRx(uint8_t cVcoCalData);
group-Avnet 0:478cfd88041f 200 uint8_t SpiritCalibrationGetVcoCalDataRx(void);
group-Avnet 0:478cfd88041f 201 void SpiritCalibrationSetVcoWindow(VcoWin xRefWord);
group-Avnet 0:478cfd88041f 202 VcoWin SpiritCalibrationGetVcoWindow(void);
group-Avnet 0:478cfd88041f 203 VcoSel SpiritCalibrationGetVcoSelecttion(void);
group-Avnet 0:478cfd88041f 204 void SpiritCalibrationSelectVco(VcoSel xVco);
group-Avnet 0:478cfd88041f 205
group-Avnet 0:478cfd88041f 206 /**
group-Avnet 0:478cfd88041f 207 * @}
group-Avnet 0:478cfd88041f 208 */
group-Avnet 0:478cfd88041f 209
group-Avnet 0:478cfd88041f 210
group-Avnet 0:478cfd88041f 211 /**
group-Avnet 0:478cfd88041f 212 * @}
group-Avnet 0:478cfd88041f 213 */
group-Avnet 0:478cfd88041f 214
group-Avnet 0:478cfd88041f 215
group-Avnet 0:478cfd88041f 216 /**
group-Avnet 0:478cfd88041f 217 * @}
group-Avnet 0:478cfd88041f 218 */
group-Avnet 0:478cfd88041f 219
group-Avnet 0:478cfd88041f 220 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 221 }
group-Avnet 0:478cfd88041f 222 #endif
group-Avnet 0:478cfd88041f 223
group-Avnet 0:478cfd88041f 224 #endif
group-Avnet 0:478cfd88041f 225
group-Avnet 0:478cfd88041f 226 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/