sys/dev/pci/n8/include_public/n8_pub_buffer.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_buffer.h 1.6@(#)
  37  *****************************************************************************/
  38
  39 /*****************************************************************************/
  40 /** @file n8_pub_buffer
  41  *  @brief Common declarations for buffer operations.
  42  *
  43  * Public header file for buffer operations.
  44  *
  45  *****************************************************************************/
  46
  47 /*****************************************************************************
  48  * Revision history:
  49  * 06/05/03 brr   Added prototypes for N8_DeleteSizedBuffer & N8_DeleteBuffer.
  50  * 02/06/02 hml   Original version.
  51  ****************************************************************************/
  52 #ifndef N8_PUB_BUFFER_H
  53 #define N8_PUB_BUFFER_H
  54
  55 #ifdef __cplusplus
  56 extern "C"
  57 {
  58 #endif
  59
  60 #include "n8_pub_common.h"
  61
  62 #define MAX_BC_NUM_BYTE_SIZE     512
  63
  64 typedef unsigned char *N8_BufferHandle_t;
  65
  66 typedef struct{
  67    int length;
  68    int offset;
  69    char value[MAX_BC_NUM_BYTE_SIZE + 1];  /* 4096 bits plus a null */
  70 } ATTR;
  71
  72 /*****************************************************************************
  73  * Function prototypes
  74  *****************************************************************************/
  75 N8_Status_t N8_BufferAllocate(N8_BufferHandle_t *bufferHandle_p,
  76                               N8_Buffer_t **virtualAddress_pp,
  77                               const unsigned int size);
  78
  79 N8_Status_t N8_BufferFree(N8_BufferHandle_t bufferHandle);
  80
  81 #ifndef __KERNEL__
  82 N8_Status_t N8_CreateSizedBufferFromATTR(N8_SizedBuffer_t *buf_p,
  83                                  const ATTR *attr_p);
  84 N8_Status_t N8_CreateSizedBufferFromString(const char *str_p, N8_SizedBuffer_t *buf_p);
  85 N8_Status_t N8_DeleteSizedBuffer(N8_SizedBuffer_t *buf_p);
  86
  87 N8_Buffer_t *N8_CreateBuffer(const char *e);
  88 N8_Status_t N8_DeleteBuffer(N8_Buffer_t *buf_p);
  89 #endif /* __KERNEL__ */
  90
  91 #ifdef __cplusplus
  92 }
  93 #endif
  94
  95 #endif /* N8_PUB_BUFFER_H */
  96
  97