4 * Copyright (C) 2010 Nokia Corporation
6 * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
7 * Sakari Ailus <sakari.ailus@iki.fi>
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.
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.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/compat.h>
24 #include <linux/export.h>
25 #include <linux/idr.h>
26 #include <linux/ioctl.h>
27 #include <linux/media.h>
28 #include <linux/slab.h>
29 #include <linux/types.h>
31 #include <media/media-device.h>
32 #include <media/media-devnode.h>
33 #include <media/media-entity.h>
35 #ifdef CONFIG_MEDIA_CONTROLLER
37 /* -----------------------------------------------------------------------------
41 static int media_device_open(struct file *filp)
46 static int media_device_close(struct file *filp)
51 static int media_device_get_info(struct media_device *dev,
52 struct media_device_info __user *__info)
54 struct media_device_info info;
56 memset(&info, 0, sizeof(info));
58 strlcpy(info.driver, dev->dev->driver->name, sizeof(info.driver));
59 strlcpy(info.model, dev->model, sizeof(info.model));
60 strlcpy(info.serial, dev->serial, sizeof(info.serial));
61 strlcpy(info.bus_info, dev->bus_info, sizeof(info.bus_info));
63 info.media_version = MEDIA_API_VERSION;
64 info.hw_revision = dev->hw_revision;
65 info.driver_version = dev->driver_version;
67 if (copy_to_user(__info, &info, sizeof(*__info)))
72 static struct media_entity *find_entity(struct media_device *mdev, u32 id)
74 struct media_entity *entity;
75 int next = id & MEDIA_ENT_ID_FLAG_NEXT;
77 id &= ~MEDIA_ENT_ID_FLAG_NEXT;
79 spin_lock(&mdev->lock);
81 media_device_for_each_entity(entity, mdev) {
82 if (((media_entity_id(entity) == id) && !next) ||
83 ((media_entity_id(entity) > id) && next)) {
84 spin_unlock(&mdev->lock);
89 spin_unlock(&mdev->lock);
94 static long media_device_enum_entities(struct media_device *mdev,
95 struct media_entity_desc __user *uent)
97 struct media_entity *ent;
98 struct media_entity_desc u_ent;
100 memset(&u_ent, 0, sizeof(u_ent));
101 if (copy_from_user(&u_ent.id, &uent->id, sizeof(u_ent.id)))
104 ent = find_entity(mdev, u_ent.id);
109 u_ent.id = media_entity_id(ent);
111 strlcpy(u_ent.name, ent->name, sizeof(u_ent.name));
112 u_ent.type = ent->function;
113 u_ent.revision = 0; /* Unused */
114 u_ent.flags = ent->flags;
115 u_ent.group_id = 0; /* Unused */
116 u_ent.pads = ent->num_pads;
117 u_ent.links = ent->num_links - ent->num_backlinks;
118 memcpy(&u_ent.raw, &ent->info, sizeof(ent->info));
119 if (copy_to_user(uent, &u_ent, sizeof(u_ent)))
124 static void media_device_kpad_to_upad(const struct media_pad *kpad,
125 struct media_pad_desc *upad)
127 upad->entity = media_entity_id(kpad->entity);
128 upad->index = kpad->index;
129 upad->flags = kpad->flags;
132 static long __media_device_enum_links(struct media_device *mdev,
133 struct media_links_enum *links)
135 struct media_entity *entity;
137 entity = find_entity(mdev, links->entity);
144 for (p = 0; p < entity->num_pads; p++) {
145 struct media_pad_desc pad;
147 memset(&pad, 0, sizeof(pad));
148 media_device_kpad_to_upad(&entity->pads[p], &pad);
149 if (copy_to_user(&links->pads[p], &pad, sizeof(pad)))
155 struct media_link *link;
156 struct media_link_desc __user *ulink_desc = links->links;
158 list_for_each_entry(link, &entity->links, list) {
159 struct media_link_desc klink_desc;
161 /* Ignore backlinks. */
162 if (link->source->entity != entity)
164 memset(&klink_desc, 0, sizeof(klink_desc));
165 media_device_kpad_to_upad(link->source,
167 media_device_kpad_to_upad(link->sink,
169 klink_desc.flags = link->flags;
170 if (copy_to_user(ulink_desc, &klink_desc,
171 sizeof(*ulink_desc)))
180 static long media_device_enum_links(struct media_device *mdev,
181 struct media_links_enum __user *ulinks)
183 struct media_links_enum links;
186 if (copy_from_user(&links, ulinks, sizeof(links)))
189 rval = __media_device_enum_links(mdev, &links);
193 if (copy_to_user(ulinks, &links, sizeof(*ulinks)))
199 static long media_device_setup_link(struct media_device *mdev,
200 struct media_link_desc __user *_ulink)
202 struct media_link *link = NULL;
203 struct media_link_desc ulink;
204 struct media_entity *source;
205 struct media_entity *sink;
208 if (copy_from_user(&ulink, _ulink, sizeof(ulink)))
211 /* Find the source and sink entities and link.
213 source = find_entity(mdev, ulink.source.entity);
214 sink = find_entity(mdev, ulink.sink.entity);
216 if (source == NULL || sink == NULL)
219 if (ulink.source.index >= source->num_pads ||
220 ulink.sink.index >= sink->num_pads)
223 link = media_entity_find_link(&source->pads[ulink.source.index],
224 &sink->pads[ulink.sink.index]);
228 /* Setup the link on both entities. */
229 ret = __media_entity_setup_link(link, ulink.flags);
231 if (copy_to_user(_ulink, &ulink, sizeof(ulink)))
237 static long __media_device_get_topology(struct media_device *mdev,
238 struct media_v2_topology *topo)
240 struct media_entity *entity;
241 struct media_interface *intf;
242 struct media_pad *pad;
243 struct media_link *link;
244 struct media_v2_entity kentity, *uentity;
245 struct media_v2_interface kintf, *uintf;
246 struct media_v2_pad kpad, *upad;
247 struct media_v2_link klink, *ulink;
251 topo->topology_version = mdev->topology_version;
253 /* Get entities and number of entities */
255 uentity = media_get_uptr(topo->ptr_entities);
256 media_device_for_each_entity(entity, mdev) {
261 if (i > topo->num_entities) {
266 /* Copy fields to userspace struct if not error */
267 memset(&kentity, 0, sizeof(kentity));
268 kentity.id = entity->graph_obj.id;
269 kentity.function = entity->function;
270 strncpy(kentity.name, entity->name,
271 sizeof(kentity.name));
273 if (copy_to_user(uentity, &kentity, sizeof(kentity)))
277 topo->num_entities = i;
279 /* Get interfaces and number of interfaces */
281 uintf = media_get_uptr(topo->ptr_interfaces);
282 media_device_for_each_intf(intf, mdev) {
287 if (i > topo->num_interfaces) {
292 memset(&kintf, 0, sizeof(kintf));
294 /* Copy intf fields to userspace struct */
295 kintf.id = intf->graph_obj.id;
296 kintf.intf_type = intf->type;
297 kintf.flags = intf->flags;
299 if (media_type(&intf->graph_obj) == MEDIA_GRAPH_INTF_DEVNODE) {
300 struct media_intf_devnode *devnode;
302 devnode = intf_to_devnode(intf);
304 kintf.devnode.major = devnode->major;
305 kintf.devnode.minor = devnode->minor;
308 if (copy_to_user(uintf, &kintf, sizeof(kintf)))
312 topo->num_interfaces = i;
314 /* Get pads and number of pads */
316 upad = media_get_uptr(topo->ptr_pads);
317 media_device_for_each_pad(pad, mdev) {
322 if (i > topo->num_pads) {
327 memset(&kpad, 0, sizeof(kpad));
329 /* Copy pad fields to userspace struct */
330 kpad.id = pad->graph_obj.id;
331 kpad.entity_id = pad->entity->graph_obj.id;
332 kpad.flags = pad->flags;
334 if (copy_to_user(upad, &kpad, sizeof(kpad)))
340 /* Get links and number of links */
342 ulink = media_get_uptr(topo->ptr_links);
343 media_device_for_each_link(link, mdev) {
344 if (link->is_backlink)
352 if (i > topo->num_links) {
357 memset(&klink, 0, sizeof(klink));
359 /* Copy link fields to userspace struct */
360 klink.id = link->graph_obj.id;
361 klink.source_id = link->gobj0->id;
362 klink.sink_id = link->gobj1->id;
363 klink.flags = link->flags;
365 if (copy_to_user(ulink, &klink, sizeof(klink)))
374 static long media_device_get_topology(struct media_device *mdev,
375 struct media_v2_topology __user *utopo)
377 struct media_v2_topology ktopo;
380 if (copy_from_user(&ktopo, utopo, sizeof(ktopo)))
383 ret = __media_device_get_topology(mdev, &ktopo);
387 if (copy_to_user(utopo, &ktopo, sizeof(*utopo)))
393 static long media_device_ioctl(struct file *filp, unsigned int cmd,
396 struct media_devnode *devnode = media_devnode_data(filp);
397 struct media_device *dev = to_media_device(devnode);
401 case MEDIA_IOC_DEVICE_INFO:
402 ret = media_device_get_info(dev,
403 (struct media_device_info __user *)arg);
406 case MEDIA_IOC_ENUM_ENTITIES:
407 ret = media_device_enum_entities(dev,
408 (struct media_entity_desc __user *)arg);
411 case MEDIA_IOC_ENUM_LINKS:
412 mutex_lock(&dev->graph_mutex);
413 ret = media_device_enum_links(dev,
414 (struct media_links_enum __user *)arg);
415 mutex_unlock(&dev->graph_mutex);
418 case MEDIA_IOC_SETUP_LINK:
419 mutex_lock(&dev->graph_mutex);
420 ret = media_device_setup_link(dev,
421 (struct media_link_desc __user *)arg);
422 mutex_unlock(&dev->graph_mutex);
425 case MEDIA_IOC_G_TOPOLOGY:
426 mutex_lock(&dev->graph_mutex);
427 ret = media_device_get_topology(dev,
428 (struct media_v2_topology __user *)arg);
429 mutex_unlock(&dev->graph_mutex);
441 struct media_links_enum32 {
443 compat_uptr_t pads; /* struct media_pad_desc * */
444 compat_uptr_t links; /* struct media_link_desc * */
448 static long media_device_enum_links32(struct media_device *mdev,
449 struct media_links_enum32 __user *ulinks)
451 struct media_links_enum links;
452 compat_uptr_t pads_ptr, links_ptr;
454 memset(&links, 0, sizeof(links));
456 if (get_user(links.entity, &ulinks->entity)
457 || get_user(pads_ptr, &ulinks->pads)
458 || get_user(links_ptr, &ulinks->links))
461 links.pads = compat_ptr(pads_ptr);
462 links.links = compat_ptr(links_ptr);
464 return __media_device_enum_links(mdev, &links);
467 #define MEDIA_IOC_ENUM_LINKS32 _IOWR('|', 0x02, struct media_links_enum32)
469 static long media_device_compat_ioctl(struct file *filp, unsigned int cmd,
472 struct media_devnode *devnode = media_devnode_data(filp);
473 struct media_device *dev = to_media_device(devnode);
477 case MEDIA_IOC_DEVICE_INFO:
478 case MEDIA_IOC_ENUM_ENTITIES:
479 case MEDIA_IOC_SETUP_LINK:
480 case MEDIA_IOC_G_TOPOLOGY:
481 return media_device_ioctl(filp, cmd, arg);
483 case MEDIA_IOC_ENUM_LINKS32:
484 mutex_lock(&dev->graph_mutex);
485 ret = media_device_enum_links32(dev,
486 (struct media_links_enum32 __user *)arg);
487 mutex_unlock(&dev->graph_mutex);
496 #endif /* CONFIG_COMPAT */
498 static const struct media_file_operations media_device_fops = {
499 .owner = THIS_MODULE,
500 .open = media_device_open,
501 .ioctl = media_device_ioctl,
503 .compat_ioctl = media_device_compat_ioctl,
504 #endif /* CONFIG_COMPAT */
505 .release = media_device_close,
508 /* -----------------------------------------------------------------------------
512 static ssize_t show_model(struct device *cd,
513 struct device_attribute *attr, char *buf)
515 struct media_device *mdev = to_media_device(to_media_devnode(cd));
517 return sprintf(buf, "%.*s\n", (int)sizeof(mdev->model), mdev->model);
520 static DEVICE_ATTR(model, S_IRUGO, show_model, NULL);
522 /* -----------------------------------------------------------------------------
523 * Registration/unregistration
526 static void media_device_release(struct media_devnode *mdev)
528 dev_dbg(mdev->parent, "Media device released\n");
532 * media_device_register_entity - Register an entity with a media device
533 * @mdev: The media device
534 * @entity: The entity
536 int __must_check media_device_register_entity(struct media_device *mdev,
537 struct media_entity *entity)
541 if (entity->function == MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN ||
542 entity->function == MEDIA_ENT_F_UNKNOWN)
544 "Entity type for entity %s was not initialized!\n",
547 /* Warn if we apparently re-register an entity */
548 WARN_ON(entity->graph_obj.mdev != NULL);
549 entity->graph_obj.mdev = mdev;
550 INIT_LIST_HEAD(&entity->links);
551 entity->num_links = 0;
552 entity->num_backlinks = 0;
554 spin_lock(&mdev->lock);
556 entity->internal_idx = ida_simple_get(&mdev->entity_internal_idx, 1, 0,
558 if (entity->internal_idx < 0) {
559 spin_unlock(&mdev->lock);
560 return entity->internal_idx;
563 mdev->entity_internal_idx_max =
564 max(mdev->entity_internal_idx_max, entity->internal_idx);
566 /* Initialize media_gobj embedded at the entity */
567 media_gobj_create(mdev, MEDIA_GRAPH_ENTITY, &entity->graph_obj);
569 /* Initialize objects at the pads */
570 for (i = 0; i < entity->num_pads; i++)
571 media_gobj_create(mdev, MEDIA_GRAPH_PAD,
572 &entity->pads[i].graph_obj);
574 spin_unlock(&mdev->lock);
578 EXPORT_SYMBOL_GPL(media_device_register_entity);
580 static void __media_device_unregister_entity(struct media_entity *entity)
582 struct media_device *mdev = entity->graph_obj.mdev;
583 struct media_link *link, *tmp;
584 struct media_interface *intf;
587 ida_simple_remove(&mdev->entity_internal_idx, entity->internal_idx);
589 /* Remove all interface links pointing to this entity */
590 list_for_each_entry(intf, &mdev->interfaces, graph_obj.list) {
591 list_for_each_entry_safe(link, tmp, &intf->links, list) {
592 if (link->entity == entity)
593 __media_remove_intf_link(link);
597 /* Remove all data links that belong to this entity */
598 __media_entity_remove_links(entity);
600 /* Remove all pads that belong to this entity */
601 for (i = 0; i < entity->num_pads; i++)
602 media_gobj_destroy(&entity->pads[i].graph_obj);
604 /* Remove the entity */
605 media_gobj_destroy(&entity->graph_obj);
607 entity->graph_obj.mdev = NULL;
610 void media_device_unregister_entity(struct media_entity *entity)
612 struct media_device *mdev = entity->graph_obj.mdev;
617 spin_lock(&mdev->lock);
618 __media_device_unregister_entity(entity);
619 spin_unlock(&mdev->lock);
621 EXPORT_SYMBOL_GPL(media_device_unregister_entity);
624 * media_device_init() - initialize a media device
625 * @mdev: The media device
627 * The caller is responsible for initializing the media device before
628 * registration. The following fields must be set:
630 * - dev must point to the parent device
631 * - model must be filled with the device model name
633 void media_device_init(struct media_device *mdev)
635 INIT_LIST_HEAD(&mdev->entities);
636 INIT_LIST_HEAD(&mdev->interfaces);
637 INIT_LIST_HEAD(&mdev->pads);
638 INIT_LIST_HEAD(&mdev->links);
639 spin_lock_init(&mdev->lock);
640 mutex_init(&mdev->graph_mutex);
641 ida_init(&mdev->entity_internal_idx);
643 dev_dbg(mdev->dev, "Media device initialized\n");
645 EXPORT_SYMBOL_GPL(media_device_init);
647 void media_device_cleanup(struct media_device *mdev)
649 ida_destroy(&mdev->entity_internal_idx);
650 mdev->entity_internal_idx_max = 0;
651 mutex_destroy(&mdev->graph_mutex);
653 EXPORT_SYMBOL_GPL(media_device_cleanup);
655 int __must_check __media_device_register(struct media_device *mdev,
656 struct module *owner)
660 /* Register the device node. */
661 mdev->devnode.fops = &media_device_fops;
662 mdev->devnode.parent = mdev->dev;
663 mdev->devnode.release = media_device_release;
665 /* Set version 0 to indicate user-space that the graph is static */
666 mdev->topology_version = 0;
668 ret = media_devnode_register(&mdev->devnode, owner);
672 ret = device_create_file(&mdev->devnode.dev, &dev_attr_model);
674 media_devnode_unregister(&mdev->devnode);
678 dev_dbg(mdev->dev, "Media device registered\n");
682 EXPORT_SYMBOL_GPL(__media_device_register);
684 void media_device_unregister(struct media_device *mdev)
686 struct media_entity *entity;
687 struct media_entity *next;
688 struct media_interface *intf, *tmp_intf;
693 spin_lock(&mdev->lock);
695 /* Check if mdev was ever registered at all */
696 if (!media_devnode_is_registered(&mdev->devnode)) {
697 spin_unlock(&mdev->lock);
701 /* Remove all entities from the media device */
702 list_for_each_entry_safe(entity, next, &mdev->entities, graph_obj.list)
703 __media_device_unregister_entity(entity);
705 /* Remove all interfaces from the media device */
706 list_for_each_entry_safe(intf, tmp_intf, &mdev->interfaces,
708 __media_remove_intf_links(intf);
709 media_gobj_destroy(&intf->graph_obj);
713 spin_unlock(&mdev->lock);
715 device_remove_file(&mdev->devnode.dev, &dev_attr_model);
716 media_devnode_unregister(&mdev->devnode);
718 dev_dbg(mdev->dev, "Media device unregistered\n");
720 EXPORT_SYMBOL_GPL(media_device_unregister);
722 static void media_device_release_devres(struct device *dev, void *res)
726 struct media_device *media_device_get_devres(struct device *dev)
728 struct media_device *mdev;
730 mdev = devres_find(dev, media_device_release_devres, NULL, NULL);
734 mdev = devres_alloc(media_device_release_devres,
735 sizeof(struct media_device), GFP_KERNEL);
738 return devres_get(dev, mdev, NULL, NULL);
740 EXPORT_SYMBOL_GPL(media_device_get_devres);
742 struct media_device *media_device_find_devres(struct device *dev)
744 return devres_find(dev, media_device_release_devres, NULL, NULL);
746 EXPORT_SYMBOL_GPL(media_device_find_devres);
748 #endif /* CONFIG_MEDIA_CONTROLLER */