drivers/s390/scsi/zfcp_aux.c

   1 /*
   2  * zfcp device driver
   3  *
   4  * Module interface and handling of zfcp data structures.
   5  *
   6  * Copyright IBM Corp. 2002, 2010
   7  */
   8
   9 /*
  10  * Driver authors:
  11  *            Martin Peschke (originator of the driver)
  12  *            Raimund Schroeder
  13  *            Aron Zeh
  14  *            Wolfgang Taphorn
  15  *            Stefan Bader
  16  *            Heiko Carstens (kernel 2.6 port of the driver)
  17  *            Andreas Herrmann
  18  *            Maxim Shchetynin
  19  *            Volker Sameske
  20  *            Ralph Wuerthner
  21  *            Michael Loehr
  22  *            Swen Schillig
  23  *            Christof Schmitt
  24  *            Martin Petermann
  25  *            Sven Schuetz
  26  */
  27
  28 #define KMSG_COMPONENT "zfcp"
  29 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
  30
  31 #include <linux/miscdevice.h>
  32 #include <linux/seq_file.h>
  33 #include <linux/slab.h>
  34 #include <linux/module.h>
  35 #include "zfcp_ext.h"
  36 #include "zfcp_fc.h"
  37 #include "zfcp_reqlist.h"
  38
  39 #define ZFCP_BUS_ID_SIZE        20
  40
  41 MODULE_AUTHOR("IBM Deutschland Entwicklung GmbH - linux390@de.ibm.com");
  42 MODULE_DESCRIPTION("FCP HBA driver");
  43 MODULE_LICENSE("GPL");
  44
  45 static char *init_device;
  46 module_param_named(device, init_device, charp, 0400);
  47 MODULE_PARM_DESC(device, "specify initial device");
  48
  49 static struct kmem_cache * __init zfcp_cache_hw_align(const char *name,
  50                                                       unsigned long size)
  51 {
  52         return kmem_cache_create(name, size, roundup_pow_of_two(size), 0, NULL);
  53 }
  54
  55 static void __init zfcp_init_device_configure(char *busid, u64 wwpn, u64 lun)
  56 {
  57         struct ccw_device *cdev;
  58         struct zfcp_adapter *adapter;
  59         struct zfcp_port *port;
  60
  61         cdev = get_ccwdev_by_busid(&zfcp_ccw_driver, busid);
  62         if (!cdev)
  63                 return;
  64
  65         if (ccw_device_set_online(cdev))
  66                 goto out_ccw_device;
  67
  68         adapter = zfcp_ccw_adapter_by_cdev(cdev);
  69         if (!adapter)
  70                 goto out_ccw_device;
  71
  72         port = zfcp_get_port_by_wwpn(adapter, wwpn);
  73         if (!port)
  74                 goto out_port;
  75         flush_work(&port->rport_work);
  76
  77         zfcp_unit_add(port, lun);
  78         put_device(&port->dev);
  79
  80 out_port:
  81         zfcp_ccw_adapter_put(adapter);
  82 out_ccw_device:
  83         put_device(&cdev->dev);
  84         return;
  85 }
  86
  87 static void __init zfcp_init_device_setup(char *devstr)
  88 {
  89         char *token;
  90         char *str, *str_saved;
  91         char busid[ZFCP_BUS_ID_SIZE];
  92         u64 wwpn, lun;
  93
  94         /* duplicate devstr and keep the original for sysfs presentation*/
  95         str_saved = kstrdup(devstr, GFP_KERNEL);
  96         str = str_saved;
  97         if (!str)
  98                 return;
  99
 100         token = strsep(&str, ",");
 101         if (!token || strlen(token) >= ZFCP_BUS_ID_SIZE)
 102                 goto err_out;
 103         strncpy(busid, token, ZFCP_BUS_ID_SIZE);
 104
 105         token = strsep(&str, ",");
 106         if (!token || strict_strtoull(token, 0, (unsigned long long *) &wwpn))
 107                 goto err_out;
 108
 109         token = strsep(&str, ",");
 110         if (!token || strict_strtoull(token, 0, (unsigned long long *) &lun))
 111                 goto err_out;
 112
 113         kfree(str_saved);
 114         zfcp_init_device_configure(busid, wwpn, lun);
 115         return;
 116
 117 err_out:
 118         kfree(str_saved);
 119         pr_err("%s is not a valid SCSI device\n", devstr);
 120 }
 121
 122 static int __init zfcp_module_init(void)
 123 {
 124         int retval = -ENOMEM;
 125
 126         zfcp_fsf_qtcb_cache = zfcp_cache_hw_align("zfcp_fsf_qtcb",
 127                                                   sizeof(struct fsf_qtcb));
 128         if (!zfcp_fsf_qtcb_cache)
 129                 goto out_qtcb_cache;
 130
 131         zfcp_fc_req_cache = zfcp_cache_hw_align("zfcp_fc_req",
 132                                                 sizeof(struct zfcp_fc_req));
 133         if (!zfcp_fc_req_cache)
 134                 goto out_fc_cache;
 135
 136         zfcp_scsi_transport_template =
 137                 fc_attach_transport(&zfcp_transport_functions);
 138         if (!zfcp_scsi_transport_template)
 139                 goto out_transport;
 140         scsi_transport_reserve_device(zfcp_scsi_transport_template,
 141                                       sizeof(struct zfcp_scsi_dev));
 142
 143
 144         retval = misc_register(&zfcp_cfdc_misc);
 145         if (retval) {
 146                 pr_err("Registering the misc device zfcp_cfdc failed\n");
 147                 goto out_misc;
 148         }
 149
 150         retval = ccw_driver_register(&zfcp_ccw_driver);
 151         if (retval) {
 152                 pr_err("The zfcp device driver could not register with "
 153                        "the common I/O layer\n");
 154                 goto out_ccw_register;
 155         }
 156
 157         if (init_device)
 158                 zfcp_init_device_setup(init_device);
 159         return 0;
 160
 161 out_ccw_register:
 162         misc_deregister(&zfcp_cfdc_misc);
 163 out_misc:
 164         fc_release_transport(zfcp_scsi_transport_template);
 165 out_transport:
 166         kmem_cache_destroy(zfcp_fc_req_cache);
 167 out_fc_cache:
 168         kmem_cache_destroy(zfcp_fsf_qtcb_cache);
 169 out_qtcb_cache:
 170         return retval;
 171 }
 172
 173 module_init(zfcp_module_init);
 174
 175 static void __exit zfcp_module_exit(void)
 176 {
 177         ccw_driver_unregister(&zfcp_ccw_driver);
 178         misc_deregister(&zfcp_cfdc_misc);
 179         fc_release_transport(zfcp_scsi_transport_template);
 180         kmem_cache_destroy(zfcp_fc_req_cache);
 181         kmem_cache_destroy(zfcp_fsf_qtcb_cache);
 182 }
 183
 184 module_exit(zfcp_module_exit);
 185
 186 /**
 187  * zfcp_get_port_by_wwpn - find port in port list of adapter by wwpn
 188  * @adapter: pointer to adapter to search for port
 189  * @wwpn: wwpn to search for
 190  *
 191  * Returns: pointer to zfcp_port or NULL
 192  */
 193 struct zfcp_port *zfcp_get_port_by_wwpn(struct zfcp_adapter *adapter,
 194                                         u64 wwpn)
 195 {
 196         unsigned long flags;
 197         struct zfcp_port *port;
 198
 199         read_lock_irqsave(&adapter->port_list_lock, flags);
 200         list_for_each_entry(port, &adapter->port_list, list)
 201                 if (port->wwpn == wwpn) {
 202                         if (!get_device(&port->dev))
 203                                 port = NULL;
 204                         read_unlock_irqrestore(&adapter->port_list_lock, flags);
 205                         return port;
 206                 }
 207         read_unlock_irqrestore(&adapter->port_list_lock, flags);
 208         return NULL;
 209 }
 210
 211 static int zfcp_allocate_low_mem_buffers(struct zfcp_adapter *adapter)
 212 {
 213         adapter->pool.erp_req =
 214                 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
 215         if (!adapter->pool.erp_req)
 216                 return -ENOMEM;
 217
 218         adapter->pool.gid_pn_req =
 219                 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
 220         if (!adapter->pool.gid_pn_req)
 221                 return -ENOMEM;
 222
 223         adapter->pool.scsi_req =
 224                 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
 225         if (!adapter->pool.scsi_req)
 226                 return -ENOMEM;
 227
 228         adapter->pool.scsi_abort =
 229                 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
 230         if (!adapter->pool.scsi_abort)
 231                 return -ENOMEM;
 232
 233         adapter->pool.status_read_req =
 234                 mempool_create_kmalloc_pool(FSF_STATUS_READS_RECOM,
 235                                             sizeof(struct zfcp_fsf_req));
 236         if (!adapter->pool.status_read_req)
 237                 return -ENOMEM;
 238
 239         adapter->pool.qtcb_pool =
 240                 mempool_create_slab_pool(4, zfcp_fsf_qtcb_cache);
 241         if (!adapter->pool.qtcb_pool)
 242                 return -ENOMEM;
 243
 244         BUILD_BUG_ON(sizeof(struct fsf_status_read_buffer) > PAGE_SIZE);
 245         adapter->pool.sr_data =
 246                 mempool_create_page_pool(FSF_STATUS_READS_RECOM, 0);
 247         if (!adapter->pool.sr_data)
 248                 return -ENOMEM;
 249
 250         adapter->pool.gid_pn =
 251                 mempool_create_slab_pool(1, zfcp_fc_req_cache);
 252         if (!adapter->pool.gid_pn)
 253                 return -ENOMEM;
 254
 255         return 0;
 256 }
 257
 258 static void zfcp_free_low_mem_buffers(struct zfcp_adapter *adapter)
 259 {
 260         if (adapter->pool.erp_req)
 261                 mempool_destroy(adapter->pool.erp_req);
 262         if (adapter->pool.scsi_req)
 263                 mempool_destroy(adapter->pool.scsi_req);
 264         if (adapter->pool.scsi_abort)
 265                 mempool_destroy(adapter->pool.scsi_abort);
 266         if (adapter->pool.qtcb_pool)
 267                 mempool_destroy(adapter->pool.qtcb_pool);
 268         if (adapter->pool.status_read_req)
 269                 mempool_destroy(adapter->pool.status_read_req);
 270         if (adapter->pool.sr_data)
 271                 mempool_destroy(adapter->pool.sr_data);
 272         if (adapter->pool.gid_pn)
 273                 mempool_destroy(adapter->pool.gid_pn);
 274 }
 275
 276 /**
 277  * zfcp_status_read_refill - refill the long running status_read_requests
 278  * @adapter: ptr to struct zfcp_adapter for which the buffers should be refilled
 279  *
 280  * Returns: 0 on success, 1 otherwise
 281  *
 282  * if there are 16 or more status_read requests missing an adapter_reopen
 283  * is triggered
 284  */
 285 int zfcp_status_read_refill(struct zfcp_adapter *adapter)
 286 {
 287         while (atomic_read(&adapter->stat_miss) > 0)
 288                 if (zfcp_fsf_status_read(adapter->qdio)) {
 289                         if (atomic_read(&adapter->stat_miss) >=
 290                             adapter->stat_read_buf_num) {
 291                                 zfcp_erp_adapter_reopen(adapter, 0, "axsref1");
 292                                 return 1;
 293                         }
 294                         break;
 295                 } else
 296                         atomic_dec(&adapter->stat_miss);
 297         return 0;
 298 }
 299
 300 static void _zfcp_status_read_scheduler(struct work_struct *work)
 301 {
 302         zfcp_status_read_refill(container_of(work, struct zfcp_adapter,
 303                                              stat_work));
 304 }
 305
 306 static void zfcp_print_sl(struct seq_file *m, struct service_level *sl)
 307 {
 308         struct zfcp_adapter *adapter =
 309                 container_of(sl, struct zfcp_adapter, service_level);
 310
 311         seq_printf(m, "zfcp: %s microcode level %x\n",
 312                    dev_name(&adapter->ccw_device->dev),
 313                    adapter->fsf_lic_version);
 314 }
 315
 316 static int zfcp_setup_adapter_work_queue(struct zfcp_adapter *adapter)
 317 {
 318         char name[TASK_COMM_LEN];
 319
 320         snprintf(name, sizeof(name), "zfcp_q_%s",
 321                  dev_name(&adapter->ccw_device->dev));
 322         adapter->work_queue = create_singlethread_workqueue(name);
 323
 324         if (adapter->work_queue)
 325                 return 0;
 326         return -ENOMEM;
 327 }
 328
 329 static void zfcp_destroy_adapter_work_queue(struct zfcp_adapter *adapter)
 330 {
 331         if (adapter->work_queue)
 332                 destroy_workqueue(adapter->work_queue);
 333         adapter->work_queue = NULL;
 334
 335 }
 336
 337 /**
 338  * zfcp_adapter_enqueue - enqueue a new adapter to the list
 339  * @ccw_device: pointer to the struct cc_device
 340  *
 341  * Returns:     struct zfcp_adapter*
 342  * Enqueues an adapter at the end of the adapter list in the driver data.
 343  * All adapter internal structures are set up.
 344  * Proc-fs entries are also created.
 345  */
 346 struct zfcp_adapter *zfcp_adapter_enqueue(struct ccw_device *ccw_device)
 347 {
 348         struct zfcp_adapter *adapter;
 349
 350         if (!get_device(&ccw_device->dev))
 351                 return ERR_PTR(-ENODEV);
 352
 353         adapter = kzalloc(sizeof(struct zfcp_adapter), GFP_KERNEL);
 354         if (!adapter) {
 355                 put_device(&ccw_device->dev);
 356                 return ERR_PTR(-ENOMEM);
 357         }
 358
 359         kref_init(&adapter->ref);
 360
 361         ccw_device->handler = NULL;
 362         adapter->ccw_device = ccw_device;
 363
 364         INIT_WORK(&adapter->stat_work, _zfcp_status_read_scheduler);
 365         INIT_WORK(&adapter->scan_work, zfcp_fc_scan_ports);
 366         INIT_WORK(&adapter->ns_up_work, zfcp_fc_sym_name_update);
 367
 368         if (zfcp_qdio_setup(adapter))
 369                 goto failed;
 370
 371         if (zfcp_allocate_low_mem_buffers(adapter))
 372                 goto failed;
 373
 374         adapter->req_list = zfcp_reqlist_alloc();
 375         if (!adapter->req_list)
 376                 goto failed;
 377
 378         if (zfcp_dbf_adapter_register(adapter))
 379                 goto failed;
 380
 381         if (zfcp_setup_adapter_work_queue(adapter))
 382                 goto failed;
 383
 384         if (zfcp_fc_gs_setup(adapter))
 385                 goto failed;
 386
 387         rwlock_init(&adapter->port_list_lock);
 388         INIT_LIST_HEAD(&adapter->port_list);
 389
 390         INIT_LIST_HEAD(&adapter->events.list);
 391         INIT_WORK(&adapter->events.work, zfcp_fc_post_event);
 392         spin_lock_init(&adapter->events.list_lock);
 393
 394         init_waitqueue_head(&adapter->erp_ready_wq);
 395         init_waitqueue_head(&adapter->erp_done_wqh);
 396
 397         INIT_LIST_HEAD(&adapter->erp_ready_head);
 398         INIT_LIST_HEAD(&adapter->erp_running_head);
 399
 400         rwlock_init(&adapter->erp_lock);
 401         rwlock_init(&adapter->abort_lock);
 402
 403         if (zfcp_erp_thread_setup(adapter))
 404                 goto failed;
 405
 406         adapter->service_level.seq_print = zfcp_print_sl;
 407
 408         dev_set_drvdata(&ccw_device->dev, adapter);
 409
 410         if (sysfs_create_group(&ccw_device->dev.kobj,
 411                                &zfcp_sysfs_adapter_attrs))
 412                 goto failed;
 413
 414         /* report size limit per scatter-gather segment */
 415         adapter->dma_parms.max_segment_size = ZFCP_QDIO_SBALE_LEN;
 416         adapter->ccw_device->dev.dma_parms = &adapter->dma_parms;
 417
 418         if (!zfcp_scsi_adapter_register(adapter))
 419                 return adapter;
 420
 421 failed:
 422         zfcp_adapter_unregister(adapter);
 423         return ERR_PTR(-ENOMEM);
 424 }
 425
 426 void zfcp_adapter_unregister(struct zfcp_adapter *adapter)
 427 {
 428         struct ccw_device *cdev = adapter->ccw_device;
 429
 430         cancel_work_sync(&adapter->scan_work);
 431         cancel_work_sync(&adapter->stat_work);
 432         cancel_work_sync(&adapter->ns_up_work);
 433         zfcp_destroy_adapter_work_queue(adapter);
 434
 435         zfcp_fc_wka_ports_force_offline(adapter->gs);
 436         zfcp_scsi_adapter_unregister(adapter);
 437         sysfs_remove_group(&cdev->dev.kobj, &zfcp_sysfs_adapter_attrs);
 438
 439         zfcp_erp_thread_kill(adapter);
 440         zfcp_dbf_adapter_unregister(adapter);
 441         zfcp_qdio_destroy(adapter->qdio);
 442
 443         zfcp_ccw_adapter_put(adapter); /* final put to release */
 444 }
 445
 446 /**
 447  * zfcp_adapter_release - remove the adapter from the resource list
 448  * @ref: pointer to struct kref
 449  * locks:       adapter list write lock is assumed to be held by caller
 450  */
 451 void zfcp_adapter_release(struct kref *ref)
 452 {
 453         struct zfcp_adapter *adapter = container_of(ref, struct zfcp_adapter,
 454                                                     ref);
 455         struct ccw_device *cdev = adapter->ccw_device;
 456
 457         dev_set_drvdata(&adapter->ccw_device->dev, NULL);
 458         zfcp_fc_gs_destroy(adapter);
 459         zfcp_free_low_mem_buffers(adapter);
 460         kfree(adapter->req_list);
 461         kfree(adapter->fc_stats);
 462         kfree(adapter->stats_reset_data);
 463         kfree(adapter);
 464         put_device(&cdev->dev);
 465 }
 466
 467 /**
 468  * zfcp_device_unregister - remove port, unit from system
 469  * @dev: reference to device which is to be removed
 470  * @grp: related reference to attribute group
 471  *
 472  * Helper function to unregister port, unit from system
 473  */
 474 void zfcp_device_unregister(struct device *dev,
 475                             const struct attribute_group *grp)
 476 {
 477         sysfs_remove_group(&dev->kobj, grp);
 478         device_unregister(dev);
 479 }
 480
 481 static void zfcp_port_release(struct device *dev)
 482 {
 483         struct zfcp_port *port = container_of(dev, struct zfcp_port, dev);
 484
 485         zfcp_ccw_adapter_put(port->adapter);
 486         kfree(port);
 487 }
 488
 489 /**
 490  * zfcp_port_enqueue - enqueue port to port list of adapter
 491  * @adapter: adapter where remote port is added
 492  * @wwpn: WWPN of the remote port to be enqueued
 493  * @status: initial status for the port
 494  * @d_id: destination id of the remote port to be enqueued
 495  * Returns: pointer to enqueued port on success, ERR_PTR on error
 496  *
 497  * All port internal structures are set up and the sysfs entry is generated.
 498  * d_id is used to enqueue ports with a well known address like the Directory
 499  * Service for nameserver lookup.
 500  */
 501 struct zfcp_port *zfcp_port_enqueue(struct zfcp_adapter *adapter, u64 wwpn,
 502                                      u32 status, u32 d_id)
 503 {
 504         struct zfcp_port *port;
 505         int retval = -ENOMEM;
 506
 507         kref_get(&adapter->ref);
 508
 509         port = zfcp_get_port_by_wwpn(adapter, wwpn);
 510         if (port) {
 511                 put_device(&port->dev);
 512                 retval = -EEXIST;
 513                 goto err_out;
 514         }
 515
 516         port = kzalloc(sizeof(struct zfcp_port), GFP_KERNEL);
 517         if (!port)
 518                 goto err_out;
 519
 520         rwlock_init(&port->unit_list_lock);
 521         INIT_LIST_HEAD(&port->unit_list);
 522         atomic_set(&port->units, 0);
 523
 524         INIT_WORK(&port->gid_pn_work, zfcp_fc_port_did_lookup);
 525         INIT_WORK(&port->test_link_work, zfcp_fc_link_test_work);
 526         INIT_WORK(&port->rport_work, zfcp_scsi_rport_work);
 527
 528         port->adapter = adapter;
 529         port->d_id = d_id;
 530         port->wwpn = wwpn;
 531         port->rport_task = RPORT_NONE;
 532         port->dev.parent = &adapter->ccw_device->dev;
 533         port->dev.release = zfcp_port_release;
 534
 535         if (dev_set_name(&port->dev, "0x%016llx", (unsigned long long)wwpn)) {
 536                 kfree(port);
 537                 goto err_out;
 538         }
 539         retval = -EINVAL;
 540
 541         if (device_register(&port->dev)) {
 542                 put_device(&port->dev);
 543                 goto err_out;
 544         }
 545
 546         if (sysfs_create_group(&port->dev.kobj,
 547                                &zfcp_sysfs_port_attrs))
 548                 goto err_out_put;
 549
 550         write_lock_irq(&adapter->port_list_lock);
 551         list_add_tail(&port->list, &adapter->port_list);
 552         write_unlock_irq(&adapter->port_list_lock);
 553
 554         atomic_set_mask(status | ZFCP_STATUS_COMMON_RUNNING, &port->status);
 555
 556         return port;
 557
 558 err_out_put:
 559         device_unregister(&port->dev);
 560 err_out:
 561         zfcp_ccw_adapter_put(adapter);
 562         return ERR_PTR(retval);
 563 }
 564
 565 /**
 566  * zfcp_sg_free_table - free memory used by scatterlists
 567  * @sg: pointer to scatterlist
 568  * @count: number of scatterlist which are to be free'ed
 569  * the scatterlist are expected to reference pages always
 570  */
 571 void zfcp_sg_free_table(struct scatterlist *sg, int count)
 572 {
 573         int i;
 574
 575         for (i = 0; i < count; i++, sg++)
 576                 if (sg)
 577                         free_page((unsigned long) sg_virt(sg));
 578                 else
 579                         break;
 580 }
 581
 582 /**
 583  * zfcp_sg_setup_table - init scatterlist and allocate, assign buffers
 584  * @sg: pointer to struct scatterlist
 585  * @count: number of scatterlists which should be assigned with buffers
 586  * of size page
 587  *
 588  * Returns: 0 on success, -ENOMEM otherwise
 589  */
 590 int zfcp_sg_setup_table(struct scatterlist *sg, int count)
 591 {
 592         void *addr;
 593         int i;
 594
 595         sg_init_table(sg, count);
 596         for (i = 0; i < count; i++, sg++) {
 597                 addr = (void *) get_zeroed_page(GFP_KERNEL);
 598                 if (!addr) {
 599                         zfcp_sg_free_table(sg, i);
 600                         return -ENOMEM;
 601                 }
 602                 sg_set_buf(sg, addr, PAGE_SIZE);
 603         }
 604         return 0;
 605 }