xref: /OK3568_Linux_fs/kernel/include/net/tls_toe.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright (c) 2016-2017, Mellanox Technologies. All rights reserved.
3*4882a593Smuzhiyun  * Copyright (c) 2016-2017, Dave Watson <davejwatson@fb.com>. All rights reserved.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * This software is available to you under a choice of one of two
6*4882a593Smuzhiyun  * licenses.  You may choose to be licensed under the terms of the GNU
7*4882a593Smuzhiyun  * General Public License (GPL) Version 2, available from the file
8*4882a593Smuzhiyun  * COPYING in the main directory of this source tree, or the
9*4882a593Smuzhiyun  * OpenIB.org BSD license below:
10*4882a593Smuzhiyun  *
11*4882a593Smuzhiyun  *     Redistribution and use in source and binary forms, with or
12*4882a593Smuzhiyun  *     without modification, are permitted provided that the following
13*4882a593Smuzhiyun  *     conditions are met:
14*4882a593Smuzhiyun  *
15*4882a593Smuzhiyun  *      - Redistributions of source code must retain the above
16*4882a593Smuzhiyun  *        copyright notice, this list of conditions and the following
17*4882a593Smuzhiyun  *        disclaimer.
18*4882a593Smuzhiyun  *
19*4882a593Smuzhiyun  *      - Redistributions in binary form must reproduce the above
20*4882a593Smuzhiyun  *        copyright notice, this list of conditions and the following
21*4882a593Smuzhiyun  *        disclaimer in the documentation and/or other materials
22*4882a593Smuzhiyun  *        provided with the distribution.
23*4882a593Smuzhiyun  *
24*4882a593Smuzhiyun  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25*4882a593Smuzhiyun  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26*4882a593Smuzhiyun  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27*4882a593Smuzhiyun  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28*4882a593Smuzhiyun  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29*4882a593Smuzhiyun  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30*4882a593Smuzhiyun  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31*4882a593Smuzhiyun  * SOFTWARE.
32*4882a593Smuzhiyun  */
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun #include <linux/kref.h>
35*4882a593Smuzhiyun #include <linux/list.h>
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun struct sock;
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun #define TLS_TOE_DEVICE_NAME_MAX		32
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun /*
42*4882a593Smuzhiyun  * This structure defines the routines for Inline TLS driver.
43*4882a593Smuzhiyun  * The following routines are optional and filled with a
44*4882a593Smuzhiyun  * null pointer if not defined.
45*4882a593Smuzhiyun  *
46*4882a593Smuzhiyun  * @name: Its the name of registered Inline tls device
47*4882a593Smuzhiyun  * @dev_list: Inline tls device list
48*4882a593Smuzhiyun  * int (*feature)(struct tls_toe_device *device);
49*4882a593Smuzhiyun  *     Called to return Inline TLS driver capability
50*4882a593Smuzhiyun  *
51*4882a593Smuzhiyun  * int (*hash)(struct tls_toe_device *device, struct sock *sk);
52*4882a593Smuzhiyun  *     This function sets Inline driver for listen and program
53*4882a593Smuzhiyun  *     device specific functioanlity as required
54*4882a593Smuzhiyun  *
55*4882a593Smuzhiyun  * void (*unhash)(struct tls_toe_device *device, struct sock *sk);
56*4882a593Smuzhiyun  *     This function cleans listen state set by Inline TLS driver
57*4882a593Smuzhiyun  *
58*4882a593Smuzhiyun  * void (*release)(struct kref *kref);
59*4882a593Smuzhiyun  *     Release the registered device and allocated resources
60*4882a593Smuzhiyun  * @kref: Number of reference to tls_toe_device
61*4882a593Smuzhiyun  */
62*4882a593Smuzhiyun struct tls_toe_device {
63*4882a593Smuzhiyun 	char name[TLS_TOE_DEVICE_NAME_MAX];
64*4882a593Smuzhiyun 	struct list_head dev_list;
65*4882a593Smuzhiyun 	int  (*feature)(struct tls_toe_device *device);
66*4882a593Smuzhiyun 	int  (*hash)(struct tls_toe_device *device, struct sock *sk);
67*4882a593Smuzhiyun 	void (*unhash)(struct tls_toe_device *device, struct sock *sk);
68*4882a593Smuzhiyun 	void (*release)(struct kref *kref);
69*4882a593Smuzhiyun 	struct kref kref;
70*4882a593Smuzhiyun };
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun int tls_toe_bypass(struct sock *sk);
73*4882a593Smuzhiyun int tls_toe_hash(struct sock *sk);
74*4882a593Smuzhiyun void tls_toe_unhash(struct sock *sk);
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun void tls_toe_register_device(struct tls_toe_device *device);
77*4882a593Smuzhiyun void tls_toe_unregister_device(struct tls_toe_device *device);
78