include/media/media-device.h

   1 /*
   2  * Media device
   3  *
   4  * Copyright (C) 2010 Nokia Corporation
   5  *
   6  * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
   7  *           Sakari Ailus <sakari.ailus@iki.fi>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2 as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifndef _MEDIA_DEVICE_H
  24 #define _MEDIA_DEVICE_H
  25
  26 #include <linux/device.h>
  27 #include <linux/list.h>
  28 #include <linux/spinlock.h>
  29
  30 #include <media/media-devnode.h>
  31 #include <media/media-entity.h>
  32
  33 /**
  34  * struct media_device - Media device
  35  * @dev:        Parent device
  36  * @devnode:    Media device node
  37  * @model:      Device model name
  38  * @serial:     Device serial number (optional)
  39  * @bus_info:   Unique and stable device location identifier
  40  * @hw_revision: Hardware device revision
  41  * @driver_version: Device driver version
  42  * @entity_id:  ID of the next entity to be registered
  43  * @entities:   List of registered entities
  44  * @lock:       Entities list lock
  45  *
  46  * This structure represents an abstract high-level media device. It allows easy
  47  * access to entities and provides basic media device-level support. The
  48  * structure can be allocated directly or embedded in a larger structure.
  49  *
  50  * The parent @dev is a physical device. It must be set before registering the
  51  * media device.
  52  *
  53  * @model is a descriptive model name exported through sysfs. It doesn't have to
  54  * be unique.
  55  */
  56 struct media_device {
  57         /* dev->driver_data points to this struct. */
  58         struct device *dev;
  59         struct media_devnode devnode;
  60
  61         char model[32];
  62         char serial[40];
  63         char bus_info[32];
  64         u32 hw_revision;
  65         u32 driver_version;
  66
  67         u32 entity_id;
  68         struct list_head entities;
  69
  70         /* Protects the entities list */
  71         spinlock_t lock;
  72 };
  73
  74 /* media_devnode to media_device */
  75 #define to_media_device(node) container_of(node, struct media_device, devnode)
  76
  77 int __must_check media_device_register(struct media_device *mdev);
  78 void media_device_unregister(struct media_device *mdev);
  79
  80 int __must_check media_device_register_entity(struct media_device *mdev,
  81                                               struct media_entity *entity);
  82 void media_device_unregister_entity(struct media_entity *entity);
  83
  84 /* Iterate over all entities. */
  85 #define media_device_for_each_entity(entity, mdev)                      \
  86         list_for_each_entry(entity, &(mdev)->entities, list)
  87
  88 #endif