include/net/tls_toe.h

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