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_PktMbus.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 MBUS packets.
group-Avnet 0:478cfd88041f 8 * @details
group-Avnet 0:478cfd88041f 9 *
group-Avnet 0:478cfd88041f 10 * @attention
group-Avnet 0:478cfd88041f 11 *
group-Avnet 0:478cfd88041f 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
group-Avnet 0:478cfd88041f 13 *
group-Avnet 0:478cfd88041f 14 * Redistribution and use in source and binary forms, with or without modification,
group-Avnet 0:478cfd88041f 15 * are permitted provided that the following conditions are met:
group-Avnet 0:478cfd88041f 16 * 1. Redistributions of source code must retain the above copyright notice,
group-Avnet 0:478cfd88041f 17 * this list of conditions and the following disclaimer.
group-Avnet 0:478cfd88041f 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
group-Avnet 0:478cfd88041f 19 * this list of conditions and the following disclaimer in the documentation
group-Avnet 0:478cfd88041f 20 * and/or other materials provided with the distribution.
group-Avnet 0:478cfd88041f 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
group-Avnet 0:478cfd88041f 22 * may be used to endorse or promote products derived from this software
group-Avnet 0:478cfd88041f 23 * without specific prior written permission.
group-Avnet 0:478cfd88041f 24 *
group-Avnet 0:478cfd88041f 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
group-Avnet 0:478cfd88041f 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
group-Avnet 0:478cfd88041f 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
group-Avnet 0:478cfd88041f 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
group-Avnet 0:478cfd88041f 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
group-Avnet 0:478cfd88041f 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
group-Avnet 0:478cfd88041f 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
group-Avnet 0:478cfd88041f 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
group-Avnet 0:478cfd88041f 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
group-Avnet 0:478cfd88041f 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
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 /* Includes ------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 40 #include "SPIRIT_PktMbus.h"
group-Avnet 0:478cfd88041f 41 #include "SPIRIT_Radio.h"
group-Avnet 0:478cfd88041f 42 #include "MCU_Interface.h"
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_PktMbus
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 PktMbus_Private_TypesDefinitions Pkt MBUS 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 PktMbus_Private_Defines Pkt MBUS 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 PktMbus_Private_Macros Pkt MBUS 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 PktMbus_Private_Variables Pkt MBUS 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 * @defgroup PktMbus_Private_FunctionPrototypes Pkt MBUS Private Function Prototypes
group-Avnet 0:478cfd88041f 98 * @{
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 * @defgroup PktMbus_Private_Functions Pkt MBUS Private Functions
group-Avnet 0:478cfd88041f 108 * @{
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 Initializes the SPIRIT MBUS packet according to the specified parameters in the PktMbusInit struct.
group-Avnet 0:478cfd88041f 114 * @param pxPktMbusInit pointer to a PktMbusInit structure that contains the configuration information for the specified SPIRIT MBUS PACKET FORMAT.
group-Avnet 0:478cfd88041f 115 * This parameter is a pointer to @ref PktMbusInit.
group-Avnet 0:478cfd88041f 116 * @retval None.
group-Avnet 0:478cfd88041f 117 */
group-Avnet 0:478cfd88041f 118 void SpiritPktMbusInit(PktMbusInit* pxPktMbusInit)
group-Avnet 0:478cfd88041f 119 {
group-Avnet 0:478cfd88041f 120 uint8_t tempRegValue[3];
group-Avnet 0:478cfd88041f 121
group-Avnet 0:478cfd88041f 122 /* Check the parameters */
group-Avnet 0:478cfd88041f 123 s_assert_param(IS_MBUS_SUBMODE(pxPktMbusInit->xMbusSubmode));
group-Avnet 0:478cfd88041f 124
group-Avnet 0:478cfd88041f 125 /* Packet format config */
group-Avnet 0:478cfd88041f 126 SpiritPktMbusSetFormat();
group-Avnet 0:478cfd88041f 127 SpiritPktCommonFilterOnCrc(S_DISABLE);
group-Avnet 0:478cfd88041f 128 SpiritRadioCsBlanking(S_ENABLE);
group-Avnet 0:478cfd88041f 129
group-Avnet 0:478cfd88041f 130 /* Preamble, postamble and submode config */
group-Avnet 0:478cfd88041f 131 tempRegValue[0] = pxPktMbusInit->cPreambleLength;
group-Avnet 0:478cfd88041f 132 tempRegValue[1] = pxPktMbusInit->cPostambleLength;
group-Avnet 0:478cfd88041f 133 tempRegValue[2] = (uint8_t) pxPktMbusInit->xMbusSubmode;
group-Avnet 0:478cfd88041f 134
group-Avnet 0:478cfd88041f 135 /* Writes the new values on the MBUS_PRMBL registers */
group-Avnet 0:478cfd88041f 136 g_xStatus = SpiritSpiWriteRegisters(MBUS_PRMBL_BASE, 3, tempRegValue);
group-Avnet 0:478cfd88041f 137
group-Avnet 0:478cfd88041f 138 }
group-Avnet 0:478cfd88041f 139
group-Avnet 0:478cfd88041f 140 /**
group-Avnet 0:478cfd88041f 141 * @brief Returns the SPIRIT MBUS packet structure according to the specified parameters in the registers.
group-Avnet 0:478cfd88041f 142 * @param pxPktMbusInit MBUS packet init structure.
group-Avnet 0:478cfd88041f 143 * This parameter is a pointer to @ref PktMbusInit.
group-Avnet 0:478cfd88041f 144 * @retval None.
group-Avnet 0:478cfd88041f 145 */
group-Avnet 0:478cfd88041f 146 void SpiritPktMbusGetInfo(PktMbusInit* pxPktMbusInit)
group-Avnet 0:478cfd88041f 147 {
group-Avnet 0:478cfd88041f 148 uint8_t tempRegValue[3];
group-Avnet 0:478cfd88041f 149
group-Avnet 0:478cfd88041f 150 /* Reads the MBUS regs value */
group-Avnet 0:478cfd88041f 151 g_xStatus = SpiritSpiReadRegisters(MBUS_PRMBL_BASE, 3, tempRegValue);
group-Avnet 0:478cfd88041f 152
group-Avnet 0:478cfd88041f 153 /* Fit the structure */
group-Avnet 0:478cfd88041f 154 pxPktMbusInit->cPreambleLength = tempRegValue[0];
group-Avnet 0:478cfd88041f 155 pxPktMbusInit->cPostambleLength = tempRegValue[1];
group-Avnet 0:478cfd88041f 156 pxPktMbusInit->xMbusSubmode = (MbusSubmode) (tempRegValue[2]&0x0E);
group-Avnet 0:478cfd88041f 157
group-Avnet 0:478cfd88041f 158 }
group-Avnet 0:478cfd88041f 159
group-Avnet 0:478cfd88041f 160
group-Avnet 0:478cfd88041f 161 /**
group-Avnet 0:478cfd88041f 162 * @brief Configures the MBUS packet format as the one used by SPIRIT.
group-Avnet 0:478cfd88041f 163 * @param None.
group-Avnet 0:478cfd88041f 164 * @retval None.
group-Avnet 0:478cfd88041f 165 */
group-Avnet 0:478cfd88041f 166 void SpiritPktMbusSetFormat(void)
group-Avnet 0:478cfd88041f 167 {
group-Avnet 0:478cfd88041f 168 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 169
group-Avnet 0:478cfd88041f 170 /* Reads the PCKTCTRL3 register value */
group-Avnet 0:478cfd88041f 171 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 172
group-Avnet 0:478cfd88041f 173 /* Sets format bits. Also set to 0 the direct RX mode bits */
group-Avnet 0:478cfd88041f 174 tempRegValue &= 0x0F;
group-Avnet 0:478cfd88041f 175 tempRegValue |= ((uint8_t)PCKTCTRL3_PCKT_FRMT_MBUS);
group-Avnet 0:478cfd88041f 176
group-Avnet 0:478cfd88041f 177 /* Writes value on the PCKTCTRL3 register */
group-Avnet 0:478cfd88041f 178 g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 179
group-Avnet 0:478cfd88041f 180 /* Reads the PCKTCTRL1 register value */
group-Avnet 0:478cfd88041f 181 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 182
group-Avnet 0:478cfd88041f 183 /* Build the new value. Set to 0 the direct TX mode bits */
group-Avnet 0:478cfd88041f 184 tempRegValue &= 0xF3;
group-Avnet 0:478cfd88041f 185
group-Avnet 0:478cfd88041f 186 /* Writes the value on the PCKTCTRL1 register */
group-Avnet 0:478cfd88041f 187 g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 188
group-Avnet 0:478cfd88041f 189 /* Reads the PROTOCOL1 register */
group-Avnet 0:478cfd88041f 190 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 191
group-Avnet 0:478cfd88041f 192 /* Mask a reserved bit */
group-Avnet 0:478cfd88041f 193 tempRegValue &= ~0x20;
group-Avnet 0:478cfd88041f 194
group-Avnet 0:478cfd88041f 195 /* Writes the value on the PROTOCOL1 register */
group-Avnet 0:478cfd88041f 196 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
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 * @brief Sets how many chip sequence “01” shall be added in the preamble
group-Avnet 0:478cfd88041f 203 * respect to the minimum value as defined according to the specified sub-mode.
group-Avnet 0:478cfd88041f 204 * @param cPreamble the number of chip sequence.
group-Avnet 0:478cfd88041f 205 * This parameter is an uint8_t.
group-Avnet 0:478cfd88041f 206 * @retval None.
group-Avnet 0:478cfd88041f 207 */
group-Avnet 0:478cfd88041f 208 void SpiritPktMbusSetPreamble(uint8_t cPreamble)
group-Avnet 0:478cfd88041f 209 {
group-Avnet 0:478cfd88041f 210 /* Modifies the MBUS_PRMBL register value */
group-Avnet 0:478cfd88041f 211 g_xStatus = SpiritSpiWriteRegisters(MBUS_PRMBL_BASE, 1, &cPreamble);
group-Avnet 0:478cfd88041f 212
group-Avnet 0:478cfd88041f 213 }
group-Avnet 0:478cfd88041f 214
group-Avnet 0:478cfd88041f 215
group-Avnet 0:478cfd88041f 216 /**
group-Avnet 0:478cfd88041f 217 * @brief Returns how many chip sequence "01" are added in the preamble
group-Avnet 0:478cfd88041f 218 * respect to the minimum value as defined according to the specified sub-mode.
group-Avnet 0:478cfd88041f 219 * @param None.
group-Avnet 0:478cfd88041f 220 * @retval uint8_t Preable in number of "01" chip sequences.
group-Avnet 0:478cfd88041f 221 */
group-Avnet 0:478cfd88041f 222 uint8_t SpiritPktMbusGetPreamble(void)
group-Avnet 0:478cfd88041f 223 {
group-Avnet 0:478cfd88041f 224 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 225
group-Avnet 0:478cfd88041f 226 /* Modifies the MBUS_PRMBL register value */
group-Avnet 0:478cfd88041f 227 g_xStatus = SpiritSpiReadRegisters(MBUS_PRMBL_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 228
group-Avnet 0:478cfd88041f 229 /* Return value */
group-Avnet 0:478cfd88041f 230 return tempRegValue;
group-Avnet 0:478cfd88041f 231
group-Avnet 0:478cfd88041f 232 }
group-Avnet 0:478cfd88041f 233
group-Avnet 0:478cfd88041f 234
group-Avnet 0:478cfd88041f 235 /**
group-Avnet 0:478cfd88041f 236 * @brief Sets how many chip sequence “01” will be used in postamble
group-Avnet 0:478cfd88041f 237 * @param cPostamble the number of chip sequence.
group-Avnet 0:478cfd88041f 238 * This parameter is an uint8_t.
group-Avnet 0:478cfd88041f 239 * @retval None.
group-Avnet 0:478cfd88041f 240 */
group-Avnet 0:478cfd88041f 241 void SpiritPktMbusSetPostamble(uint8_t cPostamble)
group-Avnet 0:478cfd88041f 242 {
group-Avnet 0:478cfd88041f 243 /* Modifies the MBUS_PSTMBL register value */
group-Avnet 0:478cfd88041f 244 g_xStatus = SpiritSpiWriteRegisters(MBUS_PSTMBL_BASE, 1, &cPostamble);
group-Avnet 0:478cfd88041f 245
group-Avnet 0:478cfd88041f 246 }
group-Avnet 0:478cfd88041f 247
group-Avnet 0:478cfd88041f 248
group-Avnet 0:478cfd88041f 249 /**
group-Avnet 0:478cfd88041f 250 * @brief Returns how many chip sequence "01" are used in the postamble
group-Avnet 0:478cfd88041f 251 * @param None.
group-Avnet 0:478cfd88041f 252 * @retval uint8_t Postamble in number of "01" chip sequences.
group-Avnet 0:478cfd88041f 253 */
group-Avnet 0:478cfd88041f 254 uint8_t SpiritPktMbusGetPostamble(void)
group-Avnet 0:478cfd88041f 255 {
group-Avnet 0:478cfd88041f 256 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 257
group-Avnet 0:478cfd88041f 258 /* Reads the MBUS_PSTMBL register */
group-Avnet 0:478cfd88041f 259 g_xStatus = SpiritSpiReadRegisters(MBUS_PSTMBL_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 260
group-Avnet 0:478cfd88041f 261 /* Returns value */
group-Avnet 0:478cfd88041f 262 return tempRegValue;
group-Avnet 0:478cfd88041f 263
group-Avnet 0:478cfd88041f 264 }
group-Avnet 0:478cfd88041f 265
group-Avnet 0:478cfd88041f 266
group-Avnet 0:478cfd88041f 267 /**
group-Avnet 0:478cfd88041f 268 * @brief Sets the MBUS submode used.
group-Avnet 0:478cfd88041f 269 * @param xMbusSubmode the submode used.
group-Avnet 0:478cfd88041f 270 * This parameter can be any value of @ref MbusSubmode.
group-Avnet 0:478cfd88041f 271 * @retval None.
group-Avnet 0:478cfd88041f 272 */
group-Avnet 0:478cfd88041f 273 void SpiritPktMbusSetSubmode(MbusSubmode xMbusSubmode)
group-Avnet 0:478cfd88041f 274 {
group-Avnet 0:478cfd88041f 275 /* Modifies the MBUS_CTRL register value */
group-Avnet 0:478cfd88041f 276 g_xStatus = SpiritSpiWriteRegisters(MBUS_CTRL_BASE, 1, (uint8_t*)xMbusSubmode);
group-Avnet 0:478cfd88041f 277
group-Avnet 0:478cfd88041f 278 }
group-Avnet 0:478cfd88041f 279
group-Avnet 0:478cfd88041f 280
group-Avnet 0:478cfd88041f 281 /**
group-Avnet 0:478cfd88041f 282 * @brief Returns the MBUS submode used.
group-Avnet 0:478cfd88041f 283 * @param None.
group-Avnet 0:478cfd88041f 284 * @retval MbusSubmode MBUS submode.
group-Avnet 0:478cfd88041f 285 */
group-Avnet 0:478cfd88041f 286 MbusSubmode SpiritPktMbusGetSubmode(void)
group-Avnet 0:478cfd88041f 287 {
group-Avnet 0:478cfd88041f 288 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 289
group-Avnet 0:478cfd88041f 290 /* Reads the MBUS_CTRL register value */
group-Avnet 0:478cfd88041f 291 g_xStatus = SpiritSpiReadRegisters(MBUS_CTRL_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 292
group-Avnet 0:478cfd88041f 293 /* Returns value */
group-Avnet 0:478cfd88041f 294 return (MbusSubmode) tempRegValue;
group-Avnet 0:478cfd88041f 295
group-Avnet 0:478cfd88041f 296 }
group-Avnet 0:478cfd88041f 297
group-Avnet 0:478cfd88041f 298
group-Avnet 0:478cfd88041f 299 /**
group-Avnet 0:478cfd88041f 300 * @brief Sets the payload length for SPIRIT MBUS packets.
group-Avnet 0:478cfd88041f 301 * @param nPayloadLength payload length in bytes.
group-Avnet 0:478cfd88041f 302 * This parameter is an uint16_t.
group-Avnet 0:478cfd88041f 303 * @retval None.
group-Avnet 0:478cfd88041f 304 */
group-Avnet 0:478cfd88041f 305 void SpiritPktMbusSetPayloadLength(uint16_t nPayloadLength)
group-Avnet 0:478cfd88041f 306 {
group-Avnet 0:478cfd88041f 307 uint8_t tempRegValue[2];
group-Avnet 0:478cfd88041f 308
group-Avnet 0:478cfd88041f 309 /* Computes PCKTLEN0 value from nPayloadLength */
group-Avnet 0:478cfd88041f 310 tempRegValue[1]=BUILD_PCKTLEN0(nPayloadLength);//(uint8_t)nPayloadLength;
group-Avnet 0:478cfd88041f 311 /* Computes PCKTLEN1 value from nPayloadLength */
group-Avnet 0:478cfd88041f 312 tempRegValue[0]=BUILD_PCKTLEN1(nPayloadLength);//(uint8_t)(nPayloadLength>>8);
group-Avnet 0:478cfd88041f 313
group-Avnet 0:478cfd88041f 314 /* Writes data on the PCKTLEN1/0 register */
group-Avnet 0:478cfd88041f 315 g_xStatus = SpiritSpiWriteRegisters(PCKTLEN1_BASE, 2, tempRegValue);
group-Avnet 0:478cfd88041f 316
group-Avnet 0:478cfd88041f 317 }
group-Avnet 0:478cfd88041f 318
group-Avnet 0:478cfd88041f 319
group-Avnet 0:478cfd88041f 320 /**
group-Avnet 0:478cfd88041f 321 * @brief Returns the payload length for SPIRIT MBUS packets.
group-Avnet 0:478cfd88041f 322 * @param None.
group-Avnet 0:478cfd88041f 323 * @retval uint16_t Payload length in bytes.
group-Avnet 0:478cfd88041f 324 */
group-Avnet 0:478cfd88041f 325 uint16_t SpiritPktMbusGetPayloadLength(void)
group-Avnet 0:478cfd88041f 326 {
group-Avnet 0:478cfd88041f 327 uint8_t tempRegValue[2];
group-Avnet 0:478cfd88041f 328
group-Avnet 0:478cfd88041f 329 /* Reads the packet length registers */
group-Avnet 0:478cfd88041f 330 g_xStatus = SpiritSpiReadRegisters(PCKTLEN1_BASE, 2, tempRegValue);
group-Avnet 0:478cfd88041f 331
group-Avnet 0:478cfd88041f 332 /* Returns the packet length */
group-Avnet 0:478cfd88041f 333 return ((((uint16_t)tempRegValue[0])<<8) + (uint16_t) tempRegValue[1]);
group-Avnet 0:478cfd88041f 334
group-Avnet 0:478cfd88041f 335 }
group-Avnet 0:478cfd88041f 336
group-Avnet 0:478cfd88041f 337 /**
group-Avnet 0:478cfd88041f 338 *@}
group-Avnet 0:478cfd88041f 339 */
group-Avnet 0:478cfd88041f 340
group-Avnet 0:478cfd88041f 341 /**
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 *@}
group-Avnet 0:478cfd88041f 348 */
group-Avnet 0:478cfd88041f 349
group-Avnet 0:478cfd88041f 350
group-Avnet 0:478cfd88041f 351
group-Avnet 0:478cfd88041f 352
group-Avnet 0:478cfd88041f 353
group-Avnet 0:478cfd88041f 354 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/