summaryrefslogtreecommitdiff
path: root/drivers/firmware
diff options
context:
space:
mode:
authorRandy Dunlap <rdunlap@infradead.org>2023-12-22 09:19:23 +0300
committerArd Biesheuvel <ardb@kernel.org>2023-12-22 12:42:06 +0300
commit4afa688d7141ae7a166d32224abbfd536acccfca (patch)
treef843f2c0a3d3e00cf83607027121b2314a17b3ba /drivers/firmware
parent174a0c565cea74a7811ff79fbee1b70247570ade (diff)
downloadlinux-4afa688d7141ae7a166d32224abbfd536acccfca.tar.xz
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: Randy Dunlap <rdunlap@infradead.org> Cc: Ard Biesheuvel <ardb@kernel.org> Cc: linux-efi@vger.kernel.org Signed-off-by: Ard Biesheuvel <ardb@kernel.org>
Diffstat (limited to 'drivers/firmware')
-rw-r--r--drivers/firmware/efi/memmap.c8
1 files changed, 5 insertions, 3 deletions
diff --git a/drivers/firmware/efi/memmap.c b/drivers/firmware/efi/memmap.c
index a1180461a445..3365944f7965 100644
--- a/drivers/firmware/efi/memmap.c
+++ b/drivers/firmware/efi/memmap.c
@@ -32,7 +32,7 @@
* space isn't setup. Once the kernel is fully booted we can fallback
* 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)
{
@@ -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
* 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)
{
@@ -107,7 +109,7 @@ void __init efi_memmap_unmap(void)
/**
* 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
*
* Setup a mapping of the EFI memory map using ioremap_cache(). This
@@ -126,7 +128,7 @@ void __init efi_memmap_unmap(void)
* runtime so that things like efi_mem_desc_lookup() and
* 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)
{