Browse Source

[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: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Mauro Carvalho Chehab 9 years ago
parent
commit
d1b9da2d60
2 changed files with 5 additions and 1 deletions
  1. 4 0
      include/media/media-device.h
  2. 1 1
      include/uapi/linux/media.h

+ 4 - 0
include/media/media-device.h

@@ -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);

+ 1 - 1
include/uapi/linux/media.h

@@ -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.
  */
  */