1 /* bnx2i.c: Broadcom NetXtreme II iSCSI driver. 2 * 3 * Copyright (c) 2006 - 2012 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.7.2.2" 22 #define DRV_MODULE_RELDATE "Apr 25, 2012" 23 24 static char version[] = 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 "/57800/57810/57840 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, uint, 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, uint, 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 * @cnic: Corresponding cnic device 83 * 84 * This function identifies the NX2 device type and sets appropriate 85 * queue mailbox register access method, 5709 requires driver to 86 * access MBOX regs using *bin* mode 87 */ 88 void bnx2i_identify_device(struct bnx2i_hba *hba, struct cnic_dev *dev) 89 { 90 hba->cnic_dev_type = 0; 91 if (test_bit(CNIC_F_BNX2_CLASS, &dev->flags)) { 92 if (hba->pci_did == PCI_DEVICE_ID_NX2_5706 || 93 hba->pci_did == PCI_DEVICE_ID_NX2_5706S) { 94 set_bit(BNX2I_NX2_DEV_5706, &hba->cnic_dev_type); 95 } else if (hba->pci_did == PCI_DEVICE_ID_NX2_5708 || 96 hba->pci_did == PCI_DEVICE_ID_NX2_5708S) { 97 set_bit(BNX2I_NX2_DEV_5708, &hba->cnic_dev_type); 98 } else if (hba->pci_did == PCI_DEVICE_ID_NX2_5709 || 99 hba->pci_did == PCI_DEVICE_ID_NX2_5709S) { 100 set_bit(BNX2I_NX2_DEV_5709, &hba->cnic_dev_type); 101 hba->mail_queue_access = BNX2I_MQ_BIN_MODE; 102 } 103 } else if (test_bit(CNIC_F_BNX2X_CLASS, &dev->flags)) { 104 set_bit(BNX2I_NX2_DEV_57710, &hba->cnic_dev_type); 105 } else { 106 printk(KERN_ALERT "bnx2i: unknown device, 0x%x\n", 107 hba->pci_did); 108 } 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 /* 176 * We should never register devices that don't support iSCSI 177 * (see bnx2i_init_one), so something is wrong if we try to 178 * start a iSCSI adapter on hardware with 0 supported iSCSI 179 * connections 180 */ 181 BUG_ON(!hba->cnic->max_iscsi_conn); 182 183 bnx2i_send_fw_iscsi_init_msg(hba); 184 while (!test_bit(ADAPTER_STATE_UP, &hba->adapter_state) && i--) 185 msleep(BNX2I_INIT_POLL_TIME); 186 } 187 188 189 /** 190 * bnx2i_chip_cleanup - local routine to handle chip cleanup 191 * @hba: Adapter instance to register 192 * 193 * Driver checks if adapter still has any active connections before 194 * executing the cleanup process 195 */ 196 static void bnx2i_chip_cleanup(struct bnx2i_hba *hba) 197 { 198 struct bnx2i_endpoint *bnx2i_ep; 199 struct list_head *pos, *tmp; 200 201 if (hba->ofld_conns_active) { 202 /* Stage to force the disconnection 203 * This is the case where the daemon is either slow or 204 * not present 205 */ 206 printk(KERN_ALERT "bnx2i: (%s) chip cleanup for %d active " 207 "connections\n", hba->netdev->name, 208 hba->ofld_conns_active); 209 mutex_lock(&hba->net_dev_lock); 210 list_for_each_safe(pos, tmp, &hba->ep_active_list) { 211 bnx2i_ep = list_entry(pos, struct bnx2i_endpoint, link); 212 /* Clean up the chip only */ 213 bnx2i_hw_ep_disconnect(bnx2i_ep); 214 bnx2i_ep->cm_sk = NULL; 215 } 216 mutex_unlock(&hba->net_dev_lock); 217 } 218 } 219 220 221 /** 222 * bnx2i_stop - cnic callback to shutdown adapter instance 223 * @handle: transparent handle pointing to adapter structure 224 * 225 * driver checks if adapter is already in shutdown mode, if not start 226 * the shutdown process 227 */ 228 void bnx2i_stop(void *handle) 229 { 230 struct bnx2i_hba *hba = handle; 231 int conns_active; 232 int wait_delay = 1 * HZ; 233 234 /* check if cleanup happened in GOING_DOWN context */ 235 if (!test_and_set_bit(ADAPTER_STATE_GOING_DOWN, 236 &hba->adapter_state)) { 237 iscsi_host_for_each_session(hba->shost, 238 bnx2i_drop_session); 239 wait_delay = hba->hba_shutdown_tmo; 240 } 241 /* Wait for inflight offload connection tasks to complete before 242 * proceeding. Forcefully terminate all connection recovery in 243 * progress at the earliest, either in bind(), send_pdu(LOGIN), 244 * or conn_start() 245 */ 246 wait_event_interruptible_timeout(hba->eh_wait, 247 (list_empty(&hba->ep_ofld_list) && 248 list_empty(&hba->ep_destroy_list)), 249 2 * HZ); 250 /* Wait for all endpoints to be torn down, Chip will be reset once 251 * control returns to network driver. So it is required to cleanup and 252 * release all connection resources before returning from this routine. 253 */ 254 while (hba->ofld_conns_active) { 255 conns_active = hba->ofld_conns_active; 256 wait_event_interruptible_timeout(hba->eh_wait, 257 (hba->ofld_conns_active != conns_active), 258 wait_delay); 259 if (hba->ofld_conns_active == conns_active) 260 break; 261 } 262 bnx2i_chip_cleanup(hba); 263 264 /* This flag should be cleared last so that ep_disconnect() gracefully 265 * cleans up connection context 266 */ 267 clear_bit(ADAPTER_STATE_GOING_DOWN, &hba->adapter_state); 268 clear_bit(ADAPTER_STATE_UP, &hba->adapter_state); 269 } 270 271 272 /** 273 * bnx2i_init_one - initialize an adapter instance and allocate memory resources 274 * @hba: bnx2i adapter instance 275 * @cnic: cnic device handle 276 * 277 * Global resource lock is held during critical sections below. This routine is 278 * called from either cnic_register_driver() or device hot plug context and 279 * and does majority of device specific initialization 280 */ 281 static int bnx2i_init_one(struct bnx2i_hba *hba, struct cnic_dev *cnic) 282 { 283 int rc; 284 285 mutex_lock(&bnx2i_dev_lock); 286 if (!cnic->max_iscsi_conn) { 287 printk(KERN_ALERT "bnx2i: dev %s does not support " 288 "iSCSI\n", hba->netdev->name); 289 rc = -EOPNOTSUPP; 290 goto out; 291 } 292 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 out: 311 mutex_unlock(&bnx2i_dev_lock); 312 313 return rc; 314 } 315 316 317 /** 318 * bnx2i_ulp_init - initialize an adapter instance 319 * @dev: cnic device handle 320 * 321 * Called from cnic_register_driver() context to initialize all enumerated 322 * cnic devices. This routine allocate adapter structure and other 323 * device specific resources. 324 */ 325 void bnx2i_ulp_init(struct cnic_dev *dev) 326 { 327 struct bnx2i_hba *hba; 328 329 /* Allocate a HBA structure for this device */ 330 hba = bnx2i_alloc_hba(dev); 331 if (!hba) { 332 printk(KERN_ERR "bnx2i init: hba initialization failed\n"); 333 return; 334 } 335 336 /* Get PCI related information and update hba struct members */ 337 clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic); 338 if (bnx2i_init_one(hba, dev)) { 339 printk(KERN_ERR "bnx2i - hba %p init failed\n", hba); 340 bnx2i_free_hba(hba); 341 } 342 } 343 344 345 /** 346 * bnx2i_ulp_exit - shuts down adapter instance and frees all resources 347 * @dev: cnic device handle 348 * 349 */ 350 void bnx2i_ulp_exit(struct cnic_dev *dev) 351 { 352 struct bnx2i_hba *hba; 353 354 hba = bnx2i_find_hba_for_cnic(dev); 355 if (!hba) { 356 printk(KERN_INFO "bnx2i_ulp_exit: hba not " 357 "found, dev 0x%p\n", dev); 358 return; 359 } 360 mutex_lock(&bnx2i_dev_lock); 361 list_del_init(&hba->link); 362 adapter_count--; 363 364 if (test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic)) { 365 hba->cnic->unregister_device(hba->cnic, CNIC_ULP_ISCSI); 366 clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic); 367 } 368 mutex_unlock(&bnx2i_dev_lock); 369 370 bnx2i_free_hba(hba); 371 } 372 373 374 /** 375 * bnx2i_get_stats - Retrieve various statistic from iSCSI offload 376 * @handle: bnx2i_hba 377 * 378 * function callback exported via bnx2i - cnic driver interface to 379 * retrieve various iSCSI offload related statistics. 380 */ 381 int bnx2i_get_stats(void *handle) 382 { 383 struct bnx2i_hba *hba = handle; 384 struct iscsi_stats_info *stats; 385 386 if (!hba) 387 return -EINVAL; 388 389 stats = (struct iscsi_stats_info *)hba->cnic->stats_addr; 390 391 if (!stats) 392 return -ENOMEM; 393 394 strlcpy(stats->version, DRV_MODULE_VERSION, sizeof(stats->version)); 395 memcpy(stats->mac_add1 + 2, hba->cnic->mac_addr, ETH_ALEN); 396 397 stats->max_frame_size = hba->netdev->mtu; 398 stats->txq_size = hba->max_sqes; 399 stats->rxq_size = hba->max_cqes; 400 401 stats->txq_avg_depth = 0; 402 stats->rxq_avg_depth = 0; 403 404 GET_STATS_64(hba, stats, rx_pdus); 405 GET_STATS_64(hba, stats, rx_bytes); 406 407 GET_STATS_64(hba, stats, tx_pdus); 408 GET_STATS_64(hba, stats, tx_bytes); 409 410 return 0; 411 } 412 413 414 /** 415 * bnx2i_percpu_thread_create - Create a receive thread for an 416 * online CPU 417 * 418 * @cpu: cpu index for the online cpu 419 */ 420 static void bnx2i_percpu_thread_create(unsigned int cpu) 421 { 422 struct bnx2i_percpu_s *p; 423 struct task_struct *thread; 424 425 p = &per_cpu(bnx2i_percpu, cpu); 426 427 thread = kthread_create_on_node(bnx2i_percpu_io_thread, (void *)p, 428 cpu_to_node(cpu), 429 "bnx2i_thread/%d", cpu); 430 /* bind thread to the cpu */ 431 if (likely(!IS_ERR(thread))) { 432 kthread_bind(thread, cpu); 433 p->iothread = thread; 434 wake_up_process(thread); 435 } 436 } 437 438 439 static void bnx2i_percpu_thread_destroy(unsigned int cpu) 440 { 441 struct bnx2i_percpu_s *p; 442 struct task_struct *thread; 443 struct bnx2i_work *work, *tmp; 444 445 /* Prevent any new work from being queued for this CPU */ 446 p = &per_cpu(bnx2i_percpu, cpu); 447 spin_lock_bh(&p->p_work_lock); 448 thread = p->iothread; 449 p->iothread = NULL; 450 451 /* Free all work in the list */ 452 list_for_each_entry_safe(work, tmp, &p->work_list, list) { 453 list_del_init(&work->list); 454 bnx2i_process_scsi_cmd_resp(work->session, 455 work->bnx2i_conn, &work->cqe); 456 kfree(work); 457 } 458 459 spin_unlock_bh(&p->p_work_lock); 460 if (thread) 461 kthread_stop(thread); 462 } 463 464 465 /** 466 * bnx2i_cpu_callback - Handler for CPU hotplug events 467 * 468 * @nfb: The callback data block 469 * @action: The event triggering the callback 470 * @hcpu: The index of the CPU that the event is for 471 * 472 * This creates or destroys per-CPU data for iSCSI 473 * 474 * Returns NOTIFY_OK always. 475 */ 476 static int bnx2i_cpu_callback(struct notifier_block *nfb, 477 unsigned long action, void *hcpu) 478 { 479 unsigned cpu = (unsigned long)hcpu; 480 481 switch (action) { 482 case CPU_ONLINE: 483 case CPU_ONLINE_FROZEN: 484 printk(KERN_INFO "bnx2i: CPU %x online: Create Rx thread\n", 485 cpu); 486 bnx2i_percpu_thread_create(cpu); 487 break; 488 case CPU_DEAD: 489 case CPU_DEAD_FROZEN: 490 printk(KERN_INFO "CPU %x offline: Remove Rx thread\n", cpu); 491 bnx2i_percpu_thread_destroy(cpu); 492 break; 493 default: 494 break; 495 } 496 return NOTIFY_OK; 497 } 498 499 500 /** 501 * bnx2i_mod_init - module init entry point 502 * 503 * initialize any driver wide global data structures such as endpoint pool, 504 * tcp port manager/queue, sysfs. finally driver will register itself 505 * with the cnic module 506 */ 507 static int __init bnx2i_mod_init(void) 508 { 509 int err; 510 unsigned cpu = 0; 511 struct bnx2i_percpu_s *p; 512 513 printk(KERN_INFO "%s", version); 514 515 if (sq_size && !is_power_of_2(sq_size)) 516 sq_size = roundup_pow_of_two(sq_size); 517 518 mutex_init(&bnx2i_dev_lock); 519 520 bnx2i_scsi_xport_template = 521 iscsi_register_transport(&bnx2i_iscsi_transport); 522 if (!bnx2i_scsi_xport_template) { 523 printk(KERN_ERR "Could not register bnx2i transport.\n"); 524 err = -ENOMEM; 525 goto out; 526 } 527 528 err = cnic_register_driver(CNIC_ULP_ISCSI, &bnx2i_cnic_cb); 529 if (err) { 530 printk(KERN_ERR "Could not register bnx2i cnic driver.\n"); 531 goto unreg_xport; 532 } 533 534 /* Create percpu kernel threads to handle iSCSI I/O completions */ 535 for_each_possible_cpu(cpu) { 536 p = &per_cpu(bnx2i_percpu, cpu); 537 INIT_LIST_HEAD(&p->work_list); 538 spin_lock_init(&p->p_work_lock); 539 p->iothread = NULL; 540 } 541 542 for_each_online_cpu(cpu) 543 bnx2i_percpu_thread_create(cpu); 544 545 /* Initialize per CPU interrupt thread */ 546 register_hotcpu_notifier(&bnx2i_cpu_notifier); 547 548 return 0; 549 550 unreg_xport: 551 iscsi_unregister_transport(&bnx2i_iscsi_transport); 552 out: 553 return err; 554 } 555 556 557 /** 558 * bnx2i_mod_exit - module cleanup/exit entry point 559 * 560 * Global resource lock and host adapter lock is held during critical sections 561 * in this function. Driver will browse through the adapter list, cleans-up 562 * each instance, unregisters iscsi transport name and finally driver will 563 * unregister itself with the cnic module 564 */ 565 static void __exit bnx2i_mod_exit(void) 566 { 567 struct bnx2i_hba *hba; 568 unsigned cpu = 0; 569 570 mutex_lock(&bnx2i_dev_lock); 571 while (!list_empty(&adapter_list)) { 572 hba = list_entry(adapter_list.next, struct bnx2i_hba, link); 573 list_del(&hba->link); 574 adapter_count--; 575 576 if (test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic)) { 577 bnx2i_chip_cleanup(hba); 578 hba->cnic->unregister_device(hba->cnic, CNIC_ULP_ISCSI); 579 clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic); 580 } 581 582 bnx2i_free_hba(hba); 583 } 584 mutex_unlock(&bnx2i_dev_lock); 585 586 unregister_hotcpu_notifier(&bnx2i_cpu_notifier); 587 588 for_each_online_cpu(cpu) 589 bnx2i_percpu_thread_destroy(cpu); 590 591 iscsi_unregister_transport(&bnx2i_iscsi_transport); 592 cnic_unregister_driver(CNIC_ULP_ISCSI); 593 } 594 595 module_init(bnx2i_mod_init); 596 module_exit(bnx2i_mod_exit); 597