mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Sascha Hauer <s.hauer@pengutronix.de>
To: barebox@lists.infradead.org
Subject: [PATCH 6/6] Documentation: Add some TI AM335x specific documentation
Date: Tue, 30 Sep 2014 15:10:32 +0200	[thread overview]
Message-ID: <1412082632-25290-7-git-send-email-s.hauer@pengutronix.de> (raw)
In-Reply-To: <1412082632-25290-1-git-send-email-s.hauer@pengutronix.de>

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
---
 Documentation/boards/am335x.rst | 42 +++++++++++++++++++++++++++++++++++++++++
 Documentation/boards/omap.rst   |  4 ++--
 Documentation/user/barebox.rst  |  2 ++
 3 files changed, 46 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/boards/am335x.rst

diff --git a/Documentation/boards/am335x.rst b/Documentation/boards/am335x.rst
new file mode 100644
index 0000000..7959b84
--- /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 5038613..c269751 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 caf544d..00ceabb 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
 -----------------
 
-- 
2.1.0


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

      parent reply	other threads:[~2014-09-30 13:14 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-09-30 13:10 AM335x patches Sascha Hauer
2014-09-30 13:10 ` [PATCH 1/6] ARM: am33xx update SPI NOR: Check image size before flashing Sascha Hauer
2014-09-30 13:10 ` [PATCH 2/6] ARM: am33xx update SPI NOR: Ask use " Sascha Hauer
2014-09-30 13:10 ` [PATCH 3/6] ARM: am335x: Add a NAND update handler for the regular barebox Sascha Hauer
2014-09-30 13:10 ` [PATCH 4/6] ARM: am335x Phytec phyCORE: register SPI NOR and NAND update handlers Sascha Hauer
2014-09-30 13:10 ` [PATCH 5/6] ARM: am335x: NAND MLO update: always let the user confirm updating Sascha Hauer
2014-09-30 13:10 ` Sascha Hauer [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1412082632-25290-7-git-send-email-s.hauer@pengutronix.de \
    --to=s.hauer@pengutronix.de \
    --cc=barebox@lists.infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox