t4_tom.h revision 276729
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: head/sys/dev/cxgbe/tom/t4_tom.h 276729 2015-01-06 01:30:32Z np $ 28 * 29 */ 30 31#ifndef __T4_TOM_H__ 32#define __T4_TOM_H__ 33#include <sys/vmem.h> 34 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 USE_DDP_RX_FLOW_CONTROL 53 54/* TOE PCB flags */ 55enum { 56 TPF_ATTACHED = (1 << 0), /* a tcpcb refers to this toepcb */ 57 TPF_FLOWC_WR_SENT = (1 << 1), /* firmware flow context WR sent */ 58 TPF_TX_DATA_SENT = (1 << 2), /* some data sent */ 59 TPF_TX_SUSPENDED = (1 << 3), /* tx suspended for lack of resources */ 60 TPF_SEND_FIN = (1 << 4), /* send FIN after all pending data */ 61 TPF_FIN_SENT = (1 << 5), /* FIN has been sent */ 62 TPF_ABORT_SHUTDOWN = (1 << 6), /* connection abort is in progress */ 63 TPF_CPL_PENDING = (1 << 7), /* haven't received the last CPL */ 64 TPF_SYNQE = (1 << 8), /* synq_entry, not really a toepcb */ 65 TPF_SYNQE_NEEDFREE = (1 << 9), /* synq_entry was malloc'd separately */ 66 TPF_SYNQE_TCPDDP = (1 << 10), /* ulp_mode TCPDDP in toepcb */ 67 TPF_SYNQE_EXPANDED = (1 << 11), /* toepcb ready, tid context updated */ 68 TPF_SYNQE_HAS_L2TE = (1 << 12), /* we've replied to PASS_ACCEPT_REQ */ 69}; 70 71enum { 72 DDP_OK = (1 << 0), /* OK to turn on DDP */ 73 DDP_SC_REQ = (1 << 1), /* state change (on/off) requested */ 74 DDP_ON = (1 << 2), /* DDP is turned on */ 75 DDP_BUF0_ACTIVE = (1 << 3), /* buffer 0 in use (not invalidated) */ 76 DDP_BUF1_ACTIVE = (1 << 4), /* buffer 1 in use (not invalidated) */ 77}; 78 79struct ofld_tx_sdesc { 80 uint32_t plen; /* payload length */ 81 uint8_t tx_credits; /* firmware tx credits (unit is 16B) */ 82}; 83 84struct ddp_buffer { 85 uint32_t tag; /* includes color, page pod addr, and DDP page size */ 86 int nppods; 87 int offset; 88 int len; 89 int npages; 90 vm_page_t *pages; 91}; 92 93struct toepcb { 94 TAILQ_ENTRY(toepcb) link; /* toep_list */ 95 u_int flags; /* miscellaneous flags */ 96 struct tom_data *td; 97 struct inpcb *inp; /* backpointer to host stack's PCB */ 98 struct port_info *port; /* physical port */ 99 struct sge_wrq *ofld_txq; 100 struct sge_ofld_rxq *ofld_rxq; 101 struct sge_wrq *ctrlq; 102 struct l2t_entry *l2te; /* L2 table entry used by this connection */ 103 struct clip_entry *ce; /* CLIP table entry used by this tid */ 104 int tid; /* Connection identifier */ 105 106 /* tx credit handling */ 107 u_int tx_total; /* total tx WR credits (in 16B units) */ 108 u_int tx_credits; /* tx WR credits (in 16B units) available */ 109 u_int tx_nocompl; /* tx WR credits since last compl request */ 110 u_int plen_nocompl; /* payload since last compl request */ 111 112 /* rx credit handling */ 113 u_int sb_cc; /* last noted value of so_rcv->sb_cc */ 114 int rx_credits; /* rx credits (in bytes) to be returned to hw */ 115 116 u_int ulp_mode; /* ULP mode */ 117 118 u_int ddp_flags; 119 struct ddp_buffer *db[2]; 120 time_t ddp_disabled; 121 uint8_t ddp_score; 122 123 /* Tx software descriptor */ 124 uint8_t txsd_total; 125 uint8_t txsd_pidx; 126 uint8_t txsd_cidx; 127 uint8_t txsd_avail; 128 struct ofld_tx_sdesc txsd[]; 129}; 130 131struct flowc_tx_params { 132 uint32_t snd_nxt; 133 uint32_t rcv_nxt; 134 unsigned int snd_space; 135 unsigned int mss; 136}; 137 138#define DDP_RETRY_WAIT 5 /* seconds to wait before re-enabling DDP */ 139#define DDP_LOW_SCORE 1 140#define DDP_HIGH_SCORE 3 141 142/* 143 * Compressed state for embryonic connections for a listener. Barely fits in 144 * 64B, try not to grow it further. 145 */ 146struct synq_entry { 147 TAILQ_ENTRY(synq_entry) link; /* listen_ctx's synq link */ 148 int flags; /* same as toepcb's tp_flags */ 149 int tid; 150 struct listen_ctx *lctx; /* backpointer to listen ctx */ 151 struct mbuf *syn; 152 uint32_t iss; 153 uint32_t ts; 154 volatile uintptr_t wr; 155 volatile u_int refcnt; 156 uint16_t l2e_idx; 157 uint16_t rcv_bufsize; 158}; 159 160/* listen_ctx flags */ 161#define LCTX_RPL_PENDING 1 /* waiting for a CPL_PASS_OPEN_RPL */ 162 163struct listen_ctx { 164 LIST_ENTRY(listen_ctx) link; /* listen hash linkage */ 165 volatile int refcount; 166 int stid; 167 struct stid_region stid_region; 168 int flags; 169 struct inpcb *inp; /* listening socket's inp */ 170 struct sge_wrq *ctrlq; 171 struct sge_ofld_rxq *ofld_rxq; 172 struct clip_entry *ce; 173 TAILQ_HEAD(, synq_entry) synq; 174}; 175 176struct clip_entry { 177 TAILQ_ENTRY(clip_entry) link; 178 struct in6_addr lip; /* local IPv6 address */ 179 u_int refcount; 180}; 181 182TAILQ_HEAD(clip_head, clip_entry); 183struct tom_data { 184 struct toedev tod; 185 186 /* toepcb's associated with this TOE device */ 187 struct mtx toep_list_lock; 188 TAILQ_HEAD(, toepcb) toep_list; 189 190 struct mtx lctx_hash_lock; 191 LIST_HEAD(, listen_ctx) *listen_hash; 192 u_long listen_mask; 193 int lctx_count; /* # of lctx in the hash table */ 194 195 vmem_t *ppod_arena; 196 197 struct mtx clip_table_lock; 198 struct clip_head clip_table; 199 int clip_gen; 200 201 /* WRs that will not be sent to the chip because L2 resolution failed */ 202 struct mtx unsent_wr_lock; 203 STAILQ_HEAD(, wrqe) unsent_wr_list; 204 struct task reclaim_wr_resources; 205}; 206 207static inline struct tom_data * 208tod_td(struct toedev *tod) 209{ 210 211 return (__containerof(tod, struct tom_data, tod)); 212} 213 214static inline struct adapter * 215td_adapter(struct tom_data *td) 216{ 217 218 return (td->tod.tod_softc); 219} 220 221/* t4_tom.c */ 222struct toepcb *alloc_toepcb(struct port_info *, int, int, int); 223void free_toepcb(struct toepcb *); 224void offload_socket(struct socket *, struct toepcb *); 225void undo_offload_socket(struct socket *); 226void final_cpl_received(struct toepcb *); 227void insert_tid(struct adapter *, int, void *); 228void *lookup_tid(struct adapter *, int); 229void update_tid(struct adapter *, int, void *); 230void remove_tid(struct adapter *, int); 231void release_tid(struct adapter *, int, struct sge_wrq *); 232int find_best_mtu_idx(struct adapter *, struct in_conninfo *, int); 233u_long select_rcv_wnd(struct socket *); 234int select_rcv_wscale(void); 235uint64_t calc_opt0(struct socket *, struct port_info *, struct l2t_entry *, 236 int, int, int, int); 237uint64_t select_ntuple(struct port_info *, struct l2t_entry *); 238void set_tcpddp_ulp_mode(struct toepcb *); 239int negative_advice(int); 240struct clip_entry *hold_lip(struct tom_data *, struct in6_addr *); 241void release_lip(struct tom_data *, struct clip_entry *); 242 243/* t4_connect.c */ 244void t4_init_connect_cpl_handlers(struct adapter *); 245int t4_connect(struct toedev *, struct socket *, struct rtentry *, 246 struct sockaddr *); 247void act_open_failure_cleanup(struct adapter *, u_int, u_int); 248 249/* t4_listen.c */ 250void t4_init_listen_cpl_handlers(struct adapter *); 251int t4_listen_start(struct toedev *, struct tcpcb *); 252int t4_listen_stop(struct toedev *, struct tcpcb *); 253void t4_syncache_added(struct toedev *, void *); 254void t4_syncache_removed(struct toedev *, void *); 255int t4_syncache_respond(struct toedev *, void *, struct mbuf *); 256int do_abort_req_synqe(struct sge_iq *, const struct rss_header *, 257 struct mbuf *); 258int do_abort_rpl_synqe(struct sge_iq *, const struct rss_header *, 259 struct mbuf *); 260void t4_offload_socket(struct toedev *, void *, struct socket *); 261 262/* t4_cpl_io.c */ 263void t4_init_cpl_io_handlers(struct adapter *); 264void t4_uninit_cpl_io_handlers(struct adapter *); 265void send_abort_rpl(struct adapter *, struct sge_wrq *, int , int); 266void send_flowc_wr(struct toepcb *, struct flowc_tx_params *); 267void send_reset(struct adapter *, struct toepcb *, uint32_t); 268void make_established(struct toepcb *, uint32_t, uint32_t, uint16_t); 269void t4_rcvd(struct toedev *, struct tcpcb *); 270int t4_tod_output(struct toedev *, struct tcpcb *); 271int t4_send_fin(struct toedev *, struct tcpcb *); 272int t4_send_rst(struct toedev *, struct tcpcb *); 273void t4_set_tcb_field(struct adapter *, struct toepcb *, int, uint16_t, 274 uint64_t, uint64_t); 275void t4_push_frames(struct adapter *sc, struct toepcb *toep, int drop); 276 277/* t4_ddp.c */ 278void t4_init_ddp(struct adapter *, struct tom_data *); 279void t4_uninit_ddp(struct adapter *, struct tom_data *); 280int t4_soreceive_ddp(struct socket *, struct sockaddr **, struct uio *, 281 struct mbuf **, struct mbuf **, int *); 282struct mbuf *get_ddp_mbuf(int); 283void enable_ddp(struct adapter *, struct toepcb *toep); 284void release_ddp_resources(struct toepcb *toep); 285void insert_ddp_data(struct toepcb *, uint32_t); 286 287/* ULP related */ 288#define CXGBE_ISCSI_MBUF_TAG 50 289int t4tom_cpl_handler_registered(struct adapter *, unsigned int); 290void t4tom_register_cpl_iscsi_callback(void (*fp)(struct tom_data *, 291 struct socket *, void *, unsigned int)); 292void t4tom_register_queue_iscsi_callback(struct mbuf *(*fp)(struct socket *, 293 unsigned int, int *)); 294void t4_ulp_push_frames(struct adapter *sc, struct toepcb *toep, int); 295int t4_cpl_iscsi_callback(struct tom_data *, struct toepcb *, void *, uint32_t); 296struct mbuf *t4_queue_iscsi_callback(struct socket *, struct toepcb *, uint32_t, 297 int *); 298extern void (*tom_cpl_iscsi_callback)(struct tom_data *, struct socket *, 299 void *, unsigned int); 300extern struct mbuf *(*tom_queue_iscsi_callback)(struct socket*, unsigned int, 301 int *); 302#endif 303