summaryrefslogtreecommitdiffstats
path: root/Documentation/boards/at91.rst
diff options
context:
space:
mode:
authorSam Ravnborg <sam@ravnborg.org>2019-01-06 19:18:06 +0100
committerSascha Hauer <s.hauer@pengutronix.de>2019-01-08 16:40:57 +0100
commit9b20b537c892ebb0e5e25d396d2bfc49b1234919 (patch)
tree125638038ac65331708ef6fe361dcb79d9229fc4 /Documentation/boards/at91.rst
parentb3501cf81ba3ca6dafba7853a32a7b4d7f658de2 (diff)
downloadbarebox-9b20b537c892ebb0e5e25d396d2bfc49b1234919.tar.gz
barebox-9b20b537c892ebb0e5e25d396d2bfc49b1234919.tar.xz
doc: add at91 documentation
Add at91 specific documentation. Add files for the Atmel evaluations kits. This is mostly placeholders with some trivial information, but we now have files to add more information. Signed-off-by: Sam Ravnborg <sam@ravnborg.org> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'Documentation/boards/at91.rst')
-rw-r--r--Documentation/boards/at91.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/Documentation/boards/at91.rst b/Documentation/boards/at91.rst
new file mode 100644
index 0000000000..f25cb01bb1
--- /dev/null
+++ b/Documentation/boards/at91.rst
@@ -0,0 +1,51 @@
+Microchip (Atmel) AT91
+======================
+
+The Microchip (former Atmel) AT91 architecure has very good support within
+barebox.
+Most boards today have their description in their board files, but
+boards are slowly migrating to use DT.
+Likewise most boards are not yet migrated to multi image support, but
+this is also ongoing.
+
+The boot process of the AT91 CPU's is a two step process.
+The first step is named the bootstrap and at91bootstrap
+is often used (https://github.com/linux4sam/at91bootstrap).
+barebox supports bootstrapping some at91 boards as documented
+in the following.
+
+The bootstrap program are loaded by a boot program and can be loaded
+from DataFlash, NAND Flash, SD Card or via USB.
+The bootstrap program do the low-level configuration of the
+processor and then load and execute barebox.
+
+AT91 boards
+-----------
+The majority of the supported boards have a short entry here.
+For each board defconfig file(s) are noted but barebox may include additional
+defconfig files and may also include boards not included in the following.
+
+.. toctree::
+ :glob:
+ :maxdepth: 1
+
+ at91/*
+
+TODO
+----
+This is a list of AT91 specific TODO items, listed in no particular order.
+
+* fix prototype for barebox_arm_reset_vector. Introduce the prototype:
+
+.. code-block:: c
+
+ void __naked __bare_init barebox_arm_reset_vector(uint32_t r0, uint32_t r1, uint32_t r2)
+
+
+This will unify the prototype for the reset vector for multi image and standalone images
+
+* Update remaining boards to DT
+* Update remaing boards to support multi image boot
+* Get bootstrap working in combination with multi image
+* Introduce defaultenv2 for all boards
+* Add pwm driver (required to support backlight)