summaryrefslogtreecommitdiffstats
path: root/Documentation/boards/mxs
diff options
context:
space:
mode:
authorSascha Hauer <s.hauer@pengutronix.de>2014-06-17 10:37:25 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2014-06-26 11:07:10 +0200
commit3fef396bb42efc0bb12b0a8caf0d076ab1c4d879 (patch)
tree91625b2407ed25dffd093b19159135481eb80f84 /Documentation/boards/mxs
parent7e65163b9165bccca780da91fad247c0e4ac7f9f (diff)
downloadbarebox-3fef396bb42efc0bb12b0a8caf0d076ab1c4d879.tar.gz
barebox-3fef396bb42efc0bb12b0a8caf0d076ab1c4d879.tar.xz
Documentation: Add new sphinxs docs
This is a rewrite of the Documentation in reStructuredText format using Sphinx as build system, see http://sphinx-doc.org/. The documentation is built into static html pages with 'make docs'. The pages can be found under Documentation/html after building. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'Documentation/boards/mxs')
-rw-r--r--Documentation/boards/mxs/Chumby-Falconwing.rst46
-rw-r--r--Documentation/boards/mxs/Freescale-i.MX23-evk.rst28
-rw-r--r--Documentation/boards/mxs/KaRo-TX28.rst48
3 files changed, 122 insertions, 0 deletions
diff --git a/Documentation/boards/mxs/Chumby-Falconwing.rst b/Documentation/boards/mxs/Chumby-Falconwing.rst
new file mode 100644
index 0000000000..73e4c302f0
--- /dev/null
+++ b/Documentation/boards/mxs/Chumby-Falconwing.rst
@@ -0,0 +1,46 @@
+chumbyone Chumby Industrie's Falconwing
+=======================================
+
+This device is also known as "chumby one" (http://www.chumby.com/)
+
+This CPU card is based on a Freescale i.MX23 CPU. The card is shipped with:
+
+ * 64 MiB synchronous dynamic RAM (DDR type)
+
+Memory layout when @b barebox is running:
+
+ * 0x40000000 start of SDRAM
+ * 0x40000100 start of kernel's boot parameters
+ * below malloc area: stack area
+ * below barebox: malloc area
+ * 0x42000000 start of @b barebox
+
+How to get the bootloader binary image
+--------------------------------------
+
+Using the default configuration::
+
+ make ARCH=arm chumbyone_defconfig
+
+Build the bootloader binary image::
+
+ make ARCH=arm CROSS_COMPILE=armv5compiler
+
+NOTE replace the armv5compiler with your ARM v5 cross compiler.
+
+How to prepare an MCI card to boot the "chumby one" with barebox
+----------------------------------------------------------------
+
+ * Create four primary partitions on the MCI card
+ * the first one for the bootlets (about 256 kiB)
+ * the second one for the persistant environment (size is up to you, at least 256k)
+ * the third one for the kernel (2 MiB ... 4 MiB in size)
+ * the 4th one for the root filesystem which can fill the rest of the available space
+
+ * Mark the first partition with the partition ID "53" and copy the bootlets into this partition (currently not part of @b barebox!).
+
+ * Copy the default @b barebox environment into the second partition (no filesystem required).
+
+ * Copy the kernel into the third partition (no filesystem required).
+
+ * Create the root filesystem in the 4th partition. You may copy an image into this partition or you can do it in the classic way: mkfs on it, mount it and copy all required data and programs into it.
diff --git a/Documentation/boards/mxs/Freescale-i.MX23-evk.rst b/Documentation/boards/mxs/Freescale-i.MX23-evk.rst
new file mode 100644
index 0000000000..b03508c0bb
--- /dev/null
+++ b/Documentation/boards/mxs/Freescale-i.MX23-evk.rst
@@ -0,0 +1,28 @@
+Freescale i.MX23 evaluation kit
+===============================
+
+This CPU card is based on an i.MX23 CPU. The card is shipped with:
+
+ * 32 MiB synchronous dynamic RAM (mobile DDR type)
+ * ENC28j60 based network (over SPI)
+
+Memory layout when @b barebox is running:
+
+ * 0x40000000 start of SDRAM
+ * 0x40000100 start of kernel's boot parameters
+ * below malloc area: stack area
+ * below barebox: malloc area
+ * 0x41000000 start of @b barebox
+
+How to get the bootloader binary image
+--------------------------------------
+
+Using the default configuration::
+
+ make ARCH=arm imx23evk_defconfig
+
+Build the bootloader binary image::
+
+ make ARCH=arm CROSS_COMPILE=armv5compiler
+
+**NOTE** replace the armv5compiler with your ARM v5 cross compiler.
diff --git a/Documentation/boards/mxs/KaRo-TX28.rst b/Documentation/boards/mxs/KaRo-TX28.rst
new file mode 100644
index 0000000000..a6c308c7e6
--- /dev/null
+++ b/Documentation/boards/mxs/KaRo-TX28.rst
@@ -0,0 +1,48 @@
+KARO TX28 CPU module
+====================
+
+The CPU module
+--------------
+
+http://www.karo-electronics.de/
+
+This CPU card is based on a Freescale i.MX28 CPU. The card is shipped with:
+
+ * 128 MiB synchronous dynamic RAM (DDR2 type), 200 MHz support
+ * 128 MiB NAND K9F1G08U0A (3.3V type)
+ * PCA9554 GPIO expander
+ * DS1339 RTC
+ * LAN8710 Phy
+
+Supported baseboards
+--------------------
+
+Supported baseboards are:
+ * KARO's Starterkit 5
+
+How to get barebox for 'KARO's Starterkit 5'
+--------------------------------------------
+
+Using the default configuration::
+
+ make ARCH=arm tx28stk5_defconfig
+
+Build the binary image::
+
+ make ARCH=arm CROSS_COMPILE=armv5compiler
+
+**NOTE** replace the armv5compiler with your ARM v5 cross compiler.
+
+**NOTE** To use the result, you also need the following resources from Freescale:
+ * the 'bootlets' archive
+ * the 'elftosb2' encryption tool
+ * in the case you want to start @b barebox from an attached SD card the 'sdimage' tool from Freescale's 'uuc' archive.
+
+Memory layout when barebox is running
+-------------------------------------
+
+ * 0x40000000 start of SDRAM
+ * 0x40000100 start of kernel's boot parameters
+ * below malloc area: stack area
+ * below barebox: malloc area
+ * 0x47000000 start of @b barebox