xref: /openbmc/linux/drivers/scsi/cxgbi/libcxgbi.h (revision df2634f43f5106947f3735a0b61a6527a4b278cd)
1 /*
2  * libcxgbi.h: Chelsio common library for T3/T4 iSCSI driver.
3  *
4  * Copyright (c) 2010 Chelsio Communications, Inc.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation.
9  *
10  * Written by: Karen Xie (kxie@chelsio.com)
11  * Written by: Rakesh Ranjan (rranjan@chelsio.com)
12  */
13 
14 #ifndef	__LIBCXGBI_H__
15 #define	__LIBCXGBI_H__
16 
17 #include <linux/kernel.h>
18 #include <linux/errno.h>
19 #include <linux/types.h>
20 #include <linux/debugfs.h>
21 #include <linux/list.h>
22 #include <linux/netdevice.h>
23 #include <linux/if_vlan.h>
24 #include <linux/scatterlist.h>
25 #include <linux/skbuff.h>
26 #include <linux/vmalloc.h>
27 #include <scsi/scsi_device.h>
28 #include <scsi/libiscsi_tcp.h>
29 
30 enum cxgbi_dbg_flag {
31 	CXGBI_DBG_ISCSI,
32 	CXGBI_DBG_DDP,
33 	CXGBI_DBG_TOE,
34 	CXGBI_DBG_SOCK,
35 
36 	CXGBI_DBG_PDU_TX,
37 	CXGBI_DBG_PDU_RX,
38 	CXGBI_DBG_DEV,
39 };
40 
41 #define log_debug(level, fmt, ...)	\
42 	do {	\
43 		if (dbg_level & (level)) \
44 			pr_info(fmt, ##__VA_ARGS__); \
45 	} while (0)
46 
47 /* max. connections per adapter */
48 #define CXGBI_MAX_CONN		16384
49 
50 /* always allocate rooms for AHS */
51 #define SKB_TX_ISCSI_PDU_HEADER_MAX	\
52 	(sizeof(struct iscsi_hdr) + ISCSI_MAX_AHS_SIZE)
53 
54 #define	ISCSI_PDU_NONPAYLOAD_LEN	312 /* bhs(48) + ahs(256) + digest(8)*/
55 
56 /*
57  * align pdu size to multiple of 512 for better performance
58  */
59 #define cxgbi_align_pdu_size(n) do { n = (n) & (~511); } while (0)
60 
61 #define ULP2_MODE_ISCSI		2
62 
63 #define ULP2_MAX_PKT_SIZE	16224
64 #define ULP2_MAX_PDU_PAYLOAD	\
65 	(ULP2_MAX_PKT_SIZE - ISCSI_PDU_NONPAYLOAD_LEN)
66 
67 /*
68  * For iscsi connections HW may inserts digest bytes into the pdu. Those digest
69  * bytes are not sent by the host but are part of the TCP payload and therefore
70  * consume TCP sequence space.
71  */
72 static const unsigned int ulp2_extra_len[] = { 0, 4, 4, 8 };
73 static inline unsigned int cxgbi_ulp_extra_len(int submode)
74 {
75 	return ulp2_extra_len[submode & 3];
76 }
77 
78 /*
79  * struct pagepod_hdr, pagepod - pagepod format
80  */
81 
82 #define CPL_RX_DDP_STATUS_DDP_SHIFT	16 /* ddp'able */
83 #define CPL_RX_DDP_STATUS_PAD_SHIFT	19 /* pad error */
84 #define CPL_RX_DDP_STATUS_HCRC_SHIFT	20 /* hcrc error */
85 #define CPL_RX_DDP_STATUS_DCRC_SHIFT	21 /* dcrc error */
86 
87 struct cxgbi_pagepod_hdr {
88 	u32 vld_tid;
89 	u32 pgsz_tag_clr;
90 	u32 max_offset;
91 	u32 page_offset;
92 	u64 rsvd;
93 };
94 
95 #define PPOD_PAGES_MAX			4
96 struct cxgbi_pagepod {
97 	struct cxgbi_pagepod_hdr hdr;
98 	u64 addr[PPOD_PAGES_MAX + 1];
99 };
100 
101 struct cxgbi_tag_format {
102 	unsigned char sw_bits;
103 	unsigned char rsvd_bits;
104 	unsigned char rsvd_shift;
105 	unsigned char filler[1];
106 	u32 rsvd_mask;
107 };
108 
109 struct cxgbi_gather_list {
110 	unsigned int tag;
111 	unsigned int length;
112 	unsigned int offset;
113 	unsigned int nelem;
114 	struct page **pages;
115 	dma_addr_t phys_addr[0];
116 };
117 
118 struct cxgbi_ddp_info {
119 	struct kref refcnt;
120 	struct cxgbi_device *cdev;
121 	struct pci_dev *pdev;
122 	unsigned int max_txsz;
123 	unsigned int max_rxsz;
124 	unsigned int llimit;
125 	unsigned int ulimit;
126 	unsigned int nppods;
127 	unsigned int idx_last;
128 	unsigned char idx_bits;
129 	unsigned char filler[3];
130 	unsigned int idx_mask;
131 	unsigned int rsvd_tag_mask;
132 	spinlock_t map_lock;
133 	struct cxgbi_gather_list **gl_map;
134 	struct sk_buff **gl_skb;
135 };
136 
137 #define DDP_PGIDX_MAX		4
138 #define DDP_THRESHOLD		2048
139 
140 #define PPOD_PAGES_SHIFT	2       /*  4 pages per pod */
141 
142 #define PPOD_SIZE               sizeof(struct cxgbi_pagepod)  /*  64 */
143 #define PPOD_SIZE_SHIFT         6
144 
145 #define ULPMEM_DSGL_MAX_NPPODS	16	/*  1024/PPOD_SIZE */
146 #define ULPMEM_IDATA_MAX_NPPODS	4	/*  256/PPOD_SIZE */
147 #define PCIE_MEMWIN_MAX_NPPODS	16	/*  1024/PPOD_SIZE */
148 
149 #define PPOD_COLOR_SHIFT	0
150 #define PPOD_COLOR(x)		((x) << PPOD_COLOR_SHIFT)
151 
152 #define PPOD_IDX_SHIFT          6
153 #define PPOD_IDX_MAX_SIZE       24
154 
155 #define PPOD_TID_SHIFT		0
156 #define PPOD_TID(x)		((x) << PPOD_TID_SHIFT)
157 
158 #define PPOD_TAG_SHIFT		6
159 #define PPOD_TAG(x)		((x) << PPOD_TAG_SHIFT)
160 
161 #define PPOD_VALID_SHIFT	24
162 #define PPOD_VALID(x)		((x) << PPOD_VALID_SHIFT)
163 #define PPOD_VALID_FLAG		PPOD_VALID(1U)
164 
165 /*
166  * sge_opaque_hdr -
167  * Opaque version of structure the SGE stores at skb->head of TX_DATA packets
168  * and for which we must reserve space.
169  */
170 struct sge_opaque_hdr {
171 	void *dev;
172 	dma_addr_t addr[MAX_SKB_FRAGS + 1];
173 };
174 
175 struct cxgbi_sock {
176 	struct cxgbi_device *cdev;
177 
178 	int tid;
179 	int atid;
180 	unsigned long flags;
181 	unsigned int mtu;
182 	unsigned short rss_qid;
183 	unsigned short txq_idx;
184 	unsigned short advmss;
185 	unsigned int tx_chan;
186 	unsigned int rx_chan;
187 	unsigned int mss_idx;
188 	unsigned int smac_idx;
189 	unsigned char port_id;
190 	int wr_max_cred;
191 	int wr_cred;
192 	int wr_una_cred;
193 	unsigned char hcrc_len;
194 	unsigned char dcrc_len;
195 
196 	void *l2t;
197 	struct sk_buff *wr_pending_head;
198 	struct sk_buff *wr_pending_tail;
199 	struct sk_buff *cpl_close;
200 	struct sk_buff *cpl_abort_req;
201 	struct sk_buff *cpl_abort_rpl;
202 	struct sk_buff *skb_ulp_lhdr;
203 	spinlock_t lock;
204 	struct kref refcnt;
205 	unsigned int state;
206 	struct sockaddr_in saddr;
207 	struct sockaddr_in daddr;
208 	struct dst_entry *dst;
209 	struct sk_buff_head receive_queue;
210 	struct sk_buff_head write_queue;
211 	struct timer_list retry_timer;
212 	int err;
213 	rwlock_t callback_lock;
214 	void *user_data;
215 
216 	u32 rcv_nxt;
217 	u32 copied_seq;
218 	u32 rcv_wup;
219 	u32 snd_nxt;
220 	u32 snd_una;
221 	u32 write_seq;
222 };
223 
224 /*
225  * connection states
226  */
227 enum cxgbi_sock_states{
228 	CTP_CLOSED,
229 	CTP_CONNECTING,
230 	CTP_ACTIVE_OPEN,
231 	CTP_ESTABLISHED,
232 	CTP_ACTIVE_CLOSE,
233 	CTP_PASSIVE_CLOSE,
234 	CTP_CLOSE_WAIT_1,
235 	CTP_CLOSE_WAIT_2,
236 	CTP_ABORTING,
237 };
238 
239 /*
240  * Connection flags -- many to track some close related events.
241  */
242 enum cxgbi_sock_flags {
243 	CTPF_ABORT_RPL_RCVD,	/*received one ABORT_RPL_RSS message */
244 	CTPF_ABORT_REQ_RCVD,	/*received one ABORT_REQ_RSS message */
245 	CTPF_ABORT_RPL_PENDING,	/* expecting an abort reply */
246 	CTPF_TX_DATA_SENT,	/* already sent a TX_DATA WR */
247 	CTPF_ACTIVE_CLOSE_NEEDED,/* need to be closed */
248 	CTPF_HAS_ATID,		/* reserved atid */
249 	CTPF_HAS_TID,		/* reserved hw tid */
250 	CTPF_OFFLOAD_DOWN,	/* offload function off */
251 };
252 
253 struct cxgbi_skb_rx_cb {
254 	__u32 ddigest;
255 	__u32 pdulen;
256 };
257 
258 struct cxgbi_skb_tx_cb {
259 	void *l2t;
260 	struct sk_buff *wr_next;
261 };
262 
263 enum cxgbi_skcb_flags {
264 	SKCBF_TX_NEED_HDR,	/* packet needs a header */
265 	SKCBF_RX_COALESCED,	/* received whole pdu */
266 	SKCBF_RX_HDR,		/* recieved pdu header */
267 	SKCBF_RX_DATA,		/* recieved pdu payload */
268 	SKCBF_RX_STATUS,	/* recieved ddp status */
269 	SKCBF_RX_DATA_DDPD,	/* pdu payload ddp'd */
270 	SKCBF_RX_HCRC_ERR,	/* header digest error */
271 	SKCBF_RX_DCRC_ERR,	/* data digest error */
272 	SKCBF_RX_PAD_ERR,	/* padding byte error */
273 };
274 
275 struct cxgbi_skb_cb {
276 	unsigned char ulp_mode;
277 	unsigned long flags;
278 	unsigned int seq;
279 	union {
280 		struct cxgbi_skb_rx_cb rx;
281 		struct cxgbi_skb_tx_cb tx;
282 	};
283 };
284 
285 #define CXGBI_SKB_CB(skb)	((struct cxgbi_skb_cb *)&((skb)->cb[0]))
286 #define cxgbi_skcb_flags(skb)		(CXGBI_SKB_CB(skb)->flags)
287 #define cxgbi_skcb_ulp_mode(skb)	(CXGBI_SKB_CB(skb)->ulp_mode)
288 #define cxgbi_skcb_tcp_seq(skb)		(CXGBI_SKB_CB(skb)->seq)
289 #define cxgbi_skcb_rx_ddigest(skb)	(CXGBI_SKB_CB(skb)->rx.ddigest)
290 #define cxgbi_skcb_rx_pdulen(skb)	(CXGBI_SKB_CB(skb)->rx.pdulen)
291 #define cxgbi_skcb_tx_wr_next(skb)	(CXGBI_SKB_CB(skb)->tx.wr_next)
292 
293 static inline void cxgbi_skcb_set_flag(struct sk_buff *skb,
294 					enum cxgbi_skcb_flags flag)
295 {
296 	__set_bit(flag, &(cxgbi_skcb_flags(skb)));
297 }
298 
299 static inline void cxgbi_skcb_clear_flag(struct sk_buff *skb,
300 					enum cxgbi_skcb_flags flag)
301 {
302 	__clear_bit(flag, &(cxgbi_skcb_flags(skb)));
303 }
304 
305 static inline int cxgbi_skcb_test_flag(struct sk_buff *skb,
306 					enum cxgbi_skcb_flags flag)
307 {
308 	return test_bit(flag, &(cxgbi_skcb_flags(skb)));
309 }
310 
311 static inline void cxgbi_sock_set_flag(struct cxgbi_sock *csk,
312 					enum cxgbi_sock_flags flag)
313 {
314 	__set_bit(flag, &csk->flags);
315 	log_debug(1 << CXGBI_DBG_SOCK,
316 		"csk 0x%p,%u,0x%lx, bit %d.\n",
317 		csk, csk->state, csk->flags, flag);
318 }
319 
320 static inline void cxgbi_sock_clear_flag(struct cxgbi_sock *csk,
321 					enum cxgbi_sock_flags flag)
322 {
323 	__clear_bit(flag, &csk->flags);
324 	log_debug(1 << CXGBI_DBG_SOCK,
325 		"csk 0x%p,%u,0x%lx, bit %d.\n",
326 		csk, csk->state, csk->flags, flag);
327 }
328 
329 static inline int cxgbi_sock_flag(struct cxgbi_sock *csk,
330 				enum cxgbi_sock_flags flag)
331 {
332 	if (csk == NULL)
333 		return 0;
334 	return test_bit(flag, &csk->flags);
335 }
336 
337 static inline void cxgbi_sock_set_state(struct cxgbi_sock *csk, int state)
338 {
339 	log_debug(1 << CXGBI_DBG_SOCK,
340 		"csk 0x%p,%u,0x%lx, state -> %u.\n",
341 		csk, csk->state, csk->flags, state);
342 	csk->state = state;
343 }
344 
345 static inline void cxgbi_sock_free(struct kref *kref)
346 {
347 	struct cxgbi_sock *csk = container_of(kref,
348 						struct cxgbi_sock,
349 						refcnt);
350 	if (csk) {
351 		log_debug(1 << CXGBI_DBG_SOCK,
352 			"free csk 0x%p, state %u, flags 0x%lx\n",
353 			csk, csk->state, csk->flags);
354 		kfree(csk);
355 	}
356 }
357 
358 static inline void __cxgbi_sock_put(const char *fn, struct cxgbi_sock *csk)
359 {
360 	log_debug(1 << CXGBI_DBG_SOCK,
361 		"%s, put csk 0x%p, ref %u-1.\n",
362 		fn, csk, atomic_read(&csk->refcnt.refcount));
363 	kref_put(&csk->refcnt, cxgbi_sock_free);
364 }
365 #define cxgbi_sock_put(csk)	__cxgbi_sock_put(__func__, csk)
366 
367 static inline void __cxgbi_sock_get(const char *fn, struct cxgbi_sock *csk)
368 {
369 	log_debug(1 << CXGBI_DBG_SOCK,
370 		"%s, get csk 0x%p, ref %u+1.\n",
371 		fn, csk, atomic_read(&csk->refcnt.refcount));
372 	kref_get(&csk->refcnt);
373 }
374 #define cxgbi_sock_get(csk)	__cxgbi_sock_get(__func__, csk)
375 
376 static inline int cxgbi_sock_is_closing(struct cxgbi_sock *csk)
377 {
378 	return csk->state >= CTP_ACTIVE_CLOSE;
379 }
380 
381 static inline int cxgbi_sock_is_established(struct cxgbi_sock *csk)
382 {
383 	return csk->state == CTP_ESTABLISHED;
384 }
385 
386 static inline void cxgbi_sock_purge_write_queue(struct cxgbi_sock *csk)
387 {
388 	struct sk_buff *skb;
389 
390 	while ((skb = __skb_dequeue(&csk->write_queue)))
391 		__kfree_skb(skb);
392 }
393 
394 static inline unsigned int cxgbi_sock_compute_wscale(unsigned int win)
395 {
396 	unsigned int wscale = 0;
397 
398 	while (wscale < 14 && (65535 << wscale) < win)
399 		wscale++;
400 	return wscale;
401 }
402 
403 static inline struct sk_buff *alloc_wr(int wrlen, int dlen, gfp_t gfp)
404 {
405 	struct sk_buff *skb = alloc_skb(wrlen + dlen, gfp);
406 
407 	if (skb) {
408 		__skb_put(skb, wrlen);
409 		memset(skb->head, 0, wrlen + dlen);
410 	} else
411 		pr_info("alloc cpl wr skb %u+%u, OOM.\n", wrlen, dlen);
412 	return skb;
413 }
414 
415 
416 /*
417  * The number of WRs needed for an skb depends on the number of fragments
418  * in the skb and whether it has any payload in its main body.  This maps the
419  * length of the gather list represented by an skb into the # of necessary WRs.
420  * The extra two fragments are for iscsi bhs and payload padding.
421  */
422 #define SKB_WR_LIST_SIZE	 (MAX_SKB_FRAGS + 2)
423 
424 static inline void cxgbi_sock_reset_wr_list(struct cxgbi_sock *csk)
425 {
426 	csk->wr_pending_head = csk->wr_pending_tail = NULL;
427 }
428 
429 static inline void cxgbi_sock_enqueue_wr(struct cxgbi_sock *csk,
430 					  struct sk_buff *skb)
431 {
432 	cxgbi_skcb_tx_wr_next(skb) = NULL;
433 	/*
434 	 * We want to take an extra reference since both us and the driver
435 	 * need to free the packet before it's really freed. We know there's
436 	 * just one user currently so we use atomic_set rather than skb_get
437 	 * to avoid the atomic op.
438 	 */
439 	atomic_set(&skb->users, 2);
440 
441 	if (!csk->wr_pending_head)
442 		csk->wr_pending_head = skb;
443 	else
444 		cxgbi_skcb_tx_wr_next(csk->wr_pending_tail) = skb;
445 	csk->wr_pending_tail = skb;
446 }
447 
448 static inline int cxgbi_sock_count_pending_wrs(const struct cxgbi_sock *csk)
449 {
450 	int n = 0;
451 	const struct sk_buff *skb = csk->wr_pending_head;
452 
453 	while (skb) {
454 		n += skb->csum;
455 		skb = cxgbi_skcb_tx_wr_next(skb);
456 	}
457 	return n;
458 }
459 
460 static inline struct sk_buff *cxgbi_sock_peek_wr(const struct cxgbi_sock *csk)
461 {
462 	return csk->wr_pending_head;
463 }
464 
465 static inline struct sk_buff *cxgbi_sock_dequeue_wr(struct cxgbi_sock *csk)
466 {
467 	struct sk_buff *skb = csk->wr_pending_head;
468 
469 	if (likely(skb)) {
470 		csk->wr_pending_head = cxgbi_skcb_tx_wr_next(skb);
471 		cxgbi_skcb_tx_wr_next(skb) = NULL;
472 	}
473 	return skb;
474 }
475 
476 void cxgbi_sock_check_wr_invariants(const struct cxgbi_sock *);
477 void cxgbi_sock_purge_wr_queue(struct cxgbi_sock *);
478 void cxgbi_sock_skb_entail(struct cxgbi_sock *, struct sk_buff *);
479 void cxgbi_sock_fail_act_open(struct cxgbi_sock *, int);
480 void cxgbi_sock_act_open_req_arp_failure(void *, struct sk_buff *);
481 void cxgbi_sock_closed(struct cxgbi_sock *);
482 void cxgbi_sock_established(struct cxgbi_sock *, unsigned int, unsigned int);
483 void cxgbi_sock_rcv_abort_rpl(struct cxgbi_sock *);
484 void cxgbi_sock_rcv_peer_close(struct cxgbi_sock *);
485 void cxgbi_sock_rcv_close_conn_rpl(struct cxgbi_sock *, u32);
486 void cxgbi_sock_rcv_wr_ack(struct cxgbi_sock *, unsigned int, unsigned int,
487 				int);
488 unsigned int cxgbi_sock_select_mss(struct cxgbi_sock *, unsigned int);
489 void cxgbi_sock_free_cpl_skbs(struct cxgbi_sock *);
490 
491 struct cxgbi_hba {
492 	struct net_device *ndev;
493 	struct net_device *vdev;	/* vlan dev */
494 	struct Scsi_Host *shost;
495 	struct cxgbi_device *cdev;
496 	__be32 ipv4addr;
497 	unsigned char port_id;
498 };
499 
500 struct cxgbi_ports_map {
501 	unsigned int max_connect;
502 	unsigned int used;
503 	unsigned short sport_base;
504 	spinlock_t lock;
505 	unsigned int next;
506 	struct cxgbi_sock **port_csk;
507 };
508 
509 #define CXGBI_FLAG_DEV_T3		0x1
510 #define CXGBI_FLAG_DEV_T4		0x2
511 #define CXGBI_FLAG_ADAPTER_RESET	0x4
512 #define CXGBI_FLAG_IPV4_SET		0x10
513 struct cxgbi_device {
514 	struct list_head list_head;
515 	unsigned int flags;
516 	struct net_device **ports;
517 	void *lldev;
518 	struct cxgbi_hba **hbas;
519 	const unsigned short *mtus;
520 	unsigned char nmtus;
521 	unsigned char nports;
522 	struct pci_dev *pdev;
523 	struct dentry *debugfs_root;
524 	struct iscsi_transport *itp;
525 
526 	unsigned int pfvf;
527 	unsigned int snd_win;
528 	unsigned int rcv_win;
529 	unsigned int rx_credit_thres;
530 	unsigned int skb_tx_rsvd;
531 	unsigned int skb_rx_extra;	/* for msg coalesced mode */
532 	unsigned int tx_max_size;
533 	unsigned int rx_max_size;
534 	struct cxgbi_ports_map pmap;
535 	struct cxgbi_tag_format tag_format;
536 	struct cxgbi_ddp_info *ddp;
537 
538 	void (*dev_ddp_cleanup)(struct cxgbi_device *);
539 	void (*csk_ddp_free_gl_skb)(struct cxgbi_ddp_info *, int, int);
540 	int (*csk_ddp_alloc_gl_skb)(struct cxgbi_ddp_info *, int, int, gfp_t);
541 	int (*csk_ddp_set)(struct cxgbi_sock *, struct cxgbi_pagepod_hdr *,
542 				unsigned int, unsigned int,
543 				struct cxgbi_gather_list *);
544 	void (*csk_ddp_clear)(struct cxgbi_hba *,
545 				unsigned int, unsigned int, unsigned int);
546 	int (*csk_ddp_setup_digest)(struct cxgbi_sock *,
547 				unsigned int, int, int, int);
548 	int (*csk_ddp_setup_pgidx)(struct cxgbi_sock *,
549 				unsigned int, int, bool);
550 
551 	void (*csk_release_offload_resources)(struct cxgbi_sock *);
552 	int (*csk_rx_pdu_ready)(struct cxgbi_sock *, struct sk_buff *);
553 	u32 (*csk_send_rx_credits)(struct cxgbi_sock *, u32);
554 	int (*csk_push_tx_frames)(struct cxgbi_sock *, int);
555 	void (*csk_send_abort_req)(struct cxgbi_sock *);
556 	void (*csk_send_close_req)(struct cxgbi_sock *);
557 	int (*csk_alloc_cpls)(struct cxgbi_sock *);
558 	int (*csk_init_act_open)(struct cxgbi_sock *);
559 
560 	void *dd_data;
561 };
562 #define cxgbi_cdev_priv(cdev)	((cdev)->dd_data)
563 
564 struct cxgbi_conn {
565 	struct cxgbi_endpoint *cep;
566 	struct iscsi_conn *iconn;
567 	struct cxgbi_hba *chba;
568 	u32 task_idx_bits;
569 };
570 
571 struct cxgbi_endpoint {
572 	struct cxgbi_conn *cconn;
573 	struct cxgbi_hba *chba;
574 	struct cxgbi_sock *csk;
575 };
576 
577 #define MAX_PDU_FRAGS	((ULP2_MAX_PDU_PAYLOAD + 512 - 1) / 512)
578 struct cxgbi_task_data {
579 	unsigned short nr_frags;
580 	skb_frag_t frags[MAX_PDU_FRAGS];
581 	struct sk_buff *skb;
582 	unsigned int offset;
583 	unsigned int count;
584 	unsigned int sgoffset;
585 };
586 #define iscsi_task_cxgbi_data(task) \
587 	((task)->dd_data + sizeof(struct iscsi_tcp_task))
588 
589 static inline int cxgbi_is_ddp_tag(struct cxgbi_tag_format *tformat, u32 tag)
590 {
591 	return !(tag & (1 << (tformat->rsvd_bits + tformat->rsvd_shift - 1)));
592 }
593 
594 static inline int cxgbi_sw_tag_usable(struct cxgbi_tag_format *tformat,
595 					u32 sw_tag)
596 {
597 	sw_tag >>= (32 - tformat->rsvd_bits);
598 	return !sw_tag;
599 }
600 
601 static inline u32 cxgbi_set_non_ddp_tag(struct cxgbi_tag_format *tformat,
602 					u32 sw_tag)
603 {
604 	unsigned char shift = tformat->rsvd_bits + tformat->rsvd_shift - 1;
605 	u32 mask = (1 << shift) - 1;
606 
607 	if (sw_tag && (sw_tag & ~mask)) {
608 		u32 v1 = sw_tag & ((1 << shift) - 1);
609 		u32 v2 = (sw_tag >> (shift - 1)) << shift;
610 
611 		return v2 | v1 | 1 << shift;
612 	}
613 
614 	return sw_tag | 1 << shift;
615 }
616 
617 static inline u32 cxgbi_ddp_tag_base(struct cxgbi_tag_format *tformat,
618 					u32 sw_tag)
619 {
620 	u32 mask = (1 << tformat->rsvd_shift) - 1;
621 
622 	if (sw_tag && (sw_tag & ~mask)) {
623 		u32 v1 = sw_tag & mask;
624 		u32 v2 = sw_tag >> tformat->rsvd_shift;
625 
626 		v2 <<= tformat->rsvd_bits + tformat->rsvd_shift;
627 
628 		return v2 | v1;
629 	}
630 
631 	return sw_tag;
632 }
633 
634 static inline u32 cxgbi_tag_rsvd_bits(struct cxgbi_tag_format *tformat,
635 					u32 tag)
636 {
637 	if (cxgbi_is_ddp_tag(tformat, tag))
638 		return (tag >> tformat->rsvd_shift) & tformat->rsvd_mask;
639 
640 	return 0;
641 }
642 
643 static inline u32 cxgbi_tag_nonrsvd_bits(struct cxgbi_tag_format *tformat,
644 					u32 tag)
645 {
646 	unsigned char shift = tformat->rsvd_bits + tformat->rsvd_shift - 1;
647 	u32 v1, v2;
648 
649 	if (cxgbi_is_ddp_tag(tformat, tag)) {
650 		v1 = tag & ((1 << tformat->rsvd_shift) - 1);
651 		v2 = (tag >> (shift + 1)) << tformat->rsvd_shift;
652 	} else {
653 		u32 mask = (1 << shift) - 1;
654 		tag &= ~(1 << shift);
655 		v1 = tag & mask;
656 		v2 = (tag >> 1) & ~mask;
657 	}
658 	return v1 | v2;
659 }
660 
661 static inline void *cxgbi_alloc_big_mem(unsigned int size,
662 					gfp_t gfp)
663 {
664 	void *p = kmalloc(size, gfp);
665 	if (!p)
666 		p = vmalloc(size);
667 	if (p)
668 		memset(p, 0, size);
669 	return p;
670 }
671 
672 static inline void cxgbi_free_big_mem(void *addr)
673 {
674 	if (is_vmalloc_addr(addr))
675 		vfree(addr);
676 	else
677 		kfree(addr);
678 }
679 
680 static inline void cxgbi_set_iscsi_ipv4(struct cxgbi_hba *chba, __be32 ipaddr)
681 {
682 	if (chba->cdev->flags & CXGBI_FLAG_IPV4_SET)
683 		chba->ipv4addr = ipaddr;
684 	else
685 		pr_info("set iscsi ipv4 NOT supported, using %s ipv4.\n",
686 			chba->ndev->name);
687 }
688 
689 static inline __be32 cxgbi_get_iscsi_ipv4(struct cxgbi_hba *chba)
690 {
691 	return chba->ipv4addr;
692 }
693 
694 struct cxgbi_device *cxgbi_device_register(unsigned int, unsigned int);
695 void cxgbi_device_unregister(struct cxgbi_device *);
696 void cxgbi_device_unregister_all(unsigned int flag);
697 struct cxgbi_device *cxgbi_device_find_by_lldev(void *);
698 int cxgbi_hbas_add(struct cxgbi_device *, unsigned int, unsigned int,
699 			struct scsi_host_template *,
700 			struct scsi_transport_template *);
701 void cxgbi_hbas_remove(struct cxgbi_device *);
702 
703 int cxgbi_device_portmap_create(struct cxgbi_device *cdev, unsigned int base,
704 			unsigned int max_conn);
705 void cxgbi_device_portmap_cleanup(struct cxgbi_device *cdev);
706 
707 void cxgbi_conn_tx_open(struct cxgbi_sock *);
708 void cxgbi_conn_pdu_ready(struct cxgbi_sock *);
709 int cxgbi_conn_alloc_pdu(struct iscsi_task *, u8);
710 int cxgbi_conn_init_pdu(struct iscsi_task *, unsigned int , unsigned int);
711 int cxgbi_conn_xmit_pdu(struct iscsi_task *);
712 
713 void cxgbi_cleanup_task(struct iscsi_task *task);
714 
715 void cxgbi_get_conn_stats(struct iscsi_cls_conn *, struct iscsi_stats *);
716 int cxgbi_set_conn_param(struct iscsi_cls_conn *,
717 			enum iscsi_param, char *, int);
718 int cxgbi_get_conn_param(struct iscsi_cls_conn *, enum iscsi_param, char *);
719 struct iscsi_cls_conn *cxgbi_create_conn(struct iscsi_cls_session *, u32);
720 int cxgbi_bind_conn(struct iscsi_cls_session *,
721 			struct iscsi_cls_conn *, u64, int);
722 void cxgbi_destroy_session(struct iscsi_cls_session *);
723 struct iscsi_cls_session *cxgbi_create_session(struct iscsi_endpoint *,
724 			u16, u16, u32);
725 int cxgbi_set_host_param(struct Scsi_Host *,
726 			enum iscsi_host_param, char *, int);
727 int cxgbi_get_host_param(struct Scsi_Host *, enum iscsi_host_param, char *);
728 struct iscsi_endpoint *cxgbi_ep_connect(struct Scsi_Host *,
729 			struct sockaddr *, int);
730 int cxgbi_ep_poll(struct iscsi_endpoint *, int);
731 void cxgbi_ep_disconnect(struct iscsi_endpoint *);
732 
733 int cxgbi_iscsi_init(struct iscsi_transport *,
734 			struct scsi_transport_template **);
735 void cxgbi_iscsi_cleanup(struct iscsi_transport *,
736 			struct scsi_transport_template **);
737 void cxgbi_parse_pdu_itt(struct iscsi_conn *, itt_t, int *, int *);
738 int cxgbi_ddp_init(struct cxgbi_device *, unsigned int, unsigned int,
739 			unsigned int, unsigned int);
740 int cxgbi_ddp_cleanup(struct cxgbi_device *);
741 void cxgbi_ddp_page_size_factor(int *);
742 void cxgbi_ddp_ppod_clear(struct cxgbi_pagepod *);
743 void cxgbi_ddp_ppod_set(struct cxgbi_pagepod *, struct cxgbi_pagepod_hdr *,
744 			struct cxgbi_gather_list *, unsigned int);
745 #endif	/*__LIBCXGBI_H__*/
746