summary refs log tree commit diff stats
path: root/docs/specs/pci-serial.rst
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2023-04-20 17:03:33 +0100
committerMichael S. Tsirkin <mst@redhat.com>2023-04-24 22:56:55 -0400
commit3669b594d88930f9e5d7c83e038d7d9ca5a75378 (patch)
treea690d36e7dba2d20747d343133a2e703ddb41337 /docs/specs/pci-serial.rst
parent0c0e21d1c1e2dde4f7437bcd5c53127013cc25f7 (diff)
downloadfocaccia-qemu-3669b594d88930f9e5d7c83e038d7d9ca5a75378.tar.gz
focaccia-qemu-3669b594d88930f9e5d7c83e038d7d9ca5a75378.zip
docs/specs: Convert pci-serial.txt to rst
Convert pci-serial.txt to reStructuredText. This includes
some wordsmithing, and the correction of the docs to note
that the Windows inf file includes 2x and 4x support
(as it has done since commit dc9528fdf9f61 in 2014).

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20230420160334.1048224-3-peter.maydell@linaro.org>
Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Diffstat (limited to 'docs/specs/pci-serial.rst')
-rw-r--r--docs/specs/pci-serial.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/specs/pci-serial.rst b/docs/specs/pci-serial.rst
new file mode 100644
index 0000000000..8d916a3669
--- /dev/null
+++ b/docs/specs/pci-serial.rst
@@ -0,0 +1,37 @@
+=======================
+QEMU PCI serial devices
+=======================
+
+QEMU implements some PCI serial devices which are simple PCI
+wrappers around one or more 16550 UARTs.
+
+There is one single-port variant and two multiport-variants.  Linux
+guests work out-of-the box with all cards.  There is a Windows inf file
+(``docs/qemupciserial.inf``) to set up the cards in Windows guests.
+
+
+Single-port card
+----------------
+
+Name:
+  ``pci-serial``
+PCI ID:
+  1b36:0002
+PCI Region 0:
+   IO bar, 8 bytes long, with the 16550 UART mapped to it.
+Interrupt:
+   Wired to pin A.
+
+
+Multiport cards
+---------------
+
+Name:
+  ``pci-serial-2x``, ``pci-serial-4x``
+PCI ID:
+  1b36:0003 (``-2x``) and 1b36:0004 (``-4x``)
+PCI Region 0:
+   IO bar, with two or four 16550 UARTs mapped after each other.
+   The first is at offset 0, the second at offset 8, and so on.
+Interrupt:
+   Wired to pin A.