Skip to contentSkip to conversation

drm/amd/display; Fix kernel doc warnings

PATCH In review Harry Wentland 3 participants 4 messages Sep 19, 2019 3 messages not in the archive

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drm/amd/display; Fix kernel doc warnings

We had a couple of missing definitions and formatting errors.

---
 drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c | 14 ++++++++++++++
 drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 10 +++++++++-
 2 files changed, 23 insertions(+), 1 deletion(-)
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c +14 -0
index 7d62b4e86386..928a87f89f31 100644
@@ -261,6 +261,13 @@ static inline bool amdgpu_dm_vrr_active(struct dm_crtc_state *dm_state)
 	       dm_state->freesync_config.state == VRR_STATE_ACTIVE_FIXED;
 }
 
+/**
+ * dm_pflip_high_irq() - Handle pageflip interrupt
+ * @interrupt_params: ignored
+ *
+ * Handles the pageflip interrupt by notfying all interested parties
+ * that the pageflip has been completed.
+ */
 static void dm_pflip_high_irq(void *interrupt_params)
 {
 	struct amdgpu_crtc *amdgpu_crtc;
@@ -405,6 +412,13 @@ static void dm_vupdate_high_irq(void *interrupt_params)
 	}
 }
 
+/**
+ * dm_crtc_high_irq() - Handles CRTC interrupt
+ * @interrupt_params: ignored
+ *
+ * Handles the CRTC/VSYNC interrupt by notfying DRM's VBLANK
+ * event handler.
+ */
 static void dm_crtc_high_irq(void *interrupt_params)
 {
 	struct common_irq_params *irq_params = interrupt_params;
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +9 -1
index 17a35b504552..af2025f3ac1a 100644
@@ -105,6 +105,12 @@ struct amdgpu_dm_backlight_caps {
  * @display_indexes_num: Max number of display streams supported
  * @irq_handler_list_table_lock: Synchronizes access to IRQ tables
  * @backlight_dev: Backlight control device
+ * @backlight_link: Link on which to control backlight
+ * @backlight_caps: Capabilities of the backlight device
+ * @freesync_module: Module handling freesync calculations
+ * @fw_dmcu: Reference to DMCU firmware
+ * @dmcu_fw_version: Version of the DMCU firmware
+ * @soc_bounding_box: SOC bounding box values provided by gpu_info FW
  * @cached_state: Caches device atomic state for suspend/resume
  * @compressor: Frame buffer compression buffer. See &struct dm_comressor_info
  */
@@ -125,7 +131,7 @@ struct amdgpu_display_manager {
 	u16 display_indexes_num;
 
 	/**
-	 * @atomic_obj
+	 * @atomic_obj:
 	 *
 	 * In combination with &dm_atomic_state it helps manage
 	 * global atomic state that doesn't map cleanly into existing
@@ -231,6 +237,8 @@ struct amdgpu_display_manager {
 	uint32_t dmcu_fw_version;
 #ifdef CONFIG_DRM_AMD_DC_DCN2_0
 	/**
+	 * @soc_bounding_box:
+	 *
 	 * gpu_info FW provided soc bounding box struct or 0 if not
 	 * available in FW
 	 */
Signature · 6 lines
2.23.0

_______________________________________________
amd-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/amd-gfx

A message that is not in the archive (sent off-list or not yet received): 20190919174244.30192-1-harry.wentland-5C7GfCeVMHo@public.gmane.org

Reviewed-by Nicholas Kazlauskas
#2 lore raw
Quoted 13 lines · Harry Wentland

We had a couple of missing definitions and formatting errors.

---
  drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c | 14 ++++++++++++++
  drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 10 +++++++++-
  2 files changed, 23 insertions(+), 1 deletion(-)
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c +0 -0
index 7d62b4e86386..928a87f89f31 100644

drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c static inline bool amdgpu_dm_vrr_active(struct dm_crtc_state *dm_state) · line 268

Quoted 8 lines
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c +5 -0
@@ -261,6 +261,13 @@ static inline bool amdgpu_dm_vrr_active(struct dm_crtc_state *dm_state)
  	       dm_state->freesync_config.state == VRR_STATE_ACTIVE_FIXED;
  }
 
+/**
+ * dm_pflip_high_irq() - Handle pageflip interrupt
+ * @interrupt_params: ignored
+ *
+ * Handles the pageflip interrupt by notfying all interested parties

Should be "notifying".

With that fixed,

Quoted 47 lines
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c +9 -0
+ * that the pageflip has been completed.
+ */
  static void dm_pflip_high_irq(void *interrupt_params)
  {
  	struct amdgpu_crtc *amdgpu_crtc;
@@ -405,6 +412,13 @@ static void dm_vupdate_high_irq(void *interrupt_params)
  	}
  }
 
+/**
+ * dm_crtc_high_irq() - Handles CRTC interrupt
+ * @interrupt_params: ignored
+ *
+ * Handles the CRTC/VSYNC interrupt by notfying DRM's VBLANK
+ * event handler.
+ */
  static void dm_crtc_high_irq(void *interrupt_params)
  {
  	struct common_irq_params *irq_params = interrupt_params;
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +7 -1
index 17a35b504552..af2025f3ac1a 100644
@@ -105,6 +105,12 @@ struct amdgpu_dm_backlight_caps {
   * @display_indexes_num: Max number of display streams supported
   * @irq_handler_list_table_lock: Synchronizes access to IRQ tables
   * @backlight_dev: Backlight control device
+ * @backlight_link: Link on which to control backlight
+ * @backlight_caps: Capabilities of the backlight device
+ * @freesync_module: Module handling freesync calculations
+ * @fw_dmcu: Reference to DMCU firmware
+ * @dmcu_fw_version: Version of the DMCU firmware
+ * @soc_bounding_box: SOC bounding box values provided by gpu_info FW
   * @cached_state: Caches device atomic state for suspend/resume
   * @compressor: Frame buffer compression buffer. See &struct dm_comressor_info
   */
@@ -125,7 +131,7 @@ struct amdgpu_display_manager {
  	u16 display_indexes_num;
 
  	/**
-	 * @atomic_obj
+	 * @atomic_obj:
  	 *
  	 * In combination with &dm_atomic_state it helps manage
  	 * global atomic state that doesn't map cleanly into existing

drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h struct amdgpu_display_manager { · line 244

Quoted 8 lines
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +2 -0
@@ -231,6 +237,8 @@ struct amdgpu_display_manager {
  	uint32_t dmcu_fw_version;
  #ifdef CONFIG_DRM_AMD_DC_DCN2_0
  	/**
+	 * @soc_bounding_box:
+	 *
  	 * gpu_info FW provided soc bounding box struct or 0 if not
  	 * available in FW
  	 */

_______________________________________________
amd-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/amd-gfx

A message that is not in the archive (sent off-list or not yet received): 37bcfe0e-6ef8-cbbe-cdcc-b456a3a25353-5C7GfCeVMHo@public.gmane.org

#4 lore raw

PATCH 1/1 drm/amd/display; Fix kernel doc warnings

We had a couple of missing definitions and formatting errors.

v2: Fix 'notifying' type

---
 drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c | 14 ++++++++++++++
 drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 10 +++++++++-
 2 files changed, 23 insertions(+), 1 deletion(-)
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c +14 -0
index 7d62b4e86386..1a23eebc24dc 100644
@@ -261,6 +261,13 @@ static inline bool amdgpu_dm_vrr_active(struct dm_crtc_state *dm_state)
 	       dm_state->freesync_config.state == VRR_STATE_ACTIVE_FIXED;
 }
 
+/**
+ * dm_pflip_high_irq() - Handle pageflip interrupt
+ * @interrupt_params: ignored
+ *
+ * Handles the pageflip interrupt by notifying all interested parties
+ * that the pageflip has been completed.
+ */
 static void dm_pflip_high_irq(void *interrupt_params)
 {
 	struct amdgpu_crtc *amdgpu_crtc;
@@ -405,6 +412,13 @@ static void dm_vupdate_high_irq(void *interrupt_params)
 	}
 }
 
+/**
+ * dm_crtc_high_irq() - Handles CRTC interrupt
+ * @interrupt_params: ignored
+ *
+ * Handles the CRTC/VSYNC interrupt by notfying DRM's VBLANK
+ * event handler.
+ */
 static void dm_crtc_high_irq(void *interrupt_params)
 {
 	struct common_irq_params *irq_params = interrupt_params;
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +9 -1
index 17a35b504552..af2025f3ac1a 100644
@@ -105,6 +105,12 @@ struct amdgpu_dm_backlight_caps {
  * @display_indexes_num: Max number of display streams supported
  * @irq_handler_list_table_lock: Synchronizes access to IRQ tables
  * @backlight_dev: Backlight control device
+ * @backlight_link: Link on which to control backlight
+ * @backlight_caps: Capabilities of the backlight device
+ * @freesync_module: Module handling freesync calculations
+ * @fw_dmcu: Reference to DMCU firmware
+ * @dmcu_fw_version: Version of the DMCU firmware
+ * @soc_bounding_box: SOC bounding box values provided by gpu_info FW
  * @cached_state: Caches device atomic state for suspend/resume
  * @compressor: Frame buffer compression buffer. See &struct dm_comressor_info
  */
@@ -125,7 +131,7 @@ struct amdgpu_display_manager {
 	u16 display_indexes_num;
 
 	/**
-	 * @atomic_obj
+	 * @atomic_obj:
 	 *
 	 * In combination with &dm_atomic_state it helps manage
 	 * global atomic state that doesn't map cleanly into existing
@@ -231,6 +237,8 @@ struct amdgpu_display_manager {
 	uint32_t dmcu_fw_version;
 #ifdef CONFIG_DRM_AMD_DC_DCN2_0
 	/**
+	 * @soc_bounding_box:
+	 *
 	 * gpu_info FW provided soc bounding box struct or 0 if not
 	 * available in FW
 	 */
Signature · 6 lines
2.23.0

_______________________________________________
amd-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/amd-gfx

A message that is not in the archive (sent off-list or not yet received): 20190919175243.31592-1-harry.wentland-5C7GfCeVMHo@public.gmane.org

Reviewed-by
#6 lore raw
Quoted 7 lines · Harry Wentland

We had a couple of missing definitions and formatting errors.

v2: Fix 'notifying' type

Quoted 75 lines
---
 drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c | 14 ++++++++++++++
 drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 10 +++++++++-
 2 files changed, 23 insertions(+), 1 deletion(-)
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c +14 -0
index 7d62b4e86386..1a23eebc24dc 100644
@@ -261,6 +261,13 @@ static inline bool amdgpu_dm_vrr_active(struct dm_crtc_state *dm_state)
               dm_state->freesync_config.state == VRR_STATE_ACTIVE_FIXED;
 }
 
+/**
+ * dm_pflip_high_irq() - Handle pageflip interrupt
+ * @interrupt_params: ignored
+ *
+ * Handles the pageflip interrupt by notifying all interested parties
+ * that the pageflip has been completed.
+ */
 static void dm_pflip_high_irq(void *interrupt_params)
 {
        struct amdgpu_crtc *amdgpu_crtc;
@@ -405,6 +412,13 @@ static void dm_vupdate_high_irq(void *interrupt_params)
        }
 }
 
+/**
+ * dm_crtc_high_irq() - Handles CRTC interrupt
+ * @interrupt_params: ignored
+ *
+ * Handles the CRTC/VSYNC interrupt by notfying DRM's VBLANK
+ * event handler.
+ */
 static void dm_crtc_high_irq(void *interrupt_params)
 {
        struct common_irq_params *irq_params = interrupt_params;
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +9 -2
index 17a35b504552..af2025f3ac1a 100644
@@ -105,6 +105,12 @@ struct amdgpu_dm_backlight_caps {
  * @display_indexes_num: Max number of display streams supported
  * @irq_handler_list_table_lock: Synchronizes access to IRQ tables
  * @backlight_dev: Backlight control device
+ * @backlight_link: Link on which to control backlight
+ * @backlight_caps: Capabilities of the backlight device
+ * @freesync_module: Module handling freesync calculations
+ * @fw_dmcu: Reference to DMCU firmware
+ * @dmcu_fw_version: Version of the DMCU firmware
+ * @soc_bounding_box: SOC bounding box values provided by gpu_info FW
  * @cached_state: Caches device atomic state for suspend/resume
  * @compressor: Frame buffer compression buffer. See &struct dm_comressor_info
  */
@@ -125,7 +131,7 @@ struct amdgpu_display_manager {
        u16 display_indexes_num;
 
        /**
-        * @atomic_obj
+        * @atomic_obj:
         *
         * In combination with &dm_atomic_state it helps manage
         * global atomic state that doesn't map cleanly into existing
@@ -231,6 +237,8 @@ struct amdgpu_display_manager {
        uint32_t dmcu_fw_version;
 #ifdef CONFIG_DRM_AMD_DC_DCN2_0
        /**
+        * @soc_bounding_box:
+        *
         * gpu_info FW provided soc bounding box struct or 0 if not
         * available in FW
         */
--

2.23.0

Quoted 4 lines

_______________________________________________
amd-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/amd-gfx

_______________________________________________
amd-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/amd-gfx