ChibiOS/RT  6.0.3
pipe_t Struct Reference

Structure representing a pipe object. More...

#include <chpipes.h>

Collaboration diagram for pipe_t:
Collaboration graph

Data Fields

uint8_t * buffer
 Pointer to the pipe buffer. More...
 
uint8_t * top
 Pointer to the location after the buffer. More...
 
uint8_t * wrptr
 Write pointer. More...
 
uint8_t * rdptr
 Read pointer. More...
 
size_t cnt
 Bytes in the pipe. More...
 
bool reset
 True if in reset state. More...
 
thread_reference_t wtr
 Waiting writer. More...
 
thread_reference_t rtr
 Waiting reader. More...
 
mutex_t cmtx
 Common access mutex. More...
 
mutex_t wmtx
 Write access mutex. More...
 
mutex_t rmtx
 Read access mutex. More...
 

Detailed Description

Structure representing a pipe object.

Definition at line 52 of file chpipes.h.

Field Documentation

uint8_t* pipe_t::buffer

Pointer to the pipe buffer.

Definition at line 53 of file chpipes.h.

Referenced by chPipeGetSize(), chPipeObjectInit(), chPipeReset(), pipe_read(), and pipe_write().

uint8_t* pipe_t::top

Pointer to the location after the buffer.

Definition at line 55 of file chpipes.h.

Referenced by chPipeGetSize(), chPipeObjectInit(), pipe_read(), and pipe_write().

uint8_t* pipe_t::wrptr

Write pointer.

Definition at line 57 of file chpipes.h.

Referenced by chPipeObjectInit(), chPipeReset(), and pipe_write().

uint8_t* pipe_t::rdptr

Read pointer.

Definition at line 58 of file chpipes.h.

Referenced by chPipeObjectInit(), chPipeReset(), and pipe_read().

size_t pipe_t::cnt

Bytes in the pipe.

Definition at line 59 of file chpipes.h.

Referenced by chPipeGetUsedCount(), chPipeObjectInit(), chPipeReset(), pipe_read(), and pipe_write().

bool pipe_t::reset

True if in reset state.

Definition at line 60 of file chpipes.h.

Referenced by chPipeObjectInit(), chPipeReadTimeout(), chPipeReset(), chPipeResume(), and chPipeWriteTimeout().

thread_reference_t pipe_t::wtr

Waiting writer.

Definition at line 61 of file chpipes.h.

Referenced by chPipeObjectInit(), chPipeReadTimeout(), chPipeReset(), and chPipeWriteTimeout().

thread_reference_t pipe_t::rtr

Waiting reader.

Definition at line 62 of file chpipes.h.

Referenced by chPipeObjectInit(), chPipeReadTimeout(), chPipeReset(), and chPipeWriteTimeout().

mutex_t pipe_t::cmtx

Common access mutex.

Definition at line 64 of file chpipes.h.

mutex_t pipe_t::wmtx

Write access mutex.

Definition at line 65 of file chpipes.h.

mutex_t pipe_t::rmtx

Read access mutex.

Definition at line 66 of file chpipes.h.