event_buffer.h

00001   /**
00002   ******************************************************************************
00003   * @file    event_buffer.h
00004   * @author  Central LAB
00005   * @version V2.0.0
00006   * @date    10-February-2016
00007   * @brief   Header File for Event 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 #include "wifi_module.h"
00044 #ifndef __EVENT_BUFFER_H
00045 #define __EVENT_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 typedef enum
00089 {
00090   WIFI_NO_EVENT,
00091   WIFI_WIND_EVENT = 0x0001,
00092   WIFI_SOCK_ID_EVENT,
00093   WIFI_GCFG_EVENT,
00094   WIFI_GPIO_EVENT,
00095   WIFI_OK_EVENT,
00096   WIFI_ERROR_EVENT,
00097   WIFI_STANDBY_CONFIG_EVENT,
00098   WIFI_RESUME_CONFIG_EVENT,
00099   WIFI_HTTP_EVENT,
00100   WIFI_CLIENT_SOCKET_WRITE_EVENT,
00101   WIFI_FILE_EVENT,
00102   WIFI_CLIENT_SOCKET_OPEN_EVENT,
00103   WIFI_CLIENT_SOCKET_CLOSE_EVENT,
00104   WIFI_FW_UPDATE_EVENT,
00105 } event_e;
00106 
00107 
00108 typedef struct
00109 {
00110   uint32_t wind;
00111   uint32_t data_length;
00112   uint16_t socket_id;
00113   uint8_t  wind64_pending_packet_no;
00114   wifi_bool enc;         
00115   wifi_bool ok_eval; 
00116   wifi_bool event_pop;
00117   event_e event;
00118 } event_s_TypeDef;
00119 
00120 struct event_buffer {    
00121     volatile int start;  // position of first data from USART
00122     volatile int end;    // position of last data from USART
00123     volatile int size;   //Max size in terms of number of data packets (Total Bytes/size of each packet (8 bytes))
00124     volatile int count;  // number of currently filled data packets (=size if full & =0 if empty)
00125     
00126     /*unsigned main buffer pointer*/
00127     event_s_TypeDef *element;
00128 };
00129  
00130 typedef struct event_buffer buffer_e;
00131 
00132 void event_init(buffer_e *buffer, int size);
00133 int event_full(buffer_e *buffer);
00134 int event_empty(buffer_e *buffer);
00135 void push_eventbuffer(buffer_e *buffer, event_s_TypeDef data);
00136 event_s_TypeDef * pop_eventbuffer_queue(buffer_e *buffer);
00137 void reset_event(event_s_TypeDef *r_event);
00138 
00139 /**
00140   * @}
00141   */
00142 
00143 /**
00144   * @}
00145   */
00146 
00147 /**
00148   * @}
00149   */
00150   
00151 /**
00152   * @}
00153   */
00154 
00155 
00156 
00157 #endif