Commit e149847c authored by Randy Dunlap's avatar Randy Dunlap Committed by Dmitry Baryshkov
Browse files

drm/msm/disp: fix kernel-doc warnings 



Fix all kernel-doc warnings in msm_disp_snapshot.h:

msm_disp_snapshot.h:53: warning: Function parameter or struct member
 'blocks' not described in 'msm_disp_state'
msm_disp_snapshot.h:69: warning: Function parameter or struct member
 'node' not described in 'msm_disp_state_block'
msm_disp_snapshot.h:69: warning: Excess struct member 'drm_dev' description
 in 'msm_disp_state_block'
msm_disp_snapshot.h:95: warning: No description found for return value
 of 'msm_disp_snapshot_state_sync'
msm_disp_snapshot.h:100: warning: bad line:
msm_disp_snapshot.h:117: warning: bad line:
msm_disp_snapshot.h:125: warning: bad line:
msm_disp_snapshot.h:142: warning: Excess function parameter 'name'
 description in 'msm_disp_snapshot_add_block'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reviewed-by: default avatarDmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com>
Patchwork: https://patchwork.freedesktop.org/patch/687132/
Link: https://lore.kernel.org/r/20251111060353.1972869-1-rdunlap@infradead.org


Signed-off-by: default avatarDmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com>
parent fef68b2a

drivers/gpu/drm/msm/disp/msm_disp_snapshot.h

+7 −6
Original line number Diff line number Diff line
@@ -38,6 +38,7 @@ 
 * struct msm_disp_state - structure to store current dpu state

 * @dev: device pointer

 * @drm_dev: drm device pointer

 * @blocks: list head for hardware state blocks

 * @atomic_state: atomic state duplicated at the time of the error

 * @time: timestamp at which the coredump was captured

 */
@@ -55,7 +56,7 @@ struct msm_disp_state { 
/**

 * struct msm_disp_state_block - structure to store each hardware block state

 * @name: name of the block

 * @drm_dev: handle to the linked list head

 * @node: handle to the linked list head

 * @size: size of the register space of this hardware block

 * @state: array holding the register dump of this hardware block

 * @base_addr: starting address of this hardware block's register space
@@ -88,8 +89,9 @@ void msm_disp_snapshot_destroy(struct drm_device *drm_dev); 
 * msm_disp_snapshot_state_sync - synchronously snapshot display state

 * @kms:  the kms object

 *

 * Returns state or error

 * Returns: state or error

 *

 * Context:

 * Must be called with &kms->dump_mutex held

 */

struct msm_disp_state *msm_disp_snapshot_state_sync(struct msm_kms *kms);
@@ -97,7 +99,7 @@ struct msm_disp_state *msm_disp_snapshot_state_sync(struct msm_kms *kms); 
/**

 * msm_disp_snapshot_state - trigger to dump the display snapshot

 * @drm_dev:	handle to drm device



 *

 * Returns:	none

 */

void msm_disp_snapshot_state(struct drm_device *drm_dev);
@@ -114,7 +116,7 @@ void msm_disp_state_print(struct msm_disp_state *disp_state, struct drm_printer 
/**

 * msm_disp_snapshot_capture_state - utility to capture atomic state and hw registers

 * @disp_state:	    handle to msm_disp_state struct



 *

 * Returns:	none

 */

void msm_disp_snapshot_capture_state(struct msm_disp_state *disp_state);
@@ -122,7 +124,7 @@ void msm_disp_snapshot_capture_state(struct msm_disp_state *disp_state); 
/**

 * msm_disp_state_free - free the memory after the coredump has been read

 * @data:	    handle to struct msm_disp_state



 *

 * Returns: none

 */

void msm_disp_state_free(void *data);
@@ -130,7 +132,6 @@ void msm_disp_state_free(void *data); 
/**

 * msm_disp_snapshot_add_block - add a hardware block with its register dump

 * @disp_state:	    handle to struct msm_disp_state

 * @name:           name of the hardware block

 * @len:            size of the register space of the hardware block

 * @base_addr:      starting address of the register space of the hardware block

 * @fmt:            format in which the block names need to be printed