SPIRIT_LinearFifo.h

00001 /**
00002   ******************************************************************************
00003  * @file    SPIRIT_LinearFifo.h
00004   * @author  VMA division - AMS
00005   * @version 3.2.2
00006   * @date    08-July-2015
00007  * @brief   Configuration and management of SPIRIT Fifo.
00008  * @details
00009  *
00010   * @attention
00011  *
00012   * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
00013  *
00014   * Redistribution and use in source and binary forms, with or without modification,
00015   * are permitted provided that the following conditions are met:
00016   *   1. Redistributions of source code must retain the above copyright notice,
00017   *      this list of conditions and the following disclaimer.
00018   *   2. Redistributions in binary form must reproduce the above copyright notice,
00019   *      this list of conditions and the following disclaimer in the documentation
00020   *      and/or other materials provided with the distribution.
00021   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00022   *      may be used to endorse or promote products derived from this software
00023   *      without specific prior written permission.
00024  *
00025   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00026   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00028   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00029   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00030   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00031   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00032   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00033   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00034   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035   *
00036   ******************************************************************************
00037  */
00038 
00039 /* Define to prevent recursive inclusion -------------------------------------*/
00040 #ifndef __SPIRIT_LINEAR_FIFO_H
00041 #define __SPIRIT_LINEAR_FIFO_H
00042 
00043 
00044 /* Includes ------------------------------------------------------------------*/
00045 
00046 #include "SPIRIT_Regs.h"
00047 #include "SPIRIT_Types.h"
00048 
00049 
00050 #ifdef __cplusplus
00051  extern "C" {
00052 #endif
00053 
00054 
00055 /**
00056  * @addtogroup SPIRIT_Libraries
00057  * @{
00058  */
00059 
00060 
00061 /**
00062  * @defgroup SPIRIT_LinearFifo          Linear FIFO
00063  * @brief Configuration and management of SPIRIT FIFO.
00064  * @details See the file <i>@ref SPIRIT_LinearFifo.h</i> for more details.
00065  * @{
00066  */
00067 
00068 /**
00069  * @defgroup LinearFifo_Exported_Types  Linear FIFO Exported Types
00070  * @{
00071  */
00072 
00073 
00074 /**
00075  * @}
00076  */
00077 
00078 
00079 /**
00080  * @defgroup LinearFifo_Exported_Constants      Linear FIFO Exported Constants
00081  * @{
00082  */
00083 #define IS_FIFO_THR(VAL)  (VAL<=96)
00084 
00085 /**
00086  * @}
00087  */
00088 
00089 
00090 /**
00091  * @defgroup LinearFifo_Exported_Macros         Linear FIFO Exported Macros
00092  * @{
00093  */
00094 
00095 
00096 /**
00097  * @}
00098  */
00099 
00100 
00101 /**
00102  * @defgroup LinearFifo_Exported_Functions                      Linear FIFO Exported Functions
00103  * @{
00104  */
00105 
00106 uint8_t SpiritLinearFifoReadNumElementsRxFifo(void);
00107 uint8_t SpiritLinearFifoReadNumElementsTxFifo(void);
00108 void SpiritLinearFifoSetAlmostFullThresholdRx(uint8_t cThrRxFifo);
00109 uint8_t SpiritLinearFifoGetAlmostFullThresholdRx(void);
00110 void SpiritLinearFifoSetAlmostEmptyThresholdRx(uint8_t cThrRxFifo);
00111 uint8_t SpiritLinearFifoGetAlmostEmptyThresholdRx(void);
00112 void SpiritLinearFifoSetAlmostFullThresholdTx(uint8_t cThrTxFifo);
00113 uint8_t SpiritLinearFifoGetAlmostFullThresholdTx(void);
00114 void SpiritLinearFifoSetAlmostEmptyThresholdTx(uint8_t cThrTxFifo);
00115 uint8_t SpiritLinearFifoGetAlmostEmptyThresholdTx(void);
00116 
00117 /**
00118  * @}
00119  */
00120 
00121 /**
00122  * @}
00123  */
00124 
00125 
00126 /**
00127  * @}
00128  */
00129 
00130 #ifdef __cplusplus
00131 }
00132 #endif
00133 
00134 #endif
00135 
00136 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/