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
 180         /* check if cleanup happened in GOING_DOWN context */
 181         if (!test_and_clear_bit(ADAPTER_STATE_GOING_DOWN,
 182                                 &hba->adapter_state))
 183                 iscsi_host_for_each_session(hba->shost,
 184                                             bnx2i_drop_session);
 185
 186         /* Wait for all endpoints to be torn down, Chip will be reset once
 187          *  control returns to network driver. So it is required to cleanup and
 188          * release all connection resources before returning from this routine.
 189          */
 190         wait_event_interruptible_timeout(hba->eh_wait,
 191                                          (hba->ofld_conns_active == 0),
 192                                          hba->hba_shutdown_tmo);
 193         /* This flag should be cleared last so that ep_disconnect() gracefully
 194          * cleans up connection context
 195          */
 196         clear_bit(ADAPTER_STATE_UP, &hba->adapter_state);
 197 }
 198
 199 /**
 200  * bnx2i_register_device - register bnx2i adapter instance with the cnic driver
 201  * @hba:        Adapter instance to register
 202  *
 203  * registers bnx2i adapter instance with the cnic driver while holding the
 204  *      adapter structure lock
 205  */
 206 void bnx2i_register_device(struct bnx2i_hba *hba)
 207 {
 208         int rc;
 209
 210         if (test_bit(ADAPTER_STATE_GOING_DOWN, &hba->adapter_state) ||
 211             test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic)) {
 212                 return;
 213         }
 214
 215         rc = hba->cnic->register_device(hba->cnic, CNIC_ULP_ISCSI, hba);
 216
 217         if (!rc)
 218                 set_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
 219 }
 220
 221
 222 /**
 223  * bnx2i_reg_dev_all - registers all adapter instances with the cnic driver
 224  *
 225  * registers all bnx2i adapter instances with the cnic driver while holding
 226  *      the global resource lock
 227  */
 228 void bnx2i_reg_dev_all(void)
 229 {
 230         struct bnx2i_hba *hba, *temp;
 231
 232         mutex_lock(&bnx2i_dev_lock);
 233         list_for_each_entry_safe(hba, temp, &adapter_list, link)
 234                 bnx2i_register_device(hba);
 235         mutex_unlock(&bnx2i_dev_lock);
 236 }
 237
 238
 239 /**
 240  * bnx2i_unreg_one_device - unregister adapter instance with the cnic driver
 241  * @hba:        Adapter instance to unregister
 242  *
 243  * registers bnx2i adapter instance with the cnic driver while holding
 244  *      the adapter structure lock
 245  */
 246 static void bnx2i_unreg_one_device(struct bnx2i_hba *hba)
 247 {
 248         if (hba->ofld_conns_active ||
 249             !test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic) ||
 250             test_bit(ADAPTER_STATE_GOING_DOWN, &hba->adapter_state))
 251                 return;
 252
 253         hba->cnic->unregister_device(hba->cnic, CNIC_ULP_ISCSI);
 254
 255         /* ep_disconnect could come before NETDEV_DOWN, driver won't
 256          * see NETDEV_DOWN as it already unregistered itself.
 257          */
 258         hba->adapter_state = 0;
 259         clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
 260 }
 261
 262 /**
 263  * bnx2i_unreg_dev_all - unregisters all bnx2i instances with the cnic driver
 264  *
 265  * unregisters all bnx2i adapter instances with the cnic driver while holding
 266  *      the global resource lock
 267  */
 268 void bnx2i_unreg_dev_all(void)
 269 {
 270         struct bnx2i_hba *hba, *temp;
 271
 272         mutex_lock(&bnx2i_dev_lock);
 273         list_for_each_entry_safe(hba, temp, &adapter_list, link)
 274                 bnx2i_unreg_one_device(hba);
 275         mutex_unlock(&bnx2i_dev_lock);
 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_mod_init - module init entry point
 375  *
 376  * initialize any driver wide global data structures such as endpoint pool,
 377  *      tcp port manager/queue, sysfs. finally driver will register itself
 378  *      with the cnic module
 379  */
 380 static int __init bnx2i_mod_init(void)
 381 {
 382         int err;
 383
 384         printk(KERN_INFO "%s", version);
 385
 386         if (sq_size && !is_power_of_2(sq_size))
 387                 sq_size = roundup_pow_of_two(sq_size);
 388
 389         mutex_init(&bnx2i_dev_lock);
 390
 391         bnx2i_scsi_xport_template =
 392                         iscsi_register_transport(&bnx2i_iscsi_transport);
 393         if (!bnx2i_scsi_xport_template) {
 394                 printk(KERN_ERR "Could not register bnx2i transport.\n");
 395                 err = -ENOMEM;
 396                 goto out;
 397         }
 398
 399         err = cnic_register_driver(CNIC_ULP_ISCSI, &bnx2i_cnic_cb);
 400         if (err) {
 401                 printk(KERN_ERR "Could not register bnx2i cnic driver.\n");
 402                 goto unreg_xport;
 403         }
 404
 405         return 0;
 406
 407 unreg_xport:
 408         iscsi_unregister_transport(&bnx2i_iscsi_transport);
 409 out:
 410         return err;
 411 }
 412
 413
 414 /**
 415  * bnx2i_mod_exit - module cleanup/exit entry point
 416  *
 417  * Global resource lock and host adapter lock is held during critical sections
 418  *      in this function. Driver will browse through the adapter list, cleans-up
 419  *      each instance, unregisters iscsi transport name and finally driver will
 420  *      unregister itself with the cnic module
 421  */
 422 static void __exit bnx2i_mod_exit(void)
 423 {
 424         struct bnx2i_hba *hba;
 425
 426         mutex_lock(&bnx2i_dev_lock);
 427         while (!list_empty(&adapter_list)) {
 428                 hba = list_entry(adapter_list.next, struct bnx2i_hba, link);
 429                 list_del(&hba->link);
 430                 adapter_count--;
 431
 432                 if (test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic)) {
 433                         hba->cnic->unregister_device(hba->cnic, CNIC_ULP_ISCSI);
 434                         clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
 435                 }
 436
 437                 bnx2i_free_hba(hba);
 438         }
 439         mutex_unlock(&bnx2i_dev_lock);
 440
 441         iscsi_unregister_transport(&bnx2i_iscsi_transport);
 442         cnic_unregister_driver(CNIC_ULP_ISCSI);
 443 }
 444
 445 module_init(bnx2i_mod_init);
 446 module_exit(bnx2i_mod_exit);