sys/dev/pci/n8/common/contextMem.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  * @(#) contextMem.h 1.8@(#)
  38  *****************************************************************************/
  39
  40 /*****************************************************************************/
  41 /** @file contextMem.h
  42  *  @brief Contains declarations for Context management Interface.
  43  *
  44  *
  45  *****************************************************************************/
  46
  47
  48 /*****************************************************************************
  49  * Revision history:
  50  * 10/25/02 brr   Clean up function prototypes & include files.
  51  * 03/29/02 hml   Added proto for n8_contextvalidate. (BUGS 657 658).
  52  * 03/26/02 hml   Added proto for n8_contextfree.
  53  * 03/22/02 hml   Added new protos and a define.
  54  * 02/18/02 brr   Support chip selection.
  55  * 02/05/02 brr   Original version.
  56  ***************************************************************************/
  57
  58 #ifndef CONTEXTMEM_H
  59 #define CONTEXTMEM_H
  60 #include "n8_pub_common.h"
  61
  62 #define N8_CONTEXT_MAX_PRINT 20
  63 typedef struct
  64 {
  65   int     userID;
  66 } ContextMemoryMap_t;
  67
  68 void N8_ContextMemInit  (int chip);
  69 void N8_ContextMemRemove(int chip);
  70 void N8_ContextMemFreeAll(N8_Unit_t chip, unsigned long sessionID);
  71 N8_Status_t n8_contextalloc(N8_Unit_t *chip,
  72                             unsigned long sessionID,
  73                             unsigned int *index_p);
  74 N8_Status_t
  75 n8_contextfree(int chip, unsigned long sessionID, unsigned long entry);
  76 N8_Status_t
  77 n8_contextvalidate(N8_Unit_t chip, unsigned long sessionID, unsigned int entry);
  78 void n8_contextDisplay(void);
  79
  80
  81 #endif /* CONTEXTMEM_H */
  82