Commit 4afa688d authored by Randy Dunlap's avatar Randy Dunlap Committed by Ard Biesheuvel

efi: memmap: fix kernel-doc warnings

Correct all kernel-doc notation to repair warnings that are
reported by scripts/kernel-doc:

memmap.c:38: warning: No description found for return value of '__efi_memmap_init'
memmap.c:82: warning: No description found for return value of 'efi_memmap_init_early'
memmap.c:132: warning: Function parameter or member 'addr' not described in 'efi_memmap_init_late'
memmap.c:132: warning: Excess function parameter 'phys_addr' description in 'efi_memmap_init_late'
memmap.c:132: warning: No description found for return value of 'efi_memmap_init_late'
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Ard Biesheuvel <ardb@kernel.org>
Cc: linux-efi@vger.kernel.org
Signed-off-by: default avatarArd Biesheuvel <ardb@kernel.org>
parent 174a0c56
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
* space isn't setup. Once the kernel is fully booted we can fallback * space isn't setup. Once the kernel is fully booted we can fallback
* to the more robust memremap*() API. * to the more robust memremap*() API.
* *
* Returns zero on success, a negative error code on failure. * Returns: zero on success, a negative error code on failure.
*/ */
int __init __efi_memmap_init(struct efi_memory_map_data *data) int __init __efi_memmap_init(struct efi_memory_map_data *data)
{ {
...@@ -77,6 +77,8 @@ int __init __efi_memmap_init(struct efi_memory_map_data *data) ...@@ -77,6 +77,8 @@ int __init __efi_memmap_init(struct efi_memory_map_data *data)
* *
* Use early_memremap() to map the passed in EFI memory map and assign * Use early_memremap() to map the passed in EFI memory map and assign
* it to efi.memmap. * it to efi.memmap.
*
* Returns: zero on success, a negative error code on failure.
*/ */
int __init efi_memmap_init_early(struct efi_memory_map_data *data) int __init efi_memmap_init_early(struct efi_memory_map_data *data)
{ {
...@@ -107,7 +109,7 @@ void __init efi_memmap_unmap(void) ...@@ -107,7 +109,7 @@ void __init efi_memmap_unmap(void)
/** /**
* efi_memmap_init_late - Map efi.memmap with memremap() * efi_memmap_init_late - Map efi.memmap with memremap()
* @phys_addr: Physical address of the new EFI memory map * @addr: Physical address of the new EFI memory map
* @size: Size in bytes of the new EFI memory map * @size: Size in bytes of the new EFI memory map
* *
* Setup a mapping of the EFI memory map using ioremap_cache(). This * Setup a mapping of the EFI memory map using ioremap_cache(). This
...@@ -126,7 +128,7 @@ void __init efi_memmap_unmap(void) ...@@ -126,7 +128,7 @@ void __init efi_memmap_unmap(void)
* runtime so that things like efi_mem_desc_lookup() and * runtime so that things like efi_mem_desc_lookup() and
* efi_mem_attributes() always work. * efi_mem_attributes() always work.
* *
* Returns zero on success, a negative error code on failure. * Returns: zero on success, a negative error code on failure.
*/ */
int __init efi_memmap_init_late(phys_addr_t addr, unsigned long size) int __init efi_memmap_init_late(phys_addr_t addr, unsigned long size)
{ {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment