sys/dev/pci/n8/include_private/n8_SKSManager.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_SKSManager.h 1.2@(#)
  37  *****************************************************************************/
  38
  39 /*****************************************************************************/
  40 /** @file n8_SKSManager.h
  41  *  @brief NSP2000 SKS Manager
  42  *
  43  * This file has declarations for the SKS Kernel resident manager file.
  44  *
  45  *****************************************************************************/
  46
  47 /*****************************************************************************
  48  * Revision history:
  49  * 02/25/02 msz   File created.
  50  ****************************************************************************/
  51 #ifndef _N8_SKSMANAGER_H
  52 #define _N8_SKSMANAGER_H
  53
  54 #include "n8_pub_common.h"
  55
  56 /*****************************************************************************
  57  * #defines
  58  *****************************************************************************/
  59
  60 /*****************************************************************************
  61  * Structures/type definitions
  62  *****************************************************************************/
  63
  64 /* The following two strucutres are used in the ioctl processing to     */
  65 /* make the calls from user space to the kernel functions below.        */
  66 /* n8_SKSResetUnit and n8_SKSAllocate don't require their own           */
  67 /* structures as they are passing only one parameter each.              */
  68
  69 typedef struct
  70 {
  71    unsigned int    targetSKS;
  72    const uint32_t *data_p;
  73    int             data_length;
  74    uint32_t        offset;
  75 } n8_SKSWriteParams_t;
  76
  77 typedef struct
  78 {
  79    N8_SKSKeyHandle_t  *keyHandle_p;
  80    unsigned int       status;
  81 } n8_setStatusParams_t;
  82
  83 /*****************************************************************************
  84  * Function prototypes
  85  *****************************************************************************/
  86
  87 N8_Status_t n8_SKSWrite(const unsigned int  targetSKS,
  88                         const uint32_t     *data_p,
  89                         const int           data_length,
  90                         const uint32_t      offset,
  91                         const int           fromUser);
  92
  93 N8_Status_t n8_SKSResetUnit(const N8_Unit_t targetSKS);
  94
  95 N8_Status_t n8_SKSAllocate(N8_SKSKeyHandle_t *keyHandle_p);
  96
  97 N8_Status_t n8_SKSsetStatus(N8_SKSKeyHandle_t *keyHandle_p,
  98                             unsigned int       status);
  99
 100 #endif