@@ -46,8 +46,16 @@ 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()`.
+:c:func:`media_device_unregister()`. The resources of an unregistered media
+device will be released by the ``release()`` callback of :c:type:`media_device`
+ops, which will be called when the last user of the media device has released it
+calling :c:func:`media_device_put()`.
+
+The ``release()`` callback is the way all the resources of the media device are
+released once :c:func:`media_device_init()` has been called. This is also
+relevant during device driver's probe function as the ``release()`` callback
+will also have to be able to safely release the resources related to a partially
+initialised media device.
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
@@ -257,8 +257,10 @@ void media_device_init(struct media_device *mdev);
*
* @mdev: pointer to struct &media_device
*
- * This function that will destroy the graph_mutex that is
- * initialized in media_device_init().
+ * This function that will destroy the graph_mutex that is initialized in
+ * media_device_init(). Note that *only* drivers that do not manage releasing
+ * the memory of th media device itself call this function. This function is
+ * thus effectively DEPRECATED.
*/
void media_device_cleanup(struct media_device *mdev);
Document that after unregistering, Media device memory resources are released by the release() callback rather than by calling media_device_cleanup(). Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> --- Documentation/driver-api/media/mc-core.rst | 12 ++++++++++-- include/media/media-device.h | 6 ++++-- 2 files changed, 14 insertions(+), 4 deletions(-)