4 * Copyright(c) 2017 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #ifndef _RTE_SECURITY_DRIVER_H_
35 #define _RTE_SECURITY_DRIVER_H_
38 * @file rte_security_driver.h
39 * @b EXPERIMENTAL: this API may change without prior notice
41 * RTE Security Common Definitions
49 #include "rte_security.h"
52 * Configure a security session on a device.
54 * @param device Crypto/eth device pointer
55 * @param conf Security session configuration
56 * @param sess Pointer to Security private session structure
57 * @param mp Mempool where the private session is allocated
60 * - Returns 0 if private session structure have been created successfully.
61 * - Returns -EINVAL if input parameters are invalid.
62 * - Returns -ENOTSUP if crypto device does not support the crypto transform.
63 * - Returns -ENOMEM if the private session could not be allocated.
65 typedef int (*security_session_create_t)(void *device,
66 struct rte_security_session_conf *conf,
67 struct rte_security_session *sess,
68 struct rte_mempool *mp);
71 * Free driver private session data.
73 * @param dev Crypto/eth device pointer
74 * @param sess Security session structure
76 typedef int (*security_session_destroy_t)(void *device,
77 struct rte_security_session *sess);
80 * Update driver private session data.
82 * @param device Crypto/eth device pointer
83 * @param sess Pointer to Security private session structure
84 * @param conf Security session configuration
87 * - Returns 0 if private session structure have been updated successfully.
88 * - Returns -EINVAL if input parameters are invalid.
89 * - Returns -ENOTSUP if crypto device does not support the crypto transform.
91 typedef int (*security_session_update_t)(void *device,
92 struct rte_security_session *sess,
93 struct rte_security_session_conf *conf);
95 * Get stats from the PMD.
97 * @param device Crypto/eth device pointer
98 * @param sess Pointer to Security private session structure
99 * @param stats Security stats of the driver
102 * - Returns 0 if private session structure have been updated successfully.
103 * - Returns -EINVAL if session parameters are invalid.
105 typedef int (*security_session_stats_get_t)(void *device,
106 struct rte_security_session *sess,
107 struct rte_security_stats *stats);
110 * Update the mbuf with provided metadata.
112 * @param sess Security session structure
113 * @param mb Packet buffer
117 * - Returns 0 if metadata updated successfully.
118 * - Returns -ve value for errors.
120 typedef int (*security_set_pkt_metadata_t)(void *device,
121 struct rte_security_session *sess, struct rte_mbuf *m,
125 * Get security capabilities of the device.
127 * @param device crypto/eth device pointer
130 * - Returns rte_security_capability pointer on success.
131 * - Returns NULL on error.
133 typedef const struct rte_security_capability *(*security_capabilities_get_t)(
136 /** Security operations function pointer table */
137 struct rte_security_ops {
138 security_session_create_t session_create;
139 /**< Configure a security session. */
140 security_session_update_t session_update;
141 /**< Update a security session. */
142 security_session_stats_get_t session_stats_get;
143 /**< Get security session statistics. */
144 security_session_destroy_t session_destroy;
145 /**< Clear a security sessions private data. */
146 security_set_pkt_metadata_t set_pkt_metadata;
147 /**< Update mbuf metadata. */
148 security_capabilities_get_t capabilities_get;
149 /**< Get security capabilities. */
156 #endif /* _RTE_SECURITY_DRIVER_H_ */