Commit d1b9da2d authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[media] media-device.h: Let clearer that entity function must be initialized

Improve the documentation to let it clear that the entity function
must be initialized.
Suggested-by: default avatarLaurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 829de29b
...@@ -423,6 +423,10 @@ void media_device_unregister(struct media_device *mdev); ...@@ -423,6 +423,10 @@ void media_device_unregister(struct media_device *mdev);
* %MEDIA_ENT_FL_DEFAULT indicates the default entity for a given type. * %MEDIA_ENT_FL_DEFAULT indicates the default entity for a given type.
* This can be used to report the default audio and video devices or the * This can be used to report the default audio and video devices or the
* default camera sensor. * default camera sensor.
*
* NOTE: Drivers should set the entity function before calling this function.
* Please notice that the values %MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN and
* %MEDIA_ENT_F_UNKNOWN should not be used by the drivers.
*/ */
int __must_check media_device_register_entity(struct media_device *mdev, int __must_check media_device_register_entity(struct media_device *mdev,
struct media_entity *entity); struct media_entity *entity);
......
...@@ -92,7 +92,7 @@ struct media_device_info { ...@@ -92,7 +92,7 @@ struct media_device_info {
* *
* Subdevs are initialized with MEDIA_ENT_T_V4L2_SUBDEV_UNKNOWN, * Subdevs are initialized with MEDIA_ENT_T_V4L2_SUBDEV_UNKNOWN,
* in order to preserve backward compatibility. * in order to preserve backward compatibility.
* Drivers should change to the proper subdev type before * Drivers must change to the proper subdev type before
* registering the entity. * registering the entity.
*/ */
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment