Create a subdirectory for s390x under docs/system/ and move the
existing vfio-ap documentation there.

Create an initial document describing s390x system emulation.

Suggested-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Cornelia Huck <cohuck@redhat.com>
---

Mostly an initial version so that Janosch can base his protected virt
documentation on something; there's room for more here :)

If this looks good, I'll queue it on my s390-next branch for 5.1.

---
 MAINTAINERS                         |  5 +++--
 docs/system/index.rst               |  1 -
 docs/system/{ => s390x}/vfio-ap.rst |  0
 docs/system/target-s390x.rst        | 26 ++++++++++++++++++++++++++
 docs/system/targets.rst             |  1 +
 5 files changed, 30 insertions(+), 3 deletions(-)
 rename docs/system/{ => s390x}/vfio-ap.rst (100%)
 create mode 100644 docs/system/target-s390x.rst

diff --git a/MAINTAINERS b/MAINTAINERS
index 7364af0d8b07..dfbd5b0c5de9 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -101,7 +101,8 @@ F: include/hw/watchdog/wdt_diag288.h
 F: pc-bios/s390-ccw/
 F: pc-bios/s390-ccw.img
 F: target/s390x/
-F: docs/vfio-ap.txt
+F: docs/system/target-s390x.rst
+F: docs/system/s390x/
 F: tests/migration/s390x/
 K: ^Subject:.*(?i)s390x?
 T: git https://github.com/cohuck/qemu.git s390-next
@@ -1606,7 +1607,7 @@ F: hw/s390x/ap-bridge.c
 F: include/hw/s390x/ap-device.h
 F: include/hw/s390x/ap-bridge.h
 F: hw/vfio/ap.c
-F: docs/system/vfio-ap.rst
+F: docs/system/s390x/vfio-ap.rst
 L: qemu-s390x@nongnu.org
 
 vhost
diff --git a/docs/system/index.rst b/docs/system/index.rst
index 6e5f20fa1333..c0f685b818e5 100644
--- a/docs/system/index.rst
+++ b/docs/system/index.rst
@@ -30,7 +30,6 @@ Contents:
    managed-startup
    targets
    security
-   vfio-ap
    deprecated
    build-platforms
    license
diff --git a/docs/system/vfio-ap.rst b/docs/system/s390x/vfio-ap.rst
similarity index 100%
rename from docs/system/vfio-ap.rst
rename to docs/system/s390x/vfio-ap.rst
diff --git a/docs/system/target-s390x.rst b/docs/system/target-s390x.rst
new file mode 100644
index 000000000000..4c8b7cdd6615
--- /dev/null
+++ b/docs/system/target-s390x.rst
@@ -0,0 +1,26 @@
+.. _s390x-System-emulator:
+
+s390x System emulator
+---------------------
+
+QEMU can emulate z/Architecture (in particular, 64 bit) s390x systems
+via the ``qemu-system-s390x`` binary. Only one machine type,
+``s390-ccw-virtio``, is supported (with versioning for compatibility
+handling).
+
+When using KVM as accelerator, QEMU can emulate CPUs up to the generation
+of the host. When using the default cpu model with TCG as accelerator,
+QEMU will emulate a subset of z13 cpu features that should be enough to run
+distributions built for the z13.
+
+Device support
+==============
+
+QEMU will not emulate most of the traditional devices found under LPAR or
+z/VM; virtio devices (especially using virtio-ccw) make up the bulk of
+the available devices. Passthrough of host devices via vfio-pci, vfio-ccw,
+or vfio-ap is also available.
+
+.. toctree::
+   s390x/vfio-ap
+
diff --git a/docs/system/targets.rst b/docs/system/targets.rst
index eba3111247f6..0d8f91580aa5 100644
--- a/docs/system/targets.rst
+++ b/docs/system/targets.rst
@@ -17,3 +17,4 @@ Contents:
    target-arm
    target-m68k
    target-xtensa
+   target-s390x
-- 
2.21.1

On Wed, 18 Mar 2020 at 10:39, Cornelia Huck <cohuck@redhat.com> wrote:
>
> Create a subdirectory for s390x under docs/system/ and move the
> existing vfio-ap documentation there.
>
> Create an initial document describing s390x system emulation.
>
> Suggested-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Cornelia Huck <cohuck@redhat.com>
> ---
>
> Mostly an initial version so that Janosch can base his protected virt
> documentation on something; there's room for more here :)
>
> If this looks good, I'll queue it on my s390-next branch for 5.1.

I would be happy to take documentation cleanups like this
for 5.0 during the early to mid part of freeze.

thanks
-- PMM

On Wed, 18 Mar 2020 11:12:11 +0000
Peter Maydell <peter.maydell@linaro.org> wrote:

> On Wed, 18 Mar 2020 at 10:39, Cornelia Huck <cohuck@redhat.com> wrote:
> >
> > Create a subdirectory for s390x under docs/system/ and move the
> > existing vfio-ap documentation there.
> >
> > Create an initial document describing s390x system emulation.
> >
> > Suggested-by: Peter Maydell <peter.maydell@linaro.org>
> > Signed-off-by: Cornelia Huck <cohuck@redhat.com>
> > ---
> >
> > Mostly an initial version so that Janosch can base his protected virt
> > documentation on something; there's room for more here :)
> >
> > If this looks good, I'll queue it on my s390-next branch for 5.1.  
> 
> I would be happy to take documentation cleanups like this
> for 5.0 during the early to mid part of freeze.

Even better; I'll just wait for an R-b/A-b from someone then.

On 18.03.20 11:39, Cornelia Huck wrote:
> Create a subdirectory for s390x under docs/system/ and move the
> existing vfio-ap documentation there.
> 
> Create an initial document describing s390x system emulation.
> 
> Suggested-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Cornelia Huck <cohuck@redhat.com>
> ---
> 
> Mostly an initial version so that Janosch can base his protected virt
> documentation on something; there's room for more here :)
> 
> If this looks good, I'll queue it on my s390-next branch for 5.1.

Acked-by: Christian Borntraeger <borntraeger@de.ibm.com>

> 
> ---
>  MAINTAINERS                         |  5 +++--
>  docs/system/index.rst               |  1 -
>  docs/system/{ => s390x}/vfio-ap.rst |  0
>  docs/system/target-s390x.rst        | 26 ++++++++++++++++++++++++++
>  docs/system/targets.rst             |  1 +
>  5 files changed, 30 insertions(+), 3 deletions(-)
>  rename docs/system/{ => s390x}/vfio-ap.rst (100%)
>  create mode 100644 docs/system/target-s390x.rst
> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 7364af0d8b07..dfbd5b0c5de9 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -101,7 +101,8 @@ F: include/hw/watchdog/wdt_diag288.h
>  F: pc-bios/s390-ccw/
>  F: pc-bios/s390-ccw.img
>  F: target/s390x/
> -F: docs/vfio-ap.txt
> +F: docs/system/target-s390x.rst
> +F: docs/system/s390x/
>  F: tests/migration/s390x/
>  K: ^Subject:.*(?i)s390x?
>  T: git https://github.com/cohuck/qemu.git s390-next
> @@ -1606,7 +1607,7 @@ F: hw/s390x/ap-bridge.c
>  F: include/hw/s390x/ap-device.h
>  F: include/hw/s390x/ap-bridge.h
>  F: hw/vfio/ap.c
> -F: docs/system/vfio-ap.rst
> +F: docs/system/s390x/vfio-ap.rst
>  L: qemu-s390x@nongnu.org
>  
>  vhost
> diff --git a/docs/system/index.rst b/docs/system/index.rst
> index 6e5f20fa1333..c0f685b818e5 100644
> --- a/docs/system/index.rst
> +++ b/docs/system/index.rst
> @@ -30,7 +30,6 @@ Contents:
>     managed-startup
>     targets
>     security
> -   vfio-ap
>     deprecated
>     build-platforms
>     license
> diff --git a/docs/system/vfio-ap.rst b/docs/system/s390x/vfio-ap.rst
> similarity index 100%
> rename from docs/system/vfio-ap.rst
> rename to docs/system/s390x/vfio-ap.rst
> diff --git a/docs/system/target-s390x.rst b/docs/system/target-s390x.rst
> new file mode 100644
> index 000000000000..4c8b7cdd6615
> --- /dev/null
> +++ b/docs/system/target-s390x.rst
> @@ -0,0 +1,26 @@
> +.. _s390x-System-emulator:
> +
> +s390x System emulator
> +---------------------
> +
> +QEMU can emulate z/Architecture (in particular, 64 bit) s390x systems
> +via the ``qemu-system-s390x`` binary. Only one machine type,
> +``s390-ccw-virtio``, is supported (with versioning for compatibility
> +handling).
> +
> +When using KVM as accelerator, QEMU can emulate CPUs up to the generation
> +of the host. When using the default cpu model with TCG as accelerator,
> +QEMU will emulate a subset of z13 cpu features that should be enough to run
> +distributions built for the z13.
> +
> +Device support
> +==============
> +
> +QEMU will not emulate most of the traditional devices found under LPAR or
> +z/VM; virtio devices (especially using virtio-ccw) make up the bulk of
> +the available devices. Passthrough of host devices via vfio-pci, vfio-ccw,
> +or vfio-ap is also available.
> +
> +.. toctree::
> +   s390x/vfio-ap
> +
> diff --git a/docs/system/targets.rst b/docs/system/targets.rst
> index eba3111247f6..0d8f91580aa5 100644
> --- a/docs/system/targets.rst
> +++ b/docs/system/targets.rst
> @@ -17,3 +17,4 @@ Contents:
>     target-arm
>     target-m68k
>     target-xtensa
> +   target-s390x
> 

On Wed, 18 Mar 2020 11:39:40 +0100
Cornelia Huck <cohuck@redhat.com> wrote:

> Create a subdirectory for s390x under docs/system/ and move the
> existing vfio-ap documentation there.
> 
> Create an initial document describing s390x system emulation.
> 
> Suggested-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Cornelia Huck <cohuck@redhat.com>
> ---
> 
> Mostly an initial version so that Janosch can base his protected virt
> documentation on something; there's room for more here :)
> 
> If this looks good, I'll queue it on my s390-next branch for 5.1.
> 
> ---
>  MAINTAINERS                         |  5 +++--
>  docs/system/index.rst               |  1 -
>  docs/system/{ => s390x}/vfio-ap.rst |  0
>  docs/system/target-s390x.rst        | 26 ++++++++++++++++++++++++++
>  docs/system/targets.rst             |  1 +
>  5 files changed, 30 insertions(+), 3 deletions(-)
>  rename docs/system/{ => s390x}/vfio-ap.rst (100%)
>  create mode 100644 docs/system/target-s390x.rst

Queued to s390-fixes.