xref: /openbmc/linux/arch/sparc/kernel/vio.c (revision 615c36f5)
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_bus_match(struct device *dev, struct device_driver *drv)
49 {
50 	struct vio_dev *vio_dev = to_vio_dev(dev);
51 	struct vio_driver *vio_drv = to_vio_driver(drv);
52 	const struct vio_device_id *matches = vio_drv->id_table;
53 
54 	if (!matches)
55 		return 0;
56 
57 	return vio_match_device(matches, vio_dev) != NULL;
58 }
59 
60 static int vio_device_probe(struct device *dev)
61 {
62 	struct vio_dev *vdev = to_vio_dev(dev);
63 	struct vio_driver *drv = to_vio_driver(dev->driver);
64 	const struct vio_device_id *id;
65 	int error = -ENODEV;
66 
67 	if (drv->probe) {
68 		id = vio_match_device(drv->id_table, vdev);
69 		if (id)
70 			error = drv->probe(vdev, id);
71 	}
72 
73 	return error;
74 }
75 
76 static int vio_device_remove(struct device *dev)
77 {
78 	struct vio_dev *vdev = to_vio_dev(dev);
79 	struct vio_driver *drv = to_vio_driver(dev->driver);
80 
81 	if (drv->remove)
82 		return drv->remove(vdev);
83 
84 	return 1;
85 }
86 
87 static ssize_t devspec_show(struct device *dev,
88 		struct device_attribute *attr, char *buf)
89 {
90 	struct vio_dev *vdev = to_vio_dev(dev);
91 	const char *str = "none";
92 
93 	if (!strcmp(vdev->type, "vnet-port"))
94 		str = "vnet";
95 	else if (!strcmp(vdev->type, "vdc-port"))
96 		str = "vdisk";
97 
98 	return sprintf(buf, "%s\n", str);
99 }
100 
101 static ssize_t type_show(struct device *dev,
102 		struct device_attribute *attr, char *buf)
103 {
104 	struct vio_dev *vdev = to_vio_dev(dev);
105 	return sprintf(buf, "%s\n", vdev->type);
106 }
107 
108 static struct device_attribute vio_dev_attrs[] = {
109 	__ATTR_RO(devspec),
110 	__ATTR_RO(type),
111 	__ATTR_NULL
112 };
113 
114 static struct bus_type vio_bus_type = {
115 	.name		= "vio",
116 	.dev_attrs	= vio_dev_attrs,
117 	.match		= vio_bus_match,
118 	.probe		= vio_device_probe,
119 	.remove		= vio_device_remove,
120 };
121 
122 int vio_register_driver(struct vio_driver *viodrv)
123 {
124 	viodrv->driver.bus = &vio_bus_type;
125 
126 	return driver_register(&viodrv->driver);
127 }
128 EXPORT_SYMBOL(vio_register_driver);
129 
130 void vio_unregister_driver(struct vio_driver *viodrv)
131 {
132 	driver_unregister(&viodrv->driver);
133 }
134 EXPORT_SYMBOL(vio_unregister_driver);
135 
136 static void vio_dev_release(struct device *dev)
137 {
138 	kfree(to_vio_dev(dev));
139 }
140 
141 static ssize_t
142 show_pciobppath_attr(struct device *dev, struct device_attribute *attr,
143 		     char *buf)
144 {
145 	struct vio_dev *vdev;
146 	struct device_node *dp;
147 
148 	vdev = to_vio_dev(dev);
149 	dp = vdev->dp;
150 
151 	return snprintf (buf, PAGE_SIZE, "%s\n", dp->full_name);
152 }
153 
154 static DEVICE_ATTR(obppath, S_IRUSR | S_IRGRP | S_IROTH,
155 		   show_pciobppath_attr, NULL);
156 
157 static struct device_node *cdev_node;
158 
159 static struct vio_dev *root_vdev;
160 static u64 cdev_cfg_handle;
161 
162 static void vio_fill_channel_info(struct mdesc_handle *hp, u64 mp,
163 				  struct vio_dev *vdev)
164 {
165 	u64 a;
166 
167 	mdesc_for_each_arc(a, hp, mp, MDESC_ARC_TYPE_FWD) {
168 		const u64 *chan_id;
169 		const u64 *irq;
170 		u64 target;
171 
172 		target = mdesc_arc_target(hp, a);
173 
174 		irq = mdesc_get_property(hp, target, "tx-ino", NULL);
175 		if (irq)
176 			vdev->tx_irq = sun4v_build_virq(cdev_cfg_handle, *irq);
177 
178 		irq = mdesc_get_property(hp, target, "rx-ino", NULL);
179 		if (irq)
180 			vdev->rx_irq = sun4v_build_virq(cdev_cfg_handle, *irq);
181 
182 		chan_id = mdesc_get_property(hp, target, "id", NULL);
183 		if (chan_id)
184 			vdev->channel_id = *chan_id;
185 	}
186 }
187 
188 static struct vio_dev *vio_create_one(struct mdesc_handle *hp, u64 mp,
189 				      struct device *parent)
190 {
191 	const char *type, *compat, *bus_id_name;
192 	struct device_node *dp;
193 	struct vio_dev *vdev;
194 	int err, tlen, clen;
195 	const u64 *id, *cfg_handle;
196 	u64 a;
197 
198 	type = mdesc_get_property(hp, mp, "device-type", &tlen);
199 	if (!type) {
200 		type = mdesc_get_property(hp, mp, "name", &tlen);
201 		if (!type) {
202 			type = mdesc_node_name(hp, mp);
203 			tlen = strlen(type) + 1;
204 		}
205 	}
206 	if (tlen > VIO_MAX_TYPE_LEN) {
207 		printk(KERN_ERR "VIO: Type string [%s] is too long.\n",
208 		       type);
209 		return NULL;
210 	}
211 
212 	id = mdesc_get_property(hp, mp, "id", NULL);
213 
214 	cfg_handle = NULL;
215 	mdesc_for_each_arc(a, hp, mp, MDESC_ARC_TYPE_BACK) {
216 		u64 target;
217 
218 		target = mdesc_arc_target(hp, a);
219 		cfg_handle = mdesc_get_property(hp, target,
220 						"cfg-handle", NULL);
221 		if (cfg_handle)
222 			break;
223 	}
224 
225 	bus_id_name = type;
226 	if (!strcmp(type, "domain-services-port"))
227 		bus_id_name = "ds";
228 
229 	/*
230 	 * 20 char is the old driver-core name size limit, which is no more.
231 	 * This check can probably be removed after review and possible
232 	 * adaption of the vio users name length handling.
233 	 */
234 	if (strlen(bus_id_name) >= 20 - 4) {
235 		printk(KERN_ERR "VIO: bus_id_name [%s] is too long.\n",
236 		       bus_id_name);
237 		return NULL;
238 	}
239 
240 	compat = mdesc_get_property(hp, mp, "device-type", &clen);
241 	if (!compat) {
242 		clen = 0;
243 	} else if (clen > VIO_MAX_COMPAT_LEN) {
244 		printk(KERN_ERR "VIO: Compat len %d for [%s] is too long.\n",
245 		       clen, type);
246 		return NULL;
247 	}
248 
249 	vdev = kzalloc(sizeof(*vdev), GFP_KERNEL);
250 	if (!vdev) {
251 		printk(KERN_ERR "VIO: Could not allocate vio_dev\n");
252 		return NULL;
253 	}
254 
255 	vdev->mp = mp;
256 	memcpy(vdev->type, type, tlen);
257 	if (compat)
258 		memcpy(vdev->compat, compat, clen);
259 	else
260 		memset(vdev->compat, 0, sizeof(vdev->compat));
261 	vdev->compat_len = clen;
262 
263 	vdev->channel_id = ~0UL;
264 	vdev->tx_irq = ~0;
265 	vdev->rx_irq = ~0;
266 
267 	vio_fill_channel_info(hp, mp, vdev);
268 
269 	if (!id) {
270 		dev_set_name(&vdev->dev, "%s", bus_id_name);
271 		vdev->dev_no = ~(u64)0;
272 	} else if (!cfg_handle) {
273 		dev_set_name(&vdev->dev, "%s-%llu", bus_id_name, *id);
274 		vdev->dev_no = *id;
275 	} else {
276 		dev_set_name(&vdev->dev, "%s-%llu-%llu", bus_id_name,
277 			     *cfg_handle, *id);
278 		vdev->dev_no = *cfg_handle;
279 	}
280 
281 	vdev->dev.parent = parent;
282 	vdev->dev.bus = &vio_bus_type;
283 	vdev->dev.release = vio_dev_release;
284 
285 	if (parent == NULL) {
286 		dp = cdev_node;
287 	} else if (to_vio_dev(parent) == root_vdev) {
288 		dp = of_get_next_child(cdev_node, NULL);
289 		while (dp) {
290 			if (!strcmp(dp->type, type))
291 				break;
292 
293 			dp = of_get_next_child(cdev_node, dp);
294 		}
295 	} else {
296 		dp = to_vio_dev(parent)->dp;
297 	}
298 	vdev->dp = dp;
299 
300 	printk(KERN_INFO "VIO: Adding device %s\n", dev_name(&vdev->dev));
301 
302 	err = device_register(&vdev->dev);
303 	if (err) {
304 		printk(KERN_ERR "VIO: Could not register device %s, err=%d\n",
305 		       dev_name(&vdev->dev), err);
306 		kfree(vdev);
307 		return NULL;
308 	}
309 	if (vdev->dp)
310 		err = sysfs_create_file(&vdev->dev.kobj,
311 					&dev_attr_obppath.attr);
312 
313 	return vdev;
314 }
315 
316 static void vio_add(struct mdesc_handle *hp, u64 node)
317 {
318 	(void) vio_create_one(hp, node, &root_vdev->dev);
319 }
320 
321 static int vio_md_node_match(struct device *dev, void *arg)
322 {
323 	struct vio_dev *vdev = to_vio_dev(dev);
324 
325 	if (vdev->mp == (u64) arg)
326 		return 1;
327 
328 	return 0;
329 }
330 
331 static void vio_remove(struct mdesc_handle *hp, u64 node)
332 {
333 	struct device *dev;
334 
335 	dev = device_find_child(&root_vdev->dev, (void *) node,
336 				vio_md_node_match);
337 	if (dev) {
338 		printk(KERN_INFO "VIO: Removing device %s\n", dev_name(dev));
339 
340 		device_unregister(dev);
341 	}
342 }
343 
344 static struct mdesc_notifier_client vio_device_notifier = {
345 	.add		= vio_add,
346 	.remove		= vio_remove,
347 	.node_name	= "virtual-device-port",
348 };
349 
350 /* We are only interested in domain service ports under the
351  * "domain-services" node.  On control nodes there is another port
352  * under "openboot" that we should not mess with as aparently that is
353  * reserved exclusively for OBP use.
354  */
355 static void vio_add_ds(struct mdesc_handle *hp, u64 node)
356 {
357 	int found;
358 	u64 a;
359 
360 	found = 0;
361 	mdesc_for_each_arc(a, hp, node, MDESC_ARC_TYPE_BACK) {
362 		u64 target = mdesc_arc_target(hp, a);
363 		const char *name = mdesc_node_name(hp, target);
364 
365 		if (!strcmp(name, "domain-services")) {
366 			found = 1;
367 			break;
368 		}
369 	}
370 
371 	if (found)
372 		(void) vio_create_one(hp, node, &root_vdev->dev);
373 }
374 
375 static struct mdesc_notifier_client vio_ds_notifier = {
376 	.add		= vio_add_ds,
377 	.remove		= vio_remove,
378 	.node_name	= "domain-services-port",
379 };
380 
381 static const char *channel_devices_node = "channel-devices";
382 static const char *channel_devices_compat = "SUNW,sun4v-channel-devices";
383 static const char *cfg_handle_prop = "cfg-handle";
384 
385 static int __init vio_init(void)
386 {
387 	struct mdesc_handle *hp;
388 	const char *compat;
389 	const u64 *cfg_handle;
390 	int err, len;
391 	u64 root;
392 
393 	err = bus_register(&vio_bus_type);
394 	if (err) {
395 		printk(KERN_ERR "VIO: Could not register bus type err=%d\n",
396 		       err);
397 		return err;
398 	}
399 
400 	hp = mdesc_grab();
401 	if (!hp)
402 		return 0;
403 
404 	root = mdesc_node_by_name(hp, MDESC_NODE_NULL, channel_devices_node);
405 	if (root == MDESC_NODE_NULL) {
406 		printk(KERN_INFO "VIO: No channel-devices MDESC node.\n");
407 		mdesc_release(hp);
408 		return 0;
409 	}
410 
411 	cdev_node = of_find_node_by_name(NULL, "channel-devices");
412 	err = -ENODEV;
413 	if (!cdev_node) {
414 		printk(KERN_INFO "VIO: No channel-devices OBP node.\n");
415 		goto out_release;
416 	}
417 
418 	compat = mdesc_get_property(hp, root, "compatible", &len);
419 	if (!compat) {
420 		printk(KERN_ERR "VIO: Channel devices lacks compatible "
421 		       "property\n");
422 		goto out_release;
423 	}
424 	if (!of_find_in_proplist(compat, channel_devices_compat, len)) {
425 		printk(KERN_ERR "VIO: Channel devices node lacks (%s) "
426 		       "compat entry.\n", channel_devices_compat);
427 		goto out_release;
428 	}
429 
430 	cfg_handle = mdesc_get_property(hp, root, cfg_handle_prop, NULL);
431 	if (!cfg_handle) {
432 		printk(KERN_ERR "VIO: Channel devices lacks %s property\n",
433 		       cfg_handle_prop);
434 		goto out_release;
435 	}
436 
437 	cdev_cfg_handle = *cfg_handle;
438 
439 	root_vdev = vio_create_one(hp, root, NULL);
440 	err = -ENODEV;
441 	if (!root_vdev) {
442 		printk(KERN_ERR "VIO: Coult not create root device.\n");
443 		goto out_release;
444 	}
445 
446 	mdesc_register_notifier(&vio_device_notifier);
447 	mdesc_register_notifier(&vio_ds_notifier);
448 
449 	mdesc_release(hp);
450 
451 	return err;
452 
453 out_release:
454 	mdesc_release(hp);
455 	return err;
456 }
457 
458 postcore_initcall(vio_init);
459