Sync usage with man page.
[netbsd-mini2440.git] / sys / dev / pci / n8 / common / api / commands / n8_cb_dh.h
blob709beb345d2447823607c49b0925eb2f270cdfe2
1 /*-
2 * Copyright (C) 2001-2003 by NBMK Encryption Technologies.
3 * All rights reserved.
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:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
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.
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.
35 /*****************************************************************************
36 * @(#) n8_cb_dh.h 1.9@(#)
37 *****************************************************************************/
39 /*****************************************************************************/
40 /** @file n8_cb_dh.h
41 * @brief DSA Command Blocks
43 * Command Block Generation for Diffie-Hellman
45 *****************************************************************************/
47 /*****************************************************************************
48 * Revision history:
49 * 09/14/01 bac Added computation of gRmodP in cb_precomputeDHValues.
50 * Changed cb_computeGXmodp to be cb_computeGXmodp_short and
51 * cb_computeGXmodp_long. The former uses the precomputed value
52 * for gRmodP and the latter computes it. Other changes from the
53 * code review.
54 * 08/24/01 bac Changed method signatures and added *NUMCMDS defines.
55 * 07/12/01 bac Changed signatures for cb_computeGXmodp to accept uint32_t not
56 * pointers.
57 * 06/22/01 mel Initial Version
58 ****************************************************************************/
60 #ifndef N8_CB_DH_H
61 #define N8_CB_DH_H
63 #include "n8_cb_dsa.h"
64 #include "n8_cb_rsa.h"
65 #include "n8_pub_errors.h"
68 /* macros indicating the number of command blocks for each computation */
69 #define N8_CB_PRECOMPUTE_DHVALUES_NUMCMDS \
70 (N8_CB_COMPUTE_CX_NUMCMDS + N8_CB_COMPUTE_RMODX_NUMCMDS + 5)
71 #define N8_CB_COMPUTE_G_XMODP_NUMCMDS_SHORT 6
72 #define N8_CB_COMPUTE_G_XMODP_NUMCMDS_LONG 8
74 /* function prototypes */
75 N8_Status_t cb_precomputeDHValues(const API_Request_t *req_p,
76 const uint32_t g_a,
77 const uint32_t p_a,
78 const uint32_t RmodP_a,
79 const uint32_t gRmodP_a,
80 const uint32_t cp_a,
81 const unsigned int modulusLength,
82 PK_CMD_BLOCK_t *cmdBuf_p,
83 const N8_Unit_t unitID);
85 N8_Status_t cb_computeGXmodp_long(const API_Request_t *req_p,
86 const uint32_t g_a,
87 const uint32_t x_a,
88 const uint32_t p_a,
89 const uint32_t cp_a,
90 const uint32_t RmodP_a,
91 const uint32_t result_a,
92 const unsigned int modulusLengthBytes,
93 PK_CMD_BLOCK_t *cmdBuf_p);
95 N8_Status_t cb_computeGXmodp_short(const API_Request_t *req_p,
96 const uint32_t x_a,
97 const uint32_t p_a,
98 const uint32_t cp_a,
99 const uint32_t gRmodP_a,
100 const uint32_t result_a,
101 const unsigned int modulusLengthBytes,
102 PK_CMD_BLOCK_t *cmdBuf_p);
103 #endif /* N8_CB_DH_H */