• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Media device
3  *
4  * Copyright (C) 2010 Nokia Corporation
5  *
6  * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
7  *	     Sakari Ailus <sakari.ailus@iki.fi>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License version 2 as
11  * published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  */
18 
19 /* We need to access legacy defines from linux/media.h */
20 #define __NEED_MEDIA_LEGACY_API
21 
22 #include <linux/compat.h>
23 #include <linux/export.h>
24 #include <linux/idr.h>
25 #include <linux/ioctl.h>
26 #include <linux/media.h>
27 #include <linux/slab.h>
28 #include <linux/types.h>
29 #include <linux/pci.h>
30 #include <linux/usb.h>
31 
32 #include <media/media-device.h>
33 #include <media/media-devnode.h>
34 #include <media/media-entity.h>
35 
36 #ifdef CONFIG_MEDIA_CONTROLLER
37 
38 /* -----------------------------------------------------------------------------
39  * Userspace API
40  */
41 
media_get_uptr(__u64 arg)42 static inline void __user *media_get_uptr(__u64 arg)
43 {
44 	return (void __user *)(uintptr_t)arg;
45 }
46 
media_device_open(struct file * filp)47 static int media_device_open(struct file *filp)
48 {
49 	return 0;
50 }
51 
media_device_close(struct file * filp)52 static int media_device_close(struct file *filp)
53 {
54 	return 0;
55 }
56 
media_device_get_info(struct media_device * dev,void * arg)57 static long media_device_get_info(struct media_device *dev, void *arg)
58 {
59 	struct media_device_info *info = arg;
60 
61 	memset(info, 0, sizeof(*info));
62 
63 	if (dev->driver_name[0])
64 		strlcpy(info->driver, dev->driver_name, sizeof(info->driver));
65 	else
66 		strlcpy(info->driver, dev->dev->driver->name,
67 			sizeof(info->driver));
68 
69 	strlcpy(info->model, dev->model, sizeof(info->model));
70 	strlcpy(info->serial, dev->serial, sizeof(info->serial));
71 	strlcpy(info->bus_info, dev->bus_info, sizeof(info->bus_info));
72 
73 	info->media_version = LINUX_VERSION_CODE;
74 	info->driver_version = info->media_version;
75 	info->hw_revision = dev->hw_revision;
76 
77 	return 0;
78 }
79 
find_entity(struct media_device * mdev,u32 id)80 static struct media_entity *find_entity(struct media_device *mdev, u32 id)
81 {
82 	struct media_entity *entity;
83 	int next = id & MEDIA_ENT_ID_FLAG_NEXT;
84 
85 	id &= ~MEDIA_ENT_ID_FLAG_NEXT;
86 
87 	media_device_for_each_entity(entity, mdev) {
88 		if (((media_entity_id(entity) == id) && !next) ||
89 		    ((media_entity_id(entity) > id) && next)) {
90 			return entity;
91 		}
92 	}
93 
94 	return NULL;
95 }
96 
media_device_enum_entities(struct media_device * mdev,void * arg)97 static long media_device_enum_entities(struct media_device *mdev, void *arg)
98 {
99 	struct media_entity_desc *entd = arg;
100 	struct media_entity *ent;
101 
102 	ent = find_entity(mdev, entd->id);
103 	if (ent == NULL)
104 		return -EINVAL;
105 
106 	memset(entd, 0, sizeof(*entd));
107 
108 	entd->id = media_entity_id(ent);
109 	if (ent->name)
110 		strlcpy(entd->name, ent->name, sizeof(entd->name));
111 	entd->type = ent->function;
112 	entd->revision = 0;		/* Unused */
113 	entd->flags = ent->flags;
114 	entd->group_id = 0;		/* Unused */
115 	entd->pads = ent->num_pads;
116 	entd->links = ent->num_links - ent->num_backlinks;
117 
118 	/*
119 	 * Workaround for a bug at media-ctl <= v1.10 that makes it to
120 	 * do the wrong thing if the entity function doesn't belong to
121 	 * either MEDIA_ENT_F_OLD_BASE or MEDIA_ENT_F_OLD_SUBDEV_BASE
122 	 * Ranges.
123 	 *
124 	 * Non-subdevices are expected to be at the MEDIA_ENT_F_OLD_BASE,
125 	 * or, otherwise, will be silently ignored by media-ctl when
126 	 * printing the graphviz diagram. So, map them into the devnode
127 	 * old range.
128 	 */
129 	if (ent->function < MEDIA_ENT_F_OLD_BASE ||
130 	    ent->function > MEDIA_ENT_F_TUNER) {
131 		if (is_media_entity_v4l2_subdev(ent))
132 			entd->type = MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN;
133 		else if (ent->function != MEDIA_ENT_F_IO_V4L)
134 			entd->type = MEDIA_ENT_T_DEVNODE_UNKNOWN;
135 	}
136 
137 	memcpy(&entd->raw, &ent->info, sizeof(ent->info));
138 
139 	return 0;
140 }
141 
media_device_kpad_to_upad(const struct media_pad * kpad,struct media_pad_desc * upad)142 static void media_device_kpad_to_upad(const struct media_pad *kpad,
143 				      struct media_pad_desc *upad)
144 {
145 	upad->entity = media_entity_id(kpad->entity);
146 	upad->index = kpad->index;
147 	upad->flags = kpad->flags;
148 }
149 
media_device_enum_links(struct media_device * mdev,void * arg)150 static long media_device_enum_links(struct media_device *mdev, void *arg)
151 {
152 	struct media_links_enum *links = arg;
153 	struct media_entity *entity;
154 
155 	entity = find_entity(mdev, links->entity);
156 	if (entity == NULL)
157 		return -EINVAL;
158 
159 	if (links->pads) {
160 		unsigned int p;
161 
162 		for (p = 0; p < entity->num_pads; p++) {
163 			struct media_pad_desc pad;
164 
165 			memset(&pad, 0, sizeof(pad));
166 			media_device_kpad_to_upad(&entity->pads[p], &pad);
167 			if (copy_to_user(&links->pads[p], &pad, sizeof(pad)))
168 				return -EFAULT;
169 		}
170 	}
171 
172 	if (links->links) {
173 		struct media_link *link;
174 		struct media_link_desc __user *ulink_desc = links->links;
175 
176 		list_for_each_entry(link, &entity->links, list) {
177 			struct media_link_desc klink_desc;
178 
179 			/* Ignore backlinks. */
180 			if (link->source->entity != entity)
181 				continue;
182 			memset(&klink_desc, 0, sizeof(klink_desc));
183 			media_device_kpad_to_upad(link->source,
184 						  &klink_desc.source);
185 			media_device_kpad_to_upad(link->sink,
186 						  &klink_desc.sink);
187 			klink_desc.flags = link->flags;
188 			if (copy_to_user(ulink_desc, &klink_desc,
189 					 sizeof(*ulink_desc)))
190 				return -EFAULT;
191 			ulink_desc++;
192 		}
193 	}
194 
195 	return 0;
196 }
197 
media_device_setup_link(struct media_device * mdev,void * arg)198 static long media_device_setup_link(struct media_device *mdev, void *arg)
199 {
200 	struct media_link_desc *linkd = arg;
201 	struct media_link *link = NULL;
202 	struct media_entity *source;
203 	struct media_entity *sink;
204 
205 	/* Find the source and sink entities and link.
206 	 */
207 	source = find_entity(mdev, linkd->source.entity);
208 	sink = find_entity(mdev, linkd->sink.entity);
209 
210 	if (source == NULL || sink == NULL)
211 		return -EINVAL;
212 
213 	if (linkd->source.index >= source->num_pads ||
214 	    linkd->sink.index >= sink->num_pads)
215 		return -EINVAL;
216 
217 	link = media_entity_find_link(&source->pads[linkd->source.index],
218 				      &sink->pads[linkd->sink.index]);
219 	if (link == NULL)
220 		return -EINVAL;
221 
222 	/* Setup the link on both entities. */
223 	return __media_entity_setup_link(link, linkd->flags);
224 }
225 
media_device_get_topology(struct media_device * mdev,void * arg)226 static long media_device_get_topology(struct media_device *mdev, void *arg)
227 {
228 	struct media_v2_topology *topo = arg;
229 	struct media_entity *entity;
230 	struct media_interface *intf;
231 	struct media_pad *pad;
232 	struct media_link *link;
233 	struct media_v2_entity kentity, __user *uentity;
234 	struct media_v2_interface kintf, __user *uintf;
235 	struct media_v2_pad kpad, __user *upad;
236 	struct media_v2_link klink, __user *ulink;
237 	unsigned int i;
238 	int ret = 0;
239 
240 	topo->topology_version = mdev->topology_version;
241 
242 	/* Get entities and number of entities */
243 	i = 0;
244 	uentity = media_get_uptr(topo->ptr_entities);
245 	media_device_for_each_entity(entity, mdev) {
246 		i++;
247 		if (ret || !uentity)
248 			continue;
249 
250 		if (i > topo->num_entities) {
251 			ret = -ENOSPC;
252 			continue;
253 		}
254 
255 		/* Copy fields to userspace struct if not error */
256 		memset(&kentity, 0, sizeof(kentity));
257 		kentity.id = entity->graph_obj.id;
258 		kentity.function = entity->function;
259 		strncpy(kentity.name, entity->name,
260 			sizeof(kentity.name));
261 
262 		if (copy_to_user(uentity, &kentity, sizeof(kentity)))
263 			ret = -EFAULT;
264 		uentity++;
265 	}
266 	topo->num_entities = i;
267 
268 	/* Get interfaces and number of interfaces */
269 	i = 0;
270 	uintf = media_get_uptr(topo->ptr_interfaces);
271 	media_device_for_each_intf(intf, mdev) {
272 		i++;
273 		if (ret || !uintf)
274 			continue;
275 
276 		if (i > topo->num_interfaces) {
277 			ret = -ENOSPC;
278 			continue;
279 		}
280 
281 		memset(&kintf, 0, sizeof(kintf));
282 
283 		/* Copy intf fields to userspace struct */
284 		kintf.id = intf->graph_obj.id;
285 		kintf.intf_type = intf->type;
286 		kintf.flags = intf->flags;
287 
288 		if (media_type(&intf->graph_obj) == MEDIA_GRAPH_INTF_DEVNODE) {
289 			struct media_intf_devnode *devnode;
290 
291 			devnode = intf_to_devnode(intf);
292 
293 			kintf.devnode.major = devnode->major;
294 			kintf.devnode.minor = devnode->minor;
295 		}
296 
297 		if (copy_to_user(uintf, &kintf, sizeof(kintf)))
298 			ret = -EFAULT;
299 		uintf++;
300 	}
301 	topo->num_interfaces = i;
302 
303 	/* Get pads and number of pads */
304 	i = 0;
305 	upad = media_get_uptr(topo->ptr_pads);
306 	media_device_for_each_pad(pad, mdev) {
307 		i++;
308 		if (ret || !upad)
309 			continue;
310 
311 		if (i > topo->num_pads) {
312 			ret = -ENOSPC;
313 			continue;
314 		}
315 
316 		memset(&kpad, 0, sizeof(kpad));
317 
318 		/* Copy pad fields to userspace struct */
319 		kpad.id = pad->graph_obj.id;
320 		kpad.entity_id = pad->entity->graph_obj.id;
321 		kpad.flags = pad->flags;
322 
323 		if (copy_to_user(upad, &kpad, sizeof(kpad)))
324 			ret = -EFAULT;
325 		upad++;
326 	}
327 	topo->num_pads = i;
328 
329 	/* Get links and number of links */
330 	i = 0;
331 	ulink = media_get_uptr(topo->ptr_links);
332 	media_device_for_each_link(link, mdev) {
333 		if (link->is_backlink)
334 			continue;
335 
336 		i++;
337 
338 		if (ret || !ulink)
339 			continue;
340 
341 		if (i > topo->num_links) {
342 			ret = -ENOSPC;
343 			continue;
344 		}
345 
346 		memset(&klink, 0, sizeof(klink));
347 
348 		/* Copy link fields to userspace struct */
349 		klink.id = link->graph_obj.id;
350 		klink.source_id = link->gobj0->id;
351 		klink.sink_id = link->gobj1->id;
352 		klink.flags = link->flags;
353 
354 		if (copy_to_user(ulink, &klink, sizeof(klink)))
355 			ret = -EFAULT;
356 		ulink++;
357 	}
358 	topo->num_links = i;
359 
360 	return ret;
361 }
362 
copy_arg_from_user(void * karg,void __user * uarg,unsigned int cmd)363 static long copy_arg_from_user(void *karg, void __user *uarg, unsigned int cmd)
364 {
365 	/* All media IOCTLs are _IOWR() */
366 	if (copy_from_user(karg, uarg, _IOC_SIZE(cmd)))
367 		return -EFAULT;
368 
369 	return 0;
370 }
371 
copy_arg_to_user(void __user * uarg,void * karg,unsigned int cmd)372 static long copy_arg_to_user(void __user *uarg, void *karg, unsigned int cmd)
373 {
374 	/* All media IOCTLs are _IOWR() */
375 	if (copy_to_user(uarg, karg, _IOC_SIZE(cmd)))
376 		return -EFAULT;
377 
378 	return 0;
379 }
380 
381 /* Do acquire the graph mutex */
382 #define MEDIA_IOC_FL_GRAPH_MUTEX	BIT(0)
383 
384 #define MEDIA_IOC_ARG(__cmd, func, fl, from_user, to_user)		\
385 	[_IOC_NR(MEDIA_IOC_##__cmd)] = {				\
386 		.cmd = MEDIA_IOC_##__cmd,				\
387 		.fn = (long (*)(struct media_device *, void *))func,	\
388 		.flags = fl,						\
389 		.arg_from_user = from_user,				\
390 		.arg_to_user = to_user,					\
391 	}
392 
393 #define MEDIA_IOC(__cmd, func, fl)					\
394 	MEDIA_IOC_ARG(__cmd, func, fl, copy_arg_from_user, copy_arg_to_user)
395 
396 /* the table is indexed by _IOC_NR(cmd) */
397 struct media_ioctl_info {
398 	unsigned int cmd;
399 	unsigned short flags;
400 	long (*fn)(struct media_device *dev, void *arg);
401 	long (*arg_from_user)(void *karg, void __user *uarg, unsigned int cmd);
402 	long (*arg_to_user)(void __user *uarg, void *karg, unsigned int cmd);
403 };
404 
405 static const struct media_ioctl_info ioctl_info[] = {
406 	MEDIA_IOC(DEVICE_INFO, media_device_get_info, MEDIA_IOC_FL_GRAPH_MUTEX),
407 	MEDIA_IOC(ENUM_ENTITIES, media_device_enum_entities, MEDIA_IOC_FL_GRAPH_MUTEX),
408 	MEDIA_IOC(ENUM_LINKS, media_device_enum_links, MEDIA_IOC_FL_GRAPH_MUTEX),
409 	MEDIA_IOC(SETUP_LINK, media_device_setup_link, MEDIA_IOC_FL_GRAPH_MUTEX),
410 	MEDIA_IOC(G_TOPOLOGY, media_device_get_topology, MEDIA_IOC_FL_GRAPH_MUTEX),
411 };
412 
media_device_ioctl(struct file * filp,unsigned int cmd,unsigned long __arg)413 static long media_device_ioctl(struct file *filp, unsigned int cmd,
414 			       unsigned long __arg)
415 {
416 	struct media_devnode *devnode = media_devnode_data(filp);
417 	struct media_device *dev = devnode->media_dev;
418 	const struct media_ioctl_info *info;
419 	void __user *arg = (void __user *)__arg;
420 	char __karg[256], *karg = __karg;
421 	long ret;
422 
423 	if (_IOC_NR(cmd) >= ARRAY_SIZE(ioctl_info)
424 	    || ioctl_info[_IOC_NR(cmd)].cmd != cmd)
425 		return -ENOIOCTLCMD;
426 
427 	info = &ioctl_info[_IOC_NR(cmd)];
428 
429 	if (_IOC_SIZE(info->cmd) > sizeof(__karg)) {
430 		karg = kmalloc(_IOC_SIZE(info->cmd), GFP_KERNEL);
431 		if (!karg)
432 			return -ENOMEM;
433 	}
434 
435 	if (info->arg_from_user) {
436 		ret = info->arg_from_user(karg, arg, cmd);
437 		if (ret)
438 			goto out_free;
439 	}
440 
441 	if (info->flags & MEDIA_IOC_FL_GRAPH_MUTEX)
442 		mutex_lock(&dev->graph_mutex);
443 
444 	ret = info->fn(dev, karg);
445 
446 	if (info->flags & MEDIA_IOC_FL_GRAPH_MUTEX)
447 		mutex_unlock(&dev->graph_mutex);
448 
449 	if (!ret && info->arg_to_user)
450 		ret = info->arg_to_user(arg, karg, cmd);
451 
452 out_free:
453 	if (karg != __karg)
454 		kfree(karg);
455 
456 	return ret;
457 }
458 
459 #ifdef CONFIG_COMPAT
460 
461 struct media_links_enum32 {
462 	__u32 entity;
463 	compat_uptr_t pads; /* struct media_pad_desc * */
464 	compat_uptr_t links; /* struct media_link_desc * */
465 	__u32 reserved[4];
466 };
467 
media_device_enum_links32(struct media_device * mdev,struct media_links_enum32 __user * ulinks)468 static long media_device_enum_links32(struct media_device *mdev,
469 				      struct media_links_enum32 __user *ulinks)
470 {
471 	struct media_links_enum links;
472 	compat_uptr_t pads_ptr, links_ptr;
473 	int ret;
474 
475 	memset(&links, 0, sizeof(links));
476 
477 	if (get_user(links.entity, &ulinks->entity)
478 	    || get_user(pads_ptr, &ulinks->pads)
479 	    || get_user(links_ptr, &ulinks->links))
480 		return -EFAULT;
481 
482 	links.pads = compat_ptr(pads_ptr);
483 	links.links = compat_ptr(links_ptr);
484 
485 	ret = media_device_enum_links(mdev, &links);
486 	if (ret)
487 		return ret;
488 
489 	if (copy_to_user(ulinks->reserved, links.reserved,
490 			 sizeof(ulinks->reserved)))
491 		return -EFAULT;
492 	return 0;
493 }
494 
495 #define MEDIA_IOC_ENUM_LINKS32		_IOWR('|', 0x02, struct media_links_enum32)
496 
media_device_compat_ioctl(struct file * filp,unsigned int cmd,unsigned long arg)497 static long media_device_compat_ioctl(struct file *filp, unsigned int cmd,
498 				      unsigned long arg)
499 {
500 	struct media_devnode *devnode = media_devnode_data(filp);
501 	struct media_device *dev = devnode->media_dev;
502 	long ret;
503 
504 	switch (cmd) {
505 	case MEDIA_IOC_ENUM_LINKS32:
506 		mutex_lock(&dev->graph_mutex);
507 		ret = media_device_enum_links32(dev,
508 				(struct media_links_enum32 __user *)arg);
509 		mutex_unlock(&dev->graph_mutex);
510 		break;
511 
512 	default:
513 		return media_device_ioctl(filp, cmd, arg);
514 	}
515 
516 	return ret;
517 }
518 #endif /* CONFIG_COMPAT */
519 
520 static const struct media_file_operations media_device_fops = {
521 	.owner = THIS_MODULE,
522 	.open = media_device_open,
523 	.ioctl = media_device_ioctl,
524 #ifdef CONFIG_COMPAT
525 	.compat_ioctl = media_device_compat_ioctl,
526 #endif /* CONFIG_COMPAT */
527 	.release = media_device_close,
528 };
529 
530 /* -----------------------------------------------------------------------------
531  * sysfs
532  */
533 
show_model(struct device * cd,struct device_attribute * attr,char * buf)534 static ssize_t show_model(struct device *cd,
535 			  struct device_attribute *attr, char *buf)
536 {
537 	struct media_devnode *devnode = to_media_devnode(cd);
538 	struct media_device *mdev = devnode->media_dev;
539 
540 	return sprintf(buf, "%.*s\n", (int)sizeof(mdev->model), mdev->model);
541 }
542 
543 static DEVICE_ATTR(model, S_IRUGO, show_model, NULL);
544 
545 /* -----------------------------------------------------------------------------
546  * Registration/unregistration
547  */
548 
media_device_release(struct media_devnode * devnode)549 static void media_device_release(struct media_devnode *devnode)
550 {
551 	dev_dbg(devnode->parent, "Media device released\n");
552 }
553 
554 /**
555  * media_device_register_entity - Register an entity with a media device
556  * @mdev:	The media device
557  * @entity:	The entity
558  */
media_device_register_entity(struct media_device * mdev,struct media_entity * entity)559 int __must_check media_device_register_entity(struct media_device *mdev,
560 					      struct media_entity *entity)
561 {
562 	struct media_entity_notify *notify, *next;
563 	unsigned int i;
564 	int ret;
565 
566 	if (entity->function == MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN ||
567 	    entity->function == MEDIA_ENT_F_UNKNOWN)
568 		dev_warn(mdev->dev,
569 			 "Entity type for entity %s was not initialized!\n",
570 			 entity->name);
571 
572 	/* Warn if we apparently re-register an entity */
573 	WARN_ON(entity->graph_obj.mdev != NULL);
574 	entity->graph_obj.mdev = mdev;
575 	INIT_LIST_HEAD(&entity->links);
576 	entity->num_links = 0;
577 	entity->num_backlinks = 0;
578 
579 	if (!ida_pre_get(&mdev->entity_internal_idx, GFP_KERNEL))
580 		return -ENOMEM;
581 
582 	mutex_lock(&mdev->graph_mutex);
583 
584 	ret = ida_get_new_above(&mdev->entity_internal_idx, 1,
585 				&entity->internal_idx);
586 	if (ret < 0) {
587 		mutex_unlock(&mdev->graph_mutex);
588 		return ret;
589 	}
590 
591 	mdev->entity_internal_idx_max =
592 		max(mdev->entity_internal_idx_max, entity->internal_idx);
593 
594 	/* Initialize media_gobj embedded at the entity */
595 	media_gobj_create(mdev, MEDIA_GRAPH_ENTITY, &entity->graph_obj);
596 
597 	/* Initialize objects at the pads */
598 	for (i = 0; i < entity->num_pads; i++)
599 		media_gobj_create(mdev, MEDIA_GRAPH_PAD,
600 			       &entity->pads[i].graph_obj);
601 
602 	/* invoke entity_notify callbacks */
603 	list_for_each_entry_safe(notify, next, &mdev->entity_notify, list)
604 		notify->notify(entity, notify->notify_data);
605 
606 	if (mdev->entity_internal_idx_max
607 	    >= mdev->pm_count_walk.ent_enum.idx_max) {
608 		struct media_graph new = { .top = 0 };
609 
610 		/*
611 		 * Initialise the new graph walk before cleaning up
612 		 * the old one in order not to spoil the graph walk
613 		 * object of the media device if graph walk init fails.
614 		 */
615 		ret = media_graph_walk_init(&new, mdev);
616 		if (ret) {
617 			mutex_unlock(&mdev->graph_mutex);
618 			return ret;
619 		}
620 		media_graph_walk_cleanup(&mdev->pm_count_walk);
621 		mdev->pm_count_walk = new;
622 	}
623 	mutex_unlock(&mdev->graph_mutex);
624 
625 	return 0;
626 }
627 EXPORT_SYMBOL_GPL(media_device_register_entity);
628 
__media_device_unregister_entity(struct media_entity * entity)629 static void __media_device_unregister_entity(struct media_entity *entity)
630 {
631 	struct media_device *mdev = entity->graph_obj.mdev;
632 	struct media_link *link, *tmp;
633 	struct media_interface *intf;
634 	unsigned int i;
635 
636 	ida_simple_remove(&mdev->entity_internal_idx, entity->internal_idx);
637 
638 	/* Remove all interface links pointing to this entity */
639 	list_for_each_entry(intf, &mdev->interfaces, graph_obj.list) {
640 		list_for_each_entry_safe(link, tmp, &intf->links, list) {
641 			if (link->entity == entity)
642 				__media_remove_intf_link(link);
643 		}
644 	}
645 
646 	/* Remove all data links that belong to this entity */
647 	__media_entity_remove_links(entity);
648 
649 	/* Remove all pads that belong to this entity */
650 	for (i = 0; i < entity->num_pads; i++)
651 		media_gobj_destroy(&entity->pads[i].graph_obj);
652 
653 	/* Remove the entity */
654 	media_gobj_destroy(&entity->graph_obj);
655 
656 	/* invoke entity_notify callbacks to handle entity removal?? */
657 
658 	entity->graph_obj.mdev = NULL;
659 }
660 
media_device_unregister_entity(struct media_entity * entity)661 void media_device_unregister_entity(struct media_entity *entity)
662 {
663 	struct media_device *mdev = entity->graph_obj.mdev;
664 
665 	if (mdev == NULL)
666 		return;
667 
668 	mutex_lock(&mdev->graph_mutex);
669 	__media_device_unregister_entity(entity);
670 	mutex_unlock(&mdev->graph_mutex);
671 }
672 EXPORT_SYMBOL_GPL(media_device_unregister_entity);
673 
674 /**
675  * media_device_init() - initialize a media device
676  * @mdev:	The media device
677  *
678  * The caller is responsible for initializing the media device before
679  * registration. The following fields must be set:
680  *
681  * - dev must point to the parent device
682  * - model must be filled with the device model name
683  */
media_device_init(struct media_device * mdev)684 void media_device_init(struct media_device *mdev)
685 {
686 	INIT_LIST_HEAD(&mdev->entities);
687 	INIT_LIST_HEAD(&mdev->interfaces);
688 	INIT_LIST_HEAD(&mdev->pads);
689 	INIT_LIST_HEAD(&mdev->links);
690 	INIT_LIST_HEAD(&mdev->entity_notify);
691 	mutex_init(&mdev->graph_mutex);
692 	ida_init(&mdev->entity_internal_idx);
693 
694 	dev_dbg(mdev->dev, "Media device initialized\n");
695 }
696 EXPORT_SYMBOL_GPL(media_device_init);
697 
media_device_cleanup(struct media_device * mdev)698 void media_device_cleanup(struct media_device *mdev)
699 {
700 	ida_destroy(&mdev->entity_internal_idx);
701 	mdev->entity_internal_idx_max = 0;
702 	media_graph_walk_cleanup(&mdev->pm_count_walk);
703 	mutex_destroy(&mdev->graph_mutex);
704 }
705 EXPORT_SYMBOL_GPL(media_device_cleanup);
706 
__media_device_register(struct media_device * mdev,struct module * owner)707 int __must_check __media_device_register(struct media_device *mdev,
708 					 struct module *owner)
709 {
710 	struct media_devnode *devnode;
711 	int ret;
712 
713 	devnode = kzalloc(sizeof(*devnode), GFP_KERNEL);
714 	if (!devnode)
715 		return -ENOMEM;
716 
717 	/* Register the device node. */
718 	mdev->devnode = devnode;
719 	devnode->fops = &media_device_fops;
720 	devnode->parent = mdev->dev;
721 	devnode->release = media_device_release;
722 
723 	/* Set version 0 to indicate user-space that the graph is static */
724 	mdev->topology_version = 0;
725 
726 	ret = media_devnode_register(mdev, devnode, owner);
727 	if (ret < 0) {
728 		/* devnode free is handled in media_devnode_*() */
729 		mdev->devnode = NULL;
730 		return ret;
731 	}
732 
733 	ret = device_create_file(&devnode->dev, &dev_attr_model);
734 	if (ret < 0) {
735 		/* devnode free is handled in media_devnode_*() */
736 		mdev->devnode = NULL;
737 		media_devnode_unregister_prepare(devnode);
738 		media_devnode_unregister(devnode);
739 		return ret;
740 	}
741 
742 	dev_dbg(mdev->dev, "Media device registered\n");
743 
744 	return 0;
745 }
746 EXPORT_SYMBOL_GPL(__media_device_register);
747 
media_device_register_entity_notify(struct media_device * mdev,struct media_entity_notify * nptr)748 int __must_check media_device_register_entity_notify(struct media_device *mdev,
749 					struct media_entity_notify *nptr)
750 {
751 	mutex_lock(&mdev->graph_mutex);
752 	list_add_tail(&nptr->list, &mdev->entity_notify);
753 	mutex_unlock(&mdev->graph_mutex);
754 	return 0;
755 }
756 EXPORT_SYMBOL_GPL(media_device_register_entity_notify);
757 
758 /*
759  * Note: Should be called with mdev->lock held.
760  */
__media_device_unregister_entity_notify(struct media_device * mdev,struct media_entity_notify * nptr)761 static void __media_device_unregister_entity_notify(struct media_device *mdev,
762 					struct media_entity_notify *nptr)
763 {
764 	list_del(&nptr->list);
765 }
766 
media_device_unregister_entity_notify(struct media_device * mdev,struct media_entity_notify * nptr)767 void media_device_unregister_entity_notify(struct media_device *mdev,
768 					struct media_entity_notify *nptr)
769 {
770 	mutex_lock(&mdev->graph_mutex);
771 	__media_device_unregister_entity_notify(mdev, nptr);
772 	mutex_unlock(&mdev->graph_mutex);
773 }
774 EXPORT_SYMBOL_GPL(media_device_unregister_entity_notify);
775 
media_device_unregister(struct media_device * mdev)776 void media_device_unregister(struct media_device *mdev)
777 {
778 	struct media_entity *entity;
779 	struct media_entity *next;
780 	struct media_interface *intf, *tmp_intf;
781 	struct media_entity_notify *notify, *nextp;
782 
783 	if (mdev == NULL)
784 		return;
785 
786 	mutex_lock(&mdev->graph_mutex);
787 
788 	/* Check if mdev was ever registered at all */
789 	if (!media_devnode_is_registered(mdev->devnode)) {
790 		mutex_unlock(&mdev->graph_mutex);
791 		return;
792 	}
793 
794 	/* Clear the devnode register bit to avoid races with media dev open */
795 	media_devnode_unregister_prepare(mdev->devnode);
796 
797 	/* Remove all entities from the media device */
798 	list_for_each_entry_safe(entity, next, &mdev->entities, graph_obj.list)
799 		__media_device_unregister_entity(entity);
800 
801 	/* Remove all entity_notify callbacks from the media device */
802 	list_for_each_entry_safe(notify, nextp, &mdev->entity_notify, list)
803 		__media_device_unregister_entity_notify(mdev, notify);
804 
805 	/* Remove all interfaces from the media device */
806 	list_for_each_entry_safe(intf, tmp_intf, &mdev->interfaces,
807 				 graph_obj.list) {
808 		/*
809 		 * Unlink the interface, but don't free it here; the
810 		 * module which created it is responsible for freeing
811 		 * it
812 		 */
813 		__media_remove_intf_links(intf);
814 		media_gobj_destroy(&intf->graph_obj);
815 	}
816 
817 	mutex_unlock(&mdev->graph_mutex);
818 
819 	dev_dbg(mdev->dev, "Media device unregistered\n");
820 
821 	device_remove_file(&mdev->devnode->dev, &dev_attr_model);
822 	media_devnode_unregister(mdev->devnode);
823 	/* devnode free is handled in media_devnode_*() */
824 	mdev->devnode = NULL;
825 }
826 EXPORT_SYMBOL_GPL(media_device_unregister);
827 
828 #if IS_ENABLED(CONFIG_PCI)
media_device_pci_init(struct media_device * mdev,struct pci_dev * pci_dev,const char * name)829 void media_device_pci_init(struct media_device *mdev,
830 			   struct pci_dev *pci_dev,
831 			   const char *name)
832 {
833 	mdev->dev = &pci_dev->dev;
834 
835 	if (name)
836 		strlcpy(mdev->model, name, sizeof(mdev->model));
837 	else
838 		strlcpy(mdev->model, pci_name(pci_dev), sizeof(mdev->model));
839 
840 	sprintf(mdev->bus_info, "PCI:%s", pci_name(pci_dev));
841 
842 	mdev->hw_revision = (pci_dev->subsystem_vendor << 16)
843 			    | pci_dev->subsystem_device;
844 
845 	media_device_init(mdev);
846 }
847 EXPORT_SYMBOL_GPL(media_device_pci_init);
848 #endif
849 
850 #if IS_ENABLED(CONFIG_USB)
__media_device_usb_init(struct media_device * mdev,struct usb_device * udev,const char * board_name,const char * driver_name)851 void __media_device_usb_init(struct media_device *mdev,
852 			     struct usb_device *udev,
853 			     const char *board_name,
854 			     const char *driver_name)
855 {
856 	mdev->dev = &udev->dev;
857 
858 	if (driver_name)
859 		strlcpy(mdev->driver_name, driver_name,
860 			sizeof(mdev->driver_name));
861 
862 	if (board_name)
863 		strlcpy(mdev->model, board_name, sizeof(mdev->model));
864 	else if (udev->product)
865 		strlcpy(mdev->model, udev->product, sizeof(mdev->model));
866 	else
867 		strlcpy(mdev->model, "unknown model", sizeof(mdev->model));
868 	if (udev->serial)
869 		strlcpy(mdev->serial, udev->serial, sizeof(mdev->serial));
870 	usb_make_path(udev, mdev->bus_info, sizeof(mdev->bus_info));
871 	mdev->hw_revision = le16_to_cpu(udev->descriptor.bcdDevice);
872 
873 	media_device_init(mdev);
874 }
875 EXPORT_SYMBOL_GPL(__media_device_usb_init);
876 #endif
877 
878 
879 #endif /* CONFIG_MEDIA_CONTROLLER */
880