cpu/ixp/npe/include/IxQMgrQAccess_p.h

   1 /**
   2  * @file    IxQMgrQAccess_p.h
   3  *
   4  * @author Intel Corporation
   5  * @date    30-Oct-2001
   6  *
   7  * @brief   QAccess private header file
   8  *
   9  *
  10  * @par
  11  * IXP400 SW Release version 2.0
  12  *
  13  * -- Copyright Notice --
  14  *
  15  * @par
  16  * Copyright 2001-2005, Intel Corporation.
  17  * All rights reserved.
  18  *
  19  * @par
  20  * Redistribution and use in source and binary forms, with or without
  21  * modification, are permitted provided that the following conditions
  22  * are met:
  23  * 1. Redistributions of source code must retain the above copyright
  24  *    notice, this list of conditions and the following disclaimer.
  25  * 2. Redistributions in binary form must reproduce the above copyright
  26  *    notice, this list of conditions and the following disclaimer in the
  27  *    documentation and/or other materials provided with the distribution.
  28  * 3. Neither the name of the Intel Corporation nor the names of its contributors
  29  *    may be used to endorse or promote products derived from this software
  30  *    without specific prior written permission.
  31  *
  32  * @par
  33  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
  34  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  35  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  36  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
  37  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  38  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  39  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  40  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  41  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  42  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  43  * SUCH DAMAGE.
  44  *
  45  * @par
  46  * -- End of Copyright Notice --
  47 */
  48
  49 #ifndef IXQMGRQACCESS_P_H
  50 #define IXQMGRQACCESS_P_H
  51
  52 /*
  53  * User defined header files
  54  */
  55 #include "IxQMgr.h"
  56
  57 /*
  58  * Global variables declarations.
  59  */
  60 extern volatile UINT32 * ixQMgrAqmIfQueAccRegAddr[];
  61
  62 /*
  63  * Initialise the Queue Access component
  64  */
  65 void
  66 ixQMgrQAccessInit (void);
  67
  68 /*
  69  * read the remainder of a multi-word queue entry
  70  * (the first word is already read)
  71  */
  72 IX_STATUS
  73 ixQMgrQReadMWordsMinus1 (IxQMgrQId qId,
  74                          UINT32 *entry);
  75
  76 /*
  77  * Fast access : pop a q entry from a single word queue
  78  */
  79 extern __inline__ UINT32 ixQMgrQAccessPop(IxQMgrQId qId);
  80
  81 extern __inline__ UINT32 ixQMgrQAccessPop(IxQMgrQId qId)
  82 {
  83   return *(ixQMgrAqmIfQueAccRegAddr[qId]);
  84 }
  85
  86 /*
  87  * Fast access : push a q entry in a single word queue
  88  */
  89 extern __inline__ void ixQMgrQAccessPush(IxQMgrQId qId, UINT32 entry);
  90
  91 extern __inline__ void ixQMgrQAccessPush(IxQMgrQId qId, UINT32 entry)
  92 {
  93   *(ixQMgrAqmIfQueAccRegAddr[qId]) = entry;
  94 }
  95
  96 #endif/*IXQMGRQACCESS_P_H*/