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_Csma.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 CSMA.
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_Csma.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 * @addtogroup SPIRIT_Libraries
group-Avnet 0:478cfd88041f 45 * @{
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 * @addtogroup SPIRIT_Csma
group-Avnet 0:478cfd88041f 51 * @{
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 * @defgroup Csma_Private_TypesDefinitions CSMA Private TypesDefinitions
group-Avnet 0:478cfd88041f 57 * @{
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 Csma_Private_Defines CSMA 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 Csma_Private_Macros CSMA 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 Csma_Private_Variables CSMA 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 Csma_Private_FunctionPrototypes CSMA Private FunctionPrototypes
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 Csma_Private_Functions CSMA 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 /**
group-Avnet 0:478cfd88041f 114 * @brief Initializes the SPIRIT CSMA according to the specified parameters in the CsmaInit.
group-Avnet 0:478cfd88041f 115 * @param pxCsmaInit Csma init structure.
group-Avnet 0:478cfd88041f 116 * This parameter is a pointer to @ref CsmaInit.
group-Avnet 0:478cfd88041f 117 * @retval None.
group-Avnet 0:478cfd88041f 118 */
group-Avnet 0:478cfd88041f 119 void SpiritCsmaInit(CsmaInit* pxCsmaInit)
group-Avnet 0:478cfd88041f 120 {
group-Avnet 0:478cfd88041f 121 uint8_t tempRegValue[5];
group-Avnet 0:478cfd88041f 122
group-Avnet 0:478cfd88041f 123 /* Check the parameters */
group-Avnet 0:478cfd88041f 124 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(pxCsmaInit->xCsmaPersistentMode));
group-Avnet 0:478cfd88041f 125 s_assert_param(IS_CCA_PERIOD(pxCsmaInit->xMultiplierTbit));
group-Avnet 0:478cfd88041f 126 s_assert_param(IS_CSMA_LENGTH(pxCsmaInit->xCcaLength));
group-Avnet 0:478cfd88041f 127 s_assert_param(IS_BU_COUNTER_SEED(pxCsmaInit->nBuCounterSeed));
group-Avnet 0:478cfd88041f 128 s_assert_param(IS_BU_PRESCALER(pxCsmaInit->cBuPrescaler));
group-Avnet 0:478cfd88041f 129 s_assert_param(IS_CMAX_NB(pxCsmaInit->cMaxNb));
group-Avnet 0:478cfd88041f 130
group-Avnet 0:478cfd88041f 131 /* CSMA BU counter seed (MSB) config */
group-Avnet 0:478cfd88041f 132 tempRegValue[0] = (uint8_t)(pxCsmaInit->nBuCounterSeed >> 8);
group-Avnet 0:478cfd88041f 133
group-Avnet 0:478cfd88041f 134 /* CSMA BU counter seed (LSB) config */
group-Avnet 0:478cfd88041f 135 tempRegValue[1] = (uint8_t) pxCsmaInit->nBuCounterSeed;
group-Avnet 0:478cfd88041f 136
group-Avnet 0:478cfd88041f 137 /* CSMA BU prescaler config and CCA period config */
group-Avnet 0:478cfd88041f 138 tempRegValue[2] = (pxCsmaInit->cBuPrescaler << 2) | pxCsmaInit->xMultiplierTbit;
group-Avnet 0:478cfd88041f 139
group-Avnet 0:478cfd88041f 140 /* CSMA CCA length config and max number of back-off */
group-Avnet 0:478cfd88041f 141 tempRegValue[3] = (pxCsmaInit->xCcaLength | pxCsmaInit->cMaxNb);
group-Avnet 0:478cfd88041f 142
group-Avnet 0:478cfd88041f 143 /* Reads the PROTOCOL1_BASE register value, to write the SEED_RELOAD and CSMA_PERS_ON fields */
group-Avnet 0:478cfd88041f 144 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 1, &tempRegValue[4]);
group-Avnet 0:478cfd88041f 145
group-Avnet 0:478cfd88041f 146 /* Writes the new value for persistent mode */
group-Avnet 0:478cfd88041f 147 if(pxCsmaInit->xCsmaPersistentMode==S_ENABLE)
group-Avnet 0:478cfd88041f 148 {
group-Avnet 0:478cfd88041f 149 tempRegValue[4] |= PROTOCOL1_CSMA_PERS_ON_MASK;
group-Avnet 0:478cfd88041f 150 }
group-Avnet 0:478cfd88041f 151 else
group-Avnet 0:478cfd88041f 152 {
group-Avnet 0:478cfd88041f 153 tempRegValue[4] &= ~PROTOCOL1_CSMA_PERS_ON_MASK;
group-Avnet 0:478cfd88041f 154 }
group-Avnet 0:478cfd88041f 155
group-Avnet 0:478cfd88041f 156 /* Writes PROTOCOL1_BASE register */
group-Avnet 0:478cfd88041f 157 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL1_BASE, 1, &tempRegValue[4]);
group-Avnet 0:478cfd88041f 158
group-Avnet 0:478cfd88041f 159 /* Writes CSMA_CONFIGx_BASE registers */
group-Avnet 0:478cfd88041f 160 g_xStatus = SpiritSpiWriteRegisters(CSMA_CONFIG3_BASE, 4, tempRegValue);
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 * @brief Returns the fitted structure CsmaInit starting from the registers values.
group-Avnet 0:478cfd88041f 167 * @param pxCsmaInit Csma structure to be fitted.
group-Avnet 0:478cfd88041f 168 * This parameter is a pointer to @ref CsmaInit.
group-Avnet 0:478cfd88041f 169 * @retval None.
group-Avnet 0:478cfd88041f 170 */
group-Avnet 0:478cfd88041f 171 void SpiritCsmaGetInfo(CsmaInit* pxCsmaInit)
group-Avnet 0:478cfd88041f 172 {
group-Avnet 0:478cfd88041f 173 uint8_t tempRegValue[5];
group-Avnet 0:478cfd88041f 174
group-Avnet 0:478cfd88041f 175 /* Reads PROTOCOL1_BASE register */
group-Avnet 0:478cfd88041f 176 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 1, &tempRegValue[4]);
group-Avnet 0:478cfd88041f 177
group-Avnet 0:478cfd88041f 178 /* Reads CSMA_CONFIGx_BASE registers */
group-Avnet 0:478cfd88041f 179 g_xStatus = SpiritSpiReadRegisters(CSMA_CONFIG3_BASE, 4, tempRegValue);
group-Avnet 0:478cfd88041f 180
group-Avnet 0:478cfd88041f 181 /* Reads the bu counter seed */
group-Avnet 0:478cfd88041f 182 pxCsmaInit->nBuCounterSeed = (uint16_t)tempRegValue[1] | ((uint16_t)(tempRegValue[0] << 8));
group-Avnet 0:478cfd88041f 183
group-Avnet 0:478cfd88041f 184 /* Reads the bu prescaler */
group-Avnet 0:478cfd88041f 185 pxCsmaInit->cBuPrescaler = tempRegValue[2]>>2;
group-Avnet 0:478cfd88041f 186
group-Avnet 0:478cfd88041f 187 /* Reads the Cca period */
group-Avnet 0:478cfd88041f 188 pxCsmaInit->xMultiplierTbit = (CcaPeriod)(tempRegValue[2] & 0x03);
group-Avnet 0:478cfd88041f 189
group-Avnet 0:478cfd88041f 190 /* Reads the Cca length */
group-Avnet 0:478cfd88041f 191 pxCsmaInit->xCcaLength = (CsmaLength)(tempRegValue[3]&0xF0);
group-Avnet 0:478cfd88041f 192
group-Avnet 0:478cfd88041f 193 /* Reads the max number of back off */
group-Avnet 0:478cfd88041f 194 pxCsmaInit->cMaxNb = tempRegValue[3] & 0x07;
group-Avnet 0:478cfd88041f 195
group-Avnet 0:478cfd88041f 196 /* Reads the persistent mode enable bit */
group-Avnet 0:478cfd88041f 197 pxCsmaInit->xCsmaPersistentMode = (SpiritFunctionalState)((tempRegValue[4]>>1) & 0x01);
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 * @brief Enables or Disables the CSMA.
group-Avnet 0:478cfd88041f 204 * @param xNewState the state of the CSMA mode.
group-Avnet 0:478cfd88041f 205 * This parameter can be: S_ENABLE or S_DISABLE.
group-Avnet 0:478cfd88041f 206 * @retval None.
group-Avnet 0:478cfd88041f 207 */
group-Avnet 0:478cfd88041f 208 void SpiritCsma(SpiritFunctionalState xNewState)
group-Avnet 0:478cfd88041f 209 {
group-Avnet 0:478cfd88041f 210 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 211
group-Avnet 0:478cfd88041f 212 /* Check the parameters */
group-Avnet 0:478cfd88041f 213 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
group-Avnet 0:478cfd88041f 214
group-Avnet 0:478cfd88041f 215 /* Reads the PROTOCOL1 register value */
group-Avnet 0:478cfd88041f 216 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 217
group-Avnet 0:478cfd88041f 218 /* Sets or resets the CSMA enable bit */
group-Avnet 0:478cfd88041f 219 if(xNewState==S_ENABLE)
group-Avnet 0:478cfd88041f 220 {
group-Avnet 0:478cfd88041f 221 tempRegValue |= PROTOCOL1_CSMA_ON_MASK;
group-Avnet 0:478cfd88041f 222 }
group-Avnet 0:478cfd88041f 223 else
group-Avnet 0:478cfd88041f 224 {
group-Avnet 0:478cfd88041f 225 tempRegValue &= ~PROTOCOL1_CSMA_ON_MASK;
group-Avnet 0:478cfd88041f 226 }
group-Avnet 0:478cfd88041f 227
group-Avnet 0:478cfd88041f 228 /* Writes the new value on the PROTOCOL1 register */
group-Avnet 0:478cfd88041f 229 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 230
group-Avnet 0:478cfd88041f 231 }
group-Avnet 0:478cfd88041f 232
group-Avnet 0:478cfd88041f 233 /**
group-Avnet 0:478cfd88041f 234 * @brief Gets the CSMA mode. Says if it is enabled or disabled.
group-Avnet 0:478cfd88041f 235 * @param None.
group-Avnet 0:478cfd88041f 236 * @retval SpiritFunctionalState: CSMA mode.
group-Avnet 0:478cfd88041f 237 */
group-Avnet 0:478cfd88041f 238 SpiritFunctionalState SpiritCsmaGetCsma(void)
group-Avnet 0:478cfd88041f 239 {
group-Avnet 0:478cfd88041f 240 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 241
group-Avnet 0:478cfd88041f 242 /* Reads the PROTOCOL1 register value */
group-Avnet 0:478cfd88041f 243 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 244
group-Avnet 0:478cfd88041f 245 /* Return if set or reset */
group-Avnet 0:478cfd88041f 246 if(tempRegValue & PROTOCOL1_CSMA_ON_MASK)
group-Avnet 0:478cfd88041f 247 {
group-Avnet 0:478cfd88041f 248 return S_ENABLE;
group-Avnet 0:478cfd88041f 249 }
group-Avnet 0:478cfd88041f 250 else
group-Avnet 0:478cfd88041f 251 {
group-Avnet 0:478cfd88041f 252 return S_DISABLE;
group-Avnet 0:478cfd88041f 253 }
group-Avnet 0:478cfd88041f 254
group-Avnet 0:478cfd88041f 255 }
group-Avnet 0:478cfd88041f 256
group-Avnet 0:478cfd88041f 257 /**
group-Avnet 0:478cfd88041f 258 * @brief Enables or Disables the persistent CSMA mode.
group-Avnet 0:478cfd88041f 259 * @param xNewState the state of the persistent CSMA mode.
group-Avnet 0:478cfd88041f 260 * This parameter can be: S_ENABLE or S_DISABLE.
group-Avnet 0:478cfd88041f 261 * @retval None.
group-Avnet 0:478cfd88041f 262 */
group-Avnet 0:478cfd88041f 263 void SpiritCsmaPersistentMode(SpiritFunctionalState xNewState)
group-Avnet 0:478cfd88041f 264 {
group-Avnet 0:478cfd88041f 265 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 266
group-Avnet 0:478cfd88041f 267 /* Check the parameters */
group-Avnet 0:478cfd88041f 268 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
group-Avnet 0:478cfd88041f 269
group-Avnet 0:478cfd88041f 270 /* Reads the PROTOCOL1 register value */
group-Avnet 0:478cfd88041f 271 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 272
group-Avnet 0:478cfd88041f 273 /* Enables/disables the CSMA persistent mode */
group-Avnet 0:478cfd88041f 274 if(xNewState==S_ENABLE)
group-Avnet 0:478cfd88041f 275 {
group-Avnet 0:478cfd88041f 276 tempRegValue |= PROTOCOL1_CSMA_PERS_ON_MASK;
group-Avnet 0:478cfd88041f 277 }
group-Avnet 0:478cfd88041f 278 else
group-Avnet 0:478cfd88041f 279 {
group-Avnet 0:478cfd88041f 280 tempRegValue &= ~PROTOCOL1_CSMA_PERS_ON_MASK;
group-Avnet 0:478cfd88041f 281 }
group-Avnet 0:478cfd88041f 282
group-Avnet 0:478cfd88041f 283 /* Writes the new vaue on the PROTOCOL1 register */
group-Avnet 0:478cfd88041f 284 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 285
group-Avnet 0:478cfd88041f 286 }
group-Avnet 0:478cfd88041f 287
group-Avnet 0:478cfd88041f 288
group-Avnet 0:478cfd88041f 289 /**
group-Avnet 0:478cfd88041f 290 * @brief Gets the persistent CSMA mode.
group-Avnet 0:478cfd88041f 291 * @param None.
group-Avnet 0:478cfd88041f 292 * @retval SpiritFunctionalState: CSMA persistent mode.
group-Avnet 0:478cfd88041f 293 */
group-Avnet 0:478cfd88041f 294 SpiritFunctionalState SpiritCsmaGetPersistentMode(void)
group-Avnet 0:478cfd88041f 295 {
group-Avnet 0:478cfd88041f 296 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 297
group-Avnet 0:478cfd88041f 298 /* Reads the PROTOCOL1 register value */
group-Avnet 0:478cfd88041f 299 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 300
group-Avnet 0:478cfd88041f 301 /* Return if set or reset */
group-Avnet 0:478cfd88041f 302 if(tempRegValue & PROTOCOL1_CSMA_PERS_ON_MASK)
group-Avnet 0:478cfd88041f 303 {
group-Avnet 0:478cfd88041f 304 return S_ENABLE;
group-Avnet 0:478cfd88041f 305 }
group-Avnet 0:478cfd88041f 306 else
group-Avnet 0:478cfd88041f 307 {
group-Avnet 0:478cfd88041f 308 return S_DISABLE;
group-Avnet 0:478cfd88041f 309 }
group-Avnet 0:478cfd88041f 310
group-Avnet 0:478cfd88041f 311 }
group-Avnet 0:478cfd88041f 312
group-Avnet 0:478cfd88041f 313
group-Avnet 0:478cfd88041f 314 /**
group-Avnet 0:478cfd88041f 315 * @brief Enables or Disables the seed reload mode (if enabled it reloads the back-off generator seed using the value written in the BU_COUNTER_SEED register).
group-Avnet 0:478cfd88041f 316 * @param xNewState the state of the seed reload mode.
group-Avnet 0:478cfd88041f 317 * This parameter can be: S_ENABLE or S_DISABLE.
group-Avnet 0:478cfd88041f 318 * @retval None.
group-Avnet 0:478cfd88041f 319 */
group-Avnet 0:478cfd88041f 320 void SpiritCsmaSeedReloadMode(SpiritFunctionalState xNewState)
group-Avnet 0:478cfd88041f 321 {
group-Avnet 0:478cfd88041f 322 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 323
group-Avnet 0:478cfd88041f 324 /* Check the parameters */
group-Avnet 0:478cfd88041f 325 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
group-Avnet 0:478cfd88041f 326
group-Avnet 0:478cfd88041f 327 /* Reads the PROTOCOL1 register value */
group-Avnet 0:478cfd88041f 328 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 329
group-Avnet 0:478cfd88041f 330 /* Enables/disables the seed reload mode */
group-Avnet 0:478cfd88041f 331 if(xNewState==S_ENABLE)
group-Avnet 0:478cfd88041f 332 {
group-Avnet 0:478cfd88041f 333 tempRegValue |= PROTOCOL1_SEED_RELOAD_MASK;
group-Avnet 0:478cfd88041f 334 }
group-Avnet 0:478cfd88041f 335 else
group-Avnet 0:478cfd88041f 336 {
group-Avnet 0:478cfd88041f 337 tempRegValue &= ~PROTOCOL1_SEED_RELOAD_MASK;
group-Avnet 0:478cfd88041f 338 }
group-Avnet 0:478cfd88041f 339
group-Avnet 0:478cfd88041f 340 /* Writes the new value on the PROTOCOL1 register */
group-Avnet 0:478cfd88041f 341 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 342
group-Avnet 0:478cfd88041f 343 }
group-Avnet 0:478cfd88041f 344
group-Avnet 0:478cfd88041f 345
group-Avnet 0:478cfd88041f 346 /**
group-Avnet 0:478cfd88041f 347 * @brief Gets the seed reload mode.
group-Avnet 0:478cfd88041f 348 * @param None.
group-Avnet 0:478cfd88041f 349 * @retval SpiritFunctionalState: CSMA seed reload mode.
group-Avnet 0:478cfd88041f 350 */
group-Avnet 0:478cfd88041f 351 SpiritFunctionalState SpiritCsmaGetSeedReloadMode(void)
group-Avnet 0:478cfd88041f 352 {
group-Avnet 0:478cfd88041f 353 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 354
group-Avnet 0:478cfd88041f 355 /* Reads the PROTOCOL1 register value */
group-Avnet 0:478cfd88041f 356 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 357
group-Avnet 0:478cfd88041f 358 /* Return if set or reset */
group-Avnet 0:478cfd88041f 359 if(tempRegValue & PROTOCOL1_SEED_RELOAD_MASK)
group-Avnet 0:478cfd88041f 360 {
group-Avnet 0:478cfd88041f 361 return S_ENABLE;
group-Avnet 0:478cfd88041f 362 }
group-Avnet 0:478cfd88041f 363 else
group-Avnet 0:478cfd88041f 364 {
group-Avnet 0:478cfd88041f 365 return S_DISABLE;
group-Avnet 0:478cfd88041f 366 }
group-Avnet 0:478cfd88041f 367 }
group-Avnet 0:478cfd88041f 368
group-Avnet 0:478cfd88041f 369
group-Avnet 0:478cfd88041f 370 /**
group-Avnet 0:478cfd88041f 371 * @brief Sets the BU counter seed (BU_COUNTER_SEED register). The CSMA back off time is given by the formula: BO = rand(2^NB)*BU.
group-Avnet 0:478cfd88041f 372 * @param nBuCounterSeed seed of the random number generator used to apply the BBE algorithm.
group-Avnet 0:478cfd88041f 373 * This parameter is an uint16_t.
group-Avnet 0:478cfd88041f 374 * @retval None.
group-Avnet 0:478cfd88041f 375 */
group-Avnet 0:478cfd88041f 376 void SpiritCsmaSetBuCounterSeed(uint16_t nBuCounterSeed)
group-Avnet 0:478cfd88041f 377 {
group-Avnet 0:478cfd88041f 378 uint8_t tempRegValue[2];
group-Avnet 0:478cfd88041f 379
group-Avnet 0:478cfd88041f 380 /* Check parameters */
group-Avnet 0:478cfd88041f 381 s_assert_param(IS_BU_COUNTER_SEED(nBuCounterSeed));
group-Avnet 0:478cfd88041f 382
group-Avnet 0:478cfd88041f 383 /* Build value (MSB)*/
group-Avnet 0:478cfd88041f 384 tempRegValue[0]=(uint8_t)(nBuCounterSeed>>8);
group-Avnet 0:478cfd88041f 385 /* Build value (LSB) */
group-Avnet 0:478cfd88041f 386 tempRegValue[1]=(uint8_t)nBuCounterSeed;
group-Avnet 0:478cfd88041f 387
group-Avnet 0:478cfd88041f 388 /* Writes the CSMA_CONFIG3 registers */
group-Avnet 0:478cfd88041f 389 g_xStatus = SpiritSpiWriteRegisters(CSMA_CONFIG3_BASE, 2, tempRegValue);
group-Avnet 0:478cfd88041f 390
group-Avnet 0:478cfd88041f 391 }
group-Avnet 0:478cfd88041f 392
group-Avnet 0:478cfd88041f 393 /**
group-Avnet 0:478cfd88041f 394 * @brief Returns the BU counter seed (BU_COUNTER_SEED register).
group-Avnet 0:478cfd88041f 395 * @param None.
group-Avnet 0:478cfd88041f 396 * @retval uint16_t Seed of the random number generator used to apply the BBE algorithm.
group-Avnet 0:478cfd88041f 397 */
group-Avnet 0:478cfd88041f 398 uint16_t SpiritCsmaGetBuCounterSeed(void)
group-Avnet 0:478cfd88041f 399 {
group-Avnet 0:478cfd88041f 400 uint8_t tempRegValue[2];
group-Avnet 0:478cfd88041f 401
group-Avnet 0:478cfd88041f 402 /* Reads the CSMA_CONFIGx registers value */
group-Avnet 0:478cfd88041f 403 g_xStatus = SpiritSpiReadRegisters(CSMA_CONFIG3_BASE, 2, tempRegValue);
group-Avnet 0:478cfd88041f 404
group-Avnet 0:478cfd88041f 405 /* Build the counter seed and return it */
group-Avnet 0:478cfd88041f 406 return ((uint16_t)tempRegValue[1] + (((uint16_t)tempRegValue[0])<<8));
group-Avnet 0:478cfd88041f 407
group-Avnet 0:478cfd88041f 408 }
group-Avnet 0:478cfd88041f 409
group-Avnet 0:478cfd88041f 410
group-Avnet 0:478cfd88041f 411 /**
group-Avnet 0:478cfd88041f 412 * @brief Sets the BU prescaler. The CSMA back off time is given by the formula: BO = rand(2^NB)*BU.
group-Avnet 0:478cfd88041f 413 * @param cBuPrescaler used to program the back-off unit BU.
group-Avnet 0:478cfd88041f 414 * This parameter is an uint8_t.
group-Avnet 0:478cfd88041f 415 * @retval None.
group-Avnet 0:478cfd88041f 416 */
group-Avnet 0:478cfd88041f 417 void SpiritCsmaSetBuPrescaler(uint8_t cBuPrescaler)
group-Avnet 0:478cfd88041f 418 {
group-Avnet 0:478cfd88041f 419 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 420
group-Avnet 0:478cfd88041f 421 /* Check parameters */
group-Avnet 0:478cfd88041f 422 s_assert_param(IS_BU_PRESCALER(cBuPrescaler));
group-Avnet 0:478cfd88041f 423
group-Avnet 0:478cfd88041f 424 /* Reads the CSMA_CONFIG1 register value */
group-Avnet 0:478cfd88041f 425 g_xStatus = SpiritSpiReadRegisters(CSMA_CONFIG1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 426
group-Avnet 0:478cfd88041f 427 /* Build the new value for the BU prescaler */
group-Avnet 0:478cfd88041f 428 tempRegValue &= 0x03;
group-Avnet 0:478cfd88041f 429 tempRegValue |= (cBuPrescaler<<2);
group-Avnet 0:478cfd88041f 430
group-Avnet 0:478cfd88041f 431 /* Writes the new value on the CSMA_CONFIG1_BASE register */
group-Avnet 0:478cfd88041f 432 g_xStatus = SpiritSpiWriteRegisters(CSMA_CONFIG1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 433
group-Avnet 0:478cfd88041f 434 }
group-Avnet 0:478cfd88041f 435
group-Avnet 0:478cfd88041f 436
group-Avnet 0:478cfd88041f 437 /**
group-Avnet 0:478cfd88041f 438 * @brief Returns the BU prescaler.
group-Avnet 0:478cfd88041f 439 * @param None.
group-Avnet 0:478cfd88041f 440 * @retval uint8_t Value back-off unit (BU).
group-Avnet 0:478cfd88041f 441 */
group-Avnet 0:478cfd88041f 442 uint8_t SpiritCsmaGetBuPrescaler(void)
group-Avnet 0:478cfd88041f 443 {
group-Avnet 0:478cfd88041f 444 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 445
group-Avnet 0:478cfd88041f 446 /* Reads the CSMA_CONFIG1 register value */
group-Avnet 0:478cfd88041f 447 g_xStatus = SpiritSpiReadRegisters(CSMA_CONFIG1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 448
group-Avnet 0:478cfd88041f 449 /* Build and return the BU prescaler value */
group-Avnet 0:478cfd88041f 450 return (tempRegValue >> 2);
group-Avnet 0:478cfd88041f 451
group-Avnet 0:478cfd88041f 452 }
group-Avnet 0:478cfd88041f 453
group-Avnet 0:478cfd88041f 454
group-Avnet 0:478cfd88041f 455 /**
group-Avnet 0:478cfd88041f 456 * @brief Sets the CCA period.
group-Avnet 0:478cfd88041f 457 * @param xMultiplierTbit value of CCA period to store.
group-Avnet 0:478cfd88041f 458 * This parameter can be a value of @ref CcaPeriod.
group-Avnet 0:478cfd88041f 459 * @retval None.
group-Avnet 0:478cfd88041f 460 */
group-Avnet 0:478cfd88041f 461 void SpiritCsmaSetCcaPeriod(CcaPeriod xMultiplierTbit)
group-Avnet 0:478cfd88041f 462 {
group-Avnet 0:478cfd88041f 463 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 464
group-Avnet 0:478cfd88041f 465 /* Check the parameters */
group-Avnet 0:478cfd88041f 466 s_assert_param(IS_CCA_PERIOD(xMultiplierTbit));
group-Avnet 0:478cfd88041f 467
group-Avnet 0:478cfd88041f 468 /* Reads the CSMA_CONFIG1 register value */
group-Avnet 0:478cfd88041f 469 g_xStatus = SpiritSpiReadRegisters(CSMA_CONFIG1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 470
group-Avnet 0:478cfd88041f 471 /* Build the new value setting the the CCA period */
group-Avnet 0:478cfd88041f 472 tempRegValue &= 0xFC;
group-Avnet 0:478cfd88041f 473 tempRegValue |= xMultiplierTbit;
group-Avnet 0:478cfd88041f 474
group-Avnet 0:478cfd88041f 475 /* Writes the new value on the CSMA_CONFIG1 register */
group-Avnet 0:478cfd88041f 476 g_xStatus = SpiritSpiWriteRegisters(CSMA_CONFIG1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 477
group-Avnet 0:478cfd88041f 478 }
group-Avnet 0:478cfd88041f 479
group-Avnet 0:478cfd88041f 480
group-Avnet 0:478cfd88041f 481 /**
group-Avnet 0:478cfd88041f 482 * @brief Returns the CCA period.
group-Avnet 0:478cfd88041f 483 * @param None.
group-Avnet 0:478cfd88041f 484 * @retval CcaPeriod CCA period.
group-Avnet 0:478cfd88041f 485 */
group-Avnet 0:478cfd88041f 486 CcaPeriod SpiritCsmaGetCcaPeriod(void)
group-Avnet 0:478cfd88041f 487 {
group-Avnet 0:478cfd88041f 488 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 489
group-Avnet 0:478cfd88041f 490 /* Reads the CSMA_CONFIG1 register value */
group-Avnet 0:478cfd88041f 491 g_xStatus = SpiritSpiReadRegisters(CSMA_CONFIG1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 492
group-Avnet 0:478cfd88041f 493 /* Build and return the CCA period value */
group-Avnet 0:478cfd88041f 494 return (CcaPeriod)(tempRegValue & 0x03);
group-Avnet 0:478cfd88041f 495
group-Avnet 0:478cfd88041f 496 }
group-Avnet 0:478cfd88041f 497
group-Avnet 0:478cfd88041f 498
group-Avnet 0:478cfd88041f 499 /**
group-Avnet 0:478cfd88041f 500 * @brief Sets the CCA length.
group-Avnet 0:478cfd88041f 501 * @param xCcaLength the CCA length (a value between 1 and 15 that multiplies the CCA period).
group-Avnet 0:478cfd88041f 502 * This parameter can be any value of @ref CsmaLength.
group-Avnet 0:478cfd88041f 503 * @retval None.
group-Avnet 0:478cfd88041f 504 */
group-Avnet 0:478cfd88041f 505 void SpiritCsmaSetCcaLength(CsmaLength xCcaLength)
group-Avnet 0:478cfd88041f 506 {
group-Avnet 0:478cfd88041f 507 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 508
group-Avnet 0:478cfd88041f 509 /* Check the parameters */
group-Avnet 0:478cfd88041f 510 s_assert_param(IS_CSMA_LENGTH(xCcaLength));
group-Avnet 0:478cfd88041f 511
group-Avnet 0:478cfd88041f 512 /* Reads the CSMA_CONFIG0 register value */
group-Avnet 0:478cfd88041f 513 g_xStatus = SpiritSpiReadRegisters(CSMA_CONFIG0_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 514
group-Avnet 0:478cfd88041f 515 /* Build the value of CCA length to be set */
group-Avnet 0:478cfd88041f 516 tempRegValue &= 0x0F;
group-Avnet 0:478cfd88041f 517 tempRegValue |= xCcaLength;
group-Avnet 0:478cfd88041f 518
group-Avnet 0:478cfd88041f 519 /* Writes the new value on the CSMA_CONFIG0 register */
group-Avnet 0:478cfd88041f 520 g_xStatus = SpiritSpiWriteRegisters(CSMA_CONFIG0_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 521
group-Avnet 0:478cfd88041f 522 }
group-Avnet 0:478cfd88041f 523
group-Avnet 0:478cfd88041f 524
group-Avnet 0:478cfd88041f 525 /**
group-Avnet 0:478cfd88041f 526 * @brief Returns the CCA length.
group-Avnet 0:478cfd88041f 527 * @param None.
group-Avnet 0:478cfd88041f 528 * @retval uint8_t CCA length.
group-Avnet 0:478cfd88041f 529 */
group-Avnet 0:478cfd88041f 530 uint8_t SpiritCsmaGetCcaLength(void)
group-Avnet 0:478cfd88041f 531 {
group-Avnet 0:478cfd88041f 532 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 533
group-Avnet 0:478cfd88041f 534 /* Reads the CSMA_CONFIG0 register value */
group-Avnet 0:478cfd88041f 535 g_xStatus = SpiritSpiReadRegisters(CSMA_CONFIG0_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 536
group-Avnet 0:478cfd88041f 537 /* Build and return the CCA length */
group-Avnet 0:478cfd88041f 538 return tempRegValue >> 4;
group-Avnet 0:478cfd88041f 539
group-Avnet 0:478cfd88041f 540 }
group-Avnet 0:478cfd88041f 541
group-Avnet 0:478cfd88041f 542
group-Avnet 0:478cfd88041f 543 /**
group-Avnet 0:478cfd88041f 544 * @brief Sets the max number of back-off. If reached Spirit stops the transmission.
group-Avnet 0:478cfd88041f 545 * @param cMaxNb the max number of back-off.
group-Avnet 0:478cfd88041f 546 * This parameter is an uint8_t.
group-Avnet 0:478cfd88041f 547 * @retval None.
group-Avnet 0:478cfd88041f 548 */
group-Avnet 0:478cfd88041f 549 void SpiritCsmaSetMaxNumberBackoff(uint8_t cMaxNb)
group-Avnet 0:478cfd88041f 550 {
group-Avnet 0:478cfd88041f 551 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 552
group-Avnet 0:478cfd88041f 553 /* Check the parameters */
group-Avnet 0:478cfd88041f 554 s_assert_param(IS_CMAX_NB(cMaxNb));
group-Avnet 0:478cfd88041f 555
group-Avnet 0:478cfd88041f 556 /* Reads the CSMA_CONFIG0 register value */
group-Avnet 0:478cfd88041f 557 g_xStatus = SpiritSpiReadRegisters(CSMA_CONFIG0_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 558
group-Avnet 0:478cfd88041f 559 /* Build the value of max back off to be set */
group-Avnet 0:478cfd88041f 560 tempRegValue &= 0xF8;
group-Avnet 0:478cfd88041f 561 tempRegValue |= cMaxNb;
group-Avnet 0:478cfd88041f 562
group-Avnet 0:478cfd88041f 563 /* Writes the new value on the CSMA_CONFIG0 register */
group-Avnet 0:478cfd88041f 564 g_xStatus = SpiritSpiWriteRegisters(CSMA_CONFIG0_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 565 }
group-Avnet 0:478cfd88041f 566
group-Avnet 0:478cfd88041f 567 /**
group-Avnet 0:478cfd88041f 568 * @brief Returns the max number of back-off.
group-Avnet 0:478cfd88041f 569 * @param None.
group-Avnet 0:478cfd88041f 570 * @retval uint8_t Max number of back-off.
group-Avnet 0:478cfd88041f 571 */
group-Avnet 0:478cfd88041f 572 uint8_t SpiritCsmaGetMaxNumberBackoff(void)
group-Avnet 0:478cfd88041f 573 {
group-Avnet 0:478cfd88041f 574 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 575
group-Avnet 0:478cfd88041f 576 /* Reads the CSMA_CONFIG0 register value */
group-Avnet 0:478cfd88041f 577 g_xStatus = SpiritSpiReadRegisters(CSMA_CONFIG0_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 578
group-Avnet 0:478cfd88041f 579 /* Build and return the max number of back-off */
group-Avnet 0:478cfd88041f 580 return (tempRegValue & 0x07);
group-Avnet 0:478cfd88041f 581
group-Avnet 0:478cfd88041f 582 }
group-Avnet 0:478cfd88041f 583
group-Avnet 0:478cfd88041f 584
group-Avnet 0:478cfd88041f 585 /**
group-Avnet 0:478cfd88041f 586 *@}
group-Avnet 0:478cfd88041f 587 */
group-Avnet 0:478cfd88041f 588
group-Avnet 0:478cfd88041f 589 /**
group-Avnet 0:478cfd88041f 590 *@}
group-Avnet 0:478cfd88041f 591 */
group-Avnet 0:478cfd88041f 592
group-Avnet 0:478cfd88041f 593
group-Avnet 0:478cfd88041f 594 /**
group-Avnet 0:478cfd88041f 595 *@}
group-Avnet 0:478cfd88041f 596 */
group-Avnet 0:478cfd88041f 597
group-Avnet 0:478cfd88041f 598
group-Avnet 0:478cfd88041f 599
group-Avnet 0:478cfd88041f 600 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/