Fork of my MQTTGateway
easy-connect/stm-spirit1-rf-driver/source/libs/spirit1/SPIRIT1_Library/Src/SPIRIT_LinearFifo.c
- Committer:
- vpcola
- Date:
- 2017-04-08
- Revision:
- 0:f1d3878b8dd9
File content as of revision 0:f1d3878b8dd9:
/**
******************************************************************************
* @file SPIRIT_LinearFifo.c
* @author VMA division - AMS
* @version 3.2.2
* @date 08-July-2015
* @brief Configuration and management of SPIRIT Fifo.
* @details
*
* @attention
*
* <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of STMicroelectronics nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
******************************************************************************
*/
/* Includes ------------------------------------------------------------------*/
#include "SPIRIT_LinearFifo.h"
#include "MCU_Interface.h"
/**
* @addtogroup SPIRIT_Libraries
* @{
*/
/**
* @addtogroup SPIRIT_LinearFifo
* @{
*/
/**
* @defgroup LinearFifo_Private_TypesDefinitions Linear FIFO Private Types Definitions
* @{
*/
/**
*@}
*/
/**
* @defgroup LinearFifo_Private_Defines Linear FIFO Private Defines
* @{
*/
/**
*@}
*/
/**
* @defgroup LinearFifo_Private_Macros Linear FIFO Private Macros
* @{
*/
/**
*@}
*/
/**
* @defgroup LinearFifo_Private_Variables Linear FIFO Private Variables
* @{
*/
/**
*@}
*/
/**
* @defgroup LinearFifo_Private_FunctionPrototypes Linear FIFO Private Function Prototypes
* @{
*/
/**
*@}
*/
/**
* @defgroup LinearFifo_Private_Functions Linear FIFO Private Functions
* @{
*/
/**
* @brief Returns the number of elements in the Rx FIFO.
* @param None.
* @retval uint8_t Number of elements in the Rx FIFO.
*/
uint8_t SpiritLinearFifoReadNumElementsRxFifo(void)
{
uint8_t tempRegValue;
/* Reads the register value */
g_xStatus = SpiritSpiReadRegisters(LINEAR_FIFO_STATUS0_BASE, 1, &tempRegValue);
/* Build and return value */
return (tempRegValue & 0x7F);
}
/**
* @brief Returns the number of elements in the Tx FIFO.
* @param None.
* @retval uint8_t Number of elements in the Tx FIFO.
*/
uint8_t SpiritLinearFifoReadNumElementsTxFifo(void)
{
uint8_t tempRegValue;
/* Reads the number of elements in TX FIFO and return the value */
g_xStatus = SpiritSpiReadRegisters(LINEAR_FIFO_STATUS1_BASE, 1, &tempRegValue);
/* Build and return value */
return (tempRegValue & 0x7F);
}
/**
* @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.
* @note The almost full threshold is encountered from the top of the FIFO. For example, if it is set to 7 the almost
* full FIFO irq will be raised when the number of elements is equals to 96-7 = 89.
* @param cThrRxFifo almost full threshold.
* This parameter is an uint8_t.
* @retval None.
*/
void SpiritLinearFifoSetAlmostFullThresholdRx(uint8_t cThrRxFifo)
{
uint8_t tempRegValue;
/* Check the parameters */
s_assert_param(IS_FIFO_THR(cThrRxFifo));
/* Build the register value */
tempRegValue = cThrRxFifo & 0x7F;
/* Writes the Almost Full threshold for RX in the corresponding register */
g_xStatus = SpiritSpiWriteRegisters(FIFO_CONFIG3_RXAFTHR_BASE, 1, &tempRegValue);
}
/**
* @brief Returns the almost full threshold for RX FIFO.
* @note The almost full threshold is encountered from the top of the FIFO. For example, if it is 7 the almost
* full FIFO irq will be raised when the number of elements is equals to 96-7 = 89.
* @param None.
* @retval uint8_t Almost full threshold for Rx FIFO.
*/
uint8_t SpiritLinearFifoGetAlmostFullThresholdRx(void)
{
uint8_t tempRegValue;
/* Reads the almost full threshold for RX FIFO and return the value */
g_xStatus = SpiritSpiReadRegisters(FIFO_CONFIG3_RXAFTHR_BASE, 1, &tempRegValue);
/* Build and return value */
return (tempRegValue & 0x7F);
}
/**
* @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.
* @param cThrRxFifo almost empty threshold.
* This parameter is an uint8_t.
* @retval None.
*/
void SpiritLinearFifoSetAlmostEmptyThresholdRx(uint8_t cThrRxFifo)
{
uint8_t tempRegValue;
/* Check the parameters */
s_assert_param(IS_FIFO_THR(cThrRxFifo));
/* Build the register value */
tempRegValue = cThrRxFifo & 0x7F;
/* Writes the Almost Empty threshold for RX in the corresponding register */
g_xStatus = SpiritSpiWriteRegisters(FIFO_CONFIG2_RXAETHR_BASE, 1, &tempRegValue);
}
/**
* @brief Returns the almost empty threshold for Rx FIFO.
* @param None.
* @retval uint8_t Almost empty threshold for Rx FIFO.
*/
uint8_t SpiritLinearFifoGetAlmostEmptyThresholdRx(void)
{
uint8_t tempRegValue;
/* Reads the almost empty threshold for RX FIFO and returns the value */
g_xStatus = SpiritSpiReadRegisters(FIFO_CONFIG2_RXAETHR_BASE, 1, &tempRegValue);
/* Build and return value */
return (tempRegValue & 0x7F);
}
/**
* @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.
* @note The almost full threshold is encountered from the top of the FIFO. For example, if it is set to 7 the almost
* full FIFO irq will be raised when the number of elements is equals to 96-7 = 89.
* @param cThrTxFifo almost full threshold.
* This parameter is an uint8_t.
* @retval None.
*/
void SpiritLinearFifoSetAlmostFullThresholdTx(uint8_t cThrTxFifo)
{
uint8_t tempRegValue;
/* Check the parameters */
s_assert_param(IS_FIFO_THR(cThrTxFifo));
/* Reads the register value */
g_xStatus = SpiritSpiReadRegisters(FIFO_CONFIG1_TXAFTHR_BASE, 1, &tempRegValue);
/* Build the register value */
tempRegValue &= 0x80;
tempRegValue |= cThrTxFifo;
/* Writes the Almost Full threshold for Tx in the corresponding register */
g_xStatus = SpiritSpiWriteRegisters(FIFO_CONFIG1_TXAFTHR_BASE, 1, &tempRegValue);
}
/**
* @brief Returns the almost full threshold for Tx FIFO.
* @note The almost full threshold is encountered from the top of the FIFO. For example, if it is set to 7 the almost
* full FIFO irq will be raised when the number of elements is equals to 96-7 = 89.
* @param None.
* @retval uint8_t Almost full threshold for Tx FIFO.
*/
uint8_t SpiritLinearFifoGetAlmostFullThresholdTx(void)
{
uint8_t tempRegValue;
/* Reads the almost full threshold for Tx FIFO and returns the value */
g_xStatus = SpiritSpiReadRegisters(FIFO_CONFIG1_TXAFTHR_BASE, 1, &tempRegValue);
/* Build and returns value */
return (tempRegValue & 0x7F);
}
/**
* @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.
* @param cThrTxFifo: almost empty threshold.
* This parameter is an uint8_t.
* @retval None.
*/
void SpiritLinearFifoSetAlmostEmptyThresholdTx(uint8_t cThrTxFifo)
{
uint8_t tempRegValue;
/* Check the parameters */
s_assert_param(IS_FIFO_THR(cThrTxFifo));
/* Reads the register value */
g_xStatus = SpiritSpiReadRegisters(FIFO_CONFIG0_TXAETHR_BASE, 1, &tempRegValue);
/* Build the register value */
tempRegValue &= 0x80;
tempRegValue |= cThrTxFifo;
/* Writes the Almost Empty threshold for Tx in the corresponding register */
g_xStatus = SpiritSpiWriteRegisters(FIFO_CONFIG0_TXAETHR_BASE, 1, &tempRegValue);
}
/**
* @brief Returns the almost empty threshold for Tx FIFO.
* @param None.
* @retval uint8_t Almost empty threshold for Tx FIFO.
*/
uint8_t SpiritLinearFifoGetAlmostEmptyThresholdTx(void)
{
uint8_t tempRegValue;
/* Reads the almost empty threshold for TX FIFO and returns the value */
g_xStatus = SpiritSpiReadRegisters(FIFO_CONFIG0_TXAETHR_BASE, 1, &tempRegValue);
/* Build and return value */
return (tempRegValue & 0x7F);
}
/**
*@}
*/
/**
*@}
*/
/**
*@}
*/
/******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/