4 * Module interface and handling of zfcp data structures.
6 * Copyright IBM Corporation 2002, 2009
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>
35 #define ZFCP_BUS_ID_SIZE 20
37 MODULE_AUTHOR("IBM Deutschland Entwicklung GmbH - linux390@de.ibm.com");
38 MODULE_DESCRIPTION("FCP HBA driver");
39 MODULE_LICENSE("GPL");
41 static char *init_device
;
42 module_param_named(device
, init_device
, charp
, 0400);
43 MODULE_PARM_DESC(device
, "specify initial device");
45 static int zfcp_reqlist_alloc(struct zfcp_adapter
*adapter
)
49 adapter
->req_list
= kcalloc(REQUEST_LIST_SIZE
, sizeof(struct list_head
),
51 if (!adapter
->req_list
)
54 for (idx
= 0; idx
< REQUEST_LIST_SIZE
; idx
++)
55 INIT_LIST_HEAD(&adapter
->req_list
[idx
]);
60 * zfcp_reqlist_isempty - is the request list empty
61 * @adapter: pointer to struct zfcp_adapter
63 * Returns: true if list is empty, false otherwise
65 int zfcp_reqlist_isempty(struct zfcp_adapter
*adapter
)
69 for (idx
= 0; idx
< REQUEST_LIST_SIZE
; idx
++)
70 if (!list_empty(&adapter
->req_list
[idx
]))
75 static void __init
zfcp_init_device_configure(char *busid
, u64 wwpn
, u64 lun
)
77 struct zfcp_adapter
*adapter
;
78 struct zfcp_port
*port
;
79 struct zfcp_unit
*unit
;
81 down(&zfcp_data
.config_sema
);
82 read_lock_irq(&zfcp_data
.config_lock
);
83 adapter
= zfcp_get_adapter_by_busid(busid
);
85 zfcp_adapter_get(adapter
);
86 read_unlock_irq(&zfcp_data
.config_lock
);
90 port
= zfcp_port_enqueue(adapter
, wwpn
, 0, 0);
93 unit
= zfcp_unit_enqueue(port
, lun
);
96 up(&zfcp_data
.config_sema
);
97 ccw_device_set_online(adapter
->ccw_device
);
99 zfcp_erp_wait(adapter
);
100 flush_work(&unit
->scsi_work
);
102 down(&zfcp_data
.config_sema
);
107 zfcp_adapter_put(adapter
);
109 up(&zfcp_data
.config_sema
);
113 static struct kmem_cache
*zfcp_cache_create(int size
, char *name
)
116 while ((size
- align
) > 0)
118 return kmem_cache_create(name
, size
, align
, 0, NULL
);
121 static void __init
zfcp_init_device_setup(char *devstr
)
125 char busid
[ZFCP_BUS_ID_SIZE
];
128 /* duplicate devstr and keep the original for sysfs presentation*/
129 str
= kmalloc(strlen(devstr
) + 1, GFP_KERNEL
);
135 token
= strsep(&str
, ",");
136 if (!token
|| strlen(token
) >= ZFCP_BUS_ID_SIZE
)
138 strncpy(busid
, token
, ZFCP_BUS_ID_SIZE
);
140 token
= strsep(&str
, ",");
141 if (!token
|| strict_strtoull(token
, 0, (unsigned long long *) &wwpn
))
144 token
= strsep(&str
, ",");
145 if (!token
|| strict_strtoull(token
, 0, (unsigned long long *) &lun
))
149 zfcp_init_device_configure(busid
, wwpn
, lun
);
154 pr_err("%s is not a valid SCSI device\n", devstr
);
157 static int __init
zfcp_module_init(void)
159 int retval
= -ENOMEM
;
161 zfcp_data
.fsf_req_qtcb_cache
= zfcp_cache_create(
162 sizeof(struct zfcp_fsf_req_qtcb
), "zfcp_fsf");
163 if (!zfcp_data
.fsf_req_qtcb_cache
)
166 zfcp_data
.sr_buffer_cache
= zfcp_cache_create(
167 sizeof(struct fsf_status_read_buffer
), "zfcp_sr");
168 if (!zfcp_data
.sr_buffer_cache
)
171 zfcp_data
.gid_pn_cache
= zfcp_cache_create(
172 sizeof(struct zfcp_gid_pn_data
), "zfcp_gid");
173 if (!zfcp_data
.gid_pn_cache
)
176 zfcp_data
.work_queue
= create_singlethread_workqueue("zfcp_wq");
178 sema_init(&zfcp_data
.config_sema
, 1);
179 rwlock_init(&zfcp_data
.config_lock
);
181 zfcp_data
.scsi_transport_template
=
182 fc_attach_transport(&zfcp_transport_functions
);
183 if (!zfcp_data
.scsi_transport_template
)
186 retval
= misc_register(&zfcp_cfdc_misc
);
188 pr_err("Registering the misc device zfcp_cfdc failed\n");
192 retval
= zfcp_ccw_register();
194 pr_err("The zfcp device driver could not register with "
195 "the common I/O layer\n");
196 goto out_ccw_register
;
200 zfcp_init_device_setup(init_device
);
204 misc_deregister(&zfcp_cfdc_misc
);
206 fc_release_transport(zfcp_data
.scsi_transport_template
);
208 kmem_cache_destroy(zfcp_data
.gid_pn_cache
);
210 kmem_cache_destroy(zfcp_data
.sr_buffer_cache
);
212 kmem_cache_destroy(zfcp_data
.fsf_req_qtcb_cache
);
217 module_init(zfcp_module_init
);
220 * zfcp_get_unit_by_lun - find unit in unit list of port by FCP LUN
221 * @port: pointer to port to search for unit
222 * @fcp_lun: FCP LUN to search for
224 * Returns: pointer to zfcp_unit or NULL
226 struct zfcp_unit
*zfcp_get_unit_by_lun(struct zfcp_port
*port
, u64 fcp_lun
)
228 struct zfcp_unit
*unit
;
230 list_for_each_entry(unit
, &port
->unit_list_head
, list
)
231 if ((unit
->fcp_lun
== fcp_lun
) &&
232 !(atomic_read(&unit
->status
) & ZFCP_STATUS_COMMON_REMOVE
))
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
,
247 struct zfcp_port
*port
;
249 list_for_each_entry(port
, &adapter
->port_list_head
, list
)
250 if ((port
->wwpn
== wwpn
) &&
251 !(atomic_read(&port
->status
) & ZFCP_STATUS_COMMON_REMOVE
))
256 static void zfcp_sysfs_unit_release(struct device
*dev
)
258 kfree(container_of(dev
, struct zfcp_unit
, sysfs_device
));
262 * zfcp_unit_enqueue - enqueue unit to unit list of a port.
263 * @port: pointer to port where unit is added
264 * @fcp_lun: FCP LUN of unit to be enqueued
265 * Returns: pointer to enqueued unit on success, ERR_PTR on error
266 * Locks: config_sema must be held to serialize changes to the unit list
268 * Sets up some unit internal structures and creates sysfs entry.
270 struct zfcp_unit
*zfcp_unit_enqueue(struct zfcp_port
*port
, u64 fcp_lun
)
272 struct zfcp_unit
*unit
;
274 unit
= kzalloc(sizeof(struct zfcp_unit
), GFP_KERNEL
);
276 return ERR_PTR(-ENOMEM
);
278 atomic_set(&unit
->refcount
, 0);
279 init_waitqueue_head(&unit
->remove_wq
);
280 INIT_WORK(&unit
->scsi_work
, zfcp_scsi_scan
);
283 unit
->fcp_lun
= fcp_lun
;
285 dev_set_name(&unit
->sysfs_device
, "0x%016llx",
286 (unsigned long long) fcp_lun
);
287 unit
->sysfs_device
.parent
= &port
->sysfs_device
;
288 unit
->sysfs_device
.release
= zfcp_sysfs_unit_release
;
289 dev_set_drvdata(&unit
->sysfs_device
, unit
);
291 /* mark unit unusable as long as sysfs registration is not complete */
292 atomic_set_mask(ZFCP_STATUS_COMMON_REMOVE
, &unit
->status
);
294 spin_lock_init(&unit
->latencies
.lock
);
295 unit
->latencies
.write
.channel
.min
= 0xFFFFFFFF;
296 unit
->latencies
.write
.fabric
.min
= 0xFFFFFFFF;
297 unit
->latencies
.read
.channel
.min
= 0xFFFFFFFF;
298 unit
->latencies
.read
.fabric
.min
= 0xFFFFFFFF;
299 unit
->latencies
.cmd
.channel
.min
= 0xFFFFFFFF;
300 unit
->latencies
.cmd
.fabric
.min
= 0xFFFFFFFF;
302 read_lock_irq(&zfcp_data
.config_lock
);
303 if (zfcp_get_unit_by_lun(port
, fcp_lun
)) {
304 read_unlock_irq(&zfcp_data
.config_lock
);
307 read_unlock_irq(&zfcp_data
.config_lock
);
309 if (device_register(&unit
->sysfs_device
))
312 if (sysfs_create_group(&unit
->sysfs_device
.kobj
,
313 &zfcp_sysfs_unit_attrs
)) {
314 device_unregister(&unit
->sysfs_device
);
315 return ERR_PTR(-EIO
);
320 write_lock_irq(&zfcp_data
.config_lock
);
321 list_add_tail(&unit
->list
, &port
->unit_list_head
);
322 atomic_clear_mask(ZFCP_STATUS_COMMON_REMOVE
, &unit
->status
);
323 atomic_set_mask(ZFCP_STATUS_COMMON_RUNNING
, &unit
->status
);
325 write_unlock_irq(&zfcp_data
.config_lock
);
333 return ERR_PTR(-EINVAL
);
337 * zfcp_unit_dequeue - dequeue unit
338 * @unit: pointer to zfcp_unit
340 * waits until all work is done on unit and removes it then from the unit->list
341 * of the associated port.
343 void zfcp_unit_dequeue(struct zfcp_unit
*unit
)
345 wait_event(unit
->remove_wq
, atomic_read(&unit
->refcount
) == 0);
346 write_lock_irq(&zfcp_data
.config_lock
);
347 list_del(&unit
->list
);
348 write_unlock_irq(&zfcp_data
.config_lock
);
349 zfcp_port_put(unit
->port
);
350 sysfs_remove_group(&unit
->sysfs_device
.kobj
, &zfcp_sysfs_unit_attrs
);
351 device_unregister(&unit
->sysfs_device
);
354 static int zfcp_allocate_low_mem_buffers(struct zfcp_adapter
*adapter
)
356 /* must only be called with zfcp_data.config_sema taken */
357 adapter
->pool
.fsf_req_erp
=
358 mempool_create_slab_pool(1, zfcp_data
.fsf_req_qtcb_cache
);
359 if (!adapter
->pool
.fsf_req_erp
)
362 adapter
->pool
.fsf_req_scsi
=
363 mempool_create_slab_pool(1, zfcp_data
.fsf_req_qtcb_cache
);
364 if (!adapter
->pool
.fsf_req_scsi
)
367 adapter
->pool
.fsf_req_abort
=
368 mempool_create_slab_pool(1, zfcp_data
.fsf_req_qtcb_cache
);
369 if (!adapter
->pool
.fsf_req_abort
)
372 adapter
->pool
.fsf_req_status_read
=
373 mempool_create_kmalloc_pool(FSF_STATUS_READS_RECOM
,
374 sizeof(struct zfcp_fsf_req
));
375 if (!adapter
->pool
.fsf_req_status_read
)
378 adapter
->pool
.data_status_read
=
379 mempool_create_slab_pool(FSF_STATUS_READS_RECOM
,
380 zfcp_data
.sr_buffer_cache
);
381 if (!adapter
->pool
.data_status_read
)
384 adapter
->pool
.data_gid_pn
=
385 mempool_create_slab_pool(1, zfcp_data
.gid_pn_cache
);
386 if (!adapter
->pool
.data_gid_pn
)
392 static void zfcp_free_low_mem_buffers(struct zfcp_adapter
*adapter
)
394 /* zfcp_data.config_sema must be held */
395 if (adapter
->pool
.fsf_req_erp
)
396 mempool_destroy(adapter
->pool
.fsf_req_erp
);
397 if (adapter
->pool
.fsf_req_scsi
)
398 mempool_destroy(adapter
->pool
.fsf_req_scsi
);
399 if (adapter
->pool
.fsf_req_abort
)
400 mempool_destroy(adapter
->pool
.fsf_req_abort
);
401 if (adapter
->pool
.fsf_req_status_read
)
402 mempool_destroy(adapter
->pool
.fsf_req_status_read
);
403 if (adapter
->pool
.data_status_read
)
404 mempool_destroy(adapter
->pool
.data_status_read
);
405 if (adapter
->pool
.data_gid_pn
)
406 mempool_destroy(adapter
->pool
.data_gid_pn
);
410 * zfcp_status_read_refill - refill the long running status_read_requests
411 * @adapter: ptr to struct zfcp_adapter for which the buffers should be refilled
413 * Returns: 0 on success, 1 otherwise
415 * if there are 16 or more status_read requests missing an adapter_reopen
418 int zfcp_status_read_refill(struct zfcp_adapter
*adapter
)
420 while (atomic_read(&adapter
->stat_miss
) > 0)
421 if (zfcp_fsf_status_read(adapter
)) {
422 if (atomic_read(&adapter
->stat_miss
) >= 16) {
423 zfcp_erp_adapter_reopen(adapter
, 0, "axsref1",
429 atomic_dec(&adapter
->stat_miss
);
433 static void _zfcp_status_read_scheduler(struct work_struct
*work
)
435 zfcp_status_read_refill(container_of(work
, struct zfcp_adapter
,
439 static void zfcp_print_sl(struct seq_file
*m
, struct service_level
*sl
)
441 struct zfcp_adapter
*adapter
=
442 container_of(sl
, struct zfcp_adapter
, service_level
);
444 seq_printf(m
, "zfcp: %s microcode level %x\n",
445 dev_name(&adapter
->ccw_device
->dev
),
446 adapter
->fsf_lic_version
);
450 * zfcp_adapter_enqueue - enqueue a new adapter to the list
451 * @ccw_device: pointer to the struct cc_device
453 * Returns: 0 if a new adapter was successfully enqueued
454 * -ENOMEM if alloc failed
455 * Enqueues an adapter at the end of the adapter list in the driver data.
456 * All adapter internal structures are set up.
457 * Proc-fs entries are also created.
458 * locks: config_sema must be held to serialise changes to the adapter list
460 int zfcp_adapter_enqueue(struct ccw_device
*ccw_device
)
462 struct zfcp_adapter
*adapter
;
465 * Note: It is safe to release the list_lock, as any list changes
466 * are protected by the config_sema, which must be held to get here
469 adapter
= kzalloc(sizeof(struct zfcp_adapter
), GFP_KERNEL
);
473 adapter
->gs
= kzalloc(sizeof(struct zfcp_wka_ports
), GFP_KERNEL
);
479 ccw_device
->handler
= NULL
;
480 adapter
->ccw_device
= ccw_device
;
481 atomic_set(&adapter
->refcount
, 0);
483 if (zfcp_qdio_allocate(adapter
))
484 goto qdio_allocate_failed
;
486 if (zfcp_allocate_low_mem_buffers(adapter
))
487 goto failed_low_mem_buffers
;
489 if (zfcp_reqlist_alloc(adapter
))
490 goto failed_low_mem_buffers
;
492 if (zfcp_adapter_debug_register(adapter
))
493 goto debug_register_failed
;
495 init_waitqueue_head(&adapter
->remove_wq
);
496 init_waitqueue_head(&adapter
->erp_thread_wqh
);
497 init_waitqueue_head(&adapter
->erp_done_wqh
);
499 INIT_LIST_HEAD(&adapter
->port_list_head
);
500 INIT_LIST_HEAD(&adapter
->erp_ready_head
);
501 INIT_LIST_HEAD(&adapter
->erp_running_head
);
503 spin_lock_init(&adapter
->req_list_lock
);
505 spin_lock_init(&adapter
->hba_dbf_lock
);
506 spin_lock_init(&adapter
->san_dbf_lock
);
507 spin_lock_init(&adapter
->scsi_dbf_lock
);
508 spin_lock_init(&adapter
->rec_dbf_lock
);
509 spin_lock_init(&adapter
->req_q_lock
);
510 spin_lock_init(&adapter
->qdio_stat_lock
);
512 rwlock_init(&adapter
->erp_lock
);
513 rwlock_init(&adapter
->abort_lock
);
515 sema_init(&adapter
->erp_ready_sem
, 0);
517 INIT_WORK(&adapter
->stat_work
, _zfcp_status_read_scheduler
);
518 INIT_WORK(&adapter
->scan_work
, _zfcp_scan_ports_later
);
520 adapter
->service_level
.seq_print
= zfcp_print_sl
;
522 /* mark adapter unusable as long as sysfs registration is not complete */
523 atomic_set_mask(ZFCP_STATUS_COMMON_REMOVE
, &adapter
->status
);
525 dev_set_drvdata(&ccw_device
->dev
, adapter
);
527 if (sysfs_create_group(&ccw_device
->dev
.kobj
,
528 &zfcp_sysfs_adapter_attrs
))
531 atomic_clear_mask(ZFCP_STATUS_COMMON_REMOVE
, &adapter
->status
);
532 zfcp_fc_wka_ports_init(adapter
);
534 if (!zfcp_adapter_scsi_register(adapter
))
538 zfcp_adapter_debug_unregister(adapter
);
539 debug_register_failed
:
540 dev_set_drvdata(&ccw_device
->dev
, NULL
);
541 kfree(adapter
->req_list
);
542 failed_low_mem_buffers
:
543 zfcp_free_low_mem_buffers(adapter
);
544 qdio_allocate_failed
:
545 zfcp_qdio_free(adapter
);
551 * zfcp_adapter_dequeue - remove the adapter from the resource list
552 * @adapter: pointer to struct zfcp_adapter which should be removed
553 * locks: adapter list write lock is assumed to be held by caller
555 void zfcp_adapter_dequeue(struct zfcp_adapter
*adapter
)
560 cancel_work_sync(&adapter
->scan_work
);
561 cancel_work_sync(&adapter
->stat_work
);
562 zfcp_adapter_scsi_unregister(adapter
);
563 sysfs_remove_group(&adapter
->ccw_device
->dev
.kobj
,
564 &zfcp_sysfs_adapter_attrs
);
565 dev_set_drvdata(&adapter
->ccw_device
->dev
, NULL
);
566 /* sanity check: no pending FSF requests */
567 spin_lock_irqsave(&adapter
->req_list_lock
, flags
);
568 retval
= zfcp_reqlist_isempty(adapter
);
569 spin_unlock_irqrestore(&adapter
->req_list_lock
, flags
);
573 zfcp_adapter_debug_unregister(adapter
);
574 zfcp_qdio_free(adapter
);
575 zfcp_free_low_mem_buffers(adapter
);
576 kfree(adapter
->req_list
);
577 kfree(adapter
->fc_stats
);
578 kfree(adapter
->stats_reset_data
);
583 static void zfcp_sysfs_port_release(struct device
*dev
)
585 kfree(container_of(dev
, struct zfcp_port
, sysfs_device
));
589 * zfcp_port_enqueue - enqueue port to port list of adapter
590 * @adapter: adapter where remote port is added
591 * @wwpn: WWPN of the remote port to be enqueued
592 * @status: initial status for the port
593 * @d_id: destination id of the remote port to be enqueued
594 * Returns: pointer to enqueued port on success, ERR_PTR on error
595 * Locks: config_sema must be held to serialize changes to the port list
597 * All port internal structures are set up and the sysfs entry is generated.
598 * d_id is used to enqueue ports with a well known address like the Directory
599 * Service for nameserver lookup.
601 struct zfcp_port
*zfcp_port_enqueue(struct zfcp_adapter
*adapter
, u64 wwpn
,
602 u32 status
, u32 d_id
)
604 struct zfcp_port
*port
;
607 port
= kzalloc(sizeof(struct zfcp_port
), GFP_KERNEL
);
609 return ERR_PTR(-ENOMEM
);
611 init_waitqueue_head(&port
->remove_wq
);
612 INIT_LIST_HEAD(&port
->unit_list_head
);
613 INIT_WORK(&port
->gid_pn_work
, zfcp_erp_port_strategy_open_lookup
);
614 INIT_WORK(&port
->test_link_work
, zfcp_fc_link_test_work
);
615 INIT_WORK(&port
->rport_work
, zfcp_scsi_rport_work
);
617 port
->adapter
= adapter
;
620 port
->rport_task
= RPORT_NONE
;
622 /* mark port unusable as long as sysfs registration is not complete */
623 atomic_set_mask(status
| ZFCP_STATUS_COMMON_REMOVE
, &port
->status
);
624 atomic_set(&port
->refcount
, 0);
626 dev_set_name(&port
->sysfs_device
, "0x%016llx",
627 (unsigned long long)wwpn
);
628 port
->sysfs_device
.parent
= &adapter
->ccw_device
->dev
;
630 port
->sysfs_device
.release
= zfcp_sysfs_port_release
;
631 dev_set_drvdata(&port
->sysfs_device
, port
);
633 read_lock_irq(&zfcp_data
.config_lock
);
634 if (zfcp_get_port_by_wwpn(adapter
, wwpn
)) {
635 read_unlock_irq(&zfcp_data
.config_lock
);
638 read_unlock_irq(&zfcp_data
.config_lock
);
640 if (device_register(&port
->sysfs_device
))
643 retval
= sysfs_create_group(&port
->sysfs_device
.kobj
,
644 &zfcp_sysfs_port_attrs
);
647 device_unregister(&port
->sysfs_device
);
653 write_lock_irq(&zfcp_data
.config_lock
);
654 list_add_tail(&port
->list
, &adapter
->port_list_head
);
655 atomic_clear_mask(ZFCP_STATUS_COMMON_REMOVE
, &port
->status
);
656 atomic_set_mask(ZFCP_STATUS_COMMON_RUNNING
, &port
->status
);
658 write_unlock_irq(&zfcp_data
.config_lock
);
660 zfcp_adapter_get(adapter
);
666 return ERR_PTR(-EINVAL
);
670 * zfcp_port_dequeue - dequeues a port from the port list of the adapter
671 * @port: pointer to struct zfcp_port which should be removed
673 void zfcp_port_dequeue(struct zfcp_port
*port
)
675 wait_event(port
->remove_wq
, atomic_read(&port
->refcount
) == 0);
676 write_lock_irq(&zfcp_data
.config_lock
);
677 list_del(&port
->list
);
678 write_unlock_irq(&zfcp_data
.config_lock
);
680 port
->rport
->dd_data
= NULL
;
681 zfcp_adapter_put(port
->adapter
);
682 sysfs_remove_group(&port
->sysfs_device
.kobj
, &zfcp_sysfs_port_attrs
);
683 device_unregister(&port
->sysfs_device
);
687 * zfcp_sg_free_table - free memory used by scatterlists
688 * @sg: pointer to scatterlist
689 * @count: number of scatterlist which are to be free'ed
690 * the scatterlist are expected to reference pages always
692 void zfcp_sg_free_table(struct scatterlist
*sg
, int count
)
696 for (i
= 0; i
< count
; i
++, sg
++)
698 free_page((unsigned long) sg_virt(sg
));
704 * zfcp_sg_setup_table - init scatterlist and allocate, assign buffers
705 * @sg: pointer to struct scatterlist
706 * @count: number of scatterlists which should be assigned with buffers
709 * Returns: 0 on success, -ENOMEM otherwise
711 int zfcp_sg_setup_table(struct scatterlist
*sg
, int count
)
716 sg_init_table(sg
, count
);
717 for (i
= 0; i
< count
; i
++, sg
++) {
718 addr
= (void *) get_zeroed_page(GFP_KERNEL
);
720 zfcp_sg_free_table(sg
, i
);
723 sg_set_buf(sg
, addr
, PAGE_SIZE
);