cbuf.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Sung Ho Park and CSOS
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef UBICLIB_CBUF_H_
#define UBICLIB_CBUF_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <ubinos_config.h>
#include <ubinos/type.h>
 
typedef struct _cbuf_t
{
    uint32_t head; 
    uint32_t tail; 
    uint32_t size; 
    uint8_t * buf; 
} cbuf_t;
 
typedef cbuf_t * cbuf_pt;
 
#define cbuf_def_init(_name, _size)         \
    uint8_t _name##_cbuf_buf[_size];        \
    cbuf_t _name##_cbuf = {                 \
        .head = 0,                          \
        .tail = 0,                          \
        .size = _size,                      \
        .buf = _name##_cbuf_buf,            \
    };                                      \
    cbuf_pt _name = &_name##_cbuf;
 
ubi_st_t cbuf_create(cbuf_pt * cbuf_p, uint32_t size);
 
ubi_st_t cbuf_delete(cbuf_pt * cbuf_p);
 
ubi_st_t cbuf_write(cbuf_pt cbuf, const uint8_t * buf, uint32_t len, uint32_t * written_p);
 
ubi_st_t cbuf_read(cbuf_pt cbuf, uint8_t * buf, uint32_t len, uint32_t * read_p);
 
ubi_st_t cbuf_view(cbuf_pt cbuf, uint8_t * buf, uint32_t len, uint32_t * read_p);
 
ubi_st_t cbuf_clear(cbuf_pt cbuf);
 
uint32_t cbuf_get_len(cbuf_pt cbuf);
 
uint32_t cbuf_get_empty_len(cbuf_pt cbuf);
 
uint8_t cbuf_is_full(cbuf_pt cbuf);
 
uint8_t * cbuf_get_head_addr(cbuf_pt cbuf);
 
uint8_t * cbuf_get_tail_addr(cbuf_pt cbuf);
 
uint32_t cbuf_get_contig_len(cbuf_pt cbuf);
 
uint32_t cbuf_get_contig_empty_len(cbuf_pt cbuf);
 
uint8_t cbuf_align_head(cbuf_pt cbuf, uint8_t align);
 
#ifdef __cplusplus
}
#endif
 
#endif /* UBICLIB_CBUF_H_ */