diff mbox

drm: Fix LSPCON kernel-doc

Message ID 1476877404-1327-1-git-send-email-jani.nikula@intel.com (mailing list archive)
State New, archived
Headers show

Commit Message

Jani Nikula Oct. 19, 2016, 11:43 a.m. UTC 
Fix warnings on building htmldocs.

Fixes: 056996b95686 ("drm: Helper for lspcon in drm_dp_dual_mode")
Cc: Rodrigo Vivi <rodrigo.vivi@intel.com>
Cc: Shashank Sharma <shashank.sharma@intel.com>
Cc: <dri-devel@lists.freedesktop.org>
Signed-off-by: Jani Nikula <jani.nikula@intel.com>

---

n.b. 056996b95686 ("drm: Helper for lspcon in drm_dp_dual_mode") has
been merged via drm-intel tree
---
 drivers/gpu/drm/drm_dp_dual_mode_helper.c | 14 +++++++-------
 include/drm/drm_dp_dual_mode_helper.h     | 15 ++++++++-------
 2 files changed, 15 insertions(+), 14 deletions(-)

Comments

Ville Syrjälä Oct. 19, 2016, 11:57 a.m. UTC | #1 
On Wed, Oct 19, 2016 at 02:43:24PM +0300, Jani Nikula wrote:
> Fix warnings on building htmldocs.
> 
> Fixes: 056996b95686 ("drm: Helper for lspcon in drm_dp_dual_mode")
> Cc: Rodrigo Vivi <rodrigo.vivi@intel.com>
> Cc: Shashank Sharma <shashank.sharma@intel.com>
> Cc: <dri-devel@lists.freedesktop.org>
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
> 
> ---
> 
> n.b. 056996b95686 ("drm: Helper for lspcon in drm_dp_dual_mode") has
> been merged via drm-intel tree
> ---
>  drivers/gpu/drm/drm_dp_dual_mode_helper.c | 14 +++++++-------
>  include/drm/drm_dp_dual_mode_helper.h     | 15 ++++++++-------
>  2 files changed, 15 insertions(+), 14 deletions(-)
> 
> diff --git a/drivers/gpu/drm/drm_dp_dual_mode_helper.c b/drivers/gpu/drm/drm_dp_dual_mode_helper.c
> index 2624e266abbd..488355bdafb9 100644
> --- a/drivers/gpu/drm/drm_dp_dual_mode_helper.c
> +++ b/drivers/gpu/drm/drm_dp_dual_mode_helper.c
> @@ -377,9 +377,9 @@ EXPORT_SYMBOL(drm_dp_get_dual_mode_type_name);
>  
>  /**
>   * drm_lspcon_get_mode: Get LSPCON's current mode of operation by
> - * by reading offset (0x80, 0x41)
> - * @i2c_adapter: I2C-over-aux adapter
> - * @current_mode: out vaiable, current lspcon mode of operation
> + * reading offset (0x80, 0x41)
> + * @adapter: I2C-over-aux adapter
> + * @mode: current lspcon mode of operation output variable
>   *
>   * Returns:
>   * 0 on success, sets the current_mode value to appropriate mode
> @@ -413,10 +413,10 @@ int drm_lspcon_get_mode(struct i2c_adapter *adapter,
>  EXPORT_SYMBOL(drm_lspcon_get_mode);
>  
>  /**
> - * drm_lspcon_change_mode: Change LSPCON's mode of operation by
> - * by writing offset (0x80, 0x40)
> - * @i2c_adapter: I2C-over-aux adapter
> - * @reqd_mode: required mode of operation
> + * drm_lspcon_set_mode: Change LSPCON's mode of operation by
> + * writing offset (0x80, 0x40)
> + * @adapter: I2C-over-aux adapter
> + * @mode: required mode of operation
>   *
>   * Returns:
>   * 0 on success, -error on failure/timeout
> diff --git a/include/drm/drm_dp_dual_mode_helper.h b/include/drm/drm_dp_dual_mode_helper.h
> index 55677704add8..1f04c5cfd402 100644
> --- a/include/drm/drm_dp_dual_mode_helper.h
> +++ b/include/drm/drm_dp_dual_mode_helper.h
> @@ -70,12 +70,13 @@ ssize_t drm_dp_dual_mode_write(struct i2c_adapter *adapter,
>  			       u8 offset, const void *buffer, size_t size);
>  
>  /**
> -* enum drm_lspcon_mode
> -* @lspcon_mode_ls: Level shifter mode of LSPCON
> -*	which drives DP++ to HDMI 1.4 conversion.
> -* @lspcon_mode_pcon: Protocol converter mode of LSPCON
> -*	which drives DP++ to HDMI 2.0 active conversion.
> -*/
> + * enum drm_lspcon_mode
> + * @DRM_LSPCON_MODE_INVALID: No LSPCON.
> + * @DRM_LSPCON_MODE_LS: Level shifter mode of LSPCON
> + *	which drives DP++ to HDMI 1.4 conversion.
> + * @DRM_LSPCON_MODE_PCON: Protocol converter mode of LSPCON
> + *	which drives DP++ to HDMI 2.0 active conversion.
> + */
>  enum drm_lspcon_mode {
>  	DRM_LSPCON_MODE_INVALID,
>  	DRM_LSPCON_MODE_LS,
> @@ -90,7 +91,7 @@ enum drm_lspcon_mode {
>   * @DRM_DP_DUAL_MODE_TYPE1_HDMI: Type 1 HDMI adaptor
>   * @DRM_DP_DUAL_MODE_TYPE2_DVI: Type 2 DVI adaptor
>   * @DRM_DP_DUAL_MODE_TYPE2_HDMI: Type 2 HDMI adaptor
> - * @DRM_DP_DUAL_MODE_TYPE2_LSPCON: Level shifter /protocol converter
> + * @DRM_DP_DUAL_MODE_LSPCON: Level shifter /protocol converter

May want to fix up the whitespace around '/' a bit too. Looks weird now.

>   */
>  enum drm_dp_dual_mode_type {
>  	DRM_DP_DUAL_MODE_NONE,
> -- 
> 2.1.4
> 
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/intel-gfx
diff mbox

Patch

diff --git a/drivers/gpu/drm/drm_dp_dual_mode_helper.c b/drivers/gpu/drm/drm_dp_dual_mode_helper.c
index 2624e266abbd..488355bdafb9 100644
--- a/drivers/gpu/drm/drm_dp_dual_mode_helper.c
+++ b/drivers/gpu/drm/drm_dp_dual_mode_helper.c
@@ -377,9 +377,9 @@  EXPORT_SYMBOL(drm_dp_get_dual_mode_type_name);
 
 /**
  * drm_lspcon_get_mode: Get LSPCON's current mode of operation by
- * by reading offset (0x80, 0x41)
- * @i2c_adapter: I2C-over-aux adapter
- * @current_mode: out vaiable, current lspcon mode of operation
+ * reading offset (0x80, 0x41)
+ * @adapter: I2C-over-aux adapter
+ * @mode: current lspcon mode of operation output variable
  *
  * Returns:
  * 0 on success, sets the current_mode value to appropriate mode
@@ -413,10 +413,10 @@  int drm_lspcon_get_mode(struct i2c_adapter *adapter,
 EXPORT_SYMBOL(drm_lspcon_get_mode);
 
 /**
- * drm_lspcon_change_mode: Change LSPCON's mode of operation by
- * by writing offset (0x80, 0x40)
- * @i2c_adapter: I2C-over-aux adapter
- * @reqd_mode: required mode of operation
+ * drm_lspcon_set_mode: Change LSPCON's mode of operation by
+ * writing offset (0x80, 0x40)
+ * @adapter: I2C-over-aux adapter
+ * @mode: required mode of operation
  *
  * Returns:
  * 0 on success, -error on failure/timeout
diff --git a/include/drm/drm_dp_dual_mode_helper.h b/include/drm/drm_dp_dual_mode_helper.h
index 55677704add8..1f04c5cfd402 100644
--- a/include/drm/drm_dp_dual_mode_helper.h
+++ b/include/drm/drm_dp_dual_mode_helper.h
@@ -70,12 +70,13 @@  ssize_t drm_dp_dual_mode_write(struct i2c_adapter *adapter,
 			       u8 offset, const void *buffer, size_t size);
 
 /**
-* enum drm_lspcon_mode
-* @lspcon_mode_ls: Level shifter mode of LSPCON
-*	which drives DP++ to HDMI 1.4 conversion.
-* @lspcon_mode_pcon: Protocol converter mode of LSPCON
-*	which drives DP++ to HDMI 2.0 active conversion.
-*/
+ * enum drm_lspcon_mode
+ * @DRM_LSPCON_MODE_INVALID: No LSPCON.
+ * @DRM_LSPCON_MODE_LS: Level shifter mode of LSPCON
+ *	which drives DP++ to HDMI 1.4 conversion.
+ * @DRM_LSPCON_MODE_PCON: Protocol converter mode of LSPCON
+ *	which drives DP++ to HDMI 2.0 active conversion.
+ */
 enum drm_lspcon_mode {
 	DRM_LSPCON_MODE_INVALID,
 	DRM_LSPCON_MODE_LS,
@@ -90,7 +91,7 @@  enum drm_lspcon_mode {
  * @DRM_DP_DUAL_MODE_TYPE1_HDMI: Type 1 HDMI adaptor
  * @DRM_DP_DUAL_MODE_TYPE2_DVI: Type 2 DVI adaptor
  * @DRM_DP_DUAL_MODE_TYPE2_HDMI: Type 2 HDMI adaptor
- * @DRM_DP_DUAL_MODE_TYPE2_LSPCON: Level shifter /protocol converter
+ * @DRM_DP_DUAL_MODE_LSPCON: Level shifter /protocol converter
  */
 enum drm_dp_dual_mode_type {
 	DRM_DP_DUAL_MODE_NONE,