drivers/scsi/bnx2i/bnx2i_init.c

   1 /* bnx2i.c: Broadcom NetXtreme II iSCSI driver.
   2  *
   3  * Copyright (c) 2006 - 2009 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  */
  13
  14 #include "bnx2i.h"
  15
  16 static struct list_head adapter_list = LIST_HEAD_INIT(adapter_list);
  17 static u32 adapter_count;
  18
  19 #define DRV_MODULE_NAME         "bnx2i"
  20 #define DRV_MODULE_VERSION      "2.1.1"
  21 #define DRV_MODULE_RELDATE      "Mar 24, 2010"
  22
  23 static char version[] __devinitdata =
  24                 "Broadcom NetXtreme II iSCSI Driver " DRV_MODULE_NAME \
  25                 " v" DRV_MODULE_VERSION " (" DRV_MODULE_RELDATE ")\n";
  26
  27
  28 MODULE_AUTHOR("Anil Veerabhadrappa <anilgv@broadcom.com>");
  29 MODULE_DESCRIPTION("Broadcom NetXtreme II BCM5706/5708/5709/57710/57711"
  30                    " iSCSI Driver");
  31 MODULE_LICENSE("GPL");
  32 MODULE_VERSION(DRV_MODULE_VERSION);
  33
  34 static DEFINE_MUTEX(bnx2i_dev_lock);
  35
  36 unsigned int event_coal_min = 24;
  37 module_param(event_coal_min, int, 0664);
  38 MODULE_PARM_DESC(event_coal_min, "Event Coalescing Minimum Commands");
  39
  40 unsigned int event_coal_div = 1;
  41 module_param(event_coal_div, int, 0664);
  42 MODULE_PARM_DESC(event_coal_div, "Event Coalescing Divide Factor");
  43
  44 unsigned int en_tcp_dack = 1;
  45 module_param(en_tcp_dack, int, 0664);
  46 MODULE_PARM_DESC(en_tcp_dack, "Enable TCP Delayed ACK");
  47
  48 unsigned int error_mask1 = 0x00;
  49 module_param(error_mask1, int, 0664);
  50 MODULE_PARM_DESC(error_mask1, "Config FW iSCSI Error Mask #1");
  51
  52 unsigned int error_mask2 = 0x00;
  53 module_param(error_mask2, int, 0664);
  54 MODULE_PARM_DESC(error_mask2, "Config FW iSCSI Error Mask #2");
  55
  56 unsigned int sq_size;
  57 module_param(sq_size, int, 0664);
  58 MODULE_PARM_DESC(sq_size, "Configure SQ size");
  59
  60 unsigned int rq_size = BNX2I_RQ_WQES_DEFAULT;
  61 module_param(rq_size, int, 0664);
  62 MODULE_PARM_DESC(rq_size, "Configure RQ size");
  63
  64 u64 iscsi_error_mask = 0x00;
  65
  66 static void bnx2i_unreg_one_device(struct bnx2i_hba *hba) ;
  67
  68
  69 /**
  70  * bnx2i_identify_device - identifies NetXtreme II device type
  71  * @hba:                Adapter structure pointer
  72  *
  73  * This function identifies the NX2 device type and sets appropriate
  74  *      queue mailbox register access method, 5709 requires driver to
  75  *      access MBOX regs using *bin* mode
  76  */
  77 void bnx2i_identify_device(struct bnx2i_hba *hba)
  78 {
  79         hba->cnic_dev_type = 0;
  80         if ((hba->pci_did == PCI_DEVICE_ID_NX2_5706) ||
  81             (hba->pci_did == PCI_DEVICE_ID_NX2_5706S))
  82                 set_bit(BNX2I_NX2_DEV_5706, &hba->cnic_dev_type);
  83         else if ((hba->pci_did == PCI_DEVICE_ID_NX2_5708) ||
  84             (hba->pci_did == PCI_DEVICE_ID_NX2_5708S))
  85                 set_bit(BNX2I_NX2_DEV_5708, &hba->cnic_dev_type);
  86         else if ((hba->pci_did == PCI_DEVICE_ID_NX2_5709) ||
  87             (hba->pci_did == PCI_DEVICE_ID_NX2_5709S)) {
  88                 set_bit(BNX2I_NX2_DEV_5709, &hba->cnic_dev_type);
  89                 hba->mail_queue_access = BNX2I_MQ_BIN_MODE;
  90         } else if (hba->pci_did == PCI_DEVICE_ID_NX2_57710 ||
  91                    hba->pci_did == PCI_DEVICE_ID_NX2_57711 ||
  92                    hba->pci_did == PCI_DEVICE_ID_NX2_57711E)
  93                 set_bit(BNX2I_NX2_DEV_57710, &hba->cnic_dev_type);
  94         else
  95                 printk(KERN_ALERT "bnx2i: unknown device, 0x%x\n",
  96                                   hba->pci_did);
  97 }
  98
  99
 100 /**
 101  * get_adapter_list_head - returns head of adapter list
 102  */
 103 struct bnx2i_hba *get_adapter_list_head(void)
 104 {
 105         struct bnx2i_hba *hba = NULL;
 106         struct bnx2i_hba *tmp_hba;
 107
 108         if (!adapter_count)
 109                 goto hba_not_found;
 110
 111         mutex_lock(&bnx2i_dev_lock);
 112         list_for_each_entry(tmp_hba, &adapter_list, link) {
 113                 if (tmp_hba->cnic && tmp_hba->cnic->cm_select_dev) {
 114                         hba = tmp_hba;
 115                         break;
 116                 }
 117         }
 118         mutex_unlock(&bnx2i_dev_lock);
 119 hba_not_found:
 120         return hba;
 121 }
 122
 123
 124 /**
 125  * bnx2i_find_hba_for_cnic - maps cnic device instance to bnx2i adapter instance
 126  * @cnic:       pointer to cnic device instance
 127  *
 128  */
 129 struct bnx2i_hba *bnx2i_find_hba_for_cnic(struct cnic_dev *cnic)
 130 {
 131         struct bnx2i_hba *hba, *temp;
 132
 133         mutex_lock(&bnx2i_dev_lock);
 134         list_for_each_entry_safe(hba, temp, &adapter_list, link) {
 135                 if (hba->cnic == cnic) {
 136                         mutex_unlock(&bnx2i_dev_lock);
 137                         return hba;
 138                 }
 139         }
 140         mutex_unlock(&bnx2i_dev_lock);
 141         return NULL;
 142 }
 143
 144
 145 /**
 146  * bnx2i_start - cnic callback to initialize & start adapter instance
 147  * @handle:     transparent handle pointing to adapter structure
 148  *
 149  * This function maps adapter structure to pcidev structure and initiates
 150  *      firmware handshake to enable/initialize on chip iscsi components
 151  *      This bnx2i - cnic interface api callback is issued after following
 152  *      2 conditions are met -
 153  *        a) underlying network interface is up (marked by event 'NETDEV_UP'
 154  *              from netdev
 155  *        b) bnx2i adapter instance is registered
 156  */
 157 void bnx2i_start(void *handle)
 158 {
 159 #define BNX2I_INIT_POLL_TIME    (1000 / HZ)
 160         struct bnx2i_hba *hba = handle;
 161         int i = HZ;
 162
 163         bnx2i_send_fw_iscsi_init_msg(hba);
 164         while (!test_bit(ADAPTER_STATE_UP, &hba->adapter_state) && i--)
 165                 msleep(BNX2I_INIT_POLL_TIME);
 166 }
 167
 168
 169 /**
 170  * bnx2i_stop - cnic callback to shutdown adapter instance
 171  * @handle:     transparent handle pointing to adapter structure
 172  *
 173  * driver checks if adapter is already in shutdown mode, if not start
 174  *      the shutdown process
 175  */
 176 void bnx2i_stop(void *handle)
 177 {
 178         struct bnx2i_hba *hba = handle;
 179         struct list_head *pos, *tmp;
 180         struct bnx2i_endpoint *bnx2i_ep;
 181         int conns_active;
 182
 183         /* check if cleanup happened in GOING_DOWN context */
 184         if (!test_and_clear_bit(ADAPTER_STATE_GOING_DOWN,
 185                                 &hba->adapter_state))
 186                 iscsi_host_for_each_session(hba->shost,
 187                                             bnx2i_drop_session);
 188
 189         /* Wait for all endpoints to be torn down, Chip will be reset once
 190          *  control returns to network driver. So it is required to cleanup and
 191          * release all connection resources before returning from this routine.
 192          */
 193         while (hba->ofld_conns_active) {
 194                 conns_active = hba->ofld_conns_active;
 195                 wait_event_interruptible_timeout(hba->eh_wait,
 196                                 (hba->ofld_conns_active != conns_active),
 197                                 hba->hba_shutdown_tmo);
 198                 if (hba->ofld_conns_active == conns_active)
 199                         break;
 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: Wait timeout, force all eps "
 207                         "to disconnect (%d)\n", hba->ofld_conns_active);
 208                 mutex_lock(&hba->net_dev_lock);
 209                 list_for_each_safe(pos, tmp, &hba->ep_active_list) {
 210                         bnx2i_ep = list_entry(pos, struct bnx2i_endpoint, link);
 211                         /* Clean up the chip only */
 212                         bnx2i_hw_ep_disconnect(bnx2i_ep);
 213                 }
 214                 mutex_unlock(&hba->net_dev_lock);
 215                 if (hba->ofld_conns_active)
 216                         printk(KERN_ERR "bnx2i: EP disconnect timeout (%d)!\n",
 217                                 hba->ofld_conns_active);
 218         }
 219
 220         /* This flag should be cleared last so that ep_disconnect() gracefully
 221          * cleans up connection context
 222          */
 223         clear_bit(ADAPTER_STATE_UP, &hba->adapter_state);
 224 }
 225
 226 /**
 227  * bnx2i_register_device - register bnx2i adapter instance with the cnic driver
 228  * @hba:        Adapter instance to register
 229  *
 230  * registers bnx2i adapter instance with the cnic driver while holding the
 231  *      adapter structure lock
 232  */
 233 void bnx2i_register_device(struct bnx2i_hba *hba)
 234 {
 235         int rc;
 236
 237         if (test_bit(ADAPTER_STATE_GOING_DOWN, &hba->adapter_state) ||
 238             test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic)) {
 239                 return;
 240         }
 241
 242         rc = hba->cnic->register_device(hba->cnic, CNIC_ULP_ISCSI, hba);
 243
 244         if (!rc)
 245                 set_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
 246 }
 247
 248
 249 /**
 250  * bnx2i_reg_dev_all - registers all adapter instances with the cnic driver
 251  *
 252  * registers all bnx2i adapter instances with the cnic driver while holding
 253  *      the global resource lock
 254  */
 255 void bnx2i_reg_dev_all(void)
 256 {
 257         struct bnx2i_hba *hba, *temp;
 258
 259         mutex_lock(&bnx2i_dev_lock);
 260         list_for_each_entry_safe(hba, temp, &adapter_list, link)
 261                 bnx2i_register_device(hba);
 262         mutex_unlock(&bnx2i_dev_lock);
 263 }
 264
 265
 266 /**
 267  * bnx2i_unreg_one_device - unregister adapter instance with the cnic driver
 268  * @hba:        Adapter instance to unregister
 269  *
 270  * registers bnx2i adapter instance with the cnic driver while holding
 271  *      the adapter structure lock
 272  */
 273 static void bnx2i_unreg_one_device(struct bnx2i_hba *hba)
 274 {
 275         if (hba->ofld_conns_active ||
 276             !test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic) ||
 277             test_bit(ADAPTER_STATE_GOING_DOWN, &hba->adapter_state))
 278                 return;
 279
 280         hba->cnic->unregister_device(hba->cnic, CNIC_ULP_ISCSI);
 281
 282         /* ep_disconnect could come before NETDEV_DOWN, driver won't
 283          * see NETDEV_DOWN as it already unregistered itself.
 284          */
 285         hba->adapter_state = 0;
 286         clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
 287 }
 288
 289 /**
 290  * bnx2i_unreg_dev_all - unregisters all bnx2i instances with the cnic driver
 291  *
 292  * unregisters all bnx2i adapter instances with the cnic driver while holding
 293  *      the global resource lock
 294  */
 295 void bnx2i_unreg_dev_all(void)
 296 {
 297         struct bnx2i_hba *hba, *temp;
 298
 299         mutex_lock(&bnx2i_dev_lock);
 300         list_for_each_entry_safe(hba, temp, &adapter_list, link)
 301                 bnx2i_unreg_one_device(hba);
 302         mutex_unlock(&bnx2i_dev_lock);
 303 }
 304
 305
 306 /**
 307  * bnx2i_init_one - initialize an adapter instance and allocate memory resources
 308  * @hba:        bnx2i adapter instance
 309  * @cnic:       cnic device handle
 310  *
 311  * Global resource lock is held during critical sections below. This routine is
 312  *      called from either cnic_register_driver() or device hot plug context and
 313  *      and does majority of device specific initialization
 314  */
 315 static int bnx2i_init_one(struct bnx2i_hba *hba, struct cnic_dev *cnic)
 316 {
 317         int rc;
 318
 319         mutex_lock(&bnx2i_dev_lock);
 320         hba->cnic = cnic;
 321         rc = cnic->register_device(cnic, CNIC_ULP_ISCSI, hba);
 322         if (!rc) {
 323                 hba->age++;
 324                 set_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
 325                 list_add_tail(&hba->link, &adapter_list);
 326                 adapter_count++;
 327         } else if (rc == -EBUSY)        /* duplicate registration */
 328                 printk(KERN_ALERT "bnx2i, duplicate registration"
 329                                   "hba=%p, cnic=%p\n", hba, cnic);
 330         else if (rc == -EAGAIN)
 331                 printk(KERN_ERR "bnx2i, driver not registered\n");
 332         else if (rc == -EINVAL)
 333                 printk(KERN_ERR "bnx2i, invalid type %d\n", CNIC_ULP_ISCSI);
 334         else
 335                 printk(KERN_ERR "bnx2i dev reg, unknown error, %d\n", rc);
 336
 337         mutex_unlock(&bnx2i_dev_lock);
 338
 339         return rc;
 340 }
 341
 342
 343 /**
 344  * bnx2i_ulp_init - initialize an adapter instance
 345  * @dev:        cnic device handle
 346  *
 347  * Called from cnic_register_driver() context to initialize all enumerated
 348  *      cnic devices. This routine allocate adapter structure and other
 349  *      device specific resources.
 350  */
 351 void bnx2i_ulp_init(struct cnic_dev *dev)
 352 {
 353         struct bnx2i_hba *hba;
 354
 355         /* Allocate a HBA structure for this device */
 356         hba = bnx2i_alloc_hba(dev);
 357         if (!hba) {
 358                 printk(KERN_ERR "bnx2i init: hba initialization failed\n");
 359                 return;
 360         }
 361
 362         /* Get PCI related information and update hba struct members */
 363         clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
 364         if (bnx2i_init_one(hba, dev)) {
 365                 printk(KERN_ERR "bnx2i - hba %p init failed\n", hba);
 366                 bnx2i_free_hba(hba);
 367         }
 368 }
 369
 370
 371 /**
 372  * bnx2i_ulp_exit - shuts down adapter instance and frees all resources
 373  * @dev:        cnic device handle
 374  *
 375  */
 376 void bnx2i_ulp_exit(struct cnic_dev *dev)
 377 {
 378         struct bnx2i_hba *hba;
 379
 380         hba = bnx2i_find_hba_for_cnic(dev);
 381         if (!hba) {
 382                 printk(KERN_INFO "bnx2i_ulp_exit: hba not "
 383                                  "found, dev 0x%p\n", dev);
 384                 return;
 385         }
 386         mutex_lock(&bnx2i_dev_lock);
 387         list_del_init(&hba->link);
 388         adapter_count--;
 389
 390         if (test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic)) {
 391                 hba->cnic->unregister_device(hba->cnic, CNIC_ULP_ISCSI);
 392                 clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
 393         }
 394         mutex_unlock(&bnx2i_dev_lock);
 395
 396         bnx2i_free_hba(hba);
 397 }
 398
 399
 400 /**
 401  * bnx2i_mod_init - module init entry point
 402  *
 403  * initialize any driver wide global data structures such as endpoint pool,
 404  *      tcp port manager/queue, sysfs. finally driver will register itself
 405  *      with the cnic module
 406  */
 407 static int __init bnx2i_mod_init(void)
 408 {
 409         int err;
 410
 411         printk(KERN_INFO "%s", version);
 412
 413         if (sq_size && !is_power_of_2(sq_size))
 414                 sq_size = roundup_pow_of_two(sq_size);
 415
 416         mutex_init(&bnx2i_dev_lock);
 417
 418         bnx2i_scsi_xport_template =
 419                         iscsi_register_transport(&bnx2i_iscsi_transport);
 420         if (!bnx2i_scsi_xport_template) {
 421                 printk(KERN_ERR "Could not register bnx2i transport.\n");
 422                 err = -ENOMEM;
 423                 goto out;
 424         }
 425
 426         err = cnic_register_driver(CNIC_ULP_ISCSI, &bnx2i_cnic_cb);
 427         if (err) {
 428                 printk(KERN_ERR "Could not register bnx2i cnic driver.\n");
 429                 goto unreg_xport;
 430         }
 431
 432         return 0;
 433
 434 unreg_xport:
 435         iscsi_unregister_transport(&bnx2i_iscsi_transport);
 436 out:
 437         return err;
 438 }
 439
 440
 441 /**
 442  * bnx2i_mod_exit - module cleanup/exit entry point
 443  *
 444  * Global resource lock and host adapter lock is held during critical sections
 445  *      in this function. Driver will browse through the adapter list, cleans-up
 446  *      each instance, unregisters iscsi transport name and finally driver will
 447  *      unregister itself with the cnic module
 448  */
 449 static void __exit bnx2i_mod_exit(void)
 450 {
 451         struct bnx2i_hba *hba;
 452
 453         mutex_lock(&bnx2i_dev_lock);
 454         while (!list_empty(&adapter_list)) {
 455                 hba = list_entry(adapter_list.next, struct bnx2i_hba, link);
 456                 list_del(&hba->link);
 457                 adapter_count--;
 458
 459                 if (test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic)) {
 460                         hba->cnic->unregister_device(hba->cnic, CNIC_ULP_ISCSI);
 461                         clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
 462                 }
 463
 464                 bnx2i_free_hba(hba);
 465         }
 466         mutex_unlock(&bnx2i_dev_lock);
 467
 468         iscsi_unregister_transport(&bnx2i_iscsi_transport);
 469         cnic_unregister_driver(CNIC_ULP_ISCSI);
 470 }
 471
 472 module_init(bnx2i_mod_init);
 473 module_exit(bnx2i_mod_exit);