tinyusb  0.4
Click here to lend your support to tinyusb donation and make a donation at pledgie.com
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
fifo.h File Reference
#include "common/common.h"

Go to the source code of this file.

Data Structures

struct  fifo_t
 Simple Circular FIFO. More...
 

Macros

#define FIFO_DEF(name, ff_depth, type, is_overwritable)
 

Functions

bool fifo_write (fifo_t *f, void const *p_data)
 Write one byte into the RX buffer. More...
 
bool fifo_read (fifo_t *f, void *p_buffer)
 Read one byte out of the RX buffer. More...
 
void fifo_clear (fifo_t *f)
 Clear the fifo read and write pointers and set length to zero. More...
 
static bool fifo_is_empty (fifo_t *f) ATTR_PURE ATTR_ALWAYS_INLINE
 
static bool fifo_is_full (fifo_t *f) ATTR_PURE ATTR_ALWAYS_INLINE
 
static uint16_t fifo_get_length (fifo_t *f) ATTR_PURE ATTR_ALWAYS_INLINE
 

Detailed Description

Author
hathach (tinyusb.org)

LICENSE

Software License Agreement (BSD License)

Copyright (c) 2013, hathach (tinyusb.org) All rights reserved.

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 the copyright holders 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 ''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 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.

This file is part of the tinyusb stack.

Definition in file fifo.h.