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 radio_spi.h
group-Avnet 0:478cfd88041f 4 * @author System Lab - NOIDA
group-Avnet 0:478cfd88041f 5 * @version V1.0.0
group-Avnet 0:478cfd88041f 6 * @date 15-May-2014
group-Avnet 0:478cfd88041f 7 * @brief This file contains all the functions prototypes for SPI .
group-Avnet 0:478cfd88041f 8 ******************************************************************************
group-Avnet 0:478cfd88041f 9 * @attention
group-Avnet 0:478cfd88041f 10 *
group-Avnet 0:478cfd88041f 11 * <h2><center>&copy; COPYRIGHT(c) 2014 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
group-Avnet 0:478cfd88041f 39 /* Define to prevent recursive inclusion -------------------------------------*/
group-Avnet 0:478cfd88041f 40 #ifndef __RADIO_SPI_H
group-Avnet 0:478cfd88041f 41 #define __RADIO_SPI_H
group-Avnet 0:478cfd88041f 42 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 43 extern "C" {
group-Avnet 0:478cfd88041f 44 #endif
group-Avnet 0:478cfd88041f 45
group-Avnet 0:478cfd88041f 46 /* Includes ------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 47 #ifdef USE_STM32L1XX_NUCLEO
group-Avnet 0:478cfd88041f 48 // #include "stm32l1xx_hal.h"
group-Avnet 0:478cfd88041f 49 #endif
group-Avnet 0:478cfd88041f 50
group-Avnet 0:478cfd88041f 51 #ifdef USE_STM32F4XX_NUCLEO
group-Avnet 0:478cfd88041f 52 // #include "stm32f4xx_hal.h"
group-Avnet 0:478cfd88041f 53 #endif
group-Avnet 0:478cfd88041f 54 #include "SPIRIT_Config.h"
group-Avnet 0:478cfd88041f 55 #include "radio_spi.h"
group-Avnet 0:478cfd88041f 56 // #include "spirit1-arch.h"
group-Avnet 0:478cfd88041f 57
group-Avnet 0:478cfd88041f 58 /**
group-Avnet 0:478cfd88041f 59 * @addtogroup BSP
group-Avnet 0:478cfd88041f 60 * @{
group-Avnet 0:478cfd88041f 61 */
group-Avnet 0:478cfd88041f 62
group-Avnet 0:478cfd88041f 63 /* Exported types ------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 64
group-Avnet 0:478cfd88041f 65
group-Avnet 0:478cfd88041f 66 /* Exported constants --------------------------------------------------------*/
group-Avnet 0:478cfd88041f 67
group-Avnet 0:478cfd88041f 68
group-Avnet 0:478cfd88041f 69 /* Exported macro ------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 70 /* Define for SPIRIT1 board */
group-Avnet 0:478cfd88041f 71 #if !defined (USE_SPIRIT1_DEFAULT)
group-Avnet 0:478cfd88041f 72 #define USE_SPIRIT1_DEFAULT
group-Avnet 0:478cfd88041f 73 #endif
group-Avnet 0:478cfd88041f 74
group-Avnet 0:478cfd88041f 75 /* SPIRIT1_Spi_config */
group-Avnet 0:478cfd88041f 76 /* SPI1 */
group-Avnet 0:478cfd88041f 77 #define RADIO_SPI SPI1
group-Avnet 0:478cfd88041f 78 #define RADIO_SPI_CLK_ENABLE() __SPI1_CLK_ENABLE()
group-Avnet 0:478cfd88041f 79 #define RADIO_SPI_CLK_DISABLE() __SPI1_CLK_DISABLE()
group-Avnet 0:478cfd88041f 80
group-Avnet 0:478cfd88041f 81 #define RADIO_SPI_MISO_PORT GPIOA
group-Avnet 0:478cfd88041f 82 #define RADIO_SPI_MISO_PIN GPIO_PIN_6
group-Avnet 0:478cfd88041f 83 #define RADIO_SPI_MISO_CLOCK_ENABLE() __GPIOA_CLK_ENABLE()
group-Avnet 0:478cfd88041f 84 #define RADIO_SPI_MISO_CLOCK_DISABLE() __GPIOA_CLK_DISABLE()
group-Avnet 0:478cfd88041f 85
group-Avnet 0:478cfd88041f 86 #define RADIO_SPI_MOSI_PORT GPIOA
group-Avnet 0:478cfd88041f 87 #define RADIO_SPI_MOSI_PIN GPIO_PIN_7
group-Avnet 0:478cfd88041f 88 #define RADIO_SPI_MOSI_CLOCK_ENABLE() __GPIOA_CLK_ENABLE()
group-Avnet 0:478cfd88041f 89 #define RADIO_SPI_MOSI_CLOCK_DISABLE() __GPIOA_CLK_DISABLE()
group-Avnet 0:478cfd88041f 90
group-Avnet 0:478cfd88041f 91
group-Avnet 0:478cfd88041f 92
group-Avnet 0:478cfd88041f 93 #ifdef USE_SPIRIT1_DEFAULT
group-Avnet 0:478cfd88041f 94
group-Avnet 0:478cfd88041f 95 #define RADIO_SPI_SCK_PORT GPIOB
group-Avnet 0:478cfd88041f 96 #define RADIO_SPI_SCK_PIN GPIO_PIN_3
group-Avnet 0:478cfd88041f 97 #define RADIO_SPI_SCK_CLOCK_ENABLE() __GPIOB_CLK_ENABLE()
group-Avnet 0:478cfd88041f 98 #define RADIO_SPI_SCK_CLOCK_DISABLE() __GPIOB_CLK_DISABLE()
group-Avnet 0:478cfd88041f 99
group-Avnet 0:478cfd88041f 100
group-Avnet 0:478cfd88041f 101 #define RADIO_SPI_CS_PORT GPIOB
group-Avnet 0:478cfd88041f 102 #define RADIO_SPI_CS_PIN GPIO_PIN_6
group-Avnet 0:478cfd88041f 103 #define RADIO_SPI_CS_CLOCK_ENABLE() __GPIOB_CLK_ENABLE()
group-Avnet 0:478cfd88041f 104 #define RADIO_SPI_CS_CLOCK_DISABLE() __GPIOB_CLK_DISABLE()
group-Avnet 0:478cfd88041f 105
group-Avnet 0:478cfd88041f 106 #else
group-Avnet 0:478cfd88041f 107
group-Avnet 0:478cfd88041f 108 #define RADIO_SPI_SCK_PORT GPIOB
group-Avnet 0:478cfd88041f 109 #define RADIO_SPI_SCK_PIN GPIO_PIN_3
group-Avnet 0:478cfd88041f 110 #define RADIO_SPI_SCK_CLOCK_ENABLE() __GPIOB_CLK_ENABLE()
group-Avnet 0:478cfd88041f 111 #define RADIO_SPI_SCK_CLOCK_DISABLE() __GPIOB_CLK_DISABLE()
group-Avnet 0:478cfd88041f 112
group-Avnet 0:478cfd88041f 113
group-Avnet 0:478cfd88041f 114 #define RADIO_SPI_CS_PORT GPIOB
group-Avnet 0:478cfd88041f 115 #define RADIO_SPI_CS_PIN GPIO_PIN_6
group-Avnet 0:478cfd88041f 116 #define RADIO_SPI_CS_CLOCK_ENABLE() __GPIOB_CLK_ENABLE()
group-Avnet 0:478cfd88041f 117 #define RADIO_SPI_CS_CLOCK_DISABLE() __GPIOB_CLK_DISABLE()
group-Avnet 0:478cfd88041f 118
group-Avnet 0:478cfd88041f 119 #endif
group-Avnet 0:478cfd88041f 120
group-Avnet 0:478cfd88041f 121 /* Maximum Timeout values for flags waiting loops. These timeouts are not based
group-Avnet 0:478cfd88041f 122 on accurate values, they just guarantee that the application will not remain
group-Avnet 0:478cfd88041f 123 stuck if the SPI communication is corrupted.
group-Avnet 0:478cfd88041f 124 You may modify these timeout values depending on CPU frequency and application
group-Avnet 0:478cfd88041f 125 conditions (interrupts routines ...) */
group-Avnet 0:478cfd88041f 126 #define RADIO_SPI_TIMEOUT_MAX ((uint32_t)1000)
group-Avnet 0:478cfd88041f 127
group-Avnet 0:478cfd88041f 128 /* SPIRIT1_Spi_config_Private_Defines */
group-Avnet 0:478cfd88041f 129 #define CS_TO_SCLK_DELAY 0x0200//FIXME what is this doing?
group-Avnet 0:478cfd88041f 130 #define CLK_TO_CS_DELAY 0x0001
group-Avnet 0:478cfd88041f 131
group-Avnet 0:478cfd88041f 132 /* SPIRIT1_Spi_config_Headers */
group-Avnet 0:478cfd88041f 133 #define HEADER_WRITE_MASK 0x00 /*!< Write mask for header byte*/
group-Avnet 0:478cfd88041f 134 #define HEADER_READ_MASK 0x01 /*!< Read mask for header byte*/
group-Avnet 0:478cfd88041f 135 #define HEADER_ADDRESS_MASK 0x00 /*!< Address mask for header byte*/
group-Avnet 0:478cfd88041f 136 #define HEADER_COMMAND_MASK 0x80 /*!< Command mask for header byte*/
group-Avnet 0:478cfd88041f 137
group-Avnet 0:478cfd88041f 138 #define LINEAR_FIFO_ADDRESS 0xFF /*!< Linear FIFO address*/
group-Avnet 0:478cfd88041f 139
group-Avnet 0:478cfd88041f 140 /* SPIRIT1_Spi_config_Private_FunctionPrototypes */
group-Avnet 0:478cfd88041f 141 #define SPI_ENTER_CRITICAL() IRQ_DISABLE()
group-Avnet 0:478cfd88041f 142 #define SPI_EXIT_CRITICAL() IRQ_ENABLE()
group-Avnet 0:478cfd88041f 143
group-Avnet 0:478cfd88041f 144 /* SPIRIT1_Spi_config_Private_Functions */
group-Avnet 0:478cfd88041f 145 #define RadioSpiCSLow() HAL_GPIO_WritePin(RADIO_SPI_CS_PORT, RADIO_SPI_CS_PIN, GPIO_PIN_RESET)
group-Avnet 0:478cfd88041f 146 #define RadioSpiCSHigh() HAL_GPIO_WritePin(RADIO_SPI_CS_PORT, RADIO_SPI_CS_PIN, GPIO_PIN_SET)
group-Avnet 0:478cfd88041f 147
group-Avnet 0:478cfd88041f 148 /* SPIRIT1_Spi_config_Private_Macros */
group-Avnet 0:478cfd88041f 149 #define BUILT_HEADER(add_comm, w_r) (add_comm | w_r) /*!< macro to build the header byte*/
group-Avnet 0:478cfd88041f 150 #define WRITE_HEADER BUILT_HEADER(HEADER_ADDRESS_MASK, HEADER_WRITE_MASK) /*!< macro to build the write
group-Avnet 0:478cfd88041f 151 header byte*/
group-Avnet 0:478cfd88041f 152 #define READ_HEADER BUILT_HEADER(HEADER_ADDRESS_MASK, HEADER_READ_MASK) /*!< macro to build the read
group-Avnet 0:478cfd88041f 153 header byte*/
group-Avnet 0:478cfd88041f 154 #define COMMAND_HEADER BUILT_HEADER(HEADER_COMMAND_MASK, HEADER_WRITE_MASK) /*!< macro to build the command
group-Avnet 0:478cfd88041f 155 header byte*/
group-Avnet 0:478cfd88041f 156
group-Avnet 0:478cfd88041f 157
group-Avnet 0:478cfd88041f 158
group-Avnet 0:478cfd88041f 159 /* Exported Variables --------------------------------------------------------*/
group-Avnet 0:478cfd88041f 160
group-Avnet 0:478cfd88041f 161
group-Avnet 0:478cfd88041f 162 /* Exported functions ------------------------------------------------------- */
group-Avnet 0:478cfd88041f 163 void SdkEvalSpiInit(void);
group-Avnet 0:478cfd88041f 164 // void SpiCSGpioSetLevel(GPIO_PinState xState);
group-Avnet 0:478cfd88041f 165 StatusBytes SdkEvalSpiWriteRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
group-Avnet 0:478cfd88041f 166 StatusBytes SdkEvalSpiReadRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
group-Avnet 0:478cfd88041f 167 StatusBytes SdkEvalSpiCommandStrobes(uint8_t cCommandCode);
group-Avnet 0:478cfd88041f 168 StatusBytes SdkEvalSpiWriteFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
group-Avnet 0:478cfd88041f 169 StatusBytes SdkEvalSpiReadFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
group-Avnet 0:478cfd88041f 170
group-Avnet 0:478cfd88041f 171
group-Avnet 0:478cfd88041f 172 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 173 }
group-Avnet 0:478cfd88041f 174 #endif
group-Avnet 0:478cfd88041f 175 #endif /*__RADIO_SPI_H */
group-Avnet 0:478cfd88041f 176
group-Avnet 0:478cfd88041f 177 /**
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 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/