Home | History | Annotate | Download | only in utils
      1 /*
      2  * queue.h
      3  *
      4  * Copyright(c) 1998 - 2009 Texas Instruments. All rights reserved.
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  *
     11  *  * Redistributions of source code must retain the above copyright
     12  *    notice, this list of conditions and the following disclaimer.
     13  *  * Redistributions in binary form must reproduce the above copyright
     14  *    notice, this list of conditions and the following disclaimer in
     15  *    the documentation and/or other materials provided with the
     16  *    distribution.
     17  *  * Neither the name Texas Instruments nor the names of its
     18  *    contributors may be used to endorse or promote products derived
     19  *    from this software without specific prior written permission.
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     32  */
     33 
     34 
     35 
     36 /** \file   queue.h
     37  *  \brief  queue module header file.
     38  *
     39  *  \see    queue.c
     40  */
     41 
     42 
     43 #ifndef _QUEUE_H_
     44 #define _QUEUE_H_
     45 
     46 
     47 #define QUE_UNLIMITED_SIZE      0xFFFFFFFF
     48 
     49 /* A queue node header structure */
     50 typedef struct _TQueNodeHdr
     51 {
     52     struct _TQueNodeHdr *pNext;
     53     struct _TQueNodeHdr *pPrev;
     54 } TQueNodeHdr;
     55 
     56 
     57 
     58 /* External Functions Prototypes */
     59 /* ============================= */
     60 TI_HANDLE que_Create  (TI_HANDLE hOs, TI_HANDLE hReport, TI_UINT32 uLimit, TI_UINT32 uNodeHeaderOffset);
     61 TI_STATUS que_Destroy (TI_HANDLE hQue);
     62 TI_STATUS que_Enqueue (TI_HANDLE hQue, TI_HANDLE hItem);
     63 TI_HANDLE que_Dequeue (TI_HANDLE hQue);
     64 TI_STATUS que_Requeue (TI_HANDLE hQue, TI_HANDLE hItem);
     65 TI_UINT32 que_Size    (TI_HANDLE hQue);
     66 
     67 #ifdef TI_DBG
     68 void      que_Print   (TI_HANDLE hQue);
     69 #endif /* TI_DBG */
     70 
     71 
     72 
     73 #endif  /* _QUEUE_H_ */
     74