kpriv/linux-hardened
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[media] move documentation to the header files

Browse source 
Some exported functions were still documented at the .c file,
instead of documenting at the .h one.

Move the documentation to the right place, as we only use headers
at media device-drivers.xml DocBook.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
This commit is contained in:
Mauro Carvalho Chehab 2015-12-16 13:53:04 -02:00
parent 0798ce4a38
commit 92777994a5
4 changed files with 22 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
drivers/media/media-device.c
View file

@ -577,13 +577,6 @@ int __must_check media_device_register_entity(struct media_device *mdev,
}
EXPORT_SYMBOL_GPL(media_device_register_entity);
/**
* media_device_unregister_entity - Unregister an entity
* @entity: The entity
*
* If the entity has never been registered this function will return
* immediately.
*/
static void __media_device_unregister_entity(struct media_entity *entity)
{
struct media_device *mdev = entity->graph_obj.mdev;
@ -627,7 +620,6 @@ void media_device_unregister_entity(struct media_entity *entity)
}
EXPORT_SYMBOL_GPL(media_device_unregister_entity);
/**
* media_device_init() - initialize a media device
* @mdev: The media device
@ -652,11 +644,6 @@ void media_device_init(struct media_device *mdev)
}
EXPORT_SYMBOL_GPL(media_device_init);
/**
* media_device_cleanup() - Cleanup a media device
* @mdev: The media device
*
*/
void media_device_cleanup(struct media_device *mdev)
{
ida_destroy(&mdev->entity_internal_idx);
@ -665,13 +652,6 @@ void media_device_cleanup(struct media_device *mdev)
}
EXPORT_SYMBOL_GPL(media_device_cleanup);
/**
* __media_device_register() - register a media device
* @mdev: The media device
* @owner: The module owner
*
* returns zero on success or a negative error code.
*/
int __must_check __media_device_register(struct media_device *mdev,
struct module *owner)
{
@ -701,13 +681,6 @@ int __must_check __media_device_register(struct media_device *mdev,
}
EXPORT_SYMBOL_GPL(__media_device_register);
/**
* media_device_unregister - unregister a media device
* @mdev: The media device
*
* It is safe to call this function on an unregistered
* (but initialised) media device.
*/
void media_device_unregister(struct media_device *mdev)
{
struct media_entity *entity;

13
drivers/media/media-entity.c
View file

@ -70,14 +70,6 @@ static inline const char *intf_type(struct media_interface *intf)
}
};
/**
* __media_entity_enum_init - Initialise an entity enumeration
*
* @ent_enum: Entity enumeration to be initialised
* @idx_max: Maximum number of entities in the enumeration
*
* Returns zero on success or a negative error code.
*/
__must_check int __media_entity_enum_init(struct media_entity_enum *ent_enum,
int idx_max)
{
@ -93,11 +85,6 @@ __must_check int __media_entity_enum_init(struct media_entity_enum *ent_enum,
}
EXPORT_SYMBOL_GPL(__media_entity_enum_init);
/**
* media_entity_enum_cleanup - Release resources of an entity enumeration
*
* @e: Entity enumeration to be released
*/
void media_entity_enum_cleanup(struct media_entity_enum *ent_enum)
{
kfree(ent_enum->bmap);

6
include/media/media-device.h
View file

@ -428,6 +428,8 @@ void media_device_cleanup(struct media_device *mdev);
* a sysfs attribute.
*
* Unregistering a media device that hasn't been registered is *NOT* safe.
*
* Return: returns zero on success or a negative error code.
*/
int __must_check __media_device_register(struct media_device *mdev,
struct module *owner);
@ -437,6 +439,10 @@ int __must_check __media_device_register(struct media_device *mdev,
* __media_device_unregister() - Unegisters a media device element
*
* @mdev: pointer to struct &media_device
*
*
* It is safe to call this function on an unregistered (but initialised)
* media device.
*/
void media_device_unregister(struct media_device *mdev);

18
include/media/media-entity.h
View file

@ -370,9 +370,23 @@ static inline bool is_media_entity_v4l2_subdev(struct media_entity *entity)
}
}
/**
* __media_entity_enum_init - Initialise an entity enumeration
*
* @ent_enum: Entity enumeration to be initialised
* @idx_max: Maximum number of entities in the enumeration
*
* Return: Returns zero on success or a negative error code.
*/
__must_check int __media_entity_enum_init(struct media_entity_enum *ent_enum,
int idx_max);
void media_entity_enum_cleanup(struct media_entity_enum *e);
/**
* media_entity_enum_cleanup - Release resources of an entity enumeration
*
* @ent_enum: Entity enumeration to be released
*/
void media_entity_enum_cleanup(struct media_entity_enum *ent_enum);
/**
* media_entity_enum_zero - Clear the entire enum
@ -847,6 +861,7 @@ void media_remove_intf_link(struct media_link *link);
* Note: this is an unlocked version of media_remove_intf_links().
*/
void __media_remove_intf_links(struct media_interface *intf);
/**
* media_remove_intf_links() - remove all links associated with an interface
*
@ -861,7 +876,6 @@ void __media_remove_intf_links(struct media_interface *intf);
*/
void media_remove_intf_links(struct media_interface *intf);
#define media_entity_call(entity, operation, args...) \
(((entity)->ops && (entity)->ops->operation) ? \
(entity)->ops->operation((entity) , ##args) : -ENOIOCTLCMD)