doc/pcie: Add basic entry for PCIe doxygen documentation

This has been missing so let's add it. Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
pengxy · Jun 17, 2023 · 1b51be4 · 1b51be4
1 parent d39645a
commit 1b51be4
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 0 deletions.
diff --git a/doc/hardware/peripherals/index.rst b/doc/hardware/peripherals/index.rst
@@ -40,6 +40,7 @@ Peripherals
    mdio.rst
    mipi_dsi.rst
    mbox.rst
+   pcie.rst
    peci.rst
    ps2.rst
    pwm.rst

diff --git a/doc/hardware/peripherals/pcie.rst b/doc/hardware/peripherals/pcie.rst
@@ -0,0 +1,13 @@
+.. _pcie_api:
+
+Peripheral Component Interconnect express Bus (PCIe)
+####################################################
+
+Overview
+********
+
+
+API Reference
+*************
+
+.. doxygengroup:: pcie_host_interface
diff --git a/include/zephyr/drivers/pcie/cap.h b/include/zephyr/drivers/pcie/cap.h
@@ -6,6 +6,13 @@
 #ifndef ZEPHYR_INCLUDE_DRIVERS_PCIE_CAP_H_
 #define ZEPHYR_INCLUDE_DRIVERS_PCIE_CAP_H_
 
+/**
+ * @brief PCIe Capabilities
+ * @defgroup pcie_capabilities PCIe Capabilities
+ * @ingroup pcie_host_interface
+ * @{
+ */
+
 /*
  * PCI & PCI Express Capabilities
  * from PCI Code and ID Assignment Specification Revision 1.11
@@ -79,4 +86,8 @@
 #define PCIE_EXT_CAP_ID_AP	0x002BU	/* Alternate Protocol */
 #define PCIE_EXT_CAP_ID_SFI	0x002CU	/* System Firmware Intermediary  */
 
+/**
+ * @}
+ */
+
 #endif /* ZEPHYR_INCLUDE_DRIVERS_PCIE_CAP_H_ */
diff --git a/include/zephyr/drivers/pcie/msi.h b/include/zephyr/drivers/pcie/msi.h
@@ -7,6 +7,13 @@
 #ifndef ZEPHYR_INCLUDE_DRIVERS_PCIE_MSI_H_
 #define ZEPHYR_INCLUDE_DRIVERS_PCIE_MSI_H_
 
+/**
+ * @brief PCIe Host MSI Interface
+ * @defgroup pcie_host_msi_interface PCIe Host MSI Interface
+ * @ingroup pcie_host_interface
+ * @{
+ */
+
 #include <zephyr/kernel.h>
 #include <zephyr/types.h>
 #include <stdbool.h>
@@ -190,4 +197,8 @@ extern bool pcie_is_msi(pcie_bdf_t bdf);
 }
 #endif
 
+/**
+ * @}
+ */
+
 #endif /* ZEPHYR_INCLUDE_DRIVERS_PCIE_MSI_H_ */
diff --git a/include/zephyr/drivers/pcie/pcie.h b/include/zephyr/drivers/pcie/pcie.h
@@ -7,6 +7,13 @@
 #ifndef ZEPHYR_INCLUDE_DRIVERS_PCIE_PCIE_H_
 #define ZEPHYR_INCLUDE_DRIVERS_PCIE_PCIE_H_
 
+/**
+ * @brief PCIe Host Interface
+ * @defgroup pcie_host_interface PCIe Host Interface
+ * @ingroup io_interfaces
+ * @{
+ */
+
 #include <stddef.h>
 #include <zephyr/devicetree.h>
 #include <zephyr/dt-bindings/pcie/pcie.h>
@@ -596,4 +603,8 @@ extern bool pcie_connect_dynamic_irq(pcie_bdf_t bdf,
 }
 #endif
 
+/**
+ * @}
+ */
+
 #endif /* ZEPHYR_INCLUDE_DRIVERS_PCIE_PCIE_H_ */
diff --git a/include/zephyr/drivers/pcie/ptm.h b/include/zephyr/drivers/pcie/ptm.h
@@ -8,6 +8,13 @@
 #ifndef ZEPHYR_INCLUDE_DRIVERS_PCIE_PTM_H_
 #define ZEPHYR_INCLUDE_DRIVERS_PCIE_PTM_H_
 
+/**
+ * @brief PCIe Host PTM Interface
+ * @defgroup pcie_host_ptm_interface PCIe Host PTM Interface
+ * @ingroup pcie_host_interface
+ * @{
+ */
+
 #include <stddef.h>
 #include <zephyr/types.h>
 
@@ -27,4 +34,8 @@ bool pcie_ptm_enable(pcie_bdf_t bdf);
 }
 #endif
 
+/**
+ * @}
+ */
+
 #endif /* ZEPHYR_INCLUDE_DRIVERS_PCIE_PTM_H_ */