xref: /freebsd/sys/dev/qat_c2xxx/qat_hw15var.h (revision 271171e0)
1 /* SPDX-License-Identifier: BSD-2-Clause-NetBSD AND BSD-3-Clause */
2 /*	$NetBSD: qat_hw15var.h,v 1.1 2019/11/20 09:37:46 hikaru Exp $	*/
3 
4 /*
5  * Copyright (c) 2019 Internet Initiative Japan, Inc.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
21  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 /*
31  *   Copyright(c) 2007-2013 Intel Corporation. All rights reserved.
32  *
33  *   Redistribution and use in source and binary forms, with or without
34  *   modification, are permitted provided that the following conditions
35  *   are met:
36  *
37  *     * Redistributions of source code must retain the above copyright
38  *       notice, this list of conditions and the following disclaimer.
39  *     * Redistributions in binary form must reproduce the above copyright
40  *       notice, this list of conditions and the following disclaimer in
41  *       the documentation and/or other materials provided with the
42  *       distribution.
43  *     * Neither the name of Intel Corporation nor the names of its
44  *       contributors may be used to endorse or promote products derived
45  *       from this software without specific prior written permission.
46  *
47  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
48  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
49  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
50  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
51  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
52  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
53  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
54  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
55  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
56  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
57  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
58  */
59 
60 /* $FreeBSD$ */
61 
62 #ifndef _DEV_PCI_QAT_HW15VAR_H_
63 #define _DEV_PCI_QAT_HW15VAR_H_
64 
65 CTASSERT(HASH_CONTENT_DESC_SIZE >=
66    sizeof(struct fw_auth_hdr) + MAX_HASH_SETUP_BLK_SZ);
67 CTASSERT(CIPHER_CONTENT_DESC_SIZE >=
68    sizeof(struct fw_cipher_hdr) + MAX_CIPHER_SETUP_BLK_SZ);
69 CTASSERT(CONTENT_DESC_MAX_SIZE >=
70     roundup(HASH_CONTENT_DESC_SIZE + CIPHER_CONTENT_DESC_SIZE,
71         QAT_OPTIMAL_ALIGN));
72 CTASSERT(QAT_SYM_REQ_PARAMS_SIZE_PADDED >=
73     roundup(sizeof(struct fw_la_cipher_req_params) +
74         sizeof(struct fw_la_auth_req_params), QAT_OPTIMAL_ALIGN));
75 
76 /* length of the 5 long words of the request that are stored in the session
77  * This is rounded up to 32 in order to use the fast memcopy function */
78 #define QAT_HW15_SESSION_REQ_CACHE_SIZE	(32)
79 
80 void		qat_msg_req_type_populate(struct arch_if_req_hdr *,
81 		    enum arch_if_req, uint32_t);
82 void		qat_msg_cmn_hdr_populate(struct fw_la_bulk_req *, bus_addr_t,
83 		    uint8_t, uint8_t, uint16_t, uint32_t);
84 void		qat_msg_service_cmd_populate(struct fw_la_bulk_req *,
85 		    enum fw_la_cmd_id, uint16_t);
86 void		qat_msg_cmn_mid_populate(struct fw_comn_req_mid *, void *,
87 		    uint64_t , uint64_t);
88 void		qat_msg_req_params_populate(struct fw_la_bulk_req *, bus_addr_t,
89 		    uint8_t);
90 void		qat_msg_cmn_footer_populate(union fw_comn_req_ftr *, uint64_t);
91 void		qat_msg_params_populate(struct fw_la_bulk_req *,
92 		    struct qat_crypto_desc *, uint8_t, uint16_t,
93 		    uint16_t);
94 
95 
96 int		qat_adm_ring_init(struct qat_softc *);
97 int		qat_adm_ring_send_init(struct qat_softc *);
98 
99 void		qat_hw15_crypto_setup_desc(struct qat_crypto *,
100 		    struct qat_session *, struct qat_crypto_desc *);
101 void		qat_hw15_crypto_setup_req_params(struct qat_crypto_bank *,
102 		    struct qat_session *, struct qat_crypto_desc const *,
103 		    struct qat_sym_cookie *, struct cryptop *);
104 
105 #endif
106