summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/boards/imx.rst13
-rw-r--r--Documentation/boards/imx/amazon-kindle-3.rst (renamed from Documentation/boards/imx/amazon-kindle3.rst)12
-rw-r--r--Documentation/boards/imx/amazon-kindle-4-5.rst (renamed from Documentation/boards/imx/amazon-kindle-mx50.rst)39
-rw-r--r--Documentation/boards/imx/element14-warp7.rst (renamed from Documentation/boards/imx/Element14-WaRP7.rst)5
-rw-r--r--Documentation/boards/imx/garz-fricke-cupid.rst (renamed from Documentation/boards/imx/Garz-Fricke-Cupid.rst)0
-rw-r--r--Documentation/boards/imx/garz-fricke-vincell.rst (renamed from Documentation/boards/imx/Garz-Fricke-Vincell.rst)4
-rw-r--r--Documentation/boards/imx/karo-tx25.rst (renamed from Documentation/boards/imx/Karo-TX25.rst)0
-rw-r--r--Documentation/boards/imx/karo-tx6.rst (renamed from Documentation/boards/imx/Karo-TX6.rst)4
-rw-r--r--Documentation/boards/imx/nxp-imx8mq-evk.rst116
-rw-r--r--Documentation/boards/imx/phytec-phycard-i.mx27.rst (renamed from Documentation/boards/imx/Phytec-phyCARD-i.MX27.rst)0
-rw-r--r--Documentation/boards/imx/phytec-phycore-i.mx27.rst (renamed from Documentation/boards/imx/Phytec-phyCORE-i.MX27.rst)0
-rw-r--r--Documentation/boards/imx/phytec-phycore-i.mx31.rst (renamed from Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst)8
-rw-r--r--Documentation/boards/imx/phytec-phycore-i.mx35.rst (renamed from Documentation/boards/imx/Phytec-phyCORE-i.MX35.rst)0
-rw-r--r--Documentation/boards/imx/synertronixx_scb9328.rst2
-rw-r--r--Documentation/boards/imx/wandboard.rst (renamed from Documentation/boards/imx/Wandboard.rst)11
-rw-r--r--Documentation/devicetree/bindings/barebox/barebox,environment.rst2
-rw-r--r--Documentation/user/barebox.rst4
-rw-r--r--Documentation/user/bootchooser.rst2
-rw-r--r--Documentation/user/system-setup.rst2
19 files changed, 184 insertions, 40 deletions
diff --git a/Documentation/boards/imx.rst b/Documentation/boards/imx.rst
index b3002badf1..db889ee702 100644
--- a/Documentation/boards/imx.rst
+++ b/Documentation/boards/imx.rst
@@ -21,6 +21,7 @@ The Internal Boot Mode is supported on:
* i.MX53
* i.MX6
* i.MX7
+* i.MX8MQ
With the Internal Boot Mode, the images contain a header which describes
where the binary shall be loaded and started. These headers also contain
@@ -44,6 +45,15 @@ of the image to the card, use::
dd if=images/barebox-freescale-imx51-babbage.img of=/dev/sdd bs=1024 skip=1 seek=1
+NOTE: MaskROM on i.MX8 expects image to start at +33KiB mark, so the
+following command has to be used instead:
+
+ dd if=images/barebox-nxp-imx8mq-evk.img of=/dev/sdd bs=1024 skip=33 seek=33
+
+Or, in case of NAND:
+
+ dd if=images/barebox-nxp-imx8mq-evk.img of=/dev/nand bs=1024 skip=33 seek=1
+
The images can also always be started second stage::
bootm /mnt/tftp/barebox-freescale-imx51-babbage.img
@@ -59,7 +69,8 @@ options in this file are:
Header:
+----------------+--------------------------------------------------------------+
-| soc <soctype> | soctype can be one of imx35, imx51, imx53, imx6, imx7, vf610 |
+| soc <soctype> |soctype can be one of imx35, imx51, imx53, imx6, imx7, vf610, |
+| | imx8mq |
+----------------+--------------------------------------------------------------+
| loadaddr <adr> | The address the binary is uploaded to |
+----------------+--------------------------------------------------------------+
diff --git a/Documentation/boards/imx/amazon-kindle3.rst b/Documentation/boards/imx/amazon-kindle-3.rst
index 50592f2cb9..dffb7efb2d 100644
--- a/Documentation/boards/imx/amazon-kindle3.rst
+++ b/Documentation/boards/imx/amazon-kindle-3.rst
@@ -14,7 +14,10 @@ vendor modified u-boot imximage.
To upload and run a new bootloader the device can be put into USB-downloader
mode by the SOC microcode when Vol+ is pressed during startup. A new USB
device "SE Blank RINGO" should appear, barebox may be uploaded using
-$ scripts/imx/imx-usb-loader barebox.imximg
+
+::
+
+ $ scripts/imx/imx-usb-loader barebox.imximg
Note: a USB serial ACM console will be launched by a barebox init script
when the cursor select key is pressed during startup (e.g. before running
@@ -23,6 +26,7 @@ imx-usb-loader)
Barebox may be used as drop-in replacement for the shipped bootloader.
When installing the barebox imximg on the eMMC take care not to overwrite
the partition table and vendor supplied serial numbers stored on the eMMC.
-e.g. just write the imx-header and the application section:
-memcpy -b -s barebox.imximg -d /dev/disk0.imx_header 1024 0 1024
-memcpy -b -s barebox.imximg -d /dev/disk0.self 4096 0 195584
+e.g. just write the imx-header and the application section::
+
+ memcpy -b -s barebox.imximg -d /dev/disk0.imx_header 1024 0 1024
+ memcpy -b -s barebox.imximg -d /dev/disk0.self 4096 0 195584
diff --git a/Documentation/boards/imx/amazon-kindle-mx50.rst b/Documentation/boards/imx/amazon-kindle-4-5.rst
index 1e71cd26ba..bc6bf2609b 100644
--- a/Documentation/boards/imx/amazon-kindle-mx50.rst
+++ b/Documentation/boards/imx/amazon-kindle-4-5.rst
@@ -18,24 +18,32 @@ are shipped with a vendor modified u-boot imximage based on u-boot v2009.08.
To upload and run a new bootloader the older devices can be put into
USB-downloader mode by the SOC microcode when a specific key is pressed during
startup:
+
* the fiveway down button on the model D01100
* the home button on model D01200
+
A new USB device "NS Blank CODEX" should appear, barebox may be uploaded using
-$ scripts/imx/imx-usb-loader barebox-kindle-d01100.img
-$ scripts/imx/imx-usb-loader barebox-kindle-d01200.img
+
+::
+
+ $ scripts/imx/imx-usb-loader barebox-kindle-d01100.img
+ $ scripts/imx/imx-usb-loader barebox-kindle-d01200.img
+
Hint: keep the select button pressed down to get the barebox USB console.
Barebox may be used as drop-in replacement for the shipped bootloader, when
the imximg fits into 258048 bytes. When installing the barebox imximg on
-the eMMC take care not to overwrite the vendor supplied serial numbers stored
-on the eMMC.
-e.g. for the D01100 just write the imx-header and the application section:
-loady -t usbserial
-memcpy -b -s barebox-kindle-d01100.img -d /dev/disk0.boot0.imx_header 1024 0 2048
-memcpy -b -s barebox-kindle-d01100.img -d /dev/disk0.boot0.self 4096 0 253952
+the eMMC, take care not to overwrite the vendor supplied serial numbers stored
+on the eMMC,
+e.g. for the D01100 just write the imx-header and the application section::
+
+ loady -t usbserial
+ memcpy -b -s barebox-kindle-d01100.img -d /dev/disk0.boot0.imx_header 1024 0 2048
+ memcpy -b -s barebox-kindle-d01100.img -d /dev/disk0.boot0.self 4096 0 253952
Note: a USB serial ACM console will be launched by a barebox init script
when
+
* the cursor select key is pressed during startup of model D01100
* the home button is pressed within a second after startup of model D01200.
If you press the home button during startup, you will enter USB boot mode.
@@ -47,12 +55,15 @@ power consumption to a few milliamps of battery power, after some minutes
the power consumption is further reduced to about 550 microamps. Switching
on iomux pullups may significantly reduce your standby-time.
-Hints to reduce the build image size.
+Hints to reduce the build image size
+------------------------------------
+
Note that a drop-in replacement barebox imximage must not exceed 258048 bytes
since the space behind it is in use. Hence, don't build in drivers and FS
-that are not required, e.g.:
- NET, DISK_AHCI, DISK_INTF_PLATFORM_IDE, DISK_ATA, VIDEO, PWM, LED,
- USB_STORAGE, USB_ULPI, NAND, MTD_UBI, FS_UBIFS, MFD_MC34704, MFD_MC9SDZ60,
- MFD_STMPE, EEPROM_AT25, EEPROM_AT24, KEYBOARD_GPIO, PARTITION_DISK_EFI
+that are not required, e.g.
+``NET, DISK_AHCI, DISK_INTF_PLATFORM_IDE, DISK_ATA, VIDEO, PWM, LED,
+USB_STORAGE, USB_ULPI, NAND, MTD_UBI, FS_UBIFS, MFD_MC34704, MFD_MC9SDZ60,
+MFD_STMPE, EEPROM_AT25, EEPROM_AT24, KEYBOARD_GPIO, PARTITION_DISK_EFI``
+
Also unselect support for other boards to get rid of their dependencies.
-Further select IMAGE_COMPRESSION_XZKERN
+Further select ``IMAGE_COMPRESSION_XZKERN``.
diff --git a/Documentation/boards/imx/Element14-WaRP7.rst b/Documentation/boards/imx/element14-warp7.rst
index df14f84dc4..830a2fb55b 100644
--- a/Documentation/boards/imx/Element14-WaRP7.rst
+++ b/Documentation/boards/imx/element14-warp7.rst
@@ -4,15 +4,16 @@ element14 WaRP7
This CPU card is based on an NXP i.MX7S SoC.
Supported hardware
-==================
+------------------
- NXP PMIC PFUZE3000
- Kingston 08EMCP04-EL3AV100 eMCP (eMMC and LPDDR3 memory in one package)
+
- 8 GiB eMMC Triple-Level cell NAND flash, eMMC standard 5.0 (HS400)
- 512 MiB LPDDR3 SDRAM starting at address 0x80000000
Bootstrapping barebox
-=====================
+---------------------
The device boots in internal boot mode from eMMC and is shipped with a
vendor modified u-boot imximage.
diff --git a/Documentation/boards/imx/Garz-Fricke-Cupid.rst b/Documentation/boards/imx/garz-fricke-cupid.rst
index 452004859e..452004859e 100644
--- a/Documentation/boards/imx/Garz-Fricke-Cupid.rst
+++ b/Documentation/boards/imx/garz-fricke-cupid.rst
diff --git a/Documentation/boards/imx/Garz-Fricke-Vincell.rst b/Documentation/boards/imx/garz-fricke-vincell.rst
index 58ab0ab42f..09d87d67c3 100644
--- a/Documentation/boards/imx/Garz-Fricke-Vincell.rst
+++ b/Documentation/boards/imx/garz-fricke-vincell.rst
@@ -7,11 +7,11 @@ This CPU card is based on a Freescale i.MX53 CPU. The card is shipped with:
* 512MiB synchronous dynamic RAM
* microSD slot
-see http://www.garz-fricke.com/en/products/embedded-systems/single-board-computer/ia-0086r/ for more information
+See http://www.garz-fricke.com/en/products/embedded-systems/single-board-computer/ia-0086r/ for more information.
Bootstrapping barebox
-=====================
+---------------------
The Vincell is shipped with the RedBoot bootloader. To replace RedBoot with
barebox, you first need to connect a serial console to the device.
diff --git a/Documentation/boards/imx/Karo-TX25.rst b/Documentation/boards/imx/karo-tx25.rst
index 756c99d816..756c99d816 100644
--- a/Documentation/boards/imx/Karo-TX25.rst
+++ b/Documentation/boards/imx/karo-tx25.rst
diff --git a/Documentation/boards/imx/Karo-TX6.rst b/Documentation/boards/imx/karo-tx6.rst
index 8dd26b5964..acd6d68eeb 100644
--- a/Documentation/boards/imx/Karo-TX6.rst
+++ b/Documentation/boards/imx/karo-tx6.rst
@@ -1,5 +1,5 @@
-KaRo TX6x
-=========
+Ka-Ro TX6x
+==========
This CPU cards are based on a Freescale i.MX6 SoC.
There are currently six variants of this module, that are distinguished
diff --git a/Documentation/boards/imx/nxp-imx8mq-evk.rst b/Documentation/boards/imx/nxp-imx8mq-evk.rst
new file mode 100644
index 0000000000..9dfa911bec
--- /dev/null
+++ b/Documentation/boards/imx/nxp-imx8mq-evk.rst
@@ -0,0 +1,116 @@
+NXP i.MX8MQ EVK Evaluation Board
+================================
+
+Board comes with:
+
+* 3GiB of LPDDR4 RAM
+* 16GiB eMMC
+
+Not including booting via serial, the device can boot from either SD or eMMC.
+
+Downloading DDR PHY Firmware
+----------------------------
+
+As a part of DDR intialization routine NXP i.MX8MQ EVK requires and
+uses several binary firmware blobs that are distributed under a
+separate EULA and cannot be included in Barebox. In order to obtain
+the do the following::
+
+ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-7.2.bin
+ chmod +x firmware-imx-7.2.bin
+ ./firmware-imx-7.2.bin
+
+Executing that file should produce a EULA acceptance dialog as well as
+result in the following files:
+
+- lpddr4_pmu_train_1d_dmem.bin
+- lpddr4_pmu_train_1d_imem.bin
+- lpddr4_pmu_train_2d_dmem.bin
+- lpddr4_pmu_train_2d_imem.bin
+
+As a last step of this process those files need to be placed in
+"firmware/imx/"::
+
+ for f in lpddr4_pmu_train_1d_dmem.bin \
+ lpddr4_pmu_train_1d_imem.bin \
+ lpddr4_pmu_train_2d_dmem.bin \
+ lpddr4_pmu_train_2d_imem.bin; \
+ do \
+ cp firmware-imx-7.2/firmware/ddr/synopsys/${f} \
+ firmware/imx/${f}; \
+ done
+
+DDR Configuration Code
+======================
+
+The following two files:
+
+ - ddr_init.c
+ - ddrphy_train.c
+
+were obtained by running i.MX 8M DDR Tool that can be found here:
+
+https://community.nxp.com/docs/DOC-340179
+
+Only minimal amount of necessary changes were made to those files.
+All of the "impedance matching" code is located in "ddr.h".
+
+Build Barebox
+=============
+
+ make imx_v8_defconfig
+ make
+
+Boot Configuration
+==================
+
+The NXM i.MX8MQ EVK Evaluation Board has two switches responsible for
+configuring bootsource/boot mode:
+
+ * SW802 for selecting appropriate BMOD
+ * SW801 for selecting appropriate boot medium
+
+In order to select internal boot set SW802 as follows::
+
+ +-----+
+ | |
+ | O | | <--- on = high level
+ | | | |
+ | | O | <--- off = low level
+ | |
+ | 1 2 |
+ +-----+
+
+Bootsource is the internal eMMC::
+
+ +---------+
+ | |
+ | | | O | |
+ | | | | | | <---- eMMC
+ | O O O O |
+ | |
+ | 1 2 3 4 |
+ +---------+
+
+Bootsource is the SD2 slot::
+
+ +---------+
+ | |
+ | O O | | |
+ | | | | | | <---- SD2
+ | | | O O |
+ | |
+ | 1 2 3 4 |
+ +---------+
+
+
+Serial boot SW802 setting needed for i.MX8 DDR Tool is as follows::
+
+ +-----+
+ | |
+ | | O | <--- on = high level
+ | | | |
+ | O | | <--- off = low level
+ | |
+ | 1 2 |
+ +-----+ \ No newline at end of file
diff --git a/Documentation/boards/imx/Phytec-phyCARD-i.MX27.rst b/Documentation/boards/imx/phytec-phycard-i.mx27.rst
index d5d3837132..d5d3837132 100644
--- a/Documentation/boards/imx/Phytec-phyCARD-i.MX27.rst
+++ b/Documentation/boards/imx/phytec-phycard-i.mx27.rst
diff --git a/Documentation/boards/imx/Phytec-phyCORE-i.MX27.rst b/Documentation/boards/imx/phytec-phycore-i.mx27.rst
index 4b40be781d..4b40be781d 100644
--- a/Documentation/boards/imx/Phytec-phyCORE-i.MX27.rst
+++ b/Documentation/boards/imx/phytec-phycore-i.mx27.rst
diff --git a/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst b/Documentation/boards/imx/phytec-phycore-i.mx31.rst
index 6c05bcdfdc..d9a981b998 100644
--- a/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst
+++ b/Documentation/boards/imx/phytec-phycore-i.mx31.rst
@@ -23,8 +23,8 @@ Supported baseboards
Supported baseboards are:
* Silica / Phytec PCM-970 via phyMAP-i.MX31, PMA-001
-How to get barebox for 'Phytec's phyCORE-i.MX31'
-------------------------------------------------
+How to get barebox for Phytec's phyCORE-i.MX31
+----------------------------------------------
Using the default configuration::
@@ -34,8 +34,8 @@ Build the binary image::
make ARCH=arm CROSS_COMPILE=armv5compiler
-**NOTE:** replace ''armv5compiler'' with your ARM v5 cross compiler,
- e.g.: ''arm-1136jfs-linux-gnueabi-''
+.. note:: replace ``armv5compiler`` with your ARM v5 cross compiler prefix,
+ e.g.: ``arm-1136jfs-linux-gnueabi-``
The resulting binary image to be flashed will be ``barebox.bin``, whereas
the file named just ``barebox`` is an ELF executable for ARM.
diff --git a/Documentation/boards/imx/Phytec-phyCORE-i.MX35.rst b/Documentation/boards/imx/phytec-phycore-i.mx35.rst
index adf5d26382..adf5d26382 100644
--- a/Documentation/boards/imx/Phytec-phyCORE-i.MX35.rst
+++ b/Documentation/boards/imx/phytec-phycore-i.mx35.rst
diff --git a/Documentation/boards/imx/synertronixx_scb9328.rst b/Documentation/boards/imx/synertronixx_scb9328.rst
index 0e59046a24..a104d1c2f7 100644
--- a/Documentation/boards/imx/synertronixx_scb9328.rst
+++ b/Documentation/boards/imx/synertronixx_scb9328.rst
@@ -1,4 +1,4 @@
-Synertronixx scb9328
+Synertronixx SCB9328
====================
See http://www.synertronixx.de/produkte/scb9328/scb9328.htm
diff --git a/Documentation/boards/imx/Wandboard.rst b/Documentation/boards/imx/wandboard.rst
index 574318a009..8283b47260 100644
--- a/Documentation/boards/imx/Wandboard.rst
+++ b/Documentation/boards/imx/wandboard.rst
@@ -8,14 +8,15 @@ the Wandboard Dual (i.MX6DL, 1GiB DDR3) and Wandboard Quad (i.MX6Q, 2GiB DDR3).
The device boots from the SD card slot on the System-on-Module board, it
will not boot from the slot on the carrier board.
-To boot barebox on any wandboard, build imx_v7_defconfig
-and copy the barebox imx-image to the i.MX boot location of a SD card, e.g.
-dd bs=1024 skip=1 seek=1 if=images/barebox-imx6-wandboard.img of=/dev/mmcblk0
+To boot barebox on any wandboard, build ``imx_v7_defconfig``
+and copy the barebox imx-image to the i.MX boot location of a SD card, e.g.::
+
+ dd bs=1024 skip=1 seek=1 if=images/barebox-imx6-wandboard.img of=/dev/mmcblk0
Only one image exists, supporting all three Wandboard variants, barebox will
detect the Wandboard variant depending on the SoC variant.
-This image is only usable for SD-boot. It will not boot via imx-usb-loader.
+This image is only usable for SD boot. It will not boot via imx-usb-loader.
Connect to the serial port using a null-modem cable to get console access.
-For further documentation, including board schematics see http://wandboard.org/
+For further documentation, including board schematics, see http://wandboard.org/.
diff --git a/Documentation/devicetree/bindings/barebox/barebox,environment.rst b/Documentation/devicetree/bindings/barebox/barebox,environment.rst
index 029e7f04a4..918efd15f5 100644
--- a/Documentation/devicetree/bindings/barebox/barebox,environment.rst
+++ b/Documentation/devicetree/bindings/barebox/barebox,environment.rst
@@ -30,7 +30,7 @@ Example:
.. code-block:: none
- environment@0 {
+ environment {
compatible = "barebox,environment";
device-path = &flash, "partname:barebox-environment";
};
diff --git a/Documentation/user/barebox.rst b/Documentation/user/barebox.rst
index 1203c10cd1..82a33a3219 100644
--- a/Documentation/user/barebox.rst
+++ b/Documentation/user/barebox.rst
@@ -11,7 +11,7 @@ the suffix (for example 2014.06.1).
All releases can be downloaded from:
-http://www.barebox.org/download/
+https://www.barebox.org/download/
Development versions of barebox are accessible via Git. A local repository clone
can be checked out as follows:
@@ -39,7 +39,7 @@ you can look at the ``next`` branch:
$ git checkout -b next origin/remotes/next
A web interface to the repository is available at
-http://git.pengutronix.de/?p=barebox.git.
+https://git.pengutronix.de/cgit/barebox
.. _configuration:
diff --git a/Documentation/user/bootchooser.rst b/Documentation/user/bootchooser.rst
index 9a75afbf5e..05725d8f21 100644
--- a/Documentation/user/bootchooser.rst
+++ b/Documentation/user/bootchooser.rst
@@ -76,7 +76,7 @@ In case only the booted system itself knows when it is in a good state, the
barebox-state tool from the dt-utils_ package can be used to reset the
``remaining_attempts`` counter from the running system.
-.. _dt-utils: http://git.pengutronix.de/?p=tools/dt-utils.git;a=summary
+.. _dt-utils: https://git.pengutronix.de/cgit/tools/dt-utils
General Bootchooser Options
---------------------------
diff --git a/Documentation/user/system-setup.rst b/Documentation/user/system-setup.rst
index 7e4a7669a8..f0598bc2b5 100644
--- a/Documentation/user/system-setup.rst
+++ b/Documentation/user/system-setup.rst
@@ -29,7 +29,7 @@ A good alternative terminal program is microcom. On Debian it can be installed
with ``apt-get install microcom``, on other distributions it can be installed
from source:
-http://git.pengutronix.de/?p=tools/microcom.git;a=summary
+https://git.pengutronix.de/cgit/tools/microcom
Usage is simple::