Skip to contentSkip to conversation

driver core: Document struct device:dma_ops

PATCH In review Jonathan Corbet 2 participants 2 messages Aug 24, 2017 Driver core

lore
Share & tools
lore

Jonathan Corbet

author
#0 lore raw

PATCH 1/1 driver core: Document struct device:dma_ops

Commit 5657933dbb6e (treewide: Move dma_ops from struct dev_archdata into struct device) added the dma_ops field to struct device, but did not update the kerneldoc comment, yielding this warning:

./include/linux/device.h:969: warning: No description found for parameter 'dma_ops'

Add a description and bring a little peace to the world.

Signed-off-by Jonathan Corbet <[email protected]>
---
 include/linux/device.h | 1 +
 1 file changed, 1 insertion(+)
include/linux/device.h +1 -0
index 723cd54b94da..ed9904728cda 100644
@@ -847,6 +847,7 @@ struct dev_links_info {
  * @msi_list:	Hosts MSI descriptors
  * @msi_domain: The generic MSI domain this device is using.
  * @numa_node:	NUMA node this device is close to.
+ * @dma_ops:    DMA mapping operations for this device.
  * @dma_mask:	Dma mask (if dma'ble device).
  * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
  * 		hardware supports 64-bit addresses for consistent allocations
Signature · 1 line
2.13.4
Reviewed-by on v1 1/1
#1 lore raw
Quoted 18 lines · Jonathan Corbet

Commit 5657933dbb6e (treewide: Move dma_ops from struct dev_archdata into struct device) added the dma_ops field to struct device, but did not update the kerneldoc comment, yielding this warning:

./include/linux/device.h:969: warning: No description found for parameter 'dma_ops'

Add a description and bring a little peace to the world.

Signed-off-by Jonathan Corbet <[email protected]>
---
 include/linux/device.h | 1 +
 1 file changed, 1 insertion(+)
include/linux/device.h +0 -0
index 723cd54b94da..ed9904728cda 100644

include/linux/device.h struct dev_links_info { · line 853

Quoted 7 lines
include/linux/device.h +1 -0
@@ -847,6 +847,7 @@ struct dev_links_info {
  * @msi_list:	Hosts MSI descriptors
  * @msi_domain: The generic MSI domain this device is using.
  * @numa_node:	NUMA node this device is close to.
+ * @dma_ops:    DMA mapping operations for this device.
  * @dma_mask:	Dma mask (if dma'ble device).
  * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
  * 		hardware supports 64-bit addresses for consistent allocations

Thanks Jonathan for this patch.

Reviewed-by Bart Van Assche <[email protected]>