Skip to contentSkip to conversation

fwnode: add missing kernel-doc for struct fwnode_operations members

PATCH Applied Danilo Krummrich 4 participants 5 messages Jul 27 – Jul 30

Subsystems (3)
lore
Share & tools
lore

Danilo Krummrich

author maintainer
#0 lore raw

PATCH 1/1 fwnode: add missing kernel-doc for struct fwnode_operations members

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.

---
 include/linux/fwnode.h | 4 ++++
 1 file changed, 4 insertions(+)
include/linux/fwnode.h +4 -0
index 4e86e6990d28..a9dcaf7e7076 100644
@@ -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.
  */
Signature · 1 line
2.55.0
Reviewed-by Tested-by on v1 1/1
#1 lore raw
Quoted 8 lines · Danilo Krummrich

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.

Thanks.

Quoted 26 lines
---
 include/linux/fwnode.h | 4 ++++
 1 file changed, 4 insertions(+)
include/linux/fwnode.h +4 -0
index 4e86e6990d28..a9dcaf7e7076 100644
@@ -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.
  */
Signature · 1 line
~Randy
reviewer Reviewed-by on v1 1/1
#2 lore raw
In reply to Danilo Krummrich
Quoted 8 lines · Danilo Krummrich

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.

Thanks!

Signature · 1 line
Sakari Ailus
reviewer Reviewed-by on v1 1/1
#3 lore raw
In reply to Danilo Krummrich
Quoted 35 lines · Danilo Krummrich

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.

---
 include/linux/fwnode.h | 4 ++++
 1 file changed, 4 insertions(+)
include/linux/fwnode.h +4 -1
index 4e86e6990d28..a9dcaf7e7076 100644
@@ -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.
  */
--
Quoted 3 lines

2.55.0

author maintainer Applied
#4 lore raw
In reply to Danilo Krummrich
Quoted 1 line · Danilo Krummrich

[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.