2 * libcxgbi.h: Chelsio common library for T3/T4 iSCSI driver.
4 * Copyright (c) 2010-2015 Chelsio Communications, Inc.
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.
10 * Written by: Karen Xie (kxie@chelsio.com)
11 * Written by: Rakesh Ranjan (rranjan@chelsio.com)
14 #ifndef __LIBCXGBI_H__
15 #define __LIBCXGBI_H__
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 <linux/version.h>
28 #include <scsi/scsi_device.h>
29 #include <scsi/libiscsi_tcp.h>
31 #include <libcxgb_ppm.h>
44 #define log_debug(level, fmt, ...) \
46 if (dbg_level & (level)) \
47 pr_info(fmt, ##__VA_ARGS__); \
50 #define pr_info_ipaddr(fmt_trail, \
51 addr1, addr2, args_trail...) \
53 if (!((1 << CXGBI_DBG_SOCK) & dbg_level)) \
55 pr_info("%pISpc - %pISpc, " fmt_trail, \
56 addr1, addr2, args_trail); \
59 /* max. connections per adapter */
60 #define CXGBI_MAX_CONN 16384
62 /* always allocate rooms for AHS */
63 #define SKB_TX_ISCSI_PDU_HEADER_MAX \
64 (sizeof(struct iscsi_hdr) + ISCSI_MAX_AHS_SIZE)
66 #define ISCSI_PDU_NONPAYLOAD_LEN 312 /* bhs(48) + ahs(256) + digest(8)*/
69 * align pdu size to multiple of 512 for better performance
71 #define cxgbi_align_pdu_size(n) do { n = (n) & (~511); } while (0)
73 #define ULP2_MODE_ISCSI 2
75 #define ULP2_MAX_PKT_SIZE 16224
76 #define ULP2_MAX_PDU_PAYLOAD \
77 (ULP2_MAX_PKT_SIZE - ISCSI_PDU_NONPAYLOAD_LEN)
79 #define CXGBI_ULP2_MAX_ISO_PAYLOAD 65535
81 #define CXGBI_MAX_ISO_DATA_IN_SKB \
82 min_t(u32, MAX_SKB_FRAGS << PAGE_SHIFT, CXGBI_ULP2_MAX_ISO_PAYLOAD)
84 #define cxgbi_is_iso_config(csk) ((csk)->cdev->skb_iso_txhdr)
85 #define cxgbi_is_iso_disabled(csk) ((csk)->disable_iso)
88 * For iscsi connections HW may inserts digest bytes into the pdu. Those digest
89 * bytes are not sent by the host but are part of the TCP payload and therefore
90 * consume TCP sequence space.
92 static const unsigned int ulp2_extra_len
[] = { 0, 4, 4, 8 };
93 static inline unsigned int cxgbi_ulp_extra_len(int submode
)
95 return ulp2_extra_len
[submode
& 3];
98 #define CPL_RX_DDP_STATUS_DDP_SHIFT 16 /* ddp'able */
99 #define CPL_RX_DDP_STATUS_PAD_SHIFT 19 /* pad error */
100 #define CPL_RX_DDP_STATUS_HCRC_SHIFT 20 /* hcrc error */
101 #define CPL_RX_DDP_STATUS_DCRC_SHIFT 21 /* dcrc error */
105 * Opaque version of structure the SGE stores at skb->head of TX_DATA packets
106 * and for which we must reserve space.
108 struct sge_opaque_hdr
{
110 dma_addr_t addr
[MAX_SKB_FRAGS
+ 1];
114 struct cxgbi_device
*cdev
;
120 unsigned short rss_qid
;
121 unsigned short txq_idx
;
122 unsigned short advmss
;
123 unsigned int tx_chan
;
124 unsigned int rx_chan
;
125 unsigned int mss_idx
;
126 unsigned int smac_idx
;
127 unsigned char port_id
;
131 #ifdef CONFIG_CHELSIO_T4_DCB
134 unsigned char hcrc_len
;
135 unsigned char dcrc_len
;
138 struct sk_buff
*wr_pending_head
;
139 struct sk_buff
*wr_pending_tail
;
140 struct sk_buff
*cpl_close
;
141 struct sk_buff
*cpl_abort_req
;
142 struct sk_buff
*cpl_abort_rpl
;
143 struct sk_buff
*skb_ulp_lhdr
;
147 unsigned int csk_family
;
149 struct sockaddr_in saddr
;
150 struct sockaddr_in6 saddr6
;
153 struct sockaddr_in daddr
;
154 struct sockaddr_in6 daddr6
;
156 struct dst_entry
*dst
;
157 struct sk_buff_head receive_queue
;
158 struct sk_buff_head write_queue
;
159 struct timer_list retry_timer
;
160 struct completion cmpl
;
162 rwlock_t callback_lock
;
176 unsigned long prev_iso_ts
;
182 enum cxgbi_sock_states
{
195 * Connection flags -- many to track some close related events.
197 enum cxgbi_sock_flags
{
198 CTPF_ABORT_RPL_RCVD
, /*received one ABORT_RPL_RSS message */
199 CTPF_ABORT_REQ_RCVD
, /*received one ABORT_REQ_RSS message */
200 CTPF_ABORT_RPL_PENDING
, /* expecting an abort reply */
201 CTPF_TX_DATA_SENT
, /* already sent a TX_DATA WR */
202 CTPF_ACTIVE_CLOSE_NEEDED
,/* need to be closed */
203 CTPF_HAS_ATID
, /* reserved atid */
204 CTPF_HAS_TID
, /* reserved hw tid */
205 CTPF_OFFLOAD_DOWN
, /* offload function off */
206 CTPF_LOGOUT_RSP_RCVD
, /* received logout response */
209 struct cxgbi_skb_rx_cb
{
214 struct cxgbi_skb_tx_cb
{
216 void *arp_err_handler
;
217 struct sk_buff
*wr_next
;
222 enum cxgbi_skcb_flags
{
223 SKCBF_TX_NEED_HDR
, /* packet needs a header */
224 SKCBF_TX_MEM_WRITE
, /* memory write */
225 SKCBF_TX_FLAG_COMPL
, /* wr completion flag */
226 SKCBF_RX_COALESCED
, /* received whole pdu */
227 SKCBF_RX_HDR
, /* received pdu header */
228 SKCBF_RX_DATA
, /* received pdu payload */
229 SKCBF_RX_STATUS
, /* received ddp status */
230 SKCBF_RX_ISCSI_COMPL
, /* received iscsi completion */
231 SKCBF_RX_DATA_DDPD
, /* pdu payload ddp'd */
232 SKCBF_RX_HCRC_ERR
, /* header digest error */
233 SKCBF_RX_DCRC_ERR
, /* data digest error */
234 SKCBF_RX_PAD_ERR
, /* padding byte error */
235 SKCBF_TX_ISO
, /* iso cpl in tx skb */
238 struct cxgbi_skb_cb
{
240 struct cxgbi_skb_rx_cb rx
;
241 struct cxgbi_skb_tx_cb tx
;
247 #define CXGBI_SKB_CB(skb) ((struct cxgbi_skb_cb *)&((skb)->cb[0]))
248 #define cxgbi_skcb_flags(skb) (CXGBI_SKB_CB(skb)->flags)
249 #define cxgbi_skcb_tcp_seq(skb) (CXGBI_SKB_CB(skb)->seq)
250 #define cxgbi_skcb_rx_ddigest(skb) (CXGBI_SKB_CB(skb)->rx.ddigest)
251 #define cxgbi_skcb_rx_pdulen(skb) (CXGBI_SKB_CB(skb)->rx.pdulen)
252 #define cxgbi_skcb_tx_wr_next(skb) (CXGBI_SKB_CB(skb)->tx.wr_next)
253 #define cxgbi_skcb_tx_iscsi_hdrlen(skb) (CXGBI_SKB_CB(skb)->tx.iscsi_hdr_len)
254 #define cxgbi_skcb_tx_ulp_mode(skb) (CXGBI_SKB_CB(skb)->tx.ulp_mode)
256 static inline void cxgbi_skcb_set_flag(struct sk_buff
*skb
,
257 enum cxgbi_skcb_flags flag
)
259 __set_bit(flag
, &(cxgbi_skcb_flags(skb
)));
262 static inline void cxgbi_skcb_clear_flag(struct sk_buff
*skb
,
263 enum cxgbi_skcb_flags flag
)
265 __clear_bit(flag
, &(cxgbi_skcb_flags(skb
)));
268 static inline int cxgbi_skcb_test_flag(const struct sk_buff
*skb
,
269 enum cxgbi_skcb_flags flag
)
271 return test_bit(flag
, &(cxgbi_skcb_flags(skb
)));
274 static inline void cxgbi_sock_set_flag(struct cxgbi_sock
*csk
,
275 enum cxgbi_sock_flags flag
)
277 __set_bit(flag
, &csk
->flags
);
278 log_debug(1 << CXGBI_DBG_SOCK
,
279 "csk 0x%p,%u,0x%lx, bit %d.\n",
280 csk
, csk
->state
, csk
->flags
, flag
);
283 static inline void cxgbi_sock_clear_flag(struct cxgbi_sock
*csk
,
284 enum cxgbi_sock_flags flag
)
286 __clear_bit(flag
, &csk
->flags
);
287 log_debug(1 << CXGBI_DBG_SOCK
,
288 "csk 0x%p,%u,0x%lx, bit %d.\n",
289 csk
, csk
->state
, csk
->flags
, flag
);
292 static inline int cxgbi_sock_flag(struct cxgbi_sock
*csk
,
293 enum cxgbi_sock_flags flag
)
297 return test_bit(flag
, &csk
->flags
);
300 static inline void cxgbi_sock_set_state(struct cxgbi_sock
*csk
, int state
)
302 log_debug(1 << CXGBI_DBG_SOCK
,
303 "csk 0x%p,%u,0x%lx, state -> %u.\n",
304 csk
, csk
->state
, csk
->flags
, state
);
308 static inline void cxgbi_sock_free(struct kref
*kref
)
310 struct cxgbi_sock
*csk
= container_of(kref
,
314 log_debug(1 << CXGBI_DBG_SOCK
,
315 "free csk 0x%p, state %u, flags 0x%lx\n",
316 csk
, csk
->state
, csk
->flags
);
321 static inline void __cxgbi_sock_put(const char *fn
, struct cxgbi_sock
*csk
)
323 log_debug(1 << CXGBI_DBG_SOCK
,
324 "%s, put csk 0x%p, ref %u-1.\n",
325 fn
, csk
, kref_read(&csk
->refcnt
));
326 kref_put(&csk
->refcnt
, cxgbi_sock_free
);
328 #define cxgbi_sock_put(csk) __cxgbi_sock_put(__func__, csk)
330 static inline void __cxgbi_sock_get(const char *fn
, struct cxgbi_sock
*csk
)
332 log_debug(1 << CXGBI_DBG_SOCK
,
333 "%s, get csk 0x%p, ref %u+1.\n",
334 fn
, csk
, kref_read(&csk
->refcnt
));
335 kref_get(&csk
->refcnt
);
337 #define cxgbi_sock_get(csk) __cxgbi_sock_get(__func__, csk)
339 static inline int cxgbi_sock_is_closing(struct cxgbi_sock
*csk
)
341 return csk
->state
>= CTP_ACTIVE_CLOSE
;
344 static inline int cxgbi_sock_is_established(struct cxgbi_sock
*csk
)
346 return csk
->state
== CTP_ESTABLISHED
;
349 static inline void cxgbi_sock_purge_write_queue(struct cxgbi_sock
*csk
)
353 while ((skb
= __skb_dequeue(&csk
->write_queue
)))
357 static inline unsigned int cxgbi_sock_compute_wscale(unsigned int win
)
359 unsigned int wscale
= 0;
361 while (wscale
< 14 && (65535 << wscale
) < win
)
366 static inline struct sk_buff
*alloc_wr(int wrlen
, int dlen
, gfp_t gfp
)
368 struct sk_buff
*skb
= alloc_skb(wrlen
+ dlen
, gfp
);
371 __skb_put(skb
, wrlen
);
372 memset(skb
->head
, 0, wrlen
+ dlen
);
374 pr_info("alloc cpl wr skb %u+%u, OOM.\n", wrlen
, dlen
);
380 * The number of WRs needed for an skb depends on the number of fragments
381 * in the skb and whether it has any payload in its main body. This maps the
382 * length of the gather list represented by an skb into the # of necessary WRs.
383 * The extra two fragments are for iscsi bhs and payload padding.
385 #define SKB_WR_LIST_SIZE (MAX_SKB_FRAGS + 2)
387 static inline void cxgbi_sock_reset_wr_list(struct cxgbi_sock
*csk
)
389 csk
->wr_pending_head
= csk
->wr_pending_tail
= NULL
;
392 static inline void cxgbi_sock_enqueue_wr(struct cxgbi_sock
*csk
,
395 cxgbi_skcb_tx_wr_next(skb
) = NULL
;
397 * We want to take an extra reference since both us and the driver
398 * need to free the packet before it's really freed.
402 if (!csk
->wr_pending_head
)
403 csk
->wr_pending_head
= skb
;
405 cxgbi_skcb_tx_wr_next(csk
->wr_pending_tail
) = skb
;
406 csk
->wr_pending_tail
= skb
;
409 static inline int cxgbi_sock_count_pending_wrs(const struct cxgbi_sock
*csk
)
412 const struct sk_buff
*skb
= csk
->wr_pending_head
;
416 skb
= cxgbi_skcb_tx_wr_next(skb
);
421 static inline struct sk_buff
*cxgbi_sock_peek_wr(const struct cxgbi_sock
*csk
)
423 return csk
->wr_pending_head
;
426 static inline struct sk_buff
*cxgbi_sock_dequeue_wr(struct cxgbi_sock
*csk
)
428 struct sk_buff
*skb
= csk
->wr_pending_head
;
431 csk
->wr_pending_head
= cxgbi_skcb_tx_wr_next(skb
);
432 cxgbi_skcb_tx_wr_next(skb
) = NULL
;
437 void cxgbi_sock_check_wr_invariants(const struct cxgbi_sock
*);
438 void cxgbi_sock_purge_wr_queue(struct cxgbi_sock
*);
439 void cxgbi_sock_skb_entail(struct cxgbi_sock
*, struct sk_buff
*);
440 void cxgbi_sock_fail_act_open(struct cxgbi_sock
*, int);
441 void cxgbi_sock_act_open_req_arp_failure(void *, struct sk_buff
*);
442 void cxgbi_sock_closed(struct cxgbi_sock
*);
443 void cxgbi_sock_established(struct cxgbi_sock
*, unsigned int, unsigned int);
444 void cxgbi_sock_rcv_abort_rpl(struct cxgbi_sock
*);
445 void cxgbi_sock_rcv_peer_close(struct cxgbi_sock
*);
446 void cxgbi_sock_rcv_close_conn_rpl(struct cxgbi_sock
*, u32
);
447 void cxgbi_sock_rcv_wr_ack(struct cxgbi_sock
*, unsigned int, unsigned int,
449 unsigned int cxgbi_sock_select_mss(struct cxgbi_sock
*, unsigned int);
450 void cxgbi_sock_free_cpl_skbs(struct cxgbi_sock
*);
453 struct net_device
*ndev
;
454 struct net_device
*vdev
; /* vlan dev */
455 struct Scsi_Host
*shost
;
456 struct cxgbi_device
*cdev
;
458 unsigned char port_id
;
461 struct cxgbi_ports_map
{
462 unsigned int max_connect
;
464 unsigned short sport_base
;
467 struct cxgbi_sock
**port_csk
;
470 #define CXGBI_FLAG_DEV_T3 0x1
471 #define CXGBI_FLAG_DEV_T4 0x2
472 #define CXGBI_FLAG_ADAPTER_RESET 0x4
473 #define CXGBI_FLAG_IPV4_SET 0x10
474 #define CXGBI_FLAG_USE_PPOD_OFLDQ 0x40
475 #define CXGBI_FLAG_DDP_OFF 0x100
476 #define CXGBI_FLAG_DEV_ISO_OFF 0x400
478 struct cxgbi_device
{
479 struct list_head list_head
;
480 struct list_head rcu_node
;
482 struct net_device
**ports
;
484 struct cxgbi_hba
**hbas
;
485 const unsigned short *mtus
;
487 unsigned char nports
;
488 struct pci_dev
*pdev
;
489 struct dentry
*debugfs_root
;
490 struct iscsi_transport
*itp
;
491 struct module
*owner
;
494 unsigned int rx_credit_thres
;
495 unsigned int skb_tx_rsvd
;
497 unsigned int skb_rx_extra
; /* for msg coalesced mode */
498 unsigned int tx_max_size
;
499 unsigned int rx_max_size
;
500 unsigned int rxq_idx_cntr
;
501 struct cxgbi_ports_map pmap
;
503 void (*dev_ddp_cleanup
)(struct cxgbi_device
*);
504 struct cxgbi_ppm
* (*cdev2ppm
)(struct cxgbi_device
*);
505 int (*csk_ddp_set_map
)(struct cxgbi_ppm
*, struct cxgbi_sock
*,
506 struct cxgbi_task_tag_info
*);
507 void (*csk_ddp_clear_map
)(struct cxgbi_device
*cdev
,
509 struct cxgbi_task_tag_info
*);
510 int (*csk_ddp_setup_digest
)(struct cxgbi_sock
*,
511 unsigned int, int, int);
512 int (*csk_ddp_setup_pgidx
)(struct cxgbi_sock
*,
515 void (*csk_release_offload_resources
)(struct cxgbi_sock
*);
516 int (*csk_rx_pdu_ready
)(struct cxgbi_sock
*, struct sk_buff
*);
517 u32 (*csk_send_rx_credits
)(struct cxgbi_sock
*, u32
);
518 int (*csk_push_tx_frames
)(struct cxgbi_sock
*, int);
519 void (*csk_send_abort_req
)(struct cxgbi_sock
*);
520 void (*csk_send_close_req
)(struct cxgbi_sock
*);
521 int (*csk_alloc_cpls
)(struct cxgbi_sock
*);
522 int (*csk_init_act_open
)(struct cxgbi_sock
*);
526 #define cxgbi_cdev_priv(cdev) ((cdev)->dd_data)
529 struct cxgbi_endpoint
*cep
;
530 struct iscsi_conn
*iconn
;
531 struct cxgbi_hba
*chba
;
533 unsigned int ddp_full
;
534 unsigned int ddp_tag_full
;
537 struct cxgbi_endpoint
{
538 struct cxgbi_conn
*cconn
;
539 struct cxgbi_hba
*chba
;
540 struct cxgbi_sock
*csk
;
543 struct cxgbi_task_data
{
544 #define CXGBI_TASK_SGL_CHECKED 0x1
545 #define CXGBI_TASK_SGL_COPY 0x2
547 unsigned short nr_frags
;
548 struct page_frag frags
[MAX_SKB_FRAGS
];
553 unsigned int sgoffset
;
556 u32 max_xmit_dlength
;
557 struct cxgbi_task_tag_info ttinfo
;
559 #define iscsi_task_cxgbi_data(task) \
560 ((task)->dd_data + sizeof(struct iscsi_tcp_task))
562 struct cxgbi_iso_info
{
563 #define CXGBI_ISO_INFO_FSLICE 0x1
564 #define CXGBI_ISO_INFO_LSLICE 0x2
565 #define CXGBI_ISO_INFO_IMM_ENABLE 0x4
578 static inline void cxgbi_set_iscsi_ipv4(struct cxgbi_hba
*chba
, __be32 ipaddr
)
580 if (chba
->cdev
->flags
& CXGBI_FLAG_IPV4_SET
)
581 chba
->ipv4addr
= ipaddr
;
583 pr_info("set iscsi ipv4 NOT supported, using %s ipv4.\n",
587 struct cxgbi_device
*cxgbi_device_register(unsigned int, unsigned int);
588 void cxgbi_device_unregister(struct cxgbi_device
*);
589 void cxgbi_device_unregister_all(unsigned int flag
);
590 struct cxgbi_device
*cxgbi_device_find_by_lldev(void *);
591 struct cxgbi_device
*cxgbi_device_find_by_netdev(struct net_device
*, int *);
592 struct cxgbi_device
*cxgbi_device_find_by_netdev_rcu(struct net_device
*,
594 int cxgbi_hbas_add(struct cxgbi_device
*, u64
, unsigned int,
595 struct scsi_host_template
*,
596 struct scsi_transport_template
*);
597 void cxgbi_hbas_remove(struct cxgbi_device
*);
599 int cxgbi_device_portmap_create(struct cxgbi_device
*cdev
, unsigned int base
,
600 unsigned int max_conn
);
601 void cxgbi_device_portmap_cleanup(struct cxgbi_device
*cdev
);
603 void cxgbi_conn_tx_open(struct cxgbi_sock
*);
604 void cxgbi_conn_pdu_ready(struct cxgbi_sock
*);
605 int cxgbi_conn_alloc_pdu(struct iscsi_task
*, u8
);
606 int cxgbi_conn_init_pdu(struct iscsi_task
*, unsigned int , unsigned int);
607 int cxgbi_conn_xmit_pdu(struct iscsi_task
*);
609 void cxgbi_cleanup_task(struct iscsi_task
*task
);
611 umode_t
cxgbi_attr_is_visible(int param_type
, int param
);
612 void cxgbi_get_conn_stats(struct iscsi_cls_conn
*, struct iscsi_stats
*);
613 int cxgbi_set_conn_param(struct iscsi_cls_conn
*,
614 enum iscsi_param
, char *, int);
615 int cxgbi_get_ep_param(struct iscsi_endpoint
*ep
, enum iscsi_param
, char *);
616 struct iscsi_cls_conn
*cxgbi_create_conn(struct iscsi_cls_session
*, u32
);
617 int cxgbi_bind_conn(struct iscsi_cls_session
*,
618 struct iscsi_cls_conn
*, u64
, int);
619 void cxgbi_destroy_session(struct iscsi_cls_session
*);
620 struct iscsi_cls_session
*cxgbi_create_session(struct iscsi_endpoint
*,
622 int cxgbi_set_host_param(struct Scsi_Host
*,
623 enum iscsi_host_param
, char *, int);
624 int cxgbi_get_host_param(struct Scsi_Host
*, enum iscsi_host_param
, char *);
625 struct iscsi_endpoint
*cxgbi_ep_connect(struct Scsi_Host
*,
626 struct sockaddr
*, int);
627 int cxgbi_ep_poll(struct iscsi_endpoint
*, int);
628 void cxgbi_ep_disconnect(struct iscsi_endpoint
*);
630 int cxgbi_iscsi_init(struct iscsi_transport
*,
631 struct scsi_transport_template
**);
632 void cxgbi_iscsi_cleanup(struct iscsi_transport
*,
633 struct scsi_transport_template
**);
634 void cxgbi_parse_pdu_itt(struct iscsi_conn
*, itt_t
, int *, int *);
635 int cxgbi_ddp_init(struct cxgbi_device
*, unsigned int, unsigned int,
636 unsigned int, unsigned int);
637 int cxgbi_ddp_cleanup(struct cxgbi_device
*);
638 void cxgbi_ddp_page_size_factor(int *);
639 void cxgbi_ddp_set_one_ppod(struct cxgbi_pagepod
*,
640 struct cxgbi_task_tag_info
*,
641 struct scatterlist
**sg_pp
, unsigned int *sg_off
);
642 int cxgbi_ddp_ppm_setup(void **ppm_pp
, struct cxgbi_device
*cdev
,
643 struct cxgbi_tag_format
*tformat
,
644 unsigned int iscsi_size
, unsigned int llimit
,
645 unsigned int start
, unsigned int rsvd_factor
,
646 unsigned int edram_start
, unsigned int edram_size
);
647 #endif /*__LIBCXGBI_H__*/