4 * Module interface and handling of zfcp data structures.
6 * Copyright IBM Corporation 2002, 2008
11 * Martin Peschke (originator of the driver)
16 * Heiko Carstens (kernel 2.6 port of the driver)
28 #include <linux/miscdevice.h>
33 MODULE_AUTHOR("IBM Deutschland Entwicklung GmbH - linux390@de.ibm.com");
34 MODULE_DESCRIPTION("FCP HBA driver");
35 MODULE_LICENSE("GPL");
37 module_param(device, charp, 0400);
38 MODULE_PARM_DESC(device, "specify initial device");
40 static int zfcp_reqlist_alloc(struct zfcp_adapter *adapter)
44 adapter->req_list = kcalloc(REQUEST_LIST_SIZE, sizeof(struct list_head),
46 if (!adapter->req_list)
49 for (idx = 0; idx < REQUEST_LIST_SIZE; idx++)
50 INIT_LIST_HEAD(&adapter->req_list[idx]);
55 * zfcp_reqlist_isempty - is the request list empty
56 * @adapter: pointer to struct zfcp_adapter
58 * Returns: true if list is empty, false otherwise
60 int zfcp_reqlist_isempty(struct zfcp_adapter *adapter)
64 for (idx = 0; idx < REQUEST_LIST_SIZE; idx++)
65 if (!list_empty(&adapter->req_list[idx]))
70 static int __init zfcp_device_setup(char *devstr)
78 /* duplicate devstr and keep the original for sysfs presentation*/
79 str = kmalloc(strlen(devstr) + 1, GFP_KERNEL);
85 token = strsep(&str, ",");
86 if (!token || strlen(token) >= BUS_ID_SIZE)
88 strncpy(zfcp_data.init_busid, token, BUS_ID_SIZE);
90 token = strsep(&str, ",");
91 if (!token || strict_strtoull(token, 0,
92 (unsigned long long *) &zfcp_data.init_wwpn))
95 token = strsep(&str, ",");
96 if (!token || strict_strtoull(token, 0,
97 (unsigned long long *) &zfcp_data.init_fcp_lun))
105 pr_err("zfcp: %s is not a valid SCSI device\n", devstr);
109 static void __init zfcp_init_device_configure(void)
111 struct zfcp_adapter *adapter;
112 struct zfcp_port *port;
113 struct zfcp_unit *unit;
115 down(&zfcp_data.config_sema);
116 read_lock_irq(&zfcp_data.config_lock);
117 adapter = zfcp_get_adapter_by_busid(zfcp_data.init_busid);
119 zfcp_adapter_get(adapter);
120 read_unlock_irq(&zfcp_data.config_lock);
124 port = zfcp_port_enqueue(adapter, zfcp_data.init_wwpn, 0, 0);
127 unit = zfcp_unit_enqueue(port, zfcp_data.init_fcp_lun);
130 up(&zfcp_data.config_sema);
131 ccw_device_set_online(adapter->ccw_device);
132 zfcp_erp_wait(adapter);
133 down(&zfcp_data.config_sema);
138 zfcp_adapter_put(adapter);
140 up(&zfcp_data.config_sema);
144 static struct kmem_cache *zfcp_cache_create(int size, char *name)
147 while ((size - align) > 0)
149 return kmem_cache_create(name , size, align, 0, NULL);
152 static int __init zfcp_module_init(void)
154 int retval = -ENOMEM;
156 zfcp_data.fsf_req_qtcb_cache = zfcp_cache_create(
157 sizeof(struct zfcp_fsf_req_qtcb), "zfcp_fsf");
158 if (!zfcp_data.fsf_req_qtcb_cache)
161 zfcp_data.sr_buffer_cache = zfcp_cache_create(
162 sizeof(struct fsf_status_read_buffer), "zfcp_sr");
163 if (!zfcp_data.sr_buffer_cache)
166 zfcp_data.gid_pn_cache = zfcp_cache_create(
167 sizeof(struct zfcp_gid_pn_data), "zfcp_gid");
168 if (!zfcp_data.gid_pn_cache)
171 INIT_LIST_HEAD(&zfcp_data.adapter_list_head);
172 INIT_LIST_HEAD(&zfcp_data.adapter_remove_lh);
174 sema_init(&zfcp_data.config_sema, 1);
175 rwlock_init(&zfcp_data.config_lock);
177 zfcp_data.scsi_transport_template =
178 fc_attach_transport(&zfcp_transport_functions);
179 if (!zfcp_data.scsi_transport_template)
182 retval = misc_register(&zfcp_cfdc_misc);
184 pr_err("zfcp: Registering the misc device zfcp_cfdc failed\n");
188 retval = zfcp_ccw_register();
190 pr_err("zfcp: The zfcp device driver could not register with "
191 "the common I/O layer\n");
192 goto out_ccw_register;
195 if (zfcp_device_setup(device))
196 zfcp_init_device_configure();
201 misc_deregister(&zfcp_cfdc_misc);
203 fc_release_transport(zfcp_data.scsi_transport_template);
205 kmem_cache_destroy(zfcp_data.gid_pn_cache);
207 kmem_cache_destroy(zfcp_data.sr_buffer_cache);
209 kmem_cache_destroy(zfcp_data.fsf_req_qtcb_cache);
214 module_init(zfcp_module_init);
217 * zfcp_get_unit_by_lun - find unit in unit list of port by FCP LUN
218 * @port: pointer to port to search for unit
219 * @fcp_lun: FCP LUN to search for
221 * Returns: pointer to zfcp_unit or NULL
223 struct zfcp_unit *zfcp_get_unit_by_lun(struct zfcp_port *port, u64 fcp_lun)
225 struct zfcp_unit *unit;
227 list_for_each_entry(unit, &port->unit_list_head, list)
228 if ((unit->fcp_lun == fcp_lun) &&
229 !(atomic_read(&unit->status) & ZFCP_STATUS_COMMON_REMOVE))
235 * zfcp_get_port_by_wwpn - find port in port list of adapter by wwpn
236 * @adapter: pointer to adapter to search for port
237 * @wwpn: wwpn to search for
239 * Returns: pointer to zfcp_port or NULL
241 struct zfcp_port *zfcp_get_port_by_wwpn(struct zfcp_adapter *adapter,
244 struct zfcp_port *port;
246 list_for_each_entry(port, &adapter->port_list_head, list)
247 if ((port->wwpn == wwpn) && !(atomic_read(&port->status) &
248 (ZFCP_STATUS_PORT_NO_WWPN | ZFCP_STATUS_COMMON_REMOVE)))
253 static void zfcp_sysfs_unit_release(struct device *dev)
255 kfree(container_of(dev, struct zfcp_unit, sysfs_device));
259 * zfcp_unit_enqueue - enqueue unit to unit list of a port.
260 * @port: pointer to port where unit is added
261 * @fcp_lun: FCP LUN of unit to be enqueued
262 * Returns: pointer to enqueued unit on success, ERR_PTR on error
263 * Locks: config_sema must be held to serialize changes to the unit list
265 * Sets up some unit internal structures and creates sysfs entry.
267 struct zfcp_unit *zfcp_unit_enqueue(struct zfcp_port *port, u64 fcp_lun)
269 struct zfcp_unit *unit;
271 unit = kzalloc(sizeof(struct zfcp_unit), GFP_KERNEL);
273 return ERR_PTR(-ENOMEM);
275 atomic_set(&unit->refcount, 0);
276 init_waitqueue_head(&unit->remove_wq);
279 unit->fcp_lun = fcp_lun;
281 snprintf(unit->sysfs_device.bus_id, BUS_ID_SIZE, "0x%016llx",
282 (unsigned long long) fcp_lun);
283 unit->sysfs_device.parent = &port->sysfs_device;
284 unit->sysfs_device.release = zfcp_sysfs_unit_release;
285 dev_set_drvdata(&unit->sysfs_device, unit);
287 /* mark unit unusable as long as sysfs registration is not complete */
288 atomic_set_mask(ZFCP_STATUS_COMMON_REMOVE, &unit->status);
290 spin_lock_init(&unit->latencies.lock);
291 unit->latencies.write.channel.min = 0xFFFFFFFF;
292 unit->latencies.write.fabric.min = 0xFFFFFFFF;
293 unit->latencies.read.channel.min = 0xFFFFFFFF;
294 unit->latencies.read.fabric.min = 0xFFFFFFFF;
295 unit->latencies.cmd.channel.min = 0xFFFFFFFF;
296 unit->latencies.cmd.fabric.min = 0xFFFFFFFF;
298 read_lock_irq(&zfcp_data.config_lock);
299 if (zfcp_get_unit_by_lun(port, fcp_lun)) {
300 read_unlock_irq(&zfcp_data.config_lock);
303 read_unlock_irq(&zfcp_data.config_lock);
305 if (device_register(&unit->sysfs_device))
308 if (sysfs_create_group(&unit->sysfs_device.kobj,
309 &zfcp_sysfs_unit_attrs)) {
310 device_unregister(&unit->sysfs_device);
311 return ERR_PTR(-EIO);
315 unit->scsi_lun = scsilun_to_int((struct scsi_lun *)&unit->fcp_lun);
317 write_lock_irq(&zfcp_data.config_lock);
318 list_add_tail(&unit->list, &port->unit_list_head);
319 atomic_clear_mask(ZFCP_STATUS_COMMON_REMOVE, &unit->status);
320 atomic_set_mask(ZFCP_STATUS_COMMON_RUNNING, &unit->status);
322 write_unlock_irq(&zfcp_data.config_lock);
331 return ERR_PTR(-EINVAL);
335 * zfcp_unit_dequeue - dequeue unit
336 * @unit: pointer to zfcp_unit
338 * waits until all work is done on unit and removes it then from the unit->list
339 * of the associated port.
341 void zfcp_unit_dequeue(struct zfcp_unit *unit)
343 wait_event(unit->remove_wq, atomic_read(&unit->refcount) == 0);
344 write_lock_irq(&zfcp_data.config_lock);
345 list_del(&unit->list);
346 write_unlock_irq(&zfcp_data.config_lock);
348 zfcp_port_put(unit->port);
349 sysfs_remove_group(&unit->sysfs_device.kobj, &zfcp_sysfs_unit_attrs);
350 device_unregister(&unit->sysfs_device);
353 static int zfcp_allocate_low_mem_buffers(struct zfcp_adapter *adapter)
355 /* must only be called with zfcp_data.config_sema taken */
356 adapter->pool.fsf_req_erp =
357 mempool_create_slab_pool(1, zfcp_data.fsf_req_qtcb_cache);
358 if (!adapter->pool.fsf_req_erp)
361 adapter->pool.fsf_req_scsi =
362 mempool_create_slab_pool(1, zfcp_data.fsf_req_qtcb_cache);
363 if (!adapter->pool.fsf_req_scsi)
366 adapter->pool.fsf_req_abort =
367 mempool_create_slab_pool(1, zfcp_data.fsf_req_qtcb_cache);
368 if (!adapter->pool.fsf_req_abort)
371 adapter->pool.fsf_req_status_read =
372 mempool_create_kmalloc_pool(FSF_STATUS_READS_RECOM,
373 sizeof(struct zfcp_fsf_req));
374 if (!adapter->pool.fsf_req_status_read)
377 adapter->pool.data_status_read =
378 mempool_create_slab_pool(FSF_STATUS_READS_RECOM,
379 zfcp_data.sr_buffer_cache);
380 if (!adapter->pool.data_status_read)
383 adapter->pool.data_gid_pn =
384 mempool_create_slab_pool(1, zfcp_data.gid_pn_cache);
385 if (!adapter->pool.data_gid_pn)
391 static void zfcp_free_low_mem_buffers(struct zfcp_adapter *adapter)
393 /* zfcp_data.config_sema must be held */
394 if (adapter->pool.fsf_req_erp)
395 mempool_destroy(adapter->pool.fsf_req_erp);
396 if (adapter->pool.fsf_req_scsi)
397 mempool_destroy(adapter->pool.fsf_req_scsi);
398 if (adapter->pool.fsf_req_abort)
399 mempool_destroy(adapter->pool.fsf_req_abort);
400 if (adapter->pool.fsf_req_status_read)
401 mempool_destroy(adapter->pool.fsf_req_status_read);
402 if (adapter->pool.data_status_read)
403 mempool_destroy(adapter->pool.data_status_read);
404 if (adapter->pool.data_gid_pn)
405 mempool_destroy(adapter->pool.data_gid_pn);
408 static void zfcp_dummy_release(struct device *dev)
414 * zfcp_status_read_refill - refill the long running status_read_requests
415 * @adapter: ptr to struct zfcp_adapter for which the buffers should be refilled
417 * Returns: 0 on success, 1 otherwise
419 * if there are 16 or more status_read requests missing an adapter_reopen
422 int zfcp_status_read_refill(struct zfcp_adapter *adapter)
424 while (atomic_read(&adapter->stat_miss) > 0)
425 if (zfcp_fsf_status_read(adapter)) {
426 if (atomic_read(&adapter->stat_miss) >= 16) {
427 zfcp_erp_adapter_reopen(adapter, 0, 103, NULL);
432 atomic_dec(&adapter->stat_miss);
436 static void _zfcp_status_read_scheduler(struct work_struct *work)
438 zfcp_status_read_refill(container_of(work, struct zfcp_adapter,
443 * zfcp_adapter_enqueue - enqueue a new adapter to the list
444 * @ccw_device: pointer to the struct cc_device
446 * Returns: 0 if a new adapter was successfully enqueued
447 * -ENOMEM if alloc failed
448 * Enqueues an adapter at the end of the adapter list in the driver data.
449 * All adapter internal structures are set up.
450 * Proc-fs entries are also created.
451 * locks: config_sema must be held to serialise changes to the adapter list
453 int zfcp_adapter_enqueue(struct ccw_device *ccw_device)
455 struct zfcp_adapter *adapter;
458 * Note: It is safe to release the list_lock, as any list changes
459 * are protected by the config_sema, which must be held to get here
462 adapter = kzalloc(sizeof(struct zfcp_adapter), GFP_KERNEL);
466 ccw_device->handler = NULL;
467 adapter->ccw_device = ccw_device;
468 atomic_set(&adapter->refcount, 0);
470 if (zfcp_qdio_allocate(adapter))
471 goto qdio_allocate_failed;
473 if (zfcp_allocate_low_mem_buffers(adapter))
474 goto failed_low_mem_buffers;
476 if (zfcp_reqlist_alloc(adapter))
477 goto failed_low_mem_buffers;
479 if (zfcp_adapter_debug_register(adapter))
480 goto debug_register_failed;
482 init_waitqueue_head(&adapter->remove_wq);
483 init_waitqueue_head(&adapter->erp_thread_wqh);
484 init_waitqueue_head(&adapter->erp_done_wqh);
486 INIT_LIST_HEAD(&adapter->port_list_head);
487 INIT_LIST_HEAD(&adapter->port_remove_lh);
488 INIT_LIST_HEAD(&adapter->erp_ready_head);
489 INIT_LIST_HEAD(&adapter->erp_running_head);
491 spin_lock_init(&adapter->req_list_lock);
493 spin_lock_init(&adapter->hba_dbf_lock);
494 spin_lock_init(&adapter->san_dbf_lock);
495 spin_lock_init(&adapter->scsi_dbf_lock);
496 spin_lock_init(&adapter->rec_dbf_lock);
497 spin_lock_init(&adapter->req_q.lock);
499 rwlock_init(&adapter->erp_lock);
500 rwlock_init(&adapter->abort_lock);
502 sema_init(&adapter->erp_ready_sem, 0);
504 INIT_WORK(&adapter->stat_work, _zfcp_status_read_scheduler);
505 INIT_WORK(&adapter->scan_work, _zfcp_scan_ports_later);
507 /* mark adapter unusable as long as sysfs registration is not complete */
508 atomic_set_mask(ZFCP_STATUS_COMMON_REMOVE, &adapter->status);
510 dev_set_drvdata(&ccw_device->dev, adapter);
512 if (sysfs_create_group(&ccw_device->dev.kobj,
513 &zfcp_sysfs_adapter_attrs))
516 adapter->generic_services.parent = &adapter->ccw_device->dev;
517 adapter->generic_services.release = zfcp_dummy_release;
518 snprintf(adapter->generic_services.bus_id, BUS_ID_SIZE,
521 if (device_register(&adapter->generic_services))
522 goto generic_services_failed;
524 write_lock_irq(&zfcp_data.config_lock);
525 atomic_clear_mask(ZFCP_STATUS_COMMON_REMOVE, &adapter->status);
526 list_add_tail(&adapter->list, &zfcp_data.adapter_list_head);
527 write_unlock_irq(&zfcp_data.config_lock);
529 zfcp_data.adapters++;
531 zfcp_fc_nameserver_init(adapter);
535 generic_services_failed:
536 sysfs_remove_group(&ccw_device->dev.kobj,
537 &zfcp_sysfs_adapter_attrs);
539 zfcp_adapter_debug_unregister(adapter);
540 debug_register_failed:
541 dev_set_drvdata(&ccw_device->dev, NULL);
542 kfree(adapter->req_list);
543 failed_low_mem_buffers:
544 zfcp_free_low_mem_buffers(adapter);
545 qdio_allocate_failed:
546 zfcp_qdio_free(adapter);
552 * zfcp_adapter_dequeue - remove the adapter from the resource list
553 * @adapter: pointer to struct zfcp_adapter which should be removed
554 * locks: adapter list write lock is assumed to be held by caller
556 void zfcp_adapter_dequeue(struct zfcp_adapter *adapter)
561 cancel_work_sync(&adapter->scan_work);
562 cancel_work_sync(&adapter->stat_work);
563 zfcp_adapter_scsi_unregister(adapter);
564 device_unregister(&adapter->generic_services);
565 sysfs_remove_group(&adapter->ccw_device->dev.kobj,
566 &zfcp_sysfs_adapter_attrs);
567 dev_set_drvdata(&adapter->ccw_device->dev, NULL);
568 /* sanity check: no pending FSF requests */
569 spin_lock_irqsave(&adapter->req_list_lock, flags);
570 retval = zfcp_reqlist_isempty(adapter);
571 spin_unlock_irqrestore(&adapter->req_list_lock, flags);
575 zfcp_adapter_debug_unregister(adapter);
577 /* remove specified adapter data structure from list */
578 write_lock_irq(&zfcp_data.config_lock);
579 list_del(&adapter->list);
580 write_unlock_irq(&zfcp_data.config_lock);
582 /* decrease number of adapters in list */
583 zfcp_data.adapters--;
585 zfcp_qdio_free(adapter);
587 zfcp_free_low_mem_buffers(adapter);
588 kfree(adapter->req_list);
589 kfree(adapter->fc_stats);
590 kfree(adapter->stats_reset_data);
594 static void zfcp_sysfs_port_release(struct device *dev)
596 kfree(container_of(dev, struct zfcp_port, sysfs_device));
600 * zfcp_port_enqueue - enqueue port to port list of adapter
601 * @adapter: adapter where remote port is added
602 * @wwpn: WWPN of the remote port to be enqueued
603 * @status: initial status for the port
604 * @d_id: destination id of the remote port to be enqueued
605 * Returns: pointer to enqueued port on success, ERR_PTR on error
606 * Locks: config_sema must be held to serialize changes to the port list
608 * All port internal structures are set up and the sysfs entry is generated.
609 * d_id is used to enqueue ports with a well known address like the Directory
610 * Service for nameserver lookup.
612 struct zfcp_port *zfcp_port_enqueue(struct zfcp_adapter *adapter, u64 wwpn,
613 u32 status, u32 d_id)
615 struct zfcp_port *port;
618 port = kzalloc(sizeof(struct zfcp_port), GFP_KERNEL);
620 return ERR_PTR(-ENOMEM);
622 init_waitqueue_head(&port->remove_wq);
624 INIT_LIST_HEAD(&port->unit_list_head);
625 INIT_LIST_HEAD(&port->unit_remove_lh);
626 INIT_WORK(&port->gid_pn_work, zfcp_erp_port_strategy_open_lookup);
628 port->adapter = adapter;
632 /* mark port unusable as long as sysfs registration is not complete */
633 atomic_set_mask(status | ZFCP_STATUS_COMMON_REMOVE, &port->status);
634 atomic_set(&port->refcount, 0);
636 snprintf(port->sysfs_device.bus_id, BUS_ID_SIZE, "0x%016llx",
637 (unsigned long long) wwpn);
638 port->sysfs_device.parent = &adapter->ccw_device->dev;
640 port->sysfs_device.release = zfcp_sysfs_port_release;
641 dev_set_drvdata(&port->sysfs_device, port);
643 read_lock_irq(&zfcp_data.config_lock);
644 if (!(status & ZFCP_STATUS_PORT_NO_WWPN))
645 if (zfcp_get_port_by_wwpn(adapter, wwpn)) {
646 read_unlock_irq(&zfcp_data.config_lock);
649 read_unlock_irq(&zfcp_data.config_lock);
651 if (device_register(&port->sysfs_device))
654 retval = sysfs_create_group(&port->sysfs_device.kobj,
655 &zfcp_sysfs_port_attrs);
658 device_unregister(&port->sysfs_device);
664 write_lock_irq(&zfcp_data.config_lock);
665 list_add_tail(&port->list, &adapter->port_list_head);
666 atomic_clear_mask(ZFCP_STATUS_COMMON_REMOVE, &port->status);
667 atomic_set_mask(ZFCP_STATUS_COMMON_RUNNING, &port->status);
670 write_unlock_irq(&zfcp_data.config_lock);
672 zfcp_adapter_get(adapter);
678 return ERR_PTR(-EINVAL);
682 * zfcp_port_dequeue - dequeues a port from the port list of the adapter
683 * @port: pointer to struct zfcp_port which should be removed
685 void zfcp_port_dequeue(struct zfcp_port *port)
687 wait_event(port->remove_wq, atomic_read(&port->refcount) == 0);
688 write_lock_irq(&zfcp_data.config_lock);
689 list_del(&port->list);
690 port->adapter->ports--;
691 write_unlock_irq(&zfcp_data.config_lock);
693 fc_remote_port_delete(port->rport);
695 zfcp_adapter_put(port->adapter);
696 sysfs_remove_group(&port->sysfs_device.kobj, &zfcp_sysfs_port_attrs);
697 device_unregister(&port->sysfs_device);
701 * zfcp_sg_free_table - free memory used by scatterlists
702 * @sg: pointer to scatterlist
703 * @count: number of scatterlist which are to be free'ed
704 * the scatterlist are expected to reference pages always
706 void zfcp_sg_free_table(struct scatterlist *sg, int count)
710 for (i = 0; i < count; i++, sg++)
712 free_page((unsigned long) sg_virt(sg));
718 * zfcp_sg_setup_table - init scatterlist and allocate, assign buffers
719 * @sg: pointer to struct scatterlist
720 * @count: number of scatterlists which should be assigned with buffers
723 * Returns: 0 on success, -ENOMEM otherwise
725 int zfcp_sg_setup_table(struct scatterlist *sg, int count)
730 sg_init_table(sg, count);
731 for (i = 0; i < count; i++, sg++) {
732 addr = (void *) get_zeroed_page(GFP_KERNEL);
734 zfcp_sg_free_table(sg, i);
737 sg_set_buf(sg, addr, PAGE_SIZE);