1 /* bnx2i.c: Broadcom NetXtreme II iSCSI driver.
3 * Copyright (c) 2006 - 2011 Broadcom Corporation
4 * Copyright (c) 2007, 2008 Red Hat, Inc. All rights reserved.
5 * Copyright (c) 2007, 2008 Mike Christie
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation.
11 * Written by: Anil Veerabhadrappa (anilgv@broadcom.com)
12 * Maintained by: Eddie Wai (eddie.wai@broadcom.com)
17 static struct list_head adapter_list
= LIST_HEAD_INIT(adapter_list
);
18 static u32 adapter_count
;
20 #define DRV_MODULE_NAME "bnx2i"
21 #define DRV_MODULE_VERSION "2.7.0.3"
22 #define DRV_MODULE_RELDATE "Jun 15, 2011"
24 static char version
[] __devinitdata
=
25 "Broadcom NetXtreme II iSCSI Driver " DRV_MODULE_NAME \
26 " v" DRV_MODULE_VERSION
" (" DRV_MODULE_RELDATE
")\n";
29 MODULE_AUTHOR("Anil Veerabhadrappa <anilgv@broadcom.com> and "
30 "Eddie Wai <eddie.wai@broadcom.com>");
32 MODULE_DESCRIPTION("Broadcom NetXtreme II BCM5706/5708/5709/57710/57711/57712"
33 "/57800/57810/57840 iSCSI Driver");
34 MODULE_LICENSE("GPL");
35 MODULE_VERSION(DRV_MODULE_VERSION
);
37 static DEFINE_MUTEX(bnx2i_dev_lock
);
39 unsigned int event_coal_min
= 24;
40 module_param(event_coal_min
, int, 0664);
41 MODULE_PARM_DESC(event_coal_min
, "Event Coalescing Minimum Commands");
43 unsigned int event_coal_div
= 2;
44 module_param(event_coal_div
, int, 0664);
45 MODULE_PARM_DESC(event_coal_div
, "Event Coalescing Divide Factor");
47 unsigned int en_tcp_dack
= 1;
48 module_param(en_tcp_dack
, int, 0664);
49 MODULE_PARM_DESC(en_tcp_dack
, "Enable TCP Delayed ACK");
51 unsigned int error_mask1
= 0x00;
52 module_param(error_mask1
, uint
, 0664);
53 MODULE_PARM_DESC(error_mask1
, "Config FW iSCSI Error Mask #1");
55 unsigned int error_mask2
= 0x00;
56 module_param(error_mask2
, uint
, 0664);
57 MODULE_PARM_DESC(error_mask2
, "Config FW iSCSI Error Mask #2");
60 module_param(sq_size
, int, 0664);
61 MODULE_PARM_DESC(sq_size
, "Configure SQ size");
63 unsigned int rq_size
= BNX2I_RQ_WQES_DEFAULT
;
64 module_param(rq_size
, int, 0664);
65 MODULE_PARM_DESC(rq_size
, "Configure RQ size");
67 u64 iscsi_error_mask
= 0x00;
69 DEFINE_PER_CPU(struct bnx2i_percpu_s
, bnx2i_percpu
);
71 static int bnx2i_cpu_callback(struct notifier_block
*nfb
,
72 unsigned long action
, void *hcpu
);
73 /* notification function for CPU hotplug events */
74 static struct notifier_block bnx2i_cpu_notifier
= {
75 .notifier_call
= bnx2i_cpu_callback
,
80 * bnx2i_identify_device - identifies NetXtreme II device type
81 * @hba: Adapter structure pointer
83 * This function identifies the NX2 device type and sets appropriate
84 * queue mailbox register access method, 5709 requires driver to
85 * access MBOX regs using *bin* mode
87 void bnx2i_identify_device(struct bnx2i_hba
*hba
)
89 hba
->cnic_dev_type
= 0;
90 if ((hba
->pci_did
== PCI_DEVICE_ID_NX2_5706
) ||
91 (hba
->pci_did
== PCI_DEVICE_ID_NX2_5706S
))
92 set_bit(BNX2I_NX2_DEV_5706
, &hba
->cnic_dev_type
);
93 else if ((hba
->pci_did
== PCI_DEVICE_ID_NX2_5708
) ||
94 (hba
->pci_did
== PCI_DEVICE_ID_NX2_5708S
))
95 set_bit(BNX2I_NX2_DEV_5708
, &hba
->cnic_dev_type
);
96 else if ((hba
->pci_did
== PCI_DEVICE_ID_NX2_5709
) ||
97 (hba
->pci_did
== PCI_DEVICE_ID_NX2_5709S
)) {
98 set_bit(BNX2I_NX2_DEV_5709
, &hba
->cnic_dev_type
);
99 hba
->mail_queue_access
= BNX2I_MQ_BIN_MODE
;
100 } else if (hba
->pci_did
== PCI_DEVICE_ID_NX2_57710
||
101 hba
->pci_did
== PCI_DEVICE_ID_NX2_57711
||
102 hba
->pci_did
== PCI_DEVICE_ID_NX2_57711E
||
103 hba
->pci_did
== PCI_DEVICE_ID_NX2_57712
||
104 hba
->pci_did
== PCI_DEVICE_ID_NX2_57712E
||
105 hba
->pci_did
== PCI_DEVICE_ID_NX2_57800
||
106 hba
->pci_did
== PCI_DEVICE_ID_NX2_57800_MF
||
107 hba
->pci_did
== PCI_DEVICE_ID_NX2_57800_VF
||
108 hba
->pci_did
== PCI_DEVICE_ID_NX2_57810
||
109 hba
->pci_did
== PCI_DEVICE_ID_NX2_57810_MF
||
110 hba
->pci_did
== PCI_DEVICE_ID_NX2_57810_VF
||
111 hba
->pci_did
== PCI_DEVICE_ID_NX2_57840
||
112 hba
->pci_did
== PCI_DEVICE_ID_NX2_57840_MF
||
113 hba
->pci_did
== PCI_DEVICE_ID_NX2_57840_VF
)
114 set_bit(BNX2I_NX2_DEV_57710
, &hba
->cnic_dev_type
);
116 printk(KERN_ALERT
"bnx2i: unknown device, 0x%x\n",
122 * get_adapter_list_head - returns head of adapter list
124 struct bnx2i_hba
*get_adapter_list_head(void)
126 struct bnx2i_hba
*hba
= NULL
;
127 struct bnx2i_hba
*tmp_hba
;
132 mutex_lock(&bnx2i_dev_lock
);
133 list_for_each_entry(tmp_hba
, &adapter_list
, link
) {
134 if (tmp_hba
->cnic
&& tmp_hba
->cnic
->cm_select_dev
) {
139 mutex_unlock(&bnx2i_dev_lock
);
146 * bnx2i_find_hba_for_cnic - maps cnic device instance to bnx2i adapter instance
147 * @cnic: pointer to cnic device instance
150 struct bnx2i_hba
*bnx2i_find_hba_for_cnic(struct cnic_dev
*cnic
)
152 struct bnx2i_hba
*hba
, *temp
;
154 mutex_lock(&bnx2i_dev_lock
);
155 list_for_each_entry_safe(hba
, temp
, &adapter_list
, link
) {
156 if (hba
->cnic
== cnic
) {
157 mutex_unlock(&bnx2i_dev_lock
);
161 mutex_unlock(&bnx2i_dev_lock
);
167 * bnx2i_start - cnic callback to initialize & start adapter instance
168 * @handle: transparent handle pointing to adapter structure
170 * This function maps adapter structure to pcidev structure and initiates
171 * firmware handshake to enable/initialize on chip iscsi components
172 * This bnx2i - cnic interface api callback is issued after following
173 * 2 conditions are met -
174 * a) underlying network interface is up (marked by event 'NETDEV_UP'
176 * b) bnx2i adapter instance is registered
178 void bnx2i_start(void *handle
)
180 #define BNX2I_INIT_POLL_TIME (1000 / HZ)
181 struct bnx2i_hba
*hba
= handle
;
185 * We should never register devices that don't support iSCSI
186 * (see bnx2i_init_one), so something is wrong if we try to
187 * start a iSCSI adapter on hardware with 0 supported iSCSI
190 BUG_ON(!hba
->cnic
->max_iscsi_conn
);
192 bnx2i_send_fw_iscsi_init_msg(hba
);
193 while (!test_bit(ADAPTER_STATE_UP
, &hba
->adapter_state
) && i
--)
194 msleep(BNX2I_INIT_POLL_TIME
);
199 * bnx2i_chip_cleanup - local routine to handle chip cleanup
200 * @hba: Adapter instance to register
202 * Driver checks if adapter still has any active connections before
203 * executing the cleanup process
205 static void bnx2i_chip_cleanup(struct bnx2i_hba
*hba
)
207 struct bnx2i_endpoint
*bnx2i_ep
;
208 struct list_head
*pos
, *tmp
;
210 if (hba
->ofld_conns_active
) {
211 /* Stage to force the disconnection
212 * This is the case where the daemon is either slow or
215 printk(KERN_ALERT
"bnx2i: (%s) chip cleanup for %d active "
216 "connections\n", hba
->netdev
->name
,
217 hba
->ofld_conns_active
);
218 mutex_lock(&hba
->net_dev_lock
);
219 list_for_each_safe(pos
, tmp
, &hba
->ep_active_list
) {
220 bnx2i_ep
= list_entry(pos
, struct bnx2i_endpoint
, link
);
221 /* Clean up the chip only */
222 bnx2i_hw_ep_disconnect(bnx2i_ep
);
223 bnx2i_ep
->cm_sk
= NULL
;
225 mutex_unlock(&hba
->net_dev_lock
);
231 * bnx2i_stop - cnic callback to shutdown adapter instance
232 * @handle: transparent handle pointing to adapter structure
234 * driver checks if adapter is already in shutdown mode, if not start
235 * the shutdown process
237 void bnx2i_stop(void *handle
)
239 struct bnx2i_hba
*hba
= handle
;
241 int wait_delay
= 1 * HZ
;
243 /* check if cleanup happened in GOING_DOWN context */
244 if (!test_and_set_bit(ADAPTER_STATE_GOING_DOWN
,
245 &hba
->adapter_state
)) {
246 iscsi_host_for_each_session(hba
->shost
,
248 wait_delay
= hba
->hba_shutdown_tmo
;
250 /* Wait for inflight offload connection tasks to complete before
251 * proceeding. Forcefully terminate all connection recovery in
252 * progress at the earliest, either in bind(), send_pdu(LOGIN),
255 wait_event_interruptible_timeout(hba
->eh_wait
,
256 (list_empty(&hba
->ep_ofld_list
) &&
257 list_empty(&hba
->ep_destroy_list
)),
259 /* Wait for all endpoints to be torn down, Chip will be reset once
260 * control returns to network driver. So it is required to cleanup and
261 * release all connection resources before returning from this routine.
263 while (hba
->ofld_conns_active
) {
264 conns_active
= hba
->ofld_conns_active
;
265 wait_event_interruptible_timeout(hba
->eh_wait
,
266 (hba
->ofld_conns_active
!= conns_active
),
268 if (hba
->ofld_conns_active
== conns_active
)
271 bnx2i_chip_cleanup(hba
);
273 /* This flag should be cleared last so that ep_disconnect() gracefully
274 * cleans up connection context
276 clear_bit(ADAPTER_STATE_GOING_DOWN
, &hba
->adapter_state
);
277 clear_bit(ADAPTER_STATE_UP
, &hba
->adapter_state
);
282 * bnx2i_init_one - initialize an adapter instance and allocate memory resources
283 * @hba: bnx2i adapter instance
284 * @cnic: cnic device handle
286 * Global resource lock is held during critical sections below. This routine is
287 * called from either cnic_register_driver() or device hot plug context and
288 * and does majority of device specific initialization
290 static int bnx2i_init_one(struct bnx2i_hba
*hba
, struct cnic_dev
*cnic
)
294 mutex_lock(&bnx2i_dev_lock
);
295 if (!cnic
->max_iscsi_conn
) {
296 printk(KERN_ALERT
"bnx2i: dev %s does not support "
297 "iSCSI\n", hba
->netdev
->name
);
303 rc
= cnic
->register_device(cnic
, CNIC_ULP_ISCSI
, hba
);
306 set_bit(BNX2I_CNIC_REGISTERED
, &hba
->reg_with_cnic
);
307 list_add_tail(&hba
->link
, &adapter_list
);
309 } else if (rc
== -EBUSY
) /* duplicate registration */
310 printk(KERN_ALERT
"bnx2i, duplicate registration"
311 "hba=%p, cnic=%p\n", hba
, cnic
);
312 else if (rc
== -EAGAIN
)
313 printk(KERN_ERR
"bnx2i, driver not registered\n");
314 else if (rc
== -EINVAL
)
315 printk(KERN_ERR
"bnx2i, invalid type %d\n", CNIC_ULP_ISCSI
);
317 printk(KERN_ERR
"bnx2i dev reg, unknown error, %d\n", rc
);
320 mutex_unlock(&bnx2i_dev_lock
);
327 * bnx2i_ulp_init - initialize an adapter instance
328 * @dev: cnic device handle
330 * Called from cnic_register_driver() context to initialize all enumerated
331 * cnic devices. This routine allocate adapter structure and other
332 * device specific resources.
334 void bnx2i_ulp_init(struct cnic_dev
*dev
)
336 struct bnx2i_hba
*hba
;
338 /* Allocate a HBA structure for this device */
339 hba
= bnx2i_alloc_hba(dev
);
341 printk(KERN_ERR
"bnx2i init: hba initialization failed\n");
345 /* Get PCI related information and update hba struct members */
346 clear_bit(BNX2I_CNIC_REGISTERED
, &hba
->reg_with_cnic
);
347 if (bnx2i_init_one(hba
, dev
)) {
348 printk(KERN_ERR
"bnx2i - hba %p init failed\n", hba
);
355 * bnx2i_ulp_exit - shuts down adapter instance and frees all resources
356 * @dev: cnic device handle
359 void bnx2i_ulp_exit(struct cnic_dev
*dev
)
361 struct bnx2i_hba
*hba
;
363 hba
= bnx2i_find_hba_for_cnic(dev
);
365 printk(KERN_INFO
"bnx2i_ulp_exit: hba not "
366 "found, dev 0x%p\n", dev
);
369 mutex_lock(&bnx2i_dev_lock
);
370 list_del_init(&hba
->link
);
373 if (test_bit(BNX2I_CNIC_REGISTERED
, &hba
->reg_with_cnic
)) {
374 hba
->cnic
->unregister_device(hba
->cnic
, CNIC_ULP_ISCSI
);
375 clear_bit(BNX2I_CNIC_REGISTERED
, &hba
->reg_with_cnic
);
377 mutex_unlock(&bnx2i_dev_lock
);
384 * bnx2i_percpu_thread_create - Create a receive thread for an
387 * @cpu: cpu index for the online cpu
389 static void bnx2i_percpu_thread_create(unsigned int cpu
)
391 struct bnx2i_percpu_s
*p
;
392 struct task_struct
*thread
;
394 p
= &per_cpu(bnx2i_percpu
, cpu
);
396 thread
= kthread_create_on_node(bnx2i_percpu_io_thread
, (void *)p
,
398 "bnx2i_thread/%d", cpu
);
399 /* bind thread to the cpu */
400 if (likely(!IS_ERR(thread
))) {
401 kthread_bind(thread
, cpu
);
402 p
->iothread
= thread
;
403 wake_up_process(thread
);
408 static void bnx2i_percpu_thread_destroy(unsigned int cpu
)
410 struct bnx2i_percpu_s
*p
;
411 struct task_struct
*thread
;
412 struct bnx2i_work
*work
, *tmp
;
414 /* Prevent any new work from being queued for this CPU */
415 p
= &per_cpu(bnx2i_percpu
, cpu
);
416 spin_lock_bh(&p
->p_work_lock
);
417 thread
= p
->iothread
;
420 /* Free all work in the list */
421 list_for_each_entry_safe(work
, tmp
, &p
->work_list
, list
) {
422 list_del_init(&work
->list
);
423 bnx2i_process_scsi_cmd_resp(work
->session
,
424 work
->bnx2i_conn
, &work
->cqe
);
428 spin_unlock_bh(&p
->p_work_lock
);
430 kthread_stop(thread
);
435 * bnx2i_cpu_callback - Handler for CPU hotplug events
437 * @nfb: The callback data block
438 * @action: The event triggering the callback
439 * @hcpu: The index of the CPU that the event is for
441 * This creates or destroys per-CPU data for iSCSI
443 * Returns NOTIFY_OK always.
445 static int bnx2i_cpu_callback(struct notifier_block
*nfb
,
446 unsigned long action
, void *hcpu
)
448 unsigned cpu
= (unsigned long)hcpu
;
452 case CPU_ONLINE_FROZEN
:
453 printk(KERN_INFO
"bnx2i: CPU %x online: Create Rx thread\n",
455 bnx2i_percpu_thread_create(cpu
);
458 case CPU_DEAD_FROZEN
:
459 printk(KERN_INFO
"CPU %x offline: Remove Rx thread\n", cpu
);
460 bnx2i_percpu_thread_destroy(cpu
);
470 * bnx2i_mod_init - module init entry point
472 * initialize any driver wide global data structures such as endpoint pool,
473 * tcp port manager/queue, sysfs. finally driver will register itself
474 * with the cnic module
476 static int __init
bnx2i_mod_init(void)
480 struct bnx2i_percpu_s
*p
;
482 printk(KERN_INFO
"%s", version
);
484 if (sq_size
&& !is_power_of_2(sq_size
))
485 sq_size
= roundup_pow_of_two(sq_size
);
487 mutex_init(&bnx2i_dev_lock
);
489 bnx2i_scsi_xport_template
=
490 iscsi_register_transport(&bnx2i_iscsi_transport
);
491 if (!bnx2i_scsi_xport_template
) {
492 printk(KERN_ERR
"Could not register bnx2i transport.\n");
497 err
= cnic_register_driver(CNIC_ULP_ISCSI
, &bnx2i_cnic_cb
);
499 printk(KERN_ERR
"Could not register bnx2i cnic driver.\n");
503 /* Create percpu kernel threads to handle iSCSI I/O completions */
504 for_each_possible_cpu(cpu
) {
505 p
= &per_cpu(bnx2i_percpu
, cpu
);
506 INIT_LIST_HEAD(&p
->work_list
);
507 spin_lock_init(&p
->p_work_lock
);
511 for_each_online_cpu(cpu
)
512 bnx2i_percpu_thread_create(cpu
);
514 /* Initialize per CPU interrupt thread */
515 register_hotcpu_notifier(&bnx2i_cpu_notifier
);
520 iscsi_unregister_transport(&bnx2i_iscsi_transport
);
527 * bnx2i_mod_exit - module cleanup/exit entry point
529 * Global resource lock and host adapter lock is held during critical sections
530 * in this function. Driver will browse through the adapter list, cleans-up
531 * each instance, unregisters iscsi transport name and finally driver will
532 * unregister itself with the cnic module
534 static void __exit
bnx2i_mod_exit(void)
536 struct bnx2i_hba
*hba
;
539 mutex_lock(&bnx2i_dev_lock
);
540 while (!list_empty(&adapter_list
)) {
541 hba
= list_entry(adapter_list
.next
, struct bnx2i_hba
, link
);
542 list_del(&hba
->link
);
545 if (test_bit(BNX2I_CNIC_REGISTERED
, &hba
->reg_with_cnic
)) {
546 bnx2i_chip_cleanup(hba
);
547 hba
->cnic
->unregister_device(hba
->cnic
, CNIC_ULP_ISCSI
);
548 clear_bit(BNX2I_CNIC_REGISTERED
, &hba
->reg_with_cnic
);
553 mutex_unlock(&bnx2i_dev_lock
);
555 unregister_hotcpu_notifier(&bnx2i_cpu_notifier
);
557 for_each_online_cpu(cpu
)
558 bnx2i_percpu_thread_destroy(cpu
);
560 iscsi_unregister_transport(&bnx2i_iscsi_transport
);
561 cnic_unregister_driver(CNIC_ULP_ISCSI
);
564 module_init(bnx2i_mod_init
);
565 module_exit(bnx2i_mod_exit
);