1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2012 Chelsio Communications, Inc. 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 * 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. 15 * 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 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef _NETINET_TOE_H_ 32 #define _NETINET_TOE_H_ 33 34 #ifndef _KERNEL 35 #error "no user-serviceable parts inside" 36 #endif 37 38 struct tcpopt; 39 struct tcphdr; 40 struct in_conninfo; 41 struct tcp_info; 42 43 struct toedev { 44 TAILQ_ENTRY(toedev) link; /* glue for toedev_list */ 45 void *tod_softc; /* TOE driver private data */ 46 47 /* 48 * Active open. If a failure occurs, it is reported back by the driver 49 * via toe_connect_failed. 50 */ 51 int (*tod_connect)(struct toedev *, struct socket *, struct rtentry *, 52 struct sockaddr *); 53 54 /* Passive open. */ 55 int (*tod_listen_start)(struct toedev *, struct tcpcb *); 56 int (*tod_listen_stop)(struct toedev *, struct tcpcb *); 57 58 /* 59 * The kernel uses this routine to pass on any frame it receives for an 60 * offloaded connection to the TOE driver. This is an unusual event. 61 */ 62 void (*tod_input)(struct toedev *, struct tcpcb *, struct mbuf *); 63 64 /* 65 * This is called by the kernel during pru_rcvd for an offloaded TCP 66 * connection and provides an opportunity for the TOE driver to manage 67 * its rx window and credits. 68 */ 69 void (*tod_rcvd)(struct toedev *, struct tcpcb *); 70 71 /* 72 * Transmit routine. The kernel calls this to have the TOE driver 73 * evaluate whether there is data to be transmitted, and transmit it. 74 */ 75 int (*tod_output)(struct toedev *, struct tcpcb *); 76 77 /* Immediate teardown: send RST to peer. */ 78 int (*tod_send_rst)(struct toedev *, struct tcpcb *); 79 80 /* Initiate orderly disconnect by sending FIN to the peer. */ 81 int (*tod_send_fin)(struct toedev *, struct tcpcb *); 82 83 /* Called to indicate that the kernel is done with this TCP PCB. */ 84 void (*tod_pcb_detach)(struct toedev *, struct tcpcb *); 85 86 /* 87 * The kernel calls this once it has information about an L2 entry that 88 * the TOE driver enquired about previously (via toe_l2_resolve). 89 */ 90 void (*tod_l2_update)(struct toedev *, struct ifnet *, 91 struct sockaddr *, uint8_t *, uint16_t); 92 93 /* XXX. Route has been redirected. */ 94 void (*tod_route_redirect)(struct toedev *, struct ifnet *, 95 struct rtentry *, struct rtentry *); 96 97 /* Syncache interaction. */ 98 void (*tod_syncache_added)(struct toedev *, void *); 99 void (*tod_syncache_removed)(struct toedev *, void *); 100 int (*tod_syncache_respond)(struct toedev *, void *, struct mbuf *); 101 void (*tod_offload_socket)(struct toedev *, void *, struct socket *); 102 103 /* TCP socket option */ 104 void (*tod_ctloutput)(struct toedev *, struct tcpcb *, int, int); 105 106 /* Update software state */ 107 void (*tod_tcp_info)(struct toedev *, struct tcpcb *, 108 struct tcp_info *); 109 }; 110 111 #include <sys/eventhandler.h> 112 typedef void (*tcp_offload_listen_start_fn)(void *, struct tcpcb *); 113 typedef void (*tcp_offload_listen_stop_fn)(void *, struct tcpcb *); 114 EVENTHANDLER_DECLARE(tcp_offload_listen_start, tcp_offload_listen_start_fn); 115 EVENTHANDLER_DECLARE(tcp_offload_listen_stop, tcp_offload_listen_stop_fn); 116 117 void init_toedev(struct toedev *); 118 int register_toedev(struct toedev *); 119 int unregister_toedev(struct toedev *); 120 121 /* 122 * General interface for looking up L2 information for an IP address. If an 123 * answer is not available right away then the TOE driver's tod_l2_update will 124 * be called later. 125 */ 126 int toe_l2_resolve(struct toedev *, struct ifnet *, struct sockaddr *, 127 uint8_t *, uint16_t *); 128 129 void toe_connect_failed(struct toedev *, struct inpcb *, int); 130 131 void toe_syncache_add(struct in_conninfo *, struct tcpopt *, struct tcphdr *, 132 struct inpcb *, void *, void *); 133 int toe_syncache_expand(struct in_conninfo *, struct tcpopt *, struct tcphdr *, 134 struct socket **); 135 136 int toe_4tuple_check(struct in_conninfo *, struct tcphdr *, struct ifnet *); 137 #endif 138