2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2012 Chelsio Communications, Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #ifndef _NETINET_TOE_H_
32 #define _NETINET_TOE_H_
35 #error "no user-serviceable parts inside"
38 #include <sys/_eventhandler.h>
47 TAILQ_ENTRY(toedev) link; /* glue for toedev_list */
48 void *tod_softc; /* TOE driver private data */
51 * Active open. If a failure occurs, it is reported back by the driver
52 * via toe_connect_failed.
54 int (*tod_connect)(struct toedev *, struct socket *, struct rtentry *,
58 int (*tod_listen_start)(struct toedev *, struct tcpcb *);
59 int (*tod_listen_stop)(struct toedev *, struct tcpcb *);
62 * The kernel uses this routine to pass on any frame it receives for an
63 * offloaded connection to the TOE driver. This is an unusual event.
65 void (*tod_input)(struct toedev *, struct tcpcb *, struct mbuf *);
68 * This is called by the kernel during pru_rcvd for an offloaded TCP
69 * connection and provides an opportunity for the TOE driver to manage
70 * its rx window and credits.
72 void (*tod_rcvd)(struct toedev *, struct tcpcb *);
75 * Transmit routine. The kernel calls this to have the TOE driver
76 * evaluate whether there is data to be transmitted, and transmit it.
78 int (*tod_output)(struct toedev *, struct tcpcb *);
80 /* Immediate teardown: send RST to peer. */
81 int (*tod_send_rst)(struct toedev *, struct tcpcb *);
83 /* Initiate orderly disconnect by sending FIN to the peer. */
84 int (*tod_send_fin)(struct toedev *, struct tcpcb *);
86 /* Called to indicate that the kernel is done with this TCP PCB. */
87 void (*tod_pcb_detach)(struct toedev *, struct tcpcb *);
90 * The kernel calls this once it has information about an L2 entry that
91 * the TOE driver enquired about previously (via toe_l2_resolve).
93 void (*tod_l2_update)(struct toedev *, struct ifnet *,
94 struct sockaddr *, uint8_t *, uint16_t);
96 /* XXX. Route has been redirected. */
97 void (*tod_route_redirect)(struct toedev *, struct ifnet *,
98 struct rtentry *, struct rtentry *);
100 /* Syncache interaction. */
101 void (*tod_syncache_added)(struct toedev *, void *);
102 void (*tod_syncache_removed)(struct toedev *, void *);
103 int (*tod_syncache_respond)(struct toedev *, void *, struct mbuf *);
104 void (*tod_offload_socket)(struct toedev *, void *, struct socket *);
106 /* TCP socket option */
107 void (*tod_ctloutput)(struct toedev *, struct tcpcb *, int, int);
109 /* Update software state */
110 void (*tod_tcp_info)(struct toedev *, struct tcpcb *,
113 /* Create a TLS session */
114 int (*tod_alloc_tls_session)(struct toedev *, struct tcpcb *,
115 struct ktls_session *);
118 typedef void (*tcp_offload_listen_start_fn)(void *, struct tcpcb *);
119 typedef void (*tcp_offload_listen_stop_fn)(void *, struct tcpcb *);
120 EVENTHANDLER_DECLARE(tcp_offload_listen_start, tcp_offload_listen_start_fn);
121 EVENTHANDLER_DECLARE(tcp_offload_listen_stop, tcp_offload_listen_stop_fn);
123 void init_toedev(struct toedev *);
124 int register_toedev(struct toedev *);
125 int unregister_toedev(struct toedev *);
128 * General interface for looking up L2 information for an IP address. If an
129 * answer is not available right away then the TOE driver's tod_l2_update will
132 int toe_l2_resolve(struct toedev *, struct ifnet *, struct sockaddr *,
133 uint8_t *, uint16_t *);
135 void toe_connect_failed(struct toedev *, struct inpcb *, int);
137 void toe_syncache_add(struct in_conninfo *, struct tcpopt *, struct tcphdr *,
138 struct inpcb *, void *, void *);
139 int toe_syncache_expand(struct in_conninfo *, struct tcpopt *, struct tcphdr *,
142 int toe_4tuple_check(struct in_conninfo *, struct tcphdr *, struct ifnet *);