summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorSascha Hauer <s.hauer@pengutronix.de>2014-09-30 15:07:26 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2014-09-30 15:07:26 +0200
commit3d8cf91b89c107cd55a5ee708aa091aec65111dd (patch)
tree319a4ebbaf762e939208a25a9a58d4827fd24758 /Documentation
parent36a744ed79b02f9abb8d2d1e148ae9576a669059 (diff)
downloadbarebox-3d8cf91b89c107cd55a5ee708aa091aec65111dd.tar.gz
barebox-3d8cf91b89c107cd55a5ee708aa091aec65111dd.tar.xz
Documentation: Add some TI AM335x specific documentation
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/boards/am335x.rst42
-rw-r--r--Documentation/boards/omap.rst4
-rw-r--r--Documentation/user/barebox.rst2
3 files changed, 46 insertions, 2 deletions
diff --git a/Documentation/boards/am335x.rst b/Documentation/boards/am335x.rst
new file mode 100644
index 0000000000..7959b84c8d
--- /dev/null
+++ b/Documentation/boards/am335x.rst
@@ -0,0 +1,42 @@
+Texas Instruments AM335x
+========================
+
+The Texas Instruments AM335x SoCs have a two-stage boot process. The first stage
+loader, also known as MLO is loaded by the ROM code. The MLO loads the second stage
+loader from the same medium.
+
+Building barebox
+----------------
+
+The TI AM335x boards in barebox are covered by the ``am335x_mlo_defconfig``
+for the MLO and ``am335x_defconfig`` for the regular barebox image. The
+resulting images will be placed under ``images/``:
+
+::
+ barebox-am33xx-afi-gf.img
+ barebox-am33xx-afi-gf-mlo.img
+ barebox-am33xx-beaglebone.img
+ barebox-am33xx-beaglebone-mlo.img
+ barebox-am33xx-phytec-phycore.img
+ barebox-am33xx-phytec-phycore-mlo-1x128m16.img
+ barebox-am33xx-phytec-phycore-mlo-1x256m16.img
+ barebox-am33xx-phytec-phycore-mlo-1x512m16.img
+
+Some boards come in different variants, make sure to pick the correct one.
+
+Starting and updating barebox
+-----------------------------
+
+SPI NOR and NAND
+^^^^^^^^^^^^^^^^
+
+The regular board images can be started from another bootloader, see
+:ref:`second_stage`. The board should provide update handlers
+to update (or initially install) barebox on SPI NOR or NAND, see :ref:`update`.
+
+SD/MMC
+^^^^^^
+
+To start barebox from SD/MMC prepare a card with a FAT filesystem. Copy the MLO
+file for your board to the card and name it ``MLO``. Copy the regular image
+for your board to the card and name it ``barebox.bin``.
diff --git a/Documentation/boards/omap.rst b/Documentation/boards/omap.rst
index 5038613335..c2697510c5 100644
--- a/Documentation/boards/omap.rst
+++ b/Documentation/boards/omap.rst
@@ -1,5 +1,5 @@
-Texas Instruments OMAP/AM335x
-=============================
+Texas Instruments OMAP
+======================
Texas Instruments OMAP SoCs have a two-stage boot process. The first stage is
known as Xload which only loads the second stage bootloader. barebox can act as
diff --git a/Documentation/user/barebox.rst b/Documentation/user/barebox.rst
index caf544de9f..00ceabb925 100644
--- a/Documentation/user/barebox.rst
+++ b/Documentation/user/barebox.rst
@@ -171,6 +171,8 @@ the compilation process will finish with a list of images built under ``images/`
barebox-guf-santaro.img
barebox-gk802.img
+.. _second_stage:
+
Starting barebox
-----------------