sys/dev/pci/n8/common/config.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  * @(#) config.h 1.20@(#)
  37  *****************************************************************************/
  38
  39 /*****************************************************************************/
  40 /** @file config.h
  41  *  @brief NSP2000 Device Driver Configuration Manager
  42  *
  43  * This header contains the prototypes for the configuration management
  44  * routines for the NSP2000 device driver.
  45  *
  46  *****************************************************************************/
  47
  48 /*****************************************************************************
  49  * Revision history:
  50  * 04/30/03 brr   Reconcile differences between 2.4 & 3.0 baselines.
  51  * 03/03/03 jpw   Added N8_EnableAmbaTimer_g param to N8_ConfigInterrupts
  52  * 11/25/02 brr   Renamed prototypes to more close match function
  53  *                descriptions.
  54  * 10/23/02 brr   Modified N8_ConfigInterrupts to accept parameter for
  55  *                the AMBA timer preset.
  56  * 03/20/02 brr   Modified N8_ConfigInterrupts to configure & enable
  57  *                interrupts on all detected devices.
  58  * 03/01/02 brr   Added N8_DisableInterrupts.
  59  * 02/15/02 brr   Modified N8_GetConfig to return all driver information in a
  60  *                single call.
  61  * 12/14/01 brr   Support memory management performance improvements.
  62  * 11/26/01 mmd   Updated parms for N8_ConfigInit to accomodate new PCIinfo
  63  *                field of NspInstance_t.
  64  * 11/13/01 mmd   Implemented N8_AllocateHardwareResources and
  65  *                N8_ReleaseHardwareResources.
  66  * 11/10/01 brr   Modified to support static allocations of persistant data
  67  *                by the driver.
  68  * 10/22/01 mmd   Implemented N8_ClaimHardwareInstance and
  69  *                N8_ReleaseHardwareInstance.
  70  * 10/12/01 mmd   Added prototypes for N8_OpenRulesChecker,
  71  *                N8_CloseRulesChecker, and N8_PurgeNextRelatedSession.
  72  * 09/25/01 mmd   Creation.
  73  ****************************************************************************/
  74 /** @defgroup NSP2000Driver NSP2000 Device Driver Configuration Manager
  75  */
  76
  77
  78 #ifndef CONFIG_H
  79 #define CONFIG_H
  80
  81 #include "n8_driver_main.h"
  82 #include "n8_driver_parms.h"
  83
  84 /************************************************************************
  85  * The Constants below define the minimum and maximum values permitted  *
  86  * for the EA & PK command queue sizes.                                 *
  87  ************************************************************************/
  88 #define N8_MIN_CMD_QUE_EXP            4
  89 #define N8_MAX_CMD_QUE_EXP           15
  90
  91 #define N8_DEF_RNG_QUE_SIZE       (1<<N8_DEF_RNG_QUE_EXP)
  92
  93 extern int n8_chipInit(NspInstance_t *NSPinstance_p,
  94                        int            HWidx,
  95                        int            queueSize,
  96                        unsigned char  Debug);
  97
  98 extern N8_Status_t  n8_chipRemove(NspInstance_t *NSPinstance_p, int HWidx);
  99
 100 extern void n8_enableInterrupts (int timer_preset);
 101 extern void n8_disableInterrupts(void );
 102 extern void N8_GetConfig(NSPdriverInfo_t *driverInfo_p);
 103
 104 extern int n8_driverInit(int eaPoolSize, int pkPoolSize);
 105 extern int n8_driverRemove(void);
 106
 107 #endif   /* CONFIG_H */
 108
 109
 110