sys/dev/pci/n8/include_public/n8_pub_context.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  * @(#) n8_pub_context.h 1.5@(#)
  37  *****************************************************************************/
  38
  39 /*****************************************************************************/
  40 /** @file n8_pub_context
  41  *  @brief Common declarations for context memory operations.
  42  *
  43  * Public header file for context memory operations.
  44  *
  45  *****************************************************************************/
  46
  47 /*****************************************************************************
  48  * Revision history:
  49  * 08/05/03 bac   Removed #define N8_CONTEXT_INDEX_MAX_VALUE 262143 as it wasn't
  50  *                being used any more.
  51  * 10/24/01 dkm   Moved max index define from n8_contextM.h.
  52  * 10/12/01 dkm   Original version.
  53  ****************************************************************************/
  54 #ifndef N8_PUB_CONTEXT_H
  55 #define N8_PUB_CONTEXT_H
  56
  57 #ifdef __cplusplus
  58 extern "C"
  59 {
  60 #endif
  61
  62 #include "n8_pub_common.h"
  63
  64 /*****************************************************************************
  65  * Function prototypes
  66  *****************************************************************************/
  67 N8_Status_t N8_AllocateContext (N8_ContextHandle_t *contextHandle_p,
  68                                 N8_Unit_t unitID);
  69
  70 N8_Status_t N8_FreeContext (const N8_ContextHandle_t contextHandle,
  71                             N8_Event_t               *event_p);
  72
  73 N8_Status_t N8_WriteContext  (N8_ContextHandle_t contextHandle,
  74                               N8_Buffer_t        *context_p,
  75                               uint32_t           contextLength,
  76                               N8_Event_t         *event_p );
  77
  78 N8_Status_t N8_ReadContext  (N8_ContextHandle_t contextHandle,
  79                               N8_Buffer_t        *context_p,
  80                               uint32_t           contextLength,
  81                               N8_Event_t         *event_p );
  82
  83 #ifdef __cplusplus
  84 }
  85 #endif
  86
  87 #endif
  88
  89