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