1 /* 2 * Copyright (c) 2017-2018 Cavium, Inc. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 25 * POSSIBILITY OF SUCH DAMAGE. 26 * 27 * $FreeBSD$ 28 * 29 */ 30 31 32 #ifndef __TCP_COMMON__ 33 #define __TCP_COMMON__ 34 /********************/ 35 /* TCP FW CONSTANTS */ 36 /********************/ 37 38 #define TCP_INVALID_TIMEOUT_VAL -1 39 40 41 /* 42 * OOO opaque data received from LL2 43 */ 44 struct ooo_opaque 45 { 46 __le32 cid /* connection ID */; 47 u8 drop_isle /* isle number of the first isle to drop */; 48 u8 drop_size /* number of isles to drop */; 49 u8 ooo_opcode /* (use enum tcp_seg_placement_event) */; 50 u8 ooo_isle /* OOO isle number to add the packet to */; 51 }; 52 53 54 /* 55 * tcp connect mode enum 56 */ 57 enum tcp_connect_mode 58 { 59 TCP_CONNECT_ACTIVE, 60 TCP_CONNECT_PASSIVE, 61 MAX_TCP_CONNECT_MODE 62 }; 63 64 65 /* 66 * tcp function init parameters 67 */ 68 struct tcp_init_params 69 { 70 __le32 two_msl_timer /* 2MSL (used for TIME_WAIT state) timeout value */; 71 __le16 tx_sws_timer /* Transmission silly window syndrom timeout value */; 72 u8 maxFinRT /* Minimum Fin RT */; 73 u8 reserved[9]; 74 }; 75 76 77 /* 78 * tcp IPv4/IPv6 enum 79 */ 80 enum tcp_ip_version 81 { 82 TCP_IPV4, 83 TCP_IPV6, 84 MAX_TCP_IP_VERSION 85 }; 86 87 88 /* 89 * tcp offload parameters 90 */ 91 struct tcp_offload_params 92 { 93 __le16 local_mac_addr_lo; 94 __le16 local_mac_addr_mid; 95 __le16 local_mac_addr_hi; 96 __le16 remote_mac_addr_lo; 97 __le16 remote_mac_addr_mid; 98 __le16 remote_mac_addr_hi; 99 __le16 vlan_id; 100 u8 flags; 101 #define TCP_OFFLOAD_PARAMS_TS_EN_MASK 0x1 /* timestamp enable */ 102 #define TCP_OFFLOAD_PARAMS_TS_EN_SHIFT 0 103 #define TCP_OFFLOAD_PARAMS_DA_EN_MASK 0x1 /* delayed ack enabled */ 104 #define TCP_OFFLOAD_PARAMS_DA_EN_SHIFT 1 105 #define TCP_OFFLOAD_PARAMS_KA_EN_MASK 0x1 /* keep alive enabled */ 106 #define TCP_OFFLOAD_PARAMS_KA_EN_SHIFT 2 107 #define TCP_OFFLOAD_PARAMS_NAGLE_EN_MASK 0x1 /* nagle algorithm enabled */ 108 #define TCP_OFFLOAD_PARAMS_NAGLE_EN_SHIFT 3 109 #define TCP_OFFLOAD_PARAMS_DA_CNT_EN_MASK 0x1 /* delayed ack counter enabled */ 110 #define TCP_OFFLOAD_PARAMS_DA_CNT_EN_SHIFT 4 111 #define TCP_OFFLOAD_PARAMS_FIN_SENT_MASK 0x1 /* fin already sent to far end */ 112 #define TCP_OFFLOAD_PARAMS_FIN_SENT_SHIFT 5 113 #define TCP_OFFLOAD_PARAMS_FIN_RECEIVED_MASK 0x1 /* fin received */ 114 #define TCP_OFFLOAD_PARAMS_FIN_RECEIVED_SHIFT 6 115 #define TCP_OFFLOAD_PARAMS_RESERVED0_MASK 0x1 116 #define TCP_OFFLOAD_PARAMS_RESERVED0_SHIFT 7 117 u8 ip_version; 118 __le32 remote_ip[4]; 119 __le32 local_ip[4]; 120 __le32 flow_label; 121 u8 ttl; 122 u8 tos_or_tc; 123 __le16 remote_port; 124 __le16 local_port; 125 __le16 mss /* the mss derived from remote mss and local mtu, ipVersion options and tags */; 126 u8 rcv_wnd_scale; 127 u8 connect_mode /* TCP connect mode: use enum tcp_connect_mode */; 128 __le16 srtt /* in ms */; 129 __le32 cwnd /* absolute congestion window */; 130 __le32 ss_thresh; 131 __le16 reserved1; 132 u8 ka_max_probe_cnt; 133 u8 dup_ack_theshold; 134 __le32 rcv_next; 135 __le32 snd_una; 136 __le32 snd_next; 137 __le32 snd_max; 138 __le32 snd_wnd /* absolute send window (not scaled) */; 139 __le32 rcv_wnd /* absolute receive window (not scaled) */; 140 __le32 snd_wl1 /* the segment sequence number used for the last window update */; 141 __le32 ts_recent /* The timestamp value to send in the next ACK */; 142 __le32 ts_recent_age /* The length of time, in ms, since the most recent timestamp was received */; 143 __le32 total_rt /* The total time, in ms, that has been spent retransmitting the current TCP segment */; 144 __le32 ka_timeout_delta /* The time remaining, in clock ticks, until the next keepalive timeout. A value of -1 indicates that the keepalive timer was not running when the connection was offloaded. */; 145 __le32 rt_timeout_delta /* The time remaining, in clock ticks, until the next retransmit timeout. A value of -1 indicates that the retransmit timer was not running when the connection was offloaded. */; 146 u8 dup_ack_cnt /* The number of ACKs that have been accepted for the same sequence number */; 147 u8 snd_wnd_probe_cnt /* The current send window probe round */; 148 u8 ka_probe_cnt /* the number of keepalive probes that have been sent that have not received a response */; 149 u8 rt_cnt /* The number of retransmits that have been sent */; 150 __le16 rtt_var /* in ms */; 151 __le16 fw_internal /* fw internal use - initialize value = 0 */; 152 __le32 ka_timeout /* This member specifies, in ms, the timeout interval for inactivity before sending a keepalive probe */; 153 __le32 ka_interval /* This member specifies, in ms, the timeout after which to retransmit a keepalive frame if no response is received to a keepalive probe */; 154 __le32 max_rt_time /* This member specifies, in ms, the maximum time that the offload target should spend retransmitting a segment */; 155 __le32 initial_rcv_wnd /* Initial receive window */; 156 u8 snd_wnd_scale; 157 u8 ack_frequency /* delayed ack counter threshold */; 158 __le16 da_timeout_value /* delayed ack timeout value in ms */; 159 __le32 reserved3[2]; 160 }; 161 162 163 /* 164 * tcp offload parameters 165 */ 166 struct tcp_offload_params_opt2 167 { 168 __le16 local_mac_addr_lo; 169 __le16 local_mac_addr_mid; 170 __le16 local_mac_addr_hi; 171 __le16 remote_mac_addr_lo; 172 __le16 remote_mac_addr_mid; 173 __le16 remote_mac_addr_hi; 174 __le16 vlan_id; 175 u8 flags; 176 #define TCP_OFFLOAD_PARAMS_OPT2_TS_EN_MASK 0x1 /* timestamp enable */ 177 #define TCP_OFFLOAD_PARAMS_OPT2_TS_EN_SHIFT 0 178 #define TCP_OFFLOAD_PARAMS_OPT2_DA_EN_MASK 0x1 /* delayed ack enabled */ 179 #define TCP_OFFLOAD_PARAMS_OPT2_DA_EN_SHIFT 1 180 #define TCP_OFFLOAD_PARAMS_OPT2_KA_EN_MASK 0x1 /* keep alive enabled */ 181 #define TCP_OFFLOAD_PARAMS_OPT2_KA_EN_SHIFT 2 182 #define TCP_OFFLOAD_PARAMS_OPT2_RESERVED0_MASK 0x1F 183 #define TCP_OFFLOAD_PARAMS_OPT2_RESERVED0_SHIFT 3 184 u8 ip_version; 185 __le32 remote_ip[4]; 186 __le32 local_ip[4]; 187 __le32 flow_label; 188 u8 ttl; 189 u8 tos_or_tc; 190 __le16 remote_port; 191 __le16 local_port; 192 __le16 mss /* the mss derived from remote mss and local mtu, ipVersion options and tags */; 193 u8 rcv_wnd_scale; 194 u8 connect_mode /* TCP connect mode: use enum tcp_connect_mode */; 195 __le16 syn_ip_payload_length /* length of Tcp header in SYN packet - relevent for passive mode */; 196 __le32 syn_phy_addr_lo /* physical address (low) of SYN buffer - relevent for passive mode */; 197 __le32 syn_phy_addr_hi /* physical address (high) of SYN buffer - relevent for passive mode */; 198 __le32 reserved1[22]; 199 }; 200 201 202 /* 203 * tcp IPv4/IPv6 enum 204 */ 205 enum tcp_seg_placement_event 206 { 207 TCP_EVENT_ADD_PEN, 208 TCP_EVENT_ADD_NEW_ISLE, 209 TCP_EVENT_ADD_ISLE_RIGHT, 210 TCP_EVENT_ADD_ISLE_LEFT, 211 TCP_EVENT_JOIN, 212 TCP_EVENT_DELETE_ISLES, 213 TCP_EVENT_NOP, 214 MAX_TCP_SEG_PLACEMENT_EVENT 215 }; 216 217 218 /* 219 * tcp init parameters 220 */ 221 struct tcp_update_params 222 { 223 __le16 flags; 224 #define TCP_UPDATE_PARAMS_REMOTE_MAC_ADDR_CHANGED_MASK 0x1 225 #define TCP_UPDATE_PARAMS_REMOTE_MAC_ADDR_CHANGED_SHIFT 0 226 #define TCP_UPDATE_PARAMS_MSS_CHANGED_MASK 0x1 227 #define TCP_UPDATE_PARAMS_MSS_CHANGED_SHIFT 1 228 #define TCP_UPDATE_PARAMS_TTL_CHANGED_MASK 0x1 229 #define TCP_UPDATE_PARAMS_TTL_CHANGED_SHIFT 2 230 #define TCP_UPDATE_PARAMS_TOS_OR_TC_CHANGED_MASK 0x1 231 #define TCP_UPDATE_PARAMS_TOS_OR_TC_CHANGED_SHIFT 3 232 #define TCP_UPDATE_PARAMS_KA_TIMEOUT_CHANGED_MASK 0x1 233 #define TCP_UPDATE_PARAMS_KA_TIMEOUT_CHANGED_SHIFT 4 234 #define TCP_UPDATE_PARAMS_KA_INTERVAL_CHANGED_MASK 0x1 235 #define TCP_UPDATE_PARAMS_KA_INTERVAL_CHANGED_SHIFT 5 236 #define TCP_UPDATE_PARAMS_MAX_RT_TIME_CHANGED_MASK 0x1 237 #define TCP_UPDATE_PARAMS_MAX_RT_TIME_CHANGED_SHIFT 6 238 #define TCP_UPDATE_PARAMS_FLOW_LABEL_CHANGED_MASK 0x1 239 #define TCP_UPDATE_PARAMS_FLOW_LABEL_CHANGED_SHIFT 7 240 #define TCP_UPDATE_PARAMS_INITIAL_RCV_WND_CHANGED_MASK 0x1 241 #define TCP_UPDATE_PARAMS_INITIAL_RCV_WND_CHANGED_SHIFT 8 242 #define TCP_UPDATE_PARAMS_KA_MAX_PROBE_CNT_CHANGED_MASK 0x1 243 #define TCP_UPDATE_PARAMS_KA_MAX_PROBE_CNT_CHANGED_SHIFT 9 244 #define TCP_UPDATE_PARAMS_KA_EN_CHANGED_MASK 0x1 245 #define TCP_UPDATE_PARAMS_KA_EN_CHANGED_SHIFT 10 246 #define TCP_UPDATE_PARAMS_NAGLE_EN_CHANGED_MASK 0x1 247 #define TCP_UPDATE_PARAMS_NAGLE_EN_CHANGED_SHIFT 11 248 #define TCP_UPDATE_PARAMS_KA_EN_MASK 0x1 249 #define TCP_UPDATE_PARAMS_KA_EN_SHIFT 12 250 #define TCP_UPDATE_PARAMS_NAGLE_EN_MASK 0x1 251 #define TCP_UPDATE_PARAMS_NAGLE_EN_SHIFT 13 252 #define TCP_UPDATE_PARAMS_KA_RESTART_MASK 0x1 253 #define TCP_UPDATE_PARAMS_KA_RESTART_SHIFT 14 254 #define TCP_UPDATE_PARAMS_RETRANSMIT_RESTART_MASK 0x1 255 #define TCP_UPDATE_PARAMS_RETRANSMIT_RESTART_SHIFT 15 256 __le16 remote_mac_addr_lo; 257 __le16 remote_mac_addr_mid; 258 __le16 remote_mac_addr_hi; 259 __le16 mss; 260 u8 ttl; 261 u8 tos_or_tc; 262 __le32 ka_timeout; 263 __le32 ka_interval; 264 __le32 max_rt_time; 265 __le32 flow_label; 266 __le32 initial_rcv_wnd; 267 u8 ka_max_probe_cnt; 268 u8 reserved1[7]; 269 }; 270 271 272 /* 273 * toe upload parameters 274 */ 275 struct tcp_upload_params 276 { 277 __le32 rcv_next; 278 __le32 snd_una; 279 __le32 snd_next; 280 __le32 snd_max; 281 __le32 snd_wnd /* absolute send window (not scaled) */; 282 __le32 rcv_wnd /* absolute receive window (not scaled) */; 283 __le32 snd_wl1 /* the segment sequence number used for the last window update */; 284 __le32 cwnd /* absolute congestion window */; 285 __le32 ss_thresh; 286 __le16 srtt /* in ms */; 287 __le16 rtt_var /* in ms */; 288 __le32 ts_time /* The current value of the adjusted timestamp */; 289 __le32 ts_recent /* The timestamp value to send in the next ACK */; 290 __le32 ts_recent_age /* The length of time, in ms, since the most recent timestamp was received */; 291 __le32 total_rt /* The total time, in ms, that has been spent retransmitting the current TCP segment */; 292 __le32 ka_timeout_delta /* The time remaining, in clock ticks, until the next keepalive timeout. A value of -1 indicates that the keepalive timer was not running when the connection was offloaded. */; 293 __le32 rt_timeout_delta /* The time remaining, in clock ticks, until the next retransmit timeout. A value of -1 indicates that the retransmit timer was not running when the connection was offloaded. */; 294 u8 dup_ack_cnt /* The number of ACKs that have been accepted for the same sequence number */; 295 u8 snd_wnd_probe_cnt /* The current send window probe round */; 296 u8 ka_probe_cnt /* the number of keepalive probes that have been sent that have not received a response */; 297 u8 rt_cnt /* The number of retransmits that have been sent */; 298 __le32 reserved; 299 }; 300 301 #endif /* __TCP_COMMON__ */ 302