| Message ID | 20210727170414.3368-4-peter.maydell@linaro.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | docs/specs: Convert various ACPI docs to rST | expand |
On Tue, 27 Jul 2021 18:04:12 +0100 Peter Maydell <peter.maydell@linaro.org> wrote: > Convert the PCI hotplug spec document to rST. Julia, This doc doesn't describe ACPI PCI hotplug we have now, Care to update it? > --- > ...i_pci_hotplug.txt => acpi_pci_hotplug.rst} | 37 ++++++++++--------- > docs/specs/index.rst | 1 + > 2 files changed, 21 insertions(+), 17 deletions(-) > rename docs/specs/{acpi_pci_hotplug.txt => acpi_pci_hotplug.rst} (51%) > > diff --git a/docs/specs/acpi_pci_hotplug.txt b/docs/specs/acpi_pci_hotplug.rst > similarity index 51% > rename from docs/specs/acpi_pci_hotplug.txt > rename to docs/specs/acpi_pci_hotplug.rst > index a839434f313..685bc5c322f 100644 > --- a/docs/specs/acpi_pci_hotplug.txt > +++ b/docs/specs/acpi_pci_hotplug.rst > @@ -1,45 +1,48 @@ > QEMU<->ACPI BIOS PCI hotplug interface > --------------------------------------- > +====================================== > > QEMU supports PCI hotplug via ACPI, for PCI bus 0. This document > describes the interface between QEMU and the ACPI BIOS. > > -ACPI GPE block (IO ports 0xafe0-0xafe3, byte access): > ------------------------------------------ > +ACPI GPE block (IO ports 0xafe0-0xafe3, byte access) > +---------------------------------------------------- > > Generic ACPI GPE block. Bit 1 (GPE.1) used to notify PCI hotplug/eject > event to ACPI BIOS, via SCI interrupt. > > -PCI slot injection notification pending (IO port 0xae00-0xae03, 4-byte access): > ---------------------------------------------------------------- > +PCI slot injection notification pending (IO port 0xae00-0xae03, 4-byte access) > +------------------------------------------------------------------------------ > + > Slot injection notification pending. One bit per slot. > > Read by ACPI BIOS GPE.1 handler to notify OS of injection > events. Read-only. > > -PCI slot removal notification (IO port 0xae04-0xae07, 4-byte access): > ------------------------------------------------------ > +PCI slot removal notification (IO port 0xae04-0xae07, 4-byte access) > +-------------------------------------------------------------------- > + > Slot removal notification pending. One bit per slot. > > Read by ACPI BIOS GPE.1 handler to notify OS of removal > events. Read-only. > > -PCI device eject (IO port 0xae08-0xae0b, 4-byte access): > ----------------------------------------- > +PCI device eject (IO port 0xae08-0xae0b, 4-byte access) > +------------------------------------------------------- > > Write: Used by ACPI BIOS _EJ0 method to request device removal. > One bit per slot. > > Read: Hotplug features register. Used by platform to identify features > available. Current base feature set (no bits set): > - - Read-only "up" register @0xae00, 4-byte access, bit per slot > - - Read-only "down" register @0xae04, 4-byte access, bit per slot > - - Read/write "eject" register @0xae08, 4-byte access, > - write: bit per slot eject, read: hotplug feature set > - - Read-only hotplug capable register @0xae0c, 4-byte access, bit per slot > > -PCI removability status (IO port 0xae0c-0xae0f, 4-byte access): > ------------------------------------------------ > +- Read-only "up" register @0xae00, 4-byte access, bit per slot > +- Read-only "down" register @0xae04, 4-byte access, bit per slot > +- Read/write "eject" register @0xae08, 4-byte access, > + write: bit per slot eject, read: hotplug feature set > +- Read-only hotplug capable register @0xae0c, 4-byte access, bit per slot > + > +PCI removability status (IO port 0xae0c-0xae0f, 4-byte access) > +-------------------------------------------------------------- > Used by ACPI BIOS _RMV method to indicate removability status to OS. One > -bit per slot. Read-only > +bit per slot. Read-only. > diff --git a/docs/specs/index.rst b/docs/specs/index.rst > index 17cc7868b91..8296fb19b72 100644 > --- a/docs/specs/index.rst > +++ b/docs/specs/index.rst > @@ -15,3 +15,4 @@ guest hardware that is specific to QEMU. > acpi_hest_ghes > acpi_cpu_hotplug > acpi_mem_hotplug > + acpi_pci_hotplug
diff --git a/docs/specs/acpi_pci_hotplug.txt b/docs/specs/acpi_pci_hotplug.rst similarity index 51% rename from docs/specs/acpi_pci_hotplug.txt rename to docs/specs/acpi_pci_hotplug.rst index a839434f313..685bc5c322f 100644 --- a/docs/specs/acpi_pci_hotplug.txt +++ b/docs/specs/acpi_pci_hotplug.rst @@ -1,45 +1,48 @@ QEMU<->ACPI BIOS PCI hotplug interface --------------------------------------- +====================================== QEMU supports PCI hotplug via ACPI, for PCI bus 0. This document describes the interface between QEMU and the ACPI BIOS. -ACPI GPE block (IO ports 0xafe0-0xafe3, byte access): ------------------------------------------ +ACPI GPE block (IO ports 0xafe0-0xafe3, byte access) +---------------------------------------------------- Generic ACPI GPE block. Bit 1 (GPE.1) used to notify PCI hotplug/eject event to ACPI BIOS, via SCI interrupt. -PCI slot injection notification pending (IO port 0xae00-0xae03, 4-byte access): ---------------------------------------------------------------- +PCI slot injection notification pending (IO port 0xae00-0xae03, 4-byte access) +------------------------------------------------------------------------------ + Slot injection notification pending. One bit per slot. Read by ACPI BIOS GPE.1 handler to notify OS of injection events. Read-only. -PCI slot removal notification (IO port 0xae04-0xae07, 4-byte access): ------------------------------------------------------ +PCI slot removal notification (IO port 0xae04-0xae07, 4-byte access) +-------------------------------------------------------------------- + Slot removal notification pending. One bit per slot. Read by ACPI BIOS GPE.1 handler to notify OS of removal events. Read-only. -PCI device eject (IO port 0xae08-0xae0b, 4-byte access): ----------------------------------------- +PCI device eject (IO port 0xae08-0xae0b, 4-byte access) +------------------------------------------------------- Write: Used by ACPI BIOS _EJ0 method to request device removal. One bit per slot. Read: Hotplug features register. Used by platform to identify features available. Current base feature set (no bits set): - - Read-only "up" register @0xae00, 4-byte access, bit per slot - - Read-only "down" register @0xae04, 4-byte access, bit per slot - - Read/write "eject" register @0xae08, 4-byte access, - write: bit per slot eject, read: hotplug feature set - - Read-only hotplug capable register @0xae0c, 4-byte access, bit per slot -PCI removability status (IO port 0xae0c-0xae0f, 4-byte access): ------------------------------------------------ +- Read-only "up" register @0xae00, 4-byte access, bit per slot +- Read-only "down" register @0xae04, 4-byte access, bit per slot +- Read/write "eject" register @0xae08, 4-byte access, + write: bit per slot eject, read: hotplug feature set +- Read-only hotplug capable register @0xae0c, 4-byte access, bit per slot + +PCI removability status (IO port 0xae0c-0xae0f, 4-byte access) +-------------------------------------------------------------- Used by ACPI BIOS _RMV method to indicate removability status to OS. One -bit per slot. Read-only +bit per slot. Read-only. diff --git a/docs/specs/index.rst b/docs/specs/index.rst index 17cc7868b91..8296fb19b72 100644 --- a/docs/specs/index.rst +++ b/docs/specs/index.rst @@ -15,3 +15,4 @@ guest hardware that is specific to QEMU. acpi_hest_ghes acpi_cpu_hotplug acpi_mem_hotplug + acpi_pci_hotplug
Convert the PCI hotplug spec document to rST. --- ...i_pci_hotplug.txt => acpi_pci_hotplug.rst} | 37 ++++++++++--------- docs/specs/index.rst | 1 + 2 files changed, 21 insertions(+), 17 deletions(-) rename docs/specs/{acpi_pci_hotplug.txt => acpi_pci_hotplug.rst} (51%) -- 2.20.1