OpenE2K/qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

docs/specs: Convert pci-serial.txt to rst

Browse Source 
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 dc9528fdf9 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>
This commit is contained in:
Peter Maydell 2023-04-20 17:03:33 +01:00 committed by Michael S. Tsirkin
parent 0c0e21d1c1
commit 3669b594d8
6 changed files with 43 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/specs/index.rst
View File

@ -9,6 +9,7 @@ guest hardware that is specific to QEMU.
:maxdepth: 2
pci-ids
pci-serial
ppc-xive
ppc-spapr-xive
ppc-spapr-numa

6
docs/specs/pci-ids.rst
View File

@ -63,11 +63,11 @@ PCI devices (other than virtio):
1b36:0001
PCI-PCI bridge
1b36:0002
PCI serial port (16550A) adapter (``docs/specs/pci-serial.txt``)
PCI serial port (16550A) adapter (:doc:`pci-serial`)
1b36:0003
PCI Dual-port 16550A adapter (``docs/specs/pci-serial.txt``)
PCI Dual-port 16550A adapter (:doc:`pci-serial`)
1b36:0004
PCI Quad-port 16550A adapter (``docs/specs/pci-serial.txt``)
PCI Quad-port 16550A adapter (:doc:`pci-serial`)
1b36:0005
PCI test device (``docs/specs/pci-testdev.txt``)
1b36:0006

37
docs/specs/pci-serial.rst Normal file
View File

@ -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.

34
docs/specs/pci-serial.txt
View File

@ -1,34 +0,0 @@
QEMU pci serial devices
=======================
There is one single-port variant and two muliport-variants. Linux
guests out-of-the box with all cards. There is a Windows inf file
(docs/qemupciserial.inf) to setup the single-port card 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 is wired to pin A.
multiport cards
---------------
Name: pci-serial-2x
PCI ID: 1b36:0003
Name: pci-serial-4x
PCI ID: 1b36:0004
PCI Region 0:
IO bar, with two/four 16550 uart mapped after each other.
The first is at offset 0, second at offset 8, ...
Interrupt is wired to pin A.

2
hw/char/serial-pci-multi.c
View File

@ -25,7 +25,7 @@
* THE SOFTWARE.
*/
/* see docs/specs/pci-serial.txt */
/* see docs/specs/pci-serial.rst */
#include "qemu/osdep.h"
#include "qapi/error.h"

2
hw/char/serial-pci.c
View File

@ -23,7 +23,7 @@
* THE SOFTWARE.
*/
/* see docs/specs/pci-serial.txt */
/* see docs/specs/pci-serial.rst */
#include "qemu/osdep.h"
#include "qapi/error.h"