qbsbuffers.h

 
#ifndef QBSBUFFERS_H
    #define QBSBUFFERS_H
 
    #include "qtypes.h"
 
    #ifdef __cplusplus
    extern "C" {
    #endif
 
    #ifndef Q_BYTE_SIZED_BUFFERS
        #define Q_BYTE_SIZED_BUFFERS    ( 1 )
    #endif
 
    typedef struct _qBSBuffer_s { // skipcq: CXX-E2000
        struct _qBSBuffer_Private_s { // skipcq: CXX-E2000
            volatile qUINT8_t *buffer;  /*< Points to the beginning of the buffer storage area. */
            volatile qIndex_t head;     /*< Used to hold the index of the head. */
            volatile qIndex_t tail;     /*< Used to hold the index of the tail. */
            size_t length;              /*< The length of the buffer(a valid power of two). */
        }
        qPrivate;
    }
    qBSBuffer_t;
 
    size_t qBSBuffer_Count( const qBSBuffer_t * const b );
 
    qBool_t qBSBuffer_IsFull( const qBSBuffer_t * const b );
 
    qBool_t qBSBuffer_Empty( const qBSBuffer_t * const b );
 
    qUINT8_t qBSBuffer_Peek( const qBSBuffer_t * const b );
 
    qBool_t qBSBuffer_Get( qBSBuffer_t * const b,
                           qUINT8_t *dst );
 
    qBool_t qBSBuffer_Read( qBSBuffer_t * const b,
                            void *dst,
                            const size_t n );
 
    qBool_t qBSBuffer_Put( qBSBuffer_t * const b,
                           const qUINT8_t bData );
 
    qBool_t qBSBuffer_Setup( qBSBuffer_t * const b,
                             volatile qUINT8_t *pBuffer,
                             const size_t length );
 
    #ifdef __cplusplus
    }
    #endif
 
#endif