1 /*
2 * zfcp device driver
3 *
4 * Module interface and handling of zfcp data structures.
5 *
6 * Copyright IBM Corp. 2002, 2013
7 */
8
9 /*
10 * Driver authors:
11 * Martin Peschke (originator of the driver)
12 * Raimund Schroeder
13 * Aron Zeh
14 * Wolfgang Taphorn
15 * Stefan Bader
16 * Heiko Carstens (kernel 2.6 port of the driver)
17 * Andreas Herrmann
18 * Maxim Shchetynin
19 * Volker Sameske
20 * Ralph Wuerthner
21 * Michael Loehr
22 * Swen Schillig
23 * Christof Schmitt
24 * Martin Petermann
25 * Sven Schuetz
26 * Steffen Maier
27 */
28
29 #define KMSG_COMPONENT "zfcp"
30 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
31
32 #include <linux/miscdevice.h>
33 #include <linux/seq_file.h>
34 #include <linux/slab.h>
35 #include <linux/module.h>
36 #include "zfcp_ext.h"
37 #include "zfcp_fc.h"
38 #include "zfcp_reqlist.h"
39
40 #define ZFCP_BUS_ID_SIZE 20
41
42 MODULE_AUTHOR("IBM Deutschland Entwicklung GmbH - linux390@de.ibm.com");
43 MODULE_DESCRIPTION("FCP HBA driver");
44 MODULE_LICENSE("GPL");
45
46 static char *init_device;
47 module_param_named(device, init_device, charp, 0400);
48 MODULE_PARM_DESC(device, "specify initial device");
49
zfcp_cache_hw_align(const char * name,unsigned long size)50 static struct kmem_cache * __init zfcp_cache_hw_align(const char *name,
51 unsigned long size)
52 {
53 return kmem_cache_create(name, size, roundup_pow_of_two(size), 0, NULL);
54 }
55
zfcp_init_device_configure(char * busid,u64 wwpn,u64 lun)56 static void __init zfcp_init_device_configure(char *busid, u64 wwpn, u64 lun)
57 {
58 struct ccw_device *cdev;
59 struct zfcp_adapter *adapter;
60 struct zfcp_port *port;
61
62 cdev = get_ccwdev_by_busid(&zfcp_ccw_driver, busid);
63 if (!cdev)
64 return;
65
66 if (ccw_device_set_online(cdev))
67 goto out_ccw_device;
68
69 adapter = zfcp_ccw_adapter_by_cdev(cdev);
70 if (!adapter)
71 goto out_ccw_device;
72
73 port = zfcp_get_port_by_wwpn(adapter, wwpn);
74 if (!port)
75 goto out_port;
76 flush_work(&port->rport_work);
77
78 zfcp_unit_add(port, lun);
79 put_device(&port->dev);
80
81 out_port:
82 zfcp_ccw_adapter_put(adapter);
83 out_ccw_device:
84 put_device(&cdev->dev);
85 return;
86 }
87
zfcp_init_device_setup(char * devstr)88 static void __init zfcp_init_device_setup(char *devstr)
89 {
90 char *token;
91 char *str, *str_saved;
92 char busid[ZFCP_BUS_ID_SIZE];
93 u64 wwpn, lun;
94
95 /* duplicate devstr and keep the original for sysfs presentation*/
96 str_saved = kstrdup(devstr, GFP_KERNEL);
97 str = str_saved;
98 if (!str)
99 return;
100
101 token = strsep(&str, ",");
102 if (!token || strlen(token) >= ZFCP_BUS_ID_SIZE)
103 goto err_out;
104 strncpy(busid, token, ZFCP_BUS_ID_SIZE);
105
106 token = strsep(&str, ",");
107 if (!token || strict_strtoull(token, 0, (unsigned long long *) &wwpn))
108 goto err_out;
109
110 token = strsep(&str, ",");
111 if (!token || strict_strtoull(token, 0, (unsigned long long *) &lun))
112 goto err_out;
113
114 kfree(str_saved);
115 zfcp_init_device_configure(busid, wwpn, lun);
116 return;
117
118 err_out:
119 kfree(str_saved);
120 pr_err("%s is not a valid SCSI device\n", devstr);
121 }
122
zfcp_module_init(void)123 static int __init zfcp_module_init(void)
124 {
125 int retval = -ENOMEM;
126
127 zfcp_fsf_qtcb_cache = zfcp_cache_hw_align("zfcp_fsf_qtcb",
128 sizeof(struct fsf_qtcb));
129 if (!zfcp_fsf_qtcb_cache)
130 goto out_qtcb_cache;
131
132 zfcp_fc_req_cache = zfcp_cache_hw_align("zfcp_fc_req",
133 sizeof(struct zfcp_fc_req));
134 if (!zfcp_fc_req_cache)
135 goto out_fc_cache;
136
137 zfcp_scsi_transport_template =
138 fc_attach_transport(&zfcp_transport_functions);
139 if (!zfcp_scsi_transport_template)
140 goto out_transport;
141 scsi_transport_reserve_device(zfcp_scsi_transport_template,
142 sizeof(struct zfcp_scsi_dev));
143
144
145 retval = misc_register(&zfcp_cfdc_misc);
146 if (retval) {
147 pr_err("Registering the misc device zfcp_cfdc failed\n");
148 goto out_misc;
149 }
150
151 retval = ccw_driver_register(&zfcp_ccw_driver);
152 if (retval) {
153 pr_err("The zfcp device driver could not register with "
154 "the common I/O layer\n");
155 goto out_ccw_register;
156 }
157
158 if (init_device)
159 zfcp_init_device_setup(init_device);
160 return 0;
161
162 out_ccw_register:
163 misc_deregister(&zfcp_cfdc_misc);
164 out_misc:
165 fc_release_transport(zfcp_scsi_transport_template);
166 out_transport:
167 kmem_cache_destroy(zfcp_fc_req_cache);
168 out_fc_cache:
169 kmem_cache_destroy(zfcp_fsf_qtcb_cache);
170 out_qtcb_cache:
171 return retval;
172 }
173
174 module_init(zfcp_module_init);
175
zfcp_module_exit(void)176 static void __exit zfcp_module_exit(void)
177 {
178 ccw_driver_unregister(&zfcp_ccw_driver);
179 misc_deregister(&zfcp_cfdc_misc);
180 fc_release_transport(zfcp_scsi_transport_template);
181 kmem_cache_destroy(zfcp_fc_req_cache);
182 kmem_cache_destroy(zfcp_fsf_qtcb_cache);
183 }
184
185 module_exit(zfcp_module_exit);
186
187 /**
188 * zfcp_get_port_by_wwpn - find port in port list of adapter by wwpn
189 * @adapter: pointer to adapter to search for port
190 * @wwpn: wwpn to search for
191 *
192 * Returns: pointer to zfcp_port or NULL
193 */
zfcp_get_port_by_wwpn(struct zfcp_adapter * adapter,u64 wwpn)194 struct zfcp_port *zfcp_get_port_by_wwpn(struct zfcp_adapter *adapter,
195 u64 wwpn)
196 {
197 unsigned long flags;
198 struct zfcp_port *port;
199
200 read_lock_irqsave(&adapter->port_list_lock, flags);
201 list_for_each_entry(port, &adapter->port_list, list)
202 if (port->wwpn == wwpn) {
203 if (!get_device(&port->dev))
204 port = NULL;
205 read_unlock_irqrestore(&adapter->port_list_lock, flags);
206 return port;
207 }
208 read_unlock_irqrestore(&adapter->port_list_lock, flags);
209 return NULL;
210 }
211
zfcp_allocate_low_mem_buffers(struct zfcp_adapter * adapter)212 static int zfcp_allocate_low_mem_buffers(struct zfcp_adapter *adapter)
213 {
214 adapter->pool.erp_req =
215 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
216 if (!adapter->pool.erp_req)
217 return -ENOMEM;
218
219 adapter->pool.gid_pn_req =
220 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
221 if (!adapter->pool.gid_pn_req)
222 return -ENOMEM;
223
224 adapter->pool.scsi_req =
225 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
226 if (!adapter->pool.scsi_req)
227 return -ENOMEM;
228
229 adapter->pool.scsi_abort =
230 mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
231 if (!adapter->pool.scsi_abort)
232 return -ENOMEM;
233
234 adapter->pool.status_read_req =
235 mempool_create_kmalloc_pool(FSF_STATUS_READS_RECOM,
236 sizeof(struct zfcp_fsf_req));
237 if (!adapter->pool.status_read_req)
238 return -ENOMEM;
239
240 adapter->pool.qtcb_pool =
241 mempool_create_slab_pool(4, zfcp_fsf_qtcb_cache);
242 if (!adapter->pool.qtcb_pool)
243 return -ENOMEM;
244
245 BUILD_BUG_ON(sizeof(struct fsf_status_read_buffer) > PAGE_SIZE);
246 adapter->pool.sr_data =
247 mempool_create_page_pool(FSF_STATUS_READS_RECOM, 0);
248 if (!adapter->pool.sr_data)
249 return -ENOMEM;
250
251 adapter->pool.gid_pn =
252 mempool_create_slab_pool(1, zfcp_fc_req_cache);
253 if (!adapter->pool.gid_pn)
254 return -ENOMEM;
255
256 return 0;
257 }
258
zfcp_free_low_mem_buffers(struct zfcp_adapter * adapter)259 static void zfcp_free_low_mem_buffers(struct zfcp_adapter *adapter)
260 {
261 if (adapter->pool.erp_req)
262 mempool_destroy(adapter->pool.erp_req);
263 if (adapter->pool.scsi_req)
264 mempool_destroy(adapter->pool.scsi_req);
265 if (adapter->pool.scsi_abort)
266 mempool_destroy(adapter->pool.scsi_abort);
267 if (adapter->pool.qtcb_pool)
268 mempool_destroy(adapter->pool.qtcb_pool);
269 if (adapter->pool.status_read_req)
270 mempool_destroy(adapter->pool.status_read_req);
271 if (adapter->pool.sr_data)
272 mempool_destroy(adapter->pool.sr_data);
273 if (adapter->pool.gid_pn)
274 mempool_destroy(adapter->pool.gid_pn);
275 }
276
277 /**
278 * zfcp_status_read_refill - refill the long running status_read_requests
279 * @adapter: ptr to struct zfcp_adapter for which the buffers should be refilled
280 *
281 * Returns: 0 on success, 1 otherwise
282 *
283 * if there are 16 or more status_read requests missing an adapter_reopen
284 * is triggered
285 */
zfcp_status_read_refill(struct zfcp_adapter * adapter)286 int zfcp_status_read_refill(struct zfcp_adapter *adapter)
287 {
288 while (atomic_read(&adapter->stat_miss) > 0)
289 if (zfcp_fsf_status_read(adapter->qdio)) {
290 if (atomic_read(&adapter->stat_miss) >=
291 adapter->stat_read_buf_num) {
292 zfcp_erp_adapter_reopen(adapter, 0, "axsref1");
293 return 1;
294 }
295 break;
296 } else
297 atomic_dec(&adapter->stat_miss);
298 return 0;
299 }
300
_zfcp_status_read_scheduler(struct work_struct * work)301 static void _zfcp_status_read_scheduler(struct work_struct *work)
302 {
303 zfcp_status_read_refill(container_of(work, struct zfcp_adapter,
304 stat_work));
305 }
306
zfcp_print_sl(struct seq_file * m,struct service_level * sl)307 static void zfcp_print_sl(struct seq_file *m, struct service_level *sl)
308 {
309 struct zfcp_adapter *adapter =
310 container_of(sl, struct zfcp_adapter, service_level);
311
312 seq_printf(m, "zfcp: %s microcode level %x\n",
313 dev_name(&adapter->ccw_device->dev),
314 adapter->fsf_lic_version);
315 }
316
zfcp_setup_adapter_work_queue(struct zfcp_adapter * adapter)317 static int zfcp_setup_adapter_work_queue(struct zfcp_adapter *adapter)
318 {
319 char name[TASK_COMM_LEN];
320
321 snprintf(name, sizeof(name), "zfcp_q_%s",
322 dev_name(&adapter->ccw_device->dev));
323 adapter->work_queue = create_singlethread_workqueue(name);
324
325 if (adapter->work_queue)
326 return 0;
327 return -ENOMEM;
328 }
329
zfcp_destroy_adapter_work_queue(struct zfcp_adapter * adapter)330 static void zfcp_destroy_adapter_work_queue(struct zfcp_adapter *adapter)
331 {
332 if (adapter->work_queue)
333 destroy_workqueue(adapter->work_queue);
334 adapter->work_queue = NULL;
335
336 }
337
338 /**
339 * zfcp_adapter_enqueue - enqueue a new adapter to the list
340 * @ccw_device: pointer to the struct cc_device
341 *
342 * Returns: struct zfcp_adapter*
343 * Enqueues an adapter at the end of the adapter list in the driver data.
344 * All adapter internal structures are set up.
345 * Proc-fs entries are also created.
346 */
zfcp_adapter_enqueue(struct ccw_device * ccw_device)347 struct zfcp_adapter *zfcp_adapter_enqueue(struct ccw_device *ccw_device)
348 {
349 struct zfcp_adapter *adapter;
350
351 if (!get_device(&ccw_device->dev))
352 return ERR_PTR(-ENODEV);
353
354 adapter = kzalloc(sizeof(struct zfcp_adapter), GFP_KERNEL);
355 if (!adapter) {
356 put_device(&ccw_device->dev);
357 return ERR_PTR(-ENOMEM);
358 }
359
360 kref_init(&adapter->ref);
361
362 ccw_device->handler = NULL;
363 adapter->ccw_device = ccw_device;
364
365 INIT_WORK(&adapter->stat_work, _zfcp_status_read_scheduler);
366 INIT_WORK(&adapter->scan_work, zfcp_fc_scan_ports);
367 INIT_WORK(&adapter->ns_up_work, zfcp_fc_sym_name_update);
368
369 if (zfcp_qdio_setup(adapter))
370 goto failed;
371
372 if (zfcp_allocate_low_mem_buffers(adapter))
373 goto failed;
374
375 adapter->req_list = zfcp_reqlist_alloc();
376 if (!adapter->req_list)
377 goto failed;
378
379 if (zfcp_dbf_adapter_register(adapter))
380 goto failed;
381
382 if (zfcp_setup_adapter_work_queue(adapter))
383 goto failed;
384
385 if (zfcp_fc_gs_setup(adapter))
386 goto failed;
387
388 rwlock_init(&adapter->port_list_lock);
389 INIT_LIST_HEAD(&adapter->port_list);
390
391 INIT_LIST_HEAD(&adapter->events.list);
392 INIT_WORK(&adapter->events.work, zfcp_fc_post_event);
393 spin_lock_init(&adapter->events.list_lock);
394
395 init_waitqueue_head(&adapter->erp_ready_wq);
396 init_waitqueue_head(&adapter->erp_done_wqh);
397
398 INIT_LIST_HEAD(&adapter->erp_ready_head);
399 INIT_LIST_HEAD(&adapter->erp_running_head);
400
401 rwlock_init(&adapter->erp_lock);
402 rwlock_init(&adapter->abort_lock);
403
404 if (zfcp_erp_thread_setup(adapter))
405 goto failed;
406
407 adapter->service_level.seq_print = zfcp_print_sl;
408
409 dev_set_drvdata(&ccw_device->dev, adapter);
410
411 if (sysfs_create_group(&ccw_device->dev.kobj,
412 &zfcp_sysfs_adapter_attrs))
413 goto failed;
414
415 /* report size limit per scatter-gather segment */
416 adapter->dma_parms.max_segment_size = ZFCP_QDIO_SBALE_LEN;
417 adapter->ccw_device->dev.dma_parms = &adapter->dma_parms;
418
419 adapter->stat_read_buf_num = FSF_STATUS_READS_RECOM;
420
421 if (!zfcp_scsi_adapter_register(adapter))
422 return adapter;
423
424 failed:
425 zfcp_adapter_unregister(adapter);
426 return ERR_PTR(-ENOMEM);
427 }
428
zfcp_adapter_unregister(struct zfcp_adapter * adapter)429 void zfcp_adapter_unregister(struct zfcp_adapter *adapter)
430 {
431 struct ccw_device *cdev = adapter->ccw_device;
432
433 cancel_work_sync(&adapter->scan_work);
434 cancel_work_sync(&adapter->stat_work);
435 cancel_work_sync(&adapter->ns_up_work);
436 zfcp_destroy_adapter_work_queue(adapter);
437
438 zfcp_fc_wka_ports_force_offline(adapter->gs);
439 zfcp_scsi_adapter_unregister(adapter);
440 sysfs_remove_group(&cdev->dev.kobj, &zfcp_sysfs_adapter_attrs);
441
442 zfcp_erp_thread_kill(adapter);
443 zfcp_dbf_adapter_unregister(adapter);
444 zfcp_qdio_destroy(adapter->qdio);
445
446 zfcp_ccw_adapter_put(adapter); /* final put to release */
447 }
448
449 /**
450 * zfcp_adapter_release - remove the adapter from the resource list
451 * @ref: pointer to struct kref
452 * locks: adapter list write lock is assumed to be held by caller
453 */
zfcp_adapter_release(struct kref * ref)454 void zfcp_adapter_release(struct kref *ref)
455 {
456 struct zfcp_adapter *adapter = container_of(ref, struct zfcp_adapter,
457 ref);
458 struct ccw_device *cdev = adapter->ccw_device;
459
460 dev_set_drvdata(&adapter->ccw_device->dev, NULL);
461 zfcp_fc_gs_destroy(adapter);
462 zfcp_free_low_mem_buffers(adapter);
463 kfree(adapter->req_list);
464 kfree(adapter->fc_stats);
465 kfree(adapter->stats_reset_data);
466 kfree(adapter);
467 put_device(&cdev->dev);
468 }
469
470 /**
471 * zfcp_device_unregister - remove port, unit from system
472 * @dev: reference to device which is to be removed
473 * @grp: related reference to attribute group
474 *
475 * Helper function to unregister port, unit from system
476 */
zfcp_device_unregister(struct device * dev,const struct attribute_group * grp)477 void zfcp_device_unregister(struct device *dev,
478 const struct attribute_group *grp)
479 {
480 sysfs_remove_group(&dev->kobj, grp);
481 device_unregister(dev);
482 }
483
zfcp_port_release(struct device * dev)484 static void zfcp_port_release(struct device *dev)
485 {
486 struct zfcp_port *port = container_of(dev, struct zfcp_port, dev);
487
488 zfcp_ccw_adapter_put(port->adapter);
489 kfree(port);
490 }
491
492 /**
493 * zfcp_port_enqueue - enqueue port to port list of adapter
494 * @adapter: adapter where remote port is added
495 * @wwpn: WWPN of the remote port to be enqueued
496 * @status: initial status for the port
497 * @d_id: destination id of the remote port to be enqueued
498 * Returns: pointer to enqueued port on success, ERR_PTR on error
499 *
500 * All port internal structures are set up and the sysfs entry is generated.
501 * d_id is used to enqueue ports with a well known address like the Directory
502 * Service for nameserver lookup.
503 */
zfcp_port_enqueue(struct zfcp_adapter * adapter,u64 wwpn,u32 status,u32 d_id)504 struct zfcp_port *zfcp_port_enqueue(struct zfcp_adapter *adapter, u64 wwpn,
505 u32 status, u32 d_id)
506 {
507 struct zfcp_port *port;
508 int retval = -ENOMEM;
509
510 kref_get(&adapter->ref);
511
512 port = zfcp_get_port_by_wwpn(adapter, wwpn);
513 if (port) {
514 put_device(&port->dev);
515 retval = -EEXIST;
516 goto err_out;
517 }
518
519 port = kzalloc(sizeof(struct zfcp_port), GFP_KERNEL);
520 if (!port)
521 goto err_out;
522
523 rwlock_init(&port->unit_list_lock);
524 INIT_LIST_HEAD(&port->unit_list);
525 atomic_set(&port->units, 0);
526
527 INIT_WORK(&port->gid_pn_work, zfcp_fc_port_did_lookup);
528 INIT_WORK(&port->test_link_work, zfcp_fc_link_test_work);
529 INIT_WORK(&port->rport_work, zfcp_scsi_rport_work);
530
531 port->adapter = adapter;
532 port->d_id = d_id;
533 port->wwpn = wwpn;
534 port->rport_task = RPORT_NONE;
535 port->dev.parent = &adapter->ccw_device->dev;
536 port->dev.release = zfcp_port_release;
537
538 if (dev_set_name(&port->dev, "0x%016llx", (unsigned long long)wwpn)) {
539 kfree(port);
540 goto err_out;
541 }
542 retval = -EINVAL;
543
544 if (device_register(&port->dev)) {
545 put_device(&port->dev);
546 goto err_out;
547 }
548
549 if (sysfs_create_group(&port->dev.kobj,
550 &zfcp_sysfs_port_attrs))
551 goto err_out_put;
552
553 write_lock_irq(&adapter->port_list_lock);
554 list_add_tail(&port->list, &adapter->port_list);
555 write_unlock_irq(&adapter->port_list_lock);
556
557 atomic_set_mask(status | ZFCP_STATUS_COMMON_RUNNING, &port->status);
558
559 return port;
560
561 err_out_put:
562 device_unregister(&port->dev);
563 err_out:
564 zfcp_ccw_adapter_put(adapter);
565 return ERR_PTR(retval);
566 }
567
568 /**
569 * zfcp_sg_free_table - free memory used by scatterlists
570 * @sg: pointer to scatterlist
571 * @count: number of scatterlist which are to be free'ed
572 * the scatterlist are expected to reference pages always
573 */
zfcp_sg_free_table(struct scatterlist * sg,int count)574 void zfcp_sg_free_table(struct scatterlist *sg, int count)
575 {
576 int i;
577
578 for (i = 0; i < count; i++, sg++)
579 if (sg)
580 free_page((unsigned long) sg_virt(sg));
581 else
582 break;
583 }
584
585 /**
586 * zfcp_sg_setup_table - init scatterlist and allocate, assign buffers
587 * @sg: pointer to struct scatterlist
588 * @count: number of scatterlists which should be assigned with buffers
589 * of size page
590 *
591 * Returns: 0 on success, -ENOMEM otherwise
592 */
zfcp_sg_setup_table(struct scatterlist * sg,int count)593 int zfcp_sg_setup_table(struct scatterlist *sg, int count)
594 {
595 void *addr;
596 int i;
597
598 sg_init_table(sg, count);
599 for (i = 0; i < count; i++, sg++) {
600 addr = (void *) get_zeroed_page(GFP_KERNEL);
601 if (!addr) {
602 zfcp_sg_free_table(sg, i);
603 return -ENOMEM;
604 }
605 sg_set_buf(sg, addr, PAGE_SIZE);
606 }
607 return 0;
608 }
609