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(FW_TP_WR) | \
56 			      FW_WR_IMMDLEN(sizeof(*w) - sizeof(w->wr))); \
57 	(w)->wr.wr_mid = htonl(FW_WR_LEN16(DIV_ROUND_UP(sizeof(*w), 16)) | \
58 			       FW_WR_FLOWID(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(FW_ULPTX_WR) | FW_WR_ATOMIC(atomic)); \
69 	(w)->wr.wr_mid = htonl(FW_WR_LEN16(DIV_ROUND_UP(wrlen, 16)) | \
70 			       FW_WR_FLOWID(tid)); \
71 	(w)->wr.wr_lo = cpu_to_be64(0); \
72 } while (0)
73 
74 /* Special asynchronous notification message */
75 #define CXGB4_MSG_AN ((void *)1)
76 
77 struct serv_entry {
78 	void *data;
79 };
80 
81 union aopen_entry {
82 	void *data;
83 	union aopen_entry *next;
84 };
85 
86 /*
87  * Holds the size, base address, free list start, etc of the TID, server TID,
88  * and active-open TID tables.  The tables themselves are allocated dynamically.
89  */
90 struct tid_info {
91 	void **tid_tab;
92 	unsigned int ntids;
93 
94 	struct serv_entry *stid_tab;
95 	unsigned long *stid_bmap;
96 	unsigned int nstids;
97 	unsigned int stid_base;
98 
99 	union aopen_entry *atid_tab;
100 	unsigned int natids;
101 	unsigned int atid_base;
102 
103 	struct filter_entry *ftid_tab;
104 	unsigned int nftids;
105 	unsigned int ftid_base;
106 	unsigned int aftid_base;
107 	unsigned int aftid_end;
108 	/* Server filter region */
109 	unsigned int sftid_base;
110 	unsigned int nsftids;
111 
112 	spinlock_t atid_lock ____cacheline_aligned_in_smp;
113 	union aopen_entry *afree;
114 	unsigned int atids_in_use;
115 
116 	spinlock_t stid_lock;
117 	unsigned int stids_in_use;
118 
119 	atomic_t tids_in_use;
120 };
121 
122 static inline void *lookup_tid(const struct tid_info *t, unsigned int tid)
123 {
124 	return tid < t->ntids ? t->tid_tab[tid] : NULL;
125 }
126 
127 static inline void *lookup_atid(const struct tid_info *t, unsigned int atid)
128 {
129 	return atid < t->natids ? t->atid_tab[atid].data : NULL;
130 }
131 
132 static inline void *lookup_stid(const struct tid_info *t, unsigned int stid)
133 {
134 	/* Is it a server filter TID? */
135 	if (t->nsftids && (stid >= t->sftid_base)) {
136 		stid -= t->sftid_base;
137 		stid += t->nstids;
138 	} else {
139 		stid -= t->stid_base;
140 	}
141 
142 	return stid < (t->nstids + t->nsftids) ? t->stid_tab[stid].data : NULL;
143 }
144 
145 static inline void cxgb4_insert_tid(struct tid_info *t, void *data,
146 				    unsigned int tid)
147 {
148 	t->tid_tab[tid] = data;
149 	atomic_inc(&t->tids_in_use);
150 }
151 
152 int cxgb4_alloc_atid(struct tid_info *t, void *data);
153 int cxgb4_alloc_stid(struct tid_info *t, int family, void *data);
154 int cxgb4_alloc_sftid(struct tid_info *t, int family, void *data);
155 void cxgb4_free_atid(struct tid_info *t, unsigned int atid);
156 void cxgb4_free_stid(struct tid_info *t, unsigned int stid, int family);
157 void cxgb4_remove_tid(struct tid_info *t, unsigned int qid, unsigned int tid);
158 
159 struct in6_addr;
160 
161 int cxgb4_create_server(const struct net_device *dev, unsigned int stid,
162 			__be32 sip, __be16 sport, __be16 vlan,
163 			unsigned int queue);
164 int cxgb4_create_server6(const struct net_device *dev, unsigned int stid,
165 			 const struct in6_addr *sip, __be16 sport,
166 			 unsigned int queue);
167 int cxgb4_remove_server(const struct net_device *dev, unsigned int stid,
168 			unsigned int queue, bool ipv6);
169 int cxgb4_create_server_filter(const struct net_device *dev, unsigned int stid,
170 			       __be32 sip, __be16 sport, __be16 vlan,
171 			       unsigned int queue,
172 			       unsigned char port, unsigned char mask);
173 int cxgb4_remove_server_filter(const struct net_device *dev, unsigned int stid,
174 			       unsigned int queue, bool ipv6);
175 int cxgb4_clip_get(const struct net_device *dev, const struct in6_addr *lip);
176 int cxgb4_clip_release(const struct net_device *dev,
177 		       const struct in6_addr *lip);
178 
179 static inline void set_wr_txq(struct sk_buff *skb, int prio, int queue)
180 {
181 	skb_set_queue_mapping(skb, (queue << 1) | prio);
182 }
183 
184 enum cxgb4_uld {
185 	CXGB4_ULD_RDMA,
186 	CXGB4_ULD_ISCSI,
187 	CXGB4_ULD_MAX
188 };
189 
190 enum cxgb4_state {
191 	CXGB4_STATE_UP,
192 	CXGB4_STATE_START_RECOVERY,
193 	CXGB4_STATE_DOWN,
194 	CXGB4_STATE_DETACH
195 };
196 
197 enum cxgb4_control {
198 	CXGB4_CONTROL_DB_FULL,
199 	CXGB4_CONTROL_DB_EMPTY,
200 	CXGB4_CONTROL_DB_DROP,
201 };
202 
203 struct pci_dev;
204 struct l2t_data;
205 struct net_device;
206 struct pkt_gl;
207 struct tp_tcp_stats;
208 
209 struct cxgb4_range {
210 	unsigned int start;
211 	unsigned int size;
212 };
213 
214 struct cxgb4_virt_res {                      /* virtualized HW resources */
215 	struct cxgb4_range ddp;
216 	struct cxgb4_range iscsi;
217 	struct cxgb4_range stag;
218 	struct cxgb4_range rq;
219 	struct cxgb4_range pbl;
220 	struct cxgb4_range qp;
221 	struct cxgb4_range cq;
222 	struct cxgb4_range ocq;
223 };
224 
225 #define OCQ_WIN_OFFSET(pdev, vres) \
226 	(pci_resource_len((pdev), 2) - roundup_pow_of_two((vres)->ocq.size))
227 
228 /*
229  * Block of information the LLD provides to ULDs attaching to a device.
230  */
231 struct cxgb4_lld_info {
232 	struct pci_dev *pdev;                /* associated PCI device */
233 	struct l2t_data *l2t;                /* L2 table */
234 	struct tid_info *tids;               /* TID table */
235 	struct net_device **ports;           /* device ports */
236 	const struct cxgb4_virt_res *vr;     /* assorted HW resources */
237 	const unsigned short *mtus;          /* MTU table */
238 	const unsigned short *rxq_ids;       /* the ULD's Rx queue ids */
239 	const unsigned short *ciq_ids;       /* the ULD's concentrator IQ ids */
240 	unsigned short nrxq;                 /* # of Rx queues */
241 	unsigned short ntxq;                 /* # of Tx queues */
242 	unsigned short nciq;		     /* # of concentrator IQ */
243 	unsigned char nchan:4;               /* # of channels */
244 	unsigned char nports:4;              /* # of ports */
245 	unsigned char wr_cred;               /* WR 16-byte credits */
246 	unsigned char adapter_type;          /* type of adapter */
247 	unsigned char fw_api_ver;            /* FW API version */
248 	unsigned int fw_vers;                /* FW version */
249 	unsigned int iscsi_iolen;            /* iSCSI max I/O length */
250 	unsigned int cclk_ps;                /* Core clock period in psec */
251 	unsigned short udb_density;          /* # of user DB/page */
252 	unsigned short ucq_density;          /* # of user CQs/page */
253 	unsigned short filt_mode;            /* filter optional components */
254 	unsigned short tx_modq[NCHAN];       /* maps each tx channel to a */
255 					     /* scheduler queue */
256 	void __iomem *gts_reg;               /* address of GTS register */
257 	void __iomem *db_reg;                /* address of kernel doorbell */
258 	int dbfifo_int_thresh;		     /* doorbell fifo int threshold */
259 	unsigned int sge_ingpadboundary;     /* SGE ingress padding boundary */
260 	unsigned int sge_egrstatuspagesize;  /* SGE egress status page size */
261 	unsigned int sge_pktshift;           /* Padding between CPL and */
262 					     /*	packet data */
263 	unsigned int pf;		     /* Physical Function we're using */
264 	bool enable_fw_ofld_conn;            /* Enable connection through fw */
265 					     /* WR */
266 	unsigned int max_ordird_qp;          /* Max ORD/IRD depth per RDMA QP */
267 	unsigned int max_ird_adapter;        /* Max IRD memory per adapter */
268 	bool ulptx_memwrite_dsgl;            /* use of T5 DSGL allowed */
269 };
270 
271 struct cxgb4_uld_info {
272 	const char *name;
273 	void *(*add)(const struct cxgb4_lld_info *p);
274 	int (*rx_handler)(void *handle, const __be64 *rsp,
275 			  const struct pkt_gl *gl);
276 	int (*state_change)(void *handle, enum cxgb4_state new_state);
277 	int (*control)(void *handle, enum cxgb4_control control, ...);
278 };
279 
280 int cxgb4_register_uld(enum cxgb4_uld type, const struct cxgb4_uld_info *p);
281 int cxgb4_unregister_uld(enum cxgb4_uld type);
282 int cxgb4_ofld_send(struct net_device *dev, struct sk_buff *skb);
283 unsigned int cxgb4_dbfifo_count(const struct net_device *dev, int lpfifo);
284 unsigned int cxgb4_port_chan(const struct net_device *dev);
285 unsigned int cxgb4_port_viid(const struct net_device *dev);
286 unsigned int cxgb4_port_idx(const struct net_device *dev);
287 unsigned int cxgb4_best_mtu(const unsigned short *mtus, unsigned short mtu,
288 			    unsigned int *idx);
289 unsigned int cxgb4_best_aligned_mtu(const unsigned short *mtus,
290 				    unsigned short header_size,
291 				    unsigned short data_size_max,
292 				    unsigned short data_size_align,
293 				    unsigned int *mtu_idxp);
294 void cxgb4_get_tcp_stats(struct pci_dev *pdev, struct tp_tcp_stats *v4,
295 			 struct tp_tcp_stats *v6);
296 void cxgb4_iscsi_init(struct net_device *dev, unsigned int tag_mask,
297 		      const unsigned int *pgsz_order);
298 struct sk_buff *cxgb4_pktgl_to_skb(const struct pkt_gl *gl,
299 				   unsigned int skb_len, unsigned int pull_len);
300 int cxgb4_sync_txq_pidx(struct net_device *dev, u16 qid, u16 pidx, u16 size);
301 int cxgb4_flush_eq_cache(struct net_device *dev);
302 void cxgb4_disable_db_coalescing(struct net_device *dev);
303 void cxgb4_enable_db_coalescing(struct net_device *dev);
304 int cxgb4_read_tpte(struct net_device *dev, u32 stag, __be32 *tpte);
305 u64 cxgb4_read_sge_timestamp(struct net_device *dev);
306 
307 #endif  /* !__CXGB4_OFLD_H */
308