include/media/media-device.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
19 #include <media/media-devnode.h>
20 #include <media/media-entity.h>
26  * struct media_entity_notify - Media Entity Notify
44  * struct media_device_ops - Media device operations
76  * struct media_device - Media device
80  *		%MEDIA_IOC_DEVICE_INFO will return ``dev->driver->name``.
111  * This structure represents an abstract high-level media device. It allows easy
112  * access to entities and provides basic media device-level support. The
118  * @model is a descriptive model name exported through sysfs. It doesn't have to
130  * Use-case: find tuner entity connected to the decoder
146 	/* dev->driver_data points to this struct. */
195  * media_device_init() - Initializes a media device element
201  * to avoid race conditions and make the media device available to user-space
211  * - dev must point to the parent device
212  * - model must be filled with the device model name
220  * media_device_cleanup() - Cleanups a media device element
230  * __media_device_register() - Registers a media device element
240  *  - &media_device.model must be filled with the device model name as a
241  *    NUL-terminated UTF-8 string. The device/model revision must not be
246  *  - &media_device.serial is a unique serial number stored as a
247  *    NUL-terminated ASCII string. The field is big enough to store a GUID
251  *  - &media_device.bus_info represents the location of the device in the
252  *    system as a NUL-terminated ASCII string. For PCI/PCIe devices
258  *  - &media_device.hw_revision is the hardware device revision in a
259  *    driver-specific format. When possible the revision should be formatted
264 …*    #) Upon successful registration a character device named media[0-9]+ is created. The device m…
275  * media_device_register() - Registers a media device element
285  * media_device_unregister() - Unregisters a media device element
295  * media_device_register_entity() - registers a media entity inside a
309  * calling media_device_register_entity(). Entities embedded in higher-level
310  * standard structures can have some of those fields set by the higher-level
334  * media_device_unregister_entity() - unregisters a media entity.
355  * media_device_register_entity_notify() - Registers a media entity_notify
371  * media_device_unregister_entity_notify() - Unregister a media entity notify
383 	list_for_each_entry(entity, &(mdev)->entities, graph_obj.list)
387 	list_for_each_entry(intf, &(mdev)->interfaces, graph_obj.list)
391 	list_for_each_entry(pad, &(mdev)->pads, graph_obj.list)
395 	list_for_each_entry(link, &(mdev)->links, graph_obj.list)
398  * media_device_pci_init() - create and initialize a
410  * __media_device_usb_init() - create and initialize a
418  *		given by ``udev->dev->driver->name``, with is usually the wrong
480  * media_device_usb_init() - create and initialize a
496  * media_set_bus_info() - Set bus_info field
503  * platform devices. dev is required to be non-NULL for this to happen.