diff mbox series

drm: sti: don't use kernel-doc markers

Message ID 20220326235132.25192-1-rdunlap@infradead.org (mailing list archive)
State New, archived
Headers show
Series drm: sti: don't use kernel-doc markers | expand

Commit Message

Randy Dunlap March 26, 2022, 11:51 p.m. UTC
Don't mark static functions as kernel-doc.

Prevents multiple kernel-doc build warnings:

drivers/gpu/drm/sti/sti_hdmi.c:187: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * HDMI interrupt handler threaded
drivers/gpu/drm/sti/sti_hdmi.c:219: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * HDMI interrupt handler
drivers/gpu/drm/sti/sti_hdmi.c:241: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Set hdmi active area depending on the drm display mode selected
drivers/gpu/drm/sti/sti_hdmi.c:262: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Overall hdmi configuration
drivers/gpu/drm/sti/sti_hdmi.c:340: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Helper to concatenate infoframe in 32 bits word
drivers/gpu/drm/sti/sti_hdmi.c:357: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Helper to write info frame
drivers/gpu/drm/sti/sti_hdmi.c:427: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Prepare and configure the AVI infoframe
drivers/gpu/drm/sti/sti_hdmi.c:470: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Prepare and configure the AUDIO infoframe
drivers/gpu/drm/sti/sti_hdmi.c:555: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Software reset of the hdmi subsystem

Fixes: 5402626c83a2 ("drm: sti: add HDMI driver")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Aditya Srivastava <yashsri421@gmail.com>
Cc: Benjamin Gaignard <benjamin.gaignard@linaro.org>
Cc: Alain Volmat <alain.volmat@foss.st.com>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
---
 drivers/gpu/drm/sti/sti_hdmi.c |   20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

Comments

Alain Volmat March 28, 2022, 10:21 a.m. UTC | #1
Hi Randy,

thanks for the patch.

Acked-by: Alain Volmat <alain.volmat@foss.st.com>

Alain

On Sat, Mar 26, 2022 at 04:51:32PM -0700, Randy Dunlap wrote:
> Don't mark static functions as kernel-doc.
> 
> Prevents multiple kernel-doc build warnings:
> 
> drivers/gpu/drm/sti/sti_hdmi.c:187: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * HDMI interrupt handler threaded
> drivers/gpu/drm/sti/sti_hdmi.c:219: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * HDMI interrupt handler
> drivers/gpu/drm/sti/sti_hdmi.c:241: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Set hdmi active area depending on the drm display mode selected
> drivers/gpu/drm/sti/sti_hdmi.c:262: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Overall hdmi configuration
> drivers/gpu/drm/sti/sti_hdmi.c:340: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Helper to concatenate infoframe in 32 bits word
> drivers/gpu/drm/sti/sti_hdmi.c:357: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Helper to write info frame
> drivers/gpu/drm/sti/sti_hdmi.c:427: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Prepare and configure the AVI infoframe
> drivers/gpu/drm/sti/sti_hdmi.c:470: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Prepare and configure the AUDIO infoframe
> drivers/gpu/drm/sti/sti_hdmi.c:555: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Software reset of the hdmi subsystem
> 
> Fixes: 5402626c83a2 ("drm: sti: add HDMI driver")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Aditya Srivastava <yashsri421@gmail.com>
> Cc: Benjamin Gaignard <benjamin.gaignard@linaro.org>
> Cc: Alain Volmat <alain.volmat@foss.st.com>
> Cc: David Airlie <airlied@linux.ie>
> Cc: Daniel Vetter <daniel@ffwll.ch>
> ---
>  drivers/gpu/drm/sti/sti_hdmi.c |   20 ++++++++++----------
>  1 file changed, 10 insertions(+), 10 deletions(-)
> 
> --- linux-next-20220325.orig/drivers/gpu/drm/sti/sti_hdmi.c
> +++ linux-next-20220325/drivers/gpu/drm/sti/sti_hdmi.c
> @@ -183,7 +183,7 @@ void hdmi_write(struct sti_hdmi *hdmi, u
>  	writel(val, hdmi->regs + offset);
>  }
>  
> -/**
> +/*
>   * HDMI interrupt handler threaded
>   *
>   * @irq: irq number
> @@ -215,7 +215,7 @@ static irqreturn_t hdmi_irq_thread(int i
>  	return IRQ_HANDLED;
>  }
>  
> -/**
> +/*
>   * HDMI interrupt handler
>   *
>   * @irq: irq number
> @@ -237,7 +237,7 @@ static irqreturn_t hdmi_irq(int irq, voi
>  	return IRQ_WAKE_THREAD;
>  }
>  
> -/**
> +/*
>   * Set hdmi active area depending on the drm display mode selected
>   *
>   * @hdmi: pointer on the hdmi internal structure
> @@ -258,7 +258,7 @@ static void hdmi_active_area(struct sti_
>  	hdmi_write(hdmi, ymax, HDMI_ACTIVE_VID_YMAX);
>  }
>  
> -/**
> +/*
>   * Overall hdmi configuration
>   *
>   * @hdmi: pointer on the hdmi internal structure
> @@ -336,7 +336,7 @@ static void hdmi_infoframe_reset(struct
>  		hdmi_write(hdmi, 0x0, pack_offset + i);
>  }
>  
> -/**
> +/*
>   * Helper to concatenate infoframe in 32 bits word
>   *
>   * @ptr: pointer on the hdmi internal structure
> @@ -353,7 +353,7 @@ static inline unsigned int hdmi_infofram
>  	return value;
>  }
>  
> -/**
> +/*
>   * Helper to write info frame
>   *
>   * @hdmi: pointer on the hdmi internal structure
> @@ -423,7 +423,7 @@ static void hdmi_infoframe_write_infopac
>  	hdmi_write(hdmi, val, HDMI_SW_DI_CFG);
>  }
>  
> -/**
> +/*
>   * Prepare and configure the AVI infoframe
>   *
>   * AVI infoframe are transmitted at least once per two video field and
> @@ -466,7 +466,7 @@ static int hdmi_avi_infoframe_config(str
>  	return 0;
>  }
>  
> -/**
> +/*
>   * Prepare and configure the AUDIO infoframe
>   *
>   * AUDIO infoframe are transmitted once per frame and
> @@ -551,7 +551,7 @@ static int hdmi_vendor_infoframe_config(
>  
>  #define HDMI_TIMEOUT_SWRESET  100   /*milliseconds */
>  
> -/**
> +/*
>   * Software reset of the hdmi subsystem
>   *
>   * @hdmi: pointer on the hdmi internal structure
> @@ -785,7 +785,7 @@ static void sti_hdmi_disable(struct drm_
>  	cec_notifier_set_phys_addr(hdmi->notifier, CEC_PHYS_ADDR_INVALID);
>  }
>  
> -/**
> +/*
>   * sti_hdmi_audio_get_non_coherent_n() - get N parameter for non-coherent
>   * clocks. None-coherent clocks means that audio and TMDS clocks have not the
>   * same source (drifts between clocks). In this case assumption is that CTS is
Daniel Vetter March 28, 2022, 2:26 p.m. UTC | #2
On Mon, Mar 28, 2022 at 12:21:16PM +0200, Alain Volmat wrote:
> Hi Randy,
> 
> thanks for the patch.
> 
> Acked-by: Alain Volmat <alain.volmat@foss.st.com>

Will Philippe apply this one?

Just trying to make sure this wont be lost, just acking isn't enough :-)
-Daniel

> 
> Alain
> 
> On Sat, Mar 26, 2022 at 04:51:32PM -0700, Randy Dunlap wrote:
> > Don't mark static functions as kernel-doc.
> > 
> > Prevents multiple kernel-doc build warnings:
> > 
> > drivers/gpu/drm/sti/sti_hdmi.c:187: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  * HDMI interrupt handler threaded
> > drivers/gpu/drm/sti/sti_hdmi.c:219: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  * HDMI interrupt handler
> > drivers/gpu/drm/sti/sti_hdmi.c:241: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  * Set hdmi active area depending on the drm display mode selected
> > drivers/gpu/drm/sti/sti_hdmi.c:262: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  * Overall hdmi configuration
> > drivers/gpu/drm/sti/sti_hdmi.c:340: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  * Helper to concatenate infoframe in 32 bits word
> > drivers/gpu/drm/sti/sti_hdmi.c:357: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  * Helper to write info frame
> > drivers/gpu/drm/sti/sti_hdmi.c:427: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  * Prepare and configure the AVI infoframe
> > drivers/gpu/drm/sti/sti_hdmi.c:470: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  * Prepare and configure the AUDIO infoframe
> > drivers/gpu/drm/sti/sti_hdmi.c:555: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  * Software reset of the hdmi subsystem
> > 
> > Fixes: 5402626c83a2 ("drm: sti: add HDMI driver")
> > Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> > Cc: Aditya Srivastava <yashsri421@gmail.com>
> > Cc: Benjamin Gaignard <benjamin.gaignard@linaro.org>
> > Cc: Alain Volmat <alain.volmat@foss.st.com>
> > Cc: David Airlie <airlied@linux.ie>
> > Cc: Daniel Vetter <daniel@ffwll.ch>
> > ---
> >  drivers/gpu/drm/sti/sti_hdmi.c |   20 ++++++++++----------
> >  1 file changed, 10 insertions(+), 10 deletions(-)
> > 
> > --- linux-next-20220325.orig/drivers/gpu/drm/sti/sti_hdmi.c
> > +++ linux-next-20220325/drivers/gpu/drm/sti/sti_hdmi.c
> > @@ -183,7 +183,7 @@ void hdmi_write(struct sti_hdmi *hdmi, u
> >  	writel(val, hdmi->regs + offset);
> >  }
> >  
> > -/**
> > +/*
> >   * HDMI interrupt handler threaded
> >   *
> >   * @irq: irq number
> > @@ -215,7 +215,7 @@ static irqreturn_t hdmi_irq_thread(int i
> >  	return IRQ_HANDLED;
> >  }
> >  
> > -/**
> > +/*
> >   * HDMI interrupt handler
> >   *
> >   * @irq: irq number
> > @@ -237,7 +237,7 @@ static irqreturn_t hdmi_irq(int irq, voi
> >  	return IRQ_WAKE_THREAD;
> >  }
> >  
> > -/**
> > +/*
> >   * Set hdmi active area depending on the drm display mode selected
> >   *
> >   * @hdmi: pointer on the hdmi internal structure
> > @@ -258,7 +258,7 @@ static void hdmi_active_area(struct sti_
> >  	hdmi_write(hdmi, ymax, HDMI_ACTIVE_VID_YMAX);
> >  }
> >  
> > -/**
> > +/*
> >   * Overall hdmi configuration
> >   *
> >   * @hdmi: pointer on the hdmi internal structure
> > @@ -336,7 +336,7 @@ static void hdmi_infoframe_reset(struct
> >  		hdmi_write(hdmi, 0x0, pack_offset + i);
> >  }
> >  
> > -/**
> > +/*
> >   * Helper to concatenate infoframe in 32 bits word
> >   *
> >   * @ptr: pointer on the hdmi internal structure
> > @@ -353,7 +353,7 @@ static inline unsigned int hdmi_infofram
> >  	return value;
> >  }
> >  
> > -/**
> > +/*
> >   * Helper to write info frame
> >   *
> >   * @hdmi: pointer on the hdmi internal structure
> > @@ -423,7 +423,7 @@ static void hdmi_infoframe_write_infopac
> >  	hdmi_write(hdmi, val, HDMI_SW_DI_CFG);
> >  }
> >  
> > -/**
> > +/*
> >   * Prepare and configure the AVI infoframe
> >   *
> >   * AVI infoframe are transmitted at least once per two video field and
> > @@ -466,7 +466,7 @@ static int hdmi_avi_infoframe_config(str
> >  	return 0;
> >  }
> >  
> > -/**
> > +/*
> >   * Prepare and configure the AUDIO infoframe
> >   *
> >   * AUDIO infoframe are transmitted once per frame and
> > @@ -551,7 +551,7 @@ static int hdmi_vendor_infoframe_config(
> >  
> >  #define HDMI_TIMEOUT_SWRESET  100   /*milliseconds */
> >  
> > -/**
> > +/*
> >   * Software reset of the hdmi subsystem
> >   *
> >   * @hdmi: pointer on the hdmi internal structure
> > @@ -785,7 +785,7 @@ static void sti_hdmi_disable(struct drm_
> >  	cec_notifier_set_phys_addr(hdmi->notifier, CEC_PHYS_ADDR_INVALID);
> >  }
> >  
> > -/**
> > +/*
> >   * sti_hdmi_audio_get_non_coherent_n() - get N parameter for non-coherent
> >   * clocks. None-coherent clocks means that audio and TMDS clocks have not the
> >   * same source (drifts between clocks). In this case assumption is that CTS is
Philippe CORNU March 31, 2022, 4:58 p.m. UTC | #3
On 3/28/22 16:26, Daniel Vetter wrote:
> On Mon, Mar 28, 2022 at 12:21:16PM +0200, Alain Volmat wrote:
>> Hi Randy,
>>
>> thanks for the patch.
>>
>> Acked-by: Alain Volmat <alain.volmat@foss.st.com>
> 
> Will Philippe apply this one?

Hi,
yes I will (probably early next week).
Many thanks
Philippe

> 
> Just trying to make sure this wont be lost, just acking isn't enough :-)
> -Daniel
> 
>>
>> Alain
>>
>> On Sat, Mar 26, 2022 at 04:51:32PM -0700, Randy Dunlap wrote:
>>> Don't mark static functions as kernel-doc.
>>>
>>> Prevents multiple kernel-doc build warnings:
>>>
>>> drivers/gpu/drm/sti/sti_hdmi.c:187: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>>>   * HDMI interrupt handler threaded
>>> drivers/gpu/drm/sti/sti_hdmi.c:219: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>>>   * HDMI interrupt handler
>>> drivers/gpu/drm/sti/sti_hdmi.c:241: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>>>   * Set hdmi active area depending on the drm display mode selected
>>> drivers/gpu/drm/sti/sti_hdmi.c:262: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>>>   * Overall hdmi configuration
>>> drivers/gpu/drm/sti/sti_hdmi.c:340: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>>>   * Helper to concatenate infoframe in 32 bits word
>>> drivers/gpu/drm/sti/sti_hdmi.c:357: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>>>   * Helper to write info frame
>>> drivers/gpu/drm/sti/sti_hdmi.c:427: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>>>   * Prepare and configure the AVI infoframe
>>> drivers/gpu/drm/sti/sti_hdmi.c:470: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>>>   * Prepare and configure the AUDIO infoframe
>>> drivers/gpu/drm/sti/sti_hdmi.c:555: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>>>   * Software reset of the hdmi subsystem
>>>
>>> Fixes: 5402626c83a2 ("drm: sti: add HDMI driver")
>>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>>> Cc: Aditya Srivastava <yashsri421@gmail.com>
>>> Cc: Benjamin Gaignard <benjamin.gaignard@linaro.org>
>>> Cc: Alain Volmat <alain.volmat@foss.st.com>
>>> Cc: David Airlie <airlied@linux.ie>
>>> Cc: Daniel Vetter <daniel@ffwll.ch>
>>> ---
>>>   drivers/gpu/drm/sti/sti_hdmi.c |   20 ++++++++++----------
>>>   1 file changed, 10 insertions(+), 10 deletions(-)
>>>
>>> --- linux-next-20220325.orig/drivers/gpu/drm/sti/sti_hdmi.c
>>> +++ linux-next-20220325/drivers/gpu/drm/sti/sti_hdmi.c
>>> @@ -183,7 +183,7 @@ void hdmi_write(struct sti_hdmi *hdmi, u
>>>   	writel(val, hdmi->regs + offset);
>>>   }
>>>   
>>> -/**
>>> +/*
>>>    * HDMI interrupt handler threaded
>>>    *
>>>    * @irq: irq number
>>> @@ -215,7 +215,7 @@ static irqreturn_t hdmi_irq_thread(int i
>>>   	return IRQ_HANDLED;
>>>   }
>>>   
>>> -/**
>>> +/*
>>>    * HDMI interrupt handler
>>>    *
>>>    * @irq: irq number
>>> @@ -237,7 +237,7 @@ static irqreturn_t hdmi_irq(int irq, voi
>>>   	return IRQ_WAKE_THREAD;
>>>   }
>>>   
>>> -/**
>>> +/*
>>>    * Set hdmi active area depending on the drm display mode selected
>>>    *
>>>    * @hdmi: pointer on the hdmi internal structure
>>> @@ -258,7 +258,7 @@ static void hdmi_active_area(struct sti_
>>>   	hdmi_write(hdmi, ymax, HDMI_ACTIVE_VID_YMAX);
>>>   }
>>>   
>>> -/**
>>> +/*
>>>    * Overall hdmi configuration
>>>    *
>>>    * @hdmi: pointer on the hdmi internal structure
>>> @@ -336,7 +336,7 @@ static void hdmi_infoframe_reset(struct
>>>   		hdmi_write(hdmi, 0x0, pack_offset + i);
>>>   }
>>>   
>>> -/**
>>> +/*
>>>    * Helper to concatenate infoframe in 32 bits word
>>>    *
>>>    * @ptr: pointer on the hdmi internal structure
>>> @@ -353,7 +353,7 @@ static inline unsigned int hdmi_infofram
>>>   	return value;
>>>   }
>>>   
>>> -/**
>>> +/*
>>>    * Helper to write info frame
>>>    *
>>>    * @hdmi: pointer on the hdmi internal structure
>>> @@ -423,7 +423,7 @@ static void hdmi_infoframe_write_infopac
>>>   	hdmi_write(hdmi, val, HDMI_SW_DI_CFG);
>>>   }
>>>   
>>> -/**
>>> +/*
>>>    * Prepare and configure the AVI infoframe
>>>    *
>>>    * AVI infoframe are transmitted at least once per two video field and
>>> @@ -466,7 +466,7 @@ static int hdmi_avi_infoframe_config(str
>>>   	return 0;
>>>   }
>>>   
>>> -/**
>>> +/*
>>>    * Prepare and configure the AUDIO infoframe
>>>    *
>>>    * AUDIO infoframe are transmitted once per frame and
>>> @@ -551,7 +551,7 @@ static int hdmi_vendor_infoframe_config(
>>>   
>>>   #define HDMI_TIMEOUT_SWRESET  100   /*milliseconds */
>>>   
>>> -/**
>>> +/*
>>>    * Software reset of the hdmi subsystem
>>>    *
>>>    * @hdmi: pointer on the hdmi internal structure
>>> @@ -785,7 +785,7 @@ static void sti_hdmi_disable(struct drm_
>>>   	cec_notifier_set_phys_addr(hdmi->notifier, CEC_PHYS_ADDR_INVALID);
>>>   }
>>>   
>>> -/**
>>> +/*
>>>    * sti_hdmi_audio_get_non_coherent_n() - get N parameter for non-coherent
>>>    * clocks. None-coherent clocks means that audio and TMDS clocks have not the
>>>    * same source (drifts between clocks). In this case assumption is that CTS is
>
Philippe CORNU April 7, 2022, 9 a.m. UTC | #4
On 3/31/22 18:58, Philippe CORNU wrote:
> 
> 
> On 3/28/22 16:26, Daniel Vetter wrote:
>> On Mon, Mar 28, 2022 at 12:21:16PM +0200, Alain Volmat wrote:
>>> Hi Randy,
>>>
>>> thanks for the patch.
>>>
>>> Acked-by: Alain Volmat <alain.volmat@foss.st.com>
>>
>> Will Philippe apply this one?
> 
> Hi,
> yes I will (probably early next week).
> Many thanks
> Philippe
> 

Applied on drm-misc-next.
Many thanks for your patch,
Philippe :-)

>>
>> Just trying to make sure this wont be lost, just acking isn't enough :-)
>> -Daniel
>>
>>>
>>> Alain
>>>
>>> On Sat, Mar 26, 2022 at 04:51:32PM -0700, Randy Dunlap wrote:
>>>> Don't mark static functions as kernel-doc.
>>>>
>>>> Prevents multiple kernel-doc build warnings:
>>>>
>>>> drivers/gpu/drm/sti/sti_hdmi.c:187: warning: This comment starts 
>>>> with '/**', but isn't a kernel-doc comment. Refer 
>>>> Documentation/doc-guide/kernel-doc.rst
>>>>   * HDMI interrupt handler threaded
>>>> drivers/gpu/drm/sti/sti_hdmi.c:219: warning: This comment starts 
>>>> with '/**', but isn't a kernel-doc comment. Refer 
>>>> Documentation/doc-guide/kernel-doc.rst
>>>>   * HDMI interrupt handler
>>>> drivers/gpu/drm/sti/sti_hdmi.c:241: warning: This comment starts 
>>>> with '/**', but isn't a kernel-doc comment. Refer 
>>>> Documentation/doc-guide/kernel-doc.rst
>>>>   * Set hdmi active area depending on the drm display mode selected
>>>> drivers/gpu/drm/sti/sti_hdmi.c:262: warning: This comment starts 
>>>> with '/**', but isn't a kernel-doc comment. Refer 
>>>> Documentation/doc-guide/kernel-doc.rst
>>>>   * Overall hdmi configuration
>>>> drivers/gpu/drm/sti/sti_hdmi.c:340: warning: This comment starts 
>>>> with '/**', but isn't a kernel-doc comment. Refer 
>>>> Documentation/doc-guide/kernel-doc.rst
>>>>   * Helper to concatenate infoframe in 32 bits word
>>>> drivers/gpu/drm/sti/sti_hdmi.c:357: warning: This comment starts 
>>>> with '/**', but isn't a kernel-doc comment. Refer 
>>>> Documentation/doc-guide/kernel-doc.rst
>>>>   * Helper to write info frame
>>>> drivers/gpu/drm/sti/sti_hdmi.c:427: warning: This comment starts 
>>>> with '/**', but isn't a kernel-doc comment. Refer 
>>>> Documentation/doc-guide/kernel-doc.rst
>>>>   * Prepare and configure the AVI infoframe
>>>> drivers/gpu/drm/sti/sti_hdmi.c:470: warning: This comment starts 
>>>> with '/**', but isn't a kernel-doc comment. Refer 
>>>> Documentation/doc-guide/kernel-doc.rst
>>>>   * Prepare and configure the AUDIO infoframe
>>>> drivers/gpu/drm/sti/sti_hdmi.c:555: warning: This comment starts 
>>>> with '/**', but isn't a kernel-doc comment. Refer 
>>>> Documentation/doc-guide/kernel-doc.rst
>>>>   * Software reset of the hdmi subsystem
>>>>
>>>> Fixes: 5402626c83a2 ("drm: sti: add HDMI driver")
>>>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>>>> Cc: Aditya Srivastava <yashsri421@gmail.com>
>>>> Cc: Benjamin Gaignard <benjamin.gaignard@linaro.org>
>>>> Cc: Alain Volmat <alain.volmat@foss.st.com>
>>>> Cc: David Airlie <airlied@linux.ie>
>>>> Cc: Daniel Vetter <daniel@ffwll.ch>
>>>> ---
>>>>   drivers/gpu/drm/sti/sti_hdmi.c |   20 ++++++++++----------
>>>>   1 file changed, 10 insertions(+), 10 deletions(-)
>>>>
>>>> --- linux-next-20220325.orig/drivers/gpu/drm/sti/sti_hdmi.c
>>>> +++ linux-next-20220325/drivers/gpu/drm/sti/sti_hdmi.c
>>>> @@ -183,7 +183,7 @@ void hdmi_write(struct sti_hdmi *hdmi, u
>>>>       writel(val, hdmi->regs + offset);
>>>>   }
>>>> -/**
>>>> +/*
>>>>    * HDMI interrupt handler threaded
>>>>    *
>>>>    * @irq: irq number
>>>> @@ -215,7 +215,7 @@ static irqreturn_t hdmi_irq_thread(int i
>>>>       return IRQ_HANDLED;
>>>>   }
>>>> -/**
>>>> +/*
>>>>    * HDMI interrupt handler
>>>>    *
>>>>    * @irq: irq number
>>>> @@ -237,7 +237,7 @@ static irqreturn_t hdmi_irq(int irq, voi
>>>>       return IRQ_WAKE_THREAD;
>>>>   }
>>>> -/**
>>>> +/*
>>>>    * Set hdmi active area depending on the drm display mode selected
>>>>    *
>>>>    * @hdmi: pointer on the hdmi internal structure
>>>> @@ -258,7 +258,7 @@ static void hdmi_active_area(struct sti_
>>>>       hdmi_write(hdmi, ymax, HDMI_ACTIVE_VID_YMAX);
>>>>   }
>>>> -/**
>>>> +/*
>>>>    * Overall hdmi configuration
>>>>    *
>>>>    * @hdmi: pointer on the hdmi internal structure
>>>> @@ -336,7 +336,7 @@ static void hdmi_infoframe_reset(struct
>>>>           hdmi_write(hdmi, 0x0, pack_offset + i);
>>>>   }
>>>> -/**
>>>> +/*
>>>>    * Helper to concatenate infoframe in 32 bits word
>>>>    *
>>>>    * @ptr: pointer on the hdmi internal structure
>>>> @@ -353,7 +353,7 @@ static inline unsigned int hdmi_infofram
>>>>       return value;
>>>>   }
>>>> -/**
>>>> +/*
>>>>    * Helper to write info frame
>>>>    *
>>>>    * @hdmi: pointer on the hdmi internal structure
>>>> @@ -423,7 +423,7 @@ static void hdmi_infoframe_write_infopac
>>>>       hdmi_write(hdmi, val, HDMI_SW_DI_CFG);
>>>>   }
>>>> -/**
>>>> +/*
>>>>    * Prepare and configure the AVI infoframe
>>>>    *
>>>>    * AVI infoframe are transmitted at least once per two video field 
>>>> and
>>>> @@ -466,7 +466,7 @@ static int hdmi_avi_infoframe_config(str
>>>>       return 0;
>>>>   }
>>>> -/**
>>>> +/*
>>>>    * Prepare and configure the AUDIO infoframe
>>>>    *
>>>>    * AUDIO infoframe are transmitted once per frame and
>>>> @@ -551,7 +551,7 @@ static int hdmi_vendor_infoframe_config(
>>>>   #define HDMI_TIMEOUT_SWRESET  100   /*milliseconds */
>>>> -/**
>>>> +/*
>>>>    * Software reset of the hdmi subsystem
>>>>    *
>>>>    * @hdmi: pointer on the hdmi internal structure
>>>> @@ -785,7 +785,7 @@ static void sti_hdmi_disable(struct drm_
>>>>       cec_notifier_set_phys_addr(hdmi->notifier, 
>>>> CEC_PHYS_ADDR_INVALID);
>>>>   }
>>>> -/**
>>>> +/*
>>>>    * sti_hdmi_audio_get_non_coherent_n() - get N parameter for 
>>>> non-coherent
>>>>    * clocks. None-coherent clocks means that audio and TMDS clocks 
>>>> have not the
>>>>    * same source (drifts between clocks). In this case assumption is 
>>>> that CTS is
>>
diff mbox series

Patch

--- linux-next-20220325.orig/drivers/gpu/drm/sti/sti_hdmi.c
+++ linux-next-20220325/drivers/gpu/drm/sti/sti_hdmi.c
@@ -183,7 +183,7 @@  void hdmi_write(struct sti_hdmi *hdmi, u
 	writel(val, hdmi->regs + offset);
 }
 
-/**
+/*
  * HDMI interrupt handler threaded
  *
  * @irq: irq number
@@ -215,7 +215,7 @@  static irqreturn_t hdmi_irq_thread(int i
 	return IRQ_HANDLED;
 }
 
-/**
+/*
  * HDMI interrupt handler
  *
  * @irq: irq number
@@ -237,7 +237,7 @@  static irqreturn_t hdmi_irq(int irq, voi
 	return IRQ_WAKE_THREAD;
 }
 
-/**
+/*
  * Set hdmi active area depending on the drm display mode selected
  *
  * @hdmi: pointer on the hdmi internal structure
@@ -258,7 +258,7 @@  static void hdmi_active_area(struct sti_
 	hdmi_write(hdmi, ymax, HDMI_ACTIVE_VID_YMAX);
 }
 
-/**
+/*
  * Overall hdmi configuration
  *
  * @hdmi: pointer on the hdmi internal structure
@@ -336,7 +336,7 @@  static void hdmi_infoframe_reset(struct
 		hdmi_write(hdmi, 0x0, pack_offset + i);
 }
 
-/**
+/*
  * Helper to concatenate infoframe in 32 bits word
  *
  * @ptr: pointer on the hdmi internal structure
@@ -353,7 +353,7 @@  static inline unsigned int hdmi_infofram
 	return value;
 }
 
-/**
+/*
  * Helper to write info frame
  *
  * @hdmi: pointer on the hdmi internal structure
@@ -423,7 +423,7 @@  static void hdmi_infoframe_write_infopac
 	hdmi_write(hdmi, val, HDMI_SW_DI_CFG);
 }
 
-/**
+/*
  * Prepare and configure the AVI infoframe
  *
  * AVI infoframe are transmitted at least once per two video field and
@@ -466,7 +466,7 @@  static int hdmi_avi_infoframe_config(str
 	return 0;
 }
 
-/**
+/*
  * Prepare and configure the AUDIO infoframe
  *
  * AUDIO infoframe are transmitted once per frame and
@@ -551,7 +551,7 @@  static int hdmi_vendor_infoframe_config(
 
 #define HDMI_TIMEOUT_SWRESET  100   /*milliseconds */
 
-/**
+/*
  * Software reset of the hdmi subsystem
  *
  * @hdmi: pointer on the hdmi internal structure
@@ -785,7 +785,7 @@  static void sti_hdmi_disable(struct drm_
 	cec_notifier_set_phys_addr(hdmi->notifier, CEC_PHYS_ADDR_INVALID);
 }
 
-/**
+/*
  * sti_hdmi_audio_get_non_coherent_n() - get N parameter for non-coherent
  * clocks. None-coherent clocks means that audio and TMDS clocks have not the
  * same source (drifts between clocks). In this case assumption is that CTS is