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 * @file MCU_Interface.h
group-Avnet 0:478cfd88041f 3 * @author VMA division - AMS
group-Avnet 0:478cfd88041f 4 * @version V2.0.2
group-Avnet 0:478cfd88041f 5 * @date Febrary 7, 2015
group-Avnet 0:478cfd88041f 6 * @brief Header file for low level SPIRIT SPI driver.
group-Avnet 0:478cfd88041f 7 * @details
group-Avnet 0:478cfd88041f 8 *
group-Avnet 0:478cfd88041f 9 * This header file constitutes an interface to the SPI driver used to
group-Avnet 0:478cfd88041f 10 * communicate with Spirit.
group-Avnet 0:478cfd88041f 11 * It exports some function prototypes to write/read registers and FIFOs
group-Avnet 0:478cfd88041f 12 * and to send command strobes.
group-Avnet 0:478cfd88041f 13 * Since the Spirit libraries are totally platform independent, the implementation
group-Avnet 0:478cfd88041f 14 * of these functions are not provided here. The user have to implement these functions
group-Avnet 0:478cfd88041f 15 * taking care to keep the exported prototypes.
group-Avnet 0:478cfd88041f 16 *
group-Avnet 0:478cfd88041f 17 * These functions are:
group-Avnet 0:478cfd88041f 18 *
group-Avnet 0:478cfd88041f 19 * <ul>
group-Avnet 0:478cfd88041f 20 * <li>SpiritSpiInit</i>
group-Avnet 0:478cfd88041f 21 * <li>SpiritSpiWriteRegisters</i>
group-Avnet 0:478cfd88041f 22 * <li>SpiritSpiReadRegisters</i>
group-Avnet 0:478cfd88041f 23 * <li>SpiritSpiCommandStrobes</i>
group-Avnet 0:478cfd88041f 24 * <li>SpiritSpiWriteLinearFifo</i>
group-Avnet 0:478cfd88041f 25 * <li>SpiritSpiReadLinearFifo</i>
group-Avnet 0:478cfd88041f 26 * </ul>
group-Avnet 0:478cfd88041f 27 *
group-Avnet 0:478cfd88041f 28 * @note An example of SPI driver implementation is available in the <i>Sdk_Eval</i> library.
group-Avnet 0:478cfd88041f 29 *
group-Avnet 0:478cfd88041f 30 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
group-Avnet 0:478cfd88041f 31 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
group-Avnet 0:478cfd88041f 32 * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
group-Avnet 0:478cfd88041f 33 * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
group-Avnet 0:478cfd88041f 34 * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
group-Avnet 0:478cfd88041f 35 * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
group-Avnet 0:478cfd88041f 36 *
group-Avnet 0:478cfd88041f 37 * THIS SOURCE CODE IS PROTECTED BY A LICENSE.
group-Avnet 0:478cfd88041f 38 * FOR MORE INFORMATION PLEASE CAREFULLY READ THE LICENSE AGREEMENT FILE LOCATED
group-Avnet 0:478cfd88041f 39 * IN THE ROOT DIRECTORY OF THIS FIRMWARE PACKAGE.
group-Avnet 0:478cfd88041f 40 *
group-Avnet 0:478cfd88041f 41 * <h2><center>&copy; COPYRIGHT 2015 STMicroelectronics</center></h2>
group-Avnet 0:478cfd88041f 42 */
group-Avnet 0:478cfd88041f 43
group-Avnet 0:478cfd88041f 44
group-Avnet 0:478cfd88041f 45 /* Define to prevent recursive inclusion -------------------------------------*/
group-Avnet 0:478cfd88041f 46 #ifndef __MCU_INTERFACE_H
group-Avnet 0:478cfd88041f 47 #define __MCU_INTERFACE_H
group-Avnet 0:478cfd88041f 48
group-Avnet 0:478cfd88041f 49
group-Avnet 0:478cfd88041f 50 /* Includes ------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 51 #include "SPIRIT_Types.h"
group-Avnet 0:478cfd88041f 52
group-Avnet 0:478cfd88041f 53
group-Avnet 0:478cfd88041f 54 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 55 extern "C" {
group-Avnet 0:478cfd88041f 56 #endif
group-Avnet 0:478cfd88041f 57
group-Avnet 0:478cfd88041f 58
group-Avnet 0:478cfd88041f 59 /** @addtogroup SPIRIT_Libraries
group-Avnet 0:478cfd88041f 60 * @{
group-Avnet 0:478cfd88041f 61 */
group-Avnet 0:478cfd88041f 62
group-Avnet 0:478cfd88041f 63
group-Avnet 0:478cfd88041f 64 /** @defgroup SPIRIT_SPI_Driver SPI Driver
group-Avnet 0:478cfd88041f 65 * @brief Header file for low level SPIRIT SPI driver.
group-Avnet 0:478cfd88041f 66 * @details See the file <i>@ref MCU_Interface.h</i> for more details.
group-Avnet 0:478cfd88041f 67 * @{
group-Avnet 0:478cfd88041f 68 */
group-Avnet 0:478cfd88041f 69
group-Avnet 0:478cfd88041f 70
group-Avnet 0:478cfd88041f 71
group-Avnet 0:478cfd88041f 72 /** @defgroup SPI_Exported_Types SPI Exported Types
group-Avnet 0:478cfd88041f 73 * @{
group-Avnet 0:478cfd88041f 74 */
group-Avnet 0:478cfd88041f 75
group-Avnet 0:478cfd88041f 76 /**
group-Avnet 0:478cfd88041f 77 * @}
group-Avnet 0:478cfd88041f 78 */
group-Avnet 0:478cfd88041f 79
group-Avnet 0:478cfd88041f 80
group-Avnet 0:478cfd88041f 81
group-Avnet 0:478cfd88041f 82 /** @defgroup SPI_Exported_Constants SPI Exported Constants
group-Avnet 0:478cfd88041f 83 * @{
group-Avnet 0:478cfd88041f 84 */
group-Avnet 0:478cfd88041f 85
group-Avnet 0:478cfd88041f 86 /**
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 SPI_Exported_Macros SPI Exported Macros
group-Avnet 0:478cfd88041f 93 * @{
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 */
group-Avnet 0:478cfd88041f 99
group-Avnet 0:478cfd88041f 100
group-Avnet 0:478cfd88041f 101
group-Avnet 0:478cfd88041f 102 /** @defgroup SPI_Exported_Functions SPI Exported Functions
group-Avnet 0:478cfd88041f 103 * @{
group-Avnet 0:478cfd88041f 104 */
group-Avnet 0:478cfd88041f 105
group-Avnet 0:478cfd88041f 106 typedef SpiritStatus StatusBytes;
group-Avnet 0:478cfd88041f 107
group-Avnet 0:478cfd88041f 108 void SdkEvalSpiInit(void);
group-Avnet 0:478cfd88041f 109 StatusBytes SdkEvalSpiWriteRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
group-Avnet 0:478cfd88041f 110 StatusBytes SdkEvalSpiReadRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
group-Avnet 0:478cfd88041f 111 StatusBytes SdkEvalSpiCommandStrobes(uint8_t cCommandCode);
group-Avnet 0:478cfd88041f 112 StatusBytes SdkEvalSpiWriteFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
group-Avnet 0:478cfd88041f 113 StatusBytes SdkEvalSpiReadFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
group-Avnet 0:478cfd88041f 114
group-Avnet 0:478cfd88041f 115 void SdkEvalEnterShutdown(void);
group-Avnet 0:478cfd88041f 116 void SdkEvalExitShutdown(void);
group-Avnet 0:478cfd88041f 117 SpiritFlagStatus SdkEvalCheckShutdown(void);
group-Avnet 0:478cfd88041f 118
group-Avnet 0:478cfd88041f 119 #define SpiritEnterShutdown SdkEvalEnterShutdown
group-Avnet 0:478cfd88041f 120 #define SpiritExitShutdown SdkEvalExitShutdown
group-Avnet 0:478cfd88041f 121 #define SpiritCheckShutdown (SpiritFlagStatus)SdkEvalCheckShutdown
group-Avnet 0:478cfd88041f 122
group-Avnet 0:478cfd88041f 123
group-Avnet 0:478cfd88041f 124 #define SpiritSpiInit SdkEvalSpiInit
group-Avnet 0:478cfd88041f 125 #define SpiritSpiWriteRegisters(cRegAddress, cNbBytes, pcBuffer) SdkEvalSpiWriteRegisters(cRegAddress, cNbBytes, pcBuffer)
group-Avnet 0:478cfd88041f 126 #define SpiritSpiReadRegisters(cRegAddress, cNbBytes, pcBuffer) SdkEvalSpiReadRegisters(cRegAddress, cNbBytes, pcBuffer)
group-Avnet 0:478cfd88041f 127 #define SpiritSpiCommandStrobes(cCommandCode) SdkEvalSpiCommandStrobes(cCommandCode)
group-Avnet 0:478cfd88041f 128 #define SpiritSpiWriteLinearFifo(cNbBytes, pcBuffer) SdkEvalSpiWriteFifo(cNbBytes, pcBuffer)
group-Avnet 0:478cfd88041f 129 #define SpiritSpiReadLinearFifo(cNbBytes, pcBuffer) SdkEvalSpiReadFifo(cNbBytes, pcBuffer)
group-Avnet 0:478cfd88041f 130
group-Avnet 0:478cfd88041f 131 /**
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 * @}
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 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 147 }
group-Avnet 0:478cfd88041f 148 #endif
group-Avnet 0:478cfd88041f 149
group-Avnet 0:478cfd88041f 150 #endif
group-Avnet 0:478cfd88041f 151
group-Avnet 0:478cfd88041f 152 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/