First version
[3rdparty/ote_partner/tlk.git] / include / lib / cbuf.h
1 /*
2  * Copyright (c) 2009 Travis Geiselbrecht
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files
6  * (the "Software"), to deal in the Software without restriction,
7  * including without limitation the rights to use, copy, modify, merge,
8  * publish, distribute, sublicense, and/or sell copies of the Software,
9  * and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  */
23 #ifndef __LIB_CBUF_H
24 #define __LIB_CBUF_H
25
26 #include <sys/types.h>
27 #include <kernel/event.h>
28
29 typedef struct cbuf {
30         uint head; 
31         uint tail;
32         uint len_pow2;
33         char *buf;
34         event_t event;
35 } cbuf_t;
36
37 void cbuf_initialize(cbuf_t *cbuf, size_t len);
38 size_t cbuf_read(cbuf_t *cbuf, void *_buf, size_t buflen, bool block);
39 size_t cbuf_write(cbuf_t *cbuf, const void *_buf, size_t len, bool canreschedule);
40 size_t cbuf_space_avail(cbuf_t *cbuf);
41
42 #endif
43