[PATCH] powerpc/ps3: fix ps3.h kernel-doc warnings

[Randy Dunlap]

Hi,
I have an update (v2) for this patch.
Will send this weekend.

On 11/28/25 4:24 PM, Randy Dunlap wrote:
> Fix some kernel-doc warnings in ps3.h:
> 
> - add @dev to struct ps3_dma_region
> - don't mark a function as "struct"
> - add Returns: description for one function
> - add a short description for ps3_system_bus_set_drvdata()
> - correct an enum @name
> 
> to eliminate these warnings:
> 
> Warning: arch/powerpc/include/asm/ps3.h:96 struct member 'dev' not
>  described in 'ps3_dma_region'
> Warning: arch/powerpc/include/asm/ps3.h:166 int
>  ps3_mmio_region_init(struct ps3_system_bus_device *dev, struct
>  ps3_mmio_region *r, unsigned long bus_addr, unsigned long len, enum
>  ps3_mmio_page_size page_size); error: Cannot parse struct or union!
> Warning: arch/powerpc/include/asm/ps3.h:167 No description found for
>  return value of 'ps3_mmio_region_init'
> Warning: arch/powerpc/include/asm/ps3.h:407 missing initial short
>  description on line:
>  * ps3_system_bus_set_drvdata -
> Warning: arch/powerpc/include/asm/ps3.h:473 Enum value
>  'PS3_LPM_TB_TYPE_INTERNAL' not described in enum 'ps3_lpm_tb_type'
> Warning: arch/powerpc/include/asm/ps3.h:473 Excess enum value
>  '@PS3_LPM_RIGHTS_USE_TB' description in 'ps3_lpm_tb_type'
> 
> This leaves struct members in several structs and function parameters in
> one function still undescribed.
> 
> Signed-off-by: Randy Dunlap <rdunlap at infradead.org>
> ---
> Cc: Geoff Levand <geoff at infradead.org>
> Cc: Madhavan Srinivasan <maddy at linux.ibm.com>
> Cc: Michael Ellerman <mpe at ellerman.id.au>
> Cc: Nicholas Piggin <npiggin at gmail.com>
> Cc: "Christophe Leroy (CS GROUP)" <chleroy at kernel.org>
> ---
>  arch/powerpc/include/asm/ps3.h |    9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)


-- 
~Randy