[SCSI] bnx2i: Added the use of kthreads to handle SCSI cmd completion
[linux-2.6.git] / drivers / scsi / bnx2i / bnx2i_init.c
1 /* bnx2i.c: Broadcom NetXtreme II iSCSI driver.
2  *
3  * Copyright (c) 2006 - 2010 Broadcom Corporation
4  * Copyright (c) 2007, 2008 Red Hat, Inc.  All rights reserved.
5  * Copyright (c) 2007, 2008 Mike Christie
6  *
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.
10  *
11  * Written by: Anil Veerabhadrappa (anilgv@broadcom.com)
12  * Maintained by: Eddie Wai (eddie.wai@broadcom.com)
13  */
14
15 #include "bnx2i.h"
16
17 static struct list_head adapter_list = LIST_HEAD_INIT(adapter_list);
18 static u32 adapter_count;
19
20 #define DRV_MODULE_NAME         "bnx2i"
21 #define DRV_MODULE_VERSION      "2.6.2.3"
22 #define DRV_MODULE_RELDATE      "Dec 31, 2010"
23
24 static char version[] __devinitdata =
25                 "Broadcom NetXtreme II iSCSI Driver " DRV_MODULE_NAME \
26                 " v" DRV_MODULE_VERSION " (" DRV_MODULE_RELDATE ")\n";
27
28
29 MODULE_AUTHOR("Anil Veerabhadrappa <anilgv@broadcom.com> and "
30               "Eddie Wai <eddie.wai@broadcom.com>");
31
32 MODULE_DESCRIPTION("Broadcom NetXtreme II BCM5706/5708/5709/57710/57711/57712"
33                    " iSCSI Driver");
34 MODULE_LICENSE("GPL");
35 MODULE_VERSION(DRV_MODULE_VERSION);
36
37 static DEFINE_MUTEX(bnx2i_dev_lock);
38
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");
42
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");
46
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");
50
51 unsigned int error_mask1 = 0x00;
52 module_param(error_mask1, int, 0664);
53 MODULE_PARM_DESC(error_mask1, "Config FW iSCSI Error Mask #1");
54
55 unsigned int error_mask2 = 0x00;
56 module_param(error_mask2, int, 0664);
57 MODULE_PARM_DESC(error_mask2, "Config FW iSCSI Error Mask #2");
58
59 unsigned int sq_size;
60 module_param(sq_size, int, 0664);
61 MODULE_PARM_DESC(sq_size, "Configure SQ size");
62
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");
66
67 u64 iscsi_error_mask = 0x00;
68
69 DEFINE_PER_CPU(struct bnx2i_percpu_s, bnx2i_percpu);
70
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,
76 };
77
78
79 /**
80  * bnx2i_identify_device - identifies NetXtreme II device type
81  * @hba:                Adapter structure pointer
82  *
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
86  */
87 void bnx2i_identify_device(struct bnx2i_hba *hba)
88 {
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                 set_bit(BNX2I_NX2_DEV_57710, &hba->cnic_dev_type);
106         else
107                 printk(KERN_ALERT "bnx2i: unknown device, 0x%x\n",
108                                   hba->pci_did);
109 }
110
111
112 /**
113  * get_adapter_list_head - returns head of adapter list
114  */
115 struct bnx2i_hba *get_adapter_list_head(void)
116 {
117         struct bnx2i_hba *hba = NULL;
118         struct bnx2i_hba *tmp_hba;
119
120         if (!adapter_count)
121                 goto hba_not_found;
122
123         mutex_lock(&bnx2i_dev_lock);
124         list_for_each_entry(tmp_hba, &adapter_list, link) {
125                 if (tmp_hba->cnic && tmp_hba->cnic->cm_select_dev) {
126                         hba = tmp_hba;
127                         break;
128                 }
129         }
130         mutex_unlock(&bnx2i_dev_lock);
131 hba_not_found:
132         return hba;
133 }
134
135
136 /**
137  * bnx2i_find_hba_for_cnic - maps cnic device instance to bnx2i adapter instance
138  * @cnic:       pointer to cnic device instance
139  *
140  */
141 struct bnx2i_hba *bnx2i_find_hba_for_cnic(struct cnic_dev *cnic)
142 {
143         struct bnx2i_hba *hba, *temp;
144
145         mutex_lock(&bnx2i_dev_lock);
146         list_for_each_entry_safe(hba, temp, &adapter_list, link) {
147                 if (hba->cnic == cnic) {
148                         mutex_unlock(&bnx2i_dev_lock);
149                         return hba;
150                 }
151         }
152         mutex_unlock(&bnx2i_dev_lock);
153         return NULL;
154 }
155
156
157 /**
158  * bnx2i_start - cnic callback to initialize & start adapter instance
159  * @handle:     transparent handle pointing to adapter structure
160  *
161  * This function maps adapter structure to pcidev structure and initiates
162  *      firmware handshake to enable/initialize on chip iscsi components
163  *      This bnx2i - cnic interface api callback is issued after following
164  *      2 conditions are met -
165  *        a) underlying network interface is up (marked by event 'NETDEV_UP'
166  *              from netdev
167  *        b) bnx2i adapter instance is registered
168  */
169 void bnx2i_start(void *handle)
170 {
171 #define BNX2I_INIT_POLL_TIME    (1000 / HZ)
172         struct bnx2i_hba *hba = handle;
173         int i = HZ;
174
175         if (!hba->cnic->max_iscsi_conn) {
176                 printk(KERN_ALERT "bnx2i: dev %s does not support "
177                         "iSCSI\n", hba->netdev->name);
178
179                 if (test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic)) {
180                         mutex_lock(&bnx2i_dev_lock);
181                         list_del_init(&hba->link);
182                         adapter_count--;
183                         hba->cnic->unregister_device(hba->cnic, CNIC_ULP_ISCSI);
184                         clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
185                         mutex_unlock(&bnx2i_dev_lock);
186                         bnx2i_free_hba(hba);
187                 }
188                 return;
189         }
190         bnx2i_send_fw_iscsi_init_msg(hba);
191         while (!test_bit(ADAPTER_STATE_UP, &hba->adapter_state) && i--)
192                 msleep(BNX2I_INIT_POLL_TIME);
193 }
194
195
196 /**
197  * bnx2i_chip_cleanup - local routine to handle chip cleanup
198  * @hba:        Adapter instance to register
199  *
200  * Driver checks if adapter still has any active connections before
201  *      executing the cleanup process
202  */
203 static void bnx2i_chip_cleanup(struct bnx2i_hba *hba)
204 {
205         struct bnx2i_endpoint *bnx2i_ep;
206         struct list_head *pos, *tmp;
207
208         if (hba->ofld_conns_active) {
209                 /* Stage to force the disconnection
210                  * This is the case where the daemon is either slow or
211                  * not present
212                  */
213                 printk(KERN_ALERT "bnx2i: (%s) chip cleanup for %d active "
214                         "connections\n", hba->netdev->name,
215                         hba->ofld_conns_active);
216                 mutex_lock(&hba->net_dev_lock);
217                 list_for_each_safe(pos, tmp, &hba->ep_active_list) {
218                         bnx2i_ep = list_entry(pos, struct bnx2i_endpoint, link);
219                         /* Clean up the chip only */
220                         bnx2i_hw_ep_disconnect(bnx2i_ep);
221                         bnx2i_ep->cm_sk = NULL;
222                 }
223                 mutex_unlock(&hba->net_dev_lock);
224         }
225 }
226
227
228 /**
229  * bnx2i_stop - cnic callback to shutdown adapter instance
230  * @handle:     transparent handle pointing to adapter structure
231  *
232  * driver checks if adapter is already in shutdown mode, if not start
233  *      the shutdown process
234  */
235 void bnx2i_stop(void *handle)
236 {
237         struct bnx2i_hba *hba = handle;
238         int conns_active;
239         int wait_delay = 1 * HZ;
240
241         /* check if cleanup happened in GOING_DOWN context */
242         if (!test_and_set_bit(ADAPTER_STATE_GOING_DOWN,
243                               &hba->adapter_state)) {
244                 iscsi_host_for_each_session(hba->shost,
245                                             bnx2i_drop_session);
246                 wait_delay = hba->hba_shutdown_tmo;
247         }
248         /* Wait for inflight offload connection tasks to complete before
249          * proceeding. Forcefully terminate all connection recovery in
250          * progress at the earliest, either in bind(), send_pdu(LOGIN),
251          * or conn_start()
252          */
253         wait_event_interruptible_timeout(hba->eh_wait,
254                                          (list_empty(&hba->ep_ofld_list) &&
255                                          list_empty(&hba->ep_destroy_list)),
256                                          2 * HZ);
257         /* Wait for all endpoints to be torn down, Chip will be reset once
258          *  control returns to network driver. So it is required to cleanup and
259          * release all connection resources before returning from this routine.
260          */
261         while (hba->ofld_conns_active) {
262                 conns_active = hba->ofld_conns_active;
263                 wait_event_interruptible_timeout(hba->eh_wait,
264                                 (hba->ofld_conns_active != conns_active),
265                                 wait_delay);
266                 if (hba->ofld_conns_active == conns_active)
267                         break;
268         }
269         bnx2i_chip_cleanup(hba);
270
271         /* This flag should be cleared last so that ep_disconnect() gracefully
272          * cleans up connection context
273          */
274         clear_bit(ADAPTER_STATE_GOING_DOWN, &hba->adapter_state);
275         clear_bit(ADAPTER_STATE_UP, &hba->adapter_state);
276 }
277
278
279 /**
280  * bnx2i_init_one - initialize an adapter instance and allocate memory resources
281  * @hba:        bnx2i adapter instance
282  * @cnic:       cnic device handle
283  *
284  * Global resource lock is held during critical sections below. This routine is
285  *      called from either cnic_register_driver() or device hot plug context and
286  *      and does majority of device specific initialization
287  */
288 static int bnx2i_init_one(struct bnx2i_hba *hba, struct cnic_dev *cnic)
289 {
290         int rc;
291
292         mutex_lock(&bnx2i_dev_lock);
293         hba->cnic = cnic;
294         rc = cnic->register_device(cnic, CNIC_ULP_ISCSI, hba);
295         if (!rc) {
296                 hba->age++;
297                 set_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
298                 list_add_tail(&hba->link, &adapter_list);
299                 adapter_count++;
300         } else if (rc == -EBUSY)        /* duplicate registration */
301                 printk(KERN_ALERT "bnx2i, duplicate registration"
302                                   "hba=%p, cnic=%p\n", hba, cnic);
303         else if (rc == -EAGAIN)
304                 printk(KERN_ERR "bnx2i, driver not registered\n");
305         else if (rc == -EINVAL)
306                 printk(KERN_ERR "bnx2i, invalid type %d\n", CNIC_ULP_ISCSI);
307         else
308                 printk(KERN_ERR "bnx2i dev reg, unknown error, %d\n", rc);
309
310         mutex_unlock(&bnx2i_dev_lock);
311
312         return rc;
313 }
314
315
316 /**
317  * bnx2i_ulp_init - initialize an adapter instance
318  * @dev:        cnic device handle
319  *
320  * Called from cnic_register_driver() context to initialize all enumerated
321  *      cnic devices. This routine allocate adapter structure and other
322  *      device specific resources.
323  */
324 void bnx2i_ulp_init(struct cnic_dev *dev)
325 {
326         struct bnx2i_hba *hba;
327
328         /* Allocate a HBA structure for this device */
329         hba = bnx2i_alloc_hba(dev);
330         if (!hba) {
331                 printk(KERN_ERR "bnx2i init: hba initialization failed\n");
332                 return;
333         }
334
335         /* Get PCI related information and update hba struct members */
336         clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
337         if (bnx2i_init_one(hba, dev)) {
338                 printk(KERN_ERR "bnx2i - hba %p init failed\n", hba);
339                 bnx2i_free_hba(hba);
340         }
341 }
342
343
344 /**
345  * bnx2i_ulp_exit - shuts down adapter instance and frees all resources
346  * @dev:        cnic device handle
347  *
348  */
349 void bnx2i_ulp_exit(struct cnic_dev *dev)
350 {
351         struct bnx2i_hba *hba;
352
353         hba = bnx2i_find_hba_for_cnic(dev);
354         if (!hba) {
355                 printk(KERN_INFO "bnx2i_ulp_exit: hba not "
356                                  "found, dev 0x%p\n", dev);
357                 return;
358         }
359         mutex_lock(&bnx2i_dev_lock);
360         list_del_init(&hba->link);
361         adapter_count--;
362
363         if (test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic)) {
364                 hba->cnic->unregister_device(hba->cnic, CNIC_ULP_ISCSI);
365                 clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
366         }
367         mutex_unlock(&bnx2i_dev_lock);
368
369         bnx2i_free_hba(hba);
370 }
371
372
373 /**
374  * bnx2i_percpu_thread_create - Create a receive thread for an
375  *                              online CPU
376  *
377  * @cpu:        cpu index for the online cpu
378  */
379 static void bnx2i_percpu_thread_create(unsigned int cpu)
380 {
381         struct bnx2i_percpu_s *p;
382         struct task_struct *thread;
383
384         p = &per_cpu(bnx2i_percpu, cpu);
385
386         thread = kthread_create(bnx2i_percpu_io_thread, (void *)p,
387                                 "bnx2i_thread/%d", cpu);
388         /* bind thread to the cpu */
389         if (likely(!IS_ERR(thread))) {
390                 kthread_bind(thread, cpu);
391                 p->iothread = thread;
392                 wake_up_process(thread);
393         }
394 }
395
396
397 static void bnx2i_percpu_thread_destroy(unsigned int cpu)
398 {
399         struct bnx2i_percpu_s *p;
400         struct task_struct *thread;
401         struct bnx2i_work *work, *tmp;
402
403         /* Prevent any new work from being queued for this CPU */
404         p = &per_cpu(bnx2i_percpu, cpu);
405         spin_lock_bh(&p->p_work_lock);
406         thread = p->iothread;
407         p->iothread = NULL;
408
409         /* Free all work in the list */
410         list_for_each_entry_safe(work, tmp, &p->work_list, list) {
411                 list_del_init(&work->list);
412                 bnx2i_process_scsi_cmd_resp(work->session,
413                                             work->bnx2i_conn, &work->cqe);
414                 kfree(work);
415         }
416
417         spin_unlock_bh(&p->p_work_lock);
418         if (thread)
419                 kthread_stop(thread);
420 }
421
422
423 /**
424  * bnx2i_cpu_callback - Handler for CPU hotplug events
425  *
426  * @nfb:        The callback data block
427  * @action:     The event triggering the callback
428  * @hcpu:       The index of the CPU that the event is for
429  *
430  * This creates or destroys per-CPU data for iSCSI
431  *
432  * Returns NOTIFY_OK always.
433  */
434 static int bnx2i_cpu_callback(struct notifier_block *nfb,
435                               unsigned long action, void *hcpu)
436 {
437         unsigned cpu = (unsigned long)hcpu;
438
439         switch (action) {
440         case CPU_ONLINE:
441         case CPU_ONLINE_FROZEN:
442                 printk(KERN_INFO "bnx2i: CPU %x online: Create Rx thread\n",
443                         cpu);
444                 bnx2i_percpu_thread_create(cpu);
445                 break;
446         case CPU_DEAD:
447         case CPU_DEAD_FROZEN:
448                 printk(KERN_INFO "CPU %x offline: Remove Rx thread\n", cpu);
449                 bnx2i_percpu_thread_destroy(cpu);
450                 break;
451         default:
452                 break;
453         }
454         return NOTIFY_OK;
455 }
456
457
458 /**
459  * bnx2i_mod_init - module init entry point
460  *
461  * initialize any driver wide global data structures such as endpoint pool,
462  *      tcp port manager/queue, sysfs. finally driver will register itself
463  *      with the cnic module
464  */
465 static int __init bnx2i_mod_init(void)
466 {
467         int err;
468         unsigned cpu = 0;
469         struct bnx2i_percpu_s *p;
470
471         printk(KERN_INFO "%s", version);
472
473         if (sq_size && !is_power_of_2(sq_size))
474                 sq_size = roundup_pow_of_two(sq_size);
475
476         mutex_init(&bnx2i_dev_lock);
477
478         bnx2i_scsi_xport_template =
479                         iscsi_register_transport(&bnx2i_iscsi_transport);
480         if (!bnx2i_scsi_xport_template) {
481                 printk(KERN_ERR "Could not register bnx2i transport.\n");
482                 err = -ENOMEM;
483                 goto out;
484         }
485
486         err = cnic_register_driver(CNIC_ULP_ISCSI, &bnx2i_cnic_cb);
487         if (err) {
488                 printk(KERN_ERR "Could not register bnx2i cnic driver.\n");
489                 goto unreg_xport;
490         }
491
492         /* Create percpu kernel threads to handle iSCSI I/O completions */
493         for_each_possible_cpu(cpu) {
494                 p = &per_cpu(bnx2i_percpu, cpu);
495                 INIT_LIST_HEAD(&p->work_list);
496                 spin_lock_init(&p->p_work_lock);
497                 p->iothread = NULL;
498         }
499
500         for_each_online_cpu(cpu)
501                 bnx2i_percpu_thread_create(cpu);
502
503         /* Initialize per CPU interrupt thread */
504         register_hotcpu_notifier(&bnx2i_cpu_notifier);
505
506         return 0;
507
508 unreg_xport:
509         iscsi_unregister_transport(&bnx2i_iscsi_transport);
510 out:
511         return err;
512 }
513
514
515 /**
516  * bnx2i_mod_exit - module cleanup/exit entry point
517  *
518  * Global resource lock and host adapter lock is held during critical sections
519  *      in this function. Driver will browse through the adapter list, cleans-up
520  *      each instance, unregisters iscsi transport name and finally driver will
521  *      unregister itself with the cnic module
522  */
523 static void __exit bnx2i_mod_exit(void)
524 {
525         struct bnx2i_hba *hba;
526         unsigned cpu = 0;
527
528         mutex_lock(&bnx2i_dev_lock);
529         while (!list_empty(&adapter_list)) {
530                 hba = list_entry(adapter_list.next, struct bnx2i_hba, link);
531                 list_del(&hba->link);
532                 adapter_count--;
533
534                 if (test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic)) {
535                         bnx2i_chip_cleanup(hba);
536                         hba->cnic->unregister_device(hba->cnic, CNIC_ULP_ISCSI);
537                         clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
538                 }
539
540                 bnx2i_free_hba(hba);
541         }
542         mutex_unlock(&bnx2i_dev_lock);
543
544         unregister_hotcpu_notifier(&bnx2i_cpu_notifier);
545
546         for_each_online_cpu(cpu)
547                 bnx2i_percpu_thread_destroy(cpu);
548
549         iscsi_unregister_transport(&bnx2i_iscsi_transport);
550         cnic_unregister_driver(CNIC_ULP_ISCSI);
551 }
552
553 module_init(bnx2i_mod_init);
554 module_exit(bnx2i_mod_exit);