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)
80 * For iscsi connections HW may inserts digest bytes into the pdu. Those digest
81 * bytes are not sent by the host but are part of the TCP payload and therefore
82 * consume TCP sequence space.
84 static const unsigned int ulp2_extra_len
[] = { 0, 4, 4, 8 };
85 static inline unsigned int cxgbi_ulp_extra_len(int submode
)
87 return ulp2_extra_len
[submode
& 3];
90 #define CPL_RX_DDP_STATUS_DDP_SHIFT 16 /* ddp'able */
91 #define CPL_RX_DDP_STATUS_PAD_SHIFT 19 /* pad error */
92 #define CPL_RX_DDP_STATUS_HCRC_SHIFT 20 /* hcrc error */
93 #define CPL_RX_DDP_STATUS_DCRC_SHIFT 21 /* dcrc error */
97 * Opaque version of structure the SGE stores at skb->head of TX_DATA packets
98 * and for which we must reserve space.
100 struct sge_opaque_hdr
{
102 dma_addr_t addr
[MAX_SKB_FRAGS
+ 1];
106 struct cxgbi_device
*cdev
;
112 unsigned short rss_qid
;
113 unsigned short txq_idx
;
114 unsigned short advmss
;
115 unsigned int tx_chan
;
116 unsigned int rx_chan
;
117 unsigned int mss_idx
;
118 unsigned int smac_idx
;
119 unsigned char port_id
;
123 unsigned char hcrc_len
;
124 unsigned char dcrc_len
;
127 struct sk_buff
*wr_pending_head
;
128 struct sk_buff
*wr_pending_tail
;
129 struct sk_buff
*cpl_close
;
130 struct sk_buff
*cpl_abort_req
;
131 struct sk_buff
*cpl_abort_rpl
;
132 struct sk_buff
*skb_ulp_lhdr
;
136 unsigned int csk_family
;
138 struct sockaddr_in saddr
;
139 struct sockaddr_in6 saddr6
;
142 struct sockaddr_in daddr
;
143 struct sockaddr_in6 daddr6
;
145 struct dst_entry
*dst
;
146 struct sk_buff_head receive_queue
;
147 struct sk_buff_head write_queue
;
148 struct timer_list retry_timer
;
149 struct completion cmpl
;
151 rwlock_t callback_lock
;
167 enum cxgbi_sock_states
{
180 * Connection flags -- many to track some close related events.
182 enum cxgbi_sock_flags
{
183 CTPF_ABORT_RPL_RCVD
, /*received one ABORT_RPL_RSS message */
184 CTPF_ABORT_REQ_RCVD
, /*received one ABORT_REQ_RSS message */
185 CTPF_ABORT_RPL_PENDING
, /* expecting an abort reply */
186 CTPF_TX_DATA_SENT
, /* already sent a TX_DATA WR */
187 CTPF_ACTIVE_CLOSE_NEEDED
,/* need to be closed */
188 CTPF_HAS_ATID
, /* reserved atid */
189 CTPF_HAS_TID
, /* reserved hw tid */
190 CTPF_OFFLOAD_DOWN
, /* offload function off */
191 CTPF_LOGOUT_RSP_RCVD
, /* received logout response */
194 struct cxgbi_skb_rx_cb
{
199 struct cxgbi_skb_tx_cb
{
201 void *arp_err_handler
;
202 struct sk_buff
*wr_next
;
205 enum cxgbi_skcb_flags
{
206 SKCBF_TX_NEED_HDR
, /* packet needs a header */
207 SKCBF_TX_MEM_WRITE
, /* memory write */
208 SKCBF_TX_FLAG_COMPL
, /* wr completion flag */
209 SKCBF_RX_COALESCED
, /* received whole pdu */
210 SKCBF_RX_HDR
, /* received pdu header */
211 SKCBF_RX_DATA
, /* received pdu payload */
212 SKCBF_RX_STATUS
, /* received ddp status */
213 SKCBF_RX_ISCSI_COMPL
, /* received iscsi completion */
214 SKCBF_RX_DATA_DDPD
, /* pdu payload ddp'd */
215 SKCBF_RX_HCRC_ERR
, /* header digest error */
216 SKCBF_RX_DCRC_ERR
, /* data digest error */
217 SKCBF_RX_PAD_ERR
, /* padding byte error */
220 struct cxgbi_skb_cb
{
222 struct cxgbi_skb_rx_cb rx
;
223 struct cxgbi_skb_tx_cb tx
;
225 unsigned char ulp_mode
;
230 #define CXGBI_SKB_CB(skb) ((struct cxgbi_skb_cb *)&((skb)->cb[0]))
231 #define cxgbi_skcb_flags(skb) (CXGBI_SKB_CB(skb)->flags)
232 #define cxgbi_skcb_ulp_mode(skb) (CXGBI_SKB_CB(skb)->ulp_mode)
233 #define cxgbi_skcb_tcp_seq(skb) (CXGBI_SKB_CB(skb)->seq)
234 #define cxgbi_skcb_rx_ddigest(skb) (CXGBI_SKB_CB(skb)->rx.ddigest)
235 #define cxgbi_skcb_rx_pdulen(skb) (CXGBI_SKB_CB(skb)->rx.pdulen)
236 #define cxgbi_skcb_tx_wr_next(skb) (CXGBI_SKB_CB(skb)->tx.wr_next)
238 static inline void cxgbi_skcb_set_flag(struct sk_buff
*skb
,
239 enum cxgbi_skcb_flags flag
)
241 __set_bit(flag
, &(cxgbi_skcb_flags(skb
)));
244 static inline void cxgbi_skcb_clear_flag(struct sk_buff
*skb
,
245 enum cxgbi_skcb_flags flag
)
247 __clear_bit(flag
, &(cxgbi_skcb_flags(skb
)));
250 static inline int cxgbi_skcb_test_flag(const struct sk_buff
*skb
,
251 enum cxgbi_skcb_flags flag
)
253 return test_bit(flag
, &(cxgbi_skcb_flags(skb
)));
256 static inline void cxgbi_sock_set_flag(struct cxgbi_sock
*csk
,
257 enum cxgbi_sock_flags flag
)
259 __set_bit(flag
, &csk
->flags
);
260 log_debug(1 << CXGBI_DBG_SOCK
,
261 "csk 0x%p,%u,0x%lx, bit %d.\n",
262 csk
, csk
->state
, csk
->flags
, flag
);
265 static inline void cxgbi_sock_clear_flag(struct cxgbi_sock
*csk
,
266 enum cxgbi_sock_flags flag
)
268 __clear_bit(flag
, &csk
->flags
);
269 log_debug(1 << CXGBI_DBG_SOCK
,
270 "csk 0x%p,%u,0x%lx, bit %d.\n",
271 csk
, csk
->state
, csk
->flags
, flag
);
274 static inline int cxgbi_sock_flag(struct cxgbi_sock
*csk
,
275 enum cxgbi_sock_flags flag
)
279 return test_bit(flag
, &csk
->flags
);
282 static inline void cxgbi_sock_set_state(struct cxgbi_sock
*csk
, int state
)
284 log_debug(1 << CXGBI_DBG_SOCK
,
285 "csk 0x%p,%u,0x%lx, state -> %u.\n",
286 csk
, csk
->state
, csk
->flags
, state
);
290 static inline void cxgbi_sock_free(struct kref
*kref
)
292 struct cxgbi_sock
*csk
= container_of(kref
,
296 log_debug(1 << CXGBI_DBG_SOCK
,
297 "free csk 0x%p, state %u, flags 0x%lx\n",
298 csk
, csk
->state
, csk
->flags
);
303 static inline void __cxgbi_sock_put(const char *fn
, struct cxgbi_sock
*csk
)
305 log_debug(1 << CXGBI_DBG_SOCK
,
306 "%s, put csk 0x%p, ref %u-1.\n",
307 fn
, csk
, kref_read(&csk
->refcnt
));
308 kref_put(&csk
->refcnt
, cxgbi_sock_free
);
310 #define cxgbi_sock_put(csk) __cxgbi_sock_put(__func__, csk)
312 static inline void __cxgbi_sock_get(const char *fn
, struct cxgbi_sock
*csk
)
314 log_debug(1 << CXGBI_DBG_SOCK
,
315 "%s, get csk 0x%p, ref %u+1.\n",
316 fn
, csk
, kref_read(&csk
->refcnt
));
317 kref_get(&csk
->refcnt
);
319 #define cxgbi_sock_get(csk) __cxgbi_sock_get(__func__, csk)
321 static inline int cxgbi_sock_is_closing(struct cxgbi_sock
*csk
)
323 return csk
->state
>= CTP_ACTIVE_CLOSE
;
326 static inline int cxgbi_sock_is_established(struct cxgbi_sock
*csk
)
328 return csk
->state
== CTP_ESTABLISHED
;
331 static inline void cxgbi_sock_purge_write_queue(struct cxgbi_sock
*csk
)
335 while ((skb
= __skb_dequeue(&csk
->write_queue
)))
339 static inline unsigned int cxgbi_sock_compute_wscale(unsigned int win
)
341 unsigned int wscale
= 0;
343 while (wscale
< 14 && (65535 << wscale
) < win
)
348 static inline struct sk_buff
*alloc_wr(int wrlen
, int dlen
, gfp_t gfp
)
350 struct sk_buff
*skb
= alloc_skb(wrlen
+ dlen
, gfp
);
353 __skb_put(skb
, wrlen
);
354 memset(skb
->head
, 0, wrlen
+ dlen
);
356 pr_info("alloc cpl wr skb %u+%u, OOM.\n", wrlen
, dlen
);
362 * The number of WRs needed for an skb depends on the number of fragments
363 * in the skb and whether it has any payload in its main body. This maps the
364 * length of the gather list represented by an skb into the # of necessary WRs.
365 * The extra two fragments are for iscsi bhs and payload padding.
367 #define SKB_WR_LIST_SIZE (MAX_SKB_FRAGS + 2)
369 static inline void cxgbi_sock_reset_wr_list(struct cxgbi_sock
*csk
)
371 csk
->wr_pending_head
= csk
->wr_pending_tail
= NULL
;
374 static inline void cxgbi_sock_enqueue_wr(struct cxgbi_sock
*csk
,
377 cxgbi_skcb_tx_wr_next(skb
) = NULL
;
379 * We want to take an extra reference since both us and the driver
380 * need to free the packet before it's really freed.
384 if (!csk
->wr_pending_head
)
385 csk
->wr_pending_head
= skb
;
387 cxgbi_skcb_tx_wr_next(csk
->wr_pending_tail
) = skb
;
388 csk
->wr_pending_tail
= skb
;
391 static inline int cxgbi_sock_count_pending_wrs(const struct cxgbi_sock
*csk
)
394 const struct sk_buff
*skb
= csk
->wr_pending_head
;
398 skb
= cxgbi_skcb_tx_wr_next(skb
);
403 static inline struct sk_buff
*cxgbi_sock_peek_wr(const struct cxgbi_sock
*csk
)
405 return csk
->wr_pending_head
;
408 static inline struct sk_buff
*cxgbi_sock_dequeue_wr(struct cxgbi_sock
*csk
)
410 struct sk_buff
*skb
= csk
->wr_pending_head
;
413 csk
->wr_pending_head
= cxgbi_skcb_tx_wr_next(skb
);
414 cxgbi_skcb_tx_wr_next(skb
) = NULL
;
419 void cxgbi_sock_check_wr_invariants(const struct cxgbi_sock
*);
420 void cxgbi_sock_purge_wr_queue(struct cxgbi_sock
*);
421 void cxgbi_sock_skb_entail(struct cxgbi_sock
*, struct sk_buff
*);
422 void cxgbi_sock_fail_act_open(struct cxgbi_sock
*, int);
423 void cxgbi_sock_act_open_req_arp_failure(void *, struct sk_buff
*);
424 void cxgbi_sock_closed(struct cxgbi_sock
*);
425 void cxgbi_sock_established(struct cxgbi_sock
*, unsigned int, unsigned int);
426 void cxgbi_sock_rcv_abort_rpl(struct cxgbi_sock
*);
427 void cxgbi_sock_rcv_peer_close(struct cxgbi_sock
*);
428 void cxgbi_sock_rcv_close_conn_rpl(struct cxgbi_sock
*, u32
);
429 void cxgbi_sock_rcv_wr_ack(struct cxgbi_sock
*, unsigned int, unsigned int,
431 unsigned int cxgbi_sock_select_mss(struct cxgbi_sock
*, unsigned int);
432 void cxgbi_sock_free_cpl_skbs(struct cxgbi_sock
*);
435 struct net_device
*ndev
;
436 struct net_device
*vdev
; /* vlan dev */
437 struct Scsi_Host
*shost
;
438 struct cxgbi_device
*cdev
;
440 unsigned char port_id
;
443 struct cxgbi_ports_map
{
444 unsigned int max_connect
;
446 unsigned short sport_base
;
449 struct cxgbi_sock
**port_csk
;
452 #define CXGBI_FLAG_DEV_T3 0x1
453 #define CXGBI_FLAG_DEV_T4 0x2
454 #define CXGBI_FLAG_ADAPTER_RESET 0x4
455 #define CXGBI_FLAG_IPV4_SET 0x10
456 #define CXGBI_FLAG_USE_PPOD_OFLDQ 0x40
457 #define CXGBI_FLAG_DDP_OFF 0x100
459 struct cxgbi_device
{
460 struct list_head list_head
;
461 struct list_head rcu_node
;
463 struct net_device
**ports
;
465 struct cxgbi_hba
**hbas
;
466 const unsigned short *mtus
;
468 unsigned char nports
;
469 struct pci_dev
*pdev
;
470 struct dentry
*debugfs_root
;
471 struct iscsi_transport
*itp
;
472 struct module
*owner
;
475 unsigned int rx_credit_thres
;
476 unsigned int skb_tx_rsvd
;
477 unsigned int skb_rx_extra
; /* for msg coalesced mode */
478 unsigned int tx_max_size
;
479 unsigned int rx_max_size
;
480 unsigned int rxq_idx_cntr
;
481 struct cxgbi_ports_map pmap
;
483 void (*dev_ddp_cleanup
)(struct cxgbi_device
*);
484 struct cxgbi_ppm
* (*cdev2ppm
)(struct cxgbi_device
*);
485 int (*csk_ddp_set_map
)(struct cxgbi_ppm
*, struct cxgbi_sock
*,
486 struct cxgbi_task_tag_info
*);
487 void (*csk_ddp_clear_map
)(struct cxgbi_device
*cdev
,
489 struct cxgbi_task_tag_info
*);
490 int (*csk_ddp_setup_digest
)(struct cxgbi_sock
*,
491 unsigned int, int, int);
492 int (*csk_ddp_setup_pgidx
)(struct cxgbi_sock
*,
495 void (*csk_release_offload_resources
)(struct cxgbi_sock
*);
496 int (*csk_rx_pdu_ready
)(struct cxgbi_sock
*, struct sk_buff
*);
497 u32 (*csk_send_rx_credits
)(struct cxgbi_sock
*, u32
);
498 int (*csk_push_tx_frames
)(struct cxgbi_sock
*, int);
499 void (*csk_send_abort_req
)(struct cxgbi_sock
*);
500 void (*csk_send_close_req
)(struct cxgbi_sock
*);
501 int (*csk_alloc_cpls
)(struct cxgbi_sock
*);
502 int (*csk_init_act_open
)(struct cxgbi_sock
*);
506 #define cxgbi_cdev_priv(cdev) ((cdev)->dd_data)
509 struct cxgbi_endpoint
*cep
;
510 struct iscsi_conn
*iconn
;
511 struct cxgbi_hba
*chba
;
513 unsigned int ddp_full
;
514 unsigned int ddp_tag_full
;
517 struct cxgbi_endpoint
{
518 struct cxgbi_conn
*cconn
;
519 struct cxgbi_hba
*chba
;
520 struct cxgbi_sock
*csk
;
523 #define MAX_PDU_FRAGS ((ULP2_MAX_PDU_PAYLOAD + 512 - 1) / 512)
524 struct cxgbi_task_data
{
525 unsigned short nr_frags
;
526 struct page_frag frags
[MAX_PDU_FRAGS
];
531 unsigned int sgoffset
;
532 struct cxgbi_task_tag_info ttinfo
;
534 #define iscsi_task_cxgbi_data(task) \
535 ((task)->dd_data + sizeof(struct iscsi_tcp_task))
537 static inline void *cxgbi_alloc_big_mem(unsigned int size
,
540 void *p
= kzalloc(size
, gfp
| __GFP_NOWARN
);
548 static inline void cxgbi_free_big_mem(void *addr
)
553 static inline void cxgbi_set_iscsi_ipv4(struct cxgbi_hba
*chba
, __be32 ipaddr
)
555 if (chba
->cdev
->flags
& CXGBI_FLAG_IPV4_SET
)
556 chba
->ipv4addr
= ipaddr
;
558 pr_info("set iscsi ipv4 NOT supported, using %s ipv4.\n",
562 struct cxgbi_device
*cxgbi_device_register(unsigned int, unsigned int);
563 void cxgbi_device_unregister(struct cxgbi_device
*);
564 void cxgbi_device_unregister_all(unsigned int flag
);
565 struct cxgbi_device
*cxgbi_device_find_by_lldev(void *);
566 struct cxgbi_device
*cxgbi_device_find_by_netdev(struct net_device
*, int *);
567 struct cxgbi_device
*cxgbi_device_find_by_netdev_rcu(struct net_device
*,
569 int cxgbi_hbas_add(struct cxgbi_device
*, u64
, unsigned int,
570 struct scsi_host_template
*,
571 struct scsi_transport_template
*);
572 void cxgbi_hbas_remove(struct cxgbi_device
*);
574 int cxgbi_device_portmap_create(struct cxgbi_device
*cdev
, unsigned int base
,
575 unsigned int max_conn
);
576 void cxgbi_device_portmap_cleanup(struct cxgbi_device
*cdev
);
578 void cxgbi_conn_tx_open(struct cxgbi_sock
*);
579 void cxgbi_conn_pdu_ready(struct cxgbi_sock
*);
580 int cxgbi_conn_alloc_pdu(struct iscsi_task
*, u8
);
581 int cxgbi_conn_init_pdu(struct iscsi_task
*, unsigned int , unsigned int);
582 int cxgbi_conn_xmit_pdu(struct iscsi_task
*);
584 void cxgbi_cleanup_task(struct iscsi_task
*task
);
586 umode_t
cxgbi_attr_is_visible(int param_type
, int param
);
587 void cxgbi_get_conn_stats(struct iscsi_cls_conn
*, struct iscsi_stats
*);
588 int cxgbi_set_conn_param(struct iscsi_cls_conn
*,
589 enum iscsi_param
, char *, int);
590 int cxgbi_get_ep_param(struct iscsi_endpoint
*ep
, enum iscsi_param
, char *);
591 struct iscsi_cls_conn
*cxgbi_create_conn(struct iscsi_cls_session
*, u32
);
592 int cxgbi_bind_conn(struct iscsi_cls_session
*,
593 struct iscsi_cls_conn
*, u64
, int);
594 void cxgbi_destroy_session(struct iscsi_cls_session
*);
595 struct iscsi_cls_session
*cxgbi_create_session(struct iscsi_endpoint
*,
597 int cxgbi_set_host_param(struct Scsi_Host
*,
598 enum iscsi_host_param
, char *, int);
599 int cxgbi_get_host_param(struct Scsi_Host
*, enum iscsi_host_param
, char *);
600 struct iscsi_endpoint
*cxgbi_ep_connect(struct Scsi_Host
*,
601 struct sockaddr
*, int);
602 int cxgbi_ep_poll(struct iscsi_endpoint
*, int);
603 void cxgbi_ep_disconnect(struct iscsi_endpoint
*);
605 int cxgbi_iscsi_init(struct iscsi_transport
*,
606 struct scsi_transport_template
**);
607 void cxgbi_iscsi_cleanup(struct iscsi_transport
*,
608 struct scsi_transport_template
**);
609 void cxgbi_parse_pdu_itt(struct iscsi_conn
*, itt_t
, int *, int *);
610 int cxgbi_ddp_init(struct cxgbi_device
*, unsigned int, unsigned int,
611 unsigned int, unsigned int);
612 int cxgbi_ddp_cleanup(struct cxgbi_device
*);
613 void cxgbi_ddp_page_size_factor(int *);
614 void cxgbi_ddp_set_one_ppod(struct cxgbi_pagepod
*,
615 struct cxgbi_task_tag_info
*,
616 struct scatterlist
**sg_pp
, unsigned int *sg_off
);
617 void cxgbi_ddp_ppm_setup(void **ppm_pp
, struct cxgbi_device
*,
618 struct cxgbi_tag_format
*, unsigned int ppmax
,
619 unsigned int llimit
, unsigned int start
,
620 unsigned int rsvd_factor
);
621 #endif /*__LIBCXGBI_H__*/