Linux driver-core infrastructure
 help / color / mirror / Atom feed
* [PATCH] fwnode: add missing kernel-doc for struct fwnode_operations members
@ 2026-07-27 20:27 Danilo Krummrich
  2026-07-27 20:41 ` Randy Dunlap
                   ` (3 more replies)
  0 siblings, 4 replies; 5+ messages in thread
From: Danilo Krummrich @ 2026-07-27 20:27 UTC (permalink / raw)
  To: gregkh, rafael, dakr, andriy.shevchenko, djrscally,
	heikki.krogerus, sakari.ailus, brgl, rdunlap, lenb
  Cc: linux-acpi, driver-core

Document the four undocumented struct members in
struct fwnode_operations: device_dma_supported, device_get_dma_attr,
iomap, and irq_get.

This avoids kernel-doc warnings once include/linux/fwnode.h is included
in the driver-api infrastructure documentation.

Signed-off-by: Danilo Krummrich <dakr@kernel.org>
---
 include/linux/fwnode.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/include/linux/fwnode.h b/include/linux/fwnode.h
index 4e86e6990d28..a9dcaf7e7076 100644
--- a/include/linux/fwnode.h
+++ b/include/linux/fwnode.h
@@ -117,6 +117,8 @@ struct fwnode_reference_args {
  * @put: Put a reference to an fwnode.
  * @device_is_available: Return true if the device is available.
  * @device_get_match_data: Return the device driver match data.
+ * @device_dma_supported: Return true if DMA is supported.
+ * @device_get_dma_attr: Return the device DMA attribute.
  * @property_present: Return true if a property is present.
  * @property_read_bool: Return a boolean property value.
  * @property_read_int_array: Read an array of integer properties. Return zero on
@@ -134,6 +136,8 @@ struct fwnode_reference_args {
  *			       endpoint node.
  * @graph_get_port_parent: Return the parent node of a port node.
  * @graph_parse_endpoint: Parse endpoint for port and endpoint id.
+ * @iomap: Map the I/O memory of a given index for a fwnode.
+ * @irq_get: Get the IRQ of a given index for a fwnode.
  * @add_links:	Create fwnode links to all the suppliers of the fwnode. Return
  *		zero on success, a negative error code otherwise.
  */
-- 
2.55.0


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH] fwnode: add missing kernel-doc for struct fwnode_operations members
  2026-07-27 20:27 [PATCH] fwnode: add missing kernel-doc for struct fwnode_operations members Danilo Krummrich
@ 2026-07-27 20:41 ` Randy Dunlap
  2026-07-28  8:05 ` Sakari Ailus
                   ` (2 subsequent siblings)
  3 siblings, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2026-07-27 20:41 UTC (permalink / raw)
  To: Danilo Krummrich, gregkh, rafael, andriy.shevchenko, djrscally,
	heikki.krogerus, sakari.ailus, brgl, lenb
  Cc: linux-acpi, driver-core



On 7/27/26 1:27 PM, Danilo Krummrich wrote:
> Document the four undocumented struct members in
> struct fwnode_operations: device_dma_supported, device_get_dma_attr,
> iomap, and irq_get.
> 
> This avoids kernel-doc warnings once include/linux/fwnode.h is included
> in the driver-api infrastructure documentation.
> 
> Signed-off-by: Danilo Krummrich <dakr@kernel.org>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  include/linux/fwnode.h | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/include/linux/fwnode.h b/include/linux/fwnode.h
> index 4e86e6990d28..a9dcaf7e7076 100644
> --- a/include/linux/fwnode.h
> +++ b/include/linux/fwnode.h
> @@ -117,6 +117,8 @@ struct fwnode_reference_args {
>   * @put: Put a reference to an fwnode.
>   * @device_is_available: Return true if the device is available.
>   * @device_get_match_data: Return the device driver match data.
> + * @device_dma_supported: Return true if DMA is supported.
> + * @device_get_dma_attr: Return the device DMA attribute.
>   * @property_present: Return true if a property is present.
>   * @property_read_bool: Return a boolean property value.
>   * @property_read_int_array: Read an array of integer properties. Return zero on
> @@ -134,6 +136,8 @@ struct fwnode_reference_args {
>   *			       endpoint node.
>   * @graph_get_port_parent: Return the parent node of a port node.
>   * @graph_parse_endpoint: Parse endpoint for port and endpoint id.
> + * @iomap: Map the I/O memory of a given index for a fwnode.
> + * @irq_get: Get the IRQ of a given index for a fwnode.
>   * @add_links:	Create fwnode links to all the suppliers of the fwnode. Return
>   *		zero on success, a negative error code otherwise.
>   */

-- 
~Randy

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] fwnode: add missing kernel-doc for struct fwnode_operations members
  2026-07-27 20:27 [PATCH] fwnode: add missing kernel-doc for struct fwnode_operations members Danilo Krummrich
  2026-07-27 20:41 ` Randy Dunlap
@ 2026-07-28  8:05 ` Sakari Ailus
  2026-07-28  8:38 ` Bartosz Golaszewski
  2026-07-30 14:24 ` Danilo Krummrich
  3 siblings, 0 replies; 5+ messages in thread
From: Sakari Ailus @ 2026-07-28  8:05 UTC (permalink / raw)
  To: Danilo Krummrich
  Cc: gregkh, rafael, andriy.shevchenko, djrscally, heikki.krogerus,
	brgl, rdunlap, lenb, linux-acpi, driver-core

On Mon, Jul 27, 2026 at 10:27:40PM +0200, Danilo Krummrich wrote:
> Document the four undocumented struct members in
> struct fwnode_operations: device_dma_supported, device_get_dma_attr,
> iomap, and irq_get.
> 
> This avoids kernel-doc warnings once include/linux/fwnode.h is included
> in the driver-api infrastructure documentation.
> 
> Signed-off-by: Danilo Krummrich <dakr@kernel.org>

Thanks!

Reviewed-by: Sakari Ailus <sakari.ailus@linux.intel.com>

-- 
Sakari Ailus

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] fwnode: add missing kernel-doc for struct fwnode_operations members
  2026-07-27 20:27 [PATCH] fwnode: add missing kernel-doc for struct fwnode_operations members Danilo Krummrich
  2026-07-27 20:41 ` Randy Dunlap
  2026-07-28  8:05 ` Sakari Ailus
@ 2026-07-28  8:38 ` Bartosz Golaszewski
  2026-07-30 14:24 ` Danilo Krummrich
  3 siblings, 0 replies; 5+ messages in thread
From: Bartosz Golaszewski @ 2026-07-28  8:38 UTC (permalink / raw)
  To: Danilo Krummrich
  Cc: linux-acpi, driver-core, gregkh, rafael, andriy.shevchenko,
	djrscally, heikki.krogerus, sakari.ailus, brgl, rdunlap, lenb

On Mon, 27 Jul 2026 22:27:40 +0200, Danilo Krummrich <dakr@kernel.org> said:
> Document the four undocumented struct members in
> struct fwnode_operations: device_dma_supported, device_get_dma_attr,
> iomap, and irq_get.
>
> This avoids kernel-doc warnings once include/linux/fwnode.h is included
> in the driver-api infrastructure documentation.
>
> Signed-off-by: Danilo Krummrich <dakr@kernel.org>
> ---
>  include/linux/fwnode.h | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/include/linux/fwnode.h b/include/linux/fwnode.h
> index 4e86e6990d28..a9dcaf7e7076 100644
> --- a/include/linux/fwnode.h
> +++ b/include/linux/fwnode.h
> @@ -117,6 +117,8 @@ struct fwnode_reference_args {
>   * @put: Put a reference to an fwnode.
>   * @device_is_available: Return true if the device is available.
>   * @device_get_match_data: Return the device driver match data.
> + * @device_dma_supported: Return true if DMA is supported.
> + * @device_get_dma_attr: Return the device DMA attribute.
>   * @property_present: Return true if a property is present.
>   * @property_read_bool: Return a boolean property value.
>   * @property_read_int_array: Read an array of integer properties. Return zero on
> @@ -134,6 +136,8 @@ struct fwnode_reference_args {
>   *			       endpoint node.
>   * @graph_get_port_parent: Return the parent node of a port node.
>   * @graph_parse_endpoint: Parse endpoint for port and endpoint id.
> + * @iomap: Map the I/O memory of a given index for a fwnode.
> + * @irq_get: Get the IRQ of a given index for a fwnode.
>   * @add_links:	Create fwnode links to all the suppliers of the fwnode. Return
>   *		zero on success, a negative error code otherwise.
>   */
> --
> 2.55.0
>
>

Reviewed-by: Bartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] fwnode: add missing kernel-doc for struct fwnode_operations members
  2026-07-27 20:27 [PATCH] fwnode: add missing kernel-doc for struct fwnode_operations members Danilo Krummrich
                   ` (2 preceding siblings ...)
  2026-07-28  8:38 ` Bartosz Golaszewski
@ 2026-07-30 14:24 ` Danilo Krummrich
  3 siblings, 0 replies; 5+ messages in thread
From: Danilo Krummrich @ 2026-07-30 14:24 UTC (permalink / raw)
  To: Danilo Krummrich
  Cc: gregkh, rafael, andriy.shevchenko, djrscally, heikki.krogerus,
	sakari.ailus, brgl, rdunlap, lenb, linux-acpi, driver-core

On Mon, 27 Jul 2026 22:27:40 +0200, Danilo Krummrich wrote:
> [PATCH] fwnode: add missing kernel-doc for struct fwnode_operations members

Applied, thanks!

  Branch: driver-core-testing
  Tree:   git://git.kernel.org/pub/scm/linux/kernel/git/driver-core/driver-core.git

[1/1] fwnode: add missing kernel-doc for struct fwnode_operations members
      commit: 227717928656

The patch will appear in the next linux-next integration (typically within 24
hours on weekdays).

The patch is in the driver-core-testing branch and will be promoted to
driver-core-next after validation.

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2026-07-30 14:24 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-07-27 20:27 [PATCH] fwnode: add missing kernel-doc for struct fwnode_operations members Danilo Krummrich
2026-07-27 20:41 ` Randy Dunlap
2026-07-28  8:05 ` Sakari Ailus
2026-07-28  8:38 ` Bartosz Golaszewski
2026-07-30 14:24 ` Danilo Krummrich

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox