ring_buffer.h

00001   /**
00002   ******************************************************************************
00003   * @file    ring_buffer.h
00004   * @author  Central LAB
00005   * @version V2.0.0
00006   * @date    10-February-2016
00007   * @brief   Header File for Circular Buffer management of the Wi-Fi module
00008   ******************************************************************************
00009   * @attention
00010   *
00011   * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
00012   *
00013   * Redistribution and use in source and binary forms, with or without modification,
00014   * are permitted provided that the following conditions are met:
00015   *   1. Redistributions of source code must retain the above copyright notice,
00016   *      this list of conditions and the following disclaimer.
00017   *   2. Redistributions in binary form must reproduce the above copyright notice,
00018   *      this list of conditions and the following disclaimer in the documentation
00019   *      and/or other materials provided with the distribution.
00020   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00021   *      may be used to endorse or promote products derived from this software
00022   *      without specific prior written permission.
00023   *
00024   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00025   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00026   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00027   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00028   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00029   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00030   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00031   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00032   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00033   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00034   *
00035   ******************************************************************************
00036   */
00037 
00038 /* Includes ------------------------------------------------------------------*/
00039 #include <stdio.h>
00040 #include <string.h>
00041 #include <stdint.h>
00042 #include <stdlib.h>
00043 
00044 #ifndef __RING_BUFFER_H
00045 #define __RING_BUFFER_H
00046 
00047 /** @addtogroup BSP
00048 * @{
00049 */ 
00050 
00051 
00052 /** @defgroup  NUCLEO_WIFI_BUFFER_MGMT 
00053   * @brief Wi-Fi_driver modules
00054   * @{
00055   */ 
00056 
00057 
00058 /** @defgroup NUCLEO_WIFI_BUFFER_MGMT_Private_TypesDefinitions
00059   * @{
00060   */
00061 
00062 /**
00063   * @}
00064   */
00065 
00066 /** @defgroup NUCLEO_WIFI_BUFFER_MGMT_Private_Defines
00067   * @{
00068   */
00069 
00070 /**
00071   * @}
00072   */
00073 
00074 /** @defgroup NUCLEO_WIFI_BUFFER_MGMT_Private_Macros
00075   * @{
00076   */
00077 
00078 
00079 
00080 /**
00081   * @}
00082   */
00083 
00084 /** @defgroup NUCLEO_WIFI_BUFFER_MGMT_Private_Variables
00085   * @{
00086   */
00087 
00088 struct buffer {    
00089     volatile int start; // position of first data from USART
00090     volatile int end;  // position of last data from USART
00091     volatile int size; //Max size in terms of number of data packets (Total Bytes/size of each packet (8 bytes))
00092     volatile int count; // number of currently filled data packets (=size if full & =0 if empty)
00093     
00094     /*unsigned main buffer pointer*/
00095     uint8_t *element;
00096 };
00097  
00098 typedef struct buffer buffer_td;
00099 
00100 void init(buffer_td *buffer, int size);
00101 void flush_buffer_queue(buffer_td *buffer);
00102 int is_half_full(buffer_td *buffer);
00103 int is_half_empty(buffer_td *buffer);
00104 int full(buffer_td *buffer);
00105 int empty(buffer_td *buffer);
00106 void push_buffer(buffer_td *buffer, uint8_t *data);
00107 uint8_t * pop_buffer_queue(buffer_td *buffer);
00108 uint8_t * popstack(buffer_td *buffer);
00109 uint8_t * prefetch_buffer_queue(buffer_td *buffer);
00110 void rewind_buffer_queue(buffer_td *buffer , int count);
00111 
00112 /**
00113   * @}
00114   */
00115 
00116 /**
00117   * @}
00118   */
00119 
00120 /**
00121   * @}
00122   */
00123   
00124 /**
00125   * @}
00126   */
00127 
00128 
00129 
00130 #endif