For enums that have a kernel-doc ("/**") comment block, add or correct
their kernel-doc to eliminate all kernel-doc enum warnings.Some of these needed "struct" changed to "enum" in the kernel-doc header. For a few of them, I changed the "/**" comment to a plain "/*" comment since there was no kernel-doc content there. Example: Warning: drivers/gpu/drm/amd/display/dmub/inc/dmub_cmd.h:2673 Enum value 'FAMS2_ALLOW_DELAY_CHECK_NONE' not described in enum 'dmub_fams2_allow_delay_check_mode' Warning: drivers/gpu/drm/amd/display/dmub/inc/dmub_cmd.h:2673 Enum value 'FAMS2_ALLOW_DELAY_CHECK_FROM_START' not described in enum 'dmub_fams2_allow_delay_check_mode' Warning: drivers/gpu/drm/amd/display/dmub/inc/dmub_cmd.h:2673 Enum value 'FAMS2_ALLOW_DELAY_CHECK_FROM_PREPARE' not described in enum 'dmub_fams2_allow_delay_check_mode' All .o files are the same with or without this patch. Signed-off-by: Randy Dunlap <[email protected]> --- Cc: Harry Wentland <[email protected]> Cc: Leo Li <[email protected]> Cc: Rodrigo Siqueira <[email protected]> Cc: Alex Deucher <[email protected]> Cc: Christian König <[email protected]> Cc: [email protected] Cc: Maarten Lankhorst <[email protected]> Cc: Maxime Ripard <[email protected]> Cc: Thomas Zimmermann <[email protected]> drivers/gpu/drm/amd/display/dmub/inc/dmub_cmd.h | 160 +++++++++----- 1 file changed, 110 insertions(+), 50 deletions(-) --- linux-next-20260218.orig/drivers/gpu/drm/amd/display/dmub/inc/dmub_cmd.h +++ linux-next-20260218/drivers/gpu/drm/amd/display/dmub/inc/dmub_cmd.h @@ -1007,15 +1007,30 @@ union dmub_fw_boot_status { * enum dmub_fw_boot_status_bit - Enum bit definitions for SCRATCH0. */ enum dmub_fw_boot_status_bit { - DMUB_FW_BOOT_STATUS_BIT_DAL_FIRMWARE = (1 << 0), /**< 1 if DAL FW */ - DMUB_FW_BOOT_STATUS_BIT_MAILBOX_READY = (1 << 1), /**< 1 if mailbox ready */ - DMUB_FW_BOOT_STATUS_BIT_OPTIMIZED_INIT_DONE = (1 << 2), /**< 1 if init done */ - DMUB_FW_BOOT_STATUS_BIT_RESTORE_REQUIRED = (1 << 3), /**< 1 if driver should call restore */ - DMUB_FW_BOOT_STATUS_BIT_DEFERRED_LOADED = (1 << 4), /**< 1 if VBIOS data is deferred programmed */ - DMUB_FW_BOOT_STATUS_BIT_FAMS_ENABLED = (1 << 5), /**< 1 if FAMS is enabled*/ - DMUB_FW_BOOT_STATUS_BIT_DETECTION_REQUIRED = (1 << 6), /**< 1 if detection need to be triggered by driver*/ - DMUB_FW_BOOT_STATUS_BIT_HW_POWER_INIT_DONE = (1 << 7), /**< 1 if hw power init is completed */ - DMUB_FW_BOOT_STATUS_BIT_ONO_REGIONS_ENABLED = (1 << 8), /**< 1 if ONO regions are enabled */ + /** @DMUB_FW_BOOT_STATUS_BIT_DAL_FIRMWARE: 1 if DAL FW */ + DMUB_FW_BOOT_STATUS_BIT_DAL_FIRMWARE = (1 << 0), + /** @DMUB_FW_BOOT_STATUS_BIT_MAILBOX_READY: 1 if mailbox ready */ + DMUB_FW_BOOT_STATUS_BIT_MAILBOX_READY = (1 << 1), + /** @DMUB_FW_BOOT_STATUS_BIT_OPTIMIZED_INIT_DONE: 1 if init done */ + DMUB_FW_BOOT_STATUS_BIT_OPTIMIZED_INIT_DONE = (1 << 2), + /** @DMUB_FW_BOOT_STATUS_BIT_RESTORE_REQUIRED: 1 if driver should call restore */ + DMUB_FW_BOOT_STATUS_BIT_RESTORE_REQUIRED = (1 << 3), + /** + * @DMUB_FW_BOOT_STATUS_BIT_DEFERRED_LOADED: 1 if VBIOS data is + * deferred programmed + */ + DMUB_FW_BOOT_STATUS_BIT_DEFERRED_LOADED = (1 << 4), + /** @DMUB_FW_BOOT_STATUS_BIT_FAMS_ENABLED: 1 if FAMS is enabled */ + DMUB_FW_BOOT_STATUS_BIT_FAMS_ENABLED = (1 << 5), + /** + * @DMUB_FW_BOOT_STATUS_BIT_DETECTION_REQUIRED: 1 if detection needs + * to be triggered by driver + */ + DMUB_FW_BOOT_STATUS_BIT_DETECTION_REQUIRED = (1 << 6), + /** @DMUB_FW_BOOT_STATUS_BIT_HW_POWER_INIT_DONE: 1 if hw power init is completed */ + DMUB_FW_BOOT_STATUS_BIT_HW_POWER_INIT_DONE = (1 << 7), + /** @DMUB_FW_BOOT_STATUS_BIT_ONO_REGIONS_ENABLED: if ONO regions are enabled */ + DMUB_FW_BOOT_STATUS_BIT_ONO_REGIONS_ENABLED = (1 << 8), }; /* Register bit definition for SCRATCH5 */ @@ -1079,18 +1094,22 @@ enum dmub_ips_comand_type { */ enum dmub_cursor_offload_comand_type { /** + * @DMUB_CMD__CURSOR_OFFLOAD_INIT: * Initializes the cursor offload feature. */ DMUB_CMD__CURSOR_OFFLOAD_INIT = 0, /** - * Enables cursor offloading for a stream and updates the timing parameters. + * @DMUB_CMD__CURSOR_OFFLOAD_STREAM_ENABLE: Enables cursor offloading + * for a stream and updates the timing parameters. */ DMUB_CMD__CURSOR_OFFLOAD_STREAM_ENABLE = 1, /** + * @DMUB_CMD__CURSOR_OFFLOAD_STREAM_DISABLE: * Disables cursor offloading for a given stream. */ DMUB_CMD__CURSOR_OFFLOAD_STREAM_DISABLE = 2, /** + * @DMUB_CMD__CURSOR_OFFLOAD_STREAM_PROGRAM: * Programs the latest data for a given stream. */ DMUB_CMD__CURSOR_OFFLOAD_STREAM_PROGRAM = 3, @@ -1156,7 +1175,7 @@ enum dmub_fw_boot_options_bit { * [Header (256 Bytes)][Feature 1 (256 Bytes)][Feature 2 (256 Bytes)]... */ -/** +/* * enum dmub_shared_state_feature_id - List of shared state features. */ enum dmub_shared_state_feature_id { @@ -1262,14 +1281,14 @@ struct dmub_shared_state_cursor_offload_ }; /* 248-bytes, fixed */ /** - * enum dmub_shared_state_feature_common - Generic payload. + * struct dmub_shared_state_feature_common - Generic payload. */ struct dmub_shared_state_feature_common { uint32_t padding[62]; }; /* 248-bytes, fixed */ /** - * enum dmub_shared_state_feature_header - Feature description. + * struct dmub_shared_state_feature_header - Feature description. */ struct dmub_shared_state_feature_header { uint16_t id; /**< Feature ID */ @@ -1909,30 +1928,36 @@ enum dmub_cmd_type { */ enum dmub_out_cmd_type { /** - * Invalid outbox command, ignored. + * @DMUB_OUT_CMD__NULL: Invalid outbox command, ignored. */ DMUB_OUT_CMD__NULL = 0, /** + * @DMUB_OUT_CMD__DP_AUX_REPLY: * Command type used for DP AUX Reply data notification */ DMUB_OUT_CMD__DP_AUX_REPLY = 1, /** + * @DMUB_OUT_CMD__DP_HPD_NOTIFY: * Command type used for DP HPD event notification */ DMUB_OUT_CMD__DP_HPD_NOTIFY = 2, /** + * @DMUB_OUT_CMD__SET_CONFIG_REPLY: * Command type used for SET_CONFIG Reply notification */ DMUB_OUT_CMD__SET_CONFIG_REPLY = 3, /** + * @DMUB_OUT_CMD__DPIA_NOTIFICATION: * Command type used for USB4 DPIA notification */ DMUB_OUT_CMD__DPIA_NOTIFICATION = 5, /** + * @DMUB_OUT_CMD__HPD_SENSE_NOTIFY: * Command type used for HPD redetect notification */ DMUB_OUT_CMD__HPD_SENSE_NOTIFY = 6, /** + * @DMUB_OUT_CMD__FUSED_IO: * Command type used for Fused IO notification */ DMUB_OUT_CMD__FUSED_IO = 7, @@ -2124,19 +2149,19 @@ struct dmub_rb_cmd_PLAT_54186_wa { */ enum dmub_cmd_mall_type { /** - * Allows display refresh from MALL. + * @DMUB_CMD__MALL_ACTION_ALLOW: Allows display refresh from MALL. */ DMUB_CMD__MALL_ACTION_ALLOW = 0, /** - * Disallows display refresh from MALL. + * @DMUB_CMD__MALL_ACTION_DISALLOW: Disallows display refresh from MALL. */ DMUB_CMD__MALL_ACTION_DISALLOW = 1, /** - * Cursor copy for MALL. + * @DMUB_CMD__MALL_ACTION_COPY_CURSOR: Cursor copy for MALL. */ DMUB_CMD__MALL_ACTION_COPY_CURSOR = 2, /** - * Controls DF requests. + * @DMUB_CMD__MALL_ACTION_NO_DF_REQ: Controls DF requests. */ DMUB_CMD__MALL_ACTION_NO_DF_REQ = 3, }; @@ -2165,18 +2190,21 @@ struct dmub_rb_cmd_mall { */ enum dmub_cmd_cab_type { /** + * @DMUB_CMD__CAB_NO_IDLE_OPTIMIZATION: * No idle optimizations (i.e. no CAB) */ DMUB_CMD__CAB_NO_IDLE_OPTIMIZATION = 0, /** - * No DCN requests for memory + * @DMUB_CMD__CAB_NO_DCN_REQ: No DCN requests for memory */ DMUB_CMD__CAB_NO_DCN_REQ = 1, /** + * @DMUB_CMD__CAB_DCN_SS_FIT_IN_CAB: * Fit surfaces in CAB (i.e. CAB enable) */ DMUB_CMD__CAB_DCN_SS_FIT_IN_CAB = 2, /** + * @DMUB_CMD__CAB_DCN_SS_NOT_FIT_IN_CAB: * Do not fit surfaces in CAB (i.e. no CAB) */ DMUB_CMD__CAB_DCN_SS_NOT_FIT_IN_CAB = 3, @@ -2191,7 +2219,7 @@ struct dmub_rb_cmd_cab_for_ss { uint8_t debug_bits; /* debug bits */ }; -/** +/* * Enum for indicating which MCLK switch mode per pipe */ enum mclk_switch_mode { @@ -2665,11 +2693,18 @@ struct dmub_fams2_stream_static_state_v1 * p-state request to allow latency */ enum dmub_fams2_allow_delay_check_mode { - /* No check for request to allow delay */ + /** + * @FAMS2_ALLOW_DELAY_CHECK_NONE: No check for request to allow delay + */ FAMS2_ALLOW_DELAY_CHECK_NONE = 0, - /* Check for request to allow delay */ + /** + * @FAMS2_ALLOW_DELAY_CHECK_FROM_START: Check for request to allow delay + */ FAMS2_ALLOW_DELAY_CHECK_FROM_START = 1, - /* Check for prepare to allow delay */ + /** + * @FAMS2_ALLOW_DELAY_CHECK_FROM_PREPARE: + * Check for prepare to allow delay + */ FAMS2_ALLOW_DELAY_CHECK_FROM_PREPARE = 2, }; @@ -2741,27 +2776,28 @@ struct dmub_rb_cmd_ib { */ enum dmub_cmd_idle_opt_type { /** - * DCN hardware restore. + * @DMUB_CMD__IDLE_OPT_DCN_RESTORE: DCN hardware restore. */ DMUB_CMD__IDLE_OPT_DCN_RESTORE = 0, /** - * DCN hardware save. + * @DMUB_CMD__IDLE_OPT_DCN_SAVE_INIT: DCN hardware save. */ DMUB_CMD__IDLE_OPT_DCN_SAVE_INIT = 1, /** - * DCN hardware notify idle. + * @DMUB_CMD__IDLE_OPT_DCN_NOTIFY_IDLE: DCN hardware notify idle. */ DMUB_CMD__IDLE_OPT_DCN_NOTIFY_IDLE = 2, /** + * @DMUB_CMD__IDLE_OPT_SET_DC_POWER_STATE: * DCN hardware notify power state. */ DMUB_CMD__IDLE_OPT_SET_DC_POWER_STATE = 3, /** - * DCN notify to release HW. + * @DMUB_CMD__IDLE_OPT_RELEASE_HW: DCN notify to release HW. */ DMUB_CMD__IDLE_OPT_RELEASE_HW = 4, }; @@ -2790,7 +2826,7 @@ struct dmub_rb_cmd_idle_opt_dcn_notify_i struct dmub_dcn_notify_idle_cntl_data cntl_data; }; -/** +/* * enum dmub_idle_opt_dc_power_state - DC power states. */ enum dmub_idle_opt_dc_power_state { @@ -2832,7 +2868,7 @@ struct dmub_clocks { */ enum dmub_cmd_clk_mgr_type { /** - * Notify DMCUB of clock update. + * @DMUB_CMD__CLK_MGR_NOTIFY_CLOCKS: Notify DMCUB of clock update. */ DMUB_CMD__CLK_MGR_NOTIFY_CLOCKS = 0, }; @@ -3077,21 +3113,40 @@ struct dmub_rb_cmd_dpphy_init { * 4 AUX request command bits are shifted to high nibble. */ enum dp_aux_request_action { - /** I2C-over-AUX write request */ + /** + * @DP_AUX_REQ_ACTION_I2C_WRITE: I2C-over-AUX write request + */ DP_AUX_REQ_ACTION_I2C_WRITE = 0x00, - /** I2C-over-AUX read request */ + /** + * @DP_AUX_REQ_ACTION_I2C_READ: I2C-over-AUX read request + */ DP_AUX_REQ_ACTION_I2C_READ = 0x10, - /** I2C-over-AUX write status request */ + /** + * @DP_AUX_REQ_ACTION_I2C_STATUS_REQ: I2C-over-AUX write status request + */ DP_AUX_REQ_ACTION_I2C_STATUS_REQ = 0x20, - /** I2C-over-AUX write request with MOT=1 */ + /** + * @DP_AUX_REQ_ACTION_I2C_WRITE_MOT: + * I2C-over-AUX write request with MOT=1 + */ DP_AUX_REQ_ACTION_I2C_WRITE_MOT = 0x40, - /** I2C-over-AUX read request with MOT=1 */ + /** + * @DP_AUX_REQ_ACTION_I2C_READ_MOT: + * I2C-over-AUX read request with MOT=1 + */ DP_AUX_REQ_ACTION_I2C_READ_MOT = 0x50, - /** I2C-over-AUX write status request with MOT=1 */ + /** + * @DP_AUX_REQ_ACTION_I2C_STATUS_REQ_MOT: + * I2C-over-AUX write status request with MOT=1 + */ DP_AUX_REQ_ACTION_I2C_STATUS_REQ_MOT = 0x60, - /** Native AUX write request */ + /** + * @DP_AUX_REQ_ACTION_DPCD_WRITE: Native AUX write request + */ DP_AUX_REQ_ACTION_DPCD_WRITE = 0x80, - /** Native AUX read request */ + /** + * @DP_AUX_REQ_ACTION_DPCD_READ: Native AUX read request + */ DP_AUX_REQ_ACTION_DPCD_READ = 0x90 }; @@ -3099,21 +3154,21 @@ enum dp_aux_request_action { * enum aux_return_code_type - DP AUX process return code listing. */ enum aux_return_code_type { - /** AUX process succeeded */ + /** @AUX_RET_SUCCESS: AUX process succeeded */ AUX_RET_SUCCESS = 0, - /** AUX process failed with unknown reason */ + /** @AUX_RET_ERROR_UNKNOWN: AUX process failed with unknown reason */ AUX_RET_ERROR_UNKNOWN, - /** AUX process completed with invalid reply */ + /** @AUX_RET_ERROR_INVALID_REPLY: AUX process completed with invalid reply */ AUX_RET_ERROR_INVALID_REPLY, - /** AUX process timed out */ + /** @AUX_RET_ERROR_TIMEOUT: AUX process timed out */ AUX_RET_ERROR_TIMEOUT, - /** HPD was low during AUX process */ + /** @AUX_RET_ERROR_HPD_DISCON: HPD was low during AUX process */ AUX_RET_ERROR_HPD_DISCON, - /** Failed to acquire AUX engine */ + /** @AUX_RET_ERROR_ENGINE_ACQUIRE: Failed to acquire AUX engine */ AUX_RET_ERROR_ENGINE_ACQUIRE, - /** AUX request not supported */ + /** @AUX_RET_ERROR_INVALID_OPERATION: AUX request not supported */ AUX_RET_ERROR_INVALID_OPERATION, - /** AUX process not available */ + /** @AUX_RET_ERROR_PROTOCOL_ERROR: AUX process not available */ AUX_RET_ERROR_PROTOCOL_ERROR, }; @@ -3121,9 +3176,9 @@ enum aux_return_code_type { * enum aux_channel_type - DP AUX channel type listing. */ enum aux_channel_type { - /** AUX thru Legacy DP AUX */ + /** @AUX_CHANNEL_LEGACY_DDC: AUX thru Legacy DP AUX */ AUX_CHANNEL_LEGACY_DDC, - /** AUX thru DPIA DP tunneling */ + /** @AUX_CHANNEL_DPIA: AUX thru DPIA DP tunneling */ AUX_CHANNEL_DPIA }; @@ -3608,7 +3663,7 @@ enum phy_link_rate { */ }; -/** +/* * enum dmub_phy_fsm_state - PHY FSM states. * PHY FSM state to transit to during PSR enable/disable. */ @@ -5825,10 +5880,11 @@ struct dmub_rb_cmd_abm_query_caps { */ enum dmub_abm_ace_curve_type { /** - * ACE curve as defined by the SW layer. + * @ABM_ACE_CURVE_TYPE__SW: ACE curve as defined by the SW layer. */ ABM_ACE_CURVE_TYPE__SW = 0, /** + * @ABM_ACE_CURVE_TYPE__SW_IF: * ACE curve as defined by the SW to HW translation interface layer. */ ABM_ACE_CURVE_TYPE__SW_IF = 1, @@ -5839,10 +5895,11 @@ enum dmub_abm_ace_curve_type { */ enum dmub_abm_histogram_type { /** - * ACE curve as defined by the SW layer. + * @ABM_HISTOGRAM_TYPE__SW: ACE curve as defined by the SW layer. */ ABM_HISTOGRAM_TYPE__SW = 0, /** + * @ABM_HISTOGRAM_TYPE__SW_IF: * ACE curve as defined by the SW to HW translation interface layer. */ ABM_HISTOGRAM_TYPE__SW_IF = 1, @@ -6048,14 +6105,17 @@ struct dmub_rb_cmd_get_visual_confirm_co */ enum dmub_cmd_panel_cntl_type { /** + * @DMUB_CMD__PANEL_CNTL_HW_INIT: * Initializes embedded panel hardware blocks. */ DMUB_CMD__PANEL_CNTL_HW_INIT = 0, /** + * @DMUB_CMD__PANEL_CNTL_QUERY_BACKLIGHT_INFO: * Queries backlight info for the embedded panel. */ DMUB_CMD__PANEL_CNTL_QUERY_BACKLIGHT_INFO = 1, /** + * @DMUB_CMD__PANEL_DEBUG_PWM_FREQ: * Sets the PWM Freq as per user's requirement. */ DMUB_CMD__PANEL_DEBUG_PWM_FREQ = 2,
