Steve Sims / X_NUCLEO_IDW01M1_AP

Dependents:   X_NUCLEO_IDW01M1_AP_Test

Fork of X_NUCLEO_IDW01M1 by ST

Embed: (wiki syntax)

« Back to documentation index

ring_buffer.h File Reference

ring_buffer.h File Reference

Header File for Circular Buffer management of the Wi-Fi module. More...

Go to the source code of this file.

Functions

void init (buffer_td *buffer, int size)
 init Initialize a circular buffer of type buffer_td
void flush_buffer_queue (buffer_td *buffer)
 flush_buffer_queue flushes the buffer
int is_half_full (buffer_td *buffer)
 is_half_full checks if the buffer is half full (empty)
int is_half_empty (buffer_td *buffer)
 is_half_empty checks if the buffer is less than half
int full (buffer_td *buffer)
 full indicates if the given buffer is full or not
int empty (buffer_td *buffer)
 empty indicates if the given buffer is empty or not
uint8_t * pop_buffer_queue (buffer_td *buffer)
 pop_buffer_queue dequeues the circular buffer
uint8_t * prefetch_buffer_queue (buffer_td *buffer)
 prefetch_buffer_queue prefetches the pipeline upto xx bytes
void rewind_buffer_queue (buffer_td *buffer, int count)
 rewinds_buffer_queue rewinds the circular buffer

Detailed Description

Header File for Circular Buffer management of the Wi-Fi module.

Author:
Central LAB
Version:
V2.0.0
Date:
10-February-2016
Attention:

© COPYRIGHT(c) 2015 STMicroelectronics

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.

Definition in file ring_buffer.h.