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/ioctl.h>
26 #include <linux/media.h>
27 #include <linux/slab.h>
28 #include <linux/types.h>
30 #include <media/media-device.h>
31 #include <media/media-devnode.h>
32 #include <media/media-entity.h>
34 #ifdef CONFIG_MEDIA_CONTROLLER
36 /* -----------------------------------------------------------------------------
40 static int media_device_open(struct file *filp)
45 static int media_device_close(struct file *filp)
50 static int media_device_get_info(struct media_device *dev,
51 struct media_device_info __user *__info)
53 struct media_device_info info;
55 memset(&info, 0, sizeof(info));
57 strlcpy(info.driver, dev->dev->driver->name, sizeof(info.driver));
58 strlcpy(info.model, dev->model, sizeof(info.model));
59 strlcpy(info.serial, dev->serial, sizeof(info.serial));
60 strlcpy(info.bus_info, dev->bus_info, sizeof(info.bus_info));
62 info.media_version = MEDIA_API_VERSION;
63 info.hw_revision = dev->hw_revision;
64 info.driver_version = dev->driver_version;
66 if (copy_to_user(__info, &info, sizeof(*__info)))
71 static struct media_entity *find_entity(struct media_device *mdev, u32 id)
73 struct media_entity *entity;
74 int next = id & MEDIA_ENT_ID_FLAG_NEXT;
76 id &= ~MEDIA_ENT_ID_FLAG_NEXT;
78 spin_lock(&mdev->lock);
80 media_device_for_each_entity(entity, mdev) {
81 if (((media_entity_id(entity) == id) && !next) ||
82 ((media_entity_id(entity) > id) && next)) {
83 spin_unlock(&mdev->lock);
88 spin_unlock(&mdev->lock);
93 static long media_device_enum_entities(struct media_device *mdev,
94 struct media_entity_desc __user *uent)
96 struct media_entity *ent;
97 struct media_entity_desc u_ent;
99 memset(&u_ent, 0, sizeof(u_ent));
100 if (copy_from_user(&u_ent.id, &uent->id, sizeof(u_ent.id)))
103 ent = find_entity(mdev, u_ent.id);
108 u_ent.id = media_entity_id(ent);
110 strlcpy(u_ent.name, ent->name, sizeof(u_ent.name));
111 u_ent.type = ent->function;
112 u_ent.revision = 0; /* Unused */
113 u_ent.flags = ent->flags;
114 u_ent.group_id = 0; /* Unused */
115 u_ent.pads = ent->num_pads;
116 u_ent.links = ent->num_links - ent->num_backlinks;
117 memcpy(&u_ent.raw, &ent->info, sizeof(ent->info));
118 if (copy_to_user(uent, &u_ent, sizeof(u_ent)))
123 static void media_device_kpad_to_upad(const struct media_pad *kpad,
124 struct media_pad_desc *upad)
126 upad->entity = media_entity_id(kpad->entity);
127 upad->index = kpad->index;
128 upad->flags = kpad->flags;
131 static long __media_device_enum_links(struct media_device *mdev,
132 struct media_links_enum *links)
134 struct media_entity *entity;
136 entity = find_entity(mdev, links->entity);
143 for (p = 0; p < entity->num_pads; p++) {
144 struct media_pad_desc pad;
146 memset(&pad, 0, sizeof(pad));
147 media_device_kpad_to_upad(&entity->pads[p], &pad);
148 if (copy_to_user(&links->pads[p], &pad, sizeof(pad)))
154 struct media_link *link;
155 struct media_link_desc __user *ulink_desc = links->links;
157 list_for_each_entry(link, &entity->links, list) {
158 struct media_link_desc klink_desc;
160 /* Ignore backlinks. */
161 if (link->source->entity != entity)
163 memset(&klink_desc, 0, sizeof(klink_desc));
164 media_device_kpad_to_upad(link->source,
166 media_device_kpad_to_upad(link->sink,
168 klink_desc.flags = link->flags;
169 if (copy_to_user(ulink_desc, &klink_desc,
170 sizeof(*ulink_desc)))
179 static long media_device_enum_links(struct media_device *mdev,
180 struct media_links_enum __user *ulinks)
182 struct media_links_enum links;
185 if (copy_from_user(&links, ulinks, sizeof(links)))
188 rval = __media_device_enum_links(mdev, &links);
192 if (copy_to_user(ulinks, &links, sizeof(*ulinks)))
198 static long media_device_setup_link(struct media_device *mdev,
199 struct media_link_desc __user *_ulink)
201 struct media_link *link = NULL;
202 struct media_link_desc ulink;
203 struct media_entity *source;
204 struct media_entity *sink;
207 if (copy_from_user(&ulink, _ulink, sizeof(ulink)))
210 /* Find the source and sink entities and link.
212 source = find_entity(mdev, ulink.source.entity);
213 sink = find_entity(mdev, ulink.sink.entity);
215 if (source == NULL || sink == NULL)
218 if (ulink.source.index >= source->num_pads ||
219 ulink.sink.index >= sink->num_pads)
222 link = media_entity_find_link(&source->pads[ulink.source.index],
223 &sink->pads[ulink.sink.index]);
227 /* Setup the link on both entities. */
228 ret = __media_entity_setup_link(link, ulink.flags);
230 if (copy_to_user(_ulink, &ulink, sizeof(ulink)))
236 static long __media_device_get_topology(struct media_device *mdev,
237 struct media_v2_topology *topo)
239 struct media_entity *entity;
240 struct media_interface *intf;
241 struct media_pad *pad;
242 struct media_link *link;
243 struct media_v2_entity kentity, *uentity;
244 struct media_v2_interface kintf, *uintf;
245 struct media_v2_pad kpad, *upad;
246 struct media_v2_link klink, *ulink;
250 topo->topology_version = mdev->topology_version;
252 /* Get entities and number of entities */
254 uentity = media_get_uptr(topo->ptr_entities);
255 media_device_for_each_entity(entity, mdev) {
260 if (i > topo->num_entities) {
265 /* Copy fields to userspace struct if not error */
266 memset(&kentity, 0, sizeof(kentity));
267 kentity.id = entity->graph_obj.id;
268 kentity.function = entity->function;
269 strncpy(kentity.name, entity->name,
270 sizeof(kentity.name));
272 if (copy_to_user(uentity, &kentity, sizeof(kentity)))
276 topo->num_entities = i;
278 /* Get interfaces and number of interfaces */
280 uintf = media_get_uptr(topo->ptr_interfaces);
281 media_device_for_each_intf(intf, mdev) {
286 if (i > topo->num_interfaces) {
291 memset(&kintf, 0, sizeof(kintf));
293 /* Copy intf fields to userspace struct */
294 kintf.id = intf->graph_obj.id;
295 kintf.intf_type = intf->type;
296 kintf.flags = intf->flags;
298 if (media_type(&intf->graph_obj) == MEDIA_GRAPH_INTF_DEVNODE) {
299 struct media_intf_devnode *devnode;
301 devnode = intf_to_devnode(intf);
303 kintf.devnode.major = devnode->major;
304 kintf.devnode.minor = devnode->minor;
307 if (copy_to_user(uintf, &kintf, sizeof(kintf)))
311 topo->num_interfaces = i;
313 /* Get pads and number of pads */
315 upad = media_get_uptr(topo->ptr_pads);
316 media_device_for_each_pad(pad, mdev) {
321 if (i > topo->num_pads) {
326 memset(&kpad, 0, sizeof(kpad));
328 /* Copy pad fields to userspace struct */
329 kpad.id = pad->graph_obj.id;
330 kpad.entity_id = pad->entity->graph_obj.id;
331 kpad.flags = pad->flags;
333 if (copy_to_user(upad, &kpad, sizeof(kpad)))
339 /* Get links and number of links */
341 ulink = media_get_uptr(topo->ptr_links);
342 media_device_for_each_link(link, mdev) {
343 if (link->is_backlink)
351 if (i > topo->num_links) {
356 memset(&klink, 0, sizeof(klink));
358 /* Copy link fields to userspace struct */
359 klink.id = link->graph_obj.id;
360 klink.source_id = link->gobj0->id;
361 klink.sink_id = link->gobj1->id;
362 klink.flags = link->flags;
364 if (copy_to_user(ulink, &klink, sizeof(klink)))
373 static long media_device_get_topology(struct media_device *mdev,
374 struct media_v2_topology __user *utopo)
376 struct media_v2_topology ktopo;
379 if (copy_from_user(&ktopo, utopo, sizeof(ktopo)))
382 ret = __media_device_get_topology(mdev, &ktopo);
386 if (copy_to_user(utopo, &ktopo, sizeof(*utopo)))
392 static long media_device_ioctl(struct file *filp, unsigned int cmd,
395 struct media_devnode *devnode = media_devnode_data(filp);
396 struct media_device *dev = to_media_device(devnode);
400 case MEDIA_IOC_DEVICE_INFO:
401 ret = media_device_get_info(dev,
402 (struct media_device_info __user *)arg);
405 case MEDIA_IOC_ENUM_ENTITIES:
406 ret = media_device_enum_entities(dev,
407 (struct media_entity_desc __user *)arg);
410 case MEDIA_IOC_ENUM_LINKS:
411 mutex_lock(&dev->graph_mutex);
412 ret = media_device_enum_links(dev,
413 (struct media_links_enum __user *)arg);
414 mutex_unlock(&dev->graph_mutex);
417 case MEDIA_IOC_SETUP_LINK:
418 mutex_lock(&dev->graph_mutex);
419 ret = media_device_setup_link(dev,
420 (struct media_link_desc __user *)arg);
421 mutex_unlock(&dev->graph_mutex);
424 case MEDIA_IOC_G_TOPOLOGY:
425 mutex_lock(&dev->graph_mutex);
426 ret = media_device_get_topology(dev,
427 (struct media_v2_topology __user *)arg);
428 mutex_unlock(&dev->graph_mutex);
440 struct media_links_enum32 {
442 compat_uptr_t pads; /* struct media_pad_desc * */
443 compat_uptr_t links; /* struct media_link_desc * */
447 static long media_device_enum_links32(struct media_device *mdev,
448 struct media_links_enum32 __user *ulinks)
450 struct media_links_enum links;
451 compat_uptr_t pads_ptr, links_ptr;
453 memset(&links, 0, sizeof(links));
455 if (get_user(links.entity, &ulinks->entity)
456 || get_user(pads_ptr, &ulinks->pads)
457 || get_user(links_ptr, &ulinks->links))
460 links.pads = compat_ptr(pads_ptr);
461 links.links = compat_ptr(links_ptr);
463 return __media_device_enum_links(mdev, &links);
466 #define MEDIA_IOC_ENUM_LINKS32 _IOWR('|', 0x02, struct media_links_enum32)
468 static long media_device_compat_ioctl(struct file *filp, unsigned int cmd,
471 struct media_devnode *devnode = media_devnode_data(filp);
472 struct media_device *dev = to_media_device(devnode);
476 case MEDIA_IOC_DEVICE_INFO:
477 case MEDIA_IOC_ENUM_ENTITIES:
478 case MEDIA_IOC_SETUP_LINK:
479 case MEDIA_IOC_G_TOPOLOGY:
480 return media_device_ioctl(filp, cmd, arg);
482 case MEDIA_IOC_ENUM_LINKS32:
483 mutex_lock(&dev->graph_mutex);
484 ret = media_device_enum_links32(dev,
485 (struct media_links_enum32 __user *)arg);
486 mutex_unlock(&dev->graph_mutex);
495 #endif /* CONFIG_COMPAT */
497 static const struct media_file_operations media_device_fops = {
498 .owner = THIS_MODULE,
499 .open = media_device_open,
500 .ioctl = media_device_ioctl,
502 .compat_ioctl = media_device_compat_ioctl,
503 #endif /* CONFIG_COMPAT */
504 .release = media_device_close,
507 /* -----------------------------------------------------------------------------
511 static ssize_t show_model(struct device *cd,
512 struct device_attribute *attr, char *buf)
514 struct media_device *mdev = to_media_device(to_media_devnode(cd));
516 return sprintf(buf, "%.*s\n", (int)sizeof(mdev->model), mdev->model);
519 static DEVICE_ATTR(model, S_IRUGO, show_model, NULL);
521 /* -----------------------------------------------------------------------------
522 * Registration/unregistration
525 static void media_device_release(struct media_devnode *mdev)
527 dev_dbg(mdev->parent, "Media device released\n");
531 * media_device_register_entity - Register an entity with a media device
532 * @mdev: The media device
533 * @entity: The entity
535 int __must_check media_device_register_entity(struct media_device *mdev,
536 struct media_entity *entity)
540 if (entity->function == MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN ||
541 entity->function == MEDIA_ENT_F_UNKNOWN)
543 "Entity type for entity %s was not initialized!\n",
546 /* Warn if we apparently re-register an entity */
547 WARN_ON(entity->graph_obj.mdev != NULL);
548 entity->graph_obj.mdev = mdev;
549 INIT_LIST_HEAD(&entity->links);
550 entity->num_links = 0;
551 entity->num_backlinks = 0;
553 spin_lock(&mdev->lock);
554 /* Initialize media_gobj embedded at the entity */
555 media_gobj_create(mdev, MEDIA_GRAPH_ENTITY, &entity->graph_obj);
557 /* Initialize objects at the pads */
558 for (i = 0; i < entity->num_pads; i++)
559 media_gobj_create(mdev, MEDIA_GRAPH_PAD,
560 &entity->pads[i].graph_obj);
562 spin_unlock(&mdev->lock);
566 EXPORT_SYMBOL_GPL(media_device_register_entity);
569 * media_device_unregister_entity - Unregister an entity
570 * @entity: The entity
572 * If the entity has never been registered this function will return
575 static void __media_device_unregister_entity(struct media_entity *entity)
577 struct media_device *mdev = entity->graph_obj.mdev;
578 struct media_link *link, *tmp;
579 struct media_interface *intf;
582 /* Remove all interface links pointing to this entity */
583 list_for_each_entry(intf, &mdev->interfaces, graph_obj.list) {
584 list_for_each_entry_safe(link, tmp, &intf->links, list) {
585 if (link->entity == entity)
586 __media_remove_intf_link(link);
590 /* Remove all data links that belong to this entity */
591 __media_entity_remove_links(entity);
593 /* Remove all pads that belong to this entity */
594 for (i = 0; i < entity->num_pads; i++)
595 media_gobj_destroy(&entity->pads[i].graph_obj);
597 /* Remove the entity */
598 media_gobj_destroy(&entity->graph_obj);
600 entity->graph_obj.mdev = NULL;
603 void media_device_unregister_entity(struct media_entity *entity)
605 struct media_device *mdev = entity->graph_obj.mdev;
610 spin_lock(&mdev->lock);
611 __media_device_unregister_entity(entity);
612 spin_unlock(&mdev->lock);
614 EXPORT_SYMBOL_GPL(media_device_unregister_entity);
618 * media_device_init() - initialize a media device
619 * @mdev: The media device
621 * The caller is responsible for initializing the media device before
622 * registration. The following fields must be set:
624 * - dev must point to the parent device
625 * - model must be filled with the device model name
627 void media_device_init(struct media_device *mdev)
629 INIT_LIST_HEAD(&mdev->entities);
630 INIT_LIST_HEAD(&mdev->interfaces);
631 INIT_LIST_HEAD(&mdev->pads);
632 INIT_LIST_HEAD(&mdev->links);
633 spin_lock_init(&mdev->lock);
634 mutex_init(&mdev->graph_mutex);
636 dev_dbg(mdev->dev, "Media device initialized\n");
638 EXPORT_SYMBOL_GPL(media_device_init);
641 * media_device_cleanup() - Cleanup a media device
642 * @mdev: The media device
645 void media_device_cleanup(struct media_device *mdev)
647 mutex_destroy(&mdev->graph_mutex);
649 EXPORT_SYMBOL_GPL(media_device_cleanup);
652 * __media_device_register() - register a media device
653 * @mdev: The media device
654 * @owner: The module owner
656 * returns zero on success or a negative error code.
658 int __must_check __media_device_register(struct media_device *mdev,
659 struct module *owner)
663 /* Register the device node. */
664 mdev->devnode.fops = &media_device_fops;
665 mdev->devnode.parent = mdev->dev;
666 mdev->devnode.release = media_device_release;
668 /* Set version 0 to indicate user-space that the graph is static */
669 mdev->topology_version = 0;
671 ret = media_devnode_register(&mdev->devnode, owner);
675 ret = device_create_file(&mdev->devnode.dev, &dev_attr_model);
677 media_devnode_unregister(&mdev->devnode);
681 dev_dbg(mdev->dev, "Media device registered\n");
685 EXPORT_SYMBOL_GPL(__media_device_register);
688 * media_device_unregister - unregister a media device
689 * @mdev: The media device
691 * It is safe to call this function on an unregistered
692 * (but initialised) media device.
694 void media_device_unregister(struct media_device *mdev)
696 struct media_entity *entity;
697 struct media_entity *next;
698 struct media_interface *intf, *tmp_intf;
703 spin_lock(&mdev->lock);
705 /* Check if mdev was ever registered at all */
706 if (!media_devnode_is_registered(&mdev->devnode)) {
707 spin_unlock(&mdev->lock);
711 /* Remove all entities from the media device */
712 list_for_each_entry_safe(entity, next, &mdev->entities, graph_obj.list)
713 __media_device_unregister_entity(entity);
715 /* Remove all interfaces from the media device */
716 list_for_each_entry_safe(intf, tmp_intf, &mdev->interfaces,
718 __media_remove_intf_links(intf);
719 media_gobj_destroy(&intf->graph_obj);
723 spin_unlock(&mdev->lock);
725 device_remove_file(&mdev->devnode.dev, &dev_attr_model);
726 media_devnode_unregister(&mdev->devnode);
728 dev_dbg(mdev->dev, "Media device unregistered\n");
730 EXPORT_SYMBOL_GPL(media_device_unregister);
732 static void media_device_release_devres(struct device *dev, void *res)
736 struct media_device *media_device_get_devres(struct device *dev)
738 struct media_device *mdev;
740 mdev = devres_find(dev, media_device_release_devres, NULL, NULL);
744 mdev = devres_alloc(media_device_release_devres,
745 sizeof(struct media_device), GFP_KERNEL);
748 return devres_get(dev, mdev, NULL, NULL);
750 EXPORT_SYMBOL_GPL(media_device_get_devres);
752 struct media_device *media_device_find_devres(struct device *dev)
754 return devres_find(dev, media_device_release_devres, NULL, NULL);
756 EXPORT_SYMBOL_GPL(media_device_find_devres);
758 #endif /* CONFIG_MEDIA_CONTROLLER */