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_LinearFifo.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 Fifo.
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_LinearFifo.h"
group-Avnet 0:478cfd88041f 41 #include "MCU_Interface.h"
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_LinearFifo
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 LinearFifo_Private_TypesDefinitions Linear FIFO 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 LinearFifo_Private_Defines Linear FIFO 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 LinearFifo_Private_Macros Linear FIFO 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 LinearFifo_Private_Variables Linear FIFO 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 LinearFifo_Private_FunctionPrototypes Linear FIFO 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 LinearFifo_Private_Functions Linear FIFO 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 * @brief Returns the number of elements in the Rx FIFO.
group-Avnet 0:478cfd88041f 113 * @param None.
group-Avnet 0:478cfd88041f 114 * @retval uint8_t Number of elements in the Rx FIFO.
group-Avnet 0:478cfd88041f 115 */
group-Avnet 0:478cfd88041f 116 uint8_t SpiritLinearFifoReadNumElementsRxFifo(void)
group-Avnet 0:478cfd88041f 117 {
group-Avnet 0:478cfd88041f 118 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 119
group-Avnet 0:478cfd88041f 120 /* Reads the register value */
group-Avnet 0:478cfd88041f 121 g_xStatus = SpiritSpiReadRegisters(LINEAR_FIFO_STATUS0_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 122
group-Avnet 0:478cfd88041f 123 /* Build and return value */
group-Avnet 0:478cfd88041f 124 return (tempRegValue & 0x7F);
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 * @brief Returns the number of elements in the Tx FIFO.
group-Avnet 0:478cfd88041f 131 * @param None.
group-Avnet 0:478cfd88041f 132 * @retval uint8_t Number of elements in the Tx FIFO.
group-Avnet 0:478cfd88041f 133 */
group-Avnet 0:478cfd88041f 134 uint8_t SpiritLinearFifoReadNumElementsTxFifo(void)
group-Avnet 0:478cfd88041f 135 {
group-Avnet 0:478cfd88041f 136 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 137
group-Avnet 0:478cfd88041f 138 /* Reads the number of elements in TX FIFO and return the value */
group-Avnet 0:478cfd88041f 139 g_xStatus = SpiritSpiReadRegisters(LINEAR_FIFO_STATUS1_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 140
group-Avnet 0:478cfd88041f 141 /* Build and return value */
group-Avnet 0:478cfd88041f 142 return (tempRegValue & 0x7F);
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 * @brief Sets the almost full threshold for the Rx FIFO. When the number of elements in RX FIFO reaches this value an interrupt can be generated to the MCU.
group-Avnet 0:478cfd88041f 148 * @note The almost full threshold is encountered from the top of the FIFO. For example, if it is set to 7 the almost
group-Avnet 0:478cfd88041f 149 * full FIFO irq will be raised when the number of elements is equals to 96-7 = 89.
group-Avnet 0:478cfd88041f 150 * @param cThrRxFifo almost full threshold.
group-Avnet 0:478cfd88041f 151 * This parameter is an uint8_t.
group-Avnet 0:478cfd88041f 152 * @retval None.
group-Avnet 0:478cfd88041f 153 */
group-Avnet 0:478cfd88041f 154 void SpiritLinearFifoSetAlmostFullThresholdRx(uint8_t cThrRxFifo)
group-Avnet 0:478cfd88041f 155 {
group-Avnet 0:478cfd88041f 156 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 157
group-Avnet 0:478cfd88041f 158 /* Check the parameters */
group-Avnet 0:478cfd88041f 159 s_assert_param(IS_FIFO_THR(cThrRxFifo));
group-Avnet 0:478cfd88041f 160
group-Avnet 0:478cfd88041f 161 /* Build the register value */
group-Avnet 0:478cfd88041f 162 tempRegValue = cThrRxFifo & 0x7F;
group-Avnet 0:478cfd88041f 163
group-Avnet 0:478cfd88041f 164 /* Writes the Almost Full threshold for RX in the corresponding register */
group-Avnet 0:478cfd88041f 165 g_xStatus = SpiritSpiWriteRegisters(FIFO_CONFIG3_RXAFTHR_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 166
group-Avnet 0:478cfd88041f 167 }
group-Avnet 0:478cfd88041f 168
group-Avnet 0:478cfd88041f 169
group-Avnet 0:478cfd88041f 170 /**
group-Avnet 0:478cfd88041f 171 * @brief Returns the almost full threshold for RX FIFO.
group-Avnet 0:478cfd88041f 172 * @note The almost full threshold is encountered from the top of the FIFO. For example, if it is 7 the almost
group-Avnet 0:478cfd88041f 173 * full FIFO irq will be raised when the number of elements is equals to 96-7 = 89.
group-Avnet 0:478cfd88041f 174 * @param None.
group-Avnet 0:478cfd88041f 175 * @retval uint8_t Almost full threshold for Rx FIFO.
group-Avnet 0:478cfd88041f 176 */
group-Avnet 0:478cfd88041f 177 uint8_t SpiritLinearFifoGetAlmostFullThresholdRx(void)
group-Avnet 0:478cfd88041f 178 {
group-Avnet 0:478cfd88041f 179 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 180
group-Avnet 0:478cfd88041f 181 /* Reads the almost full threshold for RX FIFO and return the value */
group-Avnet 0:478cfd88041f 182 g_xStatus = SpiritSpiReadRegisters(FIFO_CONFIG3_RXAFTHR_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 183
group-Avnet 0:478cfd88041f 184 /* Build and return value */
group-Avnet 0:478cfd88041f 185 return (tempRegValue & 0x7F);
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 * @brief Sets the almost empty threshold for the Rx FIFO. When the number of elements in RX FIFO reaches this value an interrupt can be generated to the MCU.
group-Avnet 0:478cfd88041f 192 * @param cThrRxFifo almost empty threshold.
group-Avnet 0:478cfd88041f 193 * This parameter is an uint8_t.
group-Avnet 0:478cfd88041f 194 * @retval None.
group-Avnet 0:478cfd88041f 195 */
group-Avnet 0:478cfd88041f 196 void SpiritLinearFifoSetAlmostEmptyThresholdRx(uint8_t cThrRxFifo)
group-Avnet 0:478cfd88041f 197 {
group-Avnet 0:478cfd88041f 198 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 199
group-Avnet 0:478cfd88041f 200 /* Check the parameters */
group-Avnet 0:478cfd88041f 201 s_assert_param(IS_FIFO_THR(cThrRxFifo));
group-Avnet 0:478cfd88041f 202
group-Avnet 0:478cfd88041f 203 /* Build the register value */
group-Avnet 0:478cfd88041f 204 tempRegValue = cThrRxFifo & 0x7F;
group-Avnet 0:478cfd88041f 205
group-Avnet 0:478cfd88041f 206 /* Writes the Almost Empty threshold for RX in the corresponding register */
group-Avnet 0:478cfd88041f 207 g_xStatus = SpiritSpiWriteRegisters(FIFO_CONFIG2_RXAETHR_BASE, 1, &tempRegValue);
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 * @brief Returns the almost empty threshold for Rx FIFO.
group-Avnet 0:478cfd88041f 214 * @param None.
group-Avnet 0:478cfd88041f 215 * @retval uint8_t Almost empty threshold for Rx FIFO.
group-Avnet 0:478cfd88041f 216 */
group-Avnet 0:478cfd88041f 217 uint8_t SpiritLinearFifoGetAlmostEmptyThresholdRx(void)
group-Avnet 0:478cfd88041f 218 {
group-Avnet 0:478cfd88041f 219 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 220
group-Avnet 0:478cfd88041f 221 /* Reads the almost empty threshold for RX FIFO and returns the value */
group-Avnet 0:478cfd88041f 222 g_xStatus = SpiritSpiReadRegisters(FIFO_CONFIG2_RXAETHR_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 223
group-Avnet 0:478cfd88041f 224 /* Build and return value */
group-Avnet 0:478cfd88041f 225 return (tempRegValue & 0x7F);
group-Avnet 0:478cfd88041f 226
group-Avnet 0:478cfd88041f 227 }
group-Avnet 0:478cfd88041f 228
group-Avnet 0:478cfd88041f 229
group-Avnet 0:478cfd88041f 230 /**
group-Avnet 0:478cfd88041f 231 * @brief Sets the almost full threshold for the Tx FIFO. When the number of elements in TX FIFO reaches this value an interrupt can be generated to the MCU.
group-Avnet 0:478cfd88041f 232 * @note The almost full threshold is encountered from the top of the FIFO. For example, if it is set to 7 the almost
group-Avnet 0:478cfd88041f 233 * full FIFO irq will be raised when the number of elements is equals to 96-7 = 89.
group-Avnet 0:478cfd88041f 234 * @param cThrTxFifo almost full threshold.
group-Avnet 0:478cfd88041f 235 * This parameter is an uint8_t.
group-Avnet 0:478cfd88041f 236 * @retval None.
group-Avnet 0:478cfd88041f 237 */
group-Avnet 0:478cfd88041f 238 void SpiritLinearFifoSetAlmostFullThresholdTx(uint8_t cThrTxFifo)
group-Avnet 0:478cfd88041f 239 {
group-Avnet 0:478cfd88041f 240 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 241
group-Avnet 0:478cfd88041f 242 /* Check the parameters */
group-Avnet 0:478cfd88041f 243 s_assert_param(IS_FIFO_THR(cThrTxFifo));
group-Avnet 0:478cfd88041f 244
group-Avnet 0:478cfd88041f 245 /* Reads the register value */
group-Avnet 0:478cfd88041f 246 g_xStatus = SpiritSpiReadRegisters(FIFO_CONFIG1_TXAFTHR_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 247
group-Avnet 0:478cfd88041f 248 /* Build the register value */
group-Avnet 0:478cfd88041f 249 tempRegValue &= 0x80;
group-Avnet 0:478cfd88041f 250 tempRegValue |= cThrTxFifo;
group-Avnet 0:478cfd88041f 251
group-Avnet 0:478cfd88041f 252 /* Writes the Almost Full threshold for Tx in the corresponding register */
group-Avnet 0:478cfd88041f 253 g_xStatus = SpiritSpiWriteRegisters(FIFO_CONFIG1_TXAFTHR_BASE, 1, &tempRegValue);
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 /**
group-Avnet 0:478cfd88041f 259 * @brief Returns the almost full threshold for Tx FIFO.
group-Avnet 0:478cfd88041f 260 * @note The almost full threshold is encountered from the top of the FIFO. For example, if it is set to 7 the almost
group-Avnet 0:478cfd88041f 261 * full FIFO irq will be raised when the number of elements is equals to 96-7 = 89.
group-Avnet 0:478cfd88041f 262 * @param None.
group-Avnet 0:478cfd88041f 263 * @retval uint8_t Almost full threshold for Tx FIFO.
group-Avnet 0:478cfd88041f 264 */
group-Avnet 0:478cfd88041f 265 uint8_t SpiritLinearFifoGetAlmostFullThresholdTx(void)
group-Avnet 0:478cfd88041f 266 {
group-Avnet 0:478cfd88041f 267 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 268
group-Avnet 0:478cfd88041f 269 /* Reads the almost full threshold for Tx FIFO and returns the value */
group-Avnet 0:478cfd88041f 270 g_xStatus = SpiritSpiReadRegisters(FIFO_CONFIG1_TXAFTHR_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 271
group-Avnet 0:478cfd88041f 272 /* Build and returns value */
group-Avnet 0:478cfd88041f 273 return (tempRegValue & 0x7F);
group-Avnet 0:478cfd88041f 274
group-Avnet 0:478cfd88041f 275 }
group-Avnet 0:478cfd88041f 276
group-Avnet 0:478cfd88041f 277
group-Avnet 0:478cfd88041f 278 /**
group-Avnet 0:478cfd88041f 279 * @brief Sets the almost empty threshold for the Tx FIFO. When the number of elements in Tx FIFO reaches this value an interrupt can can be generated to the MCU.
group-Avnet 0:478cfd88041f 280 * @param cThrTxFifo: almost empty threshold.
group-Avnet 0:478cfd88041f 281 * This parameter is an uint8_t.
group-Avnet 0:478cfd88041f 282 * @retval None.
group-Avnet 0:478cfd88041f 283 */
group-Avnet 0:478cfd88041f 284 void SpiritLinearFifoSetAlmostEmptyThresholdTx(uint8_t cThrTxFifo)
group-Avnet 0:478cfd88041f 285 {
group-Avnet 0:478cfd88041f 286 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 287
group-Avnet 0:478cfd88041f 288 /* Check the parameters */
group-Avnet 0:478cfd88041f 289 s_assert_param(IS_FIFO_THR(cThrTxFifo));
group-Avnet 0:478cfd88041f 290
group-Avnet 0:478cfd88041f 291 /* Reads the register value */
group-Avnet 0:478cfd88041f 292 g_xStatus = SpiritSpiReadRegisters(FIFO_CONFIG0_TXAETHR_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 293
group-Avnet 0:478cfd88041f 294 /* Build the register value */
group-Avnet 0:478cfd88041f 295 tempRegValue &= 0x80;
group-Avnet 0:478cfd88041f 296 tempRegValue |= cThrTxFifo;
group-Avnet 0:478cfd88041f 297
group-Avnet 0:478cfd88041f 298 /* Writes the Almost Empty threshold for Tx in the corresponding register */
group-Avnet 0:478cfd88041f 299 g_xStatus = SpiritSpiWriteRegisters(FIFO_CONFIG0_TXAETHR_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 300
group-Avnet 0:478cfd88041f 301 }
group-Avnet 0:478cfd88041f 302
group-Avnet 0:478cfd88041f 303
group-Avnet 0:478cfd88041f 304 /**
group-Avnet 0:478cfd88041f 305 * @brief Returns the almost empty threshold for Tx FIFO.
group-Avnet 0:478cfd88041f 306 * @param None.
group-Avnet 0:478cfd88041f 307 * @retval uint8_t Almost empty threshold for Tx FIFO.
group-Avnet 0:478cfd88041f 308 */
group-Avnet 0:478cfd88041f 309 uint8_t SpiritLinearFifoGetAlmostEmptyThresholdTx(void)
group-Avnet 0:478cfd88041f 310 {
group-Avnet 0:478cfd88041f 311 uint8_t tempRegValue;
group-Avnet 0:478cfd88041f 312
group-Avnet 0:478cfd88041f 313 /* Reads the almost empty threshold for TX FIFO and returns the value */
group-Avnet 0:478cfd88041f 314 g_xStatus = SpiritSpiReadRegisters(FIFO_CONFIG0_TXAETHR_BASE, 1, &tempRegValue);
group-Avnet 0:478cfd88041f 315
group-Avnet 0:478cfd88041f 316 /* Build and return value */
group-Avnet 0:478cfd88041f 317 return (tempRegValue & 0x7F);
group-Avnet 0:478cfd88041f 318
group-Avnet 0:478cfd88041f 319 }
group-Avnet 0:478cfd88041f 320
group-Avnet 0:478cfd88041f 321
group-Avnet 0:478cfd88041f 322 /**
group-Avnet 0:478cfd88041f 323 *@}
group-Avnet 0:478cfd88041f 324 */
group-Avnet 0:478cfd88041f 325
group-Avnet 0:478cfd88041f 326 /**
group-Avnet 0:478cfd88041f 327 *@}
group-Avnet 0:478cfd88041f 328 */
group-Avnet 0:478cfd88041f 329
group-Avnet 0:478cfd88041f 330
group-Avnet 0:478cfd88041f 331 /**
group-Avnet 0:478cfd88041f 332 *@}
group-Avnet 0:478cfd88041f 333 */
group-Avnet 0:478cfd88041f 334
group-Avnet 0:478cfd88041f 335
group-Avnet 0:478cfd88041f 336
group-Avnet 0:478cfd88041f 337 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/