leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[media] media-entity.h: document the remaining functions

Browse Source 
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 <mchehab@osg.samsung.com>
This commit is contained in:
Mauro Carvalho Chehab 2015-12-16 15:15:18 -02:00
parent 05b3b77cbb
commit 630c0e80c9
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/media/media-entity.h
View File

@ -301,11 +301,22 @@ static inline enum media_gobj_type media_type(struct media_gobj *gobj)
return gobj->id >> MEDIA_BITS_PER_ID; 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) static inline u32 media_id(struct media_gobj *gobj)
{ {
return gobj->id & MEDIA_ID_MASK; 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) static inline u32 media_gobj_gen_id(enum media_gobj_type type, u64 local_id)
{ {
u32 id; u32 id;