Paparazzi UAS v7.1_unstable
Paparazzi is a free software Unmanned Aircraft System.
Loading...
Searching...
No Matches
ring_buffer.h File Reference
#include <inttypes.h>
#include <stddef.h>
Include dependency graph for ring_buffer.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ring_buffer_t

Functions

void ring_buffer_init (ring_buffer_t *ring_buffer, uint8_t *buf, size_t size)
 Init.
size_t ring_buffer_write (ring_buffer_t *ring_buffer, const uint8_t *data, size_t len)
 Write.
size_t ring_buffer_read (ring_buffer_t *ring_buffer, uint8_t *read_buffer, size_t len)
 Read.
size_t ring_buffer_available (ring_buffer_t *ring_buffer)
size_t ring_buffer_free_space (ring_buffer_t *ring_buffer)

Data Structure Documentation

◆ ring_buffer_t

struct ring_buffer_t

Definition at line 14 of file ring_buffer.h.

Data Fields
uint8_t * buf
size_t read_offset
size_t size
size_t write_offset

Function Documentation

◆ ring_buffer_available()

size_t ring_buffer_available ( ring_buffer_t * ring_buffer)
Returns
the number of bytes available in the
Parameters
ring_buffer.

Definition at line 27 of file ring_buffer.c.

References RB_LOAD, ring_buffer_t::read_offset, ring_buffer_t::size, and ring_buffer_t::write_offset.

Referenced by ring_buffer_free_space(), ring_buffer_read(), tunnel_uavcan_char_available(), and tunnel_uavcan_send_message().

Here is the caller graph for this function:

◆ ring_buffer_free_space()

size_t ring_buffer_free_space ( ring_buffer_t * ring_buffer)
Returns
the number of bytes that can be written in
Parameters
ring_buffer

Definition at line 38 of file ring_buffer.c.

References ring_buffer_available(), and ring_buffer_t::size.

Referenced by ring_buffer_write(), and tunnel_uavcan_check_free_space().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ring_buffer_init()

void ring_buffer_init ( ring_buffer_t * ring_buffer,
uint8_t * buf,
size_t size )

Init.

Parameters
ring_bufferwith the
bufsubjacent buffer of size
size.

Definition at line 20 of file ring_buffer.c.

References ring_buffer_t::buf, ring_buffer_t::read_offset, ring_buffer_t::size, and ring_buffer_t::write_offset.

Referenced by tunnel_uavcan_init_periph().

Here is the caller graph for this function:

◆ ring_buffer_read()

size_t ring_buffer_read ( ring_buffer_t * ring_buffer,
uint8_t * read_buffer,
size_t len )

Read.

Parameters
lenbytes from
ring_bufferinto
read_buffer.
Returns
the number of byte effectively read from the ring_buffer.

Definition at line 68 of file ring_buffer.c.

References ring_buffer_t::buf, RB_STORE, ring_buffer_t::read_offset, ring_buffer_available(), and ring_buffer_t::size.

Referenced by tunnel_uavcan_get_byte(), and tunnel_uavcan_send_message().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ring_buffer_write()

size_t ring_buffer_write ( ring_buffer_t * ring_buffer,
const uint8_t * data,
size_t len )

Write.

Parameters
dataof size
lenin
ring_buffer.
Returns
the number of byte effectively written in the ring_buffer.

Definition at line 43 of file ring_buffer.c.

References ring_buffer_t::buf, RB_STORE, ring_buffer_free_space(), ring_buffer_t::size, and ring_buffer_t::write_offset.

Referenced by tunnel_uavcan_cb(), and tunnel_uavcan_put_buffer().

Here is the call graph for this function:
Here is the caller graph for this function: