4 * Module interface and handling of zfcp data structures.
6 * Copyright IBM Corp. 2002, 2013
11 * Martin Peschke (originator of the driver)
16 * Heiko Carstens (kernel 2.6 port of the driver)
29 #define KMSG_COMPONENT "zfcp"
30 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
32 #include <linux/seq_file.h>
33 #include <linux/slab.h>
34 #include <linux/module.h>
37 #include "zfcp_reqlist.h"
39 #define ZFCP_BUS_ID_SIZE 20
41 MODULE_AUTHOR("IBM Deutschland Entwicklung GmbH - linux390@de.ibm.com");
42 MODULE_DESCRIPTION("FCP HBA driver");
43 MODULE_LICENSE("GPL");
45 static char *init_device;
46 module_param_named(device, init_device, charp, 0400);
47 MODULE_PARM_DESC(device, "specify initial device");
49 static struct kmem_cache * __init zfcp_cache_hw_align(const char *name,
52 return kmem_cache_create(name, size, roundup_pow_of_two(size), 0, NULL);
55 static void __init zfcp_init_device_configure(char *busid, u64 wwpn, u64 lun)
57 struct ccw_device *cdev;
58 struct zfcp_adapter *adapter;
59 struct zfcp_port *port;
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);
75 flush_work(&port->rport_work);
77 zfcp_unit_add(port, lun);
78 put_device(&port->dev);
81 zfcp_ccw_adapter_put(adapter);
83 put_device(&cdev->dev);
87 static void __init zfcp_init_device_setup(char *devstr)
90 char *str, *str_saved;
91 char busid[ZFCP_BUS_ID_SIZE];
94 /* duplicate devstr and keep the original for sysfs presentation*/
95 str_saved = kstrdup(devstr, GFP_KERNEL);
100 token = strsep(&str, ",");
101 if (!token || strlen(token) >= ZFCP_BUS_ID_SIZE)
103 strncpy(busid, token, ZFCP_BUS_ID_SIZE);
105 token = strsep(&str, ",");
106 if (!token || kstrtoull(token, 0, (unsigned long long *) &wwpn))
109 token = strsep(&str, ",");
110 if (!token || kstrtoull(token, 0, (unsigned long long *) &lun))
114 zfcp_init_device_configure(busid, wwpn, lun);
119 pr_err("%s is not a valid SCSI device\n", devstr);
122 static int __init zfcp_module_init(void)
124 int retval = -ENOMEM;
126 zfcp_fsf_qtcb_cache = zfcp_cache_hw_align("zfcp_fsf_qtcb",
127 sizeof(struct fsf_qtcb));
128 if (!zfcp_fsf_qtcb_cache)
131 zfcp_fc_req_cache = zfcp_cache_hw_align("zfcp_fc_req",
132 sizeof(struct zfcp_fc_req));
133 if (!zfcp_fc_req_cache)
136 zfcp_scsi_transport_template =
137 fc_attach_transport(&zfcp_transport_functions);
138 if (!zfcp_scsi_transport_template)
140 scsi_transport_reserve_device(zfcp_scsi_transport_template,
141 sizeof(struct zfcp_scsi_dev));
143 retval = ccw_driver_register(&zfcp_ccw_driver);
145 pr_err("The zfcp device driver could not register with "
146 "the common I/O layer\n");
147 goto out_ccw_register;
151 zfcp_init_device_setup(init_device);
155 fc_release_transport(zfcp_scsi_transport_template);
157 kmem_cache_destroy(zfcp_fc_req_cache);
159 kmem_cache_destroy(zfcp_fsf_qtcb_cache);
164 module_init(zfcp_module_init);
166 static void __exit zfcp_module_exit(void)
168 ccw_driver_unregister(&zfcp_ccw_driver);
169 fc_release_transport(zfcp_scsi_transport_template);
170 kmem_cache_destroy(zfcp_fc_req_cache);
171 kmem_cache_destroy(zfcp_fsf_qtcb_cache);
174 module_exit(zfcp_module_exit);
177 * zfcp_get_port_by_wwpn - find port in port list of adapter by wwpn
178 * @adapter: pointer to adapter to search for port
179 * @wwpn: wwpn to search for
181 * Returns: pointer to zfcp_port or NULL
183 struct zfcp_port *zfcp_get_port_by_wwpn(struct zfcp_adapter *adapter,
187 struct zfcp_port *port;
189 read_lock_irqsave(&adapter->port_list_lock, flags);
190 list_for_each_entry(port, &adapter->port_list, list)
191 if (port->wwpn == wwpn) {
192 if (!get_device(&port->dev))
194 read_unlock_irqrestore(&adapter->port_list_lock, flags);
197 read_unlock_irqrestore(&adapter->port_list_lock, flags);
201 static int zfcp_allocate_low_mem_buffers(struct zfcp_adapter *adapter)
203 adapter->pool.erp_req =
204 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
205 if (!adapter->pool.erp_req)
208 adapter->pool.gid_pn_req =
209 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
210 if (!adapter->pool.gid_pn_req)
213 adapter->pool.scsi_req =
214 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
215 if (!adapter->pool.scsi_req)
218 adapter->pool.scsi_abort =
219 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
220 if (!adapter->pool.scsi_abort)
223 adapter->pool.status_read_req =
224 mempool_create_kmalloc_pool(FSF_STATUS_READS_RECOM,
225 sizeof(struct zfcp_fsf_req));
226 if (!adapter->pool.status_read_req)
229 adapter->pool.qtcb_pool =
230 mempool_create_slab_pool(4, zfcp_fsf_qtcb_cache);
231 if (!adapter->pool.qtcb_pool)
234 BUILD_BUG_ON(sizeof(struct fsf_status_read_buffer) > PAGE_SIZE);
235 adapter->pool.sr_data =
236 mempool_create_page_pool(FSF_STATUS_READS_RECOM, 0);
237 if (!adapter->pool.sr_data)
240 adapter->pool.gid_pn =
241 mempool_create_slab_pool(1, zfcp_fc_req_cache);
242 if (!adapter->pool.gid_pn)
248 static void zfcp_free_low_mem_buffers(struct zfcp_adapter *adapter)
250 if (adapter->pool.erp_req)
251 mempool_destroy(adapter->pool.erp_req);
252 if (adapter->pool.scsi_req)
253 mempool_destroy(adapter->pool.scsi_req);
254 if (adapter->pool.scsi_abort)
255 mempool_destroy(adapter->pool.scsi_abort);
256 if (adapter->pool.qtcb_pool)
257 mempool_destroy(adapter->pool.qtcb_pool);
258 if (adapter->pool.status_read_req)
259 mempool_destroy(adapter->pool.status_read_req);
260 if (adapter->pool.sr_data)
261 mempool_destroy(adapter->pool.sr_data);
262 if (adapter->pool.gid_pn)
263 mempool_destroy(adapter->pool.gid_pn);
267 * zfcp_status_read_refill - refill the long running status_read_requests
268 * @adapter: ptr to struct zfcp_adapter for which the buffers should be refilled
270 * Returns: 0 on success, 1 otherwise
272 * if there are 16 or more status_read requests missing an adapter_reopen
275 int zfcp_status_read_refill(struct zfcp_adapter *adapter)
277 while (atomic_add_unless(&adapter->stat_miss, -1, 0))
278 if (zfcp_fsf_status_read(adapter->qdio)) {
279 atomic_inc(&adapter->stat_miss); /* undo add -1 */
280 if (atomic_read(&adapter->stat_miss) >=
281 adapter->stat_read_buf_num) {
282 zfcp_erp_adapter_reopen(adapter, 0, "axsref1");
290 static void _zfcp_status_read_scheduler(struct work_struct *work)
292 zfcp_status_read_refill(container_of(work, struct zfcp_adapter,
296 static void zfcp_print_sl(struct seq_file *m, struct service_level *sl)
298 struct zfcp_adapter *adapter =
299 container_of(sl, struct zfcp_adapter, service_level);
301 seq_printf(m, "zfcp: %s microcode level %x\n",
302 dev_name(&adapter->ccw_device->dev),
303 adapter->fsf_lic_version);
306 static int zfcp_setup_adapter_work_queue(struct zfcp_adapter *adapter)
308 char name[TASK_COMM_LEN];
310 snprintf(name, sizeof(name), "zfcp_q_%s",
311 dev_name(&adapter->ccw_device->dev));
312 adapter->work_queue = alloc_ordered_workqueue(name, WQ_MEM_RECLAIM);
314 if (adapter->work_queue)
319 static void zfcp_destroy_adapter_work_queue(struct zfcp_adapter *adapter)
321 if (adapter->work_queue)
322 destroy_workqueue(adapter->work_queue);
323 adapter->work_queue = NULL;
328 * zfcp_adapter_enqueue - enqueue a new adapter to the list
329 * @ccw_device: pointer to the struct cc_device
331 * Returns: struct zfcp_adapter*
332 * Enqueues an adapter at the end of the adapter list in the driver data.
333 * All adapter internal structures are set up.
334 * Proc-fs entries are also created.
336 struct zfcp_adapter *zfcp_adapter_enqueue(struct ccw_device *ccw_device)
338 struct zfcp_adapter *adapter;
340 if (!get_device(&ccw_device->dev))
341 return ERR_PTR(-ENODEV);
343 adapter = kzalloc(sizeof(struct zfcp_adapter), GFP_KERNEL);
345 put_device(&ccw_device->dev);
346 return ERR_PTR(-ENOMEM);
349 kref_init(&adapter->ref);
351 ccw_device->handler = NULL;
352 adapter->ccw_device = ccw_device;
354 INIT_WORK(&adapter->stat_work, _zfcp_status_read_scheduler);
355 INIT_DELAYED_WORK(&adapter->scan_work, zfcp_fc_scan_ports);
356 INIT_WORK(&adapter->ns_up_work, zfcp_fc_sym_name_update);
358 adapter->next_port_scan = jiffies;
360 adapter->erp_action.adapter = adapter;
362 if (zfcp_qdio_setup(adapter))
365 if (zfcp_allocate_low_mem_buffers(adapter))
368 adapter->req_list = zfcp_reqlist_alloc();
369 if (!adapter->req_list)
372 if (zfcp_dbf_adapter_register(adapter))
375 if (zfcp_setup_adapter_work_queue(adapter))
378 if (zfcp_fc_gs_setup(adapter))
381 rwlock_init(&adapter->port_list_lock);
382 INIT_LIST_HEAD(&adapter->port_list);
384 INIT_LIST_HEAD(&adapter->events.list);
385 INIT_WORK(&adapter->events.work, zfcp_fc_post_event);
386 spin_lock_init(&adapter->events.list_lock);
388 init_waitqueue_head(&adapter->erp_ready_wq);
389 init_waitqueue_head(&adapter->erp_done_wqh);
391 INIT_LIST_HEAD(&adapter->erp_ready_head);
392 INIT_LIST_HEAD(&adapter->erp_running_head);
394 rwlock_init(&adapter->erp_lock);
395 rwlock_init(&adapter->abort_lock);
397 if (zfcp_erp_thread_setup(adapter))
400 adapter->service_level.seq_print = zfcp_print_sl;
402 dev_set_drvdata(&ccw_device->dev, adapter);
404 if (sysfs_create_group(&ccw_device->dev.kobj,
405 &zfcp_sysfs_adapter_attrs))
408 /* report size limit per scatter-gather segment */
409 adapter->dma_parms.max_segment_size = ZFCP_QDIO_SBALE_LEN;
410 adapter->ccw_device->dev.dma_parms = &adapter->dma_parms;
412 adapter->stat_read_buf_num = FSF_STATUS_READS_RECOM;
414 if (!zfcp_scsi_adapter_register(adapter))
418 zfcp_adapter_unregister(adapter);
419 return ERR_PTR(-ENOMEM);
422 void zfcp_adapter_unregister(struct zfcp_adapter *adapter)
424 struct ccw_device *cdev = adapter->ccw_device;
426 cancel_delayed_work_sync(&adapter->scan_work);
427 cancel_work_sync(&adapter->stat_work);
428 cancel_work_sync(&adapter->ns_up_work);
429 zfcp_destroy_adapter_work_queue(adapter);
431 zfcp_fc_wka_ports_force_offline(adapter->gs);
432 zfcp_scsi_adapter_unregister(adapter);
433 sysfs_remove_group(&cdev->dev.kobj, &zfcp_sysfs_adapter_attrs);
435 zfcp_erp_thread_kill(adapter);
436 zfcp_dbf_adapter_unregister(adapter);
437 zfcp_qdio_destroy(adapter->qdio);
439 zfcp_ccw_adapter_put(adapter); /* final put to release */
443 * zfcp_adapter_release - remove the adapter from the resource list
444 * @ref: pointer to struct kref
445 * locks: adapter list write lock is assumed to be held by caller
447 void zfcp_adapter_release(struct kref *ref)
449 struct zfcp_adapter *adapter = container_of(ref, struct zfcp_adapter,
451 struct ccw_device *cdev = adapter->ccw_device;
453 dev_set_drvdata(&adapter->ccw_device->dev, NULL);
454 zfcp_fc_gs_destroy(adapter);
455 zfcp_free_low_mem_buffers(adapter);
456 kfree(adapter->req_list);
457 kfree(adapter->fc_stats);
458 kfree(adapter->stats_reset_data);
460 put_device(&cdev->dev);
463 static void zfcp_port_release(struct device *dev)
465 struct zfcp_port *port = container_of(dev, struct zfcp_port, dev);
467 zfcp_ccw_adapter_put(port->adapter);
472 * zfcp_port_enqueue - enqueue port to port list of adapter
473 * @adapter: adapter where remote port is added
474 * @wwpn: WWPN of the remote port to be enqueued
475 * @status: initial status for the port
476 * @d_id: destination id of the remote port to be enqueued
477 * Returns: pointer to enqueued port on success, ERR_PTR on error
479 * All port internal structures are set up and the sysfs entry is generated.
480 * d_id is used to enqueue ports with a well known address like the Directory
481 * Service for nameserver lookup.
483 struct zfcp_port *zfcp_port_enqueue(struct zfcp_adapter *adapter, u64 wwpn,
484 u32 status, u32 d_id)
486 struct zfcp_port *port;
487 int retval = -ENOMEM;
489 kref_get(&adapter->ref);
491 port = zfcp_get_port_by_wwpn(adapter, wwpn);
493 put_device(&port->dev);
498 port = kzalloc(sizeof(struct zfcp_port), GFP_KERNEL);
502 rwlock_init(&port->unit_list_lock);
503 INIT_LIST_HEAD(&port->unit_list);
504 atomic_set(&port->units, 0);
506 INIT_WORK(&port->gid_pn_work, zfcp_fc_port_did_lookup);
507 INIT_WORK(&port->test_link_work, zfcp_fc_link_test_work);
508 INIT_WORK(&port->rport_work, zfcp_scsi_rport_work);
510 port->adapter = adapter;
513 port->rport_task = RPORT_NONE;
514 port->dev.parent = &adapter->ccw_device->dev;
515 port->dev.groups = zfcp_port_attr_groups;
516 port->dev.release = zfcp_port_release;
518 port->erp_action.adapter = adapter;
519 port->erp_action.port = port;
521 if (dev_set_name(&port->dev, "0x%016llx", (unsigned long long)wwpn)) {
527 if (device_register(&port->dev)) {
528 put_device(&port->dev);
532 write_lock_irq(&adapter->port_list_lock);
533 list_add_tail(&port->list, &adapter->port_list);
534 write_unlock_irq(&adapter->port_list_lock);
536 atomic_or(status | ZFCP_STATUS_COMMON_RUNNING, &port->status);
541 zfcp_ccw_adapter_put(adapter);
543 return ERR_PTR(retval);
547 * zfcp_sg_free_table - free memory used by scatterlists
548 * @sg: pointer to scatterlist
549 * @count: number of scatterlist which are to be free'ed
550 * the scatterlist are expected to reference pages always
552 void zfcp_sg_free_table(struct scatterlist *sg, int count)
556 for (i = 0; i < count; i++, sg++)
558 free_page((unsigned long) sg_virt(sg));
564 * zfcp_sg_setup_table - init scatterlist and allocate, assign buffers
565 * @sg: pointer to struct scatterlist
566 * @count: number of scatterlists which should be assigned with buffers
569 * Returns: 0 on success, -ENOMEM otherwise
571 int zfcp_sg_setup_table(struct scatterlist *sg, int count)
576 sg_init_table(sg, count);
577 for (i = 0; i < count; i++, sg++) {
578 addr = (void *) get_zeroed_page(GFP_KERNEL);
580 zfcp_sg_free_table(sg, i);
583 sg_set_buf(sg, addr, PAGE_SIZE);