michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc/pcie: Add basic entry for PCIe doxygen documentation

Browse source 
This has been missing so let's add it.

Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
This commit is contained in:
Tomasz Bursztyka 2023-06-06 11:37:54 +02:00 • committed by Anas Nashif
commit 1b51be4ba0
6 changed files with 58 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
doc/hardware/peripherals/index.rst
View file

@ -40,6 +40,7 @@ Peripherals
mdio.rst
mipi_dsi.rst
mbox.rst
pcie.rst
peci.rst
ps2.rst
pwm.rst

13
doc/hardware/peripherals/pcie.rst Normal file
View file

@ -0,0 +1,13 @@
.. _pcie_api:
Peripheral Component Interconnect express Bus (PCIe)
####################################################
Overview
********
API Reference
*************
.. doxygengroup:: pcie_host_interface

11
include/zephyr/drivers/pcie/cap.h
View file

@ -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_ */

11
include/zephyr/drivers/pcie/msi.h
View file

@ -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_ */

11
include/zephyr/drivers/pcie/pcie.h
View file

@ -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_ */

11
include/zephyr/drivers/pcie/ptm.h
View file

@ -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_ */