| 1 | /*
|
|---|
| 2 | * Copyright (c) 2017 Jiri Svoboda
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup libc
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /** @file Circular buffer
|
|---|
| 33 | */
|
|---|
| 34 |
|
|---|
| 35 | #ifndef _LIBC_CIRC_BUF_H_
|
|---|
| 36 | #define _LIBC_CIRC_BUF_H_
|
|---|
| 37 |
|
|---|
| 38 | #include <errno.h>
|
|---|
| 39 | #include <stddef.h>
|
|---|
| 40 |
|
|---|
| 41 | /** Circular buffer */
|
|---|
| 42 | typedef struct {
|
|---|
| 43 | /** Buffer */
|
|---|
| 44 | void *buf;
|
|---|
| 45 | /** Number of buffer members */
|
|---|
| 46 | size_t nmemb;
|
|---|
| 47 | /** Member size */
|
|---|
| 48 | size_t size;
|
|---|
| 49 | /** Read position */
|
|---|
| 50 | size_t rp;
|
|---|
| 51 | /** Write position */
|
|---|
| 52 | size_t wp;
|
|---|
| 53 | /** Number of used entries */
|
|---|
| 54 | size_t nused;
|
|---|
| 55 | } circ_buf_t;
|
|---|
| 56 |
|
|---|
| 57 | extern void circ_buf_init(circ_buf_t *, void *, size_t, size_t);
|
|---|
| 58 | extern size_t circ_buf_nfree(circ_buf_t *);
|
|---|
| 59 | extern size_t circ_buf_nused(circ_buf_t *);
|
|---|
| 60 | extern errno_t circ_buf_push(circ_buf_t *, const void *);
|
|---|
| 61 | extern errno_t circ_buf_pop(circ_buf_t *, void *);
|
|---|
| 62 |
|
|---|
| 63 | #endif
|
|---|
| 64 |
|
|---|
| 65 | /** @}
|
|---|
| 66 | */
|
|---|
