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