From nobody Fri Apr 17 11:34:41 2026 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E75C83EBF09 for ; Sun, 22 Feb 2026 06:01:04 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1771740068; cv=none; b=UUObgTkROrt0jc+CKDDmictafHIPzsAGwErfu81uutnksdNhWDZub7A15LwEujUe+BzCa/QTAMVIQaBSazFOr2rPV1ZS4rsZpjeGk1s4g7WfRsE9DIx6gYQlr9BsmFl6Vt2TFZQlQwNskJMtgSnywo1z+QKX4JHN/QzSlu0O/Zs= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1771740068; c=relaxed/simple; bh=fGOnYy6EGFs6KSK8An1f58e/opHYsW+RRJoCt/NIp8Y=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=t9la5MDwzgkhFmmNzJJMK8ryKqmPcUtC7H2wxvMltU2DgRbBHGRGxnDCPJvq5QJ2c4xDeXoOvutAJCtDUBI6xHmf88JLzHp4kWgACJSQcPuPnXiESKXl7OJUchnVpX8HSskygyb7CPgXs5cBWizolvYGANaHJNCd5AN9HEZO9bg= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=QpQ/5ii7; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="QpQ/5ii7" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=SGUrJpT2snvrCrHF6oQDUX1NZznrc6QH9tpjEoGVdds=; b=QpQ/5ii7leZxLHvs7muSYQSakB zvy/aaQ0m3HYxfTsHaCFJ402XdzRSzcUTUlT1rchx06MZEC3Xc2GwxF1zolh+ySlmhXmehbXBftCM vwbWnj0PEN6deZD6UOBshyyYTZv5yGtrNORrEQO2hgQv6PVLiWwjId46iQq+EhBKu3FGd1hGCavPi h0VbGehTmkn5t9BYSiqjzjqUyvnJZsBsFH0HF/Gdl6OrjqZonl+Kyin+V15zuWKYi5mIcWQuiFcsy gVX2NLh5u8VRt0q5CsJEFp1MFkKYUg70InlNr123KR3eo7kxuv/fAb8fVuA7ati0iSJW+Hy7WOrIP cST7ov0A==; Received: from [50.53.43.113] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.98.2 #2 (Red Hat Linux)) id 1vu2Wc-0000000GVXz-33hD; Sun, 22 Feb 2026 06:01:02 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Geoff Levand , linuxppc-dev@lists.ozlabs.org, Madhavan Srinivasan , Michael Ellerman Subject: [PATCH] powerpc/ps3: fix ps3.h kernel-doc warnings Date: Sat, 21 Feb 2026 22:01:01 -0800 Message-ID: <20260222060101.2086504-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.53.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Eliminate all kernel-doc warnings in ps3.h: - add one missing struct member description - add one missing function short description - correct one enum name typo - change several incomplete kernel-doc comments to plain "/*" comments Examples: Warning: arch/powerpc/include/asm/ps3.h:96 struct member 'dev' not described in 'ps3_dma_region' Warning: arch/powerpc/include/asm/ps3.h:408 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' Signed-off-by: Randy Dunlap --- Cc: Geoff Levand Cc: linuxppc-dev@lists.ozlabs.org Cc: Madhavan Srinivasan Cc: Michael Ellerman arch/powerpc/include/asm/ps3.h | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) --- linux-next-20260220.orig/arch/powerpc/include/asm/ps3.h +++ linux-next-20260220/arch/powerpc/include/asm/ps3.h @@ -65,6 +65,7 @@ struct ps3_dma_region_ops; =20 /** * struct ps3_dma_region - A per device dma state variables structure + * @dev: The device that this struct describes. * @did: The HV device id. * @page_size: The ioc pagesize. * @region_type: The HV region type. @@ -108,18 +109,19 @@ struct ps3_dma_region_ops { dma_addr_t bus_addr, unsigned long len); }; -/** + +struct ps3_system_bus_device; + +/* * struct ps3_dma_region_init - Helper to initialize structure variables * * Helper to properly initialize variables prior to calling * ps3_system_bus_device_register. */ - -struct ps3_system_bus_device; - int ps3_dma_region_init(struct ps3_system_bus_device *dev, struct ps3_dma_region *r, enum ps3_dma_page_size page_size, enum ps3_dma_region_type region_type, void *addr, unsigned long len); + int ps3_dma_region_create(struct ps3_dma_region *r); int ps3_dma_region_free(struct ps3_dma_region *r); int ps3_dma_map(struct ps3_dma_region *r, unsigned long virt_addr, @@ -136,7 +138,7 @@ enum ps3_mmio_page_size { }; =20 struct ps3_mmio_region_ops; -/** +/* * struct ps3_mmio_region - a per device mmio state variables structure * * Current systems can be supported with a single region per device. @@ -155,13 +157,13 @@ struct ps3_mmio_region_ops { int (*create)(struct ps3_mmio_region *); int (*free)(struct ps3_mmio_region *); }; -/** - * struct ps3_mmio_region_init - Helper to initialize structure variables + +/* + * ps3_mmio_region_init - Helper to initialize structure variables * * Helper to properly initialize variables prior to calling * ps3_system_bus_device_register. */ - 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); @@ -342,7 +344,7 @@ enum ps3_system_bus_device_type { PS3_DEVICE_TYPE_LPM, }; =20 -/** +/* * struct ps3_system_bus_device - a device on the system bus */ =20 @@ -371,7 +373,7 @@ struct ps3_system_bus_device { int ps3_open_hv_device(struct ps3_system_bus_device *dev); int ps3_close_hv_device(struct ps3_system_bus_device *dev); =20 -/** +/* * struct ps3_system_bus_driver - a driver for a device on the system bus */ =20 @@ -405,7 +407,7 @@ static inline struct ps3_system_bus_driv } =20 /** - * ps3_system_bus_set_drvdata - + * ps3_system_bus_set_drvdata - save driver private pointer in @dev * @dev: device structure * @data: Data to set */ @@ -464,7 +466,7 @@ enum ps3_lpm_rights { * enum ps3_lpm_tb_type - Type of trace buffer lv1 should use. * * @PS3_LPM_TB_TYPE_NONE: Do not use a trace buffer. - * @PS3_LPM_RIGHTS_USE_TB: Use the lv1 internal trace buffer. Must have + * @PS3_LPM_TB_TYPE_INTERNAL: Use the lv1 internal trace buffer. Must have * rights @PS3_LPM_RIGHTS_USE_TB. */