83525ac293284af633763bff6adc9b24f204c6a1
[deliverable/linux.git] / drivers / media / media-device.c
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 * 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
21 */
22
23 #include <linux/compat.h>
24 #include <linux/export.h>
25 #include <linux/ioctl.h>
26 #include <linux/media.h>
27 #include <linux/types.h>
28 #include <linux/slab.h>
29
30 #include <media/media-device.h>
31 #include <media/media-devnode.h>
32 #include <media/media-entity.h>
33
34 #ifdef CONFIG_MEDIA_CONTROLLER
35
36 /* -----------------------------------------------------------------------------
37 * Userspace API
38 */
39
40 static int media_device_open(struct file *filp)
41 {
42 return 0;
43 }
44
45 static int media_device_close(struct file *filp)
46 {
47 return 0;
48 }
49
50 static int media_device_get_info(struct media_device *dev,
51 struct media_device_info __user *__info)
52 {
53 struct media_device_info info;
54
55 memset(&info, 0, sizeof(info));
56
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));
61
62 info.media_version = MEDIA_API_VERSION;
63 info.hw_revision = dev->hw_revision;
64 info.driver_version = dev->driver_version;
65
66 if (copy_to_user(__info, &info, sizeof(*__info)))
67 return -EFAULT;
68 return 0;
69 }
70
71 static struct media_entity *find_entity(struct media_device *mdev, u32 id)
72 {
73 struct media_entity *entity;
74 int next = id & MEDIA_ENT_ID_FLAG_NEXT;
75
76 id &= ~MEDIA_ENT_ID_FLAG_NEXT;
77
78 spin_lock(&mdev->lock);
79
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);
84 return entity;
85 }
86 }
87
88 spin_unlock(&mdev->lock);
89
90 return NULL;
91 }
92
93 static long media_device_enum_entities(struct media_device *mdev,
94 struct media_entity_desc __user *uent)
95 {
96 struct media_entity *ent;
97 struct media_entity_desc u_ent;
98
99 memset(&u_ent, 0, sizeof(u_ent));
100 if (copy_from_user(&u_ent.id, &uent->id, sizeof(u_ent.id)))
101 return -EFAULT;
102
103 ent = find_entity(mdev, u_ent.id);
104
105 if (ent == NULL)
106 return -EINVAL;
107
108 u_ent.id = media_entity_id(ent);
109 if (ent->name)
110 strlcpy(u_ent.name, ent->name, sizeof(u_ent.name));
111 u_ent.type = ent->function;
112 u_ent.revision = ent->revision;
113 u_ent.flags = ent->flags;
114 u_ent.group_id = ent->group_id;
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)))
119 return -EFAULT;
120 return 0;
121 }
122
123 static void media_device_kpad_to_upad(const struct media_pad *kpad,
124 struct media_pad_desc *upad)
125 {
126 upad->entity = media_entity_id(kpad->entity);
127 upad->index = kpad->index;
128 upad->flags = kpad->flags;
129 }
130
131 static long __media_device_enum_links(struct media_device *mdev,
132 struct media_links_enum *links)
133 {
134 struct media_entity *entity;
135
136 entity = find_entity(mdev, links->entity);
137 if (entity == NULL)
138 return -EINVAL;
139
140 if (links->pads) {
141 unsigned int p;
142
143 for (p = 0; p < entity->num_pads; p++) {
144 struct media_pad_desc pad;
145
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)))
149 return -EFAULT;
150 }
151 }
152
153 if (links->links) {
154 struct media_link *ent_link;
155 struct media_link_desc __user *ulink = links->links;
156
157 list_for_each_entry(ent_link, &entity->links, list) {
158 struct media_link_desc link;
159
160 /* Ignore backlinks. */
161 if (ent_link->source->entity != entity)
162 continue;
163 memset(&link, 0, sizeof(link));
164 media_device_kpad_to_upad(ent_link->source,
165 &link.source);
166 media_device_kpad_to_upad(ent_link->sink,
167 &link.sink);
168 link.flags = ent_link->flags;
169 if (copy_to_user(ulink, &link, sizeof(*ulink)))
170 return -EFAULT;
171 ulink++;
172 }
173 }
174
175 return 0;
176 }
177
178 static long media_device_enum_links(struct media_device *mdev,
179 struct media_links_enum __user *ulinks)
180 {
181 struct media_links_enum links;
182 int rval;
183
184 if (copy_from_user(&links, ulinks, sizeof(links)))
185 return -EFAULT;
186
187 rval = __media_device_enum_links(mdev, &links);
188 if (rval < 0)
189 return rval;
190
191 if (copy_to_user(ulinks, &links, sizeof(*ulinks)))
192 return -EFAULT;
193
194 return 0;
195 }
196
197 static long media_device_setup_link(struct media_device *mdev,
198 struct media_link_desc __user *_ulink)
199 {
200 struct media_link *link = NULL;
201 struct media_link_desc ulink;
202 struct media_entity *source;
203 struct media_entity *sink;
204 int ret;
205
206 if (copy_from_user(&ulink, _ulink, sizeof(ulink)))
207 return -EFAULT;
208
209 /* Find the source and sink entities and link.
210 */
211 source = find_entity(mdev, ulink.source.entity);
212 sink = find_entity(mdev, ulink.sink.entity);
213
214 if (source == NULL || sink == NULL)
215 return -EINVAL;
216
217 if (ulink.source.index >= source->num_pads ||
218 ulink.sink.index >= sink->num_pads)
219 return -EINVAL;
220
221 link = media_entity_find_link(&source->pads[ulink.source.index],
222 &sink->pads[ulink.sink.index]);
223 if (link == NULL)
224 return -EINVAL;
225
226 /* Setup the link on both entities. */
227 ret = __media_entity_setup_link(link, ulink.flags);
228
229 if (copy_to_user(_ulink, &ulink, sizeof(ulink)))
230 return -EFAULT;
231
232 return ret;
233 }
234
235 static long __media_device_get_topology(struct media_device *mdev,
236 struct media_v2_topology *topo)
237 {
238 struct media_entity *entity;
239 struct media_interface *intf;
240 struct media_pad *pad;
241 struct media_link *link;
242 struct media_v2_entity uentity;
243 struct media_v2_interface uintf;
244 struct media_v2_pad upad;
245 struct media_v2_link ulink;
246 int ret = 0, i;
247
248 topo->topology_version = mdev->topology_version;
249
250 /* Get entities and number of entities */
251 i = 0;
252 media_device_for_each_entity(entity, mdev) {
253 i++;
254
255 if (ret || !topo->entities)
256 continue;
257
258 if (i > topo->num_entities) {
259 ret = -ENOSPC;
260 continue;
261 }
262
263 /* Copy fields to userspace struct if not error */
264 memset(&uentity, 0, sizeof(uentity));
265 uentity.id = entity->graph_obj.id;
266 uentity.function = entity->function;
267 strncpy(uentity.name, entity->name,
268 sizeof(uentity.name));
269
270 if (copy_to_user(&topo->entities[i - 1], &uentity, sizeof(uentity)))
271 ret = -EFAULT;
272 }
273 topo->num_entities = i;
274
275 /* Get interfaces and number of interfaces */
276 i = 0;
277 media_device_for_each_intf(intf, mdev) {
278 i++;
279
280 if (ret || !topo->interfaces)
281 continue;
282
283 if (i > topo->num_interfaces) {
284 ret = -ENOSPC;
285 continue;
286 }
287
288 memset(&uintf, 0, sizeof(uintf));
289
290 /* Copy intf fields to userspace struct */
291 uintf.id = intf->graph_obj.id;
292 uintf.intf_type = intf->type;
293 uintf.flags = intf->flags;
294
295 if (media_type(&intf->graph_obj) == MEDIA_GRAPH_INTF_DEVNODE) {
296 struct media_intf_devnode *devnode;
297
298 devnode = intf_to_devnode(intf);
299
300 uintf.devnode.major = devnode->major;
301 uintf.devnode.minor = devnode->minor;
302 }
303
304 if (copy_to_user(&topo->interfaces[i - 1], &uintf, sizeof(uintf)))
305 ret = -EFAULT;
306 }
307 topo->num_interfaces = i;
308
309 /* Get pads and number of pads */
310 i = 0;
311 media_device_for_each_pad(pad, mdev) {
312 i++;
313
314 if (ret || !topo->pads)
315 continue;
316
317 if (i > topo->num_pads) {
318 ret = -ENOSPC;
319 continue;
320 }
321
322 memset(&upad, 0, sizeof(upad));
323
324 /* Copy pad fields to userspace struct */
325 upad.id = pad->graph_obj.id;
326 upad.entity_id = pad->entity->graph_obj.id;
327 upad.flags = pad->flags;
328
329 if (copy_to_user(&topo->pads[i - 1], &upad, sizeof(upad)))
330 ret = -EFAULT;
331 }
332 topo->num_pads = i;
333
334 /* Get links and number of links */
335 i = 0;
336 media_device_for_each_link(link, mdev) {
337 if (link->is_backlink)
338 continue;
339
340 i++;
341
342 if (ret || !topo->links)
343 continue;
344
345 if (i > topo->num_links) {
346 ret = -ENOSPC;
347 continue;
348 }
349
350 memset(&ulink, 0, sizeof(ulink));
351
352 /* Copy link fields to userspace struct */
353 ulink.id = link->graph_obj.id;
354 ulink.source_id = link->gobj0->id;
355 ulink.sink_id = link->gobj1->id;
356 ulink.flags = link->flags;
357
358 if (media_type(link->gobj0) != MEDIA_GRAPH_PAD)
359 ulink.flags |= MEDIA_LNK_FL_INTERFACE_LINK;
360
361 if (copy_to_user(&topo->links[i - 1], &ulink, sizeof(ulink)))
362 ret = -EFAULT;
363 }
364 topo->num_links = i;
365
366 return ret;
367 }
368
369 static long media_device_get_topology(struct media_device *mdev,
370 struct media_v2_topology __user *utopo)
371 {
372 struct media_v2_topology ktopo;
373 int ret;
374
375 ret = copy_from_user(&ktopo, utopo, sizeof(ktopo));
376
377 if (ret < 0)
378 return ret;
379
380 ret = __media_device_get_topology(mdev, &ktopo);
381 if (ret < 0)
382 return ret;
383
384 ret = copy_to_user(utopo, &ktopo, sizeof(*utopo));
385
386 return ret;
387 }
388
389 static long media_device_ioctl(struct file *filp, unsigned int cmd,
390 unsigned long arg)
391 {
392 struct media_devnode *devnode = media_devnode_data(filp);
393 struct media_device *dev = to_media_device(devnode);
394 long ret;
395
396 switch (cmd) {
397 case MEDIA_IOC_DEVICE_INFO:
398 ret = media_device_get_info(dev,
399 (struct media_device_info __user *)arg);
400 break;
401
402 case MEDIA_IOC_ENUM_ENTITIES:
403 ret = media_device_enum_entities(dev,
404 (struct media_entity_desc __user *)arg);
405 break;
406
407 case MEDIA_IOC_ENUM_LINKS:
408 mutex_lock(&dev->graph_mutex);
409 ret = media_device_enum_links(dev,
410 (struct media_links_enum __user *)arg);
411 mutex_unlock(&dev->graph_mutex);
412 break;
413
414 case MEDIA_IOC_SETUP_LINK:
415 mutex_lock(&dev->graph_mutex);
416 ret = media_device_setup_link(dev,
417 (struct media_link_desc __user *)arg);
418 mutex_unlock(&dev->graph_mutex);
419 break;
420
421 case MEDIA_IOC_G_TOPOLOGY:
422 mutex_lock(&dev->graph_mutex);
423 ret = media_device_get_topology(dev,
424 (struct media_v2_topology __user *)arg);
425 mutex_unlock(&dev->graph_mutex);
426 break;
427
428 default:
429 ret = -ENOIOCTLCMD;
430 }
431
432 return ret;
433 }
434
435 #ifdef CONFIG_COMPAT
436
437 struct media_links_enum32 {
438 __u32 entity;
439 compat_uptr_t pads; /* struct media_pad_desc * */
440 compat_uptr_t links; /* struct media_link_desc * */
441 __u32 reserved[4];
442 };
443
444 static long media_device_enum_links32(struct media_device *mdev,
445 struct media_links_enum32 __user *ulinks)
446 {
447 struct media_links_enum links;
448 compat_uptr_t pads_ptr, links_ptr;
449
450 memset(&links, 0, sizeof(links));
451
452 if (get_user(links.entity, &ulinks->entity)
453 || get_user(pads_ptr, &ulinks->pads)
454 || get_user(links_ptr, &ulinks->links))
455 return -EFAULT;
456
457 links.pads = compat_ptr(pads_ptr);
458 links.links = compat_ptr(links_ptr);
459
460 return __media_device_enum_links(mdev, &links);
461 }
462
463 #define MEDIA_IOC_ENUM_LINKS32 _IOWR('|', 0x02, struct media_links_enum32)
464
465 static long media_device_compat_ioctl(struct file *filp, unsigned int cmd,
466 unsigned long arg)
467 {
468 struct media_devnode *devnode = media_devnode_data(filp);
469 struct media_device *dev = to_media_device(devnode);
470 long ret;
471
472 switch (cmd) {
473 case MEDIA_IOC_DEVICE_INFO:
474 case MEDIA_IOC_ENUM_ENTITIES:
475 case MEDIA_IOC_SETUP_LINK:
476 case MEDIA_IOC_G_TOPOLOGY:
477 return media_device_ioctl(filp, cmd, arg);
478
479 case MEDIA_IOC_ENUM_LINKS32:
480 mutex_lock(&dev->graph_mutex);
481 ret = media_device_enum_links32(dev,
482 (struct media_links_enum32 __user *)arg);
483 mutex_unlock(&dev->graph_mutex);
484 break;
485
486 default:
487 ret = -ENOIOCTLCMD;
488 }
489
490 return ret;
491 }
492 #endif /* CONFIG_COMPAT */
493
494 static const struct media_file_operations media_device_fops = {
495 .owner = THIS_MODULE,
496 .open = media_device_open,
497 .ioctl = media_device_ioctl,
498 #ifdef CONFIG_COMPAT
499 .compat_ioctl = media_device_compat_ioctl,
500 #endif /* CONFIG_COMPAT */
501 .release = media_device_close,
502 };
503
504 /* -----------------------------------------------------------------------------
505 * sysfs
506 */
507
508 static ssize_t show_model(struct device *cd,
509 struct device_attribute *attr, char *buf)
510 {
511 struct media_device *mdev = to_media_device(to_media_devnode(cd));
512
513 return sprintf(buf, "%.*s\n", (int)sizeof(mdev->model), mdev->model);
514 }
515
516 static DEVICE_ATTR(model, S_IRUGO, show_model, NULL);
517
518 /* -----------------------------------------------------------------------------
519 * Registration/unregistration
520 */
521
522 static void media_device_release(struct media_devnode *mdev)
523 {
524 dev_dbg(mdev->parent, "Media device released\n");
525 }
526
527 /**
528 * media_device_register - register a media device
529 * @mdev: The media device
530 *
531 * The caller is responsible for initializing the media device before
532 * registration. The following fields must be set:
533 *
534 * - dev must point to the parent device
535 * - model must be filled with the device model name
536 */
537 int __must_check __media_device_register(struct media_device *mdev,
538 struct module *owner)
539 {
540 int ret;
541
542 if (WARN_ON(mdev->dev == NULL || mdev->model[0] == 0))
543 return -EINVAL;
544
545 INIT_LIST_HEAD(&mdev->entities);
546 INIT_LIST_HEAD(&mdev->interfaces);
547 INIT_LIST_HEAD(&mdev->pads);
548 INIT_LIST_HEAD(&mdev->links);
549 spin_lock_init(&mdev->lock);
550 mutex_init(&mdev->graph_mutex);
551
552 /* Register the device node. */
553 mdev->devnode.fops = &media_device_fops;
554 mdev->devnode.parent = mdev->dev;
555 mdev->devnode.release = media_device_release;
556 ret = media_devnode_register(&mdev->devnode, owner);
557 if (ret < 0)
558 return ret;
559
560 ret = device_create_file(&mdev->devnode.dev, &dev_attr_model);
561 if (ret < 0) {
562 media_devnode_unregister(&mdev->devnode);
563 return ret;
564 }
565
566 dev_dbg(mdev->dev, "Media device registered\n");
567
568 return 0;
569 }
570 EXPORT_SYMBOL_GPL(__media_device_register);
571
572 /**
573 * media_device_unregister - unregister a media device
574 * @mdev: The media device
575 *
576 */
577 void media_device_unregister(struct media_device *mdev)
578 {
579 struct media_entity *entity;
580 struct media_entity *next;
581 struct media_interface *intf, *tmp_intf;
582
583 /* Remove all entities from the media device */
584 list_for_each_entry_safe(entity, next, &mdev->entities, graph_obj.list)
585 media_device_unregister_entity(entity);
586
587 /* Remove all interfaces from the media device */
588 spin_lock(&mdev->lock);
589 list_for_each_entry_safe(intf, tmp_intf, &mdev->interfaces,
590 graph_obj.list) {
591 __media_remove_intf_links(intf);
592 media_gobj_remove(&intf->graph_obj);
593 kfree(intf);
594 }
595 spin_unlock(&mdev->lock);
596
597 device_remove_file(&mdev->devnode.dev, &dev_attr_model);
598 media_devnode_unregister(&mdev->devnode);
599
600 dev_dbg(mdev->dev, "Media device unregistered\n");
601 }
602 EXPORT_SYMBOL_GPL(media_device_unregister);
603
604 /**
605 * media_device_register_entity - Register an entity with a media device
606 * @mdev: The media device
607 * @entity: The entity
608 */
609 int __must_check media_device_register_entity(struct media_device *mdev,
610 struct media_entity *entity)
611 {
612 int i;
613
614 if (entity->function == MEDIA_ENT_T_V4L2_SUBDEV_UNKNOWN ||
615 entity->function == MEDIA_ENT_T_UNKNOWN)
616 dev_warn(mdev->dev,
617 "Entity type for entity %s was not initialized!\n",
618 entity->name);
619
620 /* Warn if we apparently re-register an entity */
621 WARN_ON(entity->graph_obj.mdev != NULL);
622 entity->graph_obj.mdev = mdev;
623 INIT_LIST_HEAD(&entity->links);
624
625 spin_lock(&mdev->lock);
626 /* Initialize media_gobj embedded at the entity */
627 media_gobj_init(mdev, MEDIA_GRAPH_ENTITY, &entity->graph_obj);
628
629 /* Initialize objects at the pads */
630 for (i = 0; i < entity->num_pads; i++)
631 media_gobj_init(mdev, MEDIA_GRAPH_PAD,
632 &entity->pads[i].graph_obj);
633
634 spin_unlock(&mdev->lock);
635
636 return 0;
637 }
638 EXPORT_SYMBOL_GPL(media_device_register_entity);
639
640 /**
641 * media_device_unregister_entity - Unregister an entity
642 * @entity: The entity
643 *
644 * If the entity has never been registered this function will return
645 * immediately.
646 */
647 void media_device_unregister_entity(struct media_entity *entity)
648 {
649 int i;
650 struct media_device *mdev = entity->graph_obj.mdev;
651 struct media_link *link, *tmp;
652 struct media_interface *intf;
653
654 if (mdev == NULL)
655 return;
656
657 spin_lock(&mdev->lock);
658
659 /* Remove all interface links pointing to this entity */
660 list_for_each_entry(intf, &mdev->interfaces, graph_obj.list) {
661 list_for_each_entry_safe(link, tmp, &intf->links, list) {
662 if (link->entity == entity)
663 __media_remove_intf_link(link);
664 }
665 }
666
667 /* Remove all data links that belong to this entity */
668 __media_entity_remove_links(entity);
669
670 /* Remove all pads that belong to this entity */
671 for (i = 0; i < entity->num_pads; i++)
672 media_gobj_remove(&entity->pads[i].graph_obj);
673
674 /* Remove the entity */
675 media_gobj_remove(&entity->graph_obj);
676
677 spin_unlock(&mdev->lock);
678 entity->graph_obj.mdev = NULL;
679 }
680 EXPORT_SYMBOL_GPL(media_device_unregister_entity);
681
682 static void media_device_release_devres(struct device *dev, void *res)
683 {
684 }
685
686 /*
687 * media_device_get_devres() - get media device as device resource
688 * creates if one doesn't exist
689 */
690 struct media_device *media_device_get_devres(struct device *dev)
691 {
692 struct media_device *mdev;
693
694 mdev = devres_find(dev, media_device_release_devres, NULL, NULL);
695 if (mdev)
696 return mdev;
697
698 mdev = devres_alloc(media_device_release_devres,
699 sizeof(struct media_device), GFP_KERNEL);
700 if (!mdev)
701 return NULL;
702 return devres_get(dev, mdev, NULL, NULL);
703 }
704 EXPORT_SYMBOL_GPL(media_device_get_devres);
705
706 /*
707 * media_device_find_devres() - find media device as device resource
708 */
709 struct media_device *media_device_find_devres(struct device *dev)
710 {
711 return devres_find(dev, media_device_release_devres, NULL, NULL);
712 }
713 EXPORT_SYMBOL_GPL(media_device_find_devres);
714
715 #endif /* CONFIG_MEDIA_CONTROLLER */
This page took 0.046034 seconds and 4 git commands to generate.