lib/include/queue.h

Go to the documentation of this file.

//  This file is part of MOS, the MANTIS Operating System
//  See http://mantis.cs.colorado.edu/
//
//  Copyright (c) 2002 - 2007 University of Colorado, Boulder
//
//   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 the MANTIS Project 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 QUEUE_H_
#define QUEUE_H_

#include <inttypes.h>

/*error codes*/
#define Q_OK 0
#define Q_FULL 1
#define Q_UNDERFLOW 2
#define Q_EMPTY 3

typedef struct
{
  uint8_t *buf;    
  uint8_t size;    
  //  uint8_t head, tail;
  uint8_t length;  
  uint8_t head;    
  //  uint8_t tail = (head + length - 1) % size
} queue_t;

void mos_queue_init(queue_t *q, uint8_t *buffer, uint8_t size);

uint8_t mos_queue_add(queue_t *q, uint8_t byte);

uint8_t mos_queue_length(queue_t *q);

uint8_t mos_queue_remove(queue_t *q, uint8_t *byte);

uint8_t mos_queue_dump(queue_t *q, uint8_t dumpNum);

uint8_t mos_queue_peek(queue_t *q, uint8_t index, uint8_t *byte);

void mos_queue_cleanup(queue_t *q);

#endif

---