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.3"
  21 #define DRV_MODULE_RELDATE      "Aug 10, 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> and "
  29               "Eddie Wai <eddie.wai@broadcom.com>");
  30
  31 MODULE_DESCRIPTION("Broadcom NetXtreme II BCM5706/5708/5709/57710/57711"
  32                    " iSCSI Driver");
  33 MODULE_LICENSE("GPL");
  34 MODULE_VERSION(DRV_MODULE_VERSION);
  35
  36 static DEFINE_MUTEX(bnx2i_dev_lock);
  37
  38 unsigned int event_coal_min = 24;
  39 module_param(event_coal_min, int, 0664);
  40 MODULE_PARM_DESC(event_coal_min, "Event Coalescing Minimum Commands");
  41
  42 unsigned int event_coal_div = 1;
  43 module_param(event_coal_div, int, 0664);
  44 MODULE_PARM_DESC(event_coal_div, "Event Coalescing Divide Factor");
  45
  46 unsigned int en_tcp_dack = 1;
  47 module_param(en_tcp_dack, int, 0664);
  48 MODULE_PARM_DESC(en_tcp_dack, "Enable TCP Delayed ACK");
  49
  50 unsigned int error_mask1 = 0x00;
  51 module_param(error_mask1, int, 0664);
  52 MODULE_PARM_DESC(error_mask1, "Config FW iSCSI Error Mask #1");
  53
  54 unsigned int error_mask2 = 0x00;
  55 module_param(error_mask2, int, 0664);
  56 MODULE_PARM_DESC(error_mask2, "Config FW iSCSI Error Mask #2");
  57
  58 unsigned int sq_size;
  59 module_param(sq_size, int, 0664);
  60 MODULE_PARM_DESC(sq_size, "Configure SQ size");
  61
  62 unsigned int rq_size = BNX2I_RQ_WQES_DEFAULT;
  63 module_param(rq_size, int, 0664);
  64 MODULE_PARM_DESC(rq_size, "Configure RQ size");
  65
  66 u64 iscsi_error_mask = 0x00;
  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_chip_cleanup - local routine to handle chip cleanup
 171  * @hba:        Adapter instance to register
 172  *
 173  * Driver checks if adapter still has any active connections before
 174  *      executing the cleanup process
 175  */
 176 static void bnx2i_chip_cleanup(struct bnx2i_hba *hba)
 177 {
 178         struct bnx2i_endpoint *bnx2i_ep;
 179         struct list_head *pos, *tmp;
 180
 181         if (hba->ofld_conns_active) {
 182                 /* Stage to force the disconnection
 183                  * This is the case where the daemon is either slow or
 184                  * not present
 185                  */
 186                 printk(KERN_ALERT "bnx2i: (%s) chip cleanup for %d active "
 187                         "connections\n", hba->netdev->name,
 188                         hba->ofld_conns_active);
 189                 mutex_lock(&hba->net_dev_lock);
 190                 list_for_each_safe(pos, tmp, &hba->ep_active_list) {
 191                         bnx2i_ep = list_entry(pos, struct bnx2i_endpoint, link);
 192                         /* Clean up the chip only */
 193                         bnx2i_hw_ep_disconnect(bnx2i_ep);
 194                         bnx2i_ep->cm_sk = NULL;
 195                 }
 196                 mutex_unlock(&hba->net_dev_lock);
 197         }
 198 }
 199
 200
 201 /**
 202  * bnx2i_stop - cnic callback to shutdown adapter instance
 203  * @handle:     transparent handle pointing to adapter structure
 204  *
 205  * driver checks if adapter is already in shutdown mode, if not start
 206  *      the shutdown process
 207  */
 208 void bnx2i_stop(void *handle)
 209 {
 210         struct bnx2i_hba *hba = handle;
 211         int conns_active;
 212
 213         /* check if cleanup happened in GOING_DOWN context */
 214         if (!test_and_clear_bit(ADAPTER_STATE_GOING_DOWN,
 215                                 &hba->adapter_state))
 216                 iscsi_host_for_each_session(hba->shost,
 217                                             bnx2i_drop_session);
 218
 219         /* Wait for all endpoints to be torn down, Chip will be reset once
 220          *  control returns to network driver. So it is required to cleanup and
 221          * release all connection resources before returning from this routine.
 222          */
 223         while (hba->ofld_conns_active) {
 224                 conns_active = hba->ofld_conns_active;
 225                 wait_event_interruptible_timeout(hba->eh_wait,
 226                                 (hba->ofld_conns_active != conns_active),
 227                                 hba->hba_shutdown_tmo);
 228                 if (hba->ofld_conns_active == conns_active)
 229                         break;
 230         }
 231         bnx2i_chip_cleanup(hba);
 232
 233         /* This flag should be cleared last so that ep_disconnect() gracefully
 234          * cleans up connection context
 235          */
 236         clear_bit(ADAPTER_STATE_UP, &hba->adapter_state);
 237 }
 238
 239 /**
 240  * bnx2i_init_one - initialize an adapter instance and allocate memory resources
 241  * @hba:        bnx2i adapter instance
 242  * @cnic:       cnic device handle
 243  *
 244  * Global resource lock is held during critical sections below. This routine is
 245  *      called from either cnic_register_driver() or device hot plug context and
 246  *      and does majority of device specific initialization
 247  */
 248 static int bnx2i_init_one(struct bnx2i_hba *hba, struct cnic_dev *cnic)
 249 {
 250         int rc;
 251
 252         mutex_lock(&bnx2i_dev_lock);
 253         hba->cnic = cnic;
 254         rc = cnic->register_device(cnic, CNIC_ULP_ISCSI, hba);
 255         if (!rc) {
 256                 hba->age++;
 257                 set_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
 258                 list_add_tail(&hba->link, &adapter_list);
 259                 adapter_count++;
 260         } else if (rc == -EBUSY)        /* duplicate registration */
 261                 printk(KERN_ALERT "bnx2i, duplicate registration"
 262                                   "hba=%p, cnic=%p\n", hba, cnic);
 263         else if (rc == -EAGAIN)
 264                 printk(KERN_ERR "bnx2i, driver not registered\n");
 265         else if (rc == -EINVAL)
 266                 printk(KERN_ERR "bnx2i, invalid type %d\n", CNIC_ULP_ISCSI);
 267         else
 268                 printk(KERN_ERR "bnx2i dev reg, unknown error, %d\n", rc);
 269
 270         mutex_unlock(&bnx2i_dev_lock);
 271
 272         return rc;
 273 }
 274
 275
 276 /**
 277  * bnx2i_ulp_init - initialize an adapter instance
 278  * @dev:        cnic device handle
 279  *
 280  * Called from cnic_register_driver() context to initialize all enumerated
 281  *      cnic devices. This routine allocate adapter structure and other
 282  *      device specific resources.
 283  */
 284 void bnx2i_ulp_init(struct cnic_dev *dev)
 285 {
 286         struct bnx2i_hba *hba;
 287
 288         /* Allocate a HBA structure for this device */
 289         hba = bnx2i_alloc_hba(dev);
 290         if (!hba) {
 291                 printk(KERN_ERR "bnx2i init: hba initialization failed\n");
 292                 return;
 293         }
 294
 295         /* Get PCI related information and update hba struct members */
 296         clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
 297         if (bnx2i_init_one(hba, dev)) {
 298                 printk(KERN_ERR "bnx2i - hba %p init failed\n", hba);
 299                 bnx2i_free_hba(hba);
 300         }
 301 }
 302
 303
 304 /**
 305  * bnx2i_ulp_exit - shuts down adapter instance and frees all resources
 306  * @dev:        cnic device handle
 307  *
 308  */
 309 void bnx2i_ulp_exit(struct cnic_dev *dev)
 310 {
 311         struct bnx2i_hba *hba;
 312
 313         hba = bnx2i_find_hba_for_cnic(dev);
 314         if (!hba) {
 315                 printk(KERN_INFO "bnx2i_ulp_exit: hba not "
 316                                  "found, dev 0x%p\n", dev);
 317                 return;
 318         }
 319         mutex_lock(&bnx2i_dev_lock);
 320         list_del_init(&hba->link);
 321         adapter_count--;
 322
 323         if (test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic)) {
 324                 hba->cnic->unregister_device(hba->cnic, CNIC_ULP_ISCSI);
 325                 clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
 326         }
 327         mutex_unlock(&bnx2i_dev_lock);
 328
 329         bnx2i_free_hba(hba);
 330 }
 331
 332
 333 /**
 334  * bnx2i_mod_init - module init entry point
 335  *
 336  * initialize any driver wide global data structures such as endpoint pool,
 337  *      tcp port manager/queue, sysfs. finally driver will register itself
 338  *      with the cnic module
 339  */
 340 static int __init bnx2i_mod_init(void)
 341 {
 342         int err;
 343
 344         printk(KERN_INFO "%s", version);
 345
 346         if (sq_size && !is_power_of_2(sq_size))
 347                 sq_size = roundup_pow_of_two(sq_size);
 348
 349         mutex_init(&bnx2i_dev_lock);
 350
 351         bnx2i_scsi_xport_template =
 352                         iscsi_register_transport(&bnx2i_iscsi_transport);
 353         if (!bnx2i_scsi_xport_template) {
 354                 printk(KERN_ERR "Could not register bnx2i transport.\n");
 355                 err = -ENOMEM;
 356                 goto out;
 357         }
 358
 359         err = cnic_register_driver(CNIC_ULP_ISCSI, &bnx2i_cnic_cb);
 360         if (err) {
 361                 printk(KERN_ERR "Could not register bnx2i cnic driver.\n");
 362                 goto unreg_xport;
 363         }
 364
 365         return 0;
 366
 367 unreg_xport:
 368         iscsi_unregister_transport(&bnx2i_iscsi_transport);
 369 out:
 370         return err;
 371 }
 372
 373
 374 /**
 375  * bnx2i_mod_exit - module cleanup/exit entry point
 376  *
 377  * Global resource lock and host adapter lock is held during critical sections
 378  *      in this function. Driver will browse through the adapter list, cleans-up
 379  *      each instance, unregisters iscsi transport name and finally driver will
 380  *      unregister itself with the cnic module
 381  */
 382 static void __exit bnx2i_mod_exit(void)
 383 {
 384         struct bnx2i_hba *hba;
 385
 386         mutex_lock(&bnx2i_dev_lock);
 387         while (!list_empty(&adapter_list)) {
 388                 hba = list_entry(adapter_list.next, struct bnx2i_hba, link);
 389                 list_del(&hba->link);
 390                 adapter_count--;
 391
 392                 if (test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic)) {
 393                         bnx2i_chip_cleanup(hba);
 394                         hba->cnic->unregister_device(hba->cnic, CNIC_ULP_ISCSI);
 395                         clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
 396                 }
 397
 398                 bnx2i_free_hba(hba);
 399         }
 400         mutex_unlock(&bnx2i_dev_lock);
 401
 402         iscsi_unregister_transport(&bnx2i_iscsi_transport);
 403         cnic_unregister_driver(CNIC_ULP_ISCSI);
 404 }
 405
 406 module_init(bnx2i_mod_init);
 407 module_exit(bnx2i_mod_exit);