[PATCH 3/4] powerpc/ps3: mm.c: clean up kernel-doc issues
From: Randy Dunlap <rdunlap@infradead.org>
Date: 2026-09-01 06:34:13
Also in:
lkml
Use the correct format for struct members and function parameters. Use the correct function names in kernel-doc comments. Use the correct format for function descriptions. This eliminates these kernel-doc warnings: Warning: arch/powerpc/platforms/ps3/mm.c:102 struct member 'vas_id' not described in 'map' Warning: arch/powerpc/platforms/ps3/mm.c:195 missing initial short description on line: * ps3_mm_vas_destroy - Warning: arch/powerpc/platforms/ps3/mm.c:514 function parameter 'c_out' not described in 'dma_sb_map_pages' Warning: arch/powerpc/platforms/ps3/mm.c:708 expecting prototype for dma_region_free(). Prototype was for dma_sb_region_free() instead Warning: arch/powerpc/platforms/ps3/mm.c:1092 expecting prototype for dma_unmap_area_linear(). Prototype was for dma_sb_unmap_area_linear() instead This leaves around 15 unrepaired kernel-doc warnings. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> --- Cc: Geoff Levand <geoff@infradead.org> Cc: Madhavan Srinivasan <maddy@linux.ibm.com> Cc: Michael Ellerman <mpe@ellerman.id.au> Cc: Nicholas Piggin <npiggin@gmail.com> Cc: Christophe Leroy (CS GROUP) <chleroy@kernel.org> Cc: linuxppc-dev@lists.ozlabs.org arch/powerpc/platforms/ps3/mm.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
--- linux-next-20260828.orig/arch/powerpc/platforms/ps3/mm.c
+++ linux-next-20260828/arch/powerpc/platforms/ps3/mm.c@@ -79,7 +79,7 @@ struct mem_region { /** * struct map - address space state variables holder * @total: total memory available as reported by HV - * @vas_id - HV virtual address space id + * @vas_id: HV virtual address space id * @htab_size: htab size in bytes * * The HV virtual address space (vas) allows for hotplug memory regions.
@@ -193,7 +193,7 @@ fail: } /** - * ps3_mm_vas_destroy - + * ps3_mm_vas_destroy - destroy the virtual address space * * called during kexec sequence with MMU off. */
@@ -504,7 +504,7 @@ static int dma_ioc0_free_chunk(struct dm * @r: Pointer to a struct ps3_dma_region. * @phys_addr: Starting physical address of the area to map. * @len: Length in bytes of the area to map. - * c_out: A pointer to receive an allocated struct dma_chunk for this area. + * @c_out: A pointer to receive an allocated struct dma_chunk for this area. * * This is the lowest level dma mapping routine, and is the one that will * make the HV call to add the pages into the io controller address space.
@@ -699,7 +699,7 @@ static int dma_ioc0_region_create(struct } /** - * dma_region_free - Free a device dma region. + * dma_sb_region_free - Free a device dma region. * @r: Pointer to a struct ps3_dma_region. * * This is the lowest level dma region free routine, and is the one that
@@ -1081,7 +1081,7 @@ static int dma_sb_map_area_linear(struct } /** - * dma_unmap_area_linear - Unmap an area of memory from a device dma region. + * dma_sb_unmap_area_linear - Unmap an area of memory from a device dma region. * @r: Pointer to a struct ps3_dma_region. * @bus_addr: The starting ioc bus address of the area to unmap. * @len: Length in bytes of the area to unmap.