summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>2015-12-11 15:41:12 +0100
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>2016-01-11 15:19:07 +0100
commitd1b9da2d606ecec587177c4c90f1905c57538149 (patch)
tree9eddcbe89642ee275ccd5fda4365d1a9a402d6ae
parent[media] media: use unsigned for pad index (diff)
downloadlinux-d1b9da2d606ecec587177c4c90f1905c57538149.tar.xz
linux-d1b9da2d606ecec587177c4c90f1905c57538149.zip
[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>
-rw-r--r--include/media/media-device.h4
-rw-r--r--include/uapi/linux/media.h2
2 files changed, 5 insertions, 1 deletions
diff --git a/include/media/media-device.h b/include/media/media-device.h
index f9907a7728d4..215a0d88241d 100644
--- a/include/media/media-device.h
+++ b/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.
* This can be used to report the default audio and video devices or the
* 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,
struct media_entity *entity);
diff --git a/include/uapi/linux/media.h b/include/uapi/linux/media.h
index ff6a8010c520..8d8e1a3e6e1a 100644
--- a/include/uapi/linux/media.h
+++ b/include/uapi/linux/media.h
@@ -92,7 +92,7 @@ struct media_device_info {
*
* Subdevs are initialized with MEDIA_ENT_T_V4L2_SUBDEV_UNKNOWN,
* 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.
*/