2022-07-03 19:43:12

by Khalid Masum

Subject: [PATCH] usb: dwc3: Describe function parameter 'mult'

Currently the parameter is not described. Which triggers warning when using
make htmldocs. Fix it by describing the parameter.

Signed-off-by: Khalid Masum <[email protected]>
---
drivers/usb/dwc3/gadget.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/usb/dwc3/gadget.c b/drivers/usb/dwc3/gadget.c
index 8716bece1072..e8c86b08cd83 100644
--- a/drivers/usb/dwc3/gadget.c
+++ b/drivers/usb/dwc3/gadget.c
@@ -657,6 +657,7 @@ static int dwc3_gadget_set_ep_config(struct dwc3_ep *dep, unsigned int action)
/**
* dwc3_gadget_calc_tx_fifo_size - calculates the txfifo size value
* @dwc: pointer to the DWC3 context
+ * @mult: multiplier, 'mult' value for SS Isoc EPs
*
* Calculates the size value based on the equation below:
*
--
2.36.1

2022-07-08 13:11:59

by Greg Kroah-Hartman

Subject: Re: [PATCH] usb: dwc3: Describe function parameter 'mult'

On Mon, Jul 04, 2022 at 01:24:48AM +0600, Khalid Masum wrote:
> Currently the parameter is not described. Which triggers warning when using
> make htmldocs. Fix it by describing the parameter.
>
> Signed-off-by: Khalid Masum <[email protected]>
> ---
> drivers/usb/dwc3/gadget.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/drivers/usb/dwc3/gadget.c b/drivers/usb/dwc3/gadget.c
> index 8716bece1072..e8c86b08cd83 100644
> --- a/drivers/usb/dwc3/gadget.c
> +++ b/drivers/usb/dwc3/gadget.c
> @@ -657,6 +657,7 @@ static int dwc3_gadget_set_ep_config(struct dwc3_ep *dep, unsigned int action)
> /**
> * dwc3_gadget_calc_tx_fifo_size - calculates the txfifo size value
> * @dwc: pointer to the DWC3 context
> + * @mult: multiplier, 'mult' value for SS Isoc EPs
> *
> * Calculates the size value based on the equation below:
> *
> --
> 2.36.1
>

Does not apply to my usb-next branch :(

2022-07-08 19:22:38

by Khalid Masum

Subject: Re: [PATCH] usb: dwc3: Describe function parameter 'mult'

On Fri, Jul 8, 2022 at 6:49 PM Greg Kroah-Hartman
<[email protected]> wrote:
>
> On Mon, Jul 04, 2022 at 01:24:48AM +0600, Khalid Masum wrote:
> > Currently the parameter is not described. Which triggers warning when using
> > make htmldocs. Fix it by describing the parameter.
> >
> > Signed-off-by: Khalid Masum <[email protected]>
> > ---
> > drivers/usb/dwc3/gadget.c | 1 +
> > 1 file changed, 1 insertion(+)
> >
> > diff --git a/drivers/usb/dwc3/gadget.c b/drivers/usb/dwc3/gadget.c
> > index 8716bece1072..e8c86b08cd83 100644
> > --- a/drivers/usb/dwc3/gadget.c
> > +++ b/drivers/usb/dwc3/gadget.c
> > @@ -657,6 +657,7 @@ static int dwc3_gadget_set_ep_config(struct dwc3_ep *dep, unsigned int action)
> > /**
> > * dwc3_gadget_calc_tx_fifo_size - calculates the txfifo size value
> > * @dwc: pointer to the DWC3 context
> > + * @mult: multiplier, 'mult' value for SS Isoc EPs
> > *
> > * Calculates the size value based on the equation below:
> > *
> > --
> > 2.36.1
> >
>
> Does not apply to my usb-next branch :(

Thanks. I looked into usb-next and a fix is already there.