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