1 /*- 2 * Copyright (c) 2012 Chelsio Communications, Inc. 3 * All rights reserved. 4 * Written by: Navdeep Parhar <np@FreeBSD.org> 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * 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 AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 * 27 * $FreeBSD$ 28 * 29 */ 30 31 #ifndef __T4_TOM_H__ 32 #define __T4_TOM_H__ 33 34 #define KTR_CXGBE KTR_SPARE3 35 #define LISTEN_HASH_SIZE 32 36 37 /* 38 * Min receive window. We want it to be large enough to accommodate receive 39 * coalescing, handle jumbo frames, and not trigger sender SWS avoidance. 40 */ 41 #define MIN_RCV_WND (24 * 1024U) 42 43 /* 44 * Max receive window supported by HW in bytes. Only a small part of it can 45 * be set through option0, the rest needs to be set through RX_DATA_ACK. 46 */ 47 #define MAX_RCV_WND ((1U << 27) - 1) 48 49 #define DDP_RSVD_WIN (16 * 1024U) 50 #define SB_DDP_INDICATE SB_IN_TOE /* soreceive must respond to indicate */ 51 52 #define M_DDP M_PROTO1 53 54 #define USE_DDP_RX_FLOW_CONTROL 55 56 /* TOE PCB flags */ 57 enum { 58 TPF_ATTACHED = (1 << 0), /* a tcpcb refers to this toepcb */ 59 TPF_FLOWC_WR_SENT = (1 << 1), /* firmware flow context WR sent */ 60 TPF_TX_DATA_SENT = (1 << 2), /* some data sent */ 61 TPF_TX_SUSPENDED = (1 << 3), /* tx suspended for lack of resources */ 62 TPF_SEND_FIN = (1 << 4), /* send FIN after all pending data */ 63 TPF_FIN_SENT = (1 << 5), /* FIN has been sent */ 64 TPF_ABORT_SHUTDOWN = (1 << 6), /* connection abort is in progress */ 65 TPF_CPL_PENDING = (1 << 7), /* haven't received the last CPL */ 66 TPF_SYNQE = (1 << 8), /* synq_entry, not really a toepcb */ 67 TPF_SYNQE_NEEDFREE = (1 << 9), /* synq_entry was malloc'd separately */ 68 TPF_SYNQE_TCPDDP = (1 << 10), /* ulp_mode TCPDDP in toepcb */ 69 TPF_SYNQE_EXPANDED = (1 << 11), /* toepcb ready, tid context updated */ 70 TPF_SYNQE_HAS_L2TE = (1 << 12), /* we've replied to PASS_ACCEPT_REQ */ 71 }; 72 73 enum { 74 DDP_OK = (1 << 0), /* OK to turn on DDP */ 75 DDP_SC_REQ = (1 << 1), /* state change (on/off) requested */ 76 DDP_ON = (1 << 2), /* DDP is turned on */ 77 DDP_BUF0_ACTIVE = (1 << 3), /* buffer 0 in use (not invalidated) */ 78 DDP_BUF1_ACTIVE = (1 << 4), /* buffer 1 in use (not invalidated) */ 79 }; 80 81 struct ofld_tx_sdesc { 82 uint32_t plen; /* payload length */ 83 uint8_t tx_credits; /* firmware tx credits (unit is 16B) */ 84 }; 85 86 struct ppod_region { 87 TAILQ_ENTRY(ppod_region) link; 88 int used; /* # of pods used by this region */ 89 int free; /* # of contiguous pods free right after this region */ 90 }; 91 92 struct ddp_buffer { 93 uint32_t tag; /* includes color, page pod addr, and DDP page size */ 94 int nppods; 95 int offset; 96 int len; 97 struct ppod_region ppod_region; 98 int npages; 99 vm_page_t *pages; 100 }; 101 102 struct toepcb { 103 TAILQ_ENTRY(toepcb) link; /* toep_list */ 104 unsigned int flags; /* miscellaneous flags */ 105 struct tom_data *td; 106 struct inpcb *inp; /* backpointer to host stack's PCB */ 107 struct port_info *port; /* physical port */ 108 struct sge_wrq *ofld_txq; 109 struct sge_ofld_rxq *ofld_rxq; 110 struct sge_wrq *ctrlq; 111 struct l2t_entry *l2te; /* L2 table entry used by this connection */ 112 struct clip_entry *ce; /* CLIP table entry used by this tid */ 113 int tid; /* Connection identifier */ 114 unsigned int tx_credits;/* tx WR credits (in 16 byte units) remaining */ 115 unsigned int sb_cc; /* last noted value of so_rcv->sb_cc */ 116 int rx_credits; /* rx credits (in bytes) to be returned to hw */ 117 118 unsigned int ulp_mode; /* ULP mode */ 119 120 unsigned int ddp_flags; 121 struct ddp_buffer *db[2]; 122 time_t ddp_disabled; 123 uint8_t ddp_score; 124 125 /* Tx software descriptor */ 126 uint8_t txsd_total; 127 uint8_t txsd_pidx; 128 uint8_t txsd_cidx; 129 uint8_t txsd_avail; 130 struct ofld_tx_sdesc txsd[]; 131 }; 132 133 struct flowc_tx_params { 134 uint32_t snd_nxt; 135 uint32_t rcv_nxt; 136 unsigned int snd_space; 137 unsigned int mss; 138 }; 139 140 #define DDP_RETRY_WAIT 5 /* seconds to wait before re-enabling DDP */ 141 #define DDP_LOW_SCORE 1 142 #define DDP_HIGH_SCORE 3 143 144 /* 145 * Compressed state for embryonic connections for a listener. Barely fits in 146 * 64B, try not to grow it further. 147 */ 148 struct synq_entry { 149 TAILQ_ENTRY(synq_entry) link; /* listen_ctx's synq link */ 150 int flags; /* same as toepcb's tp_flags */ 151 int tid; 152 struct listen_ctx *lctx; /* backpointer to listen ctx */ 153 struct mbuf *syn; 154 uint32_t iss; 155 uint32_t ts; 156 volatile uintptr_t wr; 157 volatile u_int refcnt; 158 uint16_t l2e_idx; 159 uint16_t rcv_bufsize; 160 }; 161 162 /* listen_ctx flags */ 163 #define LCTX_RPL_PENDING 1 /* waiting for a CPL_PASS_OPEN_RPL */ 164 165 struct listen_ctx { 166 LIST_ENTRY(listen_ctx) link; /* listen hash linkage */ 167 volatile int refcount; 168 int stid; 169 struct stid_region stid_region; 170 int flags; 171 struct inpcb *inp; /* listening socket's inp */ 172 struct sge_wrq *ctrlq; 173 struct sge_ofld_rxq *ofld_rxq; 174 TAILQ_HEAD(, synq_entry) synq; 175 }; 176 177 TAILQ_HEAD(ppod_head, ppod_region); 178 179 struct clip_entry { 180 TAILQ_ENTRY(clip_entry) link; 181 struct in6_addr lip; /* local IPv6 address */ 182 u_int refcount; 183 }; 184 185 struct tom_data { 186 struct toedev tod; 187 188 /* toepcb's associated with this TOE device */ 189 struct mtx toep_list_lock; 190 TAILQ_HEAD(, toepcb) toep_list; 191 192 struct mtx lctx_hash_lock; 193 LIST_HEAD(, listen_ctx) *listen_hash; 194 u_long listen_mask; 195 int lctx_count; /* # of lctx in the hash table */ 196 197 struct mtx ppod_lock; 198 int nppods; 199 int nppods_free; /* # of available ppods */ 200 int nppods_free_head; /* # of available ppods at the begining */ 201 struct ppod_head ppods; 202 203 struct mtx clip_table_lock; 204 TAILQ_HEAD(, clip_entry) clip_table; 205 }; 206 207 static inline struct tom_data * 208 tod_td(struct toedev *tod) 209 { 210 211 return (__containerof(tod, struct tom_data, tod)); 212 } 213 214 static inline struct adapter * 215 td_adapter(struct tom_data *td) 216 { 217 218 return (td->tod.tod_softc); 219 } 220 221 /* t4_tom.c */ 222 struct toepcb *alloc_toepcb(struct port_info *, int, int, int); 223 void free_toepcb(struct toepcb *); 224 void offload_socket(struct socket *, struct toepcb *); 225 void undo_offload_socket(struct socket *); 226 void final_cpl_received(struct toepcb *); 227 void insert_tid(struct adapter *, int, void *); 228 void *lookup_tid(struct adapter *, int); 229 void update_tid(struct adapter *, int, void *); 230 void remove_tid(struct adapter *, int); 231 void release_tid(struct adapter *, int, struct sge_wrq *); 232 int find_best_mtu_idx(struct adapter *, struct in_conninfo *, int); 233 u_long select_rcv_wnd(struct socket *); 234 int select_rcv_wscale(void); 235 uint64_t calc_opt0(struct socket *, struct port_info *, struct l2t_entry *, 236 int, int, int, int); 237 uint32_t select_ntuple(struct port_info *, struct l2t_entry *, uint32_t); 238 void set_tcpddp_ulp_mode(struct toepcb *); 239 int negative_advice(int); 240 struct clip_entry *hold_lip(struct tom_data *, struct in6_addr *); 241 void release_lip(struct tom_data *, struct clip_entry *); 242 243 /* t4_connect.c */ 244 void t4_init_connect_cpl_handlers(struct adapter *); 245 int t4_connect(struct toedev *, struct socket *, struct rtentry *, 246 struct sockaddr *); 247 248 /* t4_listen.c */ 249 void t4_init_listen_cpl_handlers(struct adapter *); 250 int t4_listen_start(struct toedev *, struct tcpcb *); 251 int t4_listen_stop(struct toedev *, struct tcpcb *); 252 void t4_syncache_added(struct toedev *, void *); 253 void t4_syncache_removed(struct toedev *, void *); 254 int t4_syncache_respond(struct toedev *, void *, struct mbuf *); 255 int do_abort_req_synqe(struct sge_iq *, const struct rss_header *, 256 struct mbuf *); 257 int do_abort_rpl_synqe(struct sge_iq *, const struct rss_header *, 258 struct mbuf *); 259 void t4_offload_socket(struct toedev *, void *, struct socket *); 260 261 /* t4_cpl_io.c */ 262 void t4_init_cpl_io_handlers(struct adapter *); 263 void t4_uninit_cpl_io_handlers(struct adapter *); 264 void send_abort_rpl(struct adapter *, struct sge_wrq *, int , int); 265 void send_flowc_wr(struct toepcb *, struct flowc_tx_params *); 266 void send_reset(struct adapter *, struct toepcb *, uint32_t); 267 void make_established(struct toepcb *, uint32_t, uint32_t, uint16_t); 268 void t4_rcvd(struct toedev *, struct tcpcb *); 269 int t4_tod_output(struct toedev *, struct tcpcb *); 270 int t4_send_fin(struct toedev *, struct tcpcb *); 271 int t4_send_rst(struct toedev *, struct tcpcb *); 272 void t4_set_tcb_field(struct adapter *, struct toepcb *, uint16_t, uint64_t, 273 uint64_t); 274 275 /* t4_ddp.c */ 276 void t4_init_ddp(struct adapter *, struct tom_data *); 277 void t4_uninit_ddp(struct adapter *, struct tom_data *); 278 int t4_soreceive_ddp(struct socket *, struct sockaddr **, struct uio *, 279 struct mbuf **, struct mbuf **, int *); 280 void enable_ddp(struct adapter *, struct toepcb *toep); 281 void release_ddp_resources(struct toepcb *toep); 282 void insert_ddp_data(struct toepcb *, uint32_t); 283 #endif 284