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