RingBuf.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2020, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  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.
 *
 * *  Neither the name of Texas Instruments Incorporated 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 OWNER 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.
 */

#ifndef ti_drivers_utils_RingBuf__include
#define ti_drivers_utils_RingBuf__include

#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct
{
    unsigned char *buffer;
    size_t length;
    size_t count;
    size_t head;
    size_t tail;
    size_t maxCount;
} RingBuf_Object, *RingBuf_Handle;

void RingBuf_construct(RingBuf_Handle object, unsigned char *bufPtr, size_t bufSize);

void RingBuf_flush(RingBuf_Handle object);

int RingBuf_get(RingBuf_Handle object, unsigned char *data);

int RingBuf_getConsume(RingBuf_Handle object, size_t size);

int RingBuf_getCount(RingBuf_Handle object);

int RingBuf_getMaxCount(RingBuf_Handle object);

int RingBuf_getn(RingBuf_Handle object, unsigned char *data, size_t n);

int RingBuf_getPointer(RingBuf_Handle object, unsigned char **data);

bool RingBuf_isFull(RingBuf_Handle object);

int RingBuf_peek(RingBuf_Handle object, unsigned char *data);

int RingBuf_put(RingBuf_Handle object, unsigned char data);

int RingBuf_putAdvance(RingBuf_Handle object, size_t size);

int RingBuf_putn(RingBuf_Handle object, unsigned char *data, size_t n);

int RingBuf_putPointer(RingBuf_Handle object, unsigned char **data);

static inline size_t RingBuf_space(RingBuf_Handle object)
{
    return (object->length - object->count);
}

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_utils_RingBuf__include */