xref: /spdk/module/bdev/crypto/vbdev_crypto.h (revision 712a3f69d32632bf6c862f00200f7f437d3f7529)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (c) Intel Corporation.
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 
34 #ifndef SPDK_VBDEV_CRYPTO_H
35 #define SPDK_VBDEV_CRYPTO_H
36 
37 #include "spdk/rpc.h"
38 #include "spdk/util.h"
39 #include "spdk/string.h"
40 #include "spdk_internal/log.h"
41 
42 #include "spdk/bdev.h"
43 
44 #define AESNI_MB "crypto_aesni_mb"
45 #define QAT "crypto_qat"
46 
47 /* Supported ciphers */
48 #define AES_CBC "AES_CBC" /* QAT and AESNI_MB */
49 #define AES_XTS "AES_XTS" /* QAT only */
50 
51 typedef void (*spdk_delete_crypto_complete)(void *cb_arg, int bdeverrno);
52 
53 /**
54  * Create new crypto bdev.
55  *
56  * \param bdev_name Name of the bdev on which the crypto vbdev will be created.
57  * \param vbdev_name Name of the new crypto vbdev.
58  * \param crypto_pmd Name of the polled mode driver to use for this vbdev.
59  * \param key The key to use for this vbdev.
60  * \param cipher The cipher to use for this vbdev.
61  * \param keys The 2nd key to use for AES_XTS cipher.
62  * \return 0 on success, other on failure.
63  */
64 int create_crypto_disk(const char *bdev_name, const char *vbdev_name,
65 		       const char *crypto_pmd, const char *key,
66 		       const char *cipher, const char *key2);
67 
68 /**
69  * Delete crypto bdev.
70  *
71  * \param bdev Pointer to crypto bdev.
72  * \param cb_fn Function to call after deletion.
73  * \param cb_arg Argument to pass to cb_fn.
74  */
75 void delete_crypto_disk(struct spdk_bdev *bdev, spdk_delete_crypto_complete cb_fn,
76 			void *cb_arg);
77 
78 #endif /* SPDK_VBDEV_CRYPTO_H */
79