xref: /openbmc/linux/drivers/net/ethernet/chelsio/cxgb4/cxgb4_uld.h (revision eb3fcf007fffe5830d815e713591f3e858f2a365)
1 /*
2  * This file is part of the Chelsio T4 Ethernet driver for Linux.
3  *
4  * Copyright (c) 2003-2014 Chelsio Communications, Inc. All rights reserved.
5  *
6  * This software is available to you under a choice of one of two
7  * licenses.  You may choose to be licensed under the terms of the GNU
8  * General Public License (GPL) Version 2, available from the file
9  * COPYING in the main directory of this source tree, or the
10  * OpenIB.org BSD license below:
11  *
12  *     Redistribution and use in source and binary forms, with or
13  *     without modification, are permitted provided that the following
14  *     conditions are met:
15  *
16  *      - Redistributions of source code must retain the above
17  *        copyright notice, this list of conditions and the following
18  *        disclaimer.
19  *
20  *      - Redistributions in binary form must reproduce the above
21  *        copyright notice, this list of conditions and the following
22  *        disclaimer in the documentation and/or other materials
23  *        provided with the distribution.
24  *
25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32  * SOFTWARE.
33  */
34 
35 #ifndef __CXGB4_OFLD_H
36 #define __CXGB4_OFLD_H
37 
38 #include <linux/cache.h>
39 #include <linux/spinlock.h>
40 #include <linux/skbuff.h>
41 #include <linux/inetdevice.h>
42 #include <linux/atomic.h>
43 
44 /* CPL message priority levels */
45 enum {
46 	CPL_PRIORITY_DATA     = 0,  /* data messages */
47 	CPL_PRIORITY_SETUP    = 1,  /* connection setup messages */
48 	CPL_PRIORITY_TEARDOWN = 0,  /* connection teardown messages */
49 	CPL_PRIORITY_LISTEN   = 1,  /* listen start/stop messages */
50 	CPL_PRIORITY_ACK      = 1,  /* RX ACK messages */
51 	CPL_PRIORITY_CONTROL  = 1   /* control messages */
52 };
53 
54 #define INIT_TP_WR(w, tid) do { \
55 	(w)->wr.wr_hi = htonl(FW_WR_OP_V(FW_TP_WR) | \
56 			      FW_WR_IMMDLEN_V(sizeof(*w) - sizeof(w->wr))); \
57 	(w)->wr.wr_mid = htonl(FW_WR_LEN16_V(DIV_ROUND_UP(sizeof(*w), 16)) | \
58 			       FW_WR_FLOWID_V(tid)); \
59 	(w)->wr.wr_lo = cpu_to_be64(0); \
60 } while (0)
61 
62 #define INIT_TP_WR_CPL(w, cpl, tid) do { \
63 	INIT_TP_WR(w, tid); \
64 	OPCODE_TID(w) = htonl(MK_OPCODE_TID(cpl, tid)); \
65 } while (0)
66 
67 #define INIT_ULPTX_WR(w, wrlen, atomic, tid) do { \
68 	(w)->wr.wr_hi = htonl(FW_WR_OP_V(FW_ULPTX_WR) | \
69 			      FW_WR_ATOMIC_V(atomic)); \
70 	(w)->wr.wr_mid = htonl(FW_WR_LEN16_V(DIV_ROUND_UP(wrlen, 16)) | \
71 			       FW_WR_FLOWID_V(tid)); \
72 	(w)->wr.wr_lo = cpu_to_be64(0); \
73 } while (0)
74 
75 /* Special asynchronous notification message */
76 #define CXGB4_MSG_AN ((void *)1)
77 
78 struct serv_entry {
79 	void *data;
80 };
81 
82 union aopen_entry {
83 	void *data;
84 	union aopen_entry *next;
85 };
86 
87 /*
88  * Holds the size, base address, free list start, etc of the TID, server TID,
89  * and active-open TID tables.  The tables themselves are allocated dynamically.
90  */
91 struct tid_info {
92 	void **tid_tab;
93 	unsigned int ntids;
94 
95 	struct serv_entry *stid_tab;
96 	unsigned long *stid_bmap;
97 	unsigned int nstids;
98 	unsigned int stid_base;
99 	unsigned int hash_base;
100 
101 	union aopen_entry *atid_tab;
102 	unsigned int natids;
103 	unsigned int atid_base;
104 
105 	struct filter_entry *ftid_tab;
106 	unsigned int nftids;
107 	unsigned int ftid_base;
108 	unsigned int aftid_base;
109 	unsigned int aftid_end;
110 	/* Server filter region */
111 	unsigned int sftid_base;
112 	unsigned int nsftids;
113 
114 	spinlock_t atid_lock ____cacheline_aligned_in_smp;
115 	union aopen_entry *afree;
116 	unsigned int atids_in_use;
117 
118 	spinlock_t stid_lock;
119 	unsigned int stids_in_use;
120 	unsigned int sftids_in_use;
121 
122 	/* TIDs in the TCAM */
123 	atomic_t tids_in_use;
124 	/* TIDs in the HASH */
125 	atomic_t hash_tids_in_use;
126 };
127 
128 static inline void *lookup_tid(const struct tid_info *t, unsigned int tid)
129 {
130 	return tid < t->ntids ? t->tid_tab[tid] : NULL;
131 }
132 
133 static inline void *lookup_atid(const struct tid_info *t, unsigned int atid)
134 {
135 	return atid < t->natids ? t->atid_tab[atid].data : NULL;
136 }
137 
138 static inline void *lookup_stid(const struct tid_info *t, unsigned int stid)
139 {
140 	/* Is it a server filter TID? */
141 	if (t->nsftids && (stid >= t->sftid_base)) {
142 		stid -= t->sftid_base;
143 		stid += t->nstids;
144 	} else {
145 		stid -= t->stid_base;
146 	}
147 
148 	return stid < (t->nstids + t->nsftids) ? t->stid_tab[stid].data : NULL;
149 }
150 
151 static inline void cxgb4_insert_tid(struct tid_info *t, void *data,
152 				    unsigned int tid)
153 {
154 	t->tid_tab[tid] = data;
155 	if (t->hash_base && (tid >= t->hash_base))
156 		atomic_inc(&t->hash_tids_in_use);
157 	else
158 		atomic_inc(&t->tids_in_use);
159 }
160 
161 int cxgb4_alloc_atid(struct tid_info *t, void *data);
162 int cxgb4_alloc_stid(struct tid_info *t, int family, void *data);
163 int cxgb4_alloc_sftid(struct tid_info *t, int family, void *data);
164 void cxgb4_free_atid(struct tid_info *t, unsigned int atid);
165 void cxgb4_free_stid(struct tid_info *t, unsigned int stid, int family);
166 void cxgb4_remove_tid(struct tid_info *t, unsigned int qid, unsigned int tid);
167 
168 struct in6_addr;
169 
170 int cxgb4_create_server(const struct net_device *dev, unsigned int stid,
171 			__be32 sip, __be16 sport, __be16 vlan,
172 			unsigned int queue);
173 int cxgb4_create_server6(const struct net_device *dev, unsigned int stid,
174 			 const struct in6_addr *sip, __be16 sport,
175 			 unsigned int queue);
176 int cxgb4_remove_server(const struct net_device *dev, unsigned int stid,
177 			unsigned int queue, bool ipv6);
178 int cxgb4_create_server_filter(const struct net_device *dev, unsigned int stid,
179 			       __be32 sip, __be16 sport, __be16 vlan,
180 			       unsigned int queue,
181 			       unsigned char port, unsigned char mask);
182 int cxgb4_remove_server_filter(const struct net_device *dev, unsigned int stid,
183 			       unsigned int queue, bool ipv6);
184 
185 static inline void set_wr_txq(struct sk_buff *skb, int prio, int queue)
186 {
187 	skb_set_queue_mapping(skb, (queue << 1) | prio);
188 }
189 
190 enum cxgb4_uld {
191 	CXGB4_ULD_RDMA,
192 	CXGB4_ULD_ISCSI,
193 	CXGB4_ULD_MAX
194 };
195 
196 enum cxgb4_state {
197 	CXGB4_STATE_UP,
198 	CXGB4_STATE_START_RECOVERY,
199 	CXGB4_STATE_DOWN,
200 	CXGB4_STATE_DETACH
201 };
202 
203 enum cxgb4_control {
204 	CXGB4_CONTROL_DB_FULL,
205 	CXGB4_CONTROL_DB_EMPTY,
206 	CXGB4_CONTROL_DB_DROP,
207 };
208 
209 struct pci_dev;
210 struct l2t_data;
211 struct net_device;
212 struct pkt_gl;
213 struct tp_tcp_stats;
214 
215 struct cxgb4_range {
216 	unsigned int start;
217 	unsigned int size;
218 };
219 
220 struct cxgb4_virt_res {                      /* virtualized HW resources */
221 	struct cxgb4_range ddp;
222 	struct cxgb4_range iscsi;
223 	struct cxgb4_range stag;
224 	struct cxgb4_range rq;
225 	struct cxgb4_range pbl;
226 	struct cxgb4_range qp;
227 	struct cxgb4_range cq;
228 	struct cxgb4_range ocq;
229 };
230 
231 #define OCQ_WIN_OFFSET(pdev, vres) \
232 	(pci_resource_len((pdev), 2) - roundup_pow_of_two((vres)->ocq.size))
233 
234 /*
235  * Block of information the LLD provides to ULDs attaching to a device.
236  */
237 struct cxgb4_lld_info {
238 	struct pci_dev *pdev;                /* associated PCI device */
239 	struct l2t_data *l2t;                /* L2 table */
240 	struct tid_info *tids;               /* TID table */
241 	struct net_device **ports;           /* device ports */
242 	const struct cxgb4_virt_res *vr;     /* assorted HW resources */
243 	const unsigned short *mtus;          /* MTU table */
244 	const unsigned short *rxq_ids;       /* the ULD's Rx queue ids */
245 	const unsigned short *ciq_ids;       /* the ULD's concentrator IQ ids */
246 	unsigned short nrxq;                 /* # of Rx queues */
247 	unsigned short ntxq;                 /* # of Tx queues */
248 	unsigned short nciq;		     /* # of concentrator IQ */
249 	unsigned char nchan:4;               /* # of channels */
250 	unsigned char nports:4;              /* # of ports */
251 	unsigned char wr_cred;               /* WR 16-byte credits */
252 	unsigned char adapter_type;          /* type of adapter */
253 	unsigned char fw_api_ver;            /* FW API version */
254 	unsigned int fw_vers;                /* FW version */
255 	unsigned int iscsi_iolen;            /* iSCSI max I/O length */
256 	unsigned int cclk_ps;                /* Core clock period in psec */
257 	unsigned short udb_density;          /* # of user DB/page */
258 	unsigned short ucq_density;          /* # of user CQs/page */
259 	unsigned short filt_mode;            /* filter optional components */
260 	unsigned short tx_modq[NCHAN];       /* maps each tx channel to a */
261 					     /* scheduler queue */
262 	void __iomem *gts_reg;               /* address of GTS register */
263 	void __iomem *db_reg;                /* address of kernel doorbell */
264 	int dbfifo_int_thresh;		     /* doorbell fifo int threshold */
265 	unsigned int sge_ingpadboundary;     /* SGE ingress padding boundary */
266 	unsigned int sge_egrstatuspagesize;  /* SGE egress status page size */
267 	unsigned int sge_pktshift;           /* Padding between CPL and */
268 					     /*	packet data */
269 	unsigned int pf;		     /* Physical Function we're using */
270 	bool enable_fw_ofld_conn;            /* Enable connection through fw */
271 					     /* WR */
272 	unsigned int max_ordird_qp;          /* Max ORD/IRD depth per RDMA QP */
273 	unsigned int max_ird_adapter;        /* Max IRD memory per adapter */
274 	bool ulptx_memwrite_dsgl;            /* use of T5 DSGL allowed */
275 	int nodeid;			     /* device numa node id */
276 };
277 
278 struct cxgb4_uld_info {
279 	const char *name;
280 	void *(*add)(const struct cxgb4_lld_info *p);
281 	int (*rx_handler)(void *handle, const __be64 *rsp,
282 			  const struct pkt_gl *gl);
283 	int (*state_change)(void *handle, enum cxgb4_state new_state);
284 	int (*control)(void *handle, enum cxgb4_control control, ...);
285 };
286 
287 int cxgb4_register_uld(enum cxgb4_uld type, const struct cxgb4_uld_info *p);
288 int cxgb4_unregister_uld(enum cxgb4_uld type);
289 int cxgb4_ofld_send(struct net_device *dev, struct sk_buff *skb);
290 unsigned int cxgb4_dbfifo_count(const struct net_device *dev, int lpfifo);
291 unsigned int cxgb4_port_chan(const struct net_device *dev);
292 unsigned int cxgb4_port_viid(const struct net_device *dev);
293 unsigned int cxgb4_port_idx(const struct net_device *dev);
294 unsigned int cxgb4_best_mtu(const unsigned short *mtus, unsigned short mtu,
295 			    unsigned int *idx);
296 unsigned int cxgb4_best_aligned_mtu(const unsigned short *mtus,
297 				    unsigned short header_size,
298 				    unsigned short data_size_max,
299 				    unsigned short data_size_align,
300 				    unsigned int *mtu_idxp);
301 void cxgb4_get_tcp_stats(struct pci_dev *pdev, struct tp_tcp_stats *v4,
302 			 struct tp_tcp_stats *v6);
303 void cxgb4_iscsi_init(struct net_device *dev, unsigned int tag_mask,
304 		      const unsigned int *pgsz_order);
305 struct sk_buff *cxgb4_pktgl_to_skb(const struct pkt_gl *gl,
306 				   unsigned int skb_len, unsigned int pull_len);
307 int cxgb4_sync_txq_pidx(struct net_device *dev, u16 qid, u16 pidx, u16 size);
308 int cxgb4_flush_eq_cache(struct net_device *dev);
309 int cxgb4_read_tpte(struct net_device *dev, u32 stag, __be32 *tpte);
310 u64 cxgb4_read_sge_timestamp(struct net_device *dev);
311 
312 enum cxgb4_bar2_qtype { CXGB4_BAR2_QTYPE_EGRESS, CXGB4_BAR2_QTYPE_INGRESS };
313 int cxgb4_bar2_sge_qregs(struct net_device *dev,
314 			 unsigned int qid,
315 			 enum cxgb4_bar2_qtype qtype,
316 			 int user,
317 			 u64 *pbar2_qoffset,
318 			 unsigned int *pbar2_qid);
319 
320 #endif  /* !__CXGB4_OFLD_H */
321