sys/dev/pci/n8/QMgr/QMUtil.h

   1 /*-
   2  * Copyright (C) 2001-2003 by NBMK Encryption Technologies.
   3  * All rights reserved.
   4  *
   5  * NBMK Encryption Technologies provides no support of any kind for
   6  * this software.  Questions or concerns about it may be addressed to
   7  * the members of the relevant open-source community at
   8  * <tech-crypto@netbsd.org>.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions are
  12  * met:
  13  *
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  *
  17  * 2. Redistributions in binary form must reproduce the above
  18  *    copyright notice, this list of conditions and the following
  19  *    disclaimer in the documentation and/or other materials provided
  20  *    with the distribution.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35
  36 /*****************************************************************************
  37  * @(#) QMUtil.h 1.6@(#)
  38  *****************************************************************************/
  39
  40 /*****************************************************************************/
  41 /** @file QMUtil.h
  42  *  @brief Include file for the queue manager utilities.
  43  *
  44  *****************************************************************************/
  45
  46 /*****************************************************************************
  47  * Revision history:
  48  * 03/20/03 brr   Added prototype for displayQMgr.
  49  * 10/25/02 brr   Clean up function prototypes & include files.
  50  * 06/05/02 brr   Removed obsolete prototypes.
  51  * 02/21/02 msz   Deleted now unused QMgr_QueueInitialized
  52  * 02/20/02 msz   Added QMgrCheckRequests
  53  * 12/05/01 msz   Moved some common RNQueue, QMQueue into here QMUtil.c
  54  * 10/05/01 msz   Added QMgr_QueueGetChipAndUnit
  55  * 10/03/01 msz   Include the include files needed to compile this header.
  56  * 09/24/01 hml   Converted QMgr_get_valid_unit_num to use N8_Unit_t.
  57  * 09/20/01 hml   Added QMgr_get_valid_unit_num.
  58  * 09/06/01 hml   Added QMgr_get_psuedo_device_handle proto.
  59  * 08/27/01 hml   Added QMgr_get_num_control_structs function.
  60  * 09/26/01 msz   Added QMgr_QueueInitialized
  61  * 07/30/01 bac   Added QMCopy function.
  62  * 06/15/01 hml   Original version.
  63  ****************************************************************************/
  64 #ifndef _QMUTIL_H
  65 #define _QMUTIL_H
  66
  67 #include "n8_enqueue_common.h"
  68 #include "n8_pub_common.h"
  69 #include "n8_common.h"
  70 #include "QMQueue.h"
  71
  72 /*****************************************************************************
  73  * #defines
  74  *****************************************************************************/
  75
  76 /*****************************************************************************
  77  * Structures/type definitions
  78  *****************************************************************************/
  79
  80 /*****************************************************************************
  81  * Function prototypes
  82  *****************************************************************************/
  83
  84 N8_Status_t
  85 QMgr_get_chip_for_request (QueueControl_t  **queue_pp,
  86                            N8_Component_t    unit );
  87
  88 N8_Status_t
  89 QMgr_get_control_struct(QueueControl_t  **queue_pp,
  90                         N8_Component_t    unit,
  91                         int               chip);
  92
  93 N8_Status_t
  94 QMgr_get_valid_unit_num(N8_Component_t type,
  95                         N8_Unit_t      unitRequest,
  96                         N8_Unit_t     *unitReturn);
  97 void displayQMgr(void);
  98
  99
 100 #endif