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
= kmalloc(strlen(devstr
) + 1, GFP_KERNEL
);
108 token
= strsep(&str
, ",");
109 if (!token
|| strlen(token
) >= ZFCP_BUS_ID_SIZE
)
111 strncpy(busid
, token
, ZFCP_BUS_ID_SIZE
);
113 token
= strsep(&str
, ",");
114 if (!token
|| strict_strtoull(token
, 0, (unsigned long long *) &wwpn
))
117 token
= strsep(&str
, ",");
118 if (!token
|| strict_strtoull(token
, 0, (unsigned long long *) &lun
))
122 zfcp_init_device_configure(busid
, wwpn
, lun
);
127 pr_err("%s is not a valid SCSI device\n", devstr
);
130 static int __init
zfcp_module_init(void)
132 int retval
= -ENOMEM
;
134 zfcp_data
.gpn_ft_cache
= zfcp_cache_hw_align("zfcp_gpn",
135 sizeof(struct zfcp_fc_gpn_ft_req
));
136 if (!zfcp_data
.gpn_ft_cache
)
139 zfcp_data
.qtcb_cache
= zfcp_cache_hw_align("zfcp_qtcb",
140 sizeof(struct fsf_qtcb
));
141 if (!zfcp_data
.qtcb_cache
)
144 zfcp_data
.sr_buffer_cache
= zfcp_cache_hw_align("zfcp_sr",
145 sizeof(struct fsf_status_read_buffer
));
146 if (!zfcp_data
.sr_buffer_cache
)
149 zfcp_data
.gid_pn_cache
= zfcp_cache_hw_align("zfcp_gid",
150 sizeof(struct zfcp_fc_gid_pn
));
151 if (!zfcp_data
.gid_pn_cache
)
154 zfcp_data
.adisc_cache
= zfcp_cache_hw_align("zfcp_adisc",
155 sizeof(struct zfcp_fc_els_adisc
));
156 if (!zfcp_data
.adisc_cache
)
157 goto out_adisc_cache
;
159 zfcp_data
.scsi_transport_template
=
160 fc_attach_transport(&zfcp_transport_functions
);
161 if (!zfcp_data
.scsi_transport_template
)
164 retval
= misc_register(&zfcp_cfdc_misc
);
166 pr_err("Registering the misc device zfcp_cfdc failed\n");
170 retval
= ccw_driver_register(&zfcp_ccw_driver
);
172 pr_err("The zfcp device driver could not register with "
173 "the common I/O layer\n");
174 goto out_ccw_register
;
178 zfcp_init_device_setup(init_device
);
182 misc_deregister(&zfcp_cfdc_misc
);
184 fc_release_transport(zfcp_data
.scsi_transport_template
);
186 kmem_cache_destroy(zfcp_data
.adisc_cache
);
188 kmem_cache_destroy(zfcp_data
.gid_pn_cache
);
190 kmem_cache_destroy(zfcp_data
.sr_buffer_cache
);
192 kmem_cache_destroy(zfcp_data
.qtcb_cache
);
194 kmem_cache_destroy(zfcp_data
.gpn_ft_cache
);
199 module_init(zfcp_module_init
);
201 static void __exit
zfcp_module_exit(void)
203 ccw_driver_unregister(&zfcp_ccw_driver
);
204 misc_deregister(&zfcp_cfdc_misc
);
205 fc_release_transport(zfcp_data
.scsi_transport_template
);
206 kmem_cache_destroy(zfcp_data
.adisc_cache
);
207 kmem_cache_destroy(zfcp_data
.gid_pn_cache
);
208 kmem_cache_destroy(zfcp_data
.sr_buffer_cache
);
209 kmem_cache_destroy(zfcp_data
.qtcb_cache
);
210 kmem_cache_destroy(zfcp_data
.gpn_ft_cache
);
213 module_exit(zfcp_module_exit
);
216 * zfcp_get_unit_by_lun - find unit in unit list of port by FCP LUN
217 * @port: pointer to port to search for unit
218 * @fcp_lun: FCP LUN to search for
220 * Returns: pointer to zfcp_unit or NULL
222 struct zfcp_unit
*zfcp_get_unit_by_lun(struct zfcp_port
*port
, u64 fcp_lun
)
225 struct zfcp_unit
*unit
;
227 read_lock_irqsave(&port
->unit_list_lock
, flags
);
228 list_for_each_entry(unit
, &port
->unit_list
, list
)
229 if (unit
->fcp_lun
== fcp_lun
) {
230 if (!get_device(&unit
->dev
))
232 read_unlock_irqrestore(&port
->unit_list_lock
, flags
);
235 read_unlock_irqrestore(&port
->unit_list_lock
, flags
);
240 * zfcp_get_port_by_wwpn - find port in port list of adapter by wwpn
241 * @adapter: pointer to adapter to search for port
242 * @wwpn: wwpn to search for
244 * Returns: pointer to zfcp_port or NULL
246 struct zfcp_port
*zfcp_get_port_by_wwpn(struct zfcp_adapter
*adapter
,
250 struct zfcp_port
*port
;
252 read_lock_irqsave(&adapter
->port_list_lock
, flags
);
253 list_for_each_entry(port
, &adapter
->port_list
, list
)
254 if (port
->wwpn
== wwpn
) {
255 if (!get_device(&port
->dev
))
257 read_unlock_irqrestore(&adapter
->port_list_lock
, flags
);
260 read_unlock_irqrestore(&adapter
->port_list_lock
, flags
);
265 * zfcp_unit_release - dequeue unit
266 * @dev: pointer to device
268 * waits until all work is done on unit and removes it then from the unit->list
269 * of the associated port.
271 static void zfcp_unit_release(struct device
*dev
)
273 struct zfcp_unit
*unit
= container_of(dev
, struct zfcp_unit
, dev
);
275 put_device(&unit
->port
->dev
);
280 * zfcp_unit_enqueue - enqueue unit to unit list of a port.
281 * @port: pointer to port where unit is added
282 * @fcp_lun: FCP LUN of unit to be enqueued
283 * Returns: pointer to enqueued unit on success, ERR_PTR on error
285 * Sets up some unit internal structures and creates sysfs entry.
287 struct zfcp_unit
*zfcp_unit_enqueue(struct zfcp_port
*port
, u64 fcp_lun
)
289 struct zfcp_unit
*unit
;
290 int retval
= -ENOMEM
;
292 get_device(&port
->dev
);
294 unit
= zfcp_get_unit_by_lun(port
, fcp_lun
);
296 put_device(&unit
->dev
);
301 unit
= kzalloc(sizeof(struct zfcp_unit
), GFP_KERNEL
);
306 unit
->fcp_lun
= fcp_lun
;
307 unit
->dev
.parent
= &port
->dev
;
308 unit
->dev
.release
= zfcp_unit_release
;
310 if (dev_set_name(&unit
->dev
, "0x%016llx",
311 (unsigned long long) fcp_lun
)) {
317 INIT_WORK(&unit
->scsi_work
, zfcp_scsi_scan
);
319 spin_lock_init(&unit
->latencies
.lock
);
320 unit
->latencies
.write
.channel
.min
= 0xFFFFFFFF;
321 unit
->latencies
.write
.fabric
.min
= 0xFFFFFFFF;
322 unit
->latencies
.read
.channel
.min
= 0xFFFFFFFF;
323 unit
->latencies
.read
.fabric
.min
= 0xFFFFFFFF;
324 unit
->latencies
.cmd
.channel
.min
= 0xFFFFFFFF;
325 unit
->latencies
.cmd
.fabric
.min
= 0xFFFFFFFF;
327 if (device_register(&unit
->dev
)) {
328 put_device(&unit
->dev
);
332 if (sysfs_create_group(&unit
->dev
.kobj
, &zfcp_sysfs_unit_attrs
))
335 write_lock_irq(&port
->unit_list_lock
);
336 list_add_tail(&unit
->list
, &port
->unit_list
);
337 write_unlock_irq(&port
->unit_list_lock
);
339 atomic_set_mask(ZFCP_STATUS_COMMON_RUNNING
, &unit
->status
);
344 device_unregister(&unit
->dev
);
346 put_device(&port
->dev
);
347 return ERR_PTR(retval
);
350 static int zfcp_allocate_low_mem_buffers(struct zfcp_adapter
*adapter
)
352 adapter
->pool
.erp_req
=
353 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req
));
354 if (!adapter
->pool
.erp_req
)
357 adapter
->pool
.gid_pn_req
=
358 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req
));
359 if (!adapter
->pool
.gid_pn_req
)
362 adapter
->pool
.scsi_req
=
363 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req
));
364 if (!adapter
->pool
.scsi_req
)
367 adapter
->pool
.scsi_abort
=
368 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req
));
369 if (!adapter
->pool
.scsi_abort
)
372 adapter
->pool
.status_read_req
=
373 mempool_create_kmalloc_pool(FSF_STATUS_READS_RECOM
,
374 sizeof(struct zfcp_fsf_req
));
375 if (!adapter
->pool
.status_read_req
)
378 adapter
->pool
.qtcb_pool
=
379 mempool_create_slab_pool(4, zfcp_data
.qtcb_cache
);
380 if (!adapter
->pool
.qtcb_pool
)
383 adapter
->pool
.status_read_data
=
384 mempool_create_slab_pool(FSF_STATUS_READS_RECOM
,
385 zfcp_data
.sr_buffer_cache
);
386 if (!adapter
->pool
.status_read_data
)
389 adapter
->pool
.gid_pn
=
390 mempool_create_slab_pool(1, zfcp_data
.gid_pn_cache
);
391 if (!adapter
->pool
.gid_pn
)
397 static void zfcp_free_low_mem_buffers(struct zfcp_adapter
*adapter
)
399 if (adapter
->pool
.erp_req
)
400 mempool_destroy(adapter
->pool
.erp_req
);
401 if (adapter
->pool
.scsi_req
)
402 mempool_destroy(adapter
->pool
.scsi_req
);
403 if (adapter
->pool
.scsi_abort
)
404 mempool_destroy(adapter
->pool
.scsi_abort
);
405 if (adapter
->pool
.qtcb_pool
)
406 mempool_destroy(adapter
->pool
.qtcb_pool
);
407 if (adapter
->pool
.status_read_req
)
408 mempool_destroy(adapter
->pool
.status_read_req
);
409 if (adapter
->pool
.status_read_data
)
410 mempool_destroy(adapter
->pool
.status_read_data
);
411 if (adapter
->pool
.gid_pn
)
412 mempool_destroy(adapter
->pool
.gid_pn
);
416 * zfcp_status_read_refill - refill the long running status_read_requests
417 * @adapter: ptr to struct zfcp_adapter for which the buffers should be refilled
419 * Returns: 0 on success, 1 otherwise
421 * if there are 16 or more status_read requests missing an adapter_reopen
424 int zfcp_status_read_refill(struct zfcp_adapter
*adapter
)
426 while (atomic_read(&adapter
->stat_miss
) > 0)
427 if (zfcp_fsf_status_read(adapter
->qdio
)) {
428 if (atomic_read(&adapter
->stat_miss
) >=
429 adapter
->stat_read_buf_num
) {
430 zfcp_erp_adapter_reopen(adapter
, 0, "axsref1",
436 atomic_dec(&adapter
->stat_miss
);
440 static void _zfcp_status_read_scheduler(struct work_struct
*work
)
442 zfcp_status_read_refill(container_of(work
, struct zfcp_adapter
,
446 static void zfcp_print_sl(struct seq_file
*m
, struct service_level
*sl
)
448 struct zfcp_adapter
*adapter
=
449 container_of(sl
, struct zfcp_adapter
, service_level
);
451 seq_printf(m
, "zfcp: %s microcode level %x\n",
452 dev_name(&adapter
->ccw_device
->dev
),
453 adapter
->fsf_lic_version
);
456 static int zfcp_setup_adapter_work_queue(struct zfcp_adapter
*adapter
)
458 char name
[TASK_COMM_LEN
];
460 snprintf(name
, sizeof(name
), "zfcp_q_%s",
461 dev_name(&adapter
->ccw_device
->dev
));
462 adapter
->work_queue
= create_singlethread_workqueue(name
);
464 if (adapter
->work_queue
)
469 static void zfcp_destroy_adapter_work_queue(struct zfcp_adapter
*adapter
)
471 if (adapter
->work_queue
)
472 destroy_workqueue(adapter
->work_queue
);
473 adapter
->work_queue
= NULL
;
478 * zfcp_adapter_enqueue - enqueue a new adapter to the list
479 * @ccw_device: pointer to the struct cc_device
481 * Returns: struct zfcp_adapter*
482 * Enqueues an adapter at the end of the adapter list in the driver data.
483 * All adapter internal structures are set up.
484 * Proc-fs entries are also created.
486 struct zfcp_adapter
*zfcp_adapter_enqueue(struct ccw_device
*ccw_device
)
488 struct zfcp_adapter
*adapter
;
490 if (!get_device(&ccw_device
->dev
))
491 return ERR_PTR(-ENODEV
);
493 adapter
= kzalloc(sizeof(struct zfcp_adapter
), GFP_KERNEL
);
495 put_device(&ccw_device
->dev
);
496 return ERR_PTR(-ENOMEM
);
499 kref_init(&adapter
->ref
);
501 ccw_device
->handler
= NULL
;
502 adapter
->ccw_device
= ccw_device
;
504 INIT_WORK(&adapter
->stat_work
, _zfcp_status_read_scheduler
);
505 INIT_WORK(&adapter
->scan_work
, zfcp_fc_scan_ports
);
507 if (zfcp_qdio_setup(adapter
))
510 if (zfcp_allocate_low_mem_buffers(adapter
))
513 adapter
->req_list
= zfcp_reqlist_alloc();
514 if (!adapter
->req_list
)
517 if (zfcp_dbf_adapter_register(adapter
))
520 if (zfcp_setup_adapter_work_queue(adapter
))
523 if (zfcp_fc_gs_setup(adapter
))
526 rwlock_init(&adapter
->port_list_lock
);
527 INIT_LIST_HEAD(&adapter
->port_list
);
529 init_waitqueue_head(&adapter
->erp_ready_wq
);
530 init_waitqueue_head(&adapter
->erp_done_wqh
);
532 INIT_LIST_HEAD(&adapter
->erp_ready_head
);
533 INIT_LIST_HEAD(&adapter
->erp_running_head
);
535 rwlock_init(&adapter
->erp_lock
);
536 rwlock_init(&adapter
->abort_lock
);
538 if (zfcp_erp_thread_setup(adapter
))
541 adapter
->service_level
.seq_print
= zfcp_print_sl
;
543 dev_set_drvdata(&ccw_device
->dev
, adapter
);
545 if (sysfs_create_group(&ccw_device
->dev
.kobj
,
546 &zfcp_sysfs_adapter_attrs
))
549 /* report size limit per scatter-gather segment */
550 adapter
->dma_parms
.max_segment_size
= ZFCP_QDIO_SBALE_LEN
;
551 adapter
->ccw_device
->dev
.dma_parms
= &adapter
->dma_parms
;
553 if (!zfcp_adapter_scsi_register(adapter
))
557 zfcp_adapter_unregister(adapter
);
558 return ERR_PTR(-ENOMEM
);
561 void zfcp_adapter_unregister(struct zfcp_adapter
*adapter
)
563 struct ccw_device
*cdev
= adapter
->ccw_device
;
565 cancel_work_sync(&adapter
->scan_work
);
566 cancel_work_sync(&adapter
->stat_work
);
567 zfcp_destroy_adapter_work_queue(adapter
);
569 zfcp_fc_wka_ports_force_offline(adapter
->gs
);
570 zfcp_adapter_scsi_unregister(adapter
);
571 sysfs_remove_group(&cdev
->dev
.kobj
, &zfcp_sysfs_adapter_attrs
);
573 zfcp_erp_thread_kill(adapter
);
574 zfcp_dbf_adapter_unregister(adapter
->dbf
);
575 zfcp_qdio_destroy(adapter
->qdio
);
577 zfcp_ccw_adapter_put(adapter
); /* final put to release */
581 * zfcp_adapter_release - remove the adapter from the resource list
582 * @ref: pointer to struct kref
583 * locks: adapter list write lock is assumed to be held by caller
585 void zfcp_adapter_release(struct kref
*ref
)
587 struct zfcp_adapter
*adapter
= container_of(ref
, struct zfcp_adapter
,
589 struct ccw_device
*cdev
= adapter
->ccw_device
;
591 dev_set_drvdata(&adapter
->ccw_device
->dev
, NULL
);
592 zfcp_fc_gs_destroy(adapter
);
593 zfcp_free_low_mem_buffers(adapter
);
594 kfree(adapter
->req_list
);
595 kfree(adapter
->fc_stats
);
596 kfree(adapter
->stats_reset_data
);
598 put_device(&cdev
->dev
);
602 * zfcp_device_unregister - remove port, unit from system
603 * @dev: reference to device which is to be removed
604 * @grp: related reference to attribute group
606 * Helper function to unregister port, unit from system
608 void zfcp_device_unregister(struct device
*dev
,
609 const struct attribute_group
*grp
)
611 sysfs_remove_group(&dev
->kobj
, grp
);
612 device_unregister(dev
);
615 static void zfcp_port_release(struct device
*dev
)
617 struct zfcp_port
*port
= container_of(dev
, struct zfcp_port
, dev
);
619 zfcp_ccw_adapter_put(port
->adapter
);
624 * zfcp_port_enqueue - enqueue port to port list of adapter
625 * @adapter: adapter where remote port is added
626 * @wwpn: WWPN of the remote port to be enqueued
627 * @status: initial status for the port
628 * @d_id: destination id of the remote port to be enqueued
629 * Returns: pointer to enqueued port on success, ERR_PTR on error
631 * All port internal structures are set up and the sysfs entry is generated.
632 * d_id is used to enqueue ports with a well known address like the Directory
633 * Service for nameserver lookup.
635 struct zfcp_port
*zfcp_port_enqueue(struct zfcp_adapter
*adapter
, u64 wwpn
,
636 u32 status
, u32 d_id
)
638 struct zfcp_port
*port
;
639 int retval
= -ENOMEM
;
641 kref_get(&adapter
->ref
);
643 port
= zfcp_get_port_by_wwpn(adapter
, wwpn
);
645 put_device(&port
->dev
);
650 port
= kzalloc(sizeof(struct zfcp_port
), GFP_KERNEL
);
654 rwlock_init(&port
->unit_list_lock
);
655 INIT_LIST_HEAD(&port
->unit_list
);
657 INIT_WORK(&port
->gid_pn_work
, zfcp_fc_port_did_lookup
);
658 INIT_WORK(&port
->test_link_work
, zfcp_fc_link_test_work
);
659 INIT_WORK(&port
->rport_work
, zfcp_scsi_rport_work
);
661 port
->adapter
= adapter
;
664 port
->rport_task
= RPORT_NONE
;
665 port
->dev
.parent
= &adapter
->ccw_device
->dev
;
666 port
->dev
.release
= zfcp_port_release
;
668 if (dev_set_name(&port
->dev
, "0x%016llx", (unsigned long long)wwpn
)) {
674 if (device_register(&port
->dev
)) {
675 put_device(&port
->dev
);
679 if (sysfs_create_group(&port
->dev
.kobj
,
680 &zfcp_sysfs_port_attrs
))
683 write_lock_irq(&adapter
->port_list_lock
);
684 list_add_tail(&port
->list
, &adapter
->port_list
);
685 write_unlock_irq(&adapter
->port_list_lock
);
687 atomic_set_mask(status
| ZFCP_STATUS_COMMON_RUNNING
, &port
->status
);
692 device_unregister(&port
->dev
);
694 zfcp_ccw_adapter_put(adapter
);
695 return ERR_PTR(retval
);
699 * zfcp_sg_free_table - free memory used by scatterlists
700 * @sg: pointer to scatterlist
701 * @count: number of scatterlist which are to be free'ed
702 * the scatterlist are expected to reference pages always
704 void zfcp_sg_free_table(struct scatterlist
*sg
, int count
)
708 for (i
= 0; i
< count
; i
++, sg
++)
710 free_page((unsigned long) sg_virt(sg
));
716 * zfcp_sg_setup_table - init scatterlist and allocate, assign buffers
717 * @sg: pointer to struct scatterlist
718 * @count: number of scatterlists which should be assigned with buffers
721 * Returns: 0 on success, -ENOMEM otherwise
723 int zfcp_sg_setup_table(struct scatterlist
*sg
, int count
)
728 sg_init_table(sg
, count
);
729 for (i
= 0; i
< count
; i
++, sg
++) {
730 addr
= (void *) get_zeroed_page(GFP_KERNEL
);
732 zfcp_sg_free_table(sg
, i
);
735 sg_set_buf(sg
, addr
, PAGE_SIZE
);