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#ifndef __TCP_COMMON__ 32#define __TCP_COMMON__ 33/********************/ 34/* TCP FW CONSTANTS */ 35/********************/ 36 37#define TCP_INVALID_TIMEOUT_VAL -1 38 39/* 40 * OOO opaque data received from LL2 41 */ 42struct ooo_opaque 43{ 44 __le32 cid /* connection ID */; 45 u8 drop_isle /* isle number of the first isle to drop */; 46 u8 drop_size /* number of isles to drop */; 47 u8 ooo_opcode /* (use enum tcp_seg_placement_event) */; 48 u8 ooo_isle /* OOO isle number to add the packet to */; 49}; 50 51/* 52 * tcp connect mode enum 53 */ 54enum tcp_connect_mode 55{ 56 TCP_CONNECT_ACTIVE, 57 TCP_CONNECT_PASSIVE, 58 MAX_TCP_CONNECT_MODE 59}; 60 61/* 62 * tcp function init parameters 63 */ 64struct tcp_init_params 65{ 66 __le32 two_msl_timer /* 2MSL (used for TIME_WAIT state) timeout value */; 67 __le16 tx_sws_timer /* Transmission silly window syndrom timeout value */; 68 u8 max_fin_rt /* Minimum Fin RT */; 69 u8 reserved[9]; 70}; 71 72/* 73 * tcp IPv4/IPv6 enum 74 */ 75enum tcp_ip_version 76{ 77 TCP_IPV4, 78 TCP_IPV6, 79 MAX_TCP_IP_VERSION 80}; 81 82/* 83 * tcp offload parameters 84 */ 85struct tcp_offload_params 86{ 87 __le16 local_mac_addr_lo; 88 __le16 local_mac_addr_mid; 89 __le16 local_mac_addr_hi; 90 __le16 remote_mac_addr_lo; 91 __le16 remote_mac_addr_mid; 92 __le16 remote_mac_addr_hi; 93 __le16 vlan_id; 94 __le16 flags; 95#define TCP_OFFLOAD_PARAMS_TS_EN_MASK 0x1 /* timestamp enable */ 96#define TCP_OFFLOAD_PARAMS_TS_EN_SHIFT 0 97#define TCP_OFFLOAD_PARAMS_DA_EN_MASK 0x1 /* delayed ack enabled */ 98#define TCP_OFFLOAD_PARAMS_DA_EN_SHIFT 1 99#define TCP_OFFLOAD_PARAMS_KA_EN_MASK 0x1 /* keep alive enabled */ 100#define TCP_OFFLOAD_PARAMS_KA_EN_SHIFT 2 101#define TCP_OFFLOAD_PARAMS_ECN_SENDER_EN_MASK 0x1 /* ECN sender enabled */ 102#define TCP_OFFLOAD_PARAMS_ECN_SENDER_EN_SHIFT 3 103#define TCP_OFFLOAD_PARAMS_ECN_RECEIVER_EN_MASK 0x1 /* ECN receiver enabled */ 104#define TCP_OFFLOAD_PARAMS_ECN_RECEIVER_EN_SHIFT 4 105#define TCP_OFFLOAD_PARAMS_NAGLE_EN_MASK 0x1 /* nagle algorithm enabled */ 106#define TCP_OFFLOAD_PARAMS_NAGLE_EN_SHIFT 5 107#define TCP_OFFLOAD_PARAMS_DA_CNT_EN_MASK 0x1 /* delayed ack counter enabled */ 108#define TCP_OFFLOAD_PARAMS_DA_CNT_EN_SHIFT 6 109#define TCP_OFFLOAD_PARAMS_FIN_SENT_MASK 0x1 /* fin already sent to far end */ 110#define TCP_OFFLOAD_PARAMS_FIN_SENT_SHIFT 7 111#define TCP_OFFLOAD_PARAMS_FIN_RECEIVED_MASK 0x1 /* fin received */ 112#define TCP_OFFLOAD_PARAMS_FIN_RECEIVED_SHIFT 8 113#define TCP_OFFLOAD_PARAMS_RESERVED_MASK 0x7F 114#define TCP_OFFLOAD_PARAMS_RESERVED_SHIFT 9 115 u8 ip_version /* (use enum tcp_ip_version) */; 116 u8 reserved0[3]; 117 __le32 remote_ip[4]; 118 __le32 local_ip[4]; 119 __le32 flow_label; 120 u8 ttl; 121 u8 tos_or_tc; 122 __le16 remote_port; 123 __le16 local_port; 124 __le16 mss /* the mss derived from remote mss and local mtu, ipVersion options and tags */; 125 u8 rcv_wnd_scale; 126 u8 connect_mode /* TCP connect mode: use enum tcp_connect_mode (use enum tcp_connect_mode) */; 127 __le16 srtt /* in ms */; 128 __le32 ss_thresh; 129 __le32 rcv_wnd /* absolute receive window (not scaled) */; 130 __le32 cwnd /* absolute congestion window */; 131 u8 ka_max_probe_cnt; 132 u8 dup_ack_theshold; 133 __le16 reserved1; 134 __le32 ka_timeout /* This member specifies, in ms, the timeout interval for inactivity before sending a keepalive probe */; 135 __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 */; 136 __le32 max_rt_time /* This member specifies, in ms, the maximum time that the offload target should spend retransmitting a segment */; 137 __le32 initial_rcv_wnd /* Initial receive window */; 138 __le32 rcv_next; 139 __le32 snd_una; 140 __le32 snd_next; 141 __le32 snd_max; 142 __le32 snd_wnd /* absolute send window (not scaled) */; 143 __le32 snd_wl1 /* the segment sequence number used for the last window update */; 144 __le32 ts_recent /* The timestamp value to send in the next ACK */; 145 __le32 ts_recent_age /* The length of time, in ms, since the most recent timestamp was received */; 146 __le32 total_rt /* The total time, in ms, that has been spent retransmitting the current TCP segment */; 147 __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. */; 148 __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. */; 149 u8 dup_ack_cnt /* The number of ACKs that have been accepted for the same sequence number */; 150 u8 snd_wnd_probe_cnt /* The current send window probe round */; 151 u8 ka_probe_cnt /* the number of keepalive probes that have been sent that have not received a response */; 152 u8 rt_cnt /* The number of retransmits that have been sent */; 153 __le16 rtt_var /* in ms */; 154 __le16 fw_internal /* fw internal use - initialize value = 0 */; 155 u8 snd_wnd_scale; 156 u8 ack_frequency /* delayed ack counter threshold */; 157 __le16 da_timeout_value /* delayed ack timeout value in ms */; 158 __le32 reserved3; 159}; 160 161/* 162 * tcp offload parameters 163 */ 164struct tcp_offload_params_opt2 165{ 166 __le16 local_mac_addr_lo; 167 __le16 local_mac_addr_mid; 168 __le16 local_mac_addr_hi; 169 __le16 remote_mac_addr_lo; 170 __le16 remote_mac_addr_mid; 171 __le16 remote_mac_addr_hi; 172 __le16 vlan_id; 173 __le16 flags; 174#define TCP_OFFLOAD_PARAMS_OPT2_TS_EN_MASK 0x1 /* timestamp enable */ 175#define TCP_OFFLOAD_PARAMS_OPT2_TS_EN_SHIFT 0 176#define TCP_OFFLOAD_PARAMS_OPT2_DA_EN_MASK 0x1 /* delayed ack enabled */ 177#define TCP_OFFLOAD_PARAMS_OPT2_DA_EN_SHIFT 1 178#define TCP_OFFLOAD_PARAMS_OPT2_KA_EN_MASK 0x1 /* keep alive enabled */ 179#define TCP_OFFLOAD_PARAMS_OPT2_KA_EN_SHIFT 2 180#define TCP_OFFLOAD_PARAMS_OPT2_ECN_EN_MASK 0x1 /* ECN enabled */ 181#define TCP_OFFLOAD_PARAMS_OPT2_ECN_EN_SHIFT 3 182#define TCP_OFFLOAD_PARAMS_OPT2_RESERVED0_MASK 0xFFF 183#define TCP_OFFLOAD_PARAMS_OPT2_RESERVED0_SHIFT 4 184 u8 ip_version /* (use enum tcp_ip_version) */; 185 u8 reserved1[3]; 186 __le32 remote_ip[4]; 187 __le32 local_ip[4]; 188 __le32 flow_label; 189 u8 ttl; 190 u8 tos_or_tc; 191 __le16 remote_port; 192 __le16 local_port; 193 __le16 mss /* the mss derived from remote mss and local mtu, ipVersion options and tags */; 194 u8 rcv_wnd_scale; 195 u8 connect_mode /* TCP connect mode: use enum tcp_connect_mode (use enum tcp_connect_mode) */; 196 __le16 syn_ip_payload_length /* length of Tcp header in SYN packet - relevent for passive mode */; 197 __le32 syn_phy_addr_lo /* physical address (low) of SYN buffer - relevent for passive mode */; 198 __le32 syn_phy_addr_hi /* physical address (high) of SYN buffer - relevent for passive mode */; 199 __le32 cwnd /* absolute congestion window */; 200 u8 ka_max_probe_cnt; 201 u8 reserved2[3]; 202 __le32 ka_timeout /* This member specifies, in ms, the timeout interval for inactivity before sending a keepalive probe */; 203 __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 */; 204 __le32 max_rt_time /* This member specifies, in ms, the maximum time that the offload target should spend retransmitting a segment */; 205 __le32 reserved3[16]; 206}; 207 208/* 209 * tcp IPv4/IPv6 enum 210 */ 211enum tcp_seg_placement_event 212{ 213 TCP_EVENT_ADD_PEN, 214 TCP_EVENT_ADD_NEW_ISLE, 215 TCP_EVENT_ADD_ISLE_RIGHT, 216 TCP_EVENT_ADD_ISLE_LEFT, 217 TCP_EVENT_JOIN, 218 TCP_EVENT_DELETE_ISLES, 219 TCP_EVENT_NOP, 220 MAX_TCP_SEG_PLACEMENT_EVENT 221}; 222 223/* 224 * tcp init parameters 225 */ 226struct tcp_update_params 227{ 228 __le16 flags; 229#define TCP_UPDATE_PARAMS_REMOTE_MAC_ADDR_CHANGED_MASK 0x1 230#define TCP_UPDATE_PARAMS_REMOTE_MAC_ADDR_CHANGED_SHIFT 0 231#define TCP_UPDATE_PARAMS_MSS_CHANGED_MASK 0x1 232#define TCP_UPDATE_PARAMS_MSS_CHANGED_SHIFT 1 233#define TCP_UPDATE_PARAMS_TTL_CHANGED_MASK 0x1 234#define TCP_UPDATE_PARAMS_TTL_CHANGED_SHIFT 2 235#define TCP_UPDATE_PARAMS_TOS_OR_TC_CHANGED_MASK 0x1 236#define TCP_UPDATE_PARAMS_TOS_OR_TC_CHANGED_SHIFT 3 237#define TCP_UPDATE_PARAMS_KA_TIMEOUT_CHANGED_MASK 0x1 238#define TCP_UPDATE_PARAMS_KA_TIMEOUT_CHANGED_SHIFT 4 239#define TCP_UPDATE_PARAMS_KA_INTERVAL_CHANGED_MASK 0x1 240#define TCP_UPDATE_PARAMS_KA_INTERVAL_CHANGED_SHIFT 5 241#define TCP_UPDATE_PARAMS_MAX_RT_TIME_CHANGED_MASK 0x1 242#define TCP_UPDATE_PARAMS_MAX_RT_TIME_CHANGED_SHIFT 6 243#define TCP_UPDATE_PARAMS_FLOW_LABEL_CHANGED_MASK 0x1 244#define TCP_UPDATE_PARAMS_FLOW_LABEL_CHANGED_SHIFT 7 245#define TCP_UPDATE_PARAMS_INITIAL_RCV_WND_CHANGED_MASK 0x1 246#define TCP_UPDATE_PARAMS_INITIAL_RCV_WND_CHANGED_SHIFT 8 247#define TCP_UPDATE_PARAMS_KA_MAX_PROBE_CNT_CHANGED_MASK 0x1 248#define TCP_UPDATE_PARAMS_KA_MAX_PROBE_CNT_CHANGED_SHIFT 9 249#define TCP_UPDATE_PARAMS_KA_EN_CHANGED_MASK 0x1 250#define TCP_UPDATE_PARAMS_KA_EN_CHANGED_SHIFT 10 251#define TCP_UPDATE_PARAMS_NAGLE_EN_CHANGED_MASK 0x1 252#define TCP_UPDATE_PARAMS_NAGLE_EN_CHANGED_SHIFT 11 253#define TCP_UPDATE_PARAMS_KA_EN_MASK 0x1 254#define TCP_UPDATE_PARAMS_KA_EN_SHIFT 12 255#define TCP_UPDATE_PARAMS_NAGLE_EN_MASK 0x1 256#define TCP_UPDATE_PARAMS_NAGLE_EN_SHIFT 13 257#define TCP_UPDATE_PARAMS_KA_RESTART_MASK 0x1 258#define TCP_UPDATE_PARAMS_KA_RESTART_SHIFT 14 259#define TCP_UPDATE_PARAMS_RETRANSMIT_RESTART_MASK 0x1 260#define TCP_UPDATE_PARAMS_RETRANSMIT_RESTART_SHIFT 15 261 __le16 remote_mac_addr_lo; 262 __le16 remote_mac_addr_mid; 263 __le16 remote_mac_addr_hi; 264 __le16 mss; 265 u8 ttl; 266 u8 tos_or_tc; 267 __le32 ka_timeout; 268 __le32 ka_interval; 269 __le32 max_rt_time; 270 __le32 flow_label; 271 __le32 initial_rcv_wnd; 272 u8 ka_max_probe_cnt; 273 u8 reserved1[7]; 274}; 275 276/* 277 * toe upload parameters 278 */ 279struct tcp_upload_params 280{ 281 __le32 rcv_next; 282 __le32 snd_una; 283 __le32 snd_next; 284 __le32 snd_max; 285 __le32 snd_wnd /* absolute send window (not scaled) */; 286 __le32 rcv_wnd /* absolute receive window (not scaled) */; 287 __le32 snd_wl1 /* the segment sequence number used for the last window update */; 288 __le32 cwnd /* absolute congestion window */; 289 __le32 ss_thresh; 290 __le16 srtt /* in ms */; 291 __le16 rtt_var /* in ms */; 292 __le32 ts_time /* The current value of the adjusted timestamp */; 293 __le32 ts_recent /* The timestamp value to send in the next ACK */; 294 __le32 ts_recent_age /* The length of time, in ms, since the most recent timestamp was received */; 295 __le32 total_rt /* The total time, in ms, that has been spent retransmitting the current TCP segment */; 296 __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. */; 297 __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. */; 298 u8 dup_ack_cnt /* The number of ACKs that have been accepted for the same sequence number */; 299 u8 snd_wnd_probe_cnt /* The current send window probe round */; 300 u8 ka_probe_cnt /* the number of keepalive probes that have been sent that have not received a response */; 301 u8 rt_cnt /* The number of retransmits that have been sent */; 302 __le32 reserved; 303}; 304 305#endif /* __TCP_COMMON__ */ 306