xref: /openbmc/linux/arch/sparc/kernel/vio.c (revision efe4a1ac)
1 /* vio.c: Virtual I/O channel devices probing infrastructure.
2  *
3  *    Copyright (c) 2003-2005 IBM Corp.
4  *     Dave Engebretsen engebret@us.ibm.com
5  *     Santiago Leon santil@us.ibm.com
6  *     Hollis Blanchard <hollisb@us.ibm.com>
7  *     Stephen Rothwell
8  *
9  * Adapted to sparc64 by David S. Miller davem@davemloft.net
10  */
11 
12 #include <linux/kernel.h>
13 #include <linux/slab.h>
14 #include <linux/irq.h>
15 #include <linux/export.h>
16 #include <linux/init.h>
17 
18 #include <asm/mdesc.h>
19 #include <asm/vio.h>
20 
21 static const struct vio_device_id *vio_match_device(
22 	const struct vio_device_id *matches,
23 	const struct vio_dev *dev)
24 {
25 	const char *type, *compat;
26 	int len;
27 
28 	type = dev->type;
29 	compat = dev->compat;
30 	len = dev->compat_len;
31 
32 	while (matches->type[0] || matches->compat[0]) {
33 		int match = 1;
34 		if (matches->type[0])
35 			match &= !strcmp(matches->type, type);
36 
37 		if (matches->compat[0]) {
38 			match &= len &&
39 				of_find_in_proplist(compat, matches->compat, len);
40 		}
41 		if (match)
42 			return matches;
43 		matches++;
44 	}
45 	return NULL;
46 }
47 
48 static int vio_hotplug(struct device *dev, struct kobj_uevent_env *env)
49 {
50 	const struct vio_dev *vio_dev = to_vio_dev(dev);
51 
52 	add_uevent_var(env, "MODALIAS=vio:T%sS%s", vio_dev->type, vio_dev->compat);
53 	return 0;
54 }
55 
56 static int vio_bus_match(struct device *dev, struct device_driver *drv)
57 {
58 	struct vio_dev *vio_dev = to_vio_dev(dev);
59 	struct vio_driver *vio_drv = to_vio_driver(drv);
60 	const struct vio_device_id *matches = vio_drv->id_table;
61 
62 	if (!matches)
63 		return 0;
64 
65 	return vio_match_device(matches, vio_dev) != NULL;
66 }
67 
68 static int vio_device_probe(struct device *dev)
69 {
70 	struct vio_dev *vdev = to_vio_dev(dev);
71 	struct vio_driver *drv = to_vio_driver(dev->driver);
72 	const struct vio_device_id *id;
73 	int error = -ENODEV;
74 
75 	if (drv->probe) {
76 		id = vio_match_device(drv->id_table, vdev);
77 		if (id)
78 			error = drv->probe(vdev, id);
79 	}
80 
81 	return error;
82 }
83 
84 static int vio_device_remove(struct device *dev)
85 {
86 	struct vio_dev *vdev = to_vio_dev(dev);
87 	struct vio_driver *drv = to_vio_driver(dev->driver);
88 
89 	if (drv->remove)
90 		return drv->remove(vdev);
91 
92 	return 1;
93 }
94 
95 static ssize_t devspec_show(struct device *dev,
96 		struct device_attribute *attr, char *buf)
97 {
98 	struct vio_dev *vdev = to_vio_dev(dev);
99 	const char *str = "none";
100 
101 	if (!strcmp(vdev->type, "vnet-port"))
102 		str = "vnet";
103 	else if (!strcmp(vdev->type, "vdc-port"))
104 		str = "vdisk";
105 
106 	return sprintf(buf, "%s\n", str);
107 }
108 
109 static ssize_t type_show(struct device *dev,
110 		struct device_attribute *attr, char *buf)
111 {
112 	struct vio_dev *vdev = to_vio_dev(dev);
113 	return sprintf(buf, "%s\n", vdev->type);
114 }
115 
116 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
117 			     char *buf)
118 {
119 	const struct vio_dev *vdev = to_vio_dev(dev);
120 
121 	return sprintf(buf, "vio:T%sS%s\n", vdev->type, vdev->compat);
122 }
123 
124 static struct device_attribute vio_dev_attrs[] = {
125 	__ATTR_RO(devspec),
126 	__ATTR_RO(type),
127 	__ATTR_RO(modalias),
128 	__ATTR_NULL
129 };
130 
131 static struct bus_type vio_bus_type = {
132 	.name		= "vio",
133 	.dev_attrs	= vio_dev_attrs,
134 	.uevent         = vio_hotplug,
135 	.match		= vio_bus_match,
136 	.probe		= vio_device_probe,
137 	.remove		= vio_device_remove,
138 };
139 
140 int __vio_register_driver(struct vio_driver *viodrv, struct module *owner,
141 			const char *mod_name)
142 {
143 	viodrv->driver.bus = &vio_bus_type;
144 	viodrv->driver.name = viodrv->name;
145 	viodrv->driver.owner = owner;
146 	viodrv->driver.mod_name = mod_name;
147 
148 	return driver_register(&viodrv->driver);
149 }
150 EXPORT_SYMBOL(__vio_register_driver);
151 
152 void vio_unregister_driver(struct vio_driver *viodrv)
153 {
154 	driver_unregister(&viodrv->driver);
155 }
156 EXPORT_SYMBOL(vio_unregister_driver);
157 
158 static void vio_dev_release(struct device *dev)
159 {
160 	kfree(to_vio_dev(dev));
161 }
162 
163 static ssize_t
164 show_pciobppath_attr(struct device *dev, struct device_attribute *attr,
165 		     char *buf)
166 {
167 	struct vio_dev *vdev;
168 	struct device_node *dp;
169 
170 	vdev = to_vio_dev(dev);
171 	dp = vdev->dp;
172 
173 	return snprintf (buf, PAGE_SIZE, "%s\n", dp->full_name);
174 }
175 
176 static DEVICE_ATTR(obppath, S_IRUSR | S_IRGRP | S_IROTH,
177 		   show_pciobppath_attr, NULL);
178 
179 static struct device_node *cdev_node;
180 
181 static struct vio_dev *root_vdev;
182 static u64 cdev_cfg_handle;
183 
184 static void vio_fill_channel_info(struct mdesc_handle *hp, u64 mp,
185 				  struct vio_dev *vdev)
186 {
187 	u64 a;
188 
189 	mdesc_for_each_arc(a, hp, mp, MDESC_ARC_TYPE_FWD) {
190 		const u64 *chan_id;
191 		const u64 *irq;
192 		u64 target;
193 
194 		target = mdesc_arc_target(hp, a);
195 
196 		irq = mdesc_get_property(hp, target, "tx-ino", NULL);
197 		if (irq)
198 			vdev->tx_irq = sun4v_build_virq(cdev_cfg_handle, *irq);
199 
200 		irq = mdesc_get_property(hp, target, "rx-ino", NULL);
201 		if (irq) {
202 			vdev->rx_irq = sun4v_build_virq(cdev_cfg_handle, *irq);
203 			vdev->rx_ino = *irq;
204 		}
205 
206 		chan_id = mdesc_get_property(hp, target, "id", NULL);
207 		if (chan_id)
208 			vdev->channel_id = *chan_id;
209 	}
210 }
211 
212 int vio_set_intr(unsigned long dev_ino, int state)
213 {
214 	int err;
215 
216 	err = sun4v_vintr_set_valid(cdev_cfg_handle, dev_ino, state);
217 	return err;
218 }
219 EXPORT_SYMBOL(vio_set_intr);
220 
221 static struct vio_dev *vio_create_one(struct mdesc_handle *hp, u64 mp,
222 				      struct device *parent)
223 {
224 	const char *type, *compat, *bus_id_name;
225 	struct device_node *dp;
226 	struct vio_dev *vdev;
227 	int err, tlen, clen;
228 	const u64 *id, *cfg_handle;
229 	u64 a;
230 
231 	type = mdesc_get_property(hp, mp, "device-type", &tlen);
232 	if (!type) {
233 		type = mdesc_get_property(hp, mp, "name", &tlen);
234 		if (!type) {
235 			type = mdesc_node_name(hp, mp);
236 			tlen = strlen(type) + 1;
237 		}
238 	}
239 	if (tlen > VIO_MAX_TYPE_LEN) {
240 		printk(KERN_ERR "VIO: Type string [%s] is too long.\n",
241 		       type);
242 		return NULL;
243 	}
244 
245 	id = mdesc_get_property(hp, mp, "id", NULL);
246 
247 	cfg_handle = NULL;
248 	mdesc_for_each_arc(a, hp, mp, MDESC_ARC_TYPE_BACK) {
249 		u64 target;
250 
251 		target = mdesc_arc_target(hp, a);
252 		cfg_handle = mdesc_get_property(hp, target,
253 						"cfg-handle", NULL);
254 		if (cfg_handle)
255 			break;
256 	}
257 
258 	bus_id_name = type;
259 	if (!strcmp(type, "domain-services-port"))
260 		bus_id_name = "ds";
261 
262 	/*
263 	 * 20 char is the old driver-core name size limit, which is no more.
264 	 * This check can probably be removed after review and possible
265 	 * adaption of the vio users name length handling.
266 	 */
267 	if (strlen(bus_id_name) >= 20 - 4) {
268 		printk(KERN_ERR "VIO: bus_id_name [%s] is too long.\n",
269 		       bus_id_name);
270 		return NULL;
271 	}
272 
273 	compat = mdesc_get_property(hp, mp, "device-type", &clen);
274 	if (!compat) {
275 		clen = 0;
276 	} else if (clen > VIO_MAX_COMPAT_LEN) {
277 		printk(KERN_ERR "VIO: Compat len %d for [%s] is too long.\n",
278 		       clen, type);
279 		return NULL;
280 	}
281 
282 	vdev = kzalloc(sizeof(*vdev), GFP_KERNEL);
283 	if (!vdev) {
284 		printk(KERN_ERR "VIO: Could not allocate vio_dev\n");
285 		return NULL;
286 	}
287 
288 	vdev->mp = mp;
289 	memcpy(vdev->type, type, tlen);
290 	if (compat)
291 		memcpy(vdev->compat, compat, clen);
292 	else
293 		memset(vdev->compat, 0, sizeof(vdev->compat));
294 	vdev->compat_len = clen;
295 
296 	vdev->channel_id = ~0UL;
297 	vdev->tx_irq = ~0;
298 	vdev->rx_irq = ~0;
299 
300 	vio_fill_channel_info(hp, mp, vdev);
301 
302 	if (!id) {
303 		dev_set_name(&vdev->dev, "%s", bus_id_name);
304 		vdev->dev_no = ~(u64)0;
305 		vdev->id = ~(u64)0;
306 	} else if (!cfg_handle) {
307 		dev_set_name(&vdev->dev, "%s-%llu", bus_id_name, *id);
308 		vdev->dev_no = *id;
309 		vdev->id = ~(u64)0;
310 	} else {
311 		dev_set_name(&vdev->dev, "%s-%llu-%llu", bus_id_name,
312 			     *cfg_handle, *id);
313 		vdev->dev_no = *cfg_handle;
314 		vdev->id = *id;
315 	}
316 
317 	vdev->dev.parent = parent;
318 	vdev->dev.bus = &vio_bus_type;
319 	vdev->dev.release = vio_dev_release;
320 
321 	if (parent == NULL) {
322 		dp = cdev_node;
323 	} else if (to_vio_dev(parent) == root_vdev) {
324 		dp = of_get_next_child(cdev_node, NULL);
325 		while (dp) {
326 			if (!strcmp(dp->type, type))
327 				break;
328 
329 			dp = of_get_next_child(cdev_node, dp);
330 		}
331 	} else {
332 		dp = to_vio_dev(parent)->dp;
333 	}
334 	vdev->dp = dp;
335 
336 	printk(KERN_INFO "VIO: Adding device %s\n", dev_name(&vdev->dev));
337 
338 	err = device_register(&vdev->dev);
339 	if (err) {
340 		printk(KERN_ERR "VIO: Could not register device %s, err=%d\n",
341 		       dev_name(&vdev->dev), err);
342 		kfree(vdev);
343 		return NULL;
344 	}
345 	if (vdev->dp)
346 		err = sysfs_create_file(&vdev->dev.kobj,
347 					&dev_attr_obppath.attr);
348 
349 	return vdev;
350 }
351 
352 static void vio_add(struct mdesc_handle *hp, u64 node)
353 {
354 	(void) vio_create_one(hp, node, &root_vdev->dev);
355 }
356 
357 struct vio_md_node_query {
358 	const char *type;
359 	u64 dev_no;
360 	u64 id;
361 };
362 
363 static int vio_md_node_match(struct device *dev, void *arg)
364 {
365 	struct vio_md_node_query *query = (struct vio_md_node_query *) arg;
366 	struct vio_dev *vdev = to_vio_dev(dev);
367 
368 	if (vdev->dev_no != query->dev_no)
369 		return 0;
370 	if (vdev->id != query->id)
371 		return 0;
372 	if (strcmp(vdev->type, query->type))
373 		return 0;
374 
375 	return 1;
376 }
377 
378 static void vio_remove(struct mdesc_handle *hp, u64 node)
379 {
380 	const char *type;
381 	const u64 *id, *cfg_handle;
382 	u64 a;
383 	struct vio_md_node_query query;
384 	struct device *dev;
385 
386 	type = mdesc_get_property(hp, node, "device-type", NULL);
387 	if (!type) {
388 		type = mdesc_get_property(hp, node, "name", NULL);
389 		if (!type)
390 			type = mdesc_node_name(hp, node);
391 	}
392 
393 	query.type = type;
394 
395 	id = mdesc_get_property(hp, node, "id", NULL);
396 	cfg_handle = NULL;
397 	mdesc_for_each_arc(a, hp, node, MDESC_ARC_TYPE_BACK) {
398 		u64 target;
399 
400 		target = mdesc_arc_target(hp, a);
401 		cfg_handle = mdesc_get_property(hp, target,
402 						"cfg-handle", NULL);
403 		if (cfg_handle)
404 			break;
405 	}
406 
407 	if (!id) {
408 		query.dev_no = ~(u64)0;
409 		query.id = ~(u64)0;
410 	} else if (!cfg_handle) {
411 		query.dev_no = *id;
412 		query.id = ~(u64)0;
413 	} else {
414 		query.dev_no = *cfg_handle;
415 		query.id = *id;
416 	}
417 
418 	dev = device_find_child(&root_vdev->dev, &query,
419 				vio_md_node_match);
420 	if (dev) {
421 		printk(KERN_INFO "VIO: Removing device %s\n", dev_name(dev));
422 
423 		device_unregister(dev);
424 		put_device(dev);
425 	} else {
426 		if (!id)
427 			printk(KERN_ERR "VIO: Removed unknown %s node.\n",
428 			       type);
429 		else if (!cfg_handle)
430 			printk(KERN_ERR "VIO: Removed unknown %s node %llu.\n",
431 			       type, *id);
432 		else
433 			printk(KERN_ERR "VIO: Removed unknown %s node %llu-%llu.\n",
434 			       type, *cfg_handle, *id);
435 	}
436 }
437 
438 static struct mdesc_notifier_client vio_device_notifier = {
439 	.add		= vio_add,
440 	.remove		= vio_remove,
441 	.node_name	= "virtual-device-port",
442 };
443 
444 /* We are only interested in domain service ports under the
445  * "domain-services" node.  On control nodes there is another port
446  * under "openboot" that we should not mess with as aparently that is
447  * reserved exclusively for OBP use.
448  */
449 static void vio_add_ds(struct mdesc_handle *hp, u64 node)
450 {
451 	int found;
452 	u64 a;
453 
454 	found = 0;
455 	mdesc_for_each_arc(a, hp, node, MDESC_ARC_TYPE_BACK) {
456 		u64 target = mdesc_arc_target(hp, a);
457 		const char *name = mdesc_node_name(hp, target);
458 
459 		if (!strcmp(name, "domain-services")) {
460 			found = 1;
461 			break;
462 		}
463 	}
464 
465 	if (found)
466 		(void) vio_create_one(hp, node, &root_vdev->dev);
467 }
468 
469 static struct mdesc_notifier_client vio_ds_notifier = {
470 	.add		= vio_add_ds,
471 	.remove		= vio_remove,
472 	.node_name	= "domain-services-port",
473 };
474 
475 static const char *channel_devices_node = "channel-devices";
476 static const char *channel_devices_compat = "SUNW,sun4v-channel-devices";
477 static const char *cfg_handle_prop = "cfg-handle";
478 
479 static int __init vio_init(void)
480 {
481 	struct mdesc_handle *hp;
482 	const char *compat;
483 	const u64 *cfg_handle;
484 	int err, len;
485 	u64 root;
486 
487 	err = bus_register(&vio_bus_type);
488 	if (err) {
489 		printk(KERN_ERR "VIO: Could not register bus type err=%d\n",
490 		       err);
491 		return err;
492 	}
493 
494 	hp = mdesc_grab();
495 	if (!hp)
496 		return 0;
497 
498 	root = mdesc_node_by_name(hp, MDESC_NODE_NULL, channel_devices_node);
499 	if (root == MDESC_NODE_NULL) {
500 		printk(KERN_INFO "VIO: No channel-devices MDESC node.\n");
501 		mdesc_release(hp);
502 		return 0;
503 	}
504 
505 	cdev_node = of_find_node_by_name(NULL, "channel-devices");
506 	err = -ENODEV;
507 	if (!cdev_node) {
508 		printk(KERN_INFO "VIO: No channel-devices OBP node.\n");
509 		goto out_release;
510 	}
511 
512 	compat = mdesc_get_property(hp, root, "compatible", &len);
513 	if (!compat) {
514 		printk(KERN_ERR "VIO: Channel devices lacks compatible "
515 		       "property\n");
516 		goto out_release;
517 	}
518 	if (!of_find_in_proplist(compat, channel_devices_compat, len)) {
519 		printk(KERN_ERR "VIO: Channel devices node lacks (%s) "
520 		       "compat entry.\n", channel_devices_compat);
521 		goto out_release;
522 	}
523 
524 	cfg_handle = mdesc_get_property(hp, root, cfg_handle_prop, NULL);
525 	if (!cfg_handle) {
526 		printk(KERN_ERR "VIO: Channel devices lacks %s property\n",
527 		       cfg_handle_prop);
528 		goto out_release;
529 	}
530 
531 	cdev_cfg_handle = *cfg_handle;
532 
533 	root_vdev = vio_create_one(hp, root, NULL);
534 	err = -ENODEV;
535 	if (!root_vdev) {
536 		printk(KERN_ERR "VIO: Could not create root device.\n");
537 		goto out_release;
538 	}
539 
540 	mdesc_register_notifier(&vio_device_notifier);
541 	mdesc_register_notifier(&vio_ds_notifier);
542 
543 	mdesc_release(hp);
544 
545 	return err;
546 
547 out_release:
548 	mdesc_release(hp);
549 	return err;
550 }
551 
552 postcore_initcall(vio_init);
553