Explorar el Código

docs/specs/acpi_pci_hotplug: Convert to rST

Convert the PCI hotplug spec document to rST.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Igor Mammedov <imammedo@redhat.com>
Peter Maydell hace 4 años
padre
commit
f054eb1c92
Se han modificado 2 ficheros con 21 adiciones y 17 borrados
  1. 20 17
      docs/specs/acpi_pci_hotplug.rst
  2. 1 0
      docs/specs/index.rst

+ 20 - 17
docs/specs/acpi_pci_hotplug.txt → docs/specs/acpi_pci_hotplug.rst

@@ -1,45 +1,48 @@
 QEMU<->ACPI BIOS PCI hotplug interface
 QEMU<->ACPI BIOS PCI hotplug interface
---------------------------------------
+======================================
 
 
 QEMU supports PCI hotplug via ACPI, for PCI bus 0. This document
 QEMU supports PCI hotplug via ACPI, for PCI bus 0. This document
 describes the interface between QEMU and the ACPI BIOS.
 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
 Generic ACPI GPE block. Bit 1 (GPE.1) used to notify PCI hotplug/eject
 event to ACPI BIOS, via SCI interrupt.
 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.
 Slot injection notification pending. One bit per slot.
 
 
 Read by ACPI BIOS GPE.1 handler to notify OS of injection
 Read by ACPI BIOS GPE.1 handler to notify OS of injection
 events.  Read-only.
 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.
 Slot removal notification pending. One bit per slot.
 
 
 Read by ACPI BIOS GPE.1 handler to notify OS of removal
 Read by ACPI BIOS GPE.1 handler to notify OS of removal
 events.  Read-only.
 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.
 Write: Used by ACPI BIOS _EJ0 method to request device removal.
 One bit per slot.
 One bit per slot.
 
 
 Read: Hotplug features register.  Used by platform to identify features
 Read: Hotplug features register.  Used by platform to identify features
 available.  Current base feature set (no bits set):
 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
 Used by ACPI BIOS _RMV method to indicate removability status to OS. One
-bit per slot.  Read-only
+bit per slot.  Read-only.

+ 1 - 0
docs/specs/index.rst

@@ -15,3 +15,4 @@ guest hardware that is specific to QEMU.
    acpi_hest_ghes
    acpi_hest_ghes
    acpi_cpu_hotplug
    acpi_cpu_hotplug
    acpi_mem_hotplug
    acpi_mem_hotplug
+   acpi_pci_hotplug