summaryrefslogtreecommitdiffstats
path: root/Documentation/driver-api
diff options
context:
space:
mode:
authorSakari Ailus <sakari.ailus@linux.intel.com>2022-03-09 18:10:06 +0100
committerMauro Carvalho Chehab <mchehab@kernel.org>2022-05-17 09:18:02 +0200
commit1d1d8669e5ca669267e87ffc94f6d26e62fcd867 (patch)
treef24fa160d3e5c826096a1359d31021aa7697c790 /Documentation/driver-api
parente74e476834f810d99261988e501d460235269158 (diff)
downloadlinux-stable-1d1d8669e5ca669267e87ffc94f6d26e62fcd867.tar.gz
linux-stable-1d1d8669e5ca669267e87ffc94f6d26e62fcd867.tar.bz2
linux-stable-1d1d8669e5ca669267e87ffc94f6d26e62fcd867.zip
media: Documentation: mc: Add media_device_{init,cleanup}
Document that drivers must first initialise a media device before registering it, and clean up once the media device is unregistered. Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Diffstat (limited to 'Documentation/driver-api')
-rw-r--r--Documentation/driver-api/media/mc-core.rst13
1 files changed, 10 insertions, 3 deletions
diff --git a/Documentation/driver-api/media/mc-core.rst b/Documentation/driver-api/media/mc-core.rst
index 57b5bbba944e..02481a2513b9 100644
--- a/Documentation/driver-api/media/mc-core.rst
+++ b/Documentation/driver-api/media/mc-core.rst
@@ -42,9 +42,16 @@ Allocation of the structure is handled by the media device driver, usually by
embedding the :c:type:`media_device` instance in a larger driver-specific
structure.
-Drivers register media device instances by calling
-:c:func:`__media_device_register()` via the macro ``media_device_register()``
-and unregistered by calling :c:func:`media_device_unregister()`.
+Drivers initialise media device instances by calling
+:c:func:`media_device_init()`. After initialising a media device instance, it is
+registered by calling :c:func:`__media_device_register()` via the macro
+``media_device_register()`` and unregistered by calling
+:c:func:`media_device_unregister()`. An initialised media device must be
+eventually cleaned up by calling :c:func:`media_device_cleanup()`.
+
+Note that it is not allowed to unregister a media device instance that was not
+previously registered, or clean up a media device instance that was not
+previously initialised.
Entities
^^^^^^^^