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/list.h>
  27 #include <linux/mutex.h>
  28 #include <linux/spinlock.h>
  29
  30 #include <media/media-devnode.h>
  31 #include <media/media-entity.h>
  32
  33 struct device;
  34
  35 /**
  36  * struct media_device - Media device
  37  * @dev:        Parent device
  38  * @devnode:    Media device node
  39  * @model:      Device model name
  40  * @serial:     Device serial number (optional)
  41  * @bus_info:   Unique and stable device location identifier
  42  * @hw_revision: Hardware device revision
  43  * @driver_version: Device driver version
  44  * @entity_id:  Unique ID used on the last entity registered
  45  * @pad_id:     Unique ID used on the last pad registered
  46  * @link_id:    Unique ID used on the last link registered
  47  * @intf_devnode_id: Unique ID used on the last interface devnode registered
  48  * @entities:   List of registered entities
  49  * @interfaces: List of registered interfaces
  50  * @lock:       Entities list lock
  51  * @graph_mutex: Entities graph operation lock
  52  * @link_notify: Link state change notification callback
  53  *
  54  * This structure represents an abstract high-level media device. It allows easy
  55  * access to entities and provides basic media device-level support. The
  56  * structure can be allocated directly or embedded in a larger structure.
  57  *
  58  * The parent @dev is a physical device. It must be set before registering the
  59  * media device.
  60  *
  61  * @model is a descriptive model name exported through sysfs. It doesn't have to
  62  * be unique.
  63  */
  64 struct media_device {
  65         /* dev->driver_data points to this struct. */
  66         struct device *dev;
  67         struct media_devnode devnode;
  68
  69         char model[32];
  70         char serial[40];
  71         char bus_info[32];
  72         u32 hw_revision;
  73         u32 driver_version;
  74
  75         u32 entity_id;
  76         u32 pad_id;
  77         u32 link_id;
  78         u32 intf_devnode_id;
  79
  80         struct list_head entities;
  81         struct list_head interfaces;
  82
  83         /* Protects the entities list */
  84         spinlock_t lock;
  85         /* Serializes graph operations. */
  86         struct mutex graph_mutex;
  87
  88         int (*link_notify)(struct media_link *link, u32 flags,
  89                            unsigned int notification);
  90 };
  91
  92 #ifdef CONFIG_MEDIA_CONTROLLER
  93
  94 /* Supported link_notify @notification values. */
  95 #define MEDIA_DEV_NOTIFY_PRE_LINK_CH    0
  96 #define MEDIA_DEV_NOTIFY_POST_LINK_CH   1
  97
  98 /* media_devnode to media_device */
  99 #define to_media_device(node) container_of(node, struct media_device, devnode)
 100
 101 int __must_check __media_device_register(struct media_device *mdev,
 102                                          struct module *owner);
 103 #define media_device_register(mdev) __media_device_register(mdev, THIS_MODULE)
 104 void media_device_unregister(struct media_device *mdev);
 105
 106 int __must_check media_device_register_entity(struct media_device *mdev,
 107                                               struct media_entity *entity);
 108 void media_device_unregister_entity(struct media_entity *entity);
 109 struct media_device *media_device_get_devres(struct device *dev);
 110 struct media_device *media_device_find_devres(struct device *dev);
 111
 112 /* Iterate over all entities. */
 113 #define media_device_for_each_entity(entity, mdev)                      \
 114         list_for_each_entry(entity, &(mdev)->entities, graph_obj.list)
 115
 116 /* Iterate over all interfaces. */
 117 #define media_device_for_each_intf(intf, mdev)                  \
 118         list_for_each_entry(intf, &(mdev)->interfaces, graph_obj.list)
 119
 120
 121 #else
 122 static inline int media_device_register(struct media_device *mdev)
 123 {
 124         return 0;
 125 }
 126 static inline void media_device_unregister(struct media_device *mdev)
 127 {
 128 }
 129 static inline int media_device_register_entity(struct media_device *mdev,
 130                                                 struct media_entity *entity)
 131 {
 132         return 0;
 133 }
 134 static inline void media_device_unregister_entity(struct media_entity *entity)
 135 {
 136 }
 137 static inline struct media_device *media_device_get_devres(struct device *dev)
 138 {
 139         return NULL;
 140 }
 141 static inline struct media_device *media_device_find_devres(struct device *dev)
 142 {
 143         return NULL;
 144 }
 145 #endif /* CONFIG_MEDIA_CONTROLLER */
 146 #endif