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 * Copyright (c) 2015, Freescale Semiconductor, Inc.
group-Avnet 0:478cfd88041f 3 * All rights reserved.
group-Avnet 0:478cfd88041f 4 *
group-Avnet 0:478cfd88041f 5 * \file XcvrSpi.h
group-Avnet 0:478cfd88041f 6 *
group-Avnet 0:478cfd88041f 7 * Redistribution and use in source and binary forms, with or without modification,
group-Avnet 0:478cfd88041f 8 * are permitted provided that the following conditions are met:
group-Avnet 0:478cfd88041f 9 *
group-Avnet 0:478cfd88041f 10 * o Redistributions of source code must retain the above copyright notice, this list
group-Avnet 0:478cfd88041f 11 * of conditions and the following disclaimer.
group-Avnet 0:478cfd88041f 12 *
group-Avnet 0:478cfd88041f 13 * o Redistributions in binary form must reproduce the above copyright notice, this
group-Avnet 0:478cfd88041f 14 * list of conditions and the following disclaimer in the documentation and/or
group-Avnet 0:478cfd88041f 15 * other materials provided with the distribution.
group-Avnet 0:478cfd88041f 16 *
group-Avnet 0:478cfd88041f 17 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
group-Avnet 0:478cfd88041f 18 * contributors may be used to endorse or promote products derived from this
group-Avnet 0:478cfd88041f 19 * software without specific prior written permission.
group-Avnet 0:478cfd88041f 20 *
group-Avnet 0:478cfd88041f 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
group-Avnet 0:478cfd88041f 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
group-Avnet 0:478cfd88041f 23 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
group-Avnet 0:478cfd88041f 24 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
group-Avnet 0:478cfd88041f 25 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
group-Avnet 0:478cfd88041f 26 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
group-Avnet 0:478cfd88041f 27 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
group-Avnet 0:478cfd88041f 28 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
group-Avnet 0:478cfd88041f 29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
group-Avnet 0:478cfd88041f 30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
group-Avnet 0:478cfd88041f 31 */
group-Avnet 0:478cfd88041f 32
group-Avnet 0:478cfd88041f 33 #ifndef __XCVR_SPI_H__
group-Avnet 0:478cfd88041f 34 #define __XCVR_SPI_H__
group-Avnet 0:478cfd88041f 35
group-Avnet 0:478cfd88041f 36
group-Avnet 0:478cfd88041f 37 /*****************************************************************************
group-Avnet 0:478cfd88041f 38 * INCLUDED HEADERS *
group-Avnet 0:478cfd88041f 39 *---------------------------------------------------------------------------*
group-Avnet 0:478cfd88041f 40 * Add to this section all the headers that this module needs to include. *
group-Avnet 0:478cfd88041f 41 * Note that it is not a good practice to include header files into header *
group-Avnet 0:478cfd88041f 42 * files, so use this section only if there is no other better solution. *
group-Avnet 0:478cfd88041f 43 *---------------------------------------------------------------------------*
group-Avnet 0:478cfd88041f 44 *****************************************************************************/
group-Avnet 0:478cfd88041f 45
group-Avnet 0:478cfd88041f 46
group-Avnet 0:478cfd88041f 47 /*****************************************************************************
group-Avnet 0:478cfd88041f 48 * PUBLIC MACROS *
group-Avnet 0:478cfd88041f 49 *---------------------------------------------------------------------------*
group-Avnet 0:478cfd88041f 50 * Add to this section all the access macros, registers mappings, bit access *
group-Avnet 0:478cfd88041f 51 * macros, masks, flags etc ...
group-Avnet 0:478cfd88041f 52 *---------------------------------------------------------------------------*
group-Avnet 0:478cfd88041f 53 *****************************************************************************/
group-Avnet 0:478cfd88041f 54 #define gXcvrSpiInstance_c 0
group-Avnet 0:478cfd88041f 55
group-Avnet 0:478cfd88041f 56 /*****************************************************************************
group-Avnet 0:478cfd88041f 57 * PUBLIC FUNCTIONS *
group-Avnet 0:478cfd88041f 58 *---------------------------------------------------------------------------*
group-Avnet 0:478cfd88041f 59 * Add to this section all the global functions prototype preceded (as a *
group-Avnet 0:478cfd88041f 60 * good practice) by the keyword 'extern' *
group-Avnet 0:478cfd88041f 61 *---------------------------------------------------------------------------*
group-Avnet 0:478cfd88041f 62 *****************************************************************************/
group-Avnet 0:478cfd88041f 63
group-Avnet 0:478cfd88041f 64 #if defined(__cplusplus)
group-Avnet 0:478cfd88041f 65 extern "C" {
group-Avnet 0:478cfd88041f 66 #endif /* __cplusplus */
group-Avnet 0:478cfd88041f 67
group-Avnet 0:478cfd88041f 68 void RF_RST_Set(int state);
group-Avnet 0:478cfd88041f 69 void RF_CS_Set(int state);
group-Avnet 0:478cfd88041f 70 void RF_IRQ_Init(void);
group-Avnet 0:478cfd88041f 71 void RF_IRQ_Disable(void);
group-Avnet 0:478cfd88041f 72 void RF_IRQ_Enable(void);
group-Avnet 0:478cfd88041f 73 uint8_t RF_isIRQ_Pending(void);
group-Avnet 0:478cfd88041f 74
group-Avnet 0:478cfd88041f 75 void gXcvrAssertCS_d(void);
group-Avnet 0:478cfd88041f 76 void gXcvrDeassertCS_d(void);
group-Avnet 0:478cfd88041f 77
group-Avnet 0:478cfd88041f 78 void xcvr_spi_init(uint32_t instance);
group-Avnet 0:478cfd88041f 79 void xcvr_spi_configure_speed(uint32_t instance, uint32_t freq);
group-Avnet 0:478cfd88041f 80 void xcvr_spi_transfer(uint32_t instance,
group-Avnet 0:478cfd88041f 81 uint8_t * sendBuffer,
group-Avnet 0:478cfd88041f 82 uint8_t * receiveBuffer,
group-Avnet 0:478cfd88041f 83 uint32_t transferByteCount);
group-Avnet 0:478cfd88041f 84
group-Avnet 0:478cfd88041f 85 #if defined(__cplusplus)
group-Avnet 0:478cfd88041f 86 }
group-Avnet 0:478cfd88041f 87 #endif /* __cplusplus */
group-Avnet 0:478cfd88041f 88
group-Avnet 0:478cfd88041f 89 #endif /* __XCVR_SPI_H__ */