xref: /openbmc/linux/arch/sparc/kernel/vio.c (revision 0edbfea5) 
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 	} else if (!cfg_handle) {
306 		dev_set_name(&vdev->dev, "%s-%llu", bus_id_name, *id);
307 		vdev->dev_no = *id;
308 	} else {
309 		dev_set_name(&vdev->dev, "%s-%llu-%llu", bus_id_name,
310 			     *cfg_handle, *id);
311 		vdev->dev_no = *cfg_handle;
312 	}
313 
314 	vdev->dev.parent = parent;
315 	vdev->dev.bus = &vio_bus_type;
316 	vdev->dev.release = vio_dev_release;
317 
318 	if (parent == NULL) {
319 		dp = cdev_node;
320 	} else if (to_vio_dev(parent) == root_vdev) {
321 		dp = of_get_next_child(cdev_node, NULL);
322 		while (dp) {
323 			if (!strcmp(dp->type, type))
324 				break;
325 
326 			dp = of_get_next_child(cdev_node, dp);
327 		}
328 	} else {
329 		dp = to_vio_dev(parent)->dp;
330 	}
331 	vdev->dp = dp;
332 
333 	printk(KERN_INFO "VIO: Adding device %s\n", dev_name(&vdev->dev));
334 
335 	err = device_register(&vdev->dev);
336 	if (err) {
337 		printk(KERN_ERR "VIO: Could not register device %s, err=%d\n",
338 		       dev_name(&vdev->dev), err);
339 		kfree(vdev);
340 		return NULL;
341 	}
342 	if (vdev->dp)
343 		err = sysfs_create_file(&vdev->dev.kobj,
344 					&dev_attr_obppath.attr);
345 
346 	return vdev;
347 }
348 
349 static void vio_add(struct mdesc_handle *hp, u64 node)
350 {
351 	(void) vio_create_one(hp, node, &root_vdev->dev);
352 }
353 
354 static int vio_md_node_match(struct device *dev, void *arg)
355 {
356 	struct vio_dev *vdev = to_vio_dev(dev);
357 
358 	if (vdev->mp == (u64) arg)
359 		return 1;
360 
361 	return 0;
362 }
363 
364 static void vio_remove(struct mdesc_handle *hp, u64 node)
365 {
366 	struct device *dev;
367 
368 	dev = device_find_child(&root_vdev->dev, (void *) node,
369 				vio_md_node_match);
370 	if (dev) {
371 		printk(KERN_INFO "VIO: Removing device %s\n", dev_name(dev));
372 
373 		device_unregister(dev);
374 		put_device(dev);
375 	}
376 }
377 
378 static struct mdesc_notifier_client vio_device_notifier = {
379 	.add		= vio_add,
380 	.remove		= vio_remove,
381 	.node_name	= "virtual-device-port",
382 };
383 
384 /* We are only interested in domain service ports under the
385  * "domain-services" node.  On control nodes there is another port
386  * under "openboot" that we should not mess with as aparently that is
387  * reserved exclusively for OBP use.
388  */
389 static void vio_add_ds(struct mdesc_handle *hp, u64 node)
390 {
391 	int found;
392 	u64 a;
393 
394 	found = 0;
395 	mdesc_for_each_arc(a, hp, node, MDESC_ARC_TYPE_BACK) {
396 		u64 target = mdesc_arc_target(hp, a);
397 		const char *name = mdesc_node_name(hp, target);
398 
399 		if (!strcmp(name, "domain-services")) {
400 			found = 1;
401 			break;
402 		}
403 	}
404 
405 	if (found)
406 		(void) vio_create_one(hp, node, &root_vdev->dev);
407 }
408 
409 static struct mdesc_notifier_client vio_ds_notifier = {
410 	.add		= vio_add_ds,
411 	.remove		= vio_remove,
412 	.node_name	= "domain-services-port",
413 };
414 
415 static const char *channel_devices_node = "channel-devices";
416 static const char *channel_devices_compat = "SUNW,sun4v-channel-devices";
417 static const char *cfg_handle_prop = "cfg-handle";
418 
419 static int __init vio_init(void)
420 {
421 	struct mdesc_handle *hp;
422 	const char *compat;
423 	const u64 *cfg_handle;
424 	int err, len;
425 	u64 root;
426 
427 	err = bus_register(&vio_bus_type);
428 	if (err) {
429 		printk(KERN_ERR "VIO: Could not register bus type err=%d\n",
430 		       err);
431 		return err;
432 	}
433 
434 	hp = mdesc_grab();
435 	if (!hp)
436 		return 0;
437 
438 	root = mdesc_node_by_name(hp, MDESC_NODE_NULL, channel_devices_node);
439 	if (root == MDESC_NODE_NULL) {
440 		printk(KERN_INFO "VIO: No channel-devices MDESC node.\n");
441 		mdesc_release(hp);
442 		return 0;
443 	}
444 
445 	cdev_node = of_find_node_by_name(NULL, "channel-devices");
446 	err = -ENODEV;
447 	if (!cdev_node) {
448 		printk(KERN_INFO "VIO: No channel-devices OBP node.\n");
449 		goto out_release;
450 	}
451 
452 	compat = mdesc_get_property(hp, root, "compatible", &len);
453 	if (!compat) {
454 		printk(KERN_ERR "VIO: Channel devices lacks compatible "
455 		       "property\n");
456 		goto out_release;
457 	}
458 	if (!of_find_in_proplist(compat, channel_devices_compat, len)) {
459 		printk(KERN_ERR "VIO: Channel devices node lacks (%s) "
460 		       "compat entry.\n", channel_devices_compat);
461 		goto out_release;
462 	}
463 
464 	cfg_handle = mdesc_get_property(hp, root, cfg_handle_prop, NULL);
465 	if (!cfg_handle) {
466 		printk(KERN_ERR "VIO: Channel devices lacks %s property\n",
467 		       cfg_handle_prop);
468 		goto out_release;
469 	}
470 
471 	cdev_cfg_handle = *cfg_handle;
472 
473 	root_vdev = vio_create_one(hp, root, NULL);
474 	err = -ENODEV;
475 	if (!root_vdev) {
476 		printk(KERN_ERR "VIO: Could not create root device.\n");
477 		goto out_release;
478 	}
479 
480 	mdesc_register_notifier(&vio_device_notifier);
481 	mdesc_register_notifier(&vio_ds_notifier);
482 
483 	mdesc_release(hp);
484 
485 	return err;
486 
487 out_release:
488 	mdesc_release(hp);
489 	return err;
490 }
491 
492 postcore_initcall(vio_init);
493