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_DirectRF.c
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 direct transmission / receive modes.
group-Avnet 0:478cfd88041f 8 * @details
group-Avnet 0:478cfd88041f 9 * @attention
group-Avnet 0:478cfd88041f 10 *
group-Avnet 0:478cfd88041f 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
group-Avnet 0:478cfd88041f 12 *
group-Avnet 0:478cfd88041f 13 * Redistribution and use in source and binary forms, with or without modification,
group-Avnet 0:478cfd88041f 14 * are permitted provided that the following conditions are met:
group-Avnet 0:478cfd88041f 15 * 1. Redistributions of source code must retain the above copyright notice,
group-Avnet 0:478cfd88041f 16 * this list of conditions and the following disclaimer.
group-Avnet 0:478cfd88041f 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
group-Avnet 0:478cfd88041f 18 * this list of conditions and the following disclaimer in the documentation
group-Avnet 0:478cfd88041f 19 * and/or other materials provided with the distribution.
group-Avnet 0:478cfd88041f 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
group-Avnet 0:478cfd88041f 21 * may be used to endorse or promote products derived from this software
group-Avnet 0:478cfd88041f 22 * without specific prior written permission.
group-Avnet 0:478cfd88041f 23 *
group-Avnet 0:478cfd88041f 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
group-Avnet 0:478cfd88041f 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
group-Avnet 0:478cfd88041f 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
group-Avnet 0:478cfd88041f 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
group-Avnet 0:478cfd88041f 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
group-Avnet 0:478cfd88041f 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
group-Avnet 0:478cfd88041f 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
group-Avnet 0:478cfd88041f 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
group-Avnet 0:478cfd88041f 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
group-Avnet 0:478cfd88041f 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
group-Avnet 0:478cfd88041f 34 *
group-Avnet 0:478cfd88041f 35 ******************************************************************************
group-Avnet 0:478cfd88041f 36 */
group-Avnet 0:478cfd88041f 37
group-Avnet 0:478cfd88041f 38 /* Includes ------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 39 #include "SPIRIT_DirectRF.h"
group-Avnet 0:478cfd88041f 40 #include "MCU_Interface.h"
group-Avnet 0:478cfd88041f 41
group-Avnet 0:478cfd88041f 42
group-Avnet 0:478cfd88041f 43
group-Avnet 0:478cfd88041f 44 /**
group-Avnet 0:478cfd88041f 45 * @addtogroup SPIRIT_Libraries
group-Avnet 0:478cfd88041f 46 * @{
group-Avnet 0:478cfd88041f 47 */
group-Avnet 0:478cfd88041f 48
group-Avnet 0:478cfd88041f 49
group-Avnet 0:478cfd88041f 50 /**
group-Avnet 0:478cfd88041f 51 * @addtogroup SPIRIT_DirectRf
group-Avnet 0:478cfd88041f 52 * @{
group-Avnet 0:478cfd88041f 53 */
group-Avnet 0:478cfd88041f 54
group-Avnet 0:478cfd88041f 55
group-Avnet 0:478cfd88041f 56 /**
group-Avnet 0:478cfd88041f 57 * @defgroup DirectRf_Private_TypesDefinitions Direct RF Private Types Definitions
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 *@}
group-Avnet 0:478cfd88041f 63 */
group-Avnet 0:478cfd88041f 64
group-Avnet 0:478cfd88041f 65
group-Avnet 0:478cfd88041f 66 /**
group-Avnet 0:478cfd88041f 67 * @defgroup DirectRf_Private_Defines Direct RF Private Defines
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 *@}
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 * @defgroup DirectRf_Private_Macros Direct RF Private Macros
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 *@}
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 * @defgroup DirectRf_Private_Variables Direct RF Private Variables
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 */
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 * @defgroup DirectRf_Private_FunctionPrototypes Direct RF Private Function Prototypes
group-Avnet 0:478cfd88041f 99 * @{
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
group-Avnet 0:478cfd88041f 106
group-Avnet 0:478cfd88041f 107 /**
group-Avnet 0:478cfd88041f 108 * @defgroup DirectRf_Private_Functions Direct RF Private Functions
group-Avnet 0:478cfd88041f 109 * @{
group-Avnet 0:478cfd88041f 110 */
group-Avnet 0:478cfd88041f 111
group-Avnet 0:478cfd88041f 112 /**
group-Avnet 0:478cfd88041f 113 * @brief Sets the DirectRF RX mode of SPIRIT.
group-Avnet 0:478cfd88041f 114 * @param xDirectRx code of the desired mode.
group-Avnet 0:478cfd88041f 115 * This parameter can be any value of @ref DirectRx.
group-Avnet 0:478cfd88041f 116 * @retval None.
group-Avnet 0:478cfd88041f 117 */
group-Avnet 0:478cfd88041f 118 void SpiritDirectRfSetRxMode(DirectRx xDirectRx)
group-Avnet 0:478cfd88041f 119 {
group-Avnet 0:478cfd88041f 120 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 121
group-Avnet 0:478cfd88041f 122 /* Check the parameters */
group-Avnet 0:478cfd88041f 123 s_assert_param(IS_DIRECT_RX(xDirectRx));
group-Avnet 0:478cfd88041f 124
group-Avnet 0:478cfd88041f 125 /* Reads the register value */
group-Avnet 0:478cfd88041f 126 SpiritSpiReadRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 127
group-Avnet 0:478cfd88041f 128 /* Build the value to be stored */
group-Avnet 0:478cfd88041f 129 tempRegValue &= ~PCKTCTRL3_RX_MODE_MASK;
group-Avnet 0:478cfd88041f 130 tempRegValue |= (uint8_t)xDirectRx;
group-Avnet 0:478cfd88041f 131
group-Avnet 0:478cfd88041f 132 /* Writes value on register */
group-Avnet 0:478cfd88041f 133 g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
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 * @brief Returns the DirectRF RX mode of SPIRIT.
group-Avnet 0:478cfd88041f 140 * @param None.
group-Avnet 0:478cfd88041f 141 * @retval DirectRx Direct Rx mode.
group-Avnet 0:478cfd88041f 142 */
group-Avnet 0:478cfd88041f 143 DirectRx SpiritDirectRfGetRxMode(void)
group-Avnet 0:478cfd88041f 144 {
group-Avnet 0:478cfd88041f 145 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 146
group-Avnet 0:478cfd88041f 147 /* Reads the register value and mask the RX_Mode field */
group-Avnet 0:478cfd88041f 148 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 149
group-Avnet 0:478cfd88041f 150 /* Rebuild and return value */
group-Avnet 0:478cfd88041f 151 return (DirectRx)(tempRegValue & 0x30);
group-Avnet 0:478cfd88041f 152
group-Avnet 0:478cfd88041f 153 }
group-Avnet 0:478cfd88041f 154
group-Avnet 0:478cfd88041f 155
group-Avnet 0:478cfd88041f 156 /**
group-Avnet 0:478cfd88041f 157 * @brief Sets the TX mode of SPIRIT.
group-Avnet 0:478cfd88041f 158 * @param xDirectTx code of the desired source.
group-Avnet 0:478cfd88041f 159 * This parameter can be any value of @ref DirectTx.
group-Avnet 0:478cfd88041f 160 * @retval None.
group-Avnet 0:478cfd88041f 161 */
group-Avnet 0:478cfd88041f 162 void SpiritDirectRfSetTxMode(DirectTx xDirectTx)
group-Avnet 0:478cfd88041f 163 {
group-Avnet 0:478cfd88041f 164 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 165
group-Avnet 0:478cfd88041f 166 /* Check the parameters */
group-Avnet 0:478cfd88041f 167 s_assert_param(IS_DIRECT_TX(xDirectTx));
group-Avnet 0:478cfd88041f 168
group-Avnet 0:478cfd88041f 169 /* Reads the register value */
group-Avnet 0:478cfd88041f 170 SpiritSpiReadRegisters(PCKTCTRL1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 171
group-Avnet 0:478cfd88041f 172 /* Build the value to be stored */
group-Avnet 0:478cfd88041f 173 tempRegValue &= ~PCKTCTRL1_TX_SOURCE_MASK;
group-Avnet 0:478cfd88041f 174 tempRegValue |= (uint8_t)xDirectTx;
group-Avnet 0:478cfd88041f 175
group-Avnet 0:478cfd88041f 176 /* Writes value on register */
group-Avnet 0:478cfd88041f 177 g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL1_BASE, 1, &tempRegValue);
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 * @brief Returns the DirectRF TX mode of SPIRIT.
group-Avnet 0:478cfd88041f 184 * @param None.
group-Avnet 0:478cfd88041f 185 * @retval DirectTx Direct Tx mode.
group-Avnet 0:478cfd88041f 186 */
group-Avnet 0:478cfd88041f 187 DirectTx SpiritDirectRfGetTxMode(void)
group-Avnet 0:478cfd88041f 188 {
group-Avnet 0:478cfd88041f 189 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 190
group-Avnet 0:478cfd88041f 191 /* Reads the register value and mask the RX_Mode field */
group-Avnet 0:478cfd88041f 192 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 193
group-Avnet 0:478cfd88041f 194 /* Returns value */
group-Avnet 0:478cfd88041f 195 return (DirectTx)(tempRegValue & 0x0C);
group-Avnet 0:478cfd88041f 196
group-Avnet 0:478cfd88041f 197 }
group-Avnet 0:478cfd88041f 198
group-Avnet 0:478cfd88041f 199
group-Avnet 0:478cfd88041f 200 /**
group-Avnet 0:478cfd88041f 201 *@}
group-Avnet 0:478cfd88041f 202 */
group-Avnet 0:478cfd88041f 203
group-Avnet 0:478cfd88041f 204 /**
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 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/