linux-next: build warning after merge of the pwm tree

linux-next: build warning after merge of the pwm tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 326 bytes --]

Hi all,

After merging the pwm tree, today's linux-next build (htmldocs) produced
this warning:

include/linux/pwm.h:304: warning: Function parameter or member 'id' not described in 'pwm_chip'

Introduced by commit

  c572f3b9c8b7 ("pwm: Replace PWM chip unique base by unique ID")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

[PATCH] pwm: Update kernel doc for struct pwm_chip

[Uwe Kleine-König]

Commit c572f3b9c8b7 ("pwm: Replace PWM chip unique base by unique ID")
changed the members of struct pwm_chip, but failed to update the
documentation accordingly. Catch up and document the new member and drop
description for the two removed ones.

Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
---
 include/linux/pwm.h | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/include/linux/pwm.h b/include/linux/pwm.h
index c27a4bb76012..f87655c06c82 100644
--- a/include/linux/pwm.h
+++ b/include/linux/pwm.h
@@ -281,11 +281,10 @@ struct pwm_ops {
  * @dev: device providing the PWMs
  * @ops: callbacks for this PWM controller
  * @owner: module providing this chip
- * @base: number of first PWM controlled by this chip
+ * @id: unique number of this PWM chip
  * @npwm: number of PWMs controlled by this chip
  * @of_xlate: request a PWM device given a device tree PWM specifier
  * @of_pwm_n_cells: number of cells expected in the device tree PWM specifier
- * @list: list node for internal use
  * @pwms: array of PWM devices allocated by the framework
  */
 struct pwm_chip {

base-commit: 5d67b8f81b9d598599366214e3b2eb5f84003c9f
-- 
2.42.0

Re: [PATCH] pwm: Update kernel doc for struct pwm_chip

[Thierry Reding]

On Wed, 29 Nov 2023 11:18:32 +0100, Uwe Kleine-König wrote:
> Commit c572f3b9c8b7 ("pwm: Replace PWM chip unique base by unique ID")
> changed the members of struct pwm_chip, but failed to update the
> documentation accordingly. Catch up and document the new member and drop
> description for the two removed ones.
> 
> 

Applied, thanks!

[1/1] pwm: Update kernel doc for struct pwm_chip
      commit: 53a2eaaf19c4e652ac53b5b2441582a555768516

Best regards,
-- 
Thierry Reding <thierry.reding@gmail.com>

linux-next: build warning after merge of the pwm tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 336 bytes --]

Hi all,

After merging the pwm tree, today's linux-next build (htmldocs) produced
this warning:

include/linux/pwm.h:357: warning: Function parameter or struct member 'gpio' not described in 'pwm_chip'

Introduced by commit

  1c84bb7fc0ad ("pwm: Provide a gpio device for waveform drivers")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: linux-next: build warning after merge of the pwm tree

[Uwe Kleine-König]

[-- Attachment #1: Type: text/plain, Size: 1708 bytes --]

hello,

On Thu, Apr 17, 2025 at 04:27:00PM +1000, Stephen Rothwell wrote:
> After merging the pwm tree, today's linux-next build (htmldocs) produced
> this warning:
> 
> ocumentation/driver-api/miscellaneous:47: drivers/pwm/core.c:232: WARNING: Inline emphasis start-string without end-string. [docutils]
> 
> Introduced by commit
> 
>   bde5547f2e87 ("pwm: Better document return value of pwm_round_waveform_might_sleep()")

I squashed a fix into that commit:

$ git range-diff bde5547f2e87...fbf1880bada0
1:  bde5547f2e87 ! 1:  fbf1880bada0 pwm: Better document return value of pwm_round_waveform_might_sleep()
    @@ Commit message

         Signed-off-by: Uwe Kleine-König <u.kleine-koenig@baylibre.com>
         Link: https://lore.kernel.org/r/db84abf1e82e4498fc0e7c318d2673771d0039fe.1744120697.git.ukleinek@kernel.org
    +    [ukleinek: Fix a rst formatting issue reported by Stephen Rothwell]
         Signed-off-by: Uwe Kleine-König <ukleinek@kernel.org>

      ## drivers/pwm/core.c ##
    @@ drivers/pwm/core.c: static int __pwm_write_waveform(struct pwm_chip *chip, struc
       *
     - * Returns 0 on success, 1 if there is no valid hardware configuration matching
     - * the input waveform under the PWM rounding rules or a negative errno.
    -+ * Usually all values passed in *wf are rounded down to the nearest possible
    ++ * Usually all values passed in @wf are rounded down to the nearest possible
     + * value (in the order period_length_ns, duty_length_ns and then
     + * duty_offset_ns). Only if this isn't possible, a value might grow.
     + *

Thanks for the report (and all the work you do to notice these issues)!

Best regards
Uwe

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

linux-next: build warning after merge of the pwm tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 388 bytes --]

Hi all,

After merging the pwm tree, today's linux-next build (htmldocs) produced
this warning:

ocumentation/driver-api/miscellaneous:47: drivers/pwm/core.c:232: WARNING: Inline emphasis start-string without end-string. [docutils]

Introduced by commit

  bde5547f2e87 ("pwm: Better document return value of pwm_round_waveform_might_sleep()")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

linux-next: build warning after merge of the pwm tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 364 bytes --]

Hi all,

After merging the pwm tree, today's linux-next build (htmldocs) produced
this warning:

include/linux/pwm.h:308: warning: Function parameter or struct member 'cdev' not described in 'pwm_chip'

Introduced by commit

  0835e5c87042 ("pwm: Add support for pwmchip devices for faster and easier userspace access")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

linux-next: build warning after merge of the pwm tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 310 bytes --]

Hi all,

After merging the pwm tree, today's linux-next build (x86_64 allmodconfig)
produced this warning:

WARNING: modpost: missing MODULE_LICENSE() in drivers/pwm/pwm-intel-lgm.o

Introduced by commit

  9fba318f0f7f ("Add PWM fan controller driver for LGM SoC")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]