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>
29 #include <linux/seq_file.h>
32 #define ZFCP_BUS_ID_SIZE 20
36 MODULE_AUTHOR("IBM Deutschland Entwicklung GmbH - linux390@de.ibm.com");
37 MODULE_DESCRIPTION("FCP HBA driver");
38 MODULE_LICENSE("GPL");
40 module_param(device, charp, 0400);
41 MODULE_PARM_DESC(device, "specify initial device");
43 static int zfcp_reqlist_alloc(struct zfcp_adapter *adapter)
47 adapter->req_list = kcalloc(REQUEST_LIST_SIZE, sizeof(struct list_head),
49 if (!adapter->req_list)
52 for (idx = 0; idx < REQUEST_LIST_SIZE; idx++)
53 INIT_LIST_HEAD(&adapter->req_list[idx]);
58 * zfcp_reqlist_isempty - is the request list empty
59 * @adapter: pointer to struct zfcp_adapter
61 * Returns: true if list is empty, false otherwise
63 int zfcp_reqlist_isempty(struct zfcp_adapter *adapter)
67 for (idx = 0; idx < REQUEST_LIST_SIZE; idx++)
68 if (!list_empty(&adapter->req_list[idx]))
73 static int __init zfcp_device_setup(char *devstr)
81 /* duplicate devstr and keep the original for sysfs presentation*/
82 str = kmalloc(strlen(devstr) + 1, GFP_KERNEL);
88 token = strsep(&str, ",");
89 if (!token || strlen(token) >= ZFCP_BUS_ID_SIZE)
91 strncpy(zfcp_data.init_busid, token, ZFCP_BUS_ID_SIZE);
93 token = strsep(&str, ",");
94 if (!token || strict_strtoull(token, 0,
95 (unsigned long long *) &zfcp_data.init_wwpn))
98 token = strsep(&str, ",");
99 if (!token || strict_strtoull(token, 0,
100 (unsigned long long *) &zfcp_data.init_fcp_lun))
108 pr_err("zfcp: %s is not a valid SCSI device\n", devstr);
112 static void __init zfcp_init_device_configure(void)
114 struct zfcp_adapter *adapter;
115 struct zfcp_port *port;
116 struct zfcp_unit *unit;
118 down(&zfcp_data.config_sema);
119 read_lock_irq(&zfcp_data.config_lock);
120 adapter = zfcp_get_adapter_by_busid(zfcp_data.init_busid);
122 zfcp_adapter_get(adapter);
123 read_unlock_irq(&zfcp_data.config_lock);
127 port = zfcp_port_enqueue(adapter, zfcp_data.init_wwpn, 0, 0);
130 unit = zfcp_unit_enqueue(port, zfcp_data.init_fcp_lun);
133 up(&zfcp_data.config_sema);
134 ccw_device_set_online(adapter->ccw_device);
136 zfcp_erp_wait(adapter);
137 wait_event(adapter->erp_done_wqh,
138 !(atomic_read(&unit->status) &
139 ZFCP_STATUS_UNIT_SCSI_WORK_PENDING));
141 down(&zfcp_data.config_sema);
146 zfcp_adapter_put(adapter);
148 up(&zfcp_data.config_sema);
152 static struct kmem_cache *zfcp_cache_create(int size, char *name)
155 while ((size - align) > 0)
157 return kmem_cache_create(name , size, align, 0, NULL);
160 static int __init zfcp_module_init(void)
162 int retval = -ENOMEM;
164 zfcp_data.fsf_req_qtcb_cache = zfcp_cache_create(
165 sizeof(struct zfcp_fsf_req_qtcb), "zfcp_fsf");
166 if (!zfcp_data.fsf_req_qtcb_cache)
169 zfcp_data.sr_buffer_cache = zfcp_cache_create(
170 sizeof(struct fsf_status_read_buffer), "zfcp_sr");
171 if (!zfcp_data.sr_buffer_cache)
174 zfcp_data.gid_pn_cache = zfcp_cache_create(
175 sizeof(struct zfcp_gid_pn_data), "zfcp_gid");
176 if (!zfcp_data.gid_pn_cache)
179 zfcp_data.work_queue = create_singlethread_workqueue("zfcp_wq");
181 INIT_LIST_HEAD(&zfcp_data.adapter_list_head);
182 sema_init(&zfcp_data.config_sema, 1);
183 rwlock_init(&zfcp_data.config_lock);
185 zfcp_data.scsi_transport_template =
186 fc_attach_transport(&zfcp_transport_functions);
187 if (!zfcp_data.scsi_transport_template)
190 retval = misc_register(&zfcp_cfdc_misc);
192 pr_err("zfcp: Registering the misc device zfcp_cfdc failed\n");
196 retval = zfcp_ccw_register();
198 pr_err("zfcp: The zfcp device driver could not register with "
199 "the common I/O layer\n");
200 goto out_ccw_register;
203 if (zfcp_device_setup(device))
204 zfcp_init_device_configure();
209 misc_deregister(&zfcp_cfdc_misc);
211 fc_release_transport(zfcp_data.scsi_transport_template);
213 kmem_cache_destroy(zfcp_data.gid_pn_cache);
215 kmem_cache_destroy(zfcp_data.sr_buffer_cache);
217 kmem_cache_destroy(zfcp_data.fsf_req_qtcb_cache);
222 module_init(zfcp_module_init);
225 * zfcp_get_unit_by_lun - find unit in unit list of port by FCP LUN
226 * @port: pointer to port to search for unit
227 * @fcp_lun: FCP LUN to search for
229 * Returns: pointer to zfcp_unit or NULL
231 struct zfcp_unit *zfcp_get_unit_by_lun(struct zfcp_port *port, u64 fcp_lun)
233 struct zfcp_unit *unit;
235 list_for_each_entry(unit, &port->unit_list_head, list)
236 if ((unit->fcp_lun == fcp_lun) &&
237 !(atomic_read(&unit->status) & ZFCP_STATUS_COMMON_REMOVE))
243 * zfcp_get_port_by_wwpn - find port in port list of adapter by wwpn
244 * @adapter: pointer to adapter to search for port
245 * @wwpn: wwpn to search for
247 * Returns: pointer to zfcp_port or NULL
249 struct zfcp_port *zfcp_get_port_by_wwpn(struct zfcp_adapter *adapter,
252 struct zfcp_port *port;
254 list_for_each_entry(port, &adapter->port_list_head, list)
255 if ((port->wwpn == wwpn) && !(atomic_read(&port->status) &
256 (ZFCP_STATUS_PORT_NO_WWPN | ZFCP_STATUS_COMMON_REMOVE)))
261 static void zfcp_sysfs_unit_release(struct device *dev)
263 kfree(container_of(dev, struct zfcp_unit, sysfs_device));
267 * zfcp_unit_enqueue - enqueue unit to unit list of a port.
268 * @port: pointer to port where unit is added
269 * @fcp_lun: FCP LUN of unit to be enqueued
270 * Returns: pointer to enqueued unit on success, ERR_PTR on error
271 * Locks: config_sema must be held to serialize changes to the unit list
273 * Sets up some unit internal structures and creates sysfs entry.
275 struct zfcp_unit *zfcp_unit_enqueue(struct zfcp_port *port, u64 fcp_lun)
277 struct zfcp_unit *unit;
279 unit = kzalloc(sizeof(struct zfcp_unit), GFP_KERNEL);
281 return ERR_PTR(-ENOMEM);
283 atomic_set(&unit->refcount, 0);
284 init_waitqueue_head(&unit->remove_wq);
287 unit->fcp_lun = fcp_lun;
289 dev_set_name(&unit->sysfs_device, "0x%016llx",
290 (unsigned long long) fcp_lun);
291 unit->sysfs_device.parent = &port->sysfs_device;
292 unit->sysfs_device.release = zfcp_sysfs_unit_release;
293 dev_set_drvdata(&unit->sysfs_device, unit);
295 /* mark unit unusable as long as sysfs registration is not complete */
296 atomic_set_mask(ZFCP_STATUS_COMMON_REMOVE, &unit->status);
298 spin_lock_init(&unit->latencies.lock);
299 unit->latencies.write.channel.min = 0xFFFFFFFF;
300 unit->latencies.write.fabric.min = 0xFFFFFFFF;
301 unit->latencies.read.channel.min = 0xFFFFFFFF;
302 unit->latencies.read.fabric.min = 0xFFFFFFFF;
303 unit->latencies.cmd.channel.min = 0xFFFFFFFF;
304 unit->latencies.cmd.fabric.min = 0xFFFFFFFF;
306 read_lock_irq(&zfcp_data.config_lock);
307 if (zfcp_get_unit_by_lun(port, fcp_lun)) {
308 read_unlock_irq(&zfcp_data.config_lock);
311 read_unlock_irq(&zfcp_data.config_lock);
313 if (device_register(&unit->sysfs_device))
316 if (sysfs_create_group(&unit->sysfs_device.kobj,
317 &zfcp_sysfs_unit_attrs)) {
318 device_unregister(&unit->sysfs_device);
319 return ERR_PTR(-EIO);
324 write_lock_irq(&zfcp_data.config_lock);
325 list_add_tail(&unit->list, &port->unit_list_head);
326 atomic_clear_mask(ZFCP_STATUS_COMMON_REMOVE, &unit->status);
327 atomic_set_mask(ZFCP_STATUS_COMMON_RUNNING, &unit->status);
329 write_unlock_irq(&zfcp_data.config_lock);
337 return ERR_PTR(-EINVAL);
341 * zfcp_unit_dequeue - dequeue unit
342 * @unit: pointer to zfcp_unit
344 * waits until all work is done on unit and removes it then from the unit->list
345 * of the associated port.
347 void zfcp_unit_dequeue(struct zfcp_unit *unit)
349 wait_event(unit->remove_wq, atomic_read(&unit->refcount) == 0);
350 write_lock_irq(&zfcp_data.config_lock);
351 list_del(&unit->list);
352 write_unlock_irq(&zfcp_data.config_lock);
353 zfcp_port_put(unit->port);
354 sysfs_remove_group(&unit->sysfs_device.kobj, &zfcp_sysfs_unit_attrs);
355 device_unregister(&unit->sysfs_device);
358 static int zfcp_allocate_low_mem_buffers(struct zfcp_adapter *adapter)
360 /* must only be called with zfcp_data.config_sema taken */
361 adapter->pool.fsf_req_erp =
362 mempool_create_slab_pool(1, zfcp_data.fsf_req_qtcb_cache);
363 if (!adapter->pool.fsf_req_erp)
366 adapter->pool.fsf_req_scsi =
367 mempool_create_slab_pool(1, zfcp_data.fsf_req_qtcb_cache);
368 if (!adapter->pool.fsf_req_scsi)
371 adapter->pool.fsf_req_abort =
372 mempool_create_slab_pool(1, zfcp_data.fsf_req_qtcb_cache);
373 if (!adapter->pool.fsf_req_abort)
376 adapter->pool.fsf_req_status_read =
377 mempool_create_kmalloc_pool(FSF_STATUS_READS_RECOM,
378 sizeof(struct zfcp_fsf_req));
379 if (!adapter->pool.fsf_req_status_read)
382 adapter->pool.data_status_read =
383 mempool_create_slab_pool(FSF_STATUS_READS_RECOM,
384 zfcp_data.sr_buffer_cache);
385 if (!adapter->pool.data_status_read)
388 adapter->pool.data_gid_pn =
389 mempool_create_slab_pool(1, zfcp_data.gid_pn_cache);
390 if (!adapter->pool.data_gid_pn)
396 static void zfcp_free_low_mem_buffers(struct zfcp_adapter *adapter)
398 /* zfcp_data.config_sema must be held */
399 if (adapter->pool.fsf_req_erp)
400 mempool_destroy(adapter->pool.fsf_req_erp);
401 if (adapter->pool.fsf_req_scsi)
402 mempool_destroy(adapter->pool.fsf_req_scsi);
403 if (adapter->pool.fsf_req_abort)
404 mempool_destroy(adapter->pool.fsf_req_abort);
405 if (adapter->pool.fsf_req_status_read)
406 mempool_destroy(adapter->pool.fsf_req_status_read);
407 if (adapter->pool.data_status_read)
408 mempool_destroy(adapter->pool.data_status_read);
409 if (adapter->pool.data_gid_pn)
410 mempool_destroy(adapter->pool.data_gid_pn);
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,
442 static void zfcp_print_sl(struct seq_file *m, struct service_level *sl)
444 struct zfcp_adapter *adapter =
445 container_of(sl, struct zfcp_adapter, service_level);
447 seq_printf(m, "zfcp: %s microcode level %x\n",
448 dev_name(&adapter->ccw_device->dev),
449 adapter->fsf_lic_version);
453 * zfcp_adapter_enqueue - enqueue a new adapter to the list
454 * @ccw_device: pointer to the struct cc_device
456 * Returns: 0 if a new adapter was successfully enqueued
457 * -ENOMEM if alloc failed
458 * Enqueues an adapter at the end of the adapter list in the driver data.
459 * All adapter internal structures are set up.
460 * Proc-fs entries are also created.
461 * locks: config_sema must be held to serialise changes to the adapter list
463 int zfcp_adapter_enqueue(struct ccw_device *ccw_device)
465 struct zfcp_adapter *adapter;
468 * Note: It is safe to release the list_lock, as any list changes
469 * are protected by the config_sema, which must be held to get here
472 adapter = kzalloc(sizeof(struct zfcp_adapter), GFP_KERNEL);
476 ccw_device->handler = NULL;
477 adapter->ccw_device = ccw_device;
478 atomic_set(&adapter->refcount, 0);
480 if (zfcp_qdio_allocate(adapter))
481 goto qdio_allocate_failed;
483 if (zfcp_allocate_low_mem_buffers(adapter))
484 goto failed_low_mem_buffers;
486 if (zfcp_reqlist_alloc(adapter))
487 goto failed_low_mem_buffers;
489 if (zfcp_adapter_debug_register(adapter))
490 goto debug_register_failed;
492 init_waitqueue_head(&adapter->remove_wq);
493 init_waitqueue_head(&adapter->erp_thread_wqh);
494 init_waitqueue_head(&adapter->erp_done_wqh);
496 INIT_LIST_HEAD(&adapter->port_list_head);
497 INIT_LIST_HEAD(&adapter->erp_ready_head);
498 INIT_LIST_HEAD(&adapter->erp_running_head);
500 spin_lock_init(&adapter->req_list_lock);
502 spin_lock_init(&adapter->hba_dbf_lock);
503 spin_lock_init(&adapter->san_dbf_lock);
504 spin_lock_init(&adapter->scsi_dbf_lock);
505 spin_lock_init(&adapter->rec_dbf_lock);
506 spin_lock_init(&adapter->req_q_lock);
508 rwlock_init(&adapter->erp_lock);
509 rwlock_init(&adapter->abort_lock);
511 sema_init(&adapter->erp_ready_sem, 0);
513 INIT_WORK(&adapter->stat_work, _zfcp_status_read_scheduler);
514 INIT_WORK(&adapter->scan_work, _zfcp_scan_ports_later);
516 adapter->service_level.seq_print = zfcp_print_sl;
518 /* mark adapter unusable as long as sysfs registration is not complete */
519 atomic_set_mask(ZFCP_STATUS_COMMON_REMOVE, &adapter->status);
521 dev_set_drvdata(&ccw_device->dev, adapter);
523 if (sysfs_create_group(&ccw_device->dev.kobj,
524 &zfcp_sysfs_adapter_attrs))
527 write_lock_irq(&zfcp_data.config_lock);
528 atomic_clear_mask(ZFCP_STATUS_COMMON_REMOVE, &adapter->status);
529 list_add_tail(&adapter->list, &zfcp_data.adapter_list_head);
530 write_unlock_irq(&zfcp_data.config_lock);
532 zfcp_fc_nameserver_init(adapter);
537 zfcp_adapter_debug_unregister(adapter);
538 debug_register_failed:
539 dev_set_drvdata(&ccw_device->dev, NULL);
540 kfree(adapter->req_list);
541 failed_low_mem_buffers:
542 zfcp_free_low_mem_buffers(adapter);
543 qdio_allocate_failed:
544 zfcp_qdio_free(adapter);
550 * zfcp_adapter_dequeue - remove the adapter from the resource list
551 * @adapter: pointer to struct zfcp_adapter which should be removed
552 * locks: adapter list write lock is assumed to be held by caller
554 void zfcp_adapter_dequeue(struct zfcp_adapter *adapter)
559 cancel_work_sync(&adapter->scan_work);
560 cancel_work_sync(&adapter->stat_work);
561 zfcp_adapter_scsi_unregister(adapter);
562 sysfs_remove_group(&adapter->ccw_device->dev.kobj,
563 &zfcp_sysfs_adapter_attrs);
564 dev_set_drvdata(&adapter->ccw_device->dev, NULL);
565 /* sanity check: no pending FSF requests */
566 spin_lock_irqsave(&adapter->req_list_lock, flags);
567 retval = zfcp_reqlist_isempty(adapter);
568 spin_unlock_irqrestore(&adapter->req_list_lock, flags);
572 zfcp_adapter_debug_unregister(adapter);
574 /* remove specified adapter data structure from list */
575 write_lock_irq(&zfcp_data.config_lock);
576 list_del(&adapter->list);
577 write_unlock_irq(&zfcp_data.config_lock);
579 zfcp_qdio_free(adapter);
581 zfcp_free_low_mem_buffers(adapter);
582 kfree(adapter->req_list);
583 kfree(adapter->fc_stats);
584 kfree(adapter->stats_reset_data);
588 static void zfcp_sysfs_port_release(struct device *dev)
590 kfree(container_of(dev, struct zfcp_port, sysfs_device));
594 * zfcp_port_enqueue - enqueue port to port list of adapter
595 * @adapter: adapter where remote port is added
596 * @wwpn: WWPN of the remote port to be enqueued
597 * @status: initial status for the port
598 * @d_id: destination id of the remote port to be enqueued
599 * Returns: pointer to enqueued port on success, ERR_PTR on error
600 * Locks: config_sema must be held to serialize changes to the port list
602 * All port internal structures are set up and the sysfs entry is generated.
603 * d_id is used to enqueue ports with a well known address like the Directory
604 * Service for nameserver lookup.
606 struct zfcp_port *zfcp_port_enqueue(struct zfcp_adapter *adapter, u64 wwpn,
607 u32 status, u32 d_id)
609 struct zfcp_port *port;
612 port = kzalloc(sizeof(struct zfcp_port), GFP_KERNEL);
614 return ERR_PTR(-ENOMEM);
616 init_waitqueue_head(&port->remove_wq);
617 INIT_LIST_HEAD(&port->unit_list_head);
618 INIT_WORK(&port->gid_pn_work, zfcp_erp_port_strategy_open_lookup);
620 port->adapter = adapter;
624 /* mark port unusable as long as sysfs registration is not complete */
625 atomic_set_mask(status | ZFCP_STATUS_COMMON_REMOVE, &port->status);
626 atomic_set(&port->refcount, 0);
628 dev_set_name(&port->sysfs_device, "0x%016llx",
629 (unsigned long long)wwpn);
630 port->sysfs_device.parent = &adapter->ccw_device->dev;
632 port->sysfs_device.release = zfcp_sysfs_port_release;
633 dev_set_drvdata(&port->sysfs_device, port);
635 read_lock_irq(&zfcp_data.config_lock);
636 if (!(status & ZFCP_STATUS_PORT_NO_WWPN))
637 if (zfcp_get_port_by_wwpn(adapter, wwpn)) {
638 read_unlock_irq(&zfcp_data.config_lock);
641 read_unlock_irq(&zfcp_data.config_lock);
643 if (device_register(&port->sysfs_device))
646 retval = sysfs_create_group(&port->sysfs_device.kobj,
647 &zfcp_sysfs_port_attrs);
650 device_unregister(&port->sysfs_device);
656 write_lock_irq(&zfcp_data.config_lock);
657 list_add_tail(&port->list, &adapter->port_list_head);
658 atomic_clear_mask(ZFCP_STATUS_COMMON_REMOVE, &port->status);
659 atomic_set_mask(ZFCP_STATUS_COMMON_RUNNING, &port->status);
661 write_unlock_irq(&zfcp_data.config_lock);
663 zfcp_adapter_get(adapter);
669 return ERR_PTR(-EINVAL);
673 * zfcp_port_dequeue - dequeues a port from the port list of the adapter
674 * @port: pointer to struct zfcp_port which should be removed
676 void zfcp_port_dequeue(struct zfcp_port *port)
678 wait_event(port->remove_wq, atomic_read(&port->refcount) == 0);
679 write_lock_irq(&zfcp_data.config_lock);
680 list_del(&port->list);
681 write_unlock_irq(&zfcp_data.config_lock);
683 fc_remote_port_delete(port->rport);
685 zfcp_adapter_put(port->adapter);
686 sysfs_remove_group(&port->sysfs_device.kobj, &zfcp_sysfs_port_attrs);
687 device_unregister(&port->sysfs_device);
691 * zfcp_sg_free_table - free memory used by scatterlists
692 * @sg: pointer to scatterlist
693 * @count: number of scatterlist which are to be free'ed
694 * the scatterlist are expected to reference pages always
696 void zfcp_sg_free_table(struct scatterlist *sg, int count)
700 for (i = 0; i < count; i++, sg++)
702 free_page((unsigned long) sg_virt(sg));
708 * zfcp_sg_setup_table - init scatterlist and allocate, assign buffers
709 * @sg: pointer to struct scatterlist
710 * @count: number of scatterlists which should be assigned with buffers
713 * Returns: 0 on success, -ENOMEM otherwise
715 int zfcp_sg_setup_table(struct scatterlist *sg, int count)
720 sg_init_table(sg, count);
721 for (i = 0; i < count; i++, sg++) {
722 addr = (void *) get_zeroed_page(GFP_KERNEL);
724 zfcp_sg_free_table(sg, i);
727 sg_set_buf(sg, addr, PAGE_SIZE);