From 0ca02775eb10c8faad62a7d083c80bda5f4679d5 Mon Sep 17 00:00:00 2001
From: raiden00pl <raiden00@railab.me>
Date: Thu, 7 Nov 2024 09:41:01 +0100
Subject: [PATCH] Documentation: add PCI bus doc

Documentation: add PCI bus doc
---
 .../components/drivers/special/index.rst      |  1 +
 .../components/drivers/special/pci/index.rst  | 61 +++++++++++++++++++
 2 files changed, 62 insertions(+)
 create mode 100644 Documentation/components/drivers/special/pci/index.rst

diff --git a/Documentation/components/drivers/special/index.rst b/Documentation/components/drivers/special/index.rst
index b55212f48b5..f2df595c826 100644
--- a/Documentation/components/drivers/special/index.rst
+++ b/Documentation/components/drivers/special/index.rst
@@ -49,6 +49,7 @@ following section.
   usrsock.rst
   mmcsd.rst
   net/index.rst
+  pci/index.rst
   pinctrl.rst
   pipes.rst
   power/index.rst
diff --git a/Documentation/components/drivers/special/pci/index.rst b/Documentation/components/drivers/special/pci/index.rst
new file mode 100644
index 00000000000..04185b31c57
--- /dev/null
+++ b/Documentation/components/drivers/special/pci/index.rst
@@ -0,0 +1,61 @@
+==================
+PCI(e) Bus Drivers
+==================
+
+PCI(e) bus driver can be found in ``drivers/pci``.
+
+Supported PCI devices
+=====================
+
+PCI QEMU Test Device
+--------------------
+
+Test device provided by QEMU and enabled with ``-device pci-testdev``.
+
+PCI QEMU EDU Device
+-------------------
+
+Test device provided by QEMU and enabled with ``-device edu``.
+
+Inter-VM share memory Device (ivshmem)
+--------------------------------------
+
+Inter-VM shared memory support support can be found in ``drivers/pci/pci_ivshmem.c``.
+
+This implementation is for ``ivshmem-v1`` which is compatible with QEMU and
+ACRN hypervisor but won't work with Jailhouse hypervisor which uses ``ivshmem-v2``.
+
+16550 Compatible Serial Card
+----------------------------
+
+UART 16550 compatible PCI serial card support can be found
+in ``drivers/serial/uart_pci_16550.c``.
+
+Supported devices:
+
+- AX99100
+- QEMU pci-serial device
+- QEMU pci-serial-2x device
+- QEMU pci-serial-4x device
+
+Intel e1000
+-----------
+
+Intel e1000 compatible NIC support can be found in ``drivers/net/e1000.c``.
+
+Supported devices:
+
+- Intel I219
+- Intel 82540EM
+- Intel 82574L
+- Intel 82574L
+
+Intel igc
+---------
+
+Intel igc compatible NIC support can be found in ``drivers/net/igc.c``.
+
+Supported devices:
+
+- Intel I225LM
+- Intel I226V