PCI: endpoint: Add kernel-doc for pci_epc_mem_init() API
authorManivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
Mon, 17 Jul 2023 06:54:59 +0000 (12:24 +0530)
committerKrzysztof Wilczyński <kwilczynski@kernel.org>
Sat, 26 Aug 2023 16:54:46 +0000 (16:54 +0000)
Add missing kernel-doc for pci_epc_mem_init() API.

Link: https://lore.kernel.org/linux-pci/20230717065459.14138-8-manivannan.sadhasivam@linaro.org
Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
Signed-off-by: Krzysztof Wilczyński <kwilczynski@kernel.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
drivers/pci/endpoint/pci-epc-mem.c

index 7dcf6f480b827b0779ecd472103fedd83bab2dd0..a9c028f58da1748cdc7c1cac45ee763e221dc04f 100644 (file)
@@ -115,6 +115,16 @@ err_mem:
 }
 EXPORT_SYMBOL_GPL(pci_epc_multi_mem_init);
 
+/**
+ * pci_epc_mem_init() - Initialize the pci_epc_mem structure
+ * @epc: the EPC device that invoked pci_epc_mem_init
+ * @base: Physical address of the window region
+ * @size: Total Size of the window region
+ * @page_size: Page size of the window region
+ *
+ * Invoke to initialize a single pci_epc_mem structure used by the
+ * endpoint functions to allocate memory for mapping the PCI host memory
+ */
 int pci_epc_mem_init(struct pci_epc *epc, phys_addr_t base,
                     size_t size, size_t page_size)
 {