Unverified Commit 3350c2b3 authored by Randy Dunlap's avatar Randy Dunlap Committed by Ilpo Järvinen
Browse files

platform_data/mlxreg: mlxreg.h: fix all kernel-doc warnings 



Use the correct kernel-doc format & notation to eliminate
kernel-doc warnings:

Warning: include/linux/platform_data/mlxreg.h:24 Enum value
 'MLX_WDT_TYPE1' not described in enum 'mlxreg_wdt_type'
Warning: include/linux/platform_data/mlxreg.h:24 Enum value
 'MLX_WDT_TYPE2' not described in enum 'mlxreg_wdt_type'
Warning: include/linux/platform_data/mlxreg.h:24 Enum value
 'MLX_WDT_TYPE3' not described in enum 'mlxreg_wdt_type'
Warning: include/linux/platform_data/mlxreg.h:37 bad line:
 PHYs ready / unready state;
Warning: include/linux/platform_data/mlxreg.h:153 struct member 'np'
 not described in 'mlxreg_core_data'
Warning: include/linux/platform_data/mlxreg.h:153 struct member 'hpdev'
 not described in 'mlxreg_core_data'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20260226051232.549537-1-rdunlap@infradead.org


Reviewed-by: default avatarIlpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: default avatarIlpo Järvinen <ilpo.jarvinen@linux.intel.com>
parent c55b84fa

include/linux/platform_data/mlxreg.h

+7 −7
Original line number Diff line number Diff line
@@ -13,9 +13,9 @@ 
/**

 * enum mlxreg_wdt_type - type of HW watchdog

 *

 * TYPE1 HW watchdog implementation exist in old systems.

 * All new systems have TYPE2 HW watchdog.

 * TYPE3 HW watchdog can exist on all systems with new CPLD.

 * @MLX_WDT_TYPE1: HW watchdog implementation in old systems.

 * @MLX_WDT_TYPE2: All new systems have TYPE2 HW watchdog.

 * @MLX_WDT_TYPE3: HW watchdog that can exist on all systems with new CPLD.

 *   TYPE3 is selected by WD capability bit.

 */

enum mlxreg_wdt_type {
@@ -35,7 +35,7 @@ enum mlxreg_wdt_type { 
 * @MLXREG_HOTPLUG_LC_SYNCED: entry for line card synchronization events, coming

 *			      after hardware-firmware synchronization handshake;

 * @MLXREG_HOTPLUG_LC_READY: entry for line card ready events, indicating line card

			     PHYs ready / unready state;

 *			     PHYs ready / unready state;

 * @MLXREG_HOTPLUG_LC_ACTIVE: entry for line card active events, indicating firmware

 *			      availability / unavailability for the ports on line card;

 * @MLXREG_HOTPLUG_LC_THERMAL: entry for line card thermal shutdown events, positive
@@ -123,8 +123,8 @@ struct mlxreg_hotplug_device { 
 * @reg_pwr: attribute power register;

 * @reg_ena: attribute enable register;

 * @mode: access mode;

 * @np - pointer to node platform associated with attribute;

 * @hpdev - hotplug device data;

 * @np: pointer to node platform associated with attribute;

 * @hpdev: hotplug device data;

 * @notifier: pointer to event notifier block;

 * @health_cntr: dynamic device health indication counter;

 * @attached: true if device has been attached after good health indication;