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