From 630c0e80c984c0a9a325430d62770fd49f93f9b9 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Wed, 16 Dec 2015 15:15:18 -0200 Subject: [media] media-entity.h: document the remaining functions There are two ancillary functions that are missing comments. While those are used only internally at media-entity.c, document them, for completeness. Signed-off-by: Mauro Carvalho Chehab --- include/media/media-entity.h | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'include/media/media-entity.h') diff --git a/include/media/media-entity.h b/include/media/media-entity.h index 54be1496d542..79dd81fd463e 100644 --- a/include/media/media-entity.h +++ b/include/media/media-entity.h @@ -301,11 +301,22 @@ static inline enum media_gobj_type media_type(struct media_gobj *gobj) return gobj->id >> MEDIA_BITS_PER_ID; } +/** + * media_id() - return the media object ID + * + * @gobj: pointer to the media graph object + */ static inline u32 media_id(struct media_gobj *gobj) { return gobj->id & MEDIA_ID_MASK; } +/** + * media_gobj_gen_id() - encapsulates type and ID on at the object ID + * + * @type: object type as define at enum &media_gobj_type. + * @local_id: next ID, from struct &media_device.@id. + */ static inline u32 media_gobj_gen_id(enum media_gobj_type type, u64 local_id) { u32 id; -- cgit v1.2.3-58-ga151