Mirrors_Framework/rtems
1
0
Fork 0
mirror of https://gitlab.rtems.org/rtems/rtos/rtems.git synced 2026-10-06 10:59:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

cpukit/libpci: Add the Doxygen file headers

Browse Source 
No file in libpci had a Doxygen block.  Doxygen listed none of the 22
files, so the PCI library had no page of its own.

Give each file a block with @file, @ingroup and @brief.  The brief names
what the file implements.

Updates #5717.

Assisted-by: Claude:claude-opus-5 claude-code
Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
This commit is contained in:
Sebastian Huber
2026-09-01 20:17:20 +00:00
committed by Gedare Bloom
parent b4d322971c
commit 96081d7d90
22 changed files with 192 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cpukit/libpci/pci_access.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of the PCI
* configuration space access functions.
*/
/* PCI Access Library
*
* COPYRIGHT (c) 2010 Cobham Gaisler AB.
cpukit/libpci/pci_access_func.c
+8
View File
@@ -1,5 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of pci_access_func().
*/
/* PCI Access Library
*
* COPYRIGHT (c) 2010 Cobham Gaisler AB.
cpukit/libpci/pci_access_io.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of the PCI I/O space
* access functions.
*/
/* PCI Access Library
*
* COPYRIGHT (c) 2010 Cobham Gaisler AB.
cpukit/libpci/pci_access_mem.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of the PCI registers
* over memory space access functions.
*/
/* PCI Access Library
* Registers-over-Memory Space - Generic Big/Little endian PCI bus definitions
*
cpukit/libpci/pci_access_mem_be.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of the PCI registers
* over memory space access functions for a big endian PCI bus.
*/
/* PCI Access Library
* Registers-over-Memory Space - Generic Big endian PCI bus definitions
*
cpukit/libpci/pci_access_mem_le.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of the PCI registers
* over memory space access functions for a little endian PCI bus.
*/
/* PCI Access Library
* Registers-over-Memory Space - Generic Little endian PCI bus definitions
*
cpukit/libpci/pci_bus.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of the PCI bus driver
* of the driver manager.
*/
/* PCI bus driver.
*
* COPYRIGHT (c) 2008 Cobham Gaisler AB.
cpukit/libpci/pci_cfg.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of the PCI
* configuration library initialization.
*/
/* PCI Configuration Library
*
* COPYRIGHT (c) 2010 Cobham Gaisler AB.
cpukit/libpci/pci_cfg_auto.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of the automatic PCI
* configuration.
*/
/* PCI (Auto) configuration Library. Setup PCI configuration space and IRQ.
*
* COPYRIGHT (c) 2010 Cobham Gaisler AB.
cpukit/libpci/pci_cfg_peripheral.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of
* pci_config_peripheral().
*/
/* PCI (Peripheral) Configuration Library
*
* COPYRIGHT (c) 2011 Cobham Gaisler AB.
cpukit/libpci/pci_cfg_print_code.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation which prints the PCI
* configuration as C code.
*/
/* PCI (Static) Configuration Library. PCI Configuration C code console
* printout routines that can be used to build a static PCI configuration.
*
cpukit/libpci/pci_cfg_read.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation which reads the PCI
* configuration set up by the boot loader.
*/
/* Read current PCI configuration that bootloader or BIOS has already setup
* and initialize the PCI structures.
*
cpukit/libpci/pci_cfg_static.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of the static PCI
* configuration.
*/
/* PCI (Static) Configuration Library
*
* COPYRIGHT (c) 2010 Cobham Gaisler AB.
cpukit/libpci/pci_find.c
+8
View File
@@ -1,5 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of pci_find().
*/
/* PCI Help function, Find a PCI device by VENDOR/DEVICE ID
*
* COPYRIGHT (c) 2010 Cobham Gaisler AB.
cpukit/libpci/pci_find_dev.c
+8
View File
@@ -1,5 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of pci_find_dev().
*/
/* PCI Help function, Find a PCI device by VENDOR/DEVICE ID
*
* COPYRIGHT (c) 2010 Cobham Gaisler AB.
cpukit/libpci/pci_for_each.c
+8
View File
@@ -1,5 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of pci_for_each().
*/
/* PCI Help Function, iterate over all PCI devices. Find devices by cfg access.
*
* COPYRIGHT (c) 2010 Cobham Gaisler AB.
cpukit/libpci/pci_for_each_child.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of
* pci_for_each_child().
*/
/* PCI Help function, iterate all PCI device children of PCI bus.
*
* COPYRIGHT (c) 2010 Cobham Gaisler AB.
cpukit/libpci/pci_for_each_dev.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of
* pci_for_each_dev().
*/
/* PCI Help function, iterate all PCI devices.
*
* COPYRIGHT (c) 2010 Cobham Gaisler AB.
cpukit/libpci/pci_get_dev.c
+8
View File
@@ -1,5 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of pci_get_dev().
*/
/* PCI Help function, Find a PCI device by BUS|SLOT|FUNCTION
*
* COPYRIGHT (c) 2010 Cobham Gaisler AB.
cpukit/libpci/pci_internal.h
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This header file provides the internal interfaces of the PCI
* library.
*/
/* Private libpci declarations
*
* COPYRIGHT (c) 2015 Cobham Gaisler AB.
cpukit/libpci/pci_irq.c
+8
View File
@@ -1,5 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation of pci_dev_irq().
*/
/* PCI IRQ Library
*
* COPYRIGHT (c) 2010 Cobham Gaisler AB.
cpukit/libpci/pci_print.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This source file contains the implementation which prints the PCI
* configuration.
*/
/* PCI Print Current Configuration To Terminal
*
* COPYRIGHT (c) 2010 Cobham Gaisler AB.