Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 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 | |
Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 26 | #include <linux/list.h> |
Laurent Pinchart | 503c3d82 | 2010-03-07 15:04:59 -0300 | [diff] [blame] | 27 | #include <linux/mutex.h> |
Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 28 | |
| 29 | #include <media/media-devnode.h> |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 30 | #include <media/media-entity.h> |
Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 31 | |
Sakari Ailus | 665faa9 | 2015-12-16 11:32:17 -0200 | [diff] [blame] | 32 | struct ida; |
Paul Gortmaker | 313162d | 2012-01-30 11:46:54 -0500 | [diff] [blame] | 33 | struct device; |
| 34 | |
Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 35 | /** |
Shuah Khan | afcbdb5 | 2016-02-11 21:41:21 -0200 | [diff] [blame] | 36 | * struct media_entity_notify - Media Entity Notify |
| 37 | * |
| 38 | * @list: List head |
| 39 | * @notify_data: Input data to invoke the callback |
| 40 | * @notify: Callback function pointer |
| 41 | * |
| 42 | * Drivers may register a callback to take action when |
| 43 | * new entities get registered with the media device. |
| 44 | */ |
| 45 | struct media_entity_notify { |
| 46 | struct list_head list; |
| 47 | void *notify_data; |
| 48 | void (*notify)(struct media_entity *entity, void *notify_data); |
| 49 | }; |
| 50 | |
| 51 | /** |
Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 52 | * struct media_device - Media device |
| 53 | * @dev: Parent device |
| 54 | * @devnode: Media device node |
Mauro Carvalho Chehab | bb07bd6 | 2016-02-11 14:24:23 -0200 | [diff] [blame] | 55 | * @driver_name: Optional device driver name. If not set, calls to |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 56 | * %MEDIA_IOC_DEVICE_INFO will return ``dev->driver->name``. |
Mauro Carvalho Chehab | bb07bd6 | 2016-02-11 14:24:23 -0200 | [diff] [blame] | 57 | * This is needed for USB drivers for example, as otherwise |
| 58 | * they'll all appear as if the driver name was "usb". |
Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 59 | * @model: Device model name |
| 60 | * @serial: Device serial number (optional) |
| 61 | * @bus_info: Unique and stable device location identifier |
| 62 | * @hw_revision: Hardware device revision |
| 63 | * @driver_version: Device driver version |
Mauro Carvalho Chehab | 2521fda | 2015-08-23 09:40:26 -0300 | [diff] [blame] | 64 | * @topology_version: Monotonic counter for storing the version of the graph |
| 65 | * topology. Should be incremented each time the topology changes. |
Mauro Carvalho Chehab | 05b3b77 | 2015-12-16 14:28:01 -0200 | [diff] [blame] | 66 | * @id: Unique ID used on the last registered graph object |
Mauro Carvalho Chehab | 03e4933 | 2015-12-16 13:58:31 -0200 | [diff] [blame] | 67 | * @entity_internal_idx: Unique internal entity ID used by the graph traversal |
| 68 | * algorithms |
| 69 | * @entity_internal_idx_max: Allocated internal entity indices |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 70 | * @entities: List of registered entities |
Mauro Carvalho Chehab | 57cf79b | 2015-08-21 09:23:22 -0300 | [diff] [blame] | 71 | * @interfaces: List of registered interfaces |
Mauro Carvalho Chehab | 9155d85 | 2015-08-23 08:00:33 -0300 | [diff] [blame] | 72 | * @pads: List of registered pads |
| 73 | * @links: List of registered links |
Shuah Khan | afcbdb5 | 2016-02-11 21:41:21 -0200 | [diff] [blame] | 74 | * @entity_notify: List of registered entity_notify callbacks |
Mauro Carvalho Chehab | e2c91d4 | 2016-04-06 10:55:24 -0300 | [diff] [blame] | 75 | * @graph_mutex: Protects access to struct media_device data |
Sakari Ailus | 0c426c4 | 2016-02-21 13:25:08 -0300 | [diff] [blame] | 76 | * @pm_count_walk: Graph walk for power state walk. Access serialised using |
| 77 | * graph_mutex. |
Shuah Khan | cd87ce8 | 2016-02-11 21:41:22 -0200 | [diff] [blame] | 78 | * |
| 79 | * @source_priv: Driver Private data for enable/disable source handlers |
| 80 | * @enable_source: Enable Source Handler function pointer |
| 81 | * @disable_source: Disable Source Handler function pointer |
| 82 | * |
Mauro Carvalho Chehab | 5ed470f | 2016-04-06 10:55:25 -0300 | [diff] [blame] | 83 | * @link_notify: Link state change notification callback. This callback is |
| 84 | * called with the graph_mutex held. |
Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 85 | * |
| 86 | * This structure represents an abstract high-level media device. It allows easy |
| 87 | * access to entities and provides basic media device-level support. The |
| 88 | * structure can be allocated directly or embedded in a larger structure. |
| 89 | * |
| 90 | * The parent @dev is a physical device. It must be set before registering the |
| 91 | * media device. |
| 92 | * |
| 93 | * @model is a descriptive model name exported through sysfs. It doesn't have to |
| 94 | * be unique. |
Shuah Khan | cd87ce8 | 2016-02-11 21:41:22 -0200 | [diff] [blame] | 95 | * |
| 96 | * @enable_source is a handler to find source entity for the |
| 97 | * sink entity and activate the link between them if source |
| 98 | * entity is free. Drivers should call this handler before |
| 99 | * accessing the source. |
| 100 | * |
| 101 | * @disable_source is a handler to find source entity for the |
| 102 | * sink entity and deactivate the link between them. Drivers |
| 103 | * should call this handler to release the source. |
| 104 | * |
Shuah Khan | cd87ce8 | 2016-02-11 21:41:22 -0200 | [diff] [blame] | 105 | * Use-case: find tuner entity connected to the decoder |
| 106 | * entity and check if it is available, and activate the |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 107 | * the link between them from @enable_source and deactivate |
| 108 | * from @disable_source. |
| 109 | * |
| 110 | * .. note:: |
| 111 | * |
| 112 | * Bridge driver is expected to implement and set the |
| 113 | * handler when &media_device is registered or when |
| 114 | * bridge driver finds the media_device during probe. |
| 115 | * Bridge driver sets source_priv with information |
| 116 | * necessary to run @enable_source and @disable_source handlers. |
Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 117 | */ |
| 118 | struct media_device { |
| 119 | /* dev->driver_data points to this struct. */ |
| 120 | struct device *dev; |
Mauro Carvalho Chehab | a087ce7 | 2016-04-27 19:28:26 -0300 | [diff] [blame] | 121 | struct media_devnode *devnode; |
Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 122 | |
| 123 | char model[32]; |
Mauro Carvalho Chehab | bb07bd6 | 2016-02-11 14:24:23 -0200 | [diff] [blame] | 124 | char driver_name[32]; |
Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 125 | char serial[40]; |
| 126 | char bus_info[32]; |
| 127 | u32 hw_revision; |
| 128 | u32 driver_version; |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 129 | |
Mauro Carvalho Chehab | 952f8ee | 2016-03-16 05:34:39 -0700 | [diff] [blame] | 130 | u64 topology_version; |
Mauro Carvalho Chehab | 2521fda | 2015-08-23 09:40:26 -0300 | [diff] [blame] | 131 | |
Mauro Carvalho Chehab | 05b3b77 | 2015-12-16 14:28:01 -0200 | [diff] [blame] | 132 | u32 id; |
Sakari Ailus | 665faa9 | 2015-12-16 11:32:17 -0200 | [diff] [blame] | 133 | struct ida entity_internal_idx; |
| 134 | int entity_internal_idx_max; |
Mauro Carvalho Chehab | bfab2aac | 2015-08-14 12:47:48 -0300 | [diff] [blame] | 135 | |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 136 | struct list_head entities; |
Mauro Carvalho Chehab | 57cf79b | 2015-08-21 09:23:22 -0300 | [diff] [blame] | 137 | struct list_head interfaces; |
Mauro Carvalho Chehab | 9155d85 | 2015-08-23 08:00:33 -0300 | [diff] [blame] | 138 | struct list_head pads; |
| 139 | struct list_head links; |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 140 | |
Shuah Khan | afcbdb5 | 2016-02-11 21:41:21 -0200 | [diff] [blame] | 141 | /* notify callback list invoked when a new entity is registered */ |
| 142 | struct list_head entity_notify; |
| 143 | |
Laurent Pinchart | 503c3d82 | 2010-03-07 15:04:59 -0300 | [diff] [blame] | 144 | /* Serializes graph operations. */ |
| 145 | struct mutex graph_mutex; |
Sakari Ailus | 0c426c4 | 2016-02-21 13:25:08 -0300 | [diff] [blame] | 146 | struct media_entity_graph pm_count_walk; |
Laurent Pinchart | 97548ed | 2009-12-09 08:40:03 -0300 | [diff] [blame] | 147 | |
Shuah Khan | cd87ce8 | 2016-02-11 21:41:22 -0200 | [diff] [blame] | 148 | void *source_priv; |
| 149 | int (*enable_source)(struct media_entity *entity, |
| 150 | struct media_pipeline *pipe); |
| 151 | void (*disable_source)(struct media_entity *entity); |
| 152 | |
Sylwester Nawrocki | 813f5c0 | 2013-05-31 10:37:26 -0300 | [diff] [blame] | 153 | int (*link_notify)(struct media_link *link, u32 flags, |
| 154 | unsigned int notification); |
Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 155 | }; |
| 156 | |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 157 | /* We don't need to include pci.h or usb.h here */ |
| 158 | struct pci_dev; |
| 159 | struct usb_device; |
| 160 | |
Shuah Khan | e576d60 | 2015-06-05 17:11:54 -0300 | [diff] [blame] | 161 | #ifdef CONFIG_MEDIA_CONTROLLER |
| 162 | |
Sylwester Nawrocki | 813f5c0 | 2013-05-31 10:37:26 -0300 | [diff] [blame] | 163 | /* Supported link_notify @notification values. */ |
| 164 | #define MEDIA_DEV_NOTIFY_PRE_LINK_CH 0 |
| 165 | #define MEDIA_DEV_NOTIFY_POST_LINK_CH 1 |
| 166 | |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 167 | /** |
Sakari Ailus | c8d54cd | 2015-12-16 11:44:32 -0200 | [diff] [blame] | 168 | * media_entity_enum_init - Initialise an entity enumeration |
| 169 | * |
Mauro Carvalho Chehab | 03e4933 | 2015-12-16 13:58:31 -0200 | [diff] [blame] | 170 | * @ent_enum: Entity enumeration to be initialised |
Sakari Ailus | c8d54cd | 2015-12-16 11:44:32 -0200 | [diff] [blame] | 171 | * @mdev: The related media device |
| 172 | * |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 173 | * Return: zero on success or a negative error code. |
Sakari Ailus | c8d54cd | 2015-12-16 11:44:32 -0200 | [diff] [blame] | 174 | */ |
| 175 | static inline __must_check int media_entity_enum_init( |
| 176 | struct media_entity_enum *ent_enum, struct media_device *mdev) |
| 177 | { |
| 178 | return __media_entity_enum_init(ent_enum, |
| 179 | mdev->entity_internal_idx_max + 1); |
| 180 | } |
| 181 | |
| 182 | /** |
Javier Martinez Canillas | 9832e15 | 2015-12-11 20:57:08 -0200 | [diff] [blame] | 183 | * media_device_init() - Initializes a media device element |
| 184 | * |
| 185 | * @mdev: pointer to struct &media_device |
| 186 | * |
| 187 | * This function initializes the media device prior to its registration. |
| 188 | * The media device initialization and registration is split in two functions |
| 189 | * to avoid race conditions and make the media device available to user-space |
| 190 | * before the media graph has been completed. |
| 191 | * |
| 192 | * So drivers need to first initialize the media device, register any entity |
| 193 | * within the media device, create pad to pad links and then finally register |
| 194 | * the media device by calling media_device_register() as a final step. |
| 195 | */ |
| 196 | void media_device_init(struct media_device *mdev); |
| 197 | |
| 198 | /** |
| 199 | * media_device_cleanup() - Cleanups a media device element |
| 200 | * |
| 201 | * @mdev: pointer to struct &media_device |
| 202 | * |
| 203 | * This function that will destroy the graph_mutex that is |
| 204 | * initialized in media_device_init(). |
| 205 | */ |
| 206 | void media_device_cleanup(struct media_device *mdev); |
| 207 | |
| 208 | /** |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 209 | * __media_device_register() - Registers a media device element |
| 210 | * |
| 211 | * @mdev: pointer to struct &media_device |
| 212 | * @owner: should be filled with %THIS_MODULE |
| 213 | * |
| 214 | * Users, should, instead, call the media_device_register() macro. |
| 215 | * |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 216 | * The caller is responsible for initializing the &media_device structure |
| 217 | * before registration. The following fields of &media_device must be set: |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 218 | * |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 219 | * - &media_entity.dev must point to the parent device (usually a &pci_dev, |
| 220 | * &usb_interface or &platform_device instance). |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 221 | * |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 222 | * - &media_entity.model must be filled with the device model name as a |
| 223 | * NUL-terminated UTF-8 string. The device/model revision must not be |
| 224 | * stored in this field. |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 225 | * |
| 226 | * The following fields are optional: |
| 227 | * |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 228 | * - &media_entity.serial is a unique serial number stored as a |
| 229 | * NUL-terminated ASCII string. The field is big enough to store a GUID |
| 230 | * in text form. If the hardware doesn't provide a unique serial number |
| 231 | * this field must be left empty. |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 232 | * |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 233 | * - &media_entity.bus_info represents the location of the device in the |
| 234 | * system as a NUL-terminated ASCII string. For PCI/PCIe devices |
| 235 | * &media_entity.bus_info must be set to "PCI:" (or "PCIe:") followed by |
| 236 | * the value of pci_name(). For USB devices,the usb_make_path() function |
| 237 | * must be used. This field is used by applications to distinguish between |
| 238 | * otherwise identical devices that don't provide a serial number. |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 239 | * |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 240 | * - &media_entity.hw_revision is the hardware device revision in a |
| 241 | * driver-specific format. When possible the revision should be formatted |
| 242 | * with the KERNEL_VERSION() macro. |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 243 | * |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 244 | * - &media_entity.driver_version is formatted with the KERNEL_VERSION() |
| 245 | * macro. The version minor must be incremented when new features are added |
| 246 | * to the userspace API without breaking binary compatibility. The version |
| 247 | * major must be incremented when binary compatibility is broken. |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 248 | * |
Mauro Carvalho Chehab | 74604b7 | 2016-07-17 09:18:03 -0300 | [diff] [blame] | 249 | * .. note:: |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 250 | * |
Mauro Carvalho Chehab | 74604b7 | 2016-07-17 09:18:03 -0300 | [diff] [blame] | 251 | * #) Upon successful registration a character device named media[0-9]+ is created. The device major and minor numbers are dynamic. The model name is exported as a sysfs attribute. |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 252 | * |
Mauro Carvalho Chehab | 74604b7 | 2016-07-17 09:18:03 -0300 | [diff] [blame] | 253 | * #) Unregistering a media device that hasn't been registered is **NOT** safe. |
Mauro Carvalho Chehab | 9277799 | 2015-12-16 13:53:04 -0200 | [diff] [blame] | 254 | * |
| 255 | * Return: returns zero on success or a negative error code. |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 256 | */ |
Sakari Ailus | 85de721 | 2013-12-12 12:38:17 -0300 | [diff] [blame] | 257 | int __must_check __media_device_register(struct media_device *mdev, |
| 258 | struct module *owner); |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 259 | |
| 260 | |
| 261 | /** |
| 262 | * media_device_register() - Registers a media device element |
| 263 | * |
| 264 | * @mdev: pointer to struct &media_device |
| 265 | * |
| 266 | * This macro calls __media_device_register() passing %THIS_MODULE as |
| 267 | * the __media_device_register() second argument (**owner**). |
| 268 | */ |
Sakari Ailus | 85de721 | 2013-12-12 12:38:17 -0300 | [diff] [blame] | 269 | #define media_device_register(mdev) __media_device_register(mdev, THIS_MODULE) |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 270 | |
| 271 | /** |
Mauro Carvalho Chehab | 3047f3f | 2016-03-16 05:04:03 -0700 | [diff] [blame] | 272 | * media_device_unregister() - Unregisters a media device element |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 273 | * |
| 274 | * @mdev: pointer to struct &media_device |
Mauro Carvalho Chehab | 9277799 | 2015-12-16 13:53:04 -0200 | [diff] [blame] | 275 | * |
Mauro Carvalho Chehab | 9277799 | 2015-12-16 13:53:04 -0200 | [diff] [blame] | 276 | * It is safe to call this function on an unregistered (but initialised) |
| 277 | * media device. |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 278 | */ |
Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 279 | void media_device_unregister(struct media_device *mdev); |
| 280 | |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 281 | /** |
| 282 | * media_device_register_entity() - registers a media entity inside a |
| 283 | * previously registered media device. |
| 284 | * |
| 285 | * @mdev: pointer to struct &media_device |
| 286 | * @entity: pointer to struct &media_entity to be registered |
| 287 | * |
| 288 | * Entities are identified by a unique positive integer ID. The media |
| 289 | * controller framework will such ID automatically. IDs are not guaranteed |
| 290 | * to be contiguous, and the ID number can change on newer Kernel versions. |
| 291 | * So, neither the driver nor userspace should hardcode ID numbers to refer |
| 292 | * to the entities, but, instead, use the framework to find the ID, when |
| 293 | * needed. |
| 294 | * |
| 295 | * The media_entity name, type and flags fields should be initialized before |
| 296 | * calling media_device_register_entity(). Entities embedded in higher-level |
| 297 | * standard structures can have some of those fields set by the higher-level |
| 298 | * framework. |
| 299 | * |
| 300 | * If the device has pads, media_entity_pads_init() should be called before |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 301 | * this function. Otherwise, the &media_entity.pad and &media_entity.num_pads |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 302 | * should be zeroed before calling this function. |
| 303 | * |
| 304 | * Entities have flags that describe the entity capabilities and state: |
| 305 | * |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 306 | * %MEDIA_ENT_FL_DEFAULT |
| 307 | * indicates the default entity for a given type. |
| 308 | * This can be used to report the default audio and video devices or the |
| 309 | * default camera sensor. |
Mauro Carvalho Chehab | d1b9da2 | 2015-12-11 12:41:12 -0200 | [diff] [blame] | 310 | * |
Mauro Carvalho Chehab | 74604b7 | 2016-07-17 09:18:03 -0300 | [diff] [blame] | 311 | * .. note:: |
| 312 | * |
| 313 | * Drivers should set the entity function before calling this function. |
| 314 | * Please notice that the values %MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN and |
| 315 | * %MEDIA_ENT_F_UNKNOWN should not be used by the drivers. |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 316 | */ |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 317 | int __must_check media_device_register_entity(struct media_device *mdev, |
| 318 | struct media_entity *entity); |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 319 | |
Mauro Carvalho Chehab | 74604b7 | 2016-07-17 09:18:03 -0300 | [diff] [blame] | 320 | /** |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 321 | * media_device_unregister_entity() - unregisters a media entity. |
| 322 | * |
| 323 | * @entity: pointer to struct &media_entity to be unregistered |
| 324 | * |
| 325 | * All links associated with the entity and all PADs are automatically |
| 326 | * unregistered from the media_device when this function is called. |
| 327 | * |
| 328 | * Unregistering an entity will not change the IDs of the other entities and |
| 329 | * the previoully used ID will never be reused for a newly registered entities. |
| 330 | * |
| 331 | * When a media device is unregistered, all its entities are unregistered |
| 332 | * automatically. No manual entities unregistration is then required. |
| 333 | * |
Mauro Carvalho Chehab | 74604b7 | 2016-07-17 09:18:03 -0300 | [diff] [blame] | 334 | * .. note:: |
| 335 | * |
| 336 | * The media_entity instance itself must be freed explicitly by |
| 337 | * the driver if required. |
Mauro Carvalho Chehab | db7ee32 | 2015-12-11 11:06:08 -0200 | [diff] [blame] | 338 | */ |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 339 | void media_device_unregister_entity(struct media_entity *entity); |
Mauro Carvalho Chehab | b6e4ca8 | 2015-12-13 08:36:58 -0200 | [diff] [blame] | 340 | |
| 341 | /** |
Shuah Khan | afcbdb5 | 2016-02-11 21:41:21 -0200 | [diff] [blame] | 342 | * media_device_register_entity_notify() - Registers a media entity_notify |
| 343 | * callback |
| 344 | * |
| 345 | * @mdev: The media device |
| 346 | * @nptr: The media_entity_notify |
| 347 | * |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 348 | * .. note:: |
| 349 | * |
| 350 | * When a new entity is registered, all the registered |
| 351 | * media_entity_notify callbacks are invoked. |
Shuah Khan | afcbdb5 | 2016-02-11 21:41:21 -0200 | [diff] [blame] | 352 | */ |
| 353 | |
| 354 | int __must_check media_device_register_entity_notify(struct media_device *mdev, |
| 355 | struct media_entity_notify *nptr); |
| 356 | |
| 357 | /** |
| 358 | * media_device_unregister_entity_notify() - Unregister a media entity notify |
| 359 | * callback |
| 360 | * |
| 361 | * @mdev: The media device |
| 362 | * @nptr: The media_entity_notify |
| 363 | * |
| 364 | */ |
| 365 | void media_device_unregister_entity_notify(struct media_device *mdev, |
| 366 | struct media_entity_notify *nptr); |
| 367 | |
| 368 | /** |
Mauro Carvalho Chehab | b6e4ca8 | 2015-12-13 08:36:58 -0200 | [diff] [blame] | 369 | * media_device_get_devres() - get media device as device resource |
| 370 | * creates if one doesn't exist |
| 371 | * |
| 372 | * @dev: pointer to struct &device. |
| 373 | * |
| 374 | * Sometimes, the media controller &media_device needs to be shared by more |
| 375 | * than one driver. This function adds support for that, by dynamically |
| 376 | * allocating the &media_device and allowing it to be obtained from the |
| 377 | * struct &device associated with the common device where all sub-device |
| 378 | * components belong. So, for example, on an USB device with multiple |
| 379 | * interfaces, each interface may be handled by a separate per-interface |
| 380 | * drivers. While each interface have its own &device, they all share a |
| 381 | * common &device associated with the hole USB device. |
| 382 | */ |
Shuah Khan | d062f91 | 2015-06-03 12:12:53 -0300 | [diff] [blame] | 383 | struct media_device *media_device_get_devres(struct device *dev); |
Mauro Carvalho Chehab | b6e4ca8 | 2015-12-13 08:36:58 -0200 | [diff] [blame] | 384 | |
| 385 | /** |
| 386 | * media_device_find_devres() - find media device as device resource |
| 387 | * |
| 388 | * @dev: pointer to struct &device. |
| 389 | */ |
Shuah Khan | d062f91 | 2015-06-03 12:12:53 -0300 | [diff] [blame] | 390 | struct media_device *media_device_find_devres(struct device *dev); |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 391 | |
| 392 | /* Iterate over all entities. */ |
| 393 | #define media_device_for_each_entity(entity, mdev) \ |
Mauro Carvalho Chehab | 05bfa9f | 2015-08-23 07:51:33 -0300 | [diff] [blame] | 394 | list_for_each_entry(entity, &(mdev)->entities, graph_obj.list) |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 395 | |
Mauro Carvalho Chehab | cf975a4 | 2015-08-23 07:51:22 -0300 | [diff] [blame] | 396 | /* Iterate over all interfaces. */ |
| 397 | #define media_device_for_each_intf(intf, mdev) \ |
Mauro Carvalho Chehab | 05bfa9f | 2015-08-23 07:51:33 -0300 | [diff] [blame] | 398 | list_for_each_entry(intf, &(mdev)->interfaces, graph_obj.list) |
Mauro Carvalho Chehab | cf975a4 | 2015-08-23 07:51:22 -0300 | [diff] [blame] | 399 | |
Mauro Carvalho Chehab | 9155d85 | 2015-08-23 08:00:33 -0300 | [diff] [blame] | 400 | /* Iterate over all pads. */ |
| 401 | #define media_device_for_each_pad(pad, mdev) \ |
| 402 | list_for_each_entry(pad, &(mdev)->pads, graph_obj.list) |
| 403 | |
| 404 | /* Iterate over all links. */ |
| 405 | #define media_device_for_each_link(link, mdev) \ |
| 406 | list_for_each_entry(link, &(mdev)->links, graph_obj.list) |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 407 | |
| 408 | /** |
| 409 | * media_device_pci_init() - create and initialize a |
| 410 | * struct &media_device from a PCI device. |
| 411 | * |
Mauro Carvalho Chehab | 6cf5dad | 2016-02-22 12:10:49 -0300 | [diff] [blame] | 412 | * @mdev: pointer to struct &media_device |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 413 | * @pci_dev: pointer to struct pci_dev |
| 414 | * @name: media device name. If %NULL, the routine will use the default |
| 415 | * name for the pci device, given by pci_name() macro. |
| 416 | */ |
Mauro Carvalho Chehab | 6cf5dad | 2016-02-22 12:10:49 -0300 | [diff] [blame] | 417 | void media_device_pci_init(struct media_device *mdev, |
| 418 | struct pci_dev *pci_dev, |
| 419 | const char *name); |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 420 | /** |
| 421 | * __media_device_usb_init() - create and initialize a |
| 422 | * struct &media_device from a PCI device. |
| 423 | * |
Mauro Carvalho Chehab | 6cf5dad | 2016-02-22 12:10:49 -0300 | [diff] [blame] | 424 | * @mdev: pointer to struct &media_device |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 425 | * @udev: pointer to struct usb_device |
| 426 | * @board_name: media device name. If %NULL, the routine will use the usb |
| 427 | * product name, if available. |
| 428 | * @driver_name: name of the driver. if %NULL, the routine will use the name |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 429 | * given by ``udev->dev->driver->name``, with is usually the wrong |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 430 | * thing to do. |
| 431 | * |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 432 | * .. note:: |
| 433 | * |
| 434 | * It is better to call media_device_usb_init() instead, as |
| 435 | * such macro fills driver_name with %KBUILD_MODNAME. |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 436 | */ |
Mauro Carvalho Chehab | 6cf5dad | 2016-02-22 12:10:49 -0300 | [diff] [blame] | 437 | void __media_device_usb_init(struct media_device *mdev, |
| 438 | struct usb_device *udev, |
| 439 | const char *board_name, |
| 440 | const char *driver_name); |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 441 | |
Shuah Khan | e576d60 | 2015-06-05 17:11:54 -0300 | [diff] [blame] | 442 | #else |
| 443 | static inline int media_device_register(struct media_device *mdev) |
| 444 | { |
| 445 | return 0; |
| 446 | } |
| 447 | static inline void media_device_unregister(struct media_device *mdev) |
| 448 | { |
| 449 | } |
| 450 | static inline int media_device_register_entity(struct media_device *mdev, |
| 451 | struct media_entity *entity) |
| 452 | { |
| 453 | return 0; |
| 454 | } |
| 455 | static inline void media_device_unregister_entity(struct media_entity *entity) |
| 456 | { |
| 457 | } |
Shuah Khan | afcbdb5 | 2016-02-11 21:41:21 -0200 | [diff] [blame] | 458 | static inline int media_device_register_entity_notify( |
| 459 | struct media_device *mdev, |
| 460 | struct media_entity_notify *nptr) |
| 461 | { |
| 462 | return 0; |
| 463 | } |
| 464 | static inline void media_device_unregister_entity_notify( |
| 465 | struct media_device *mdev, |
| 466 | struct media_entity_notify *nptr) |
| 467 | { |
| 468 | } |
Shuah Khan | e576d60 | 2015-06-05 17:11:54 -0300 | [diff] [blame] | 469 | static inline struct media_device *media_device_get_devres(struct device *dev) |
| 470 | { |
| 471 | return NULL; |
| 472 | } |
| 473 | static inline struct media_device *media_device_find_devres(struct device *dev) |
| 474 | { |
| 475 | return NULL; |
| 476 | } |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 477 | |
Mauro Carvalho Chehab | 6cf5dad | 2016-02-22 12:10:49 -0300 | [diff] [blame] | 478 | static inline void media_device_pci_init(struct media_device *mdev, |
| 479 | struct pci_dev *pci_dev, |
| 480 | char *name) |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 481 | { |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 482 | } |
| 483 | |
Mauro Carvalho Chehab | 6cf5dad | 2016-02-22 12:10:49 -0300 | [diff] [blame] | 484 | static inline void __media_device_usb_init(struct media_device *mdev, |
| 485 | struct usb_device *udev, |
| 486 | char *board_name, |
| 487 | char *driver_name) |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 488 | { |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 489 | } |
| 490 | |
Shuah Khan | e576d60 | 2015-06-05 17:11:54 -0300 | [diff] [blame] | 491 | #endif /* CONFIG_MEDIA_CONTROLLER */ |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 492 | |
Mauro Carvalho Chehab | 48a7c4b | 2016-08-29 16:09:11 -0300 | [diff] [blame] | 493 | /** |
| 494 | * media_device_usb_init() - create and initialize a |
| 495 | * struct &media_device from a PCI device. |
| 496 | * |
| 497 | * @mdev: pointer to struct &media_device |
| 498 | * @udev: pointer to struct usb_device |
| 499 | * @name: media device name. If %NULL, the routine will use the usb |
| 500 | * product name, if available. |
| 501 | * |
| 502 | * This macro calls media_device_usb_init() passing the |
| 503 | * media_device_usb_init() **driver_name** parameter filled with |
| 504 | * %KBUILD_MODNAME. |
| 505 | */ |
Mauro Carvalho Chehab | 6cf5dad | 2016-02-22 12:10:49 -0300 | [diff] [blame] | 506 | #define media_device_usb_init(mdev, udev, name) \ |
| 507 | __media_device_usb_init(mdev, udev, name, KBUILD_MODNAME) |
Mauro Carvalho Chehab | 41b44e3 | 2016-02-22 11:42:04 -0300 | [diff] [blame] | 508 | |
Laurent Pinchart | 176fb0d | 2009-12-09 08:39:58 -0300 | [diff] [blame] | 509 | #endif |