4 * Module interface and handling of zfcp data structures.
6 * Copyright IBM Corporation 2002, 2010
11 * Martin Peschke (originator of the driver)
16 * Heiko Carstens (kernel 2.6 port of the driver)
28 #define KMSG_COMPONENT "zfcp"
29 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
31 #include <linux/miscdevice.h>
32 #include <linux/seq_file.h>
33 #include <linux/slab.h>
36 #include "zfcp_reqlist.h"
38 #define ZFCP_BUS_ID_SIZE 20
40 MODULE_AUTHOR("IBM Deutschland Entwicklung GmbH - linux390@de.ibm.com");
41 MODULE_DESCRIPTION("FCP HBA driver");
42 MODULE_LICENSE("GPL");
44 static char *init_device
;
45 module_param_named(device
, init_device
, charp
, 0400);
46 MODULE_PARM_DESC(device
, "specify initial device");
48 static struct kmem_cache
*zfcp_cache_hw_align(const char *name
,
51 return kmem_cache_create(name
, size
, roundup_pow_of_two(size
), 0, NULL
);
54 static void __init
zfcp_init_device_configure(char *busid
, u64 wwpn
, u64 lun
)
56 struct ccw_device
*cdev
;
57 struct zfcp_adapter
*adapter
;
58 struct zfcp_port
*port
;
59 struct zfcp_unit
*unit
;
61 cdev
= get_ccwdev_by_busid(&zfcp_ccw_driver
, busid
);
65 if (ccw_device_set_online(cdev
))
68 adapter
= zfcp_ccw_adapter_by_cdev(cdev
);
72 port
= zfcp_get_port_by_wwpn(adapter
, wwpn
);
76 unit
= zfcp_unit_enqueue(port
, lun
);
80 zfcp_erp_unit_reopen(unit
, 0, "auidc_1", NULL
);
81 zfcp_erp_wait(adapter
);
82 flush_work(&unit
->scsi_work
);
85 put_device(&port
->dev
);
87 zfcp_ccw_adapter_put(adapter
);
89 put_device(&cdev
->dev
);
93 static void __init
zfcp_init_device_setup(char *devstr
)
96 char *str
, *str_saved
;
97 char busid
[ZFCP_BUS_ID_SIZE
];
100 /* duplicate devstr and keep the original for sysfs presentation*/
101 str_saved
= kstrdup(devstr
, GFP_KERNEL
);
106 token
= strsep(&str
, ",");
107 if (!token
|| strlen(token
) >= ZFCP_BUS_ID_SIZE
)
109 strncpy(busid
, token
, ZFCP_BUS_ID_SIZE
);
111 token
= strsep(&str
, ",");
112 if (!token
|| strict_strtoull(token
, 0, (unsigned long long *) &wwpn
))
115 token
= strsep(&str
, ",");
116 if (!token
|| strict_strtoull(token
, 0, (unsigned long long *) &lun
))
120 zfcp_init_device_configure(busid
, wwpn
, lun
);
125 pr_err("%s is not a valid SCSI device\n", devstr
);
128 static int __init
zfcp_module_init(void)
130 int retval
= -ENOMEM
;
132 zfcp_data
.gpn_ft_cache
= zfcp_cache_hw_align("zfcp_gpn",
133 sizeof(struct zfcp_fc_gpn_ft_req
));
134 if (!zfcp_data
.gpn_ft_cache
)
137 zfcp_data
.qtcb_cache
= zfcp_cache_hw_align("zfcp_qtcb",
138 sizeof(struct fsf_qtcb
));
139 if (!zfcp_data
.qtcb_cache
)
142 zfcp_data
.sr_buffer_cache
= zfcp_cache_hw_align("zfcp_sr",
143 sizeof(struct fsf_status_read_buffer
));
144 if (!zfcp_data
.sr_buffer_cache
)
147 zfcp_data
.gid_pn_cache
= zfcp_cache_hw_align("zfcp_gid",
148 sizeof(struct zfcp_fc_gid_pn
));
149 if (!zfcp_data
.gid_pn_cache
)
152 zfcp_data
.adisc_cache
= zfcp_cache_hw_align("zfcp_adisc",
153 sizeof(struct zfcp_fc_els_adisc
));
154 if (!zfcp_data
.adisc_cache
)
155 goto out_adisc_cache
;
157 zfcp_data
.scsi_transport_template
=
158 fc_attach_transport(&zfcp_transport_functions
);
159 if (!zfcp_data
.scsi_transport_template
)
162 retval
= misc_register(&zfcp_cfdc_misc
);
164 pr_err("Registering the misc device zfcp_cfdc failed\n");
168 retval
= ccw_driver_register(&zfcp_ccw_driver
);
170 pr_err("The zfcp device driver could not register with "
171 "the common I/O layer\n");
172 goto out_ccw_register
;
176 zfcp_init_device_setup(init_device
);
180 misc_deregister(&zfcp_cfdc_misc
);
182 fc_release_transport(zfcp_data
.scsi_transport_template
);
184 kmem_cache_destroy(zfcp_data
.adisc_cache
);
186 kmem_cache_destroy(zfcp_data
.gid_pn_cache
);
188 kmem_cache_destroy(zfcp_data
.sr_buffer_cache
);
190 kmem_cache_destroy(zfcp_data
.qtcb_cache
);
192 kmem_cache_destroy(zfcp_data
.gpn_ft_cache
);
197 module_init(zfcp_module_init
);
199 static void __exit
zfcp_module_exit(void)
201 ccw_driver_unregister(&zfcp_ccw_driver
);
202 misc_deregister(&zfcp_cfdc_misc
);
203 fc_release_transport(zfcp_data
.scsi_transport_template
);
204 kmem_cache_destroy(zfcp_data
.adisc_cache
);
205 kmem_cache_destroy(zfcp_data
.gid_pn_cache
);
206 kmem_cache_destroy(zfcp_data
.sr_buffer_cache
);
207 kmem_cache_destroy(zfcp_data
.qtcb_cache
);
208 kmem_cache_destroy(zfcp_data
.gpn_ft_cache
);
211 module_exit(zfcp_module_exit
);
214 * zfcp_get_unit_by_lun - find unit in unit list of port by FCP LUN
215 * @port: pointer to port to search for unit
216 * @fcp_lun: FCP LUN to search for
218 * Returns: pointer to zfcp_unit or NULL
220 struct zfcp_unit
*zfcp_get_unit_by_lun(struct zfcp_port
*port
, u64 fcp_lun
)
223 struct zfcp_unit
*unit
;
225 read_lock_irqsave(&port
->unit_list_lock
, flags
);
226 list_for_each_entry(unit
, &port
->unit_list
, list
)
227 if (unit
->fcp_lun
== fcp_lun
) {
228 if (!get_device(&unit
->dev
))
230 read_unlock_irqrestore(&port
->unit_list_lock
, flags
);
233 read_unlock_irqrestore(&port
->unit_list_lock
, flags
);
238 * zfcp_get_port_by_wwpn - find port in port list of adapter by wwpn
239 * @adapter: pointer to adapter to search for port
240 * @wwpn: wwpn to search for
242 * Returns: pointer to zfcp_port or NULL
244 struct zfcp_port
*zfcp_get_port_by_wwpn(struct zfcp_adapter
*adapter
,
248 struct zfcp_port
*port
;
250 read_lock_irqsave(&adapter
->port_list_lock
, flags
);
251 list_for_each_entry(port
, &adapter
->port_list
, list
)
252 if (port
->wwpn
== wwpn
) {
253 if (!get_device(&port
->dev
))
255 read_unlock_irqrestore(&adapter
->port_list_lock
, flags
);
258 read_unlock_irqrestore(&adapter
->port_list_lock
, flags
);
263 * zfcp_unit_release - dequeue unit
264 * @dev: pointer to device
266 * waits until all work is done on unit and removes it then from the unit->list
267 * of the associated port.
269 static void zfcp_unit_release(struct device
*dev
)
271 struct zfcp_unit
*unit
= container_of(dev
, struct zfcp_unit
, dev
);
273 put_device(&unit
->port
->dev
);
278 * zfcp_unit_enqueue - enqueue unit to unit list of a port.
279 * @port: pointer to port where unit is added
280 * @fcp_lun: FCP LUN of unit to be enqueued
281 * Returns: pointer to enqueued unit on success, ERR_PTR on error
283 * Sets up some unit internal structures and creates sysfs entry.
285 struct zfcp_unit
*zfcp_unit_enqueue(struct zfcp_port
*port
, u64 fcp_lun
)
287 struct zfcp_unit
*unit
;
288 int retval
= -ENOMEM
;
290 get_device(&port
->dev
);
292 unit
= zfcp_get_unit_by_lun(port
, fcp_lun
);
294 put_device(&unit
->dev
);
299 unit
= kzalloc(sizeof(struct zfcp_unit
), GFP_KERNEL
);
304 unit
->fcp_lun
= fcp_lun
;
305 unit
->dev
.parent
= &port
->dev
;
306 unit
->dev
.release
= zfcp_unit_release
;
308 if (dev_set_name(&unit
->dev
, "0x%016llx",
309 (unsigned long long) fcp_lun
)) {
315 INIT_WORK(&unit
->scsi_work
, zfcp_scsi_scan_work
);
317 spin_lock_init(&unit
->latencies
.lock
);
318 unit
->latencies
.write
.channel
.min
= 0xFFFFFFFF;
319 unit
->latencies
.write
.fabric
.min
= 0xFFFFFFFF;
320 unit
->latencies
.read
.channel
.min
= 0xFFFFFFFF;
321 unit
->latencies
.read
.fabric
.min
= 0xFFFFFFFF;
322 unit
->latencies
.cmd
.channel
.min
= 0xFFFFFFFF;
323 unit
->latencies
.cmd
.fabric
.min
= 0xFFFFFFFF;
325 if (device_register(&unit
->dev
)) {
326 put_device(&unit
->dev
);
330 if (sysfs_create_group(&unit
->dev
.kobj
, &zfcp_sysfs_unit_attrs
))
333 write_lock_irq(&port
->unit_list_lock
);
334 list_add_tail(&unit
->list
, &port
->unit_list
);
335 write_unlock_irq(&port
->unit_list_lock
);
337 atomic_set_mask(ZFCP_STATUS_COMMON_RUNNING
, &unit
->status
);
342 device_unregister(&unit
->dev
);
344 put_device(&port
->dev
);
345 return ERR_PTR(retval
);
348 static int zfcp_allocate_low_mem_buffers(struct zfcp_adapter
*adapter
)
350 adapter
->pool
.erp_req
=
351 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req
));
352 if (!adapter
->pool
.erp_req
)
355 adapter
->pool
.gid_pn_req
=
356 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req
));
357 if (!adapter
->pool
.gid_pn_req
)
360 adapter
->pool
.scsi_req
=
361 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req
));
362 if (!adapter
->pool
.scsi_req
)
365 adapter
->pool
.scsi_abort
=
366 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req
));
367 if (!adapter
->pool
.scsi_abort
)
370 adapter
->pool
.status_read_req
=
371 mempool_create_kmalloc_pool(FSF_STATUS_READS_RECOM
,
372 sizeof(struct zfcp_fsf_req
));
373 if (!adapter
->pool
.status_read_req
)
376 adapter
->pool
.qtcb_pool
=
377 mempool_create_slab_pool(4, zfcp_data
.qtcb_cache
);
378 if (!adapter
->pool
.qtcb_pool
)
381 adapter
->pool
.status_read_data
=
382 mempool_create_slab_pool(FSF_STATUS_READS_RECOM
,
383 zfcp_data
.sr_buffer_cache
);
384 if (!adapter
->pool
.status_read_data
)
387 adapter
->pool
.gid_pn
=
388 mempool_create_slab_pool(1, zfcp_data
.gid_pn_cache
);
389 if (!adapter
->pool
.gid_pn
)
395 static void zfcp_free_low_mem_buffers(struct zfcp_adapter
*adapter
)
397 if (adapter
->pool
.erp_req
)
398 mempool_destroy(adapter
->pool
.erp_req
);
399 if (adapter
->pool
.scsi_req
)
400 mempool_destroy(adapter
->pool
.scsi_req
);
401 if (adapter
->pool
.scsi_abort
)
402 mempool_destroy(adapter
->pool
.scsi_abort
);
403 if (adapter
->pool
.qtcb_pool
)
404 mempool_destroy(adapter
->pool
.qtcb_pool
);
405 if (adapter
->pool
.status_read_req
)
406 mempool_destroy(adapter
->pool
.status_read_req
);
407 if (adapter
->pool
.status_read_data
)
408 mempool_destroy(adapter
->pool
.status_read_data
);
409 if (adapter
->pool
.gid_pn
)
410 mempool_destroy(adapter
->pool
.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
->qdio
)) {
426 if (atomic_read(&adapter
->stat_miss
) >=
427 adapter
->stat_read_buf_num
) {
428 zfcp_erp_adapter_reopen(adapter
, 0, "axsref1",
434 atomic_dec(&adapter
->stat_miss
);
438 static void _zfcp_status_read_scheduler(struct work_struct
*work
)
440 zfcp_status_read_refill(container_of(work
, struct zfcp_adapter
,
444 static void zfcp_print_sl(struct seq_file
*m
, struct service_level
*sl
)
446 struct zfcp_adapter
*adapter
=
447 container_of(sl
, struct zfcp_adapter
, service_level
);
449 seq_printf(m
, "zfcp: %s microcode level %x\n",
450 dev_name(&adapter
->ccw_device
->dev
),
451 adapter
->fsf_lic_version
);
454 static int zfcp_setup_adapter_work_queue(struct zfcp_adapter
*adapter
)
456 char name
[TASK_COMM_LEN
];
458 snprintf(name
, sizeof(name
), "zfcp_q_%s",
459 dev_name(&adapter
->ccw_device
->dev
));
460 adapter
->work_queue
= create_singlethread_workqueue(name
);
462 if (adapter
->work_queue
)
467 static void zfcp_destroy_adapter_work_queue(struct zfcp_adapter
*adapter
)
469 if (adapter
->work_queue
)
470 destroy_workqueue(adapter
->work_queue
);
471 adapter
->work_queue
= NULL
;
476 * zfcp_adapter_enqueue - enqueue a new adapter to the list
477 * @ccw_device: pointer to the struct cc_device
479 * Returns: struct zfcp_adapter*
480 * Enqueues an adapter at the end of the adapter list in the driver data.
481 * All adapter internal structures are set up.
482 * Proc-fs entries are also created.
484 struct zfcp_adapter
*zfcp_adapter_enqueue(struct ccw_device
*ccw_device
)
486 struct zfcp_adapter
*adapter
;
488 if (!get_device(&ccw_device
->dev
))
489 return ERR_PTR(-ENODEV
);
491 adapter
= kzalloc(sizeof(struct zfcp_adapter
), GFP_KERNEL
);
493 put_device(&ccw_device
->dev
);
494 return ERR_PTR(-ENOMEM
);
497 kref_init(&adapter
->ref
);
499 ccw_device
->handler
= NULL
;
500 adapter
->ccw_device
= ccw_device
;
502 INIT_WORK(&adapter
->stat_work
, _zfcp_status_read_scheduler
);
503 INIT_WORK(&adapter
->scan_work
, zfcp_fc_scan_ports
);
505 if (zfcp_qdio_setup(adapter
))
508 if (zfcp_allocate_low_mem_buffers(adapter
))
511 adapter
->req_list
= zfcp_reqlist_alloc();
512 if (!adapter
->req_list
)
515 if (zfcp_dbf_adapter_register(adapter
))
518 if (zfcp_setup_adapter_work_queue(adapter
))
521 if (zfcp_fc_gs_setup(adapter
))
524 rwlock_init(&adapter
->port_list_lock
);
525 INIT_LIST_HEAD(&adapter
->port_list
);
527 INIT_LIST_HEAD(&adapter
->events
.list
);
528 INIT_WORK(&adapter
->events
.work
, zfcp_fc_post_event
);
529 spin_lock_init(&adapter
->events
.list_lock
);
531 init_waitqueue_head(&adapter
->erp_ready_wq
);
532 init_waitqueue_head(&adapter
->erp_done_wqh
);
534 INIT_LIST_HEAD(&adapter
->erp_ready_head
);
535 INIT_LIST_HEAD(&adapter
->erp_running_head
);
537 rwlock_init(&adapter
->erp_lock
);
538 rwlock_init(&adapter
->abort_lock
);
540 if (zfcp_erp_thread_setup(adapter
))
543 adapter
->service_level
.seq_print
= zfcp_print_sl
;
545 dev_set_drvdata(&ccw_device
->dev
, adapter
);
547 if (sysfs_create_group(&ccw_device
->dev
.kobj
,
548 &zfcp_sysfs_adapter_attrs
))
551 /* report size limit per scatter-gather segment */
552 adapter
->dma_parms
.max_segment_size
= ZFCP_QDIO_SBALE_LEN
;
553 adapter
->ccw_device
->dev
.dma_parms
= &adapter
->dma_parms
;
555 if (!zfcp_adapter_scsi_register(adapter
))
559 zfcp_adapter_unregister(adapter
);
560 return ERR_PTR(-ENOMEM
);
563 void zfcp_adapter_unregister(struct zfcp_adapter
*adapter
)
565 struct ccw_device
*cdev
= adapter
->ccw_device
;
567 cancel_work_sync(&adapter
->scan_work
);
568 cancel_work_sync(&adapter
->stat_work
);
569 zfcp_destroy_adapter_work_queue(adapter
);
571 zfcp_fc_wka_ports_force_offline(adapter
->gs
);
572 zfcp_adapter_scsi_unregister(adapter
);
573 sysfs_remove_group(&cdev
->dev
.kobj
, &zfcp_sysfs_adapter_attrs
);
575 zfcp_erp_thread_kill(adapter
);
576 zfcp_dbf_adapter_unregister(adapter
->dbf
);
577 zfcp_qdio_destroy(adapter
->qdio
);
579 zfcp_ccw_adapter_put(adapter
); /* final put to release */
583 * zfcp_adapter_release - remove the adapter from the resource list
584 * @ref: pointer to struct kref
585 * locks: adapter list write lock is assumed to be held by caller
587 void zfcp_adapter_release(struct kref
*ref
)
589 struct zfcp_adapter
*adapter
= container_of(ref
, struct zfcp_adapter
,
591 struct ccw_device
*cdev
= adapter
->ccw_device
;
593 dev_set_drvdata(&adapter
->ccw_device
->dev
, NULL
);
594 zfcp_fc_gs_destroy(adapter
);
595 zfcp_free_low_mem_buffers(adapter
);
596 kfree(adapter
->req_list
);
597 kfree(adapter
->fc_stats
);
598 kfree(adapter
->stats_reset_data
);
600 put_device(&cdev
->dev
);
604 * zfcp_device_unregister - remove port, unit from system
605 * @dev: reference to device which is to be removed
606 * @grp: related reference to attribute group
608 * Helper function to unregister port, unit from system
610 void zfcp_device_unregister(struct device
*dev
,
611 const struct attribute_group
*grp
)
613 sysfs_remove_group(&dev
->kobj
, grp
);
614 device_unregister(dev
);
617 static void zfcp_port_release(struct device
*dev
)
619 struct zfcp_port
*port
= container_of(dev
, struct zfcp_port
, dev
);
621 zfcp_ccw_adapter_put(port
->adapter
);
626 * zfcp_port_enqueue - enqueue port to port list of adapter
627 * @adapter: adapter where remote port is added
628 * @wwpn: WWPN of the remote port to be enqueued
629 * @status: initial status for the port
630 * @d_id: destination id of the remote port to be enqueued
631 * Returns: pointer to enqueued port on success, ERR_PTR on error
633 * All port internal structures are set up and the sysfs entry is generated.
634 * d_id is used to enqueue ports with a well known address like the Directory
635 * Service for nameserver lookup.
637 struct zfcp_port
*zfcp_port_enqueue(struct zfcp_adapter
*adapter
, u64 wwpn
,
638 u32 status
, u32 d_id
)
640 struct zfcp_port
*port
;
641 int retval
= -ENOMEM
;
643 kref_get(&adapter
->ref
);
645 port
= zfcp_get_port_by_wwpn(adapter
, wwpn
);
647 put_device(&port
->dev
);
652 port
= kzalloc(sizeof(struct zfcp_port
), GFP_KERNEL
);
656 rwlock_init(&port
->unit_list_lock
);
657 INIT_LIST_HEAD(&port
->unit_list
);
659 INIT_WORK(&port
->gid_pn_work
, zfcp_fc_port_did_lookup
);
660 INIT_WORK(&port
->test_link_work
, zfcp_fc_link_test_work
);
661 INIT_WORK(&port
->rport_work
, zfcp_scsi_rport_work
);
663 port
->adapter
= adapter
;
666 port
->rport_task
= RPORT_NONE
;
667 port
->dev
.parent
= &adapter
->ccw_device
->dev
;
668 port
->dev
.release
= zfcp_port_release
;
670 if (dev_set_name(&port
->dev
, "0x%016llx", (unsigned long long)wwpn
)) {
676 if (device_register(&port
->dev
)) {
677 put_device(&port
->dev
);
681 if (sysfs_create_group(&port
->dev
.kobj
,
682 &zfcp_sysfs_port_attrs
))
685 write_lock_irq(&adapter
->port_list_lock
);
686 list_add_tail(&port
->list
, &adapter
->port_list
);
687 write_unlock_irq(&adapter
->port_list_lock
);
689 atomic_set_mask(status
| ZFCP_STATUS_COMMON_RUNNING
, &port
->status
);
694 device_unregister(&port
->dev
);
696 zfcp_ccw_adapter_put(adapter
);
697 return ERR_PTR(retval
);
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
);