From c476ccef39965abdf89fc660be955332e36b3d0b Mon Sep 17 00:00:00 2001
From: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date: Wed, 29 Aug 2018 07:47:14 +0200
Subject: user: Add qoriq BSP section

Update #2854.
---
 user/bsps/bsps-powerpc.rst | 79 +++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 78 insertions(+), 1 deletion(-)

(limited to 'user/bsps/bsps-powerpc.rst')

diff --git a/user/bsps/bsps-powerpc.rst b/user/bsps/bsps-powerpc.rst
index 4e59f7c..735693c 100644
--- a/user/bsps/bsps-powerpc.rst
+++ b/user/bsps/bsps-powerpc.rst
@@ -4,4 +4,81 @@
 powerpc (PowerPC)
 *****************
 
-TODO.
+QorIQ
+=====
+
+The BSP for the `QorIQ <https://en.wikipedia.org/wiki/QorIQ>`_ chip family
+offers three variants.  The `qoriq_e500` variant supports the P-series chips
+such as P1020, P2010 and P2020.  The `qoriq_e6500_32` (32-bit ISA) and
+`qoriq_e6500_64` (64-bit ISA) variants support the T-series chips such as T2080
+and T4240.  The basic hardware initialization is not performed by the BSP.  A
+boot loader with device tree support must be used to start the BSP, e.g.
+U-Boot.
+
+The BSP is known to run on these boards:
+
+* NXP P1020RDB
+
+* MicroSys miriac MPX2020 (System on Module)
+
+* Artesyn MVME2500 (VME64x SBC)
+
+* NXP T2080RDB
+
+* NXP T4240RDB
+
+* MEN G52A (CompactPCI Serial)
+
+Boot via U-Boot
+---------------
+
+The application executable file (ELF file) must be converted to an U-Boot
+image.  Use the following commands:
+
+::
+
+    powerpc-rtems5-objcopy -O binary app.exe app.bin
+    gzip -9 -f -c app.bin > app.bin.gz
+    mkimage -A ppc -O linux -T kernel -a 0x4000 -e 0x4000 -n RTEMS -d app.bin.gz app.img
+
+Use the following U-Boot commands to boot an application via TFTP download:
+
+::
+
+    tftpboot ${loadaddr} app.img && run loadfdt && bootm ${loadaddr} - ${fdt_addr} ; reset
+
+Clock Driver
+------------
+
+The clock driver uses two MPIC global timer (``QORIQ_CLOCK_TIMER`` and
+``QORIQ_CLOCK_TIMECOUNTER``).  In case ``QORIQ_IS_HYPERVISOR_GUEST`` is
+defined, then the PowerPC decrementer is used.
+
+Console Driver
+--------------
+
+The console driver supports the on-chip NS16550 compatible UARTs.  In case
+``QORIQ_IS_HYPERVISOR_GUEST`` is defined, then the EPAPR byte channel is used
+for the console device.
+
+Network Interface Driver
+------------------------
+
+The network interface driver is provided by the `libbsd`.  The DPAA is
+supported including 10Gbit/s Ethernet.
+
+Topaz Hypervisor Guest
+----------------------
+
+For a Topaz hypervisor guest configuration use:
+
+::
+
+    ../configure --enable-rtemsbsp=qoriq_e6500_32 \
+        QORIQ_IS_HYPERVISOR_GUEST=1 \
+        QORIQ_UART_0_ENABLE=0 \
+        QORIQ_UART_1_ENABLE=0 \
+        QORIQ_TLB1_ENTRY_COUNT=16
+
+You may have to adjust the linker command file according to your partition
+configuration.
-- 
cgit v1.2.3