1 /* 2 * zfcp device driver 3 * 4 * Module interface and handling of zfcp data structures. 5 * 6 * Copyright IBM Corp. 2002, 2013 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 * Steffen Maier 27 */ 28 29 #define KMSG_COMPONENT "zfcp" 30 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt 31 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 || kstrtoull(token, 0, (unsigned long long *) &wwpn)) 107 goto err_out; 108 109 token = strsep(&str, ","); 110 if (!token || kstrtoull(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 retval = ccw_driver_register(&zfcp_ccw_driver); 144 if (retval) { 145 pr_err("The zfcp device driver could not register with " 146 "the common I/O layer\n"); 147 goto out_ccw_register; 148 } 149 150 if (init_device) 151 zfcp_init_device_setup(init_device); 152 return 0; 153 154 out_ccw_register: 155 fc_release_transport(zfcp_scsi_transport_template); 156 out_transport: 157 kmem_cache_destroy(zfcp_fc_req_cache); 158 out_fc_cache: 159 kmem_cache_destroy(zfcp_fsf_qtcb_cache); 160 out_qtcb_cache: 161 return retval; 162 } 163 164 module_init(zfcp_module_init); 165 166 static void __exit zfcp_module_exit(void) 167 { 168 ccw_driver_unregister(&zfcp_ccw_driver); 169 fc_release_transport(zfcp_scsi_transport_template); 170 kmem_cache_destroy(zfcp_fc_req_cache); 171 kmem_cache_destroy(zfcp_fsf_qtcb_cache); 172 } 173 174 module_exit(zfcp_module_exit); 175 176 /** 177 * zfcp_get_port_by_wwpn - find port in port list of adapter by wwpn 178 * @adapter: pointer to adapter to search for port 179 * @wwpn: wwpn to search for 180 * 181 * Returns: pointer to zfcp_port or NULL 182 */ 183 struct zfcp_port *zfcp_get_port_by_wwpn(struct zfcp_adapter *adapter, 184 u64 wwpn) 185 { 186 unsigned long flags; 187 struct zfcp_port *port; 188 189 read_lock_irqsave(&adapter->port_list_lock, flags); 190 list_for_each_entry(port, &adapter->port_list, list) 191 if (port->wwpn == wwpn) { 192 if (!get_device(&port->dev)) 193 port = NULL; 194 read_unlock_irqrestore(&adapter->port_list_lock, flags); 195 return port; 196 } 197 read_unlock_irqrestore(&adapter->port_list_lock, flags); 198 return NULL; 199 } 200 201 static int zfcp_allocate_low_mem_buffers(struct zfcp_adapter *adapter) 202 { 203 adapter->pool.erp_req = 204 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req)); 205 if (!adapter->pool.erp_req) 206 return -ENOMEM; 207 208 adapter->pool.gid_pn_req = 209 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req)); 210 if (!adapter->pool.gid_pn_req) 211 return -ENOMEM; 212 213 adapter->pool.scsi_req = 214 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req)); 215 if (!adapter->pool.scsi_req) 216 return -ENOMEM; 217 218 adapter->pool.scsi_abort = 219 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req)); 220 if (!adapter->pool.scsi_abort) 221 return -ENOMEM; 222 223 adapter->pool.status_read_req = 224 mempool_create_kmalloc_pool(FSF_STATUS_READS_RECOM, 225 sizeof(struct zfcp_fsf_req)); 226 if (!adapter->pool.status_read_req) 227 return -ENOMEM; 228 229 adapter->pool.qtcb_pool = 230 mempool_create_slab_pool(4, zfcp_fsf_qtcb_cache); 231 if (!adapter->pool.qtcb_pool) 232 return -ENOMEM; 233 234 BUILD_BUG_ON(sizeof(struct fsf_status_read_buffer) > PAGE_SIZE); 235 adapter->pool.sr_data = 236 mempool_create_page_pool(FSF_STATUS_READS_RECOM, 0); 237 if (!adapter->pool.sr_data) 238 return -ENOMEM; 239 240 adapter->pool.gid_pn = 241 mempool_create_slab_pool(1, zfcp_fc_req_cache); 242 if (!adapter->pool.gid_pn) 243 return -ENOMEM; 244 245 return 0; 246 } 247 248 static void zfcp_free_low_mem_buffers(struct zfcp_adapter *adapter) 249 { 250 if (adapter->pool.erp_req) 251 mempool_destroy(adapter->pool.erp_req); 252 if (adapter->pool.scsi_req) 253 mempool_destroy(adapter->pool.scsi_req); 254 if (adapter->pool.scsi_abort) 255 mempool_destroy(adapter->pool.scsi_abort); 256 if (adapter->pool.qtcb_pool) 257 mempool_destroy(adapter->pool.qtcb_pool); 258 if (adapter->pool.status_read_req) 259 mempool_destroy(adapter->pool.status_read_req); 260 if (adapter->pool.sr_data) 261 mempool_destroy(adapter->pool.sr_data); 262 if (adapter->pool.gid_pn) 263 mempool_destroy(adapter->pool.gid_pn); 264 } 265 266 /** 267 * zfcp_status_read_refill - refill the long running status_read_requests 268 * @adapter: ptr to struct zfcp_adapter for which the buffers should be refilled 269 * 270 * Returns: 0 on success, 1 otherwise 271 * 272 * if there are 16 or more status_read requests missing an adapter_reopen 273 * is triggered 274 */ 275 int zfcp_status_read_refill(struct zfcp_adapter *adapter) 276 { 277 while (atomic_read(&adapter->stat_miss) > 0) 278 if (zfcp_fsf_status_read(adapter->qdio)) { 279 if (atomic_read(&adapter->stat_miss) >= 280 adapter->stat_read_buf_num) { 281 zfcp_erp_adapter_reopen(adapter, 0, "axsref1"); 282 return 1; 283 } 284 break; 285 } else 286 atomic_dec(&adapter->stat_miss); 287 return 0; 288 } 289 290 static void _zfcp_status_read_scheduler(struct work_struct *work) 291 { 292 zfcp_status_read_refill(container_of(work, struct zfcp_adapter, 293 stat_work)); 294 } 295 296 static void zfcp_print_sl(struct seq_file *m, struct service_level *sl) 297 { 298 struct zfcp_adapter *adapter = 299 container_of(sl, struct zfcp_adapter, service_level); 300 301 seq_printf(m, "zfcp: %s microcode level %x\n", 302 dev_name(&adapter->ccw_device->dev), 303 adapter->fsf_lic_version); 304 } 305 306 static int zfcp_setup_adapter_work_queue(struct zfcp_adapter *adapter) 307 { 308 char name[TASK_COMM_LEN]; 309 310 snprintf(name, sizeof(name), "zfcp_q_%s", 311 dev_name(&adapter->ccw_device->dev)); 312 adapter->work_queue = alloc_ordered_workqueue(name, WQ_MEM_RECLAIM); 313 314 if (adapter->work_queue) 315 return 0; 316 return -ENOMEM; 317 } 318 319 static void zfcp_destroy_adapter_work_queue(struct zfcp_adapter *adapter) 320 { 321 if (adapter->work_queue) 322 destroy_workqueue(adapter->work_queue); 323 adapter->work_queue = NULL; 324 325 } 326 327 /** 328 * zfcp_adapter_enqueue - enqueue a new adapter to the list 329 * @ccw_device: pointer to the struct cc_device 330 * 331 * Returns: struct zfcp_adapter* 332 * Enqueues an adapter at the end of the adapter list in the driver data. 333 * All adapter internal structures are set up. 334 * Proc-fs entries are also created. 335 */ 336 struct zfcp_adapter *zfcp_adapter_enqueue(struct ccw_device *ccw_device) 337 { 338 struct zfcp_adapter *adapter; 339 340 if (!get_device(&ccw_device->dev)) 341 return ERR_PTR(-ENODEV); 342 343 adapter = kzalloc(sizeof(struct zfcp_adapter), GFP_KERNEL); 344 if (!adapter) { 345 put_device(&ccw_device->dev); 346 return ERR_PTR(-ENOMEM); 347 } 348 349 kref_init(&adapter->ref); 350 351 ccw_device->handler = NULL; 352 adapter->ccw_device = ccw_device; 353 354 INIT_WORK(&adapter->stat_work, _zfcp_status_read_scheduler); 355 INIT_DELAYED_WORK(&adapter->scan_work, zfcp_fc_scan_ports); 356 INIT_WORK(&adapter->ns_up_work, zfcp_fc_sym_name_update); 357 358 adapter->next_port_scan = jiffies; 359 360 if (zfcp_qdio_setup(adapter)) 361 goto failed; 362 363 if (zfcp_allocate_low_mem_buffers(adapter)) 364 goto failed; 365 366 adapter->req_list = zfcp_reqlist_alloc(); 367 if (!adapter->req_list) 368 goto failed; 369 370 if (zfcp_dbf_adapter_register(adapter)) 371 goto failed; 372 373 if (zfcp_setup_adapter_work_queue(adapter)) 374 goto failed; 375 376 if (zfcp_fc_gs_setup(adapter)) 377 goto failed; 378 379 rwlock_init(&adapter->port_list_lock); 380 INIT_LIST_HEAD(&adapter->port_list); 381 382 INIT_LIST_HEAD(&adapter->events.list); 383 INIT_WORK(&adapter->events.work, zfcp_fc_post_event); 384 spin_lock_init(&adapter->events.list_lock); 385 386 init_waitqueue_head(&adapter->erp_ready_wq); 387 init_waitqueue_head(&adapter->erp_done_wqh); 388 389 INIT_LIST_HEAD(&adapter->erp_ready_head); 390 INIT_LIST_HEAD(&adapter->erp_running_head); 391 392 rwlock_init(&adapter->erp_lock); 393 rwlock_init(&adapter->abort_lock); 394 395 if (zfcp_erp_thread_setup(adapter)) 396 goto failed; 397 398 adapter->service_level.seq_print = zfcp_print_sl; 399 400 dev_set_drvdata(&ccw_device->dev, adapter); 401 402 if (sysfs_create_group(&ccw_device->dev.kobj, 403 &zfcp_sysfs_adapter_attrs)) 404 goto failed; 405 406 /* report size limit per scatter-gather segment */ 407 adapter->dma_parms.max_segment_size = ZFCP_QDIO_SBALE_LEN; 408 adapter->ccw_device->dev.dma_parms = &adapter->dma_parms; 409 410 adapter->stat_read_buf_num = FSF_STATUS_READS_RECOM; 411 412 if (!zfcp_scsi_adapter_register(adapter)) 413 return adapter; 414 415 failed: 416 zfcp_adapter_unregister(adapter); 417 return ERR_PTR(-ENOMEM); 418 } 419 420 void zfcp_adapter_unregister(struct zfcp_adapter *adapter) 421 { 422 struct ccw_device *cdev = adapter->ccw_device; 423 424 cancel_delayed_work_sync(&adapter->scan_work); 425 cancel_work_sync(&adapter->stat_work); 426 cancel_work_sync(&adapter->ns_up_work); 427 zfcp_destroy_adapter_work_queue(adapter); 428 429 zfcp_fc_wka_ports_force_offline(adapter->gs); 430 zfcp_scsi_adapter_unregister(adapter); 431 sysfs_remove_group(&cdev->dev.kobj, &zfcp_sysfs_adapter_attrs); 432 433 zfcp_erp_thread_kill(adapter); 434 zfcp_dbf_adapter_unregister(adapter); 435 zfcp_qdio_destroy(adapter->qdio); 436 437 zfcp_ccw_adapter_put(adapter); /* final put to release */ 438 } 439 440 /** 441 * zfcp_adapter_release - remove the adapter from the resource list 442 * @ref: pointer to struct kref 443 * locks: adapter list write lock is assumed to be held by caller 444 */ 445 void zfcp_adapter_release(struct kref *ref) 446 { 447 struct zfcp_adapter *adapter = container_of(ref, struct zfcp_adapter, 448 ref); 449 struct ccw_device *cdev = adapter->ccw_device; 450 451 dev_set_drvdata(&adapter->ccw_device->dev, NULL); 452 zfcp_fc_gs_destroy(adapter); 453 zfcp_free_low_mem_buffers(adapter); 454 kfree(adapter->req_list); 455 kfree(adapter->fc_stats); 456 kfree(adapter->stats_reset_data); 457 kfree(adapter); 458 put_device(&cdev->dev); 459 } 460 461 static void zfcp_port_release(struct device *dev) 462 { 463 struct zfcp_port *port = container_of(dev, struct zfcp_port, dev); 464 465 zfcp_ccw_adapter_put(port->adapter); 466 kfree(port); 467 } 468 469 /** 470 * zfcp_port_enqueue - enqueue port to port list of adapter 471 * @adapter: adapter where remote port is added 472 * @wwpn: WWPN of the remote port to be enqueued 473 * @status: initial status for the port 474 * @d_id: destination id of the remote port to be enqueued 475 * Returns: pointer to enqueued port on success, ERR_PTR on error 476 * 477 * All port internal structures are set up and the sysfs entry is generated. 478 * d_id is used to enqueue ports with a well known address like the Directory 479 * Service for nameserver lookup. 480 */ 481 struct zfcp_port *zfcp_port_enqueue(struct zfcp_adapter *adapter, u64 wwpn, 482 u32 status, u32 d_id) 483 { 484 struct zfcp_port *port; 485 int retval = -ENOMEM; 486 487 kref_get(&adapter->ref); 488 489 port = zfcp_get_port_by_wwpn(adapter, wwpn); 490 if (port) { 491 put_device(&port->dev); 492 retval = -EEXIST; 493 goto err_out; 494 } 495 496 port = kzalloc(sizeof(struct zfcp_port), GFP_KERNEL); 497 if (!port) 498 goto err_out; 499 500 rwlock_init(&port->unit_list_lock); 501 INIT_LIST_HEAD(&port->unit_list); 502 atomic_set(&port->units, 0); 503 504 INIT_WORK(&port->gid_pn_work, zfcp_fc_port_did_lookup); 505 INIT_WORK(&port->test_link_work, zfcp_fc_link_test_work); 506 INIT_WORK(&port->rport_work, zfcp_scsi_rport_work); 507 508 port->adapter = adapter; 509 port->d_id = d_id; 510 port->wwpn = wwpn; 511 port->rport_task = RPORT_NONE; 512 port->dev.parent = &adapter->ccw_device->dev; 513 port->dev.groups = zfcp_port_attr_groups; 514 port->dev.release = zfcp_port_release; 515 516 if (dev_set_name(&port->dev, "0x%016llx", (unsigned long long)wwpn)) { 517 kfree(port); 518 goto err_out; 519 } 520 retval = -EINVAL; 521 522 if (device_register(&port->dev)) { 523 put_device(&port->dev); 524 goto err_out; 525 } 526 527 write_lock_irq(&adapter->port_list_lock); 528 list_add_tail(&port->list, &adapter->port_list); 529 write_unlock_irq(&adapter->port_list_lock); 530 531 atomic_or(status | ZFCP_STATUS_COMMON_RUNNING, &port->status); 532 533 return port; 534 535 err_out: 536 zfcp_ccw_adapter_put(adapter); 537 return ERR_PTR(retval); 538 } 539 540 /** 541 * zfcp_sg_free_table - free memory used by scatterlists 542 * @sg: pointer to scatterlist 543 * @count: number of scatterlist which are to be free'ed 544 * the scatterlist are expected to reference pages always 545 */ 546 void zfcp_sg_free_table(struct scatterlist *sg, int count) 547 { 548 int i; 549 550 for (i = 0; i < count; i++, sg++) 551 if (sg) 552 free_page((unsigned long) sg_virt(sg)); 553 else 554 break; 555 } 556 557 /** 558 * zfcp_sg_setup_table - init scatterlist and allocate, assign buffers 559 * @sg: pointer to struct scatterlist 560 * @count: number of scatterlists which should be assigned with buffers 561 * of size page 562 * 563 * Returns: 0 on success, -ENOMEM otherwise 564 */ 565 int zfcp_sg_setup_table(struct scatterlist *sg, int count) 566 { 567 void *addr; 568 int i; 569 570 sg_init_table(sg, count); 571 for (i = 0; i < count; i++, sg++) { 572 addr = (void *) get_zeroed_page(GFP_KERNEL); 573 if (!addr) { 574 zfcp_sg_free_table(sg, i); 575 return -ENOMEM; 576 } 577 sg_set_buf(sg, addr, PAGE_SIZE); 578 } 579 return 0; 580 } 581