aversive_10-03-12/modules/base/cirbuf/cirbuf.h

Go to the documentation of this file.

/*  
 *  Copyright Droids Corporation (2007)
 *  Olivier MATZ <zer0@droids-corp.org>
 * 
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Revision : $Id: cirbuf.h,v 1.3 2009-03-15 21:51:16 zer0 Exp $
 *
 *
 */

#ifndef _CIRBUF_H_
#define _CIRBUF_H_

#include <aversive.h>
#include <stdio.h>

#ifdef CONFIG_MODULE_CIRBUF_LARGE
typedef signed int cirbuf_int;
typedef unsigned int cirbuf_uint;
#else
typedef signed char cirbuf_int;
typedef unsigned char cirbuf_uint;
#endif

struct cirbuf {
        cirbuf_uint maxlen;             
        volatile cirbuf_uint start;     
        volatile cirbuf_uint end;       
        volatile cirbuf_uint len;       
        char *buf;
};

/* #define CIRBUF_DEBUG */

#ifdef CIRBUF_DEBUG
#define dprintf(fmt, ...) printf("line %3.3d - " fmt, __LINE__, ##__VA_ARGS__)
#else
#define dprintf(args...) do {} while(0)
#endif


void cirbuf_init(struct cirbuf *cbuf, char *buf, cirbuf_uint start, cirbuf_uint maxlen);


#define CIRBUF_IS_FULL(cirbuf) ((cirbuf)->maxlen == (cirbuf)->len)

#define CIRBUF_IS_EMPTY(cirbuf) ((cirbuf)->len == 0)

#define CIRBUF_GET_LEN(cirbuf) ((cirbuf)->len)

#define CIRBUF_GET_MAXLEN(cirbuf) ((cirbuf)->maxlen)

#define CIRBUF_GET_FREELEN(cirbuf) ((cirbuf)->maxlen - (cirbuf)->len)

#define CIRBUF_FOREACH(c, i, e)                                 \
        for ( i=0, e=(c)->buf[(c)->start] ;                     \
              i<((c)->len) ;                                    \
              i ++,  e=(c)->buf[((c)->start+i)%((c)->maxlen)])


cirbuf_int cirbuf_add_head_safe(struct cirbuf *cbuf, char c);

void cirbuf_add_head(struct cirbuf *cbuf, char c);

cirbuf_int cirbuf_add_tail_safe(struct cirbuf *cbuf, char c);

void cirbuf_add_tail(struct cirbuf *cbuf, char c);

cirbuf_int cirbuf_del_head_safe(struct cirbuf *cbuf);

void cirbuf_del_head(struct cirbuf *cbuf);

cirbuf_int cirbuf_del_tail_safe(struct cirbuf *cbuf);

void cirbuf_del_tail(struct cirbuf *cbuf);

char cirbuf_get_head(struct cirbuf *cbuf);

char cirbuf_get_tail(struct cirbuf *cbuf);



cirbuf_int cirbuf_add_buf_head(struct cirbuf *cbuf, const char *c, cirbuf_uint n);

cirbuf_int cirbuf_add_buf_tail(struct cirbuf *cbuf, const char *c, cirbuf_uint n);

cirbuf_int cirbuf_del_buf_head(struct cirbuf *cbuf, cirbuf_uint size);

cirbuf_int cirbuf_del_buf_tail(struct cirbuf *cbuf, cirbuf_uint size);

cirbuf_int cirbuf_get_buf_head(struct cirbuf *cbuf, char *c, cirbuf_uint size);

cirbuf_int cirbuf_get_buf_tail(struct cirbuf *cbuf, char *c, cirbuf_uint size);


void cirbuf_align_left(struct cirbuf *cbuf);

void cirbuf_align_right(struct cirbuf *cbuf);

#endif /* _CIRBUF_H_ */

---