drivers/firmware/memmap.c: fix kernel-doc format

Fix kernel-doc format validation to be able to use kernel-doc script for
checking it.

Signed-off-by: Michal Simek <michal.simek@xilinx.com>
Reviewed-by: Yasuaki Ishimatsu <isimatu.yasuaki@jp.fujitsu.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Michal Simek 2015-06-25 15:02:43 -07:00 committed by Linus Torvalds
parent ec3904dc65
commit cbdc281019
1 changed files with 13 additions and 11 deletions

View File

@ -144,7 +144,9 @@ static struct kobj_type __refdata memmap_ktype = {
* *
* Common implementation of firmware_map_add() and firmware_map_add_early() * Common implementation of firmware_map_add() and firmware_map_add_early()
* which expects a pre-allocated struct firmware_map_entry. * which expects a pre-allocated struct firmware_map_entry.
**/ *
* Return: 0 always
*/
static int firmware_map_add_entry(u64 start, u64 end, static int firmware_map_add_entry(u64 start, u64 end,
const char *type, const char *type,
struct firmware_map_entry *entry) struct firmware_map_entry *entry)
@ -170,7 +172,7 @@ static int firmware_map_add_entry(u64 start, u64 end,
* @entry: removed entry. * @entry: removed entry.
* *
* The caller must hold map_entries_lock, and release it properly. * The caller must hold map_entries_lock, and release it properly.
**/ */
static inline void firmware_map_remove_entry(struct firmware_map_entry *entry) static inline void firmware_map_remove_entry(struct firmware_map_entry *entry)
{ {
list_del(&entry->list); list_del(&entry->list);
@ -208,7 +210,7 @@ static inline void remove_sysfs_fw_map_entry(struct firmware_map_entry *entry)
kobject_put(&entry->kobj); kobject_put(&entry->kobj);
} }
/* /**
* firmware_map_find_entry_in_list() - Search memmap entry in a given list. * firmware_map_find_entry_in_list() - Search memmap entry in a given list.
* @start: Start of the memory range. * @start: Start of the memory range.
* @end: End of the memory range (exclusive). * @end: End of the memory range (exclusive).
@ -236,7 +238,7 @@ firmware_map_find_entry_in_list(u64 start, u64 end, const char *type,
return NULL; return NULL;
} }
/* /**
* firmware_map_find_entry() - Search memmap entry in map_entries. * firmware_map_find_entry() - Search memmap entry in map_entries.
* @start: Start of the memory range. * @start: Start of the memory range.
* @end: End of the memory range (exclusive). * @end: End of the memory range (exclusive).
@ -254,7 +256,7 @@ firmware_map_find_entry(u64 start, u64 end, const char *type)
return firmware_map_find_entry_in_list(start, end, type, &map_entries); return firmware_map_find_entry_in_list(start, end, type, &map_entries);
} }
/* /**
* firmware_map_find_entry_bootmem() - Search memmap entry in map_entries_bootmem. * firmware_map_find_entry_bootmem() - Search memmap entry in map_entries_bootmem.
* @start: Start of the memory range. * @start: Start of the memory range.
* @end: End of the memory range (exclusive). * @end: End of the memory range (exclusive).
@ -283,8 +285,8 @@ firmware_map_find_entry_bootmem(u64 start, u64 end, const char *type)
* similar to function firmware_map_add_early(). The only difference is that * similar to function firmware_map_add_early(). The only difference is that
* it will create the syfs entry dynamically. * it will create the syfs entry dynamically.
* *
* Returns 0 on success, or -ENOMEM if no memory could be allocated. * Return: 0 on success, or -ENOMEM if no memory could be allocated.
**/ */
int __meminit firmware_map_add_hotplug(u64 start, u64 end, const char *type) int __meminit firmware_map_add_hotplug(u64 start, u64 end, const char *type)
{ {
struct firmware_map_entry *entry; struct firmware_map_entry *entry;
@ -325,8 +327,8 @@ int __meminit firmware_map_add_hotplug(u64 start, u64 end, const char *type)
* *
* That function must be called before late_initcall. * That function must be called before late_initcall.
* *
* Returns 0 on success, or -ENOMEM if no memory could be allocated. * Return: 0 on success, or -ENOMEM if no memory could be allocated.
**/ */
int __init firmware_map_add_early(u64 start, u64 end, const char *type) int __init firmware_map_add_early(u64 start, u64 end, const char *type)
{ {
struct firmware_map_entry *entry; struct firmware_map_entry *entry;
@ -346,8 +348,8 @@ int __init firmware_map_add_early(u64 start, u64 end, const char *type)
* *
* removes a firmware mapping entry. * removes a firmware mapping entry.
* *
* Returns 0 on success, or -EINVAL if no entry. * Return: 0 on success, or -EINVAL if no entry.
**/ */
int __meminit firmware_map_remove(u64 start, u64 end, const char *type) int __meminit firmware_map_remove(u64 start, u64 end, const char *type)
{ {
struct firmware_map_entry *entry; struct firmware_map_entry *entry;