Commit 2db6b72c authored Dec 06, 2023 by Bjorn Helgaas

PCI: Fix kernel-doc issues

Fix kernel-doc issues reported by
"find include -name \*pci\* | xargs scripts/kernel-doc -none":

include/linux/pci.h:731: warning: Function parameter or member 'pdev' not described in 'pci_is_vga'
include/linux/pci-epc.h:154: warning: Function parameter or member 'list_lock' not described in 'pci_epc'
include/linux/pci-epf.h:83: warning: expecting prototype for struct pci_epf_event_ops. Prototype was for struct pci_epc_event_ops instead

Link: https://lore.kernel.org/r/20240111162850.2177655-1-helgaas@kernel.org

Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Reviewed-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Sui Jingfeng <suijingfeng@loongson.cn>

parent 516f3664

include/linux/pci-epc.h

+1 −1

Original line number	Diff line number	Diff line
		@@ -122,7 +122,7 @@ struct pci_epc_mem {
		* struct pci_epc - represents the PCI EPC device
		* @dev: PCI EPC device
		* @pci_epf: list of endpoint functions present in this EPC device
		* list_lock: Mutex for protecting pci_epf list
		* @list_lock: Mutex for protecting pci_epf list
		* @ops: function pointers for performing endpoint operations
		* @windows: array of address space of the endpoint controller
		* @mem: first window of the endpoint controller, which corresponds to

include/linux/pci-epf.h

+1 −1

Original line number	Diff line number	Diff line
		@@ -68,7 +68,7 @@ struct pci_epf_ops {
		};

		/**
		* struct pci_epf_event_ops - Callbacks for capturing the EPC events
		* struct pci_epc_event_ops - Callbacks for capturing the EPC events
		* @core_init: Callback for the EPC initialization complete event
		* @link_up: Callback for the EPC link up event
		* @link_down: Callback for the EPC link down event

include/linux/pci.h

+1 −0

Original line number	Diff line number	Diff line
		@@ -715,6 +715,7 @@ static inline bool pci_is_bridge(struct pci_dev *dev)

		/**
		* pci_is_vga - check if the PCI device is a VGA device
		* @pdev: PCI device
		*
		* The PCI Code and ID Assignment spec, r1.15, secs 1.4 and 1.1, define
		* VGA Base Class and Sub-Classes: