first public release
[dpdk.git] / examples / dpdk_qat / crypto.h
1 /*-
2  *   BSD LICENSE
3  * 
4  *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  * 
7  *   Redistribution and use in source and binary forms, with or without 
8  *   modification, are permitted provided that the following conditions 
9  *   are met:
10  * 
11  *     * Redistributions of source code must retain the above copyright 
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright 
14  *       notice, this list of conditions and the following disclaimer in 
15  *       the documentation and/or other materials provided with the 
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its 
18  *       contributors may be used to endorse or promote products derived 
19  *       from this software without specific prior written permission.
20  * 
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  * 
33  *  version: DPDK.L.1.2.3-3
34  */
35
36 #ifndef CRYPTO_H_
37 #define CRYPTO_H_
38
39 /* Pass Labels/Values to crypto units */
40 enum cipher_alg {
41         /* Option to not do any cryptography */
42         NO_CIPHER,
43         CIPHER_DES,
44         CIPHER_DES_CBC,
45         CIPHER_DES3,
46         CIPHER_DES3_CBC,
47         CIPHER_AES,
48         CIPHER_AES_CBC_128,
49 };
50
51 enum hash_alg {
52         /* Option to not do any hash */
53         NO_HASH,
54         HASH_MD5,
55         HASH_SHA1,
56         HASH_SHA1_96,
57         HASH_SHA224,
58         HASH_SHA256,
59         HASH_SHA384,
60         HASH_SHA512,
61         HASH_AES_XCBC,
62         HASH_AES_XCBC_96
63 };
64
65 /* Return value from crypto_{encrypt/decrypt} */
66 enum crypto_result {
67         /* Packet was successfully put into crypto queue */
68         CRYPTO_RESULT_IN_PROGRESS,
69         /* Cryptography has failed in some way */
70         CRYPTO_RESULT_FAIL,
71 };
72
73 extern enum crypto_result crypto_encrypt(struct rte_mbuf *pkt, enum cipher_alg c,
74                 enum hash_alg h);
75 extern enum crypto_result crypto_decrypt(struct rte_mbuf *pkt, enum cipher_alg c,
76                 enum hash_alg h);
77
78 extern int crypto_init(void);
79
80 extern int per_core_crypto_init(uint32_t lcore_id);
81
82 extern void crypto_exit(void);
83
84 extern void *crypto_get_next_response(void);
85
86 extern void crypto_flush_tx_queue(uint32_t lcore_id);
87
88 #endif /* CRYPTO_H_ */