Initial content

5 files changed, 317 insertions, 0 deletions

diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..d4bb2cb
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/conf.py b/conf.py
new file mode 100644
index 0000000..3257569
--- /dev/null
+++ b/conf.py
@@ -0,0 +1,9 @@
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Linux on Marvell MMP'
+copyright = 'linux-mmp contributors'
+author = 'linux-mmp contributors'
+
+highlight_language = 'none'
diff --git a/dell-wyse-3020.rst b/dell-wyse-3020.rst
new file mode 100644
index 0000000..0ba813e
--- /dev/null
+++ b/dell-wyse-3020.rst
@@ -0,0 +1,136 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+.. highlight:: shell-session
+
+Dell Wyse 3020
+==============
+
+Dell Wyse 3020 is a MMP3-based thin client, sometimes referred to as "Ariel", 
+"Tx0D", "T10D", "T20D", etc. It's reasonably well supported by the mainline
+kernel.
+
+It comes with "WLoader" firmware, but can be flashed with Open Firmware. Open
+Firmware is 100% free software and provides better Device Tree support than
+WLoader.
+
+Hardware Support
+----------------
+
+===================     =================       ==============  ===================================
+Hardware                Model                   Status          Notes
+===================     =================       ==============  ===================================
+Embedded Controller     ene-kb3930              In progress     Power off and access to LEDs
+Power Button            ariel-pwrbutton         In progress
+Status LEDs             leds-ariel              Mainline (5.8)  Depends on ene-kb3930 to work
+Audio Codec             ce506                   Not started
+Power Regulator         88pm867                 Mainline
+Video Encoder           ch7033                  Mainline (5.8)
+RTC                     ds1338                  Mainline
+Firmware Flash          w25q32                  Mainline
+===================     =================       ==============  ===================================
+
+Booting with WLoader
+--------------------
+
+The device comes with a boot loader called WLoader. It's apparently is a
+stripped down version of Wyse's ThinOS, with GUI, USB and Network support,
+capable of loading ELF images of ThinkOS as well as Linux U-Boot-style
+uImages. There's basically zero configuration for it, but aparently it
+reads a file called wloader.conf, which tells it which kernel and initrd
+to load.
+
+To start Linux on the machine, you need to prepare an USB flash stick with
+a Linux installation. The process destroys all data on the target volume,
+so make sure you pick the right one.  Substitute ``sdx`` in command below
+for your actual volume. ``lsblk`` command might help you identify which one
+is it. Once you know the device name, you're ready to install your
+favourite distro. Fedora for OLPC XO-1.75 machine is fine::
+
+  # arm-image-installer --resizefs --target=olpc_xo175 --media=/dev/sdx \
+      --image=Fedora-Minimal-armhfp-32-1.6-sda.raw.xz
+  
+  =====================================================
+  = Selected Image:
+  = Fedora-Minimal-armhfp-32-1.6-sda.raw.xz
+  = Selected Media : /dev/sdx
+  = U-Boot Target : olpc_xo175
+  =====================================================
+  
+  *****************************************************
+  *****************************************************
+  ******** WARNING! ALL DATA WILL BE DESTROYED ********
+  *****************************************************
+  *****************************************************
+  
+   Type 'YES' to proceed, anything else to exit now
+  
+  = Proceed? YES
+  = Writing:
+  = Fedora-Minimal-armhfp-32-1.6-sda.raw.xz
+  = To: /dev/sdx ....
+  2066571264 bytes (2.1 GB, 1.9 GiB) copied, 91 s, 22.7 MB/s
+  0+233502 records in
+  0+233502 records out
+  2088763392 bytes (2.1 GB, 1.9 GiB) copied, 91.554 s, 22.8 MB/s
+  = Writing image complete!
+  = Copying loader scripts to boot partition
+  
+  = Installation Complete! Insert into the olpc_xo175 and boot.
+  #
+
+Mount the boot partitions and make some room::
+  
+  # mount /dev/sdx2 /mnt
+  # mount /dev/sdx1 /mnt/efi/
+  # rm -rf /mnt/efi/*
+  #
+
+Create the uImages::
+
+  # cat /mnt/vmlinuz-* /mnt/dtb-*/mmp3-dell-ariel.dtb >/mnt/zImage
+  # mkimage -A arm -O linux -C none  -T kernel -a 0x00008000 -e 0x00008000 -d /mnt/zImage /mnt/uImage
+  Image Name:
+  Created:      Tue May 12 13:24:10 2020
+  Image Type:   ARM Linux Kernel Image (uncompressed)
+  Data Size:    7654917 Bytes = 7475.50 KiB = 7.30 MiB
+  Load Address: 00008000
+  Entry Point:  00008000
+  # mkimage -A arm -O linux -C none  -T ramdisk -d /mnt/efi/initramfs-* /mnt/efi/uInitrd
+  Image Name:
+  Created:      Tue May 12 12:45:09 2020
+  Image Type:   ARM Linux RAMDisk Image (uncompressed)
+  Data Size:    51619027 Bytes = 50409.21 KiB = 49.23 MiB
+  Load Address: 00000000
+  Entry Point:  00000000
+
+And write the boot loader configuration::
+
+  # cat >/mnt/efi/wloader.cfg <<EOF
+  > <TX0D_START>
+  >
+  > kernel=./uImage
+  > initrd=./uInitrd
+  > param="$(sed -n 's/^[\t ]*append //p' /mnt/extlinux/extlinux.conf)"
+  >
+  > <TX0D_END>
+  > EOF
+  # umount /mnt/efi /mnt
+  #
+
+Plug in the driver in any of the machine's USB ports and you're ready to
+boot it:
+
+1. Hold power button until the LED turns Green
+2. Keep pressing "P", default password is "Fireport"
+3. Choose boot from USB
+
+Installing Open Firmware
+------------------------
+
+Flash Open Firmware::
+
+  # echo spidev >/sys/devices/platform/soc/d4000000.apb/d4035000.spi/spi_master/spi1/spi1.0/driver_override
+  # echo spi1.0 >/sys/devices/platform/soc/d4000000.apb/d4035000.spi/spi_master/spi1/spi1.0/driver/unbind
+  # echo spi1.0 >/sys/bus/spi/drivers/spidev/bind
+  # echo spi1.0 >/sys/bus/spi/drivers/spidev/bind
+  # flashrom -p linux_spi:dev=/dev/spidev1.0 -w q7c07.rom
+  #
diff --git a/index.rst b/index.rst
new file mode 100644
index 0000000..eb8aa03
--- /dev/null
+++ b/index.rst
@@ -0,0 +1,53 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Linux on Marvell MMP
+====================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   olpc-xo
+   dell-wyse-3020
+
+.. index
+
+Hardware Support
+----------------
+
+===================     =================       ==============  ===================================
+Hardware                Model                   Status          Notes
+===================     =================       ==============  ===================================
+SMP (mmp3)              mmp3-smp                Mainline
+L2 Cache (mmp2)         tauros2                 Mainline
+L2 Cache (mmp3)         tauros3                 Mainline
+USB 2.0                 pxau2o-ehci             Mainline
+USB 2.0 PHY (mmp2)      mmp2-usb-phy            Mainline
+USB 2.0 PHY (mmp3)      mmp3-usb-phy            Mainline
+MMC                     pxav3-mmc               Mainline
+Camera Controller       mmp2-ccic               Mainline
+Audio DMA               adma-1.0                Mainline
+Peripheral DMA          pdma-1.0                Mainline
+UART                    xscale-uart             Mainline
+GPIO                    mmp2-gpio               Mainline
+I2S                     mmp-twsi                Mainline
+RTC                     mmp-rtc                 Mainline
+SPI                     mmp2-ssp                Mainline
+Audio SRAM              mmio-sram               Mainline
+3D GPU (mmp2)           gc860                   Mainline        Needs power domains (In progress)
+3D GPU (mmp3)           gc2000                  Mainline        Needs power domains (In progress)
+3D GPU (mmp3)           gc320                   Mainline        Needs power domains (In progress)
+MMP3 Thermal            mmp3-thermal            In progress
+Display Controller      armada-lcdc             In progress
+USB HSIC PHY (mmp3)     mmp3-hsic-phy           In progress
+Audio Clocks            mmp2-audio-clock        In progress
+Audio I2S               mmp-sspa                In progress
+Randomness Source       mmp2-rng                In progress
+===================     =================       ==============  ===================================
+
+.. Indices and tables
+.. ==================
+.. 
+.. * :ref:`genindex`
+.. * :ref:`modindex`
+.. * :ref:`search`
diff --git a/olpc-xo.rst b/olpc-xo.rst
new file mode 100644
index 0000000..0b99065
--- /dev/null
+++ b/olpc-xo.rst
@@ -0,0 +1,99 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+.. highlight:: shell-session
+
+OLPC XO-1.75
+============
+
+OLPC XO-1.75 is a MMP2-based laptop. It's reasonably well supported by the
+mainline kernel.
+
+Hardware Support
+----------------
+
+===================     =================       ==============  ===================================
+Hardware                Model                   Status          Notes
+===================     =================       ==============  ===================================
+Game Keys               gpio-keys               Mainline
+Camera                  ov7670                  Mainline
+Wi-Fi                   sd8686                  Mainline
+Keyboard                AP SP                   Mainline
+Embedded Controller     xo1.75-ec               Mainline
+Audio Codec             rt5631                  Mainline        Needs the SoC I2C to work
+Video Encoder           hx8837                  In progress
+LCD Panel               ls075at011              In progress
+===================     =================       ==============  ===================================
+
+Firmware security
+-----------------
+
+Most OLPC machines were shipped with the security system that disallows
+booting unsigned software. If this is the case with your machine, in order
+to run the OS images other than OLPC OS you'll need to get a developer key
+and deactivate the security system.
+
+The procedure is descriped in the OLPC wiki:
+http://wiki.laptop.org/go/Activation_and_Developer_Keys
+
+Firmware upgrade
+----------------
+
+It is always preferrable to use an up to date firmware. The firmware images
+are available at http://wiki.laptop.org/go/Firmware. For the XO-1.75 laptop
+to boot the mainline kernel a firmware Q4E00JA or newer is needed. You can
+get it at http://dev.laptop.org/~quozl/q4e00ja.rom.
+
+To update the firmware, place the .rom file on to your bootable media,
+connect a charged battery pack and a wall adapter, and enter the Open
+Firmware prompt by pressing ESC during the early boot (needs an unlocked
+laptop -- see "Firmware security" above). Then use the "flash" command
+to update the firmware::
+
+  ok flash ext:\q4e00ja.rom   \ Flash the "q4e00ja.rom" from the SD card
+  ok flash u:\q4e00ja.rom     \ Flash the "q4e00ja.rom" from USB stick
+
+Installing Fedora
+-----------------
+
+Installing Fedora is very straightforward, since ``arm-image-installer``
+supports it out-of-box. You can install it to a USB flash stick or a SD
+card.
+
+The process destroys all data on the target volume, so make sure you pick
+the right one.  Substitute ``sdx`` in command below for your actual volume.
+``lsblk`` command might help you identify which one is it. Once you know
+the device name, you're ready to install Fedora::
+
+  # arm-image-installer --resizefs --target=olpc_xo175 --media=/dev/sdx \
+      --image=Fedora-Minimal-armhfp-32-1.6-sda.raw.xz
+  
+  =====================================================
+  = Selected Image:
+  = Fedora-Minimal-armhfp-32-1.6-sda.raw.xz
+  = Selected Media : /dev/sdx
+  = U-Boot Target : olpc_xo175
+  =====================================================
+  
+  *****************************************************
+  *****************************************************
+  ******** WARNING! ALL DATA WILL BE DESTROYED ********
+  *****************************************************
+  *****************************************************
+  
+   Type 'YES' to proceed, anything else to exit now
+  
+  = Proceed? YES
+  = Writing:
+  = Fedora-Minimal-armhfp-32-1.6-sda.raw.xz
+  = To: /dev/sdx ....
+  2066571264 bytes (2.1 GB, 1.9 GiB) copied, 91 s, 22.7 MB/s
+  0+233502 records in
+  0+233502 records out
+  2088763392 bytes (2.1 GB, 1.9 GiB) copied, 91.554 s, 22.8 MB/s
+  = Writing image complete!
+  = Copying loader scripts to boot partition
+  
+  = Installation Complete! Insert into the olpc_xo175 and boot.
+  #
+
+Once your machine is unlocked, it will automatically boot from your media
+wherever it will detect it attached to the USB bus or the SD card slot.