]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
PCI/P2PDMA: Add missing struct p2pdma_provider documentation
authorLeon Romanovsky <leonro@nvidia.com>
Sun, 4 Jan 2026 12:51:28 +0000 (14:51 +0200)
committerBjorn Helgaas <bhelgaas@google.com>
Tue, 6 Jan 2026 22:18:02 +0000 (16:18 -0600)
Two fields in struct p2pdma_provider were not documented, which resulted
in the following kernel-doc warning:

  Warning: include/linux/pci-p2pdma.h:26 struct member 'owner' not described in 'p2pdma_provider'
  Warning: include/linux/pci-p2pdma.h:26 struct member 'bus_offset' not described in 'p2pdma_provider'

Repro:

  $ scripts/kernel-doc -none include/linux/pci-p2pdma.h

Fixes: f58ef9d1d135 ("PCI/P2PDMA: Separate the mmap() support from the core logic")
Reported-by: Bjorn Helgaas <helgaas@kernel.org>
Closes: https://lore.kernel.org/all/20260102234033.GA246107@bhelgaas
Signed-off-by: Leon Romanovsky <leonro@nvidia.com>
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Reviewed-by: Logan Gunthorpe <logang@deltatee.com>
Link: https://patch.msgid.link/20260104-fix-p2p-kdoc-v1-1-6d181233f8bc@nvidia.com
include/linux/pci-p2pdma.h

index 517e121d2598e3d14571b94e47e4bade6beef574..873de20a224759d1ca5eb8290f287619aa5026e8 100644 (file)
@@ -20,6 +20,8 @@ struct scatterlist;
  * struct p2pdma_provider
  *
  * A p2pdma provider is a range of MMIO address space available to the CPU.
+ * @owner: Device to which this provider belongs.
+ * @bus_offset: Bus offset for p2p communication.
  */
 struct p2pdma_provider {
        struct device *owner;