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_Aes.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 AES Engine.
group-Avnet 0:478cfd88041f 8 *
group-Avnet 0:478cfd88041f 9 * @details
group-Avnet 0:478cfd88041f 10 *
group-Avnet 0:478cfd88041f 11 * In order to encrypt data, the user must manage the AES_END IRQ.
group-Avnet 0:478cfd88041f 12 * The data have to be splitted in blocks of 16 bytes and written
group-Avnet 0:478cfd88041f 13 * into the <i>AES DATA IN registers</i>. Then, after the key is written
group-Avnet 0:478cfd88041f 14 * into the <i>AES KEY registers</i>, a command of <i>Execute encryption</i>
group-Avnet 0:478cfd88041f 15 * has to be sent.
group-Avnet 0:478cfd88041f 16 *
group-Avnet 0:478cfd88041f 17 * <b>Example:</b>
group-Avnet 0:478cfd88041f 18 * @code
group-Avnet 0:478cfd88041f 19 *
group-Avnet 0:478cfd88041f 20 * SpiritAesWriteDataIn(data_buff , N_BYTES);
group-Avnet 0:478cfd88041f 21 * SpiritAesExecuteEncryption();
group-Avnet 0:478cfd88041f 22 *
group-Avnet 0:478cfd88041f 23 * while(!aes_end_flag); // the flag is set by the ISR routine which manages the AES_END irq
group-Avnet 0:478cfd88041f 24 * aes_end_flag=RESET;
group-Avnet 0:478cfd88041f 25 *
group-Avnet 0:478cfd88041f 26 * SpiritAesReadDataOut(enc_data_buff , N_BYTES);
group-Avnet 0:478cfd88041f 27 *
group-Avnet 0:478cfd88041f 28 * @endcode
group-Avnet 0:478cfd88041f 29 *
group-Avnet 0:478cfd88041f 30 * In order to decrypt data, the user must manage the AES_END IRQ and have a decryption key.
group-Avnet 0:478cfd88041f 31 * There are two operative modes to make the data decryption:
group-Avnet 0:478cfd88041f 32 * <ul>
group-Avnet 0:478cfd88041f 33 * <li> Derive the decryption key from the encryption key and decrypt data directly
group-Avnet 0:478cfd88041f 34 * using the <i>SpiritAesDeriveDecKeyExecuteDec()</i> function
group-Avnet 0:478cfd88041f 35 *
group-Avnet 0:478cfd88041f 36 * <b>Example:</b>
group-Avnet 0:478cfd88041f 37 * @code
group-Avnet 0:478cfd88041f 38 *
group-Avnet 0:478cfd88041f 39 * SpiritAesWriteDataIn(enc_data_buff , N_BYTES);
group-Avnet 0:478cfd88041f 40 * SpiritAesDeriveDecKeyExecuteDec();
group-Avnet 0:478cfd88041f 41 *
group-Avnet 0:478cfd88041f 42 * while(!aes_end_flag); // the flag is set by the ISR routine which manages the AES_END irq
group-Avnet 0:478cfd88041f 43 * aes_end_flag=RESET;
group-Avnet 0:478cfd88041f 44 *
group-Avnet 0:478cfd88041f 45 * SpiritAesReadDataOut(data_buff , N_BYTES);
group-Avnet 0:478cfd88041f 46 *
group-Avnet 0:478cfd88041f 47 * @endcode
group-Avnet 0:478cfd88041f 48 * </li>
group-Avnet 0:478cfd88041f 49 *
group-Avnet 0:478cfd88041f 50 * <li> Derive the decryption key from the encryption key using the <i>SpiritAesDeriveDecKeyFromEnc()</i>
group-Avnet 0:478cfd88041f 51 * function, store it into the <i>AES KEY registers</i> and then decrypt data using the
group-Avnet 0:478cfd88041f 52 * <i>SpiritAesExecuteDecryption()</i> function
group-Avnet 0:478cfd88041f 53 *
group-Avnet 0:478cfd88041f 54 * <b>Example:</b>
group-Avnet 0:478cfd88041f 55 * @code
group-Avnet 0:478cfd88041f 56 *
group-Avnet 0:478cfd88041f 57 * SpiritAesWriteDataIn(key_enc , 16);
group-Avnet 0:478cfd88041f 58 * SpiritAesDeriveDecKeyFromEnc();
group-Avnet 0:478cfd88041f 59 *
group-Avnet 0:478cfd88041f 60 * while(!aes_end_flag); // the flag is set by the ISR routine which manages the AES_END irq
group-Avnet 0:478cfd88041f 61 * aes_end_flag=RESET;
group-Avnet 0:478cfd88041f 62 *
group-Avnet 0:478cfd88041f 63 * SpiritAesReadDataOut(key_dec , 16);
group-Avnet 0:478cfd88041f 64 *
group-Avnet 0:478cfd88041f 65 * SpiritAesWriteKey(key_dec);
group-Avnet 0:478cfd88041f 66 * SpiritAesWriteDataIn(enc_data_buff , 16);
group-Avnet 0:478cfd88041f 67 * SpiritAesExecuteDecryption();
group-Avnet 0:478cfd88041f 68 *
group-Avnet 0:478cfd88041f 69 * while(!aes_end_flag); // the flag is set by the ISR routine which manages the AES_END irq
group-Avnet 0:478cfd88041f 70 * aes_end_flag=RESET;
group-Avnet 0:478cfd88041f 71 *
group-Avnet 0:478cfd88041f 72 * SpiritAesReadDataOut(data_buff , N_BYTES);
group-Avnet 0:478cfd88041f 73 *
group-Avnet 0:478cfd88041f 74 * @endcode
group-Avnet 0:478cfd88041f 75 * </li>
group-Avnet 0:478cfd88041f 76 * </ul>
group-Avnet 0:478cfd88041f 77 *
group-Avnet 0:478cfd88041f 78 * @attention
group-Avnet 0:478cfd88041f 79 *
group-Avnet 0:478cfd88041f 80 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
group-Avnet 0:478cfd88041f 81 *
group-Avnet 0:478cfd88041f 82 * Redistribution and use in source and binary forms, with or without modification,
group-Avnet 0:478cfd88041f 83 * are permitted provided that the following conditions are met:
group-Avnet 0:478cfd88041f 84 * 1. Redistributions of source code must retain the above copyright notice,
group-Avnet 0:478cfd88041f 85 * this list of conditions and the following disclaimer.
group-Avnet 0:478cfd88041f 86 * 2. Redistributions in binary form must reproduce the above copyright notice,
group-Avnet 0:478cfd88041f 87 * this list of conditions and the following disclaimer in the documentation
group-Avnet 0:478cfd88041f 88 * and/or other materials provided with the distribution.
group-Avnet 0:478cfd88041f 89 * 3. Neither the name of STMicroelectronics nor the names of its contributors
group-Avnet 0:478cfd88041f 90 * may be used to endorse or promote products derived from this software
group-Avnet 0:478cfd88041f 91 * without specific prior written permission.
group-Avnet 0:478cfd88041f 92 *
group-Avnet 0:478cfd88041f 93 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
group-Avnet 0:478cfd88041f 94 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
group-Avnet 0:478cfd88041f 95 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
group-Avnet 0:478cfd88041f 96 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
group-Avnet 0:478cfd88041f 97 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
group-Avnet 0:478cfd88041f 98 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
group-Avnet 0:478cfd88041f 99 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
group-Avnet 0:478cfd88041f 100 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
group-Avnet 0:478cfd88041f 101 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
group-Avnet 0:478cfd88041f 102 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
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 /* Define to prevent recursive inclusion -------------------------------------*/
group-Avnet 0:478cfd88041f 108 #ifndef __SPIRIT_AES_H
group-Avnet 0:478cfd88041f 109 #define __SPIRIT_AES_H
group-Avnet 0:478cfd88041f 110
group-Avnet 0:478cfd88041f 111
group-Avnet 0:478cfd88041f 112 /* Includes ------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 113
group-Avnet 0:478cfd88041f 114 #include "SPIRIT_Regs.h"
group-Avnet 0:478cfd88041f 115 #include "SPIRIT_Types.h"
group-Avnet 0:478cfd88041f 116
group-Avnet 0:478cfd88041f 117
group-Avnet 0:478cfd88041f 118 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 119 extern "C" {
group-Avnet 0:478cfd88041f 120 #endif
group-Avnet 0:478cfd88041f 121
group-Avnet 0:478cfd88041f 122
group-Avnet 0:478cfd88041f 123 /**
group-Avnet 0:478cfd88041f 124 * @addtogroup SPIRIT_Libraries
group-Avnet 0:478cfd88041f 125 * @{
group-Avnet 0:478cfd88041f 126 */
group-Avnet 0:478cfd88041f 127
group-Avnet 0:478cfd88041f 128
group-Avnet 0:478cfd88041f 129 /**
group-Avnet 0:478cfd88041f 130 * @defgroup SPIRIT_Aes AES
group-Avnet 0:478cfd88041f 131 * @brief Configuration and management of SPIRIT AES Engine.
group-Avnet 0:478cfd88041f 132 * @details See the file <i>@ref SPIRIT_Aes.h</i> for more details.
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 * @defgroup Aes_Exported_Types AES Exported Types
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 /**
group-Avnet 0:478cfd88041f 147 * @defgroup Aes_Exported_Constants AES Exported Constants
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
group-Avnet 0:478cfd88041f 156
group-Avnet 0:478cfd88041f 157 /**
group-Avnet 0:478cfd88041f 158 * @defgroup Aes_Exported_Macros AES Exported Macros
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 */
group-Avnet 0:478cfd88041f 166
group-Avnet 0:478cfd88041f 167
group-Avnet 0:478cfd88041f 168 /**
group-Avnet 0:478cfd88041f 169 * @defgroup Aes_Exported_Functions AES Exported Functions
group-Avnet 0:478cfd88041f 170 * @{
group-Avnet 0:478cfd88041f 171 */
group-Avnet 0:478cfd88041f 172
group-Avnet 0:478cfd88041f 173 void SpiritAesMode(SpiritFunctionalState xNewState);
group-Avnet 0:478cfd88041f 174 void SpiritAesWriteDataIn(uint8_t* pcBufferDataIn, uint8_t cDataLength);
group-Avnet 0:478cfd88041f 175 void SpiritAesReadDataOut(uint8_t* pcBufferDataOut, uint8_t cDataLength);
group-Avnet 0:478cfd88041f 176 void SpiritAesWriteKey(uint8_t* pcKey);
group-Avnet 0:478cfd88041f 177 void SpiritAesReadKey(uint8_t* pcKey);
group-Avnet 0:478cfd88041f 178 void SpiritAesDeriveDecKeyFromEnc(void);
group-Avnet 0:478cfd88041f 179 void SpiritAesExecuteEncryption(void);
group-Avnet 0:478cfd88041f 180 void SpiritAesExecuteDecryption(void);
group-Avnet 0:478cfd88041f 181 void SpiritAesDeriveDecKeyExecuteDec(void);
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 * @}
group-Avnet 0:478cfd88041f 189 */
group-Avnet 0:478cfd88041f 190
group-Avnet 0:478cfd88041f 191
group-Avnet 0:478cfd88041f 192 /**
group-Avnet 0:478cfd88041f 193 * @}
group-Avnet 0:478cfd88041f 194 */
group-Avnet 0:478cfd88041f 195
group-Avnet 0:478cfd88041f 196
group-Avnet 0:478cfd88041f 197
group-Avnet 0:478cfd88041f 198
group-Avnet 0:478cfd88041f 199 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 200 }
group-Avnet 0:478cfd88041f 201 #endif
group-Avnet 0:478cfd88041f 202
group-Avnet 0:478cfd88041f 203 #endif
group-Avnet 0:478cfd88041f 204
group-Avnet 0:478cfd88041f 205 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/