Re: Editing QEMU POWER Platform wiki page

[Cédric Le Goater]

On 2/22/21 12:01 PM, Greg Kurz wrote:
> On Thu, 18 Feb 2021 10:16:25 -0300
> Leonardo Augusto Guimarães Garcia <lagarcia@linux.ibm.com> wrote:
> 
>> Hi there,
>>
>> I would like to edit the wiki page at [0] as it contains some outdated 
>> information. Could anyone that has access to the wiki please help me 
>> create a user so that I can edit it?
>>
>> 0. https://wiki.qemu.org/Documentation/Platforms/POWER
>>
> 
> Hi Leo,
> 
> User creation isn't publicly available to avoid spam : only an existing
> user can create a new account. This being said, wiki isn't the preferred
> way to expose documentation since there's no review and things ultimately
> bitrot. Page [0] you want to update is a perfect example of the mess :
> not only it contains irrelevant data but also stuff that is definitely
> wrong (e.g. 'compat' cpu property was deprecated in QEMU 5.0 and will
> be removed in QEMU 6.0).
> 
> Ideally we'd want everything to be in the main QEMU doc and don't
> even need a wiki.
> 
> On the PowerPC front, the most up-to-date docs are in the QEMU tree:
> 
> docs/system/ppc/embedded.rst 
> docs/system/ppc/powermac.rst 
> docs/system/ppc/powernv.rst  
> docs/system/ppc/prep.rst     
> docs/system/ppc/pseries.rst  
> docs/system/target-ppc.rst   
> 
> So I don't know exactly what changes you had in mind, but maybe first
> consider to update the main documentation.

This structure doesn't quite exist yet. See the patch below adding it.

I would like to improve the PowerNV section before sending it.  

Thanks,

C. 


>From f64cf0ab37848c44271437ef837ddda66206c4b9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?C=C3=A9dric=20Le=20Goater?= <clg@kaod.org>
Date: Mon, 22 Feb 2021 12:12:23 +0100
Subject: [PATCH] docs/system: Extend PPC section
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Cédric Le Goater <clg@kaod.org>
---
 docs/system/ppc/embedded.rst | 10 +++++++
 docs/system/ppc/powermac.rst | 34 +++++++++++++++++++++++
 docs/system/ppc/powernv.rst  | 11 ++++++++
 docs/system/ppc/prep.rst     | 18 ++++++++++++
 docs/system/ppc/pseries.rst  | 12 ++++++++
 docs/system/target-ppc.rst   | 53 ++++++++++--------------------------
 6 files changed, 100 insertions(+), 38 deletions(-)
 create mode 100644 docs/system/ppc/embedded.rst
 create mode 100644 docs/system/ppc/powermac.rst
 create mode 100644 docs/system/ppc/powernv.rst
 create mode 100644 docs/system/ppc/prep.rst
 create mode 100644 docs/system/ppc/pseries.rst

diff --git a/docs/system/ppc/embedded.rst b/docs/system/ppc/embedded.rst
new file mode 100644
index 000000000000..cfffbda24da9
--- /dev/null
+++ b/docs/system/ppc/embedded.rst
@@ -0,0 +1,10 @@
+Embedded family boards
+======================
+
+- ``bamboo``               bamboo
+- ``mpc8544ds``            mpc8544ds
+- ``ppce500``              generic paravirt e500 platform
+- ``ref405ep``             ref405ep
+- ``sam460ex``             aCube Sam460ex
+- ``taihu``                taihu
+- ``virtex-ml507``         Xilinx Virtex ML507 reference design
diff --git a/docs/system/ppc/powermac.rst b/docs/system/ppc/powermac.rst
new file mode 100644
index 000000000000..04334ba2102c
--- /dev/null
+++ b/docs/system/ppc/powermac.rst
@@ -0,0 +1,34 @@
+PowerMac family boards (``g3beige``, ``mac99``)
+==================================================================
+
+Use the executable ``qemu-system-ppc`` to simulate a complete PowerMac
+PowerPC system.
+
+- ``g3beige``              Heathrow based PowerMAC
+- ``mac99``                Mac99 based PowerMAC
+
+Supported devices
+-----------------
+
+QEMU emulates the following PowerMac peripherals:
+
+ *  UniNorth or Grackle PCI Bridge
+ *  PCI VGA compatible card with VESA Bochs Extensions
+ *  2 PMAC IDE interfaces with hard disk and CD-ROM support
+ *  NE2000 PCI adapters
+ *  Non Volatile RAM
+ *  VIA-CUDA with ADB keyboard and mouse.
+
+
+Missing devices
+---------------
+
+ * To be identified
+
+Firmware
+--------
+
+Since version 0.9.1, QEMU uses OpenBIOS https://www.openbios.org/ for
+the g3beige and mac99 PowerMac and the 40p machines. OpenBIOS is a free
+(GPL v2) portable firmware implementation. The goal is to implement a
+100% IEEE 1275-1994 (referred to as Open Firmware) compliant firmware.
diff --git a/docs/system/ppc/powernv.rst b/docs/system/ppc/powernv.rst
new file mode 100644
index 000000000000..28ce09aa4513
--- /dev/null
+++ b/docs/system/ppc/powernv.rst
@@ -0,0 +1,11 @@
+PowerNV family boards (``powernv8``, ``powernv9``)
+==================================================================
+
+Supported devices
+-----------------
+
+Missing devices
+---------------
+
+Firmware
+--------
diff --git a/docs/system/ppc/prep.rst b/docs/system/ppc/prep.rst
new file mode 100644
index 000000000000..bd9eb8eabd2f
--- /dev/null
+++ b/docs/system/ppc/prep.rst
@@ -0,0 +1,18 @@
+Prep machine (``40p``)
+==================================================================
+
+Use the executable ``qemu-system-ppc`` to simulate a complete 40P (PREP)
+
+Supported devices
+-----------------
+
+QEMU emulates the following 40P (PREP) peripherals:
+
+ *  PCI Bridge
+ *  PCI VGA compatible card with VESA Bochs Extensions
+ *  2 IDE interfaces with hard disk and CD-ROM support
+ *  Floppy disk
+ *  PCnet network adapters
+ *  Serial port
+ *  PREP Non Volatile RAM
+ *  PC compatible keyboard and mouse.
diff --git a/docs/system/ppc/pseries.rst b/docs/system/ppc/pseries.rst
new file mode 100644
index 000000000000..932d4dd17d29
--- /dev/null
+++ b/docs/system/ppc/pseries.rst
@@ -0,0 +1,12 @@
+pSeries family boards (``pseries``)
+===================================
+
+Supported devices
+-----------------
+
+Missing devices
+---------------
+
+
+Firmware
+--------
diff --git a/docs/system/target-ppc.rst b/docs/system/target-ppc.rst
index a2f04c533c24..549fb1858b54 100644
--- a/docs/system/target-ppc.rst
+++ b/docs/system/target-ppc.rst
@@ -3,45 +3,22 @@
 PowerPC System emulator
 -----------------------
 
-Use the executable ``qemu-system-ppc`` to simulate a complete 40P (PREP)
-or PowerMac PowerPC system.
+Board-specific documentation
+============================
 
-QEMU emulates the following PowerMac peripherals:
+you can get a complete list by running ``qemu-system-ppc64 --machine
+help``.
 
--  UniNorth or Grackle PCI Bridge
+..
+   This table of contents should be kept sorted alphabetically
+   by the title text of each file, which isn't the same ordering
+   as an alphabetical sort by filename.
 
--  PCI VGA compatible card with VESA Bochs Extensions
+.. toctree::
+   :maxdepth: 1
 
--  2 PMAC IDE interfaces with hard disk and CD-ROM support
-
--  NE2000 PCI adapters
-
--  Non Volatile RAM
-
--  VIA-CUDA with ADB keyboard and mouse.
-
-QEMU emulates the following 40P (PREP) peripherals:
-
--  PCI Bridge
-
--  PCI VGA compatible card with VESA Bochs Extensions
-
--  2 IDE interfaces with hard disk and CD-ROM support
-
--  Floppy disk
-
--  PCnet network adapters
-
--  Serial port
-
--  PREP Non Volatile RAM
-
--  PC compatible keyboard and mouse.
-
-Since version 0.9.1, QEMU uses OpenBIOS https://www.openbios.org/ for
-the g3beige and mac99 PowerMac and the 40p machines. OpenBIOS is a free
-(GPL v2) portable firmware implementation. The goal is to implement a
-100% IEEE 1275-1994 (referred to as Open Firmware) compliant firmware.
-
-More information is available at
-http://perso.magic.fr/l_indien/qemu-ppc/.
+   ppc/embedded
+   ppc/powermac
+   ppc/powernv
+   ppc/prep
+   ppc/pseries
-- 
2.26.2