drivers/media/media-device.c

   1 /*
   2  * Media device
   3  *
   4  * Copyright (C) 2010 Nokia Corporation
   5  *
   6  * Contacts: Laurent Pinchart <[email protected]>
   7  *           Sakari Ailus <[email protected]>
   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                 strscpy(info->driver, dev->driver_name, sizeof(info->driver));
  74         else
  75                 strscpy(info->driver, dev->dev->driver->name,
  76                         sizeof(info->driver));
  77
  78         strscpy(info->model, dev->model, sizeof(info->model));
  79         strscpy(info->serial, dev->serial, sizeof(info->serial));
  80         strscpy(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                 strscpy(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                 strscpy(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 #ifdef CONFIG_MEDIA_CONTROLLER_REQUEST_API
 385         if (!mdev->ops || !mdev->ops->req_validate || !mdev->ops->req_queue)
 386                 return -ENOTTY;
 387
 388         return media_request_alloc(mdev, alloc_fd);
 389 #else
 390         return -ENOTTY;
 391 #endif
 392 }
 393
 394 static long copy_arg_from_user(void *karg, void __user *uarg, unsigned int cmd)
 395 {
 396         if ((_IOC_DIR(cmd) & _IOC_WRITE) &&
 397             copy_from_user(karg, uarg, _IOC_SIZE(cmd)))
 398                 return -EFAULT;
 399
 400         return 0;
 401 }
 402
 403 static long copy_arg_to_user(void __user *uarg, void *karg, unsigned int cmd)
 404 {
 405         if ((_IOC_DIR(cmd) & _IOC_READ) &&
 406             copy_to_user(uarg, karg, _IOC_SIZE(cmd)))
 407                 return -EFAULT;
 408
 409         return 0;
 410 }
 411
 412 /* Do acquire the graph mutex */
 413 #define MEDIA_IOC_FL_GRAPH_MUTEX        BIT(0)
 414
 415 #define MEDIA_IOC_ARG(__cmd, func, fl, from_user, to_user)              \
 416         [_IOC_NR(MEDIA_IOC_##__cmd)] = {                                \
 417                 .cmd = MEDIA_IOC_##__cmd,                               \
 418                 .fn = (long (*)(struct media_device *, void *))func,    \
 419                 .flags = fl,                                            \
 420                 .arg_from_user = from_user,                             \
 421                 .arg_to_user = to_user,                                 \
 422         }
 423
 424 #define MEDIA_IOC(__cmd, func, fl)                                      \
 425         MEDIA_IOC_ARG(__cmd, func, fl, copy_arg_from_user, copy_arg_to_user)
 426
 427 /* the table is indexed by _IOC_NR(cmd) */
 428 struct media_ioctl_info {
 429         unsigned int cmd;
 430         unsigned short flags;
 431         long (*fn)(struct media_device *dev, void *arg);
 432         long (*arg_from_user)(void *karg, void __user *uarg, unsigned int cmd);
 433         long (*arg_to_user)(void __user *uarg, void *karg, unsigned int cmd);
 434 };
 435
 436 static const struct media_ioctl_info ioctl_info[] = {
 437         MEDIA_IOC(DEVICE_INFO, media_device_get_info, MEDIA_IOC_FL_GRAPH_MUTEX),
 438         MEDIA_IOC(ENUM_ENTITIES, media_device_enum_entities, MEDIA_IOC_FL_GRAPH_MUTEX),
 439         MEDIA_IOC(ENUM_LINKS, media_device_enum_links, MEDIA_IOC_FL_GRAPH_MUTEX),
 440         MEDIA_IOC(SETUP_LINK, media_device_setup_link, MEDIA_IOC_FL_GRAPH_MUTEX),
 441         MEDIA_IOC(G_TOPOLOGY, media_device_get_topology, MEDIA_IOC_FL_GRAPH_MUTEX),
 442         MEDIA_IOC(REQUEST_ALLOC, media_device_request_alloc, 0),
 443 };
 444
 445 static long media_device_ioctl(struct file *filp, unsigned int cmd,
 446                                unsigned long __arg)
 447 {
 448         struct media_devnode *devnode = media_devnode_data(filp);
 449         struct media_device *dev = devnode->media_dev;
 450         const struct media_ioctl_info *info;
 451         void __user *arg = (void __user *)__arg;
 452         char __karg[256], *karg = __karg;
 453         long ret;
 454
 455         if (_IOC_NR(cmd) >= ARRAY_SIZE(ioctl_info)
 456             || ioctl_info[_IOC_NR(cmd)].cmd != cmd)
 457                 return -ENOIOCTLCMD;
 458
 459         info = &ioctl_info[_IOC_NR(cmd)];
 460
 461         if (_IOC_SIZE(info->cmd) > sizeof(__karg)) {
 462                 karg = kmalloc(_IOC_SIZE(info->cmd), GFP_KERNEL);
 463                 if (!karg)
 464                         return -ENOMEM;
 465         }
 466
 467         if (info->arg_from_user) {
 468                 ret = info->arg_from_user(karg, arg, cmd);
 469                 if (ret)
 470                         goto out_free;
 471         }
 472
 473         if (info->flags & MEDIA_IOC_FL_GRAPH_MUTEX)
 474                 mutex_lock(&dev->graph_mutex);
 475
 476         ret = info->fn(dev, karg);
 477
 478         if (info->flags & MEDIA_IOC_FL_GRAPH_MUTEX)
 479                 mutex_unlock(&dev->graph_mutex);
 480
 481         if (!ret && info->arg_to_user)
 482                 ret = info->arg_to_user(arg, karg, cmd);
 483
 484 out_free:
 485         if (karg != __karg)
 486                 kfree(karg);
 487
 488         return ret;
 489 }
 490
 491 #ifdef CONFIG_COMPAT
 492
 493 struct media_links_enum32 {
 494         __u32 entity;
 495         compat_uptr_t pads; /* struct media_pad_desc * */
 496         compat_uptr_t links; /* struct media_link_desc * */
 497         __u32 reserved[4];
 498 };
 499
 500 static long media_device_enum_links32(struct media_device *mdev,
 501                                       struct media_links_enum32 __user *ulinks)
 502 {
 503         struct media_links_enum links;
 504         compat_uptr_t pads_ptr, links_ptr;
 505
 506         memset(&links, 0, sizeof(links));
 507
 508         if (get_user(links.entity, &ulinks->entity)
 509             || get_user(pads_ptr, &ulinks->pads)
 510             || get_user(links_ptr, &ulinks->links))
 511                 return -EFAULT;
 512
 513         links.pads = compat_ptr(pads_ptr);
 514         links.links = compat_ptr(links_ptr);
 515
 516         return media_device_enum_links(mdev, &links);
 517 }
 518
 519 #define MEDIA_IOC_ENUM_LINKS32          _IOWR('|', 0x02, struct media_links_enum32)
 520
 521 static long media_device_compat_ioctl(struct file *filp, unsigned int cmd,
 522                                       unsigned long arg)
 523 {
 524         struct media_devnode *devnode = media_devnode_data(filp);
 525         struct media_device *dev = devnode->media_dev;
 526         long ret;
 527
 528         switch (cmd) {
 529         case MEDIA_IOC_ENUM_LINKS32:
 530                 mutex_lock(&dev->graph_mutex);
 531                 ret = media_device_enum_links32(dev,
 532                                 (struct media_links_enum32 __user *)arg);
 533                 mutex_unlock(&dev->graph_mutex);
 534                 break;
 535
 536         default:
 537                 return media_device_ioctl(filp, cmd, arg);
 538         }
 539
 540         return ret;
 541 }
 542 #endif /* CONFIG_COMPAT */
 543
 544 static const struct media_file_operations media_device_fops = {
 545         .owner = THIS_MODULE,
 546         .open = media_device_open,
 547         .ioctl = media_device_ioctl,
 548 #ifdef CONFIG_COMPAT
 549         .compat_ioctl = media_device_compat_ioctl,
 550 #endif /* CONFIG_COMPAT */
 551         .release = media_device_close,
 552 };
 553
 554 /* -----------------------------------------------------------------------------
 555  * sysfs
 556  */
 557
 558 static ssize_t show_model(struct device *cd,
 559                           struct device_attribute *attr, char *buf)
 560 {
 561         struct media_devnode *devnode = to_media_devnode(cd);
 562         struct media_device *mdev = devnode->media_dev;
 563
 564         return sprintf(buf, "%.*s\n", (int)sizeof(mdev->model), mdev->model);
 565 }
 566
 567 static DEVICE_ATTR(model, S_IRUGO, show_model, NULL);
 568
 569 /* -----------------------------------------------------------------------------
 570  * Registration/unregistration
 571  */
 572
 573 static void media_device_release(struct media_devnode *devnode)
 574 {
 575         dev_dbg(devnode->parent, "Media device released\n");
 576 }
 577
 578 /**
 579  * media_device_register_entity - Register an entity with a media device
 580  * @mdev:       The media device
 581  * @entity:     The entity
 582  */
 583 int __must_check media_device_register_entity(struct media_device *mdev,
 584                                               struct media_entity *entity)
 585 {
 586         struct media_entity_notify *notify, *next;
 587         unsigned int i;
 588         int ret;
 589
 590         if (entity->function == MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN ||
 591             entity->function == MEDIA_ENT_F_UNKNOWN)
 592                 dev_warn(mdev->dev,
 593                          "Entity type for entity %s was not initialized!\n",
 594                          entity->name);
 595
 596         /* Warn if we apparently re-register an entity */
 597         WARN_ON(entity->graph_obj.mdev != NULL);
 598         entity->graph_obj.mdev = mdev;
 599         INIT_LIST_HEAD(&entity->links);
 600         entity->num_links = 0;
 601         entity->num_backlinks = 0;
 602
 603         ret = ida_alloc_min(&mdev->entity_internal_idx, 1, GFP_KERNEL);
 604         if (ret < 0)
 605                 return ret;
 606         entity->internal_idx = ret;
 607
 608         mutex_lock(&mdev->graph_mutex);
 609         mdev->entity_internal_idx_max =
 610                 max(mdev->entity_internal_idx_max, entity->internal_idx);
 611
 612         /* Initialize media_gobj embedded at the entity */
 613         media_gobj_create(mdev, MEDIA_GRAPH_ENTITY, &entity->graph_obj);
 614
 615         /* Initialize objects at the pads */
 616         for (i = 0; i < entity->num_pads; i++)
 617                 media_gobj_create(mdev, MEDIA_GRAPH_PAD,
 618                                &entity->pads[i].graph_obj);
 619
 620         /* invoke entity_notify callbacks */
 621         list_for_each_entry_safe(notify, next, &mdev->entity_notify, list)
 622                 notify->notify(entity, notify->notify_data);
 623
 624         if (mdev->entity_internal_idx_max
 625             >= mdev->pm_count_walk.ent_enum.idx_max) {
 626                 struct media_graph new = { .top = 0 };
 627
 628                 /*
 629                  * Initialise the new graph walk before cleaning up
 630                  * the old one in order not to spoil the graph walk
 631                  * object of the media device if graph walk init fails.
 632                  */
 633                 ret = media_graph_walk_init(&new, mdev);
 634                 if (ret) {
 635                         mutex_unlock(&mdev->graph_mutex);
 636                         return ret;
 637                 }
 638                 media_graph_walk_cleanup(&mdev->pm_count_walk);
 639                 mdev->pm_count_walk = new;
 640         }
 641         mutex_unlock(&mdev->graph_mutex);
 642
 643         return 0;
 644 }
 645 EXPORT_SYMBOL_GPL(media_device_register_entity);
 646
 647 static void __media_device_unregister_entity(struct media_entity *entity)
 648 {
 649         struct media_device *mdev = entity->graph_obj.mdev;
 650         struct media_link *link, *tmp;
 651         struct media_interface *intf;
 652         unsigned int i;
 653
 654         ida_free(&mdev->entity_internal_idx, entity->internal_idx);
 655
 656         /* Remove all interface links pointing to this entity */
 657         list_for_each_entry(intf, &mdev->interfaces, graph_obj.list) {
 658                 list_for_each_entry_safe(link, tmp, &intf->links, list) {
 659                         if (link->entity == entity)
 660                                 __media_remove_intf_link(link);
 661                 }
 662         }
 663
 664         /* Remove all data links that belong to this entity */
 665         __media_entity_remove_links(entity);
 666
 667         /* Remove all pads that belong to this entity */
 668         for (i = 0; i < entity->num_pads; i++)
 669                 media_gobj_destroy(&entity->pads[i].graph_obj);
 670
 671         /* Remove the entity */
 672         media_gobj_destroy(&entity->graph_obj);
 673
 674         /* invoke entity_notify callbacks to handle entity removal?? */
 675
 676         entity->graph_obj.mdev = NULL;
 677 }
 678
 679 void media_device_unregister_entity(struct media_entity *entity)
 680 {
 681         struct media_device *mdev = entity->graph_obj.mdev;
 682
 683         if (mdev == NULL)
 684                 return;
 685
 686         mutex_lock(&mdev->graph_mutex);
 687         __media_device_unregister_entity(entity);
 688         mutex_unlock(&mdev->graph_mutex);
 689 }
 690 EXPORT_SYMBOL_GPL(media_device_unregister_entity);
 691
 692 /**
 693  * media_device_init() - initialize a media device
 694  * @mdev:       The media device
 695  *
 696  * The caller is responsible for initializing the media device before
 697  * registration. The following fields must be set:
 698  *
 699  * - dev must point to the parent device
 700  * - model must be filled with the device model name
 701  */
 702 void media_device_init(struct media_device *mdev)
 703 {
 704         INIT_LIST_HEAD(&mdev->entities);
 705         INIT_LIST_HEAD(&mdev->interfaces);
 706         INIT_LIST_HEAD(&mdev->pads);
 707         INIT_LIST_HEAD(&mdev->links);
 708         INIT_LIST_HEAD(&mdev->entity_notify);
 709
 710         mutex_init(&mdev->req_queue_mutex);
 711         mutex_init(&mdev->graph_mutex);
 712         ida_init(&mdev->entity_internal_idx);
 713
 714         atomic_set(&mdev->request_id, 0);
 715
 716         dev_dbg(mdev->dev, "Media device initialized\n");
 717 }
 718 EXPORT_SYMBOL_GPL(media_device_init);
 719
 720 void media_device_cleanup(struct media_device *mdev)
 721 {
 722         ida_destroy(&mdev->entity_internal_idx);
 723         mdev->entity_internal_idx_max = 0;
 724         media_graph_walk_cleanup(&mdev->pm_count_walk);
 725         mutex_destroy(&mdev->graph_mutex);
 726         mutex_destroy(&mdev->req_queue_mutex);
 727 }
 728 EXPORT_SYMBOL_GPL(media_device_cleanup);
 729
 730 int __must_check __media_device_register(struct media_device *mdev,
 731                                          struct module *owner)
 732 {
 733         struct media_devnode *devnode;
 734         int ret;
 735
 736         devnode = kzalloc(sizeof(*devnode), GFP_KERNEL);
 737         if (!devnode)
 738                 return -ENOMEM;
 739
 740         /* Register the device node. */
 741         mdev->devnode = devnode;
 742         devnode->fops = &media_device_fops;
 743         devnode->parent = mdev->dev;
 744         devnode->release = media_device_release;
 745
 746         /* Set version 0 to indicate user-space that the graph is static */
 747         mdev->topology_version = 0;
 748
 749         ret = media_devnode_register(mdev, devnode, owner);
 750         if (ret < 0) {
 751                 /* devnode free is handled in media_devnode_*() */
 752                 mdev->devnode = NULL;
 753                 return ret;
 754         }
 755
 756         ret = device_create_file(&devnode->dev, &dev_attr_model);
 757         if (ret < 0) {
 758                 /* devnode free is handled in media_devnode_*() */
 759                 mdev->devnode = NULL;
 760                 media_devnode_unregister_prepare(devnode);
 761                 media_devnode_unregister(devnode);
 762                 return ret;
 763         }
 764
 765         dev_dbg(mdev->dev, "Media device registered\n");
 766
 767         return 0;
 768 }
 769 EXPORT_SYMBOL_GPL(__media_device_register);
 770
 771 int __must_check media_device_register_entity_notify(struct media_device *mdev,
 772                                         struct media_entity_notify *nptr)
 773 {
 774         mutex_lock(&mdev->graph_mutex);
 775         list_add_tail(&nptr->list, &mdev->entity_notify);
 776         mutex_unlock(&mdev->graph_mutex);
 777         return 0;
 778 }
 779 EXPORT_SYMBOL_GPL(media_device_register_entity_notify);
 780
 781 /*
 782  * Note: Should be called with mdev->lock held.
 783  */
 784 static void __media_device_unregister_entity_notify(struct media_device *mdev,
 785                                         struct media_entity_notify *nptr)
 786 {
 787         list_del(&nptr->list);
 788 }
 789
 790 void media_device_unregister_entity_notify(struct media_device *mdev,
 791                                         struct media_entity_notify *nptr)
 792 {
 793         mutex_lock(&mdev->graph_mutex);
 794         __media_device_unregister_entity_notify(mdev, nptr);
 795         mutex_unlock(&mdev->graph_mutex);
 796 }
 797 EXPORT_SYMBOL_GPL(media_device_unregister_entity_notify);
 798
 799 void media_device_unregister(struct media_device *mdev)
 800 {
 801         struct media_entity *entity;
 802         struct media_entity *next;
 803         struct media_interface *intf, *tmp_intf;
 804         struct media_entity_notify *notify, *nextp;
 805
 806         if (mdev == NULL)
 807                 return;
 808
 809         mutex_lock(&mdev->graph_mutex);
 810
 811         /* Check if mdev was ever registered at all */
 812         if (!media_devnode_is_registered(mdev->devnode)) {
 813                 mutex_unlock(&mdev->graph_mutex);
 814                 return;
 815         }
 816
 817         /* Clear the devnode register bit to avoid races with media dev open */
 818         media_devnode_unregister_prepare(mdev->devnode);
 819
 820         /* Remove all entities from the media device */
 821         list_for_each_entry_safe(entity, next, &mdev->entities, graph_obj.list)
 822                 __media_device_unregister_entity(entity);
 823
 824         /* Remove all entity_notify callbacks from the media device */
 825         list_for_each_entry_safe(notify, nextp, &mdev->entity_notify, list)
 826                 __media_device_unregister_entity_notify(mdev, notify);
 827
 828         /* Remove all interfaces from the media device */
 829         list_for_each_entry_safe(intf, tmp_intf, &mdev->interfaces,
 830                                  graph_obj.list) {
 831                 /*
 832                  * Unlink the interface, but don't free it here; the
 833                  * module which created it is responsible for freeing
 834                  * it
 835                  */
 836                 __media_remove_intf_links(intf);
 837                 media_gobj_destroy(&intf->graph_obj);
 838         }
 839
 840         mutex_unlock(&mdev->graph_mutex);
 841
 842         dev_dbg(mdev->dev, "Media device unregistered\n");
 843
 844         device_remove_file(&mdev->devnode->dev, &dev_attr_model);
 845         media_devnode_unregister(mdev->devnode);
 846         /* devnode free is handled in media_devnode_*() */
 847         mdev->devnode = NULL;
 848 }
 849 EXPORT_SYMBOL_GPL(media_device_unregister);
 850
 851 #if IS_ENABLED(CONFIG_PCI)
 852 void media_device_pci_init(struct media_device *mdev,
 853                            struct pci_dev *pci_dev,
 854                            const char *name)
 855 {
 856         mdev->dev = &pci_dev->dev;
 857
 858         if (name)
 859                 strscpy(mdev->model, name, sizeof(mdev->model));
 860         else
 861                 strscpy(mdev->model, pci_name(pci_dev), sizeof(mdev->model));
 862
 863         sprintf(mdev->bus_info, "PCI:%s", pci_name(pci_dev));
 864
 865         mdev->hw_revision = (pci_dev->subsystem_vendor << 16)
 866                             | pci_dev->subsystem_device;
 867
 868         media_device_init(mdev);
 869 }
 870 EXPORT_SYMBOL_GPL(media_device_pci_init);
 871 #endif
 872
 873 #if IS_ENABLED(CONFIG_USB)
 874 void __media_device_usb_init(struct media_device *mdev,
 875                              struct usb_device *udev,
 876                              const char *board_name,
 877                              const char *driver_name)
 878 {
 879         mdev->dev = &udev->dev;
 880
 881         if (driver_name)
 882                 strscpy(mdev->driver_name, driver_name,
 883                         sizeof(mdev->driver_name));
 884
 885         if (board_name)
 886                 strscpy(mdev->model, board_name, sizeof(mdev->model));
 887         else if (udev->product)
 888                 strscpy(mdev->model, udev->product, sizeof(mdev->model));
 889         else
 890                 strscpy(mdev->model, "unknown model", sizeof(mdev->model));
 891         if (udev->serial)
 892                 strscpy(mdev->serial, udev->serial, sizeof(mdev->serial));
 893         usb_make_path(udev, mdev->bus_info, sizeof(mdev->bus_info));
 894         mdev->hw_revision = le16_to_cpu(udev->descriptor.bcdDevice);
 895
 896         media_device_init(mdev);
 897 }
 898 EXPORT_SYMBOL_GPL(__media_device_usb_init);
 899 #endif
 900
 901
 902 #endif /* CONFIG_MEDIA_CONTROLLER */