* [PATCH 1/7] ubiformat: avoid macros in help text
2014-06-26 8:51 New Documentation for barebox Sascha Hauer
@ 2014-06-26 8:51 ` Sascha Hauer
2014-06-26 8:51 ` [PATCH 2/7] automount: fix description typo Sascha Hauer
` (10 subsequent siblings)
11 siblings, 0 replies; 19+ messages in thread
From: Sascha Hauer @ 2014-06-26 8:51 UTC (permalink / raw)
To: barebox
From: Jan Luebbe <jlu@pengutronix.de>
To simplify parsing of the help strings, we need to avoid using
macros there.
Signed-off-by: Jan Luebbe <jlu@pengutronix.de>
---
commands/ubiformat.c | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/commands/ubiformat.c b/commands/ubiformat.c
index 5c8a363..443d645 100644
--- a/commands/ubiformat.c
+++ b/commands/ubiformat.c
@@ -26,7 +26,7 @@
*/
#define MAX_CONSECUTIVE_BAD_BLOCKS 4
-#define PROGRAM_NAME "ubiformat"
+#define PROGRAM_NAME "ubiformat"
#include <common.h>
#include <command.h>
@@ -337,7 +337,7 @@ static int flash_image(const struct mtd_dev_info *mtd,
long long ec;
if (!args.quiet && !args.verbose) {
- printf("\r" PROGRAM_NAME ": flashing eraseblock %d -- %2u %% complete ",
+ printf("\rubiformat: flashing eraseblock %d -- %2u %% complete ",
eb, (eb + 1) * 100 / mtd->eb_cnt);
}
@@ -447,7 +447,7 @@ static int format(const struct mtd_dev_info *mtd,
long long ec;
if (!args.quiet && !args.verbose) {
- printf("\r" PROGRAM_NAME ": formatting eraseblock %d -- %2u %% complete ",
+ printf("\rubiformat: formatting eraseblock %d -- %2u %% complete ",
eb, (eb + 1 - start_eb) * 100 / (mtd->eb_cnt - start_eb));
}
@@ -781,8 +781,8 @@ BAREBOX_CMD_HELP_OPT("-Q NUM\t", "32-bit UBI image sequence number to use")
BAREBOX_CMD_HELP_OPT("-q\t", "suppress progress percentage information")
BAREBOX_CMD_HELP_OPT("-v\t", "be verbose")
BAREBOX_CMD_HELP_TEXT("")
-BAREBOX_CMD_HELP_TEXT("Example 1: " PROGRAM_NAME " /dev/nand0 -y - format nand0 and assume yes")
-BAREBOX_CMD_HELP_TEXT("Example 2: " PROGRAM_NAME " /dev/nand0 -q -e 0 - format nand0,")
+BAREBOX_CMD_HELP_TEXT("Example 1: ubiformat /dev/nand0 -y - format nand0 and assume yes")
+BAREBOX_CMD_HELP_TEXT("Example 2: ubiformat /dev/nand0 -q -e 0 - format nand0,")
BAREBOX_CMD_HELP_TEXT("\tbe quiet and force erase counter value 0.")
BAREBOX_CMD_HELP_END
--
2.0.0
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread* [PATCH 2/7] automount: fix description typo
2014-06-26 8:51 New Documentation for barebox Sascha Hauer
2014-06-26 8:51 ` [PATCH 1/7] ubiformat: avoid macros in help text Sascha Hauer
@ 2014-06-26 8:51 ` Sascha Hauer
2014-06-26 8:51 ` [PATCH 3/7] commands: addpart: Improve description Sascha Hauer
` (9 subsequent siblings)
11 siblings, 0 replies; 19+ messages in thread
From: Sascha Hauer @ 2014-06-26 8:51 UTC (permalink / raw)
To: barebox
From: Jan Luebbe <jlu@pengutronix.de>
Signed-off-by: Jan Luebbe <jlu@pengutronix.de>
---
commands/automount.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/commands/automount.c b/commands/automount.c
index 0afe4d2..a29f286 100644
--- a/commands/automount.c
+++ b/commands/automount.c
@@ -65,7 +65,7 @@ BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(automount)
.cmd = do_automount,
- BAREBOX_CMD_DESC("execute (mount) COMMAND when PATH ist first accessed")
+ BAREBOX_CMD_DESC("execute (mount) COMMAND when PATH is first accessed")
BAREBOX_CMD_OPTS("[-ldr] PATH [COMMAND]")
BAREBOX_CMD_GROUP(CMD_GRP_PART)
BAREBOX_CMD_HELP(cmd_automount_help)
--
2.0.0
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread* [PATCH 3/7] commands: addpart: Improve description
2014-06-26 8:51 New Documentation for barebox Sascha Hauer
2014-06-26 8:51 ` [PATCH 1/7] ubiformat: avoid macros in help text Sascha Hauer
2014-06-26 8:51 ` [PATCH 2/7] automount: fix description typo Sascha Hauer
@ 2014-06-26 8:51 ` Sascha Hauer
2014-06-26 8:51 ` [PATCH 4/7] Documentation: remove doxygen documentation Sascha Hauer
` (8 subsequent siblings)
11 siblings, 0 replies; 19+ messages in thread
From: Sascha Hauer @ 2014-06-26 8:51 UTC (permalink / raw)
To: barebox
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
---
commands/partition.c | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/commands/partition.c b/commands/partition.c
index 946cf2d..51988df 100644
--- a/commands/partition.c
+++ b/commands/partition.c
@@ -166,16 +166,18 @@ static int do_addpart(int argc, char *argv[])
BAREBOX_CMD_HELP_START(addpart)
+BAREBOX_CMD_HELP_TEXT("Options:")
+BAREBOX_CMD_HELP_OPT ("-n", "do not use the device name as prefix of the partition name")
+BAREBOX_CMD_HELP_TEXT("")
+BAREBOX_CMD_HELP_TEXT("Create partitions on device DEVICE using the partition description")
+BAREBOX_CMD_HELP_TEXT("from PART.")
+BAREBOX_CMD_HELP_TEXT("PART contains a partition description compatible to the Kernel mtd")
+BAREBOX_CMD_HELP_TEXT("commandline partition description:")
+BAREBOX_CMD_HELP_TEXT("SIZE1[@OFFSET1](NAME1)[RO],SIZE2[@OFFSET2](NAME2)[RO],...")
BAREBOX_CMD_HELP_TEXT("The size and the offset can be given in decimal (without any prefix) and")
BAREBOX_CMD_HELP_TEXT("in hex (prefixed with 0x). Both can have an optional suffix K, M or G.")
BAREBOX_CMD_HELP_TEXT("The size of the last partition can be specified as '-' for the remaining")
-BAREBOX_CMD_HELP_TEXT("space on the device. This format is the same as used by the Linux")
-BAREBOX_CMD_HELP_TEXT("kernel or cmdline mtd partitions.")
-BAREBOX_CMD_HELP_TEXT("")
-BAREBOX_CMD_HELP_TEXT("Options:")
-BAREBOX_CMD_HELP_OPT ("-n", "do not use the device name as prefix of the partition name")
-BAREBOX_CMD_HELP_OPT ("DEVICE", "device being worked on")
-BAREBOX_CMD_HELP_OPT ("PART", "SIZE1[@OFFSET1](NAME1)[RO],SIZE2[@OFFSET2](NAME2)[RO],...")
+BAREBOX_CMD_HELP_TEXT("space on the device.")
BAREBOX_CMD_HELP_END
/**
--
2.0.0
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread* [PATCH 4/7] Documentation: remove doxygen documentation
2014-06-26 8:51 New Documentation for barebox Sascha Hauer
` (2 preceding siblings ...)
2014-06-26 8:51 ` [PATCH 3/7] commands: addpart: Improve description Sascha Hauer
@ 2014-06-26 8:51 ` Sascha Hauer
2014-06-26 8:51 ` [PATCH 5/7] Documentation: remove remaining documentation Sascha Hauer
` (7 subsequent siblings)
11 siblings, 0 replies; 19+ messages in thread
From: Sascha Hauer @ 2014-06-26 8:51 UTC (permalink / raw)
To: barebox
[-- Attachment #1: Type: text/plain, Size: 75608 bytes --]
The doxygen documentation is long outdated. Remove it. It will
be replaced with sphinx based documentation later.
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
---
Documentation/barebox-main.dox | 126 --
Documentation/board.dox | 94 --
Documentation/boards.dox | 74 --
Documentation/building.dox | 60 -
Documentation/commands.dox | 111 --
Documentation/developers_manual.dox | 24 -
Documentation/first_steps.dox | 61 -
Documentation/manual_org.dox | 27 -
Documentation/users_manual.dox | 18 -
Doxyfile | 1310 --------------------
Makefile | 10 -
arch/architecture.dox | 175 ---
arch/arm/boards/a9m2410/a9m2410.c | 68 -
arch/arm/boards/a9m2440/a9m2440.c | 79 --
arch/arm/boards/beagle/board.c | 31 -
arch/arm/boards/ccxmx51/ccxmx51.dox | 7 -
arch/arm/boards/chumby_falconwing/falconwing.c | 138 ---
arch/arm/boards/edb93xx/edb93xx.dox | 108 --
.../arm/boards/eukrea_cpuimx27/eukrea_cpuimx27.dox | 11 -
.../arm/boards/eukrea_cpuimx35/eukrea_cpuimx35.dox | 4 -
.../arm/boards/eukrea_cpuimx51/eukrea_cpuimx51.dox | 4 -
arch/arm/boards/freescale-mx21-ads/imx21ads.dox | 5 -
arch/arm/boards/freescale-mx23-evk/mx23-evk.c | 32 -
arch/arm/boards/freescale-mx27-ads/imx27ads.dox | 5 -
arch/arm/boards/freescale-mx35-3ds/3stack.dox | 4 -
.../arm/boards/freescale-mx51-babbage/mx51-pdk.dox | 4 -
arch/arm/boards/freescale-mx53-qsb/mx53-pdk.dox | 4 -
arch/arm/boards/freescale-mx53-smd/mx53-smd.dox | 4 -
arch/arm/boards/friendlyarm-mini2440/mini2440.c | 159 ---
arch/arm/boards/guf-cupid/cupid.dox | 9 -
arch/arm/boards/imx233-olinuxino/imx23-olinuxino.c | 59 -
arch/arm/boards/karo-tx28/tx28.c | 52 -
arch/arm/boards/karo-tx51/tx51.dox | 50 -
arch/arm/boards/module-mb7707/module-mb7707.dox | 29 -
arch/arm/boards/mx31moboard/mx31moboard.dox | 10 -
arch/arm/boards/netx/netx.dox | 9 -
arch/arm/boards/omap343xdsp/board.c | 26 -
arch/arm/boards/phytec-phycard-imx27/pca100.dox | 8 -
arch/arm/boards/phytec-phycard-omap3/pca-a-l1.dox | 16 -
arch/arm/boards/phytec-phycore-imx27/pcm038.dox | 9 -
arch/arm/boards/phytec-phycore-imx31/pcm037.dox | 11 -
arch/arm/boards/phytec-phycore-imx35/pcm043.dox | 28 -
arch/arm/boards/qil-a926x/qil-a9260.dox | 22 -
arch/arm/boards/scb9328/scb9328.dox | 9 -
arch/arm/boards/tny-a926x/tny-a9263.dox | 33 -
arch/arm/boards/tny-a926x/tny-a9g20-lpw.dox | 37 -
arch/arm/boards/toshiba-ac100/toshiba-ac100.dox | 37 -
arch/arm/boards/usb-a926x/usb-a9263.dox | 30 -
arch/arm/boards/usb-a926x/usb-a9g20-lpw.dox | 33 -
arch/arm/boards/virt2real/virt2real.dox | 41 -
arch/arm/mach-arm.dox | 67 -
arch/arm/mach-davinci/mach-davinci.dox | 7 -
arch/arm/mach-omap/arch-omap.dox | 96 --
arch/arm/mach-samsung/lowlevel-s3c24x0.S | 8 -
arch/arm/mach-samsung/mem-s3c24x0.c | 57 -
arch/blackfin/boards/ipe337/ipe337.dox | 10 -
arch/blackfin/mach-bf.dox | 9 -
arch/mips/boards/dlink-dir-320/dlink-dir-320.dox | 38 -
arch/mips/boards/loongson-ls1b/loongson_ls1b.dox | 47 -
arch/mips/boards/qemu-malta/qemu-malta.dox | 20 -
arch/mips/boards/ritmix-rzx50/ritmix-rzx50.dox | 46 -
arch/mips/boards/tplink-mr3020/tplink-mr3020.dox | 64 -
arch/mips/mach-bcm47xx/mach-bcm47xx.dox | 7 -
arch/mips/mach-loongson/mach-loongson.dox | 7 -
arch/mips/mach-malta/mach-malta.dox | 7 -
arch/mips/mach-mips.dox | 69 --
arch/mips/mach-xburst/mach-xburst.dox | 7 -
arch/ppc/boards/pcm030/pcm030.dox | 8 -
arch/ppc/mach-ppc.dox | 9 -
arch/sandbox/os/common.c | 55 -
arch/x86/boards/x86_generic/generic_pc.c | 34 -
arch/x86/boot/bioscall.S | 4 -
arch/x86/lib/bios_disk.S | 3 -
arch/x86/lib/linux_start.S | 3 -
arch/x86/mach-x86.dox | 128 --
commands/bootm.c | 17 -
commands/cp.c | 14 -
commands/devinfo.c | 28 -
commands/dfu.c | 10 -
commands/echo.c | 8 -
commands/edit.c | 16 -
commands/flash.c | 52 -
commands/gpio.c | 62 -
commands/led.c | 9 -
commands/linux16.c | 66 -
commands/loadenv.c | 9 -
commands/miitool.c | 6 -
commands/mount.c | 36 -
commands/partition.c | 24 -
commands/printenv.c | 14 -
commands/saveenv.c | 18 -
commands/setenv.c | 13 -
commands/splash.c | 11 -
commands/usbserial.c | 4 -
common/kallsyms.c | 4 -
include/command.h | 4 -
include/driver.h | 26 -
include/i2c/i2c.h | 4 -
include/linux/mtd/mtd-abi.h | 4 -
include/linux/mtd/mtd.h | 4 -
include/spi/spi.h | 4 -
include/usb/ch9.h | 4 -
include/usb/composite.h | 4 -
include/usb/gadget.h | 4 -
include/usb/usb.h | 4 -
net/netconsole.c | 28 -
scripts/doxy_filter.awk | 103 --
107 files changed, 4739 deletions(-)
delete mode 100644 Documentation/barebox-main.dox
delete mode 100644 Documentation/board.dox
delete mode 100644 Documentation/boards.dox
delete mode 100644 Documentation/building.dox
delete mode 100644 Documentation/commands.dox
delete mode 100644 Documentation/developers_manual.dox
delete mode 100644 Documentation/first_steps.dox
delete mode 100644 Documentation/manual_org.dox
delete mode 100644 Documentation/users_manual.dox
delete mode 100644 Doxyfile
delete mode 100644 arch/architecture.dox
delete mode 100644 arch/arm/boards/ccxmx51/ccxmx51.dox
delete mode 100644 arch/arm/boards/edb93xx/edb93xx.dox
delete mode 100644 arch/arm/boards/eukrea_cpuimx27/eukrea_cpuimx27.dox
delete mode 100644 arch/arm/boards/eukrea_cpuimx35/eukrea_cpuimx35.dox
delete mode 100644 arch/arm/boards/eukrea_cpuimx51/eukrea_cpuimx51.dox
delete mode 100644 arch/arm/boards/freescale-mx21-ads/imx21ads.dox
delete mode 100644 arch/arm/boards/freescale-mx27-ads/imx27ads.dox
delete mode 100644 arch/arm/boards/freescale-mx35-3ds/3stack.dox
delete mode 100644 arch/arm/boards/freescale-mx51-babbage/mx51-pdk.dox
delete mode 100644 arch/arm/boards/freescale-mx53-qsb/mx53-pdk.dox
delete mode 100644 arch/arm/boards/freescale-mx53-smd/mx53-smd.dox
delete mode 100644 arch/arm/boards/guf-cupid/cupid.dox
delete mode 100644 arch/arm/boards/karo-tx51/tx51.dox
delete mode 100644 arch/arm/boards/module-mb7707/module-mb7707.dox
delete mode 100644 arch/arm/boards/mx31moboard/mx31moboard.dox
delete mode 100644 arch/arm/boards/netx/netx.dox
delete mode 100644 arch/arm/boards/phytec-phycard-imx27/pca100.dox
delete mode 100644 arch/arm/boards/phytec-phycard-omap3/pca-a-l1.dox
delete mode 100644 arch/arm/boards/phytec-phycore-imx27/pcm038.dox
delete mode 100644 arch/arm/boards/phytec-phycore-imx31/pcm037.dox
delete mode 100644 arch/arm/boards/phytec-phycore-imx35/pcm043.dox
delete mode 100644 arch/arm/boards/qil-a926x/qil-a9260.dox
delete mode 100644 arch/arm/boards/scb9328/scb9328.dox
delete mode 100644 arch/arm/boards/tny-a926x/tny-a9263.dox
delete mode 100644 arch/arm/boards/tny-a926x/tny-a9g20-lpw.dox
delete mode 100644 arch/arm/boards/toshiba-ac100/toshiba-ac100.dox
delete mode 100644 arch/arm/boards/usb-a926x/usb-a9263.dox
delete mode 100644 arch/arm/boards/usb-a926x/usb-a9g20-lpw.dox
delete mode 100644 arch/arm/boards/virt2real/virt2real.dox
delete mode 100644 arch/arm/mach-arm.dox
delete mode 100644 arch/arm/mach-davinci/mach-davinci.dox
delete mode 100644 arch/arm/mach-omap/arch-omap.dox
delete mode 100644 arch/blackfin/boards/ipe337/ipe337.dox
delete mode 100644 arch/blackfin/mach-bf.dox
delete mode 100644 arch/mips/boards/dlink-dir-320/dlink-dir-320.dox
delete mode 100644 arch/mips/boards/loongson-ls1b/loongson_ls1b.dox
delete mode 100644 arch/mips/boards/qemu-malta/qemu-malta.dox
delete mode 100644 arch/mips/boards/ritmix-rzx50/ritmix-rzx50.dox
delete mode 100644 arch/mips/boards/tplink-mr3020/tplink-mr3020.dox
delete mode 100644 arch/mips/mach-bcm47xx/mach-bcm47xx.dox
delete mode 100644 arch/mips/mach-loongson/mach-loongson.dox
delete mode 100644 arch/mips/mach-malta/mach-malta.dox
delete mode 100644 arch/mips/mach-mips.dox
delete mode 100644 arch/mips/mach-xburst/mach-xburst.dox
delete mode 100644 arch/ppc/boards/pcm030/pcm030.dox
delete mode 100644 arch/ppc/mach-ppc.dox
delete mode 100644 arch/x86/mach-x86.dox
delete mode 100644 scripts/doxy_filter.awk
diff --git a/Documentation/barebox-main.dox b/Documentation/barebox-main.dox
deleted file mode 100644
index c98c75f..0000000
diff --git a/Documentation/board.dox b/Documentation/board.dox
deleted file mode 100644
index e545709..0000000
diff --git a/Documentation/boards.dox b/Documentation/boards.dox
deleted file mode 100644
index 8d4fabb..0000000
diff --git a/Documentation/building.dox b/Documentation/building.dox
deleted file mode 100644
index 527ca45..0000000
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
deleted file mode 100644
index d8cfa6b..0000000
diff --git a/Documentation/developers_manual.dox b/Documentation/developers_manual.dox
deleted file mode 100644
index 2f7d360..0000000
diff --git a/Documentation/first_steps.dox b/Documentation/first_steps.dox
deleted file mode 100644
index 17fdf37..0000000
diff --git a/Documentation/manual_org.dox b/Documentation/manual_org.dox
deleted file mode 100644
index 17238f0..0000000
diff --git a/Documentation/users_manual.dox b/Documentation/users_manual.dox
deleted file mode 100644
index ea47b18..0000000
diff --git a/Doxyfile b/Doxyfile
deleted file mode 100644
index 89151e3..0000000
diff --git a/Makefile b/Makefile
index 746f412..e7e1679 100644
--- a/Makefile
+++ b/Makefile
@@ -1117,16 +1117,6 @@ help:
@echo 'Execute "make" or "make all" to build all targets marked with [*] '
@echo 'For further info see the ./README file'
-# Generate doxygen docs
-# ---------------------------------------------------------------------------
-.PHONY += docs htmldocs
-
-docs : htmldocs
-
-htmldocs: Doxyfile.version
- @echo 'Running doxygen with local Doxyfile'
- $(Q)doxygen Doxyfile
-
# Generate tags for editors
# ---------------------------------------------------------------------------
quiet_cmd_tags = GEN $@
diff --git a/arch/architecture.dox b/arch/architecture.dox
deleted file mode 100644
index 2d2cf05..0000000
diff --git a/arch/arm/boards/a9m2410/a9m2410.c b/arch/arm/boards/a9m2410/a9m2410.c
index 943b770..44cf51b 100644
--- a/arch/arm/boards/a9m2410/a9m2410.c
+++ b/arch/arm/boards/a9m2410/a9m2410.c
@@ -14,12 +14,6 @@
*
*/
-/**
- * @file
- * @brief a9m2410 Specific Board Initialization routines
- *
- */
-
#include <common.h>
#include <driver.h>
#include <init.h>
@@ -154,65 +148,3 @@ static int a9m2410_console_init(void)
}
console_initcall(a9m2410_console_init);
-
-/** @page a9m2410 DIGI's a9m2410
-
-This CPU card is based on a Samsung S3C2410 CPU. The card is shipped with:
-
-- S3C2410\@200 MHz (ARM920T/ARMv4T)
-- 12MHz crystal reference
-- SDRAM 32 MiB
- - Samsung K4M563233E-EE1H
- - 2M x 32Bit x 4 Banks Mobile SDRAM
- - 90 pin FBGA
- - CL3\@133MHz, CL2\@100MHz (CAS/RAS delay 19ns)
- - four banks
- - 32 bit data bits
- - row address size is 11
- - Row cycle time: 69ns
- - collumn address size is 9 bits
- - Extended temperature range (-25�C...85�C)
- - 64ms refresh period (4k)
-- NAND Flash 32 MiB
- - Samsung KM29U256T
- - 32MiB 3,3V 8-bit
- - ID: 0xEC, 0x75, 0x??, 0xBD
- - 30ns/40ns/20ns
-- I2C interface, 100KHz and 400KHz
- - Real Time Clock
- - Dallas DS1337
- - address 0x68
- - EEPROM
- - ST M24LC64
- - address 0x50
- - 16bit addressing
-- LCD interface
-- Touch Screen interface
-- Camera interface
-- I2S interface
-- AC97 Audio-CODEC interface
-- SD card interface
-- 3 serial RS232 interfaces
-- Host and device USB interface, USB1.1 compliant
-- Ethernet interface
- - 10Mbps, Cirrus Logic, CS8900A (on the CPU card) or
- - 10/100Mbps, SMSC 91C111 (on the baseboard)
-- SPI interface
-- JTAG interface
-
-How to get the binary image:
-
-Using the default configuration:
-
-@code
-make ARCH=arm a9m2410_defconfig
-@endcode
-
-Build the binary image:
-
-@code
-make ARCH=arm CROSS_COMPILE=armv4compiler
-@endcode
-
-@note replace the armv4compiler with your ARM v4 cross compiler.
-*/
diff --git a/arch/arm/boards/a9m2440/a9m2440.c b/arch/arm/boards/a9m2440/a9m2440.c
index faac38a..587baf6 100644
--- a/arch/arm/boards/a9m2440/a9m2440.c
+++ b/arch/arm/boards/a9m2440/a9m2440.c
@@ -14,12 +14,6 @@
*
*/
-/**
- * @file
- * @brief a9m2440 Specific Board Initialization routines
- *
- */
-
#include <common.h>
#include <driver.h>
#include <init.h>
@@ -161,76 +155,3 @@ static int a9m2440_console_init(void)
}
console_initcall(a9m2440_console_init);
-
-/** @page a9m2440 DIGI's a9m2440
-
-This CPU card is based on a Samsung S3C2440 CPU. The card is shipped with:
-
-- S3C2440\@400 MHz or 533 MHz (ARM920T/ARMv4T)
-- 16.9344 MHz crystal reference
-- SDRAM 32/64/128 MiB
- - Samsung K4M563233E-EE1H (one or two devices for 32 MiB or 64 MiB)
- - 2M x 32bit x 4 Banks Mobile SDRAM
- - CL2\@100 MHz (CAS/RAS delay 19ns)
- - 105 MHz max
- - collumn address size is 9 bits
- - Row cycle time: 69ns
- - Samsung K4M513233C-DG75 (one or two devices for 64 MiB or 128 MiB)
- - 4M x 32bit x 4 Banks Mobile SDRAM
- - CL2\@100MHz (CAS/RAS delay 18ns)
- - 111 MHz max
- - collumn address size is 9 bits
- - Row cycle time: 63ns
- - 64ms refresh period (4k)
- - 90 pin FBGA
- - 32 bit data bits
- - Extended temperature range (-25�C...85�C)
-- NAND Flash 32/64/128 MiB
- - Samsung KM29U512T (NAND01GW3A0AN6)
- - 64 MiB 3,3V 8-bit
- - ID: 0xEC, 0x76, 0x??, 0xBD
- - Samsung KM29U256T
- - 32 MiB 3,3V 8-bit
- - ID: 0xEC, 0x75, 0x??, 0xBD
- - ST Micro
- - 128 MiB 3,3V 8-bit
- - ID: 0x20, 0x79
- - 30ns/40ns/20ns
-- I2C interface, 100 KHz and 400 KHz
- - Real Time Clock
- - Dallas DS1337
- - address 0x68
- - EEPROM
- - ST M24LC64
- - address 0x50
- - 16bit addressing
-- LCD interface
-- Touch Screen interface
-- Camera interface
-- I2S interface
-- AC97 Audio-CODEC interface
-- SD card interface
-- 3 serial RS232 interfaces
-- Host and device USB interface, USB1.1 compliant
-- Ethernet interface
- - 10Mbps, Cirrus Logic, CS8900A (on the CPU card)
-- SPI interface
-- JTAG interface
-
-How to get the binary image:
-
-Using the default configuration:
-
-@code
-make ARCH=arm a9m2440_defconfig
-@endcode
-
-Build the binary image:
-
-@code
-make ARCH=arm CROSS_COMPILE=armv4compiler
-@endcode
-
-@note replace the armv4compiler with your ARM v4 cross compiler.
-
-*/
diff --git a/arch/arm/boards/beagle/board.c b/arch/arm/boards/beagle/board.c
index 1899b1d..4054960 100644
--- a/arch/arm/boards/beagle/board.c
+++ b/arch/arm/boards/beagle/board.c
@@ -15,37 +15,6 @@
*
*/
-/**
- * @file
- * @brief Beagle Specific Board Initialization routines
- */
-
-/**
- * @page ti_beagle Texas Instruments Beagle Board
- *
- * Beagle Board from Texas Instruments as described here:
- * http://www.beagleboard.org
- *
- * This board is based on OMAP3530.
- * More on OMAP3530 (including documentation can be found here):
- * http://focus.ti.com/docs/prod/folders/print/omap3530.html
- *
- * This file provides initialization in two stages:
- * @li boot time initialization - do basics required to get SDRAM working.
- * This is run from SRAM - so no case constructs and global vars can be used.
- * @li run time initialization - this is for the rest of the initializations
- * such as flash, uart etc.
- *
- * Boot time initialization includes:
- * @li SDRAM initialization.
- * @li Pin Muxing relevant for Beagle.
- *
- * Run time initialization includes
- * @li serial @ref serial_ns16550.c driver device definition
- *
- * Originally from arch/arm/boards/omap/board-sdp343x.c
- */
-
#include <common.h>
#include <console.h>
#include <init.h>
diff --git a/arch/arm/boards/ccxmx51/ccxmx51.dox b/arch/arm/boards/ccxmx51/ccxmx51.dox
deleted file mode 100644
index cc28e8d..0000000
diff --git a/arch/arm/boards/chumby_falconwing/falconwing.c b/arch/arm/boards/chumby_falconwing/falconwing.c
index 77581f6..2e5fca5 100644
--- a/arch/arm/boards/chumby_falconwing/falconwing.c
+++ b/arch/arm/boards/chumby_falconwing/falconwing.c
@@ -318,141 +318,3 @@ static int falconwing_console_init(void)
}
console_initcall(falconwing_console_init);
-
-/** @page 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
-
-@section get_falconwing_binary How to get the bootloader binary image:
-
-Using the default configuration:
-
-@verbatim
-make ARCH=arm chumbyone_defconfig
-@endverbatim
-
-Build the bootloader binary image:
-
-@verbatim
-make ARCH=arm CROSS_COMPILE=armv5compiler
-@endverbatim
-
-@note replace the armv5compiler with your ARM v5 cross compiler.
-
-@section setup_falconwing 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.
-
-@section gpio_falconwing Available GPIOs
-
-The Falconwing uses some GPIOs to control various features. With the regular
-GPIO commands these features can be controlled at @a barebox's runtime.
-
-<table width="100%" border="1" cellspacing="1" cellpadding="3">
- <tr>
- <td>No</td>
- <td>Direction</td>
- <td>Function</td>
- <td>Reset</td>
- <td>Set</td>
- </tr>
- <tr>
- <td>8</td>
- <td>Output</td>
- <td>Switch Audio Amplifier</td>
- <td>Off</td>
- <td>On</td>
- </tr>
- <tr>
- <td>11</td>
- <td>Input</td>
- <td>Head Phone Detection</td>
- <td>TBD</td>
- <td>TBD</td>
- </tr>
- <tr>
- <td>14</td>
- <td>Input</td>
- <td>Unused (J113)</td>
- <td>User</td>
- <td>User</td>
- </tr>
- <tr>
- <td>15</td>
- <td>Input</td>
- <td>Unused (J114)</td>
- <td>User</td>
- <td>User</td>
- </tr>
- <tr>
- <td>26</td>
- <td>Output</td>
- <td>USB Power</td>
- <td>TBD</td>
- <td>TBD</td>
- </tr>
- <tr>
- <td>27</td>
- <td>Input</td>
- <td>Display Connected</td>
- <td>Display<br>Attached</td>
- <td>Display<br>Disconnected</td>
- </tr>
- <tr>
- <td>29</td>
- <td>Output</td>
- <td>USB HUB Reset</td>
- <td>TBD</td>
- <td>TBD</td>
- </tr>
- <tr>
- <td>50</td>
- <td>Output</td>
- <td>Display Reset</td>
- <td>Display<br>Reset</td>
- <td>Display<br>Running</td>
- </tr>
- <tr>
- <td>60</td>
- <td>Output</td>
- <td>Display Backlight</td>
- <td>Backlight<br>Off</td>
- <td>Backlight<br>On (100 %)</td>
- </tr>
- <tr>
- <td>62</td>
- <td>Input</td>
- <td>Bend</td>
- <td>Not pressed</td>
- <td>Pressed</td>
- </tr>
-</table>
-
-*/
diff --git a/arch/arm/boards/edb93xx/edb93xx.dox b/arch/arm/boards/edb93xx/edb93xx.dox
deleted file mode 100644
index 3964d55..0000000
diff --git a/arch/arm/boards/eukrea_cpuimx27/eukrea_cpuimx27.dox b/arch/arm/boards/eukrea_cpuimx27/eukrea_cpuimx27.dox
deleted file mode 100644
index 6c2bfed..0000000
diff --git a/arch/arm/boards/eukrea_cpuimx35/eukrea_cpuimx35.dox b/arch/arm/boards/eukrea_cpuimx35/eukrea_cpuimx35.dox
deleted file mode 100644
index cbdf69d..0000000
diff --git a/arch/arm/boards/eukrea_cpuimx51/eukrea_cpuimx51.dox b/arch/arm/boards/eukrea_cpuimx51/eukrea_cpuimx51.dox
deleted file mode 100644
index 0f35e17..0000000
diff --git a/arch/arm/boards/freescale-mx21-ads/imx21ads.dox b/arch/arm/boards/freescale-mx21-ads/imx21ads.dox
deleted file mode 100644
index 9f11ffa..0000000
diff --git a/arch/arm/boards/freescale-mx23-evk/mx23-evk.c b/arch/arm/boards/freescale-mx23-evk/mx23-evk.c
index 1eae377..9f13fac 100644
--- a/arch/arm/boards/freescale-mx23-evk/mx23-evk.c
+++ b/arch/arm/boards/freescale-mx23-evk/mx23-evk.c
@@ -144,35 +144,3 @@ static int mx23_evk_console_init(void)
}
console_initcall(mx23_evk_console_init);
-
-/** @page mx23_evk Freescale's 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
-
-@section get_imx23evk_binary How to get the bootloader binary image:
-
-Using the default configuration:
-
-@verbatim
-make ARCH=arm imx23evk_defconfig
-@endverbatim
-
-Build the bootloader binary image:
-
-@verbatim
-make ARCH=arm CROSS_COMPILE=armv5compiler
-@endverbatim
-
-@note replace the armv5compiler with your ARM v5 cross compiler.
-*/
diff --git a/arch/arm/boards/freescale-mx27-ads/imx27ads.dox b/arch/arm/boards/freescale-mx27-ads/imx27ads.dox
deleted file mode 100644
index e14d8e3..0000000
diff --git a/arch/arm/boards/freescale-mx35-3ds/3stack.dox b/arch/arm/boards/freescale-mx35-3ds/3stack.dox
deleted file mode 100644
index 15c5b6e..0000000
diff --git a/arch/arm/boards/freescale-mx51-babbage/mx51-pdk.dox b/arch/arm/boards/freescale-mx51-babbage/mx51-pdk.dox
deleted file mode 100644
index d9ea823..0000000
diff --git a/arch/arm/boards/freescale-mx53-qsb/mx53-pdk.dox b/arch/arm/boards/freescale-mx53-qsb/mx53-pdk.dox
deleted file mode 100644
index 3a2c84f..0000000
diff --git a/arch/arm/boards/freescale-mx53-smd/mx53-smd.dox b/arch/arm/boards/freescale-mx53-smd/mx53-smd.dox
deleted file mode 100644
index 1960508..0000000
diff --git a/arch/arm/boards/friendlyarm-mini2440/mini2440.c b/arch/arm/boards/friendlyarm-mini2440/mini2440.c
index 86e22ad..4034de5 100644
--- a/arch/arm/boards/friendlyarm-mini2440/mini2440.c
+++ b/arch/arm/boards/friendlyarm-mini2440/mini2440.c
@@ -16,12 +16,6 @@
*
*/
-/**
- * @file
- * @brief mini2440 Specific Board Initialization routines
- *
- */
-
#include <common.h>
#include <driver.h>
#include <init.h>
@@ -338,156 +332,3 @@ static int mini2440_console_init(void)
}
console_initcall(mini2440_console_init);
-
-/** @page mini2440 FriendlyARM's mini2440
-
-This system is based on a Samsung S3C2440 CPU. The card is shipped with:
-
-- S3C2440\@400 MHz or 533 MHz (ARM920T/ARMv4T)
-- 12 MHz crystal reference
-- 32.768 kHz crystal reference
-- SDRAM 64 MiB (one bank only)
- - HY57V561620 (two devices for 64 MiB to form a 32 bit bus)
- - 4M x 16bit x 4 Banks Mobile SDRAM
- - 8192 refresh cycles / 64 ms
- - CL2\@100 MHz
- - 133 MHz max
- - collumn address size is 9 bits
- - row address size is 13 bits
- - MT48LC16M16 (two devices for 64 MiB to form a 32 bit bus)
- - 4M x 16bit x 4 Banks Mobile SDRAM
- - commercial & industrial type
- - 8192 refresh cycles / 64 ms
- - CL2\@100 MHz
- - 133 MHz max
- - collumn address size is 9 bits
- - row address size is 13 bits
-- NAND Flash 128MiB...1GiB
- - K9Fxx08
-- NOR Flash (up to 22 address lines available)
- - AM29LV160DB, 2 MiB
- - SST39VF1601, 2 MiB
- - 16 bit data bus
-- SD card interface, 3.3V (fixed voltage)
-- Host and device USB interface, USB1.1 compliant
-- UDA1341TS Audio
-- DM9000 Ethernet interface
- - uses CS#4
- - uses EINT7
- - 16 bit data bus
-- I2C interface, 100 KHz and 400 KHz
- - EEPROM
- - ST M24C08
- - address 0x50
-- Speaker on GPB0 ("low" = inactive)
-- LCD interface
-- Touch Screen interface
-- Camera interface
-- I2S interface
-- AC97 Audio-CODEC interface
-- three serial RS232 interfaces (one with level converter)
-- SPI interface
-- JTAG interface
-
-How to get the binary image:
-
-Using the default configuration:
-
-@code
-make ARCH=arm mini2440_defconfig
-@endcode
-
-Build the binary image:
-
-@code
-make ARCH=arm CROSS_COMPILE=armv4compiler
-@endcode
-
-@note replace the armv4compiler with your ARM v4 cross compiler.
-
-How to bring in \a barebox ?
-
-First run it as a second stage bootloader. There are two known working ways to
-do so:
-
-One way is to use the "device firmware update" feature of the 'supervivi'.
- - connect a terminal application to the mini2440's serial connector
- - switch S2 to 'boot from NOR' to boot into 'supervivi'
- - connect your host to the usb device connector on the mini2440
- - switch on your mini2440
- - in 'supervivi' type q (command line) then:
-@code
-load ram 0x31000000 \<barebox-size\> u
-@endcode
- - use a tool for DFU update (for example from openkomo) to transfer the 'barebox.bin' binary
- - then in 'supervivi' just run
-@code
-go 0x31000000
-@endcode
-
-A second way is to use any kind of JTAG adapter. For this case I'm using the
-'JTAKkey tiny' from Amontec and OpenOCD. First you need an adapter for this
-kind of Dongle as it uses a 20 pin connector with 2.54 mm grid, and the
-mini2440 uses a 10 pin connector with 2 mm grid.
-
-@code
- Amontec JTAGkey tiny mini2440
- -------------------------------------------------------
- VREF 1 2 n.c. VREF 1 2 VREF
- TRST_N 3 4 GND TRST_N 3 4 SRST_N
- TDI 5 6 GND TDI 5 6 TDO
- TMS 7 8 GND TMS 7 8 GND
- TCK 9 10 GND TCK 9 10 GND
- n.c. 11 12 GND
- TDO 13 14 GND
- SRST_N 15 16 GND
- n.c. 17 18 GND
- n.c. 19 20 GND
-@endcode
-
-Create a simple board description file. I did it this way:
-
-@code
-source [find interface/jtagkey-tiny.cfg]
-source [find target/samsung_s3c2440.cfg]
-
-adapter_khz 12000
-@endcode
-
-And then the following steps:
- - connect a terminal application to the mini2440's serial connector
- - connect the mini2440 to a working network
- - switch S2 to boot from NOR to boot into 'supervivi'
- - switch on your mini2440
- - run the OpenOCD daemon configured with the file shown above
- - connect to the OpenOCD daemon via 'telnet'.
- - run the following commands to download @a barebox into your target
-@code
-> halt
-> load_image \<path to the 'barebox.bin'\> 0x31000000 bin
-> resume 0x31000000
-@endcode
-
-Now @a barebox is starting from an already initialized CPU and SDRAM (done by
-'supervivi').
-
-Change to your terminal console and configure the network first. Adapt the
-following settings to your network:
-@code
-eth0.ipaddr=192.168.1.240
-eth0.netmask=255.255.255.0
-eth0.gateway=192.168.23.2
-eth0.serverip=192.168.1.7
-eth0.ethaddr=00:04:f3:00:06:35
-@endcode
-
-A 'ping' to your TFTP server should bring a "...is alive" message now.
-
-We are ready now to program @a barebox into the NAND flash:
-
-@code
-erase /dev/nand0.barebox.bb
-tftp barebox.bin /dev/nand0.barebox.bb
-@endcode
-
-*/
diff --git a/arch/arm/boards/guf-cupid/cupid.dox b/arch/arm/boards/guf-cupid/cupid.dox
deleted file mode 100644
index 45f0e0c..0000000
diff --git a/arch/arm/boards/imx233-olinuxino/imx23-olinuxino.c b/arch/arm/boards/imx233-olinuxino/imx23-olinuxino.c
index fae4d91..fa95d72 100644
--- a/arch/arm/boards/imx233-olinuxino/imx23-olinuxino.c
+++ b/arch/arm/boards/imx233-olinuxino/imx23-olinuxino.c
@@ -143,62 +143,3 @@ static int imx23_olinuxino_console_init(void)
}
console_initcall(imx23_olinuxino_console_init);
-
-/** @page olinuxino Olimex.ltd's i.MX23 evaluation kit
-
-This CPU card is based on an i.MX23 CPU. The card is shipped with:
-
-- 64 MiB synchronous dynamic RAM (mobile 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
-
-@section get_imx23_olinuxino_binary How to get the bootloader binary image:
-
-Using the default configuration:
-
-@verbatim
-make ARCH=arm imx23_olinuxino_defconfig
-@endverbatim
-
-Build the bootloader binary image:
-
-@verbatim
-make ARCH=arm CROSS_COMPILE=armv5compiler
-@endverbatim
-
-@note replace the armv5compiler with your ARM v5 cross compiler.
-
-@section imx233-olinuxino How to prepare an MCI card to boot
-the imx233-olinuxino 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!).
-
-- @b barebox expect device tree blob file imx23-olinuxino.dtb
- into directory env/oftree. At compile time, copy blob file into directory
- arch/arm/boards/imx233-olinuxino/env/oftree/.
-
-- 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/arch/arm/boards/karo-tx28/tx28.c b/arch/arm/boards/karo-tx28/tx28.c
index 3fb1fe9..26dbc00 100644
--- a/arch/arm/boards/karo-tx28/tx28.c
+++ b/arch/arm/boards/karo-tx28/tx28.c
@@ -99,55 +99,3 @@ static int tx28_devices_init(void)
}
device_initcall(tx28_devices_init);
-
-/**
-@page tx28 KARO's TX28 CPU module
-
-@section tx28_cpu_card 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
-
-@section tx28_basboards Supported baseboards
-
-Supported baseboards are:
-- KARO's Starterkit 5
-
-@section tx28_stk5_howto How to get barebox for 'KARO's Starterkit 5'
-
-Using the default configuration:
-
-@verbatim
-make ARCH=arm tx28stk5_defconfig
-@endverbatim
-
-Build the binary image:
-
-@verbatim
-make ARCH=arm CROSS_COMPILE=armv5compiler
-@endverbatim
-
-@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.
-
-@section tx28_mlayout 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
-
-*/
diff --git a/arch/arm/boards/karo-tx51/tx51.dox b/arch/arm/boards/karo-tx51/tx51.dox
deleted file mode 100644
index 08268e0..0000000
diff --git a/arch/arm/boards/module-mb7707/module-mb7707.dox b/arch/arm/boards/module-mb7707/module-mb7707.dox
deleted file mode 100644
index c0dbc8a..0000000
diff --git a/arch/arm/boards/mx31moboard/mx31moboard.dox b/arch/arm/boards/mx31moboard/mx31moboard.dox
deleted file mode 100644
index 41c8bbb..0000000
diff --git a/arch/arm/boards/netx/netx.dox b/arch/arm/boards/netx/netx.dox
deleted file mode 100644
index e22c5e8..0000000
diff --git a/arch/arm/boards/omap343xdsp/board.c b/arch/arm/boards/omap343xdsp/board.c
index 8329ace..1b1cb79 100644
--- a/arch/arm/boards/omap343xdsp/board.c
+++ b/arch/arm/boards/omap343xdsp/board.c
@@ -15,32 +15,6 @@
*
*/
-/**
- * @file
- * @brief SDP3430 Specific Board Initialization routines
- */
-
-/**
- * @page ti_SDP3430 Texas Instruments SDP3430
- *
- * SDP3430 from Texas Instruments as described here:
- * http://www.ti.com/omap3430_devplatform
- * This file provides initialization in two stages:
- * @li boot time initialization - do basics required to get SDRAM working.
- * This is run from SRAM - so no case constructs and global vars can be used.
- * @li run time initialization - this is for the rest of the initializations
- * such as flash, uart etc.
- *
- * Boot time initialization includes:
- * @li SDRAM initialization.
- * @li Pin Muxing relevant for SDP3430.
- *
- * Run time initialization includes
- * @li serial @ref serial_ns16550.c driver device definition
- *
- * Originally from http://linux.omap.com/pub/bootloader/3430sdp/u-boot-v1.tar.gz
- */
-
#include <common.h>
#include <console.h>
#include <init.h>
diff --git a/arch/arm/boards/phytec-phycard-imx27/pca100.dox b/arch/arm/boards/phytec-phycard-imx27/pca100.dox
deleted file mode 100644
index 9b17674..0000000
diff --git a/arch/arm/boards/phytec-phycard-omap3/pca-a-l1.dox b/arch/arm/boards/phytec-phycard-omap3/pca-a-l1.dox
deleted file mode 100644
index d93c574..0000000
diff --git a/arch/arm/boards/phytec-phycore-imx27/pcm038.dox b/arch/arm/boards/phytec-phycore-imx27/pcm038.dox
deleted file mode 100644
index 85177d2..0000000
diff --git a/arch/arm/boards/phytec-phycore-imx31/pcm037.dox b/arch/arm/boards/phytec-phycore-imx31/pcm037.dox
deleted file mode 100644
index b2afdd6..0000000
diff --git a/arch/arm/boards/phytec-phycore-imx35/pcm043.dox b/arch/arm/boards/phytec-phycore-imx35/pcm043.dox
deleted file mode 100644
index c6715ff..0000000
diff --git a/arch/arm/boards/qil-a926x/qil-a9260.dox b/arch/arm/boards/qil-a926x/qil-a9260.dox
deleted file mode 100644
index da5c197..0000000
diff --git a/arch/arm/boards/scb9328/scb9328.dox b/arch/arm/boards/scb9328/scb9328.dox
deleted file mode 100644
index 75bc7c8..0000000
diff --git a/arch/arm/boards/tny-a926x/tny-a9263.dox b/arch/arm/boards/tny-a926x/tny-a9263.dox
deleted file mode 100644
index 68fcdd1..0000000
diff --git a/arch/arm/boards/tny-a926x/tny-a9g20-lpw.dox b/arch/arm/boards/tny-a926x/tny-a9g20-lpw.dox
deleted file mode 100644
index e002107..0000000
diff --git a/arch/arm/boards/toshiba-ac100/toshiba-ac100.dox b/arch/arm/boards/toshiba-ac100/toshiba-ac100.dox
deleted file mode 100644
index 7c50f3c..0000000
diff --git a/arch/arm/boards/usb-a926x/usb-a9263.dox b/arch/arm/boards/usb-a926x/usb-a9263.dox
deleted file mode 100644
index 380a8e2..0000000
diff --git a/arch/arm/boards/usb-a926x/usb-a9g20-lpw.dox b/arch/arm/boards/usb-a926x/usb-a9g20-lpw.dox
deleted file mode 100644
index 024a3ce..0000000
diff --git a/arch/arm/boards/virt2real/virt2real.dox b/arch/arm/boards/virt2real/virt2real.dox
deleted file mode 100644
index fc38321..0000000
diff --git a/arch/arm/mach-arm.dox b/arch/arm/mach-arm.dox
deleted file mode 100644
index 1d2de48..0000000
diff --git a/arch/arm/mach-davinci/mach-davinci.dox b/arch/arm/mach-davinci/mach-davinci.dox
deleted file mode 100644
index 789eacc..0000000
diff --git a/arch/arm/mach-omap/arch-omap.dox b/arch/arm/mach-omap/arch-omap.dox
deleted file mode 100644
index 8c2b47d..0000000
diff --git a/arch/arm/mach-samsung/lowlevel-s3c24x0.S b/arch/arm/mach-samsung/lowlevel-s3c24x0.S
index e2efd86..52079ff 100644
--- a/arch/arm/mach-samsung/lowlevel-s3c24x0.S
+++ b/arch/arm/mach-samsung/lowlevel-s3c24x0.S
@@ -31,14 +31,6 @@ s3c24x0_disable_wd:
str r1, [r0]
mov pc, lr
-/**
-@page dev_s3c24xx_wd_handling Watchdog handling
-
-The watchdog must be disabled very early, because if it resets the system
-it is still active and will continue to reset the system. So, call this
-routine very early in your board_init_lowlevel routine.
-*/
-
/*
* S3C2410 PLL configuration
* -------------------------
diff --git a/arch/arm/mach-samsung/mem-s3c24x0.c b/arch/arm/mach-samsung/mem-s3c24x0.c
index d40db14..db61c63 100644
--- a/arch/arm/mach-samsung/mem-s3c24x0.c
+++ b/arch/arm/mach-samsung/mem-s3c24x0.c
@@ -80,60 +80,3 @@ void s3c24xx_disable_second_sdram_bank(void)
writel(readl(S3C_BANKCON7) & ~(0x3 << 15), S3C_BANKCON7);
writel(readl(S3C_MISCCR) | (1 << 18), S3C_MISCCR); /* disable its clock */
}
-
-/**
-
-@page dev_s3c24xx_arch Samsung's S3C24xx Platforms in barebox
-
-@section s3c24xx_boards Boards using S3C24xx Processors
-
-@li @subpage arch/arm/boards/a9m2410/a9m2410.c
-@li @subpage arch/arm/boards/a9m2440/a9m2440.c
-
-@section s3c24xx_arch Documentation for S3C24xx Architectures Files
-
-@li @subpage arch/arm/mach-s3c24xx/generic.c
-
-@section s3c24xx_mem_map SDRAM Memory Map
-
-SDRAM starts at address 0x3000.0000 up to the available amount of connected
-SDRAM memory. Physically this CPU can handle up to 256MiB (two areas with
-up to 128MiB each).
-
-@subsection s3c24xx_mem_generic_map Generic Map
-- 0x0000.0000 Start of the internal SRAM when booting from NAND flash memory or CS signal to a NOR flash memory.
-- 0x0800.0000 Start of I/O space.
-- 0x3000.0000 Start of SDRAM area.
- - 0x3000.0100 Start of the TAG list area.
- - 0x3000.8000 Start of the linux kernel (physical address).
-- 0x4000.0000 Start of internal SRAM, when booting from NOR flash memory
-- 0x4800.0000 Start of the internal I/O area
-
-@section s3c24xx_asm_arm include/asm-arm/arch-s3c24xx directory guidelines
-All S3C24xx common headers are located here.
-
-@note Do not add board specific header files/information here.
-*/
-
-/** @page dev_s3c24xx_mach Samsung's S3C24xx based platforms
-
-@par barebox Map
-
-The location of the @a barebox itself depends on the available amount of
-installed SDRAM memory:
-
-- 0x30fc.0000 Start of @a barebox when 16MiB SDRAM is available
-- 0x31fc.0000 Start of @a barebox when 32MiB SDRAM is available
-- 0x33fc.0000 Start of @a barebox when 64MiB SDRAM is available
-
-Adjust the @p CONFIG_TEXT_BASE/CONFIG_ARCH_TEXT_BASE symbol in accordance to
-the available memory.
-
-@note The RAM based filesystem and the stack resides always below the
-@a barebox start address.
-
-@li @subpage dev_s3c24xx_wd_handling
-@li @subpage dev_s3c24xx_pll_handling
-@li @subpage dev_s3c24xx_sdram_handling
-@li @subpage dev_s3c24xx_nandboot_handling
-*/
diff --git a/arch/blackfin/boards/ipe337/ipe337.dox b/arch/blackfin/boards/ipe337/ipe337.dox
deleted file mode 100644
index 4d7925a..0000000
diff --git a/arch/blackfin/mach-bf.dox b/arch/blackfin/mach-bf.dox
deleted file mode 100644
index 4b3a3c1..0000000
diff --git a/arch/mips/boards/dlink-dir-320/dlink-dir-320.dox b/arch/mips/boards/dlink-dir-320/dlink-dir-320.dox
deleted file mode 100644
index d0f5869..0000000
diff --git a/arch/mips/boards/loongson-ls1b/loongson_ls1b.dox b/arch/mips/boards/loongson-ls1b/loongson_ls1b.dox
deleted file mode 100644
index f96a3f8..0000000
diff --git a/arch/mips/boards/qemu-malta/qemu-malta.dox b/arch/mips/boards/qemu-malta/qemu-malta.dox
deleted file mode 100644
index bf10244..0000000
diff --git a/arch/mips/boards/ritmix-rzx50/ritmix-rzx50.dox b/arch/mips/boards/ritmix-rzx50/ritmix-rzx50.dox
deleted file mode 100644
index 5ec8194..0000000
diff --git a/arch/mips/boards/tplink-mr3020/tplink-mr3020.dox b/arch/mips/boards/tplink-mr3020/tplink-mr3020.dox
deleted file mode 100644
index 16fe465..0000000
diff --git a/arch/mips/mach-bcm47xx/mach-bcm47xx.dox b/arch/mips/mach-bcm47xx/mach-bcm47xx.dox
deleted file mode 100644
index 04ccf03..0000000
diff --git a/arch/mips/mach-loongson/mach-loongson.dox b/arch/mips/mach-loongson/mach-loongson.dox
deleted file mode 100644
index 7838ce5..0000000
diff --git a/arch/mips/mach-malta/mach-malta.dox b/arch/mips/mach-malta/mach-malta.dox
deleted file mode 100644
index 85351e1..0000000
diff --git a/arch/mips/mach-mips.dox b/arch/mips/mach-mips.dox
deleted file mode 100644
index 1002b16..0000000
diff --git a/arch/mips/mach-xburst/mach-xburst.dox b/arch/mips/mach-xburst/mach-xburst.dox
deleted file mode 100644
index 052c05e..0000000
diff --git a/arch/ppc/boards/pcm030/pcm030.dox b/arch/ppc/boards/pcm030/pcm030.dox
deleted file mode 100644
index b9ada83..0000000
diff --git a/arch/ppc/mach-ppc.dox b/arch/ppc/mach-ppc.dox
deleted file mode 100644
index f7191b9..0000000
diff --git a/arch/sandbox/os/common.c b/arch/sandbox/os/common.c
index 36c8d62..4123938 100644
--- a/arch/sandbox/os/common.c
+++ b/arch/sandbox/os/common.c
@@ -18,10 +18,6 @@
*
*/
-/**
- * @file
- * @brief Common wrapper functions between barebox and the host
- */
/*
* These are host includes. Never include any barebox header
* files here...
@@ -421,54 +417,3 @@ static void print_usage(const char *prgname)
prgname
);
}
-
-/**
- * @page barebox_simul barebox Simulator
- *
- * barebox can be run as a simulator on your host to check and debug new non
- * hardware related features.
- *
- * @section simu_build How to build barebox for simulation
- *
- * @section simu_run How to run barebox simulator
- *
- * $ barebox [\<OPTIONS\>]
- *
- * Options can be:
- *
- * -m, --malloc=\<size\>
- *
- * Start sandbox with a specified malloc-space \<size\> in bytes.
- *
- * -i \<file\>
- *
- * Map a \<file\> to barebox. This option can be given multiple times. The \<file\>s
- * will show up as /dev/fd0 ... /dev/fdx in the barebox simulator.
- *
- * -e \<file\>
- *
- * Map \<file\> to barebox. With this option \<file\>s are mapped as /dev/env0 ...
- * /dev/envx and thus are used as default environment. A clean file generated
- * with dd will do to get started with an empty environment
- *
- * -O \<file\>
- *
- * Register \<file\> as a console capable of doing stdout. \<file\> can be a
- * regular file or a fifo.
- *
- * -I \<file\>
- *
- * Register \<file\> as a console capable of doing stdin. \<file\> can be a regular
- * file or a fifo.
- *
- * -x, --xres \<res\>
- *
- * Specify SDL width
- *
- * -y, --yres \<res\>
- *
- * Specify SDL height
- *
- * @section simu_dbg How to debug barebox simulator
- *
- */
diff --git a/arch/x86/boards/x86_generic/generic_pc.c b/arch/x86/boards/x86_generic/generic_pc.c
index 5560efc..482889f 100644
--- a/arch/x86/boards/x86_generic/generic_pc.c
+++ b/arch/x86/boards/x86_generic/generic_pc.c
@@ -14,11 +14,6 @@
*
*/
-/**
- * @file
- * @brief Generic PC support to let barebox acting as a boot loader
- */
-
#include <common.h>
#include <types.h>
#include <driver.h>
@@ -34,32 +29,3 @@ static int devices_init(void)
return 0;
}
device_initcall(devices_init);
-
-/** @page generic_pc Generic PC based bootloader
-
-This platform acts as a generic PC based bootloader. It depends on at least
-one boot media that is connected locally (no network boot) and can be
-handled by the regular BIOS (any kind of hard disks for example).
-
-The created @a barebox image can be used to boot a standard x86 bzImage
-Linux kernel.
-
-Refer section @ref x86_bootloader_preparations how to do so.
-
-How to get the binary image:
-
-Using the default configuration:
-
-@code
-make ARCH=x86 generic_defconfig
-@endcode
-
-Build the binary image:
-
-@code
-make ARCH=x86 CROSS_COMPILE=x86compiler
-@endcode
-
-@note replace the 'x86compiler' with your x86 (cross) compiler.
-
-*/
diff --git a/arch/x86/boot/bioscall.S b/arch/x86/boot/bioscall.S
index 84d2577..e600729 100644
--- a/arch/x86/boot/bioscall.S
+++ b/arch/x86/boot/bioscall.S
@@ -13,8 +13,6 @@
* touching registers they shouldn't be.
*/
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
.file "bioscall.S"
.code16
.section .boot.text.intcall, "ax"
@@ -95,5 +93,3 @@ die:
hlt
jmp die
.size die, .-die
-
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
diff --git a/arch/x86/lib/bios_disk.S b/arch/x86/lib/bios_disk.S
index 121f440..cce33e6 100644
--- a/arch/x86/lib/bios_disk.S
+++ b/arch/x86/lib/bios_disk.S
@@ -26,7 +26,6 @@
* space below 0x10000
*/
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
/*
* int bios_disk_rw_int13_extensions (int ah, int drive, void *dap)
*
@@ -69,5 +68,3 @@ bios_disk_rw_int13_extensions:
popl %ebp
ret
-
-#endif
diff --git a/arch/x86/lib/linux_start.S b/arch/x86/lib/linux_start.S
index f74e4e9..b9489b8 100644
--- a/arch/x86/lib/linux_start.S
+++ b/arch/x86/lib/linux_start.S
@@ -30,7 +30,6 @@
* void bios_start_linux(unsigned segment)
*
*/
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
.section .boot.text.bios_start_linux, "ax"
.code32
@@ -67,5 +66,3 @@ setup_seg:
.word 0
.code32
-
-#endif
diff --git a/arch/x86/mach-x86.dox b/arch/x86/mach-x86.dox
deleted file mode 100644
index 661e905..0000000
diff --git a/commands/bootm.c b/commands/bootm.c
index d6625df..617acd6 100644
--- a/commands/bootm.c
+++ b/commands/bootm.c
@@ -194,20 +194,3 @@ static int binfmt_uimage_init(void)
return binfmt_register(&binfmt_uimage_hook);
}
fs_initcall(binfmt_uimage_init);
-
-/**
- * @file
- * @brief Boot support for Linux
- */
-
-/**
- * @page boot_preparation Preparing for Boot
- *
- * This chapter describes what's to be done to forward the control from
- * barebox to Linux. This part describes the generic part, below you can find
- * the architecture specific part.
- *
- * - @subpage arm_boot_preparation
- * - @subpage ppc_boot_preparation
- * - @subpage x86_boot_preparation
- */
diff --git a/commands/cp.c b/commands/cp.c
index 8ecde91..1a56754 100644
--- a/commands/cp.c
+++ b/commands/cp.c
@@ -17,10 +17,6 @@
*
*/
-/**
- * @file
- * @brief cp: copy file command
- */
#include <common.h>
#include <command.h>
#include <xfuncs.h>
@@ -95,15 +91,6 @@ BAREBOX_CMD_HELP_TEXT("Options:")
BAREBOX_CMD_HELP_OPT ("-v", "verbose")
BAREBOX_CMD_HELP_END
-/**
- * @page cp_command
-This command operates on files.
-
-If you want to copy between memory blocks, use 'memcpy'.
-
-\todo What does this mean? Add examples.
- */
-
BAREBOX_CMD_START(cp)
.cmd = do_cp,
BAREBOX_CMD_DESC("copy files")
@@ -111,4 +98,3 @@ BAREBOX_CMD_START(cp)
BAREBOX_CMD_GROUP(CMD_GRP_FILE)
BAREBOX_CMD_HELP(cmd_cp_help)
BAREBOX_CMD_END
-
diff --git a/commands/devinfo.c b/commands/devinfo.c
index 052a4a0..e61aaa2 100644
--- a/commands/devinfo.c
+++ b/commands/devinfo.c
@@ -118,34 +118,6 @@ static int do_devinfo(int argc, char *argv[])
return 0;
}
-
-/**
- * @page devinfo_command
-
-If called without arguments, devinfo shows a summary of the known
-devices and drivers.
-
-If called with a device path being the argument, devinfo shows more
-default information about this device and its parameters.
-
-Example from an MPC5200 based system:
-
-@verbatim
- barebox:/ devinfo /dev/eth0
- base : 0x1002b000
- size : 0x00000000
- driver: fec_mpc5xxx
-
- no info available for eth0
- Parameters:
- ipaddr = 192.168.23.197
- ethaddr = 80:81:82:83:84:86
- gateway = 192.168.23.1
- netmask = 255.255.255.0
- serverip = 192.168.23.2
-@endverbatim
- */
-
BAREBOX_CMD_HELP_START(devinfo)
BAREBOX_CMD_HELP_TEXT("If called without arguments, devinfo shows a summary of the known")
BAREBOX_CMD_HELP_TEXT("devices.")
diff --git a/commands/dfu.c b/commands/dfu.c
index b71cc16..3546252 100644
--- a/commands/dfu.c
+++ b/commands/dfu.c
@@ -186,16 +186,6 @@ BAREBOX_CMD_HELP_OPT ("-V ID", "vendor id")
BAREBOX_CMD_HELP_OPT ("-P ID", "product id")
BAREBOX_CMD_HELP_END
-/**
- * @page dfu_command
-\<description> has the following form:
-device1(name1)[sr],device2(name2)[sr]
-'s' means 'safe mode' (download the complete image before flashing) and
-'r' that readback of the firmware is allowed.
-
-\todo Add example, how to use dfu from a Linux or Windows host.
- */
-
BAREBOX_CMD_START(dfu)
.cmd = do_dfu,
BAREBOX_CMD_DESC("device firmware update")
diff --git a/commands/echo.c b/commands/echo.c
index 9b3e21e..7d47ab7 100644
--- a/commands/echo.c
+++ b/commands/echo.c
@@ -113,13 +113,6 @@ BAREBOX_CMD_HELP_OPT ("-a FILE", "append to FILE instead of using stdout")
BAREBOX_CMD_HELP_OPT ("-o FILE", "overwrite FILE instead of using stdout")
BAREBOX_CMD_HELP_END
-/**
- * @page echo_command
-
-\todo Add documentation for -a, -o and -e.
-
- */
-
BAREBOX_CMD_START(echo)
.cmd = do_echo,
BAREBOX_CMD_DESC("echo args to console")
@@ -127,4 +120,3 @@ BAREBOX_CMD_START(echo)
BAREBOX_CMD_GROUP(CMD_GRP_CONSOLE)
BAREBOX_CMD_HELP(cmd_echo_help)
BAREBOX_CMD_END
-
diff --git a/commands/edit.c b/commands/edit.c
index f6b9d40..5a2da7d 100644
--- a/commands/edit.c
+++ b/commands/edit.c
@@ -15,11 +15,6 @@
*
*/
-/**
- * @file
- * @brief A tiny editor implementation
- */
-
#include <common.h>
#include <command.h>
#include <malloc.h>
@@ -550,16 +545,6 @@ BAREBOX_CMD_HELP_START(edit)
BAREBOX_CMD_HELP_TEXT("Use cursor keys, Ctrl-C to exit and Ctrl-D to exit-with-save.")
BAREBOX_CMD_HELP_END
-/**
- * @page edit_command
-
-<p> Barebox contains a small text editor which can be used to edit
-config files in /env. You can move the cursor around with the arrow keys
-and type characters. </p>
-
-If called as sedit, the editor uses ansi codes to scroll the screen.
- */
-
BAREBOX_CMD_START(edit)
.cmd = do_edit,
.aliases = edit_aliases,
@@ -568,4 +553,3 @@ BAREBOX_CMD_START(edit)
BAREBOX_CMD_GROUP(CMD_GRP_CONSOLE)
BAREBOX_CMD_HELP(cmd_edit_help)
BAREBOX_CMD_END
-
diff --git a/commands/flash.c b/commands/flash.c
index b50a327..99d3cb7 100644
--- a/commands/flash.c
+++ b/commands/flash.c
@@ -19,11 +19,6 @@
*
*/
-/**
- * @file
- * @brief Flash memory support: erase, protect, unprotect
- */
-
#include <common.h>
#include <command.h>
#include <errno.h>
@@ -92,20 +87,6 @@ BAREBOX_CMD_START(erase)
BAREBOX_CMD_HELP(cmd_erase_help)
BAREBOX_CMD_END
-/**
- * @page erase_command
-
-<p> Erase the flash memory handled by this device. Which area will be
-erased depends on the device: If the device represents the whole flash
-memory, the whole memory will be erased. If the device represents a
-partition on a main flash memory, only this partition part will be
-erased. </p>
-
-Refer to \ref addpart_command, \ref delpart_command and \ref
-devinfo_command for partition handling.
-
- */
-
static int do_protect(int argc, char *argv[])
{
int fd;
@@ -173,23 +154,6 @@ BAREBOX_CMD_START(protect)
BAREBOX_CMD_HELP(cmd_protect_help)
BAREBOX_CMD_END
-/**
- * @page protect_command
-
-
-If the device represents the whole
-flash memory the whole memory will be protected. If the device
-represents a partition on a main flash memory, only this partition part
-will be protected.
-
-Refer addpart_command, delpart_command and devinfo_command for partition
-handling.
-
-\todo Rework this documentation, what is an 'area'? Explain more about
-flashes here.
-
- */
-
BAREBOX_CMD_HELP_START(unprotect)
BAREBOX_CMD_HELP_TEXT("Unprotect the flash memory behind the device. It depends on the device")
BAREBOX_CMD_HELP_TEXT("given, what area will be unprotected. If the device represents the whole")
@@ -205,19 +169,3 @@ BAREBOX_CMD_START(unprotect)
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_HELP(cmd_unprotect_help)
BAREBOX_CMD_END
-
-/**
- * @page unprotect_command
-
-It depends on the device given,
-what area will be unprotected. If the device represents the whole flash memory
-the whole memory will be unprotected. If the device represents a partition
-on a main flash memory, only this partition part will be unprotected.
-
-Refer addpart_command, delpart_command and devinfo_command for partition
-handling.
-
-\todo Rework this documentation, what does it mean?
-
- */
-
diff --git a/commands/gpio.c b/commands/gpio.c
index 4f2d93e..08ecc15 100644
--- a/commands/gpio.c
+++ b/commands/gpio.c
@@ -107,65 +107,3 @@ BAREBOX_CMD_START(gpio_direction_output)
BAREBOX_CMD_OPTS("GPIO VALUE")
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
BAREBOX_CMD_END
-
-/**
- * @page gpio_for_users GPIO Handling
-
-@section regular_gpio General usage information
-
-These commands are available if the symbol @b CONFIG_GENERIC_GPIO and @b
-CONFIG_CMD_GPIO are enabled in Kconfig.
-
-@note All gpio related commands take a number to identify the pad. This
-number is architecture dependent and may not directly correlate with the
-pad numbers. Due to this, it is also possible that the numbers changes
-between @b barebox releases.
-
-@section gpio_dir_out Use Pad as GPIO Output
-@verbatim
-# gpio_direction_output <gpio_no> <initial_value>
-@endverbatim
-- gpio_no: Architecture dependend GPIO number
-- initial_value: Output value
-
-<p> To avoid glitches on the pad the routines will first set up the
-pad's value and afterwards switch the pad to output (if the silicon is
-able to do so). If the pad is already configured in non-GPIO mode (if
-available), this command may silently fail. </p>
-
-@section gpio_dir_in Use Pad as GPIO Input
-@verbatim
-# gpio_direction_input <gpio_no>
-@endverbatim
-- gpio_no: Architecture dependent GPIO number
-
-<p> If the pad is already configured in non-GPIO mode (if available),
-this command may silently fail. </p>
-
-@section gpio_get_value Read Input Value from GPIO Pin
-@verbatim
-# gpio_get_value <gpio_no>
-@endverbatim
-
-<p> Reads the current value of a GPIO pin and return the value as a
-shell return code. There is no visible output on stdout. You can check
-the return value by using "echo $?". </p>
-
-<p> A return code other than '0' or '1' specifies an error code. </p>
-
-<p> If the pad is not configured in GPIO mode, this command may silently
-fail and return garbage. </p>
-
-@section gpio_set_value Set Output Value on GPIO Pin
-@verbatim
-# gpio_set_value <gpio_no> <value>
-@endverbatim
-- gpio_no: Architecture dependent GPIO number
-- value: Output value
-
-<p> Set a new output value on pad with GPIO number \<gpio_no>. </p>
-
-<p> If the pad is not configured in GPIO-mode, this command may silently
-fail. </p>
-
-*/
diff --git a/commands/led.c b/commands/led.c
index 62c72a3..354f74d 100644
--- a/commands/led.c
+++ b/commands/led.c
@@ -70,15 +70,6 @@ static int do_led(int argc, char *argv[])
return 0;
}
-/**
- * @page led_command
-
-The exact meaning of <value> is unspecified. It can be a color in case of rgb
-LEDs or a brightness if this is controllable. In most cases only 1 for enabled
-is allowed.
-
-*/
-
BAREBOX_CMD_HELP_START(led)
BAREBOX_CMD_HELP_TEXT("Control the value of a LED. The exact meaning of VALUE is unspecified,")
BAREBOX_CMD_HELP_TEXT("it can be a brightness, or a color. Most often a value of '1' means on")
diff --git a/commands/linux16.c b/commands/linux16.c
index 65814f4..594efc7 100644
--- a/commands/linux16.c
+++ b/commands/linux16.c
@@ -330,18 +330,6 @@ BAREBOX_CMD_HELP_TEXT("Options:")
BAREBOX_CMD_HELP_OPT ("-v VESAMODE", "set VESAMODE")
BAREBOX_CMD_HELP_END
-/**
- * @page linux16_command
-
-<p>Only kernel images in bzImage format are supported by now. See \ref
-x86_boot_preparation for more info about how to use this command.</p>
-
-<p>For the video mode refer the Linux kernel documentation
-'Documentation/fb/vesafb.txt' for correct VESA mode numbers. If the keyword
-'ask' instead of a number is given, the starting kernel will ask for a number.
-</p>
- */
-
BAREBOX_CMD_START(linux16)
.cmd = do_linux16,
BAREBOX_CMD_DESC("boot a linux kernel on x86 via real-mode code")
@@ -349,57 +337,3 @@ BAREBOX_CMD_START(linux16)
BAREBOX_CMD_GROUP(CMD_GRP_BOOT)
BAREBOX_CMD_HELP(cmd_linux16_help)
BAREBOX_CMD_END
-
-/**
- * @file
- * @brief Boot support for Linux on x86
- */
-
-/**
- * @page x86_boot_preparation Linux Preparation on x86
- *
- * Due to some real mode constraints, starting Linux is somehow tricky.
- * Currently only @p bzImages are supported, because @p zImages would
- * interfere with the @a barebox runtime.
- * Also older load header versions than 2.00 aren't supported.
- *
- * The memory layout immediately before starting the Linux kernel:
- *
-@verbatim
- real mode space hole extended memory
- |---------------------------------------------->|----------->|------------------------------>
- 0 0x7e00 0x90000 0xa0000 0x100000
- <-1-|----------2-----------><-3- |
- <-4--|-5--> |---------6------------->
-@endverbatim
- *
- * @li 1 = @a barebox's real mode stack
- * @li 2 = @a barebox's code
- * @li 3 = @a barebox's flat mode stack
- * @li 4 = real mode stack, when starting the Linux kernel
- * @li 5 = Kernel's real mode setup code
- * @li 6 = compressed kernel image
- *
- * A more detailed memory layout for kernel's real mode setup code
- *
-@verbatim
-
- 0x90000 0x97fff 0x99000 0x990ff
- ---|------------------------------------------|----------------|--------------------|
- |<-------- max setup code size ----------->|<--heap/stack-->|<-- command line -->|
-
-@endverbatim
- *
- * The regular entry point into the setup code is 0x90200 (2nd sector)
- *
- * To start the kernel, it's own setup code will be called. To do so, it
- * must be called in real mode. So, @a barebox switches back to real mode
- * a last time and does a jump to the setup code entry point. Now its up to
- * the setup code to deflate the kernel, switching to its own protected mode
- * setup and starting the kernel itself.
- *
- * @note This scenario only works, if a BIOS is still present. In this case
- * there is no need for @a barebox to forward any system related information
- * to the kernel. Everything is detected by kernel's setup code.
- *
- */
diff --git a/commands/loadenv.c b/commands/loadenv.c
index ba92613..8b15af4 100644
--- a/commands/loadenv.c
+++ b/commands/loadenv.c
@@ -112,15 +112,6 @@ BAREBOX_CMD_HELP_OPT("-s", "scrub old environment")
BAREBOX_CMD_HELP_OPT("-d", "load default environment")
BAREBOX_CMD_HELP_END
-/**
- * @page loadenv_command
-
-ENVFS can only handle files, directories are skipped silently.
-
-\todo This needs proper documentation. What is ENVFS, why is it FS etc. Explain the concepts.
-
- */
-
BAREBOX_CMD_START(loadenv)
.cmd = do_loadenv,
BAREBOX_CMD_DESC("load environment from ENVFS")
diff --git a/commands/miitool.c b/commands/miitool.c
index b08be9c..40e34e9 100644
--- a/commands/miitool.c
+++ b/commands/miitool.c
@@ -293,12 +293,6 @@ BAREBOX_CMD_HELP_TEXT("Options:")
BAREBOX_CMD_HELP_OPT("-v", "increase verbosity")
BAREBOX_CMD_HELP_END
-/**
- * @page miitool_command
-This utility checks or sets the status of a network interface's
-Media Independent Interface (MII) unit. Most fast ethernet
-adapters use an MII to autonegotiate link speed and duplex setting.
- */
BAREBOX_CMD_START(miitool)
.cmd = do_miitool,
BAREBOX_CMD_DESC("view media-independent interface status")
diff --git a/commands/mount.c b/commands/mount.c
index 7aa155e..939e9bc 100644
--- a/commands/mount.c
+++ b/commands/mount.c
@@ -17,11 +17,6 @@
*
*/
-/**
- * @file
- * @brief Filesystem mounting support
- */
-
#include <common.h>
#include <command.h>
#include <fs.h>
@@ -130,37 +125,6 @@ BAREBOX_CMD_HELP_OPT("-o OPTIONS", "set file system OPTIONS")
BAREBOX_CMD_HELP_OPT("-v\t", "verbose")
BAREBOX_CMD_HELP_END
-/**
- * @page mount_command
-
-<ul>
-<li>\<device> can be a device in /dev or some arbitrary string if no
- device is needed for this driver, i.e. on ramfs. </li>
-<li>\<fstype> is the filesystem driver. A list of available drivers can
- be shown with the \ref devinfo_command command.</li>
-<li>\<mountpoint> must be an empty directory, one level below the /
- directory.</li>
-</ul>
-
- */
-
-/**
- * @page how_mount_works How mount works in barebox
-
-Mounting a filesystem ontop of a device is working like devices and
-drivers are finding together.
-
-The mount command creates a new device with the filesystem name as the
-driver for this "device". So the framework is able to merge both parts
-together.
-
-By the way: With this feature its impossible to accidentely remove
-partitions in use. A partition is internally also a device. If its
-mounted it will be marked as busy, so an delpart command fails, until
-the filesystem has been unmounted.
-
- */
-
BAREBOX_CMD_START(mount)
.cmd = do_mount,
BAREBOX_CMD_DESC("mount a filesystem or list mounted filesystems")
diff --git a/commands/partition.c b/commands/partition.c
index 51988df..ef6d9c9 100644
--- a/commands/partition.c
+++ b/commands/partition.c
@@ -180,18 +180,6 @@ BAREBOX_CMD_HELP_TEXT("The size of the last partition can be specified as '-' fo
BAREBOX_CMD_HELP_TEXT("space on the device.")
BAREBOX_CMD_HELP_END
-/**
- * @page addpart_command
-
-The size and the offset can be given in decimal (without any prefix) and
-in hex (prefixed with 0x). Both can have an optional suffix K, M or G.
-The size of the last partition can be specified as '-' for the remaining
-space on the device. This format is the same as used by the Linux
-kernel or cmdline mtd partitions.
-
-\todo This command has to be reworked and will probably change it's API.
-*/
-
BAREBOX_CMD_START(addpart)
.cmd = do_addpart,
BAREBOX_CMD_DESC("add a partition description to a device")
@@ -219,17 +207,6 @@ BAREBOX_CMD_HELP_START(delpart)
BAREBOX_CMD_HELP_TEXT("Delete partitions previously added to a device with addpart.")
BAREBOX_CMD_HELP_END
-/**
- * @page delpart_command
-
-Partitions are created by adding their description with the addpart
-command. If you want to get rid of a partition again, use delpart. The
-argument list is taken as a list of partitions to be deleted.
-
-\todo Add an example
-
- */
-
BAREBOX_CMD_START(delpart)
.cmd = do_delpart,
BAREBOX_CMD_DESC("delete partition(s)")
@@ -238,4 +215,3 @@ BAREBOX_CMD_START(delpart)
BAREBOX_CMD_HELP(cmd_delpart_help)
BAREBOX_CMD_COMPLETE(devfs_partition_complete)
BAREBOX_CMD_END
-
diff --git a/commands/printenv.c b/commands/printenv.c
index 83353ae..161c214 100644
--- a/commands/printenv.c
+++ b/commands/printenv.c
@@ -15,11 +15,6 @@
*
*/
-/**
- * @file
- * @brief printenv: Print out environment variables
- */
-
#include <common.h>
#include <command.h>
#include <errno.h>
@@ -62,15 +57,6 @@ BAREBOX_CMD_HELP_TEXT("variable to the terminal. If no argument is specified, al
BAREBOX_CMD_HELP_TEXT("printed.")
BAREBOX_CMD_HELP_END
-/**
- * @page printenv_command
-
-<p>If an argument is given, printenv prints the content of an environment
-variable to the terminal. If no argument is specified, all variables are
-printed.</p>
-
- */
-
BAREBOX_CMD_START(printenv)
.cmd = do_printenv,
BAREBOX_CMD_DESC("print value of environment variables")
diff --git a/commands/saveenv.c b/commands/saveenv.c
index d629a94..54b6fa1 100644
--- a/commands/saveenv.c
+++ b/commands/saveenv.c
@@ -15,11 +15,6 @@
*
*/
-/**
- * @file
- * @brief saveenv: Make the environment persistent
- */
-
#include <common.h>
#include <command.h>
#include <errno.h>
@@ -64,16 +59,3 @@ BAREBOX_CMD_START(saveenv)
BAREBOX_CMD_GROUP(CMD_GRP_ENV)
BAREBOX_CMD_HELP(cmd_saveenv_help)
BAREBOX_CMD_END
-
-/**
- * @page saveenv_command
-
-<p>\<envfs> is usually a block in flash but can be any other file. If
-omitted, \<directory> defaults to /env and \<envfs> defaults to
-/dev/env0. Note that envfs can only handle files, directories are being
-skipped silently.</p>
-
-\todo What does 'block in flash' mean? Add example.
-
- */
-
diff --git a/commands/setenv.c b/commands/setenv.c
index 9e21cce..af4dd29 100644
--- a/commands/setenv.c
+++ b/commands/setenv.c
@@ -15,11 +15,6 @@
*
*/
-/**
- * @file
- * @brief setenv: Set an environment variables
- */
-
#include <common.h>
#include <command.h>
#include <errno.h>
@@ -40,14 +35,6 @@ BAREBOX_CMD_HELP_TEXT("Set environment variable NAME to VALUE.")
BAREBOX_CMD_HELP_TEXT("If VALUE is ommitted, then the variable is deleted.")
BAREBOX_CMD_HELP_END
-/**
- * @page setenv_command
-
-<p> This command is only available if the simple command line parser is
-in use. Within the hush shell, \c setenv is not required.</p>
-
- */
-
BAREBOX_CMD_START(setenv)
.cmd = do_setenv,
BAREBOX_CMD_DESC("set environment variable")
diff --git a/commands/splash.c b/commands/splash.c
index c61a1d7..5d0c0ad 100644
--- a/commands/splash.c
+++ b/commands/splash.c
@@ -89,17 +89,6 @@ BAREBOX_CMD_HELP_OPT ("-b COLOR", "background color in 0xttrrggbb")
BAREBOX_CMD_HELP_OPT ("-o\t", "render offscreen")
BAREBOX_CMD_HELP_END
-/**
- * @page bmp_command
-
-This command displays a graphics in the bitmap (.bmp) format on the
-framebuffer. Currently the bmp command supports images with 8 and 24 bit
-color depth.
-
-\todo What does the -o (offscreen) option do?
-
- */
-
BAREBOX_CMD_START(splash)
.cmd = do_splash,
BAREBOX_CMD_DESC("display a BMP image")
diff --git a/commands/usbserial.c b/commands/usbserial.c
index 1c26246..e4c2f18 100644
--- a/commands/usbserial.c
+++ b/commands/usbserial.c
@@ -92,10 +92,6 @@ BAREBOX_CMD_HELP_OPT ("-s", "Generic Serial")
BAREBOX_CMD_HELP_OPT ("-d", "Disable the serial gadget")
BAREBOX_CMD_HELP_END
-/**
- * @page usbserial_command
- */
-
BAREBOX_CMD_START(usbserial)
.cmd = do_usbserial,
BAREBOX_CMD_DESC("serial gadget enable/disable")
diff --git a/common/kallsyms.c b/common/kallsyms.c
index 121b77c..53e22cd 100644
--- a/common/kallsyms.c
+++ b/common/kallsyms.c
@@ -3,8 +3,6 @@
#include <kallsyms.h>
#include <asm/sections.h>
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
/* These will be re-linked against their real values during the second link stage */
extern const unsigned long kallsyms_addresses[] __attribute__((weak));
extern const unsigned long kallsyms_num_syms __attribute__((weak));
@@ -15,8 +13,6 @@ extern const u16 kallsyms_token_index[] __attribute__((weak));
extern const unsigned long kallsyms_markers[] __attribute__((weak));
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
static inline int is_kernel_text(unsigned long addr)
{
if ((addr >= (unsigned long)_stext && addr <= (unsigned long)_etext))
diff --git a/include/command.h b/include/command.h
index 347ad2f..5d5bf53 100644
--- a/include/command.h
+++ b/include/command.h
@@ -90,8 +90,6 @@ void barebox_cmd_usage(struct command *cmdtp);
#endif /* __ASSEMBLY__ */
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#define Struct_Section __attribute__ ((unused,section (".barebox_cmd")))
#define BAREBOX_CMD_START(_name) \
@@ -127,8 +125,6 @@ static const __maybe_unused char cmd_##_name##_help[] =
#define BAREBOX_CMD_OPTS(text) .opts = text,
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
int register_command(struct command *);
#endif /* __COMMAND_H */
diff --git a/include/driver.h b/include/driver.h
index ffc0cba..53e1000 100644
--- a/include/driver.h
+++ b/include/driver.h
@@ -28,32 +28,6 @@
#include <param.h>
-/**
- * @file
- * @brief Main description of the device/driver model
- */
-
-/** @page driver_model Main description of the device/driver model
- *
- * We follow a rather simplistic driver model here. There is a
- * @code struct device_d @endcode
- * which describes a particular device present in the system.
- *
- * On the other side a
- * @code struct driver_d @endcode
- * represents a driver present in the system.
- *
- * Both structs find together via the members 'type' (int) and 'name' (char *).
- * If both members match, the driver's probe function is called with the
- * struct device_d as argument.
- *
- * People familiar with the Linux platform bus will recognize this behaviour
- * and in fact many things were stolen from there. Some selected members of the
- * structs will be described in this document.
- */
-
-/*@{*/ /* do not delete, doxygen relevant */
-
struct filep;
struct bus_type;
diff --git a/include/i2c/i2c.h b/include/i2c/i2c.h
index f89fefb..a107f5e 100644
--- a/include/i2c/i2c.h
+++ b/include/i2c/i2c.h
@@ -19,8 +19,6 @@
#include <driver.h>
#include <linux/types.h>
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
/*
* struct i2c_platform_data - structure of platform data for MXC I2C driver
* @param bitrate Bus speed measured in Hz
@@ -153,8 +151,6 @@ extern int i2c_master_recv(struct i2c_client *client, char *buf, int count);
extern int i2c_read_reg(struct i2c_client *client, u32 addr, u8 *buf, u16 count);
extern int i2c_write_reg(struct i2c_client *client, u32 addr, const u8 *buf, u16 count);
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
extern struct bus_type i2c_bus;
static inline int i2c_driver_register(struct driver_d *drv)
diff --git a/include/linux/mtd/mtd-abi.h b/include/linux/mtd/mtd-abi.h
index c1ba55b..c46605d 100644
--- a/include/linux/mtd/mtd-abi.h
+++ b/include/linux/mtd/mtd-abi.h
@@ -7,8 +7,6 @@
#ifndef __MTD_ABI_H__
#define __MTD_ABI_H__
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include <asm-generic/div64.h>
struct erase_info_user {
@@ -183,6 +181,4 @@ static inline uint32_t mtd_user_div_by_eb(uint64_t sz,
return sz;
}
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
#endif /* __MTD_ABI_H__ */
diff --git a/include/linux/mtd/mtd.h b/include/linux/mtd/mtd.h
index 5f02aee..1d33592 100644
--- a/include/linux/mtd/mtd.h
+++ b/include/linux/mtd/mtd.h
@@ -9,8 +9,6 @@
#ifndef __MTD_MTD_H__
#define __MTD_MTD_H__
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include <driver.h>
#include <errno.h>
#include <linux/types.h>
@@ -325,8 +323,6 @@ int mtd_all_ff(const void *buf, unsigned int len);
#endif /* CONFIG_MTD_DEBUG */
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
static inline int mtd_is_bitflip(int err) {
return err == -EUCLEAN;
}
diff --git a/include/spi/spi.h b/include/spi/spi.h
index b4358a8..620e5e5 100644
--- a/include/spi/spi.h
+++ b/include/spi/spi.h
@@ -1,8 +1,6 @@
#ifndef __INCLUDE_SPI_H
#define __INCLUDE_SPI_H
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include <driver.h>
#include <linux/string.h>
@@ -431,8 +429,6 @@ static inline ssize_t spi_w8r8(struct spi_device *spi, u8 cmd)
return (status < 0) ? status : result;
}
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
extern struct bus_type spi_bus;
struct spi_master *spi_get_master(int bus);
diff --git a/include/usb/ch9.h b/include/usb/ch9.h
index adbe533..9322363 100644
--- a/include/usb/ch9.h
+++ b/include/usb/ch9.h
@@ -33,8 +33,6 @@
#ifndef __LINUX_USB_CH9_H
#define __LINUX_USB_CH9_H
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include <linux/types.h> /* __u8 etc */
/*-------------------------------------------------------------------------*/
@@ -798,6 +796,4 @@ enum usb_device_state {
*/
};
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
#endif /* __LINUX_USB_CH9_H */
diff --git a/include/usb/composite.h b/include/usb/composite.h
index 798fa11..379927a 100644
--- a/include/usb/composite.h
+++ b/include/usb/composite.h
@@ -17,8 +17,6 @@
#ifndef __LINUX_USB_COMPOSITE_H
#define __LINUX_USB_COMPOSITE_H
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
/*
* This framework is an optional layer on top of the USB Gadget interface,
* making it easier to build (a) Composite devices, supporting multiple
@@ -343,6 +341,4 @@ extern int usb_string_id(struct usb_composite_dev *c);
#define WARNING(d, fmt, args...)
#define INFO(d, fmt, args...)
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
#endif /* __LINUX_USB_COMPOSITE_H */
diff --git a/include/usb/gadget.h b/include/usb/gadget.h
index ff1509c..798b51b 100644
--- a/include/usb/gadget.h
+++ b/include/usb/gadget.h
@@ -15,8 +15,6 @@
#ifndef __LINUX_USB_GADGET_H
#define __LINUX_USB_GADGET_H
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include <usb/ch9.h>
#include <malloc.h>
#include <errno.h>
@@ -899,6 +897,4 @@ extern struct usb_ep *usb_ep_autoconfig(struct usb_gadget *,
extern void usb_ep_autoconfig_reset(struct usb_gadget *);
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
#endif /* __LINUX_USB_GADGET_H */
diff --git a/include/usb/usb.h b/include/usb/usb.h
index 1a369d2..4877e32 100644
--- a/include/usb/usb.h
+++ b/include/usb/usb.h
@@ -22,8 +22,6 @@
#ifndef _USB_H_
#define _USB_H_
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include <driver.h>
#include <usb/usb_defs.h>
#include <asm/byteorder.h>
@@ -516,8 +514,6 @@ struct usb_device_id {
#define USB_CTRL_SET_TIMEOUT 5000
#define USB_CTRL_GET_TIMEOUT 5000
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
enum usb_dr_mode of_usb_get_dr_mode(struct device_node *np,
const char *propname);
diff --git a/net/netconsole.c b/net/netconsole.c
index 86a68e1..021820b 100644
--- a/net/netconsole.c
+++ b/net/netconsole.c
@@ -32,11 +32,6 @@
#include <init.h>
#include <linux/err.h>
-/**
- * @file
- * @brief Network console support
- */
-
struct nc_priv {
struct console_device cdev;
struct kfifo *fifo;
@@ -169,26 +164,3 @@ static int netconsole_init(void)
}
device_initcall(netconsole_init);
-
-/** @page net_netconsole Network console
-
-@section net_netconsole Using an UDP based network console
-
-If enabled barebox supports a console via udp networking. There is only
-one network console supported registered during init time. It is deactivated
-by default because it opens great security holes, so use with care.
-
-To use the network console you have to configure the remote ip and the local
-and remote ports. Assuming the network console is registered as cs1, it can be
-configured with:
-
-@code
-cs1.ip=<remotehost>
-cs1.port=<port>
-cs1.active=ioe
-@endcode
-
-On the remote host call scripts/netconsole with bareboxes ip and port as
-parameters. port is initialized to 6666 by default.
-
-*/
diff --git a/scripts/doxy_filter.awk b/scripts/doxy_filter.awk
deleted file mode 100644
index 5ec0406..0000000
--
2.0.0
[-- Attachment #2: Type: text/plain, Size: 149 bytes --]
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread* [PATCH 5/7] Documentation: remove remaining documentation
2014-06-26 8:51 New Documentation for barebox Sascha Hauer
` (3 preceding siblings ...)
2014-06-26 8:51 ` [PATCH 4/7] Documentation: remove doxygen documentation Sascha Hauer
@ 2014-06-26 8:51 ` Sascha Hauer
2014-06-26 8:51 ` [PATCH 6/7] Documentation: remove devicetree docs Sascha Hauer
` (6 subsequent siblings)
11 siblings, 0 replies; 19+ messages in thread
From: Sascha Hauer @ 2014-06-26 8:51 UTC (permalink / raw)
To: barebox
This removes the documentation texts in Documentation/. It will
be replaced with sphinx based documentation later.
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
---
Documentation/console.txt | 13 ----
Documentation/devices_drivers.txt | 72 ----------------------
Documentation/omap4_usb_booting.txt | 27 ---------
Documentation/porting.txt | 115 ------------------------------------
Documentation/timekeeping.txt | 13 ----
5 files changed, 240 deletions(-)
delete mode 100644 Documentation/console.txt
delete mode 100644 Documentation/devices_drivers.txt
delete mode 100644 Documentation/omap4_usb_booting.txt
delete mode 100644 Documentation/porting.txt
delete mode 100644 Documentation/timekeeping.txt
diff --git a/Documentation/console.txt b/Documentation/console.txt
deleted file mode 100644
index 76b6107..0000000
diff --git a/Documentation/devices_drivers.txt b/Documentation/devices_drivers.txt
deleted file mode 100644
index e13b13a..0000000
diff --git a/Documentation/omap4_usb_booting.txt b/Documentation/omap4_usb_booting.txt
deleted file mode 100644
index f0d45a2..0000000
diff --git a/Documentation/porting.txt b/Documentation/porting.txt
deleted file mode 100644
index bd807a3..0000000
diff --git a/Documentation/timekeeping.txt b/Documentation/timekeeping.txt
deleted file mode 100644
index ed5ef62..0000000
--
2.0.0
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread* [PATCH 6/7] Documentation: remove devicetree docs
2014-06-26 8:51 New Documentation for barebox Sascha Hauer
` (4 preceding siblings ...)
2014-06-26 8:51 ` [PATCH 5/7] Documentation: remove remaining documentation Sascha Hauer
@ 2014-06-26 8:51 ` Sascha Hauer
2014-06-26 8:51 ` [PATCH 7/7] Documentation: Add new sphinxs docs Sascha Hauer
` (5 subsequent siblings)
11 siblings, 0 replies; 19+ messages in thread
From: Sascha Hauer @ 2014-06-26 8:51 UTC (permalink / raw)
To: barebox
Remove the barebox devicetree documentation. It will
be replaced with sphinx based documentation later.
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
---
Documentation/devicetree/bindings/README | 6 ------
Documentation/devicetree/bindings/barebox.txt | 10 ---------
.../bindings/barebox/barebox,environment.txt | 25 ----------------------
Documentation/devicetree/bindings/leds/common.txt | 8 -------
.../devicetree/bindings/misc/fsl,imx-iim.txt | 20 -----------------
.../devicetree/bindings/misc/fsl,imx-ocotp.txt | 20 -----------------
6 files changed, 89 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/README
delete mode 100644 Documentation/devicetree/bindings/barebox.txt
delete mode 100644 Documentation/devicetree/bindings/barebox/barebox,environment.txt
delete mode 100644 Documentation/devicetree/bindings/leds/common.txt
delete mode 100644 Documentation/devicetree/bindings/misc/fsl,imx-iim.txt
delete mode 100644 Documentation/devicetree/bindings/misc/fsl,imx-ocotp.txt
diff --git a/Documentation/devicetree/bindings/README b/Documentation/devicetree/bindings/README
deleted file mode 100644
index b818ee8..0000000
diff --git a/Documentation/devicetree/bindings/barebox.txt b/Documentation/devicetree/bindings/barebox.txt
deleted file mode 100644
index 5e8d461..0000000
diff --git a/Documentation/devicetree/bindings/barebox/barebox,environment.txt b/Documentation/devicetree/bindings/barebox/barebox,environment.txt
deleted file mode 100644
index 5a8bf9c..0000000
diff --git a/Documentation/devicetree/bindings/leds/common.txt b/Documentation/devicetree/bindings/leds/common.txt
deleted file mode 100644
index db264b3..0000000
diff --git a/Documentation/devicetree/bindings/misc/fsl,imx-iim.txt b/Documentation/devicetree/bindings/misc/fsl,imx-iim.txt
deleted file mode 100644
index 9759210..0000000
diff --git a/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.txt b/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.txt
deleted file mode 100644
index b7a3ee5..0000000
--
2.0.0
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread* [PATCH 7/7] Documentation: Add new sphinxs docs
2014-06-26 8:51 New Documentation for barebox Sascha Hauer
` (5 preceding siblings ...)
2014-06-26 8:51 ` [PATCH 6/7] Documentation: remove devicetree docs Sascha Hauer
@ 2014-06-26 8:51 ` Sascha Hauer
2014-06-26 9:02 ` New Documentation for barebox Holger Schurig
` (4 subsequent siblings)
11 siblings, 0 replies; 19+ messages in thread
From: Sascha Hauer @ 2014-06-26 8:51 UTC (permalink / raw)
To: barebox
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>
---
Documentation/.gitignore | 1 +
Documentation/boards.rst | 10 +
Documentation/boards/cirrus-logic.rst | 9 +
.../boards/edb9xxx/cirrus_logic_edb9301.rst | 10 +
.../boards/edb9xxx/cirrus_logic_edb9302.rst | 10 +
.../boards/edb9xxx/cirrus_logic_edb9302a.rst | 10 +
.../boards/edb9xxx/cirrus_logic_edb9307.rst | 13 +
.../boards/edb9xxx/cirrus_logic_edb9307a.rst | 13 +
.../boards/edb9xxx/cirrus_logic_edb9312.rst | 13 +
.../boards/edb9xxx/cirrus_logic_edb9315.rst | 13 +
.../boards/edb9xxx/cirrus_logic_edb9315a.rst | 12 +
Documentation/boards/imx.rst | 103 ++++++++
Documentation/boards/imx/Garz-Fricke-Cupid.rst | 9 +
Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst | 38 +++
Documentation/boards/imx/eukrea_cpuimx27.rst | 11 +
Documentation/boards/imx/synertronixx_scb9328.rst | 12 +
Documentation/boards/mxs/Chumby-Falconwing.rst | 46 ++++
Documentation/boards/mxs/Freescale-i.MX23-evk.rst | 28 +++
Documentation/boards/mxs/KaRo-TX28.rst | 48 ++++
Documentation/boards/omap.rst | 40 +++
Documentation/boards/s3c/Digi-a9m2440.rst | 67 ++++++
Documentation/boards/samsung.rst | 9 +
Documentation/boards/sandbox.rst | 67 ++++++
Documentation/boards/tegra.rst | 102 ++++++++
Documentation/boards/x86.rst | 128 ++++++++++
Documentation/commands.rst | 9 +
Documentation/conf.py | 262 ++++++++++++++++++++
Documentation/devicetree/bindings/README | 6 +
Documentation/devicetree/bindings/leds/common.rst | 9 +
.../devicetree/bindings/misc/fsl,imx-iim.rst | 21 ++
.../devicetree/bindings/misc/fsl,imx-ocotp.rst | 21 ++
Documentation/devicetree/index.rst | 13 +
Documentation/download.rst | 16 ++
Documentation/filesystems.rst | 10 +
Documentation/filesystems/fat.rst | 15 ++
Documentation/filesystems/nfs.rst | 12 +
Documentation/filesystems/ramfs.rst | 10 +
Documentation/filesystems/tftp.rst | 16 ++
Documentation/gen_commands.py | 164 +++++++++++++
Documentation/glossary.rst | 18 ++
Documentation/index.rst | 26 ++
Documentation/user/automount.rst | 34 +++
Documentation/user/barebox.rst | 178 ++++++++++++++
Documentation/user/booting-linux.rst | 267 +++++++++++++++++++++
Documentation/user/defaultenv-2.rst | 113 +++++++++
Documentation/user/devicetree.rst | 84 +++++++
Documentation/user/driver-model.rst | 91 +++++++
Documentation/user/framebuffer.rst | 43 ++++
Documentation/user/hush.rst | 52 ++++
Documentation/user/introduction.rst | 27 +++
Documentation/user/memory-areas.rst | 27 +++
Documentation/user/multi-image.rst | 54 +++++
Documentation/user/networking.rst | 81 +++++++
Documentation/user/pbl.rst | 31 +++
Documentation/user/system-setup.rst | 64 +++++
Documentation/user/ubi.rst | 138 +++++++++++
Documentation/user/updating.rst | 29 +++
Documentation/user/usb.rst | 65 +++++
Documentation/user/user-manual.rst | 33 +++
Documentation/user/variables.rst | 49 ++++
Makefile | 11 +-
61 files changed, 2919 insertions(+), 2 deletions(-)
create mode 100644 Documentation/boards.rst
create mode 100644 Documentation/boards/cirrus-logic.rst
create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9301.rst
create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9302.rst
create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9302a.rst
create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9307.rst
create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9307a.rst
create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9312.rst
create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9315.rst
create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9315a.rst
create mode 100644 Documentation/boards/imx.rst
create mode 100644 Documentation/boards/imx/Garz-Fricke-Cupid.rst
create mode 100644 Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst
create mode 100644 Documentation/boards/imx/eukrea_cpuimx27.rst
create mode 100644 Documentation/boards/imx/synertronixx_scb9328.rst
create mode 100644 Documentation/boards/mxs/Chumby-Falconwing.rst
create mode 100644 Documentation/boards/mxs/Freescale-i.MX23-evk.rst
create mode 100644 Documentation/boards/mxs/KaRo-TX28.rst
create mode 100644 Documentation/boards/omap.rst
create mode 100644 Documentation/boards/s3c/Digi-a9m2440.rst
create mode 100644 Documentation/boards/samsung.rst
create mode 100644 Documentation/boards/sandbox.rst
create mode 100644 Documentation/boards/tegra.rst
create mode 100644 Documentation/boards/x86.rst
create mode 100644 Documentation/commands.rst
create mode 100644 Documentation/conf.py
create mode 100644 Documentation/devicetree/bindings/README
create mode 100644 Documentation/devicetree/bindings/leds/common.rst
create mode 100644 Documentation/devicetree/bindings/misc/fsl,imx-iim.rst
create mode 100644 Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst
create mode 100644 Documentation/devicetree/index.rst
create mode 100644 Documentation/download.rst
create mode 100644 Documentation/filesystems.rst
create mode 100644 Documentation/filesystems/fat.rst
create mode 100644 Documentation/filesystems/nfs.rst
create mode 100644 Documentation/filesystems/ramfs.rst
create mode 100644 Documentation/filesystems/tftp.rst
create mode 100755 Documentation/gen_commands.py
create mode 100644 Documentation/glossary.rst
create mode 100644 Documentation/index.rst
create mode 100644 Documentation/user/automount.rst
create mode 100644 Documentation/user/barebox.rst
create mode 100644 Documentation/user/booting-linux.rst
create mode 100644 Documentation/user/defaultenv-2.rst
create mode 100644 Documentation/user/devicetree.rst
create mode 100644 Documentation/user/driver-model.rst
create mode 100644 Documentation/user/framebuffer.rst
create mode 100644 Documentation/user/hush.rst
create mode 100644 Documentation/user/introduction.rst
create mode 100644 Documentation/user/memory-areas.rst
create mode 100644 Documentation/user/multi-image.rst
create mode 100644 Documentation/user/networking.rst
create mode 100644 Documentation/user/pbl.rst
create mode 100644 Documentation/user/system-setup.rst
create mode 100644 Documentation/user/ubi.rst
create mode 100644 Documentation/user/updating.rst
create mode 100644 Documentation/user/usb.rst
create mode 100644 Documentation/user/user-manual.rst
create mode 100644 Documentation/user/variables.rst
diff --git a/Documentation/.gitignore b/Documentation/.gitignore
index 1936cc1..1454566 100644
--- a/Documentation/.gitignore
+++ b/Documentation/.gitignore
@@ -1 +1,2 @@
+build
html
diff --git a/Documentation/boards.rst b/Documentation/boards.rst
new file mode 100644
index 0000000..78e4951
--- /dev/null
+++ b/Documentation/boards.rst
@@ -0,0 +1,10 @@
+.. _boards:
+
+Board support
+=============
+
+.. toctree::
+ :glob:
+ :maxdepth: 2
+
+ boards/*
diff --git a/Documentation/boards/cirrus-logic.rst b/Documentation/boards/cirrus-logic.rst
new file mode 100644
index 0000000..95a961e
--- /dev/null
+++ b/Documentation/boards/cirrus-logic.rst
@@ -0,0 +1,9 @@
+Cirrus Logic edb9xxx
+====================
+
+.. toctree::
+ :glob:
+ :numbered:
+ :maxdepth: 1
+
+ edb9xxx/*
diff --git a/Documentation/boards/edb9xxx/cirrus_logic_edb9301.rst b/Documentation/boards/edb9xxx/cirrus_logic_edb9301.rst
new file mode 100644
index 0000000..78c2d30
--- /dev/null
+++ b/Documentation/boards/edb9xxx/cirrus_logic_edb9301.rst
@@ -0,0 +1,10 @@
+Cirrus Logic EP9301
+===================
+
+This boards is based on a Cirrus Logic EP9301 CPU. The board is shipped with:
+
+ * 16MiB NOR type Flash Memory
+ * 32MiB synchronous dynamic RAM on CS3
+ * 128kiB serial EEPROM
+ * MII 10/100 Ethernet PHY
+ * Stereo audio codec
diff --git a/Documentation/boards/edb9xxx/cirrus_logic_edb9302.rst b/Documentation/boards/edb9xxx/cirrus_logic_edb9302.rst
new file mode 100644
index 0000000..43dfb83
--- /dev/null
+++ b/Documentation/boards/edb9xxx/cirrus_logic_edb9302.rst
@@ -0,0 +1,10 @@
+Cirrus Logic EDB9302
+====================
+
+This board is based on a Cirrus Logic EP9302 CPU. The board is shipped with:
+
+ * 16MiB NOR type Flash Memory
+ * 32MiB synchronous dynamic RAM on CS3
+ * 128kiB serial EEPROM
+ * MII 10/100 Ethernet PHY
+ * Stereo audio codec
diff --git a/Documentation/boards/edb9xxx/cirrus_logic_edb9302a.rst b/Documentation/boards/edb9xxx/cirrus_logic_edb9302a.rst
new file mode 100644
index 0000000..7283536
--- /dev/null
+++ b/Documentation/boards/edb9xxx/cirrus_logic_edb9302a.rst
@@ -0,0 +1,10 @@
+Cirrus Logic EDB9302A
+=====================
+
+This board is based on a Cirrus Logic EP9302 CPU. The board is shipped with:
+
+ * 16MiB NOR type Flash Memory
+ * 32MiB synchronous dynamic RAM on CS0
+ * 512kiB serial EEPROM
+ * MII 10/100 Ethernet PHY
+ * Stereo audio codec
diff --git a/Documentation/boards/edb9xxx/cirrus_logic_edb9307.rst b/Documentation/boards/edb9xxx/cirrus_logic_edb9307.rst
new file mode 100644
index 0000000..9006f2c
--- /dev/null
+++ b/Documentation/boards/edb9xxx/cirrus_logic_edb9307.rst
@@ -0,0 +1,13 @@
+Cirrus Logic EDB9307
+====================
+
+This board is based on a Cirrus Logic EP9307 CPU. The board is shipped with:
+
+ * 32MiB NOR type Flash Memory
+ * 64MiB synchronous dynamic RAM on CS3
+ * 512kiB asynchronous SRAM
+ * 128kiB serial EEPROM
+ * MII 10/100 Ethernet PHY
+ * Stereo audio codec
+ * Real-Time Clock
+ * IR receiver
diff --git a/Documentation/boards/edb9xxx/cirrus_logic_edb9307a.rst b/Documentation/boards/edb9xxx/cirrus_logic_edb9307a.rst
new file mode 100644
index 0000000..ba3763c
--- /dev/null
+++ b/Documentation/boards/edb9xxx/cirrus_logic_edb9307a.rst
@@ -0,0 +1,13 @@
+Cirrus Logic EDB9307A
+=====================
+
+This board is based on a Cirrus Logic EP9307 CPU. The board is shipped with:
+
+ * 32MiB NOR type Flash Memory
+ * 64MiB synchronous dynamic RAM on CS0
+ * 512kiB serial EEPROM
+ * MII 10/100 Ethernet PHY
+ * Stereo audio codec
+ * Real-Time Clock
+ * IR receiver
+
diff --git a/Documentation/boards/edb9xxx/cirrus_logic_edb9312.rst b/Documentation/boards/edb9xxx/cirrus_logic_edb9312.rst
new file mode 100644
index 0000000..16ad7fb
--- /dev/null
+++ b/Documentation/boards/edb9xxx/cirrus_logic_edb9312.rst
@@ -0,0 +1,13 @@
+Cirrus Logic EDB9312
+====================
+
+This board is based on a Cirrus Logic EP9312 CPU. The board is shipped with:
+
+ * 32MiB NOR type Flash Memory
+ * 64MiB synchronous dynamic RAM on CS3
+ * 512kiB asynchronous SRAM
+ * 128kiB serial EEPROM
+ * MII 10/100 Ethernet PHY
+ * Stereo audio codec
+ * Real-Time Clock
+ * IR receiver
diff --git a/Documentation/boards/edb9xxx/cirrus_logic_edb9315.rst b/Documentation/boards/edb9xxx/cirrus_logic_edb9315.rst
new file mode 100644
index 0000000..5adb966
--- /dev/null
+++ b/Documentation/boards/edb9xxx/cirrus_logic_edb9315.rst
@@ -0,0 +1,13 @@
+Cirrus Logic EDB9315
+====================
+
+This board is based on a Cirrus Logic EP9315 CPU. The board is shipped with:
+
+ * 32MiB NOR type Flash Memory
+ * 64MiB synchronous dynamic RAM on CS3
+ * 512kiB asynchronous SRAM
+ * 128kiB serial EEPROM
+ * MII 10/100 Ethernet PHY
+ * Stereo audio codec
+ * Real-Time Clock
+ * IR receiver
diff --git a/Documentation/boards/edb9xxx/cirrus_logic_edb9315a.rst b/Documentation/boards/edb9xxx/cirrus_logic_edb9315a.rst
new file mode 100644
index 0000000..c44f873
--- /dev/null
+++ b/Documentation/boards/edb9xxx/cirrus_logic_edb9315a.rst
@@ -0,0 +1,12 @@
+Cirrus Logic EDB9315A
+=====================
+
+This board is based on a Cirrus Logic EP9315 CPU. The board is shipped with:
+
+ * 32MiB NOR type Flash Memory
+ * 64MiB synchronous dynamic RAM on CS0
+ * 128kiB serial EEPROM
+ * MII 10/100 Ethernet PHY
+ * Stereo audio codec
+ * Real-Time Clock
+ * IR receiver
diff --git a/Documentation/boards/imx.rst b/Documentation/boards/imx.rst
new file mode 100644
index 0000000..c6b2087
--- /dev/null
+++ b/Documentation/boards/imx.rst
@@ -0,0 +1,103 @@
+Freescale i.MX
+==============
+
+Freescale i.MX is traditionally very good supported under barebox.
+Depending on the SoC there are different Boot Modes supported. Older
+SoCs up to i.MX31 only support the external Boot Mode. Newer SoCs
+can be configured for internal or external Boot Mode with the internal
+boot mode being the more popular mode. The i.MX23 and i.MX28, also
+known as i.MXs, are special. These SoCs have a completely different
+boot mechanism.
+
+Internal Boot Mode
+------------------
+
+The Internal Boot Mode is supported on:
+
+* i.MX25
+* i.MX35
+* i.MX51
+* i.MX53
+* i.MX6
+
+With the Internal Boot Mode the images contain a header which describes
+where the binary shall be loaded and started. Also these headers contain
+a so called DCD table which consists of register/value pairs. These are
+executed by the Boot ROM and are used to configure the SDRAM. In barebox
+the i.MX images are generated with the ``scripts/imx/imx-image`` tool.
+Normally it's not necessary to call this tool manually, it is executed
+automatically at the end of the build process.
+
+The images generated by the build process can be directly written to an
+SD card::
+
+ # with Multi Image support:
+ cat images/barebox-freescale-imx51-babbage.img > /dev/sdd
+ # otherwise:
+ cat barebox-flash-image > /dev/sdd
+
+This will overwrite the partition table on the card. It can be preserved
+with::
+
+ dd if=images/barebox-freescale-imx51-babbage.img of=/dev/sdd bs=512 skip=1 seek=1
+
+The images can also always be started second stage::
+
+ bootm /mnt/tftp/barebox-freescale-imx51-babbage.img
+
+USB Boot
+^^^^^^^^
+
+Most boards can be explicitly configured for USB Boot Mode or fall back
+to USB Boot when no other medium can be found. The barebox repository
+contains a USB upload tool. As it depends on the libusb development headers
+it is not built by default. Enable it explicitly in ``make menuconfig``
+and install the libusb development package. On Debian this can be done
+with ``apt-get install libusb-dev``. After compilation the tool can be used
+with only the image name as argument::
+
+ scripts/imx/imx-usb-loader images/barebox-freescale-imx51-babbage.img
+
+External Boot Mode
+------------------
+
+The External Boot Mode is supported by the older i.MX SoCs:
+
+* i.MX1
+* i.MX21
+* i.MX27
+* i.MX31
+
+(It may be supported on newer SoCs aswell, but it is not widely used there)
+
+The External Boot Mode only supports booting from NOR and NAND flash. On NOR
+flash the binary is started directly on its physical address in memory. Booting
+from NAND flash is more complicated. The NAND flash controller copies the first
+2kb of the image to the NAND Controllers internal SRAM. This initial binary
+portion is then has to:
+
+* Set up the SDRAM
+* Copy the initial binary to SDRAM to make the internal SRAM in the NAND flash
+ controller free for use for the controller
+* Copy the whole barebox image to SDRAM
+* Start the image
+
+It is possible to write the image directly to NAND. However, since NAND flash
+can have bad blocks which must be skipped during writing the image and also
+by the initial loader, it is recommended to use the :ref:`command_barebox_update`
+command for writing to NAND flash.
+
+i.MX boards
+-----------
+
+Not supported all boards have a description here. Many newer boards also do
+not have individual defconfig files, they are covered by ``imx_v7_defconfig``
+or ``imx_defconfig`` instead.
+
+.. toctree::
+ :glob:
+ :numbered:
+ :maxdepth: 1
+
+ imx/*
+ mxs/*
diff --git a/Documentation/boards/imx/Garz-Fricke-Cupid.rst b/Documentation/boards/imx/Garz-Fricke-Cupid.rst
new file mode 100644
index 0000000..1328810
--- /dev/null
+++ b/Documentation/boards/imx/Garz-Fricke-Cupid.rst
@@ -0,0 +1,9 @@
+Garz+Fricke Cupid
+=================
+
+This CPU card is based on a Freescale i.MX35 CPU. The card is shipped with:
+
+ * 256MiB Nand flash
+ * 128MiB synchronous dynamic RAM
+
+see http://www.garz-fricke.com/cupid-core_de.html for more information
diff --git a/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst b/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst
new file mode 100644
index 0000000..527c490
--- /dev/null
+++ b/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst
@@ -0,0 +1,38 @@
+Phytec phyCORE-i.MX31 CPU module PCM-037
+========================================
+
+The CPU module
+--------------
+
+http://www.phytec.eu/europe/products/modules-overview/phycore/produktdetails/p/phycore-imx31-2.html
+
+This CPU card is based on a Freescale i.MX31 CPU. The card in configuration -0000REU is shipped with:
+
+ * 128 MiB synchronous dynamic RAM (DDR type)
+ * 64 MiB NAND flash
+ * 32 MiB NOR flash
+ * 512 kiB SRAM
+ * 4kiB EEPROM
+ * MMU, FPU
+ * Serial, Ethernet, USB (OTG), I2C, SPI, MMC/SD/SDIO, PCMCIA/CF, RTC
+
+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'
+------------------------------------------------
+
+Using the default configuration::
+
+ make ARCH=arm pcm037_defconfig
+
+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-''
+
+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/eukrea_cpuimx27.rst b/Documentation/boards/imx/eukrea_cpuimx27.rst
new file mode 100644
index 0000000..c5ab4b9
--- /dev/null
+++ b/Documentation/boards/imx/eukrea_cpuimx27.rst
@@ -0,0 +1,11 @@
+Eukrea CPUIMX27
+===============
+
+This CPU card is based on a Freescale i.MX27 CPU. The card is shipped with:
+
+ * up to 64MiB NOR type Flash Memory
+ * up to 256MiB synchronous dynamic RAM
+ * up to 512MiB NAND type Flash Memory
+ * MII 10/100 ethernet PHY
+ * optional 16554 Quad UART on CS3
+
diff --git a/Documentation/boards/imx/synertronixx_scb9328.rst b/Documentation/boards/imx/synertronixx_scb9328.rst
new file mode 100644
index 0000000..229b3d0
--- /dev/null
+++ b/Documentation/boards/imx/synertronixx_scb9328.rst
@@ -0,0 +1,12 @@
+Synertronixx scb9328
+====================
+
+See http://www.synertronixx.de/produkte/scb9328/scb9328.htm
+
+This CPU card is based on a Freescale i.MX1 CPU. The card is shipped with:
+
+ * 16MiB NOR type Flash Memory
+ * 16MiB synchronous dynamic RAM
+ * DM9000 network controller
+
+It's the first i.MX board sha has ever ported Linux to.
diff --git a/Documentation/boards/mxs/Chumby-Falconwing.rst b/Documentation/boards/mxs/Chumby-Falconwing.rst
new file mode 100644
index 0000000..73e4c30
--- /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 0000000..b03508c
--- /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 0000000..a6c308c
--- /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
diff --git a/Documentation/boards/omap.rst b/Documentation/boards/omap.rst
new file mode 100644
index 0000000..63caf66
--- /dev/null
+++ b/Documentation/boards/omap.rst
@@ -0,0 +1,40 @@
+Texas Instruments OMAP/AM335x
+=============================
+
+Texas Intruments OMAP SoCs have a two staged boot process. The first stage is
+known as Xload which only loads the second stage bootloader. barebox can act as
+both the first and the second stage loader. To build as a first stage loader
+build the \*_xload_defconfig for your board, for second stage build the normal
+\*_defconfig for your board.
+
+bootstrapping a panda board
+---------------------------
+
+The Panda board boots from SD card. The OMAP Boot ROM code loads a file named
+'MLO' on a bootable FAT partition on this card. There are several howtos and
+scripts on the net which describe how to prepare such a card (it needs a
+special partitioning). The same procedure can be used for barebox. With such a
+card (assumed to be at /dev/sdc) the following can be used to build and install
+barebox::
+
+ # mount -t fat /dev/sdc1 /mnt
+ # make panda_xload_defconfig
+ # make
+ # cp barebox.bin.ift /mnt/MLO
+ # make panda_defconfig
+ # make
+ # cp barebox.bin /mnt/barebox.bin
+ # umount /mnt
+
+Bootstrapping a Beagle board is the same with the corresponding Beagle board defconfigs
+
+Networking
+----------
+
+The Beagle board does not have ethernet, but a USB ethernet dongle can be used
+for networking. the Panda board has an integrated USB ethernet converter which
+exactly behaves like an external dongle. Barebox does not automatically detect
+USB devices as this would have bad effects on boot time when USB is not needed.
+So you have to use the [[commands:usb|usb]] command to trigger USB detection.
+After this a network device should be present which can be used with the normal
+[[commands:dhcp|dhcp]] and [[commands:tftp|tftp]] commands.
diff --git a/Documentation/boards/s3c/Digi-a9m2440.rst b/Documentation/boards/s3c/Digi-a9m2440.rst
new file mode 100644
index 0000000..4ed8ae4
--- /dev/null
+++ b/Documentation/boards/s3c/Digi-a9m2440.rst
@@ -0,0 +1,67 @@
+DIGI a9m2440
+============
+
+This CPU card is based on a Samsung S3C2440 CPU. The card is shipped with:
+
+ * S3C2440\@400 MHz or 533 MHz (ARM920T/ARMv4T)
+ * 16.9344 MHz crystal reference
+ * SDRAM 32/64/128 MiB
+ * Samsung K4M563233E-EE1H (one or two devices for 32 MiB or 64 MiB)
+ * 2M x 32bit x 4 Banks Mobile SDRAM
+ * CL2\@100 MHz (CAS/RAS delay 19ns)
+ * 105 MHz max
+ * column address size is 9 bits
+ * Row cycle time: 69ns
+ * Samsung K4M513233C-DG75 (one or two devices for 64 MiB or 128 MiB)
+ * 4M x 32bit x 4 Banks Mobile SDRAM
+ * CL2\@100MHz (CAS/RAS delay 18ns)
+ * 111 MHz max
+ * column address size is 9 bits
+ * Row cycle time: 63ns
+ * 64ms refresh period (4k)
+ * 90 pin FBGA
+ * 32 bit data bits
+ * Extended temperature range (-25°C...85°C)
+ * NAND Flash 32/64/128 MiB
+ * Samsung KM29U512T (NAND01GW3A0AN6)
+ * 64 MiB 3,3V 8-bit
+ * ID: 0xEC, 0x76, 0x??, 0xBD
+ * Samsung KM29U256T
+ * 32 MiB 3,3V 8-bit
+ * ID: 0xEC, 0x75, 0x??, 0xBD
+ * ST Micro
+ * 128 MiB 3,3V 8-bit
+ * ID: 0x20, 0x79
+ * 30ns/40ns/20ns
+ * I2C interface, 100 KHz and 400 KHz
+ * Real Time Clock
+ * Dallas DS1337
+ * address 0x68
+ * EEPROM
+ * ST M24LC64
+ * address 0x50
+ * 16bit addressing
+ * LCD interface
+ * Touch Screen interface
+ * Camera interface
+ * I2S interface
+ * AC97 Audio-CODEC interface
+ * SD card interface
+ * 3 serial RS232 interfaces
+ * Host and device USB interface, USB1.1 compliant
+ * Ethernet interface
+ * 10Mbps, Cirrus Logic, CS8900A (on the CPU card)
+ * SPI interface
+ * JTAG interface
+
+How to get the binary image:
+
+Using the default configuration::
+
+ make ARCH=arm a9m2440_defconfig
+
+Build the binary image::
+
+ make ARCH=arm CROSS_COMPILE=armv4compiler
+
+**NOTE** replace the armv4compiler with your ARM v4 cross compiler.
diff --git a/Documentation/boards/samsung.rst b/Documentation/boards/samsung.rst
new file mode 100644
index 0000000..d75224f
--- /dev/null
+++ b/Documentation/boards/samsung.rst
@@ -0,0 +1,9 @@
+Samsung S3C/S5P
+===============
+
+.. toctree::
+ :glob:
+ :numbered:
+ :maxdepth: 1
+
+ s3c/*
diff --git a/Documentation/boards/sandbox.rst b/Documentation/boards/sandbox.rst
new file mode 100644
index 0000000..4601aed
--- /dev/null
+++ b/Documentation/boards/sandbox.rst
@@ -0,0 +1,67 @@
+Sandbox
+=======
+
+barebox can be run as a simulator on your host to check and debug new non
+hardware related features.
+
+Build barebox for simulation
+----------------------------
+
+the barebox sand box can be built with the host compiler::
+
+ ARCH=sandbox make sandbox_defconfig
+ ARCH=sandbox make
+
+Run sandbox
+-----------
+
+::
+
+ $ barebox [\<OPTIONS\>]
+
+Options can be::
+
+ -m, --malloc=\<size\>
+
+Start sandbox with a specified malloc-space \<size\> in bytes.
+
+::
+
+ -i \<file\>
+
+Map a \<file\> to barebox. This option can be given multiple times. The \<file\>s
+will show up as /dev/fd0 ... /dev/fdx in the barebox simulator.
+
+::
+
+ -e \<file\>
+
+Map \<file\> to barebox. With this option \<file\>s are mapped as /dev/env0 ...
+/dev/envx and thus are used as default environment. A clean file generated
+with dd will do to get started with an empty environment
+
+::
+
+ -O \<file\>
+
+Register \<file\> as a console capable of doing stdout. \<file\> can be a
+regular file or a fifo.
+
+::
+
+ -I \<file\>
+
+Register \<file\> as a console capable of doing stdin. \<file\> can be a regular
+file or a fifo.
+
+::
+
+ -x, --xres \<res\>
+
+Specify SDL width
+
+::
+
+ -y, --yres \<res\>
+
+Specify SDL height
diff --git a/Documentation/boards/tegra.rst b/Documentation/boards/tegra.rst
new file mode 100644
index 0000000..f28c506
--- /dev/null
+++ b/Documentation/boards/tegra.rst
@@ -0,0 +1,102 @@
+.. highlight:: console
+
+Nvidia Tegra
+============
+
+Building
+--------
+
+All currently supported Tegra boards are integrated in a single
+multi-image build (:ref:`multi_image`). Building is as easy as typing:
+
+.. code-block:: sh
+
+ make ARCH=arm tegra_v7_defconfig
+ make ARCH=arm CROSS_COMPILE=arm-v7-compiler-
+
+**NOTE** replace the arm-v7-compiler- with your ARM v7 cross compiler.
+
+Tegra images are specific to the bootsource. The build will generate images for
+all combinations of bootsources and supported boards. You can find the
+completed images in the ``images/`` subdirectory.
+
+The naming scheme consists of the triplet tegracodename-boardname-bootsource
+
+Kickstarting a board using USB
+------------------------------
+
+The tool needed to transfer and start a bootloader image to any Tegra board
+using the USB boot mode is called TegraRCM. Most likely this isn't available
+from your distributions repositories. You can get and install it by running the
+following commands:
+
+.. code-block:: sh
+
+ git clone https://github.com/NVIDIA/tegrarcm.git
+ cd tegrarcm
+ ./autogen.sh
+ make
+ sudo make install
+
+Connect the board to your host via the USB OTG port.
+The next step is to bring the device into USB boot mode. On developer boards
+this could normally be done by holding down a force recovery button (or setting
+some jumper) while resetting the board. On other devices you are on your own
+finding out how to achieve this.
+
+The tegrarcm tool has 3 basic options:
+
+.. code-block:: none
+
+ --bct : the BCT file needed for basic hardware init,
+ this can be found in the respective board directory
+ --bootloader : the actual barebox image
+ use the -usbloader image
+ --loadaddr : start address of the barebox image
+ use 0x00108000 for Tegra20 aka Tegra2 devices
+ use 0x80108000 for all other Tegra devices
+
+An example command line for the NVIDIA Beaver board looks like this:
+
+.. code-block:: sh
+
+ tegrarcm --bct arch/arm/boards/nvidia-beaver/beaver-2gb-emmc.bct \
+ --bootloader images/barebox-tegra30-nvidia-beaver-usbloader.img \
+ --loadaddr 0x80108000
+
+You should now see barebox coming up on the serial console.
+
+Writing barebox to the primary boot device
+------------------------------------------
+
+**NOTE** This may change in the near future to work with the standard
+barebox update mechanism (:ref:`update`).
+
+Copy the image corresponding to the primary boot device for your board to a
+SD-card and plug it into your board.
+
+Within the barebox shell use the standard mount and cp commands to copy the
+image to the boot device.
+
+On the NVIDIA Beaver board this looks like this:
+
+.. code-block:: sh
+
+ barebox@NVIDIA Tegra30 Beaver evaluation board:/ mount -a
+ mci0: detected SD card version 2.0
+ mci0: registered disk0
+ mci1: detected MMC card version 4.65
+ mci1: registered disk1.boot0
+ mci1: registered disk1.boot1
+ mci1: registered disk1
+ ext4 ext40: EXT2 rev 1, inode_size 128
+ ext4 ext41: EXT2 rev 1, inode_size 256
+ ext4 ext42: EXT2 rev 1, inode_size 256
+ none on / type ramfs
+ none on /dev type devfs
+ /dev/disk0.0 on /mnt/disk0.0 type ext4
+ /dev/disk0.1 on /mnt/disk0.1 type ext4
+ /dev/disk1.1 on /mnt/disk1.1 type ext4
+ barebox@NVIDIA Tegra30 Beaver evaluation board:/ cp /mnt/disk0.0/barebox-tegra30-nvidia-beaver-emmc.img /dev/disk1.boot0
+
+That's it: barebox should come up after resetting the board.
diff --git a/Documentation/boards/x86.rst b/Documentation/boards/x86.rst
new file mode 100644
index 0000000..5d38955
--- /dev/null
+++ b/Documentation/boards/x86.rst
@@ -0,0 +1,128 @@
+x86
+===
+
+Features
+--------
+
+barebox can act as a bootloader for PC based systems. In this case a special
+binary layout will be created to be able to store it on some media the PC
+BIOS can boot from. It can boot Linux kernels stored also on the same boot
+media and be configured at runtime, with the possibility to store the changed
+configuration on the boot media.
+
+Restrictions
+------------
+
+Due to some BIOS and barebox restrictions the boot media must be
+prepared in some special way:
+
+ * barebox must be stored in the MBR (Master Boot Record) of the boot media. Currently its not possible to store and boot it in one of the partition sectors to use it as a second stage loader). This is no eternal restriction. It only needs further effort to add this feature.
+ * barebox currently cannot run a chained boot loader. Also, this is no external restriction, only further effort needed.
+ * barebox comes with limited filesystem support. There is currently no support for the most common and popular filesystems used in the \*NIX world. This restricts locations where to store a kernel and other runtime information
+ * barebox must be stored to the first n sectors of the boot media. To ensure this does not collide with partitions on the boot media, the first partition must start at a sector behind the ones barebox occupies.
+ * barebox handles its runtime configuration in a special way: It stores it in a binary way into some reserved sectors ("persistant storage").
+
+Boot Preparations
+-----------------
+
+To store the barebox image to a boot media, it comes with the tool
+setupmbr in the directory scripts/setupmbr/ . To be able to use it on
+the boot media of your choice, some preparations are required.
+
+Keep Sectors free
+-----------------
+
+Build the barebox image and check its size. At least this amount of
+sectors must be kept free after the MBR prior the first partition. Do this
+simple calulation::
+
+ sectors = (\<size of barebox image\> + 511) / 512
+
+To be able to store the runtime configuration, further free sectors are
+required. Its up to you and your requirements, how large this persistant
+storage must be. If you need 16 kiB for this purpose, you need to keep
+additional 32 sectors free.
+
+For this example we are reserving 300 sectors for the barebox image and
+additionaly 32 sectors for the persistant storage. So, the first partition on
+the boot media must start at sector 333 or later.
+
+Run the fdisk tool to setup such a partition table::
+
+
+ [jb@host]~> fdisk /dev/sda
+ Command (m for help): p
+
+ Disk /dev/sda: 20.7 MB, 212680704 bytes
+ 16 heads, 63 sectors/track, 406 cylinders
+ Units = cylinders of 1008 * 512 = 516096 bytes
+
+ Device Boot Start End Blocks Id System
+
+Change the used units to sectors for easier handling.
+
+::
+
+ Command (m for help): u
+ Changing display/entry units to sectors
+
+ Command (m for help): p
+
+ Disk /dev/sda: 20.7 MB, 212680704 bytes
+ 16 heads, 63 sectors/track, 406 cylinders, total 409248 sectors
+ Units = sectors of 1 * 512 = 512 bytes
+
+ Device Boot Start End Blocks Id System
+
+Now its possible to create the first partition with the required offset::
+
+ Command (m for help): n
+ Command action
+ e extended
+ p primary partition (1-4)
+ p
+ Partition number (1-4): 1
+ First sector (63-409247, default 63): 333
+ Last sector or +size or +sizeM or +sizeK (333-409247, default 409247): +18M
+ Command (m for help): p
+
+ Disk /dev/sda: 20.7 MB, 212680704 bytes
+ 16 heads, 63 sectors/track, 406 cylinders, total 409248 sectors
+ Units = sectors of 1 * 512 = 512 bytes
+
+ Device Boot Start End Blocks Id System
+ /dev/sda 333 35489 17578+ 83 Linux
+
+That's all. Do whatever is required now with the new partition (formatting
+and populating the root filesystem for example) to make it useful.
+
+In the next step, barebox gets installed to this boot media::
+
+ [jb@host]~> scripts/setupmbr/setupmbr -s 32 -m ./barebox -d /dev/sda
+
+This command writes the barebox image file './barebox' onto the device
+ /dev/sda.
+
+The -s option will keep the persistant storage sectors free and untouched
+and set flags in the MBR to forward its existance, size and location to
+barebox at runtime. setupmbr also does not change the partition table.
+
+The barebox image gets stored on the boot media like this::
+
+ sector 0 1 33 333
+ |---|-------------|--------------- ~~~ ------------|--------------
+ MBR persistant barebox first
+ storage main image partition
+
+If the -s option is omitted, the "persistant storage" part simply does
+not exist::
+
+ sector 0 1 333
+ |---|--------------- ~~~ ------------|--------------
+ MBR barebox first
+ main image partition
+
+**NOTE** The setupmbr tool is also working on real image file than on device
+ nodes only. So, there is no restriction what kind of file will be
+ modified.
+
diff --git a/Documentation/commands.rst b/Documentation/commands.rst
new file mode 100644
index 0000000..a649209
--- /dev/null
+++ b/Documentation/commands.rst
@@ -0,0 +1,9 @@
+barebox command reference
+=========================
+
+.. toctree::
+ :glob:
+ :maxdepth: 1
+
+ commands/*
+
diff --git a/Documentation/conf.py b/Documentation/conf.py
new file mode 100644
index 0000000..0292c72
--- /dev/null
+++ b/Documentation/conf.py
@@ -0,0 +1,262 @@
+# -*- coding: utf-8 -*-
+#
+# barebox documentation build configuration file, created by
+# sphinx-quickstart on Tue Jun 17 11:45:57 2014.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'barebox'
+copyright = u'2014, The barebox project'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+import os
+
+version = os.environ["KERNELVERSION"]
+# The full version, including alpha/beta/rc tags.
+release = os.environ["KERNELRELEASE"]
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'bareboxdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ ('index', 'barebox.tex', u'barebox Documentation',
+ u'The barebox project', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'barebox', u'barebox Documentation',
+ [u'The barebox project'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'barebox', u'barebox Documentation',
+ u'The barebox project', 'barebox', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+highlight_language = 'c'
diff --git a/Documentation/devicetree/bindings/README b/Documentation/devicetree/bindings/README
new file mode 100644
index 0000000..b818ee8
--- /dev/null
+++ b/Documentation/devicetree/bindings/README
@@ -0,0 +1,6 @@
+
+barebox uses the same devicetree bindings as the kernel. For
+the bindings derived from the kernel look in the kernel sources
+for reference.
+
+barebox specific bindings are documented here.
diff --git a/Documentation/devicetree/bindings/leds/common.rst b/Documentation/devicetree/bindings/leds/common.rst
new file mode 100644
index 0000000..63a45bd
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/common.rst
@@ -0,0 +1,9 @@
+Common leds properties
+======================
+
+- linux,default-trigger barebox,default-trigger: This parameter, if present, is a
+ string defining the trigger assigned to the LED. Current triggers are:
+ "heartbeat" - LED flashes at a constant rate
+ "panic" - LED turns on when barebox panics
+ "net" - LED indicates network activity
+
diff --git a/Documentation/devicetree/bindings/misc/fsl,imx-iim.rst b/Documentation/devicetree/bindings/misc/fsl,imx-iim.rst
new file mode 100644
index 0000000..a067579
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/fsl,imx-iim.rst
@@ -0,0 +1,21 @@
+Freescale i.MX IIM (Ic Identification Module)
+=============================================
+
+Required properties:
+
+- compatible: fsl,imx27-iim
+- reg: physical register base and size
+
+Optional properties:
+
+- barebox,provide-mac-address: Provide MAC addresses for ethernet devices. This
+ can be multiple entries in the form <&phandle bankno fuseofs> to specify a MAC
+ address to a ethernet device.
+
+Example::
+
+ iim: iim@83f98000 {
+ compatible = "fsl,imx51-iim", "fsl,imx27-iim";
+ reg = <0x83f98000 0x4000>;
+ barebox,provide-mac-address = <&fec 1 9>;
+ };
diff --git a/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst b/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst
new file mode 100644
index 0000000..472b9e2
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst
@@ -0,0 +1,21 @@
+Freescale i.MX OCOTP (On-Chip OTP)
+==================================
+
+Required properties:
+
+- compatible: fsl,imx6q-ocotp
+- reg: physical register base and size
+
+Optional properties:
+
+- barebox,provide-mac-address: Provide MAC addresses for ethernet devices. This
+ can be multiple entries in the form <&phandle regofs> to specify a MAC
+ address to a ethernet device.
+
+Example::
+
+ ocotp1: ocotp@021bc000 {
+ compatible = "fsl,imx6q-ocotp";
+ reg = <0x021bc000 0x4000>;
+ barebox,provide-mac-address = <&fec 0x620>;
+ };
diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst
new file mode 100644
index 0000000..a24d635
--- /dev/null
+++ b/Documentation/devicetree/index.rst
@@ -0,0 +1,13 @@
+barebox specific devicetree bindings
+====================================
+
+Contents:
+
+.. toctree::
+ :glob:
+ :numbered:
+ :maxdepth: 1
+
+ bindings/barebox/*
+ bindings/leds/*
+ bindings/misc/*
diff --git a/Documentation/download.rst b/Documentation/download.rst
new file mode 100644
index 0000000..9e30efe
--- /dev/null
+++ b/Documentation/download.rst
@@ -0,0 +1,16 @@
+:: _download:
+
+Getting barebox
+===============
+
+Releases of barebox can be downloaded here:
+
+http://barebox.org/download/
+
+git
+---
+
+The barebox development repository is available via `git <http://git-scm.com/>`_ here:
+
+ * clone address git://git.pengutronix.de/git/barebox.git
+ * git web http://git.pengutronix.de/?p=barebox.git;a=summary
diff --git a/Documentation/filesystems.rst b/Documentation/filesystems.rst
new file mode 100644
index 0000000..3bb1edf
--- /dev/null
+++ b/Documentation/filesystems.rst
@@ -0,0 +1,10 @@
+.. _filesystems:
+
+filesystems
+===========
+
+.. toctree::
+ :maxdepth: 2
+ :glob:
+
+ filesystems/*
diff --git a/Documentation/filesystems/fat.rst b/Documentation/filesystems/fat.rst
new file mode 100644
index 0000000..2138328
--- /dev/null
+++ b/Documentation/filesystems/fat.rst
@@ -0,0 +1,15 @@
+.. index:: fat (filesystem)
+
+FAT filesystem
+==============
+
+barebox supports FAT filesystems in both read and write modes with optional
+support for long filenames. A FAT filesystem can be mounted using the
+:ref:`command_mount` command::
+
+ mkdir /mnt
+ mount /dev/disk0.0 fat /mnt
+ ls /mnt
+ zImage barebox.bin
+ umount /mnt
+
diff --git a/Documentation/filesystems/nfs.rst b/Documentation/filesystems/nfs.rst
new file mode 100644
index 0000000..b8ad4f3
--- /dev/null
+++ b/Documentation/filesystems/nfs.rst
@@ -0,0 +1,12 @@
+.. index:: nfs (filesystem)
+
+.. _filesystems_nfs:
+
+NFS Support
+===========
+
+barebox has readonly support for NFSv3 un UDP mode.
+
+Example::
+
+ mount -t nfs 192.168.23.4:/home/user/nfsroot /mnt/nfs
diff --git a/Documentation/filesystems/ramfs.rst b/Documentation/filesystems/ramfs.rst
new file mode 100644
index 0000000..37d6ffc
--- /dev/null
+++ b/Documentation/filesystems/ramfs.rst
@@ -0,0 +1,10 @@
+.. index:: ramfs (filesystem)
+
+ram filesystem
+==============
+
+ramfs is a simple malloc based filesystem. An instance of ramfs is mounted during startup on /. The filesystemtype passed to mount is 'ramfs'
+
+example::
+
+ mount none ramfs /somedir
diff --git a/Documentation/filesystems/tftp.rst b/Documentation/filesystems/tftp.rst
new file mode 100644
index 0000000..273be5e
--- /dev/null
+++ b/Documentation/filesystems/tftp.rst
@@ -0,0 +1,16 @@
+.. index:: tftp (filesystem)
+
+.. _filesystems_tftp:
+
+TFTP support
+============
+
+barebox has read/write support for the Trivial File Transfer Protocol.
+
+TFTP is not designed as a filesystem. It does not have support for listing
+directories. This means a :ref:`command_ls` to a TFTP mounted path will show an empty
+directory. Nevertheless the files are there.
+
+Example::
+
+ mount -t tftp 192.168.23.4 /mnt/tftp
diff --git a/Documentation/gen_commands.py b/Documentation/gen_commands.py
new file mode 100755
index 0000000..4e33cca
--- /dev/null
+++ b/Documentation/gen_commands.py
@@ -0,0 +1,164 @@
+#!/usr/bin/python
+
+import os
+import re
+import sys
+
+from collections import defaultdict
+from pprint import pprint
+
+# TODO: handle commands with the same name in multiple files
+# TODO: handle #ifdefs
+
+HELP_START = re.compile(r"""^BAREBOX_CMD_HELP_START\s*\((\w+)\)?\s*$""")
+HELP_TEXT = re.compile(r"""^BAREBOX_CMD_HELP_TEXT\s*\("(.*?)"\)?\s*$""")
+HELP_OPT = re.compile(r"""^BAREBOX_CMD_HELP_OPT\s*\("(.+?)",\s*"(.+?)"\)?\s*$""")
+HELP_END = re.compile(r"""^BAREBOX_CMD_HELP_END\s*$""")
+
+CMD_START = re.compile(r"""^BAREBOX_CMD_START\s*\((.+)\)\s*$""")
+CMD_FUNC = re.compile(r"""^\s*\.cmd\s*=\s*(.+?),\s*$""")
+CMD_DESC = re.compile(r"""^\s*BAREBOX_CMD_DESC\s*\("(.*?)"\)?\s*$""")
+CMD_OPTS = re.compile(r"""^\s*BAREBOX_CMD_OPTS\s*\("(.*?)"\)?\s*$""")
+CMD_GROUP = re.compile(r"""^\s*BAREBOX_CMD_GROUP\s*\((.+)\)\s*$""")
+CMD_END = re.compile(r"""^BAREBOX_CMD_END\s*$""")
+
+CONT = re.compile(r"""\s*"(.*?)"\s*\)?\s*$""")
+
+CMDS = {}
+
+def parse_c(name):
+ cmd = None
+ last = None
+ for line in file(name, 'r'):
+ x = HELP_START.match(line)
+ if x:
+ cmd = CMDS.setdefault(x.group(1), defaultdict(list))
+ cmd.setdefault("files", set()).add(name)
+ continue
+ x = CMD_START.match(line)
+ if x:
+ cmd = CMDS.setdefault(x.group(1), defaultdict(list))
+ cmd.setdefault("files", set()).add(name)
+ continue
+ if cmd is None:
+ continue
+ x = HELP_TEXT.match(line)
+ if x:
+ if 'h_opts' not in cmd:
+ last = cmd['h_pre']
+ else:
+ last = cmd['h_post']
+ last.append(x.group(1).decode("string_escape").strip())
+ continue
+ x = HELP_OPT.match(line)
+ if x:
+ last = cmd['h_opts']
+ last.append([
+ x.group(1).decode("string_escape"),
+ x.group(2).decode("string_escape")
+ ])
+ continue
+ x = CMD_FUNC.match(line)
+ if x:
+ last = cmd['c_func']
+ last.append(x.group(1))
+ continue
+ x = CMD_DESC.match(line)
+ if x:
+ last = cmd['c_desc']
+ last.append(x.group(1).decode("string_escape"))
+ continue
+ x = CMD_OPTS.match(line)
+ if x:
+ last = cmd['c_opts']
+ last.append(x.group(1).decode("string_escape"))
+ continue
+ x = CMD_GROUP.match(line)
+ if x:
+ last = cmd['c_group']
+ last.append(x.group(1).decode("string_escape"))
+ continue
+ x = CONT.match(line)
+ if x:
+ if last is None:
+ raise Exception("Parse error in %s: %r" % (name, line))
+ if isinstance(last[-1], str):
+ last[-1] += x.group(1).decode("string_escape")
+ elif isinstance(last[-1], list):
+ last[-1][1] += x.group(1).decode("string_escape")
+ continue
+ x = HELP_END.match(line)
+ if x:
+ cmd = last = None
+ x = CMD_END.match(line)
+ if x:
+ cmd = last = None
+
+def gen_rst(name, cmd):
+ out = []
+ out.append('.. index:: %s (command)' % name)
+ out.append('')
+ out.append('.. _command_%s:' % name)
+ out.append('')
+ if 'c_desc' in cmd:
+ out.append("%s (%s)" % (name, ''.join(cmd['c_desc']).strip()))
+ else:
+ out.append("%s" % (name,))
+ out.append('='*len(out[-1]))
+ out.append('')
+ if 'c_opts' in cmd:
+ out.append('Usage')
+ out.append('^'*len(out[-1]))
+ out.append('``%s %s``' % (name, ''.join(cmd['c_opts']).strip()))
+ out.append('')
+ if 'h_pre' in cmd:
+ pre = cmd['h_pre']
+ if pre and pre[-1] == "Options:":
+ del pre[-1]
+ if pre and pre[-1] == "":
+ del pre[-1]
+ if pre:
+ out.append('Synopsis')
+ out.append('^'*len(out[-1]))
+ out.append('\n'.join(cmd['h_pre']).strip())
+ out.append('')
+ if 'h_opts' in cmd:
+ out.append('Options')
+ out.append('^'*len(out[-1]))
+ for o, d in cmd['h_opts']:
+ o = o.strip()
+ d = d.strip()
+ if o:
+ out.append('%s\n %s' % (o, d))
+ else:
+ out.append(' %s' % (d,))
+ out.append('')
+ if 'h_post' in cmd:
+ post = cmd['h_post']
+ if post and post[0] == "":
+ del post[0]
+ if post:
+ out.append('Description')
+ out.append('^'*len(out[-1]))
+ out.append('\n'.join(cmd['h_post']).strip())
+ out.append('')
+ out.append('.. generated from: %s' % ', '.join(cmd['files']))
+ if 'c_func' in cmd:
+ out.append('.. command function: %s' % ', '.join(cmd['c_func']))
+ return '\n'.join(out)
+
+for root, dirs, files in os.walk(sys.argv[1]):
+ for name in files:
+ if name.endswith('.c'):
+ source = os.path.join(root, name)
+ parse_c(source)
+
+for name in CMDS.keys():
+ CMDS[name] = dict(CMDS[name])
+
+for name, cmd in CMDS.items():
+ #pprint({name: cmd})
+ rst = gen_rst(name, cmd)
+ target = os.path.join(sys.argv[2], name+'.rst')
+ file(target, 'w').write(rst)
+
diff --git a/Documentation/glossary.rst b/Documentation/glossary.rst
new file mode 100644
index 0000000..a702859
--- /dev/null
+++ b/Documentation/glossary.rst
@@ -0,0 +1,18 @@
+.. _glossary:
+
+Glossary
+========
+
+.. glossary:: :sorted:
+
+ FTD
+ Flattened Device Tree
+
+ DTB
+ Device Tree Blob (or Binary)
+
+ DTS
+ Device Tree Source
+
+ PBL
+ Pre BootLoader image
diff --git a/Documentation/index.rst b/Documentation/index.rst
new file mode 100644
index 0000000..aff450a
--- /dev/null
+++ b/Documentation/index.rst
@@ -0,0 +1,26 @@
+.. barebox documentation master file, created by
+ sphinx-quickstart on Tue Jun 17 11:45:57 2014.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to barebox
+==================
+
+Contents:
+
+.. toctree::
+ :glob:
+ :numbered:
+ :maxdepth: 1
+
+ download
+ user/user-manual
+ filesystems
+ commands
+ boards
+ glossary
+ devicetree/*
+
+* :ref:`search`
+* :ref:`genindex`
+
diff --git a/Documentation/user/automount.rst b/Documentation/user/automount.rst
new file mode 100644
index 0000000..d13eaf1
--- /dev/null
+++ b/Documentation/user/automount.rst
@@ -0,0 +1,34 @@
+.. _automount:
+
+Automount
+=========
+
+barebox supports automatically mounting filesystems when a path is first
+accessed. This is handled with the :ref:`command_automount` command. With automounting
+it is possible to separate the configuration of a board from actually using
+filesystems. The filesystems (and the devices they are on) are only probed
+when necessary, so barebox does not lose time probing unused devices.
+
+Typical usage is for accessing the TFTP server. To set up an automount for a
+TFTP server, the following is required::
+
+ mkdir -p /mnt/tftp
+ automount /mnt/tftp 'ifup eth0 && mount -t tftp $eth0.serverip /mnt/tftp'
+
+This creates an automountpoint on /mnt/tftp. Whenever this directory is accessed,
+the command ``ifup eth0 && mount -t tftp $eth0.serverip /mnt/tftp`` is executed.
+It will bring up the network device using :ref:`command_ifup` and mount a TFTP filesystem
+using :ref:`command_mount`.
+
+Usually the above automount command is executed from an init script in /env/init/automount.
+With the above, files on the TFTP server can be accessed without configuration::
+
+ cp /mnt/tftp/linuximage /image
+
+This automatically detects a USB mass storage device and mounts the first
+partition to /mnt/fat::
+
+ mkdir -p /mnt/fat
+ automount -d /mnt/fat 'usb && [ -e /dev/disk0.0 ] && mount /dev/disk0.0 /mnt/fat'
+
+To see a list of currently registered automountpoints use ``automount -l``.
diff --git a/Documentation/user/barebox.rst b/Documentation/user/barebox.rst
new file mode 100644
index 0000000..9eb34af
--- /dev/null
+++ b/Documentation/user/barebox.rst
@@ -0,0 +1,178 @@
+barebox
+=======
+
+Getting barebox
+---------------
+
+barebox is released on a monthly basis. The version numbers use the format
+YYYY.MM.N, so 2014.06.0 is the monthly release for June 2014. Stable releases
+are done as needed to fix critical problems and are indicated by incrementing
+the suffix (for example 2014.06.1).
+
+All releases can be downloaded from:
+
+http://www.barebox.org/download/
+
+Development versions of barebox are accessible via git. A local repository clone
+can be created using git::
+
+ git clone git://git.pengutronix.de/git/barebox.git
+ Cloning into 'barebox'...
+ remote: Counting objects: 113356, done.
+ remote: Compressing objects: 100% (25177/25177), done.
+ remote: Total 113356 (delta 87910), reused 111155 (delta 85935)
+ Receiving objects: 100% (113356/113356), 33.13 MiB | 183.00 KiB/s, done.
+ Resolving deltas: 100% (87910/87910), done.
+ Checking connectivity... done.
+ Checking out files: 100% (5651/5651), done.
+
+A web interface to the repository is available at
+http://git.pengutronix.de/?p=barebox.git.
+
+.. _configuration:
+
+Configuration
+-------------
+
+barebox uses Kconfig from the Linux Kernel as a configuration tool.
+All configuration is accessible via the 'make' command. Before running
+it you have to specify your architecture with the ARCH environment
+variable and the cross compiler with the CROSS_COMPILE environment
+variable. ARCH has to be one of:
+
+* arm
+* blackfin
+* mips
+* nios2
+* openrisc
+* ppc
+* sandbox
+* x86
+
+CROSS_COMPILE should be the prefix of your cross compiler. This can
+either contain the full path or, if the cross compiler binary is
+in your $PATH, just the prefix.
+
+Either export ARCH and CROSS_COMPILE once before working on barebox::
+
+ export ARCH=arm
+ export CROSS_COMPILE=/path/to/arm-cortexa8-linux-gnueabihf-
+ make ...
+
+or add them before each 'make' command::
+
+ ARCH=arm CROSS_COMPILE=/path/to/arm-cortexa8-linux-gnueabihf- make ...
+
+For readability, ARCH/CROSS_COMPILE are skipped from the following examples.
+
+Configuring for a board
+^^^^^^^^^^^^^^^^^^^^^^^
+
+All configuration files can be found under arch/$ARCH/configs/. For an
+overview type::
+
+ make help
+
+ ...
+ Architecture specific targets (mips):
+ No architecture specific help defined for mips
+
+ loongson-ls1b_defconfig - Build for loongson-ls1b
+ ritmix-rzx50_defconfig - Build for ritmix-rzx50
+ tplink-mr3020_defconfig - Build for tplink-mr3020
+ dlink-dir-320_defconfig - Build for dlink-dir-320
+ qemu-malta_defconfig - Build for qemu-malta
+
+barebox supports building for multiple boards with a single config. If you
+can't find your board in the list, it may be supported by one of the multi-board
+configs. As an example, this is the case for tegra_v7_defconfig and imx_v7_defconfig.
+Select your config with ``make <yourboard>_defconfig``::
+
+ make imx_v7_defconfig
+
+The configuration can be further customized with one of the configuration frontends
+with the most popular being ``menuconfig``::
+
+ make menuconfig
+
+Compilation
+-----------
+
+After barebox has been :ref:`configured <configuration>` it can be compiled::
+
+ make
+
+The resulting binary varies depending on the board barebox is compiled for.
+Without :ref:`multi_image` support the 'barebox-flash-image' link will point
+to the binary for flashing/uploading to the board. With :ref:`multi_image` support
+the compilation process will finish with a list of images built under images/::
+
+ images built:
+ barebox-freescale-imx51-babbage.img
+ barebox-genesi-efikasb.img
+ barebox-freescale-imx53-loco.img
+ barebox-freescale-imx53-loco-r.img
+ barebox-freescale-imx53-vmx53.img
+ barebox-tq-mba53-512mib.img
+ barebox-tq-mba53-1gib.img
+ barebox-datamodul-edm-qmx6.img
+ barebox-guf-santaro.img
+ barebox-gk802.img
+
+Starting barebox
+-----------------
+
+Bringing barebox to a board for the first time is highly board specific, see your
+board documentation for initial bringup.
+
+barebox binaries are, where possible, designed to be startable second stage from another
+bootloader. For example, if you have U-Boot running on your board, you can start barebox
+with U-Boot's 'go' command::
+
+ U-Boot: tftp $load_addr barebox.bin
+ U-Boot: go $load_addr
+
+With barebox already running on your board, this can be used to chainload another barebox::
+
+ bootm /mntf/tftp/barebox.bin
+
+At least ``barebox.bin`` (with :ref:`pbl` support enabled ``arch/$ARCH/pbl/zbarebox.bin``)
+should be startable second stage. The flash binary (``barebox-flash-image``) may or may not
+be startable second stage as it may have SoC specific headers which prevent running second
+stage.
+
+First Steps
+-----------
+
+This is a typical barebox startup log::
+
+ barebox 2014.06.0-00232-g689dc27-dirty #406 Wed Jun 18 00:25:17 CEST 2014
+
+
+ Board: Genesi Efika MX Smartbook
+ detected i.MX51 revision 3.0
+ mc13xxx-spi mc13892@00: Found MC13892 ID: 0x0045d0 [Rev: 2.0a]
+ m25p80 m25p800: sst25vf032b (4096 Kbytes)
+ ata0: registered /dev/ata0
+ imx-esdhc 70004000.esdhc: registered as 70004000.esdhc
+ imx-esdhc 70008000.esdhc: registered as 70008000.esdhc
+ imx-ipuv3 40000000.ipu: IPUv3EX probed
+ netconsole: registered as cs2
+ malloc space: 0xabe00000 -> 0xafdfffff (size 64 MiB)
+ mmc1: detected SD card version 2.0
+ mmc1: registered mmc1
+ barebox-environment environment-sd.7: setting default environment path to /dev/mmc1.barebox-environment
+ running /env/bin/init...
+
+ Hit any key to stop autoboot: 3
+
+ barebox@Genesi Efika MX Smartbook:/
+
+Without intervention, barebox will continue booting after 3 seconds. If interrupted
+by pressing a key, you will find yourself on the :ref:`shell <hush>`.
+
+On the shell type ``help`` for a list of supported commands. ``help <command>`` shows
+the usage for a particular command. barebox has tab completion which will complete
+your command. Arguments to commands are also completed depending on the command. If
+a command expects a file argument only files will be offered as completion. Other
+commands will only complete devices or devicetree nodes.
diff --git a/Documentation/user/booting-linux.rst b/Documentation/user/booting-linux.rst
new file mode 100644
index 0000000..561a850
--- /dev/null
+++ b/Documentation/user/booting-linux.rst
@@ -0,0 +1,267 @@
+.. _booting_linux:
+
+Booting Linux
+=============
+
+Introduction
+------------
+
+The basic boot command in barebox is :ref:`command_bootm`. This command
+can be used directly, but there is also a :ref:`command_boot` command
+which offers additional features like a boot sequence which tries to
+boot different entries until one succeeds.
+
+The bootm command
+-----------------
+
+The :ref:`command_bootm` command is the basic boot command. Depending on the
+architecture the bootm command handles different image types. On ARM the
+following images are supported:
+
+* ARM Linux zImage
+* U-Boot uImage
+* barebox images
+
+The images can either be passed directly to the bootm command as argument or
+in the ``global.bootm.image`` variable:
+
+.. code-block:: sh
+
+ bootm /path/to/zImage
+
+ # same as:
+
+ global.bootm.image=/path/to/zImage
+ bootm
+
+When barebox has an internal devicetree it is passed to the kernel. You can
+specify an alternative devicetree with the ``-o DTS`` option or the ``global.bootm.oftree``
+variable:
+
+.. code-block:: sh
+
+ bootm -o /path/to/dtb /path/to/zImage
+
+ # same as:
+
+ global.bootm.oftree=/path/to/dtb
+ global.bootm.image=/path/to/zImage
+ bootm
+
+**NOTE** It may happen that barebox is probed from the devicetree, but you have
+want to start a Kernel without passing a devicetree. In this case call ``oftree -f``
+to free the internal devicetree before calling ``bootm``
+
+Passing Kernel Arguments
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Depending on the barebox configuration (``CONFIG_FLEXIBLE_BOOTARGS``) there
+are to ways to pass bootargs to the Kernel. With ``CONFIG_FLEXIBLE_BOOTARGS``
+disabled the bootm command takes the bootargs from the ``bootargs`` environment
+variable. With ``CONFIG_FLEXIBLE_BOOTARGS`` enabled the bootargs are composed
+from different :ref:`global_device` variables. All variables beginning with
+``global.bootargs.`` will be concatenated to the bootargs:
+
+.. code-block:: sh
+
+ global linux.bootargs.base="console=ttyO0,115200"
+ global linux.bootargs.debug="earlyprintk ignore_loglevel"
+
+ bootm zImage
+
+ ...
+
+ Kernel command line: console=ttymxc0,115200n8 earlyprintk ignore_loglevel
+
+Additionally all variables starting with ``global.linux.mtdparts.`` are concatenated
+to a ``mtdparts=`` parameter to the kernel. This makes it possible to consistently
+partition devices with the :ref:`command_addpart` command and pass the same string as used
+with addpart to the Kernel:
+
+.. code-block:: sh
+
+ norparts="512k(bootloader),512k(env),4M(kernel),-(root)"
+ nandparts="1M(bootloader),1M(env),4M(kernel),-(root)"
+
+ global linux.mtdparts.nor0="physmap-flash.0:$norparts"
+ global linux.mtdparts.nand0="mxc_nand:$nandparts"
+
+ addpart /dev/nor0 $norparts
+ addpart /dev/nand0 $nandparts
+
+ ...
+
+ bootm zImage
+
+ ...
+
+ Kernel command line: mtdparts=physmap-flash.0:512k(bootloader),512k(env),4M(kernel),-(root);
+ mxc_nand:1M(bootloader),1M(env),4M(kernel),-(root)
+
+
+The boot command
+----------------
+
+The :ref:`command_boot` command offers additional convenience for the :ref:`command_bootm`
+command. It works with :ref:`boot_entries` and :ref:`bootloader_spec` entries. Boot entries
+are located under /env/boot/ and are scripts which setup the bootm variables so that the
+``boot`` command can run ``bootm`` without further arguments.
+
+.. _boot_entries:
+
+Boot entries
+^^^^^^^^^^^^
+
+A simple boot entry in ``/env/boot/mmc`` could look like this:
+
+.. code-block:: sh
+
+ #!/bin/sh
+
+ global.bootm.image=/mnt/mmc1/zImage
+ global.bootm.oftree=/env/oftree
+
+ global linux.bootargs.dyn.root="root=PARTUUID=deadbeef:01"
+
+This takes the kernel from ``/mnt/mmc1/zImage`` (which could be an
+:ref:`automount` path registered earlier). The devicetree will be used from
+``/env/oftree``. The Kernel gets the command line
+``root=PARTUUID=deadbeef:01``. Note the ``.dyn`` in the bootargs variable name.
+boot entries should always add Kernel command line parameters to variables with
+``.dyn`` in it. These will be cleared before booting different boot entries.
+This is done so that following boot entries do not leak command line
+parameters from the previous boot entries.
+
+This entry can be booted with ``boot mmc``. It can also be made the default by
+setting the ``global.boot.default`` variable to ``mmc`` and then calling
+``boot`` without arguments.
+
+.. _bootloader_spec:
+
+Bootloader Spec
+^^^^^^^^^^^^^^^
+
+barebox supports booting according to the bootloader spec:
+
+http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec/
+
+It follows another philosophy than the :ref:`boot_entries`. With Boot Entries
+booting is completely configured in the bootloader. Bootloader Spec Entries
+on the other hand the boot entries are on a boot medium. This gives a boot medium
+the possibility to describe where a Kernel is and what parameters it needs.
+
+All Bootloader Spec Entries are in a partition on the boot medium under ``/loader/entries/*.conf``.
+In the Bootloader Spec a boot medium has a dedicated partition to use for
+boot entries. barebox is less strict, it accepts Bootloader Spec Entries on
+every partition barebox can read.
+
+A Bootloader Spec Entry consists of key value pairs::
+
+ /loader/entries/6a9857a393724b7a981ebb5b8495b9ea-3.8.0-2.fc19.x86_64.conf:
+
+ title Fedora 19 (Rawhide)
+ version 3.8.0-2.fc19.x86_64
+ machine-id 6a9857a393724b7a981ebb5b8495b9ea
+ options root=UUID=6d3376e4-fc93-4509-95ec-a21d68011da2
+ linux /6a9857a393724b7a981ebb5b8495b9ea/3.8.0-2.fc19.x86_64/linux
+ initrd /6a9857a393724b7a981ebb5b8495b9ea/3.8.0-2.fc19.x86_64/initrd
+
+All pathes are absolute pathes in the partition. Bootloader Spec Entries can
+be created manually, but there also is the ``scripts/kernel-install`` tool to
+create/list/modify entries directly on a MMC/SD card or other media. To use
+it create a SD card / USB memory stick with a /boot partition with type 0xea.
+The partition can be formatted with FAT or EXT4 filesystem. If you wish to write
+to it from barebox later you must use FAT. The following creates a Bootloader
+Spec Entry on a SD card:
+
+.. code-block:: sh
+
+ scripts/kernel-install --device=/dev/mmcblk0 -a \
+ --machine-id=11ab7c89d02c4f66a4e2474ea25b2b84 --kernel-version="3.15" \
+ --kernel=/home/sha/linux/arch/arm/boot/zImage --add-root-option \
+ --root=/dev/mmcblk0p1 -o "console=ttymxc0,115200"
+
+The entry can be listed with the -l option:
+
+.. code-block:: sh
+
+ scripts/kernel-install --device=/dev/mmcblk0 -l
+
+ Entry 0:
+ title: Linux-3.15
+ version: 3.15
+ machine_id: 11ab7c89d02c4f66a4e2474ea25b2b84
+ options: console=ttymxc0,115200 root=PARTUUID=0007CB20-01
+ linux: 11ab7c89d02c4f66a4e2474ea25b2b84.15/linux
+
+When on barebox the SD card shows up as ``mmc`` then this entry can be booted with
+``boot mmc1`` or with setting ``global.boot.default`` to ``mmc1``.
+
+network boot
+------------
+
+With the following steps barebox can start the Kernel and root filesystem
+over network, a standard development case.
+
+Configure network: edit ``/env/network/eth0``. For a standard dhcp setup
+the following is enough:
+
+.. code-block:: sh
+
+ #!/bin/sh
+
+ ip=dhcp
+ serverip=192.168.23.45
+
+serverip is only necessary if it differs from the serverip offered from the dhcp server.
+A static ip setup can look like this:
+
+.. code-block:: sh
+
+ #!/bin/sh
+
+ ip=static
+ ipaddr=192.168.2.10
+ netmask=255.255.0.0
+ gateway=192.168.2.1
+ serverip=192.168.2.1
+
+Note that barebox will pass the same ip settings to the kernel, i.e. it passes
+``ip=$ipaddr:$serverip:$gateway:$netmask::eth0:`` for a static ip setup and
+``ip=dhcp`` for a dynamic dhcp setup.
+
+Adjust ``global.user`` and maybe ``global.hostname`` in ``/env/config``::
+
+ global.user=sha
+ global.hostname=efikasb
+
+Copy the kernel (and devicetree if needed) to the base dir of the TFTP server::
+
+ cp zImage /tftpboot/sha-linux-efikasb
+ cp myboard.dtb /tftpboot/sha-oftree-efikasb
+
+barebox will pass ``nfsroot=/home/${global.user}/nfsroot/${global.hostname}``
+This may be a link to another location on the NFS server. Make sure that the
+link target is exported from the server.
+
+``boot net`` will then start the Kernel.
+
+If the pathes or names are not suitable they can be adjusted in
+``/env/boot/net``:
+
+.. code-block:: sh
+
+ #!/bin/sh
+
+ path="/mnt/tftp"
+
+ global.bootm.image="${path}/${global.user}-linux-${global.hostname}"
+
+ oftree="${path}/${global.user}-oftree-${global.hostname}"
+ if [ -f "${oftree}" ]; then
+ global.bootm.oftree="$oftree"
+ fi
+
+ nfsroot="/home/${global.user}/nfsroot/${global.hostname}"
+ bootargs-ip
+ global.linux.bootargs.dyn.root="root=/dev/nfs nfsroot=$nfsroot,v3,tcp"
diff --git a/Documentation/user/defaultenv-2.rst b/Documentation/user/defaultenv-2.rst
new file mode 100644
index 0000000..fc3723e
--- /dev/null
+++ b/Documentation/user/defaultenv-2.rst
@@ -0,0 +1,113 @@
+Default environment version 2
+=============================
+
+barebox has its environment files under /env/. Most of the runtime configuration
+takes place under /env/. The environment is comparable to a tar archive which is
+unpacked from a storage medium during startup. If for whatever reason the environment
+cannot be loaded from a storage medium, a compiled-in default environment is used
+instead.
+
+The environment is not automatically stored on the storage medium when a file
+under /env/ is changed, instead this has to be done manually using the
+:ref:`command_saveenv` command.
+
+There are two sets of generic environment files which can be used. The older one
+should not be used for new boards and is not described here. New boards should use
+defaultenv-2 instead.
+
+The default environment is composed from different directories during compilation::
+
+ defaultenv/defaultenv-2-base -> base files
+ defaultenv/defaultenv-2-dfu -> overlay for DFU
+ defaultenv/defaultenv-2-menu -> overlay for menus
+ arch/$ARCH/boards/<board>/env -> board specific overlay
+
+The content of the above directories is applied one after another. If the
+same file exists in a later overlay, it will overwrite the preceding one.
+
+/env/bin/init
+-------------
+
+This script is executed by the barebox startup code after initialization.
+In the defaultenv-2 it will add some global variables and executes the scripts
+in /env/init/. It is also responsible for printing the boot timeout prompt.
+Be careful with changes to this script: since it is executed before any user
+intervention, it might lock the system.
+
+/env/init/
+----------
+
+/env/init/ is the place for startup scripts. The scripts in this directory
+will be executed in alphabetical order by the /env/bin/init script.
+
+/env/boot/
+----------
+
+/env/boot/ contains boot entry scripts. the :ref:`command_boot` command treats
+the files in this directory as possible boot targets. See :ref:`booting_linux`
+for more details.
+
+/env/config
+-----------
+
+This file contains some basic configuration settings. It can be edited using
+the :ref:`command_edit` command. Typical content:
+
+.. code-block:: sh
+
+ #!/bin/sh
+
+ # change network settings in /env/network/eth0
+ # change mtd partition settings and automountpoints in /env/init/*
+
+ #global.hostname=
+
+ # set to false if you do not want to have colors
+ #global.allow_color=true
+
+ # user (used for network filenames)
+ #global.user=none
+
+ # timeout in seconds before the default boot entry is started
+ #global.autoboot_timeout=3
+
+ # list of boot entries. These are executed in order until one
+ # succeeds. An entry can be:
+ # - a filename in /env/boot/
+ # - a full path to a directory. All files in this directory are
+ # treated as boot files and executed in alphabetical order
+ #global.boot.default=net
+
+ # base bootargs
+ #global.linux.bootargs.base="console=ttyS0,115200"
+
+When changing this file remember to do a ``saveenv`` to make the change
+persistent. Also it may be necessary to manually ``source /env/config`` before
+the changes take effect.
+
+/env/network/
+-------------
+
+This contains the configuration files for the network interfaces. Typically
+there will be a file ``eth0`` with a content like this:
+
+.. code-block:: sh
+
+ #!/bin/sh
+
+ # ip setting (static/dhcp)
+ ip=dhcp
+ global.dhcp.vendor_id=barebox-${global.hostname}
+
+ # static setup used if ip=static
+ ipaddr=
+ netmask=
+ gateway=
+ serverip=
+
+ # MAC address if needed
+ #ethaddr=xx:xx:xx:xx:xx:xx
+
+ # put code to discover eth0 (i.e. 'usb') to /env/network/eth0-discover
+
+ exit 0
diff --git a/Documentation/user/devicetree.rst b/Documentation/user/devicetree.rst
new file mode 100644
index 0000000..856ff6a
--- /dev/null
+++ b/Documentation/user/devicetree.rst
@@ -0,0 +1,84 @@
+.. _devicetree:
+
+Devicetree support
+==================
+
+Flattened Device Tree (FDT) is a data structure for describing the hardware on
+a system. On an increasing number of boards both barebox and the Linux Kernel can
+probe their devices directly from devicetrees. barebox needs the devicetree compiled
+into the binary. The Kernel usually does not have a devicetree compiled in, instead
+the Kernel expects to be passed a devicetree from the bootloader.
+
+From a bootloader's point of view, using devicetrees has the advantage that the
+same devicetree is used to probe both the Kernel and the Bootloader; this
+drastically reduces porting effort since the devicetree has to be written only
+once (and with luck somebody has already written a devicetree for the Kernel).
+Probing barebox from devicetree is highly recommended for new projects.
+
+.. _internal_devicetree:
+
+The internal devicetree
+-----------------------
+
+The devicetree barebox has been probed from plays a special role. It is referred to
+as the :ref:`internal_devicetree`. The barebox devicetree commands work on this
+devicetree. The devicetree source (DTS) files are kept in sync with the Kernel DTS
+files. As the FDT files are meant to be backward compatible, it should always be possible
+to start a Kernel with the barebox internal devicetree. However, since the barebox
+devicetree may not be complete or contain bugs it is always possible to start the
+Kernel with another devicetree than barebox has been started with.
+If a device has been probed from the devicetree then using the :ref:`command_devinfo`
+command on it will show the corresponding devicetree node:
+
+.. code-block:: sh
+
+ barebox@Phytec pcm970:/ devinfo 10002000.wdog
+ Resources:
+ num: 0
+ name: /soc/aipi@10000000/wdog@10002000
+ start: 0x10002000
+ size: 0x00001000
+ Driver: imx-watchdog
+ Bus: platform
+ Device node: /soc/aipi@10000000/wdog@10002000
+ wdog@10002000 {
+ compatible = "fsl,imx27-wdt", "fsl,imx21-wdt";
+ reg = <0x10002000 0x1000>;
+ interrupts = <0x1b>;
+ clocks = <0x1 0x4a>;
+ };
+
+Devicetree commands
+-------------------
+
+barebox has commands to show and manipulate devicetrees. These commands always
+work on the internal devicetree. It is possible to add/remove nodes using the
+:ref:`command_of_node` command and to add/change/remove properties using the
+:ref:`command_of_property` command. To dump devicetrees on the console use the
+:ref:`command_of_dump` command.
+
+.. code-block:: sh
+
+ # dump the whole devicetree
+ of_dump
+
+ # dump node of_dump /soc/nand@d8000000/
+ of_dump /soc/nand@d8000000/
+
+ # create a new node
+ of_node -c /chosen/mynode
+
+ # add a property to it
+ of_property -s /chosen/mynode/ myproperty myvalue
+
+It is important to know that these commands always work on the internal
+devicetree. If you modify the internal devicetree to influence the behaviour of
+a Kernel booted later, make sure that you start the kernel with the internal
+devicetree (i.e. don't pass a devicetree to the :ref:`command_bootm` command). If you
+wish to use another devicetree than the internal devicetree for starting the Kernel,
+you can exchange the internal devicetree during runtime:
+
+.. code-block:: sh
+
+ oftree -f
+ oftree -l /new/dtb
diff --git a/Documentation/user/driver-model.rst b/Documentation/user/driver-model.rst
new file mode 100644
index 0000000..2ec55f1
--- /dev/null
+++ b/Documentation/user/driver-model.rst
@@ -0,0 +1,91 @@
+Driver model
+============
+
+barebox has a driver model. This matches the devices on a board with their
+corresponding drivers. From a users point of view this is mostly visible in the
+:ref:`command_devinfo` and :ref:`command_drvinfo` command. Without arguments
+the :ref:`command_devinfo` command will show a hierarchical list of devices
+found on the board. As this may be instantiated from the :ref:`devicetree`
+there may be devices listed for which no driver is available. The
+:ref:`command_drvinfo` command shows a list of drivers together with the
+devices they handle.
+
+:ref:`command_devinfo` also shows a list of device files a device has registered::
+
+ `-- 70008000.esdhc
+ `-- mmc1
+ `-- 0x00000000-0x1d9bfffff ( 7.4 GiB): /dev/mmc1
+ `-- 0x00100000-0x040fffff ( 64 MiB): /dev/mmc1.0
+ `-- 0x04100000-0x240fffff ( 512 MiB): /dev/mmc1.1
+ `-- 0x24100000-0xe40fffff ( 3 GiB): /dev/mmc1.2
+ `-- 0xe4100000-0x1640fffff ( 2 GiB): /dev/mmc1.3
+ `-- 0x00080000-0x000fffff ( 512 KiB): /dev/mmc1.barebox-environment
+
+In this case the /dev/mmc1\* are handled by the mmc1 device. It must be noted
+that it's desirable that devices (mmc1) have the same name as the device files (/dev/mmc1\*),
+but this doesn't always have to be the case.
+
+Device detection
+----------------
+
+Some devices like USB or MMC may take a longer time to probe. Probing USB
+devices should not delay booting when USB may not even be used. This case is
+handled with device detection. The user visible interface to device detection
+is the :ref:`command_detect` command. ``detect -l`` shows a list of detectable
+devices::
+
+ barebox@Genesi Efika MX Smartbook:/ detect -l
+ 70004000.esdhc
+ 70008000.esdhc
+ 73f80000.usb
+ 73f80200.usb
+ 73f80400.usb
+ 83fe0000.pata
+ ata0
+ mmc0
+ mmc1
+ miibus0
+
+A particular device can be detected with ``detect <devname>``::
+
+ barebox@Genesi Efika MX Smartbook:/ detect 73f80200.usb
+ Found SMSC USB331x ULPI transceiver (0x0424:0x0006).
+ Bus 002 Device 004: ID 13d3:3273 802.11 n WLAN
+ mdio_bus: miibus0: probed
+ eth0: got preset MAC address: 00:1c:49:01:03:4b
+ Bus 002 Device 005: ID 0b95:7720 ZoWii
+ Bus 002 Device 002: ID 0424:2514
+ Bus 002 Device 001: ID 0000:0000 EHCI Host Controller
+
+For detecting all devices ``detect -a`` can be used.
+
+Device parameters
+-----------------
+
+Devices can have parameters which can be used to configure devices or to provide
+additional information for a device. The parameters can be listed with the
+:ref:`command_devinfo` command. A ``devinfo <devicename>`` will print the parameters
+of a device::
+
+ barebox@Genesi Efika MX Smartbook:/ devinfo eth0
+ Parameters:
+ ipaddr: 192.168.23.197
+ serverip: 192.168.23.1
+ gateway: 192.168.23.1
+ netmask: 255.255.0.0
+ ethaddr: 00:1c:49:01:03:4b
+
+The parameters can be used as shell variables::
+
+ eth0.ipaddr=192.168.23.15
+ echo "my current ip is: $eth0.ipaddr"
+
+device variables may have a type, so assigning wrong values may fail::
+
+ barebox@Genesi Efika MX Smartbook:/ eth0.ipaddr="This is not an IP"
+ set parameter: Invalid argument
+ barebox@Genesi Efika MX Smartbook:/ echo $?
+ 1
+
+**HINT** barebox has tab completion for variables. Typing ``eth0.<TAB><TAB>``
+will show the parameters for eth0.
diff --git a/Documentation/user/framebuffer.rst b/Documentation/user/framebuffer.rst
new file mode 100644
index 0000000..0065e7b
--- /dev/null
+++ b/Documentation/user/framebuffer.rst
@@ -0,0 +1,43 @@
+Framebuffer support
+===================
+
+barebox has support for framebuffer devices. Currently there is no console support
+for framebuffers, so framebuffer usage is limited to splash screens only. barebox
+supports BMP and PNG graphics using the :ref:`command_splash` command. barebox
+currently has no support for backlights, so unless there is a board specific enable
+hook for enabling a display it must be done manually with a script. Since barebox
+has nothing useful to show on the framebuffer it doesn't enable it during startup.
+A framebuffer can be enabled with the ``enable`` parameter of the framebuffer device:
+
+.. code-block:: sh
+
+ fb0.enable=1
+
+Some framebuffer devices support different resolutions. These can be configured
+with the ``mode_name`` parameter. See a list of supported modes using ``devinfo fb0``.
+A mode can only be changed when the framebuffer is disabled.
+
+A typical script to enable the framebuffer could look like this:
+
+.. code-block:: sh
+
+ #!/bin/sh
+
+ SPLASH=/path/to/mysplash.png
+
+ if [ ! -f $SPLASH ]; then
+ exit 0
+ fi
+
+ # first show splash
+ splash /path/to/mysplash.png
+
+ # enable framebuffer
+ fb0.enable=1
+
+ # wait for signals to become stable
+ msleep 100
+
+ # finally enable backlight
+ gpio_direction_output 42 1
+
diff --git a/Documentation/user/hush.rst b/Documentation/user/hush.rst
new file mode 100644
index 0000000..4a1b84b
--- /dev/null
+++ b/Documentation/user/hush.rst
@@ -0,0 +1,52 @@
+.. index:: hush shell
+
+.. _hush:
+
+hush shell
+==========
+
+barebox has an integrated shell: hush. This is a simple shell which
+is enough for writing simple shell scripts. Usage of the shell for
+scripts should not be overstrained. Often a command written in C is
+more flexible and also more robust than a complicated shell script.
+
+hush features
+-------------
+
+variables::
+
+ a="Hello user"
+ echo $a
+ Hello user
+
+conditional execution ``if`` / ``elif`` / ``else`` / ``fi``::
+
+ if [ ${foo} = ${bar} ]; then
+ echo "foo equals bar"
+ else
+ echo "foo and bar differ"
+ fi
+
+``for`` loops::
+
+ for i in a b c; do
+ echo $i
+ done
+
+``while`` loops::
+
+ while true; do
+ echo "endless loop"
+ done
+
+wildcard globbing::
+
+ ls d*
+ echo ???
+
+There is no support in hush for input/output redirection or pipes.
+Some commands work around this limitation with additional arguments. for
+example the :ref:`command_echo` command has the ``-a FILE`` option for appending
+a file and the ``-o FILE`` option for overwriting a file. The readline
+command requires a variable name as argument in which the line will be
+stored.
diff --git a/Documentation/user/introduction.rst b/Documentation/user/introduction.rst
new file mode 100644
index 0000000..8eb5860
--- /dev/null
+++ b/Documentation/user/introduction.rst
@@ -0,0 +1,27 @@
+Introduction
+============
+
+This is the barebox user manual. It describes how to configure, compile
+and run barebox on Embedded Systems.
+
+barebox (just barebox, not *the* barebox) is a bootloader designed for
+Embedded Systems. It runs on a variety of ARM, MIPS, PowerPC based SoCs.
+barebox aims to be a versatile and flexible bootloader, not only for
+booting Embedded Linux Systems but also for initial hardware bringup and
+development. barebox is highly configurable to be suitable as a full featured
+development binary to a lean production system. Just like busybox is the swiss
+army knife for Embedded Linux, barebox is the swiss army knife for bare metal,
+hence the name.
+
+Feedback
+--------
+
+For sending patches, asking for help and giving general feedback you are
+always welcome to write a mail to the barebox mailing list. Most of the
+discussion of barebox takes place here:
+
+http://lists.infradead.org/mailman/listinfo/barebox/
+
+There's also an IRC channel:
+
+IRC: #barebox (Freenode)
diff --git a/Documentation/user/memory-areas.rst b/Documentation/user/memory-areas.rst
new file mode 100644
index 0000000..dd1db9e
--- /dev/null
+++ b/Documentation/user/memory-areas.rst
@@ -0,0 +1,27 @@
+memory areas
+============
+
+Several barebox commands like :ref:`command_md`, erase or crc work on an area
+of memory. Areas have the following form::
+
+ <start>-<end>
+
+or::
+
+ <start>+<count>
+
+start, end and count are interpreted as decimal values if not prefixed with 0x.
+Additionally these can be postfixed with K, M or G for kilobyte, megabyte or
+gigabyte.
+
+Examples
+--------
+
+Display a hexdump from 0x80000000 to 0x80001000 (inclusive)::
+
+ md 0x80000000-0x80001000
+
+Display 1 kilobyte of memory starting at 0x80000000::
+
+ md 0x80000000+1k
+
diff --git a/Documentation/user/multi-image.rst b/Documentation/user/multi-image.rst
new file mode 100644
index 0000000..727b98f
--- /dev/null
+++ b/Documentation/user/multi-image.rst
@@ -0,0 +1,54 @@
+.. _multi_image:
+
+Multi Image Support
+===================
+
+Traditionally a single configuration only works for a single board. Sometimes
+even variants of a single board like different amount of memory require a new
+config. This has the effect that the number of defconfig files increases dramatically.
+All the configs have to be kept in sync manually. Multi Image Support solves this
+problem.
+
+With Multi Image Support binaries for multiple boards can be generated from a single
+config. A single board can only support compilation with or without Multi Image Support.
+Multi Image Support exposes several user visible changes:
+
+* In ``make menuconfig`` it becomes possible to select multiple boards instead of
+ only one.
+* The ``barebox-flash-image`` link is no longer generated since there is no single
+ binary to use anymore.
+* images are generated under images/. The build process shows all images generated
+ at the end of the build.
+
+Technical background
+--------------------
+
+With Multi Image Support enabled, the main barebox binary (barebox.bin) will be
+shared across different boards. For board specific code this means that it has
+to test whether it actually runs on the board it is designed for. Typically board
+specific code has this:
+
+.. code-block:: c
+
+ static int efikamx_init(void)
+ {
+ if (!of_machine_is_compatible("genesi,imx51-sb"))
+ return 0;
+
+ ... board specific code ...
+ }
+ device_initcall(efikamx_init);
+
+Multi Image Support always uses :ref:`PBL <pbl>` to generate compressed images.
+A board specific PBL image is prepended to the common barebox binary. The PBL
+image contains the devicetree which is passed to the common barebox binary to
+let the common binary determine the board type.
+
+The board specific PBL images are generated from a single set of object files
+using the linker. The basic trick here is that the PBL objects have multiple
+entry points, specified with the ENTRY_POINT macro. For each PBL binary
+generated a different entry point is selected using the ``-e`` option to ld.
+The linker will throw away all unused entry points and only keep the functions
+used by a particular entry point.
+
+The Multi Image PBL files can be disassembled with ``make <entry-function-name.pbl.S``
diff --git a/Documentation/user/networking.rst b/Documentation/user/networking.rst
new file mode 100644
index 0000000..23b0e46
--- /dev/null
+++ b/Documentation/user/networking.rst
@@ -0,0 +1,81 @@
+networking
+==========
+
+barebox has IPv4 networking support. Several protocols such as
+:ref:`command_dhcp`, :ref:`filesystems_nfs`, :ref:`command_tftp` are
+supported.
+
+Network configuration
+---------------------
+
+The first step for networking is configuring the network device. The network
+device is usually ``eth0``. The current configuration can be viewed with the
+:ref:`command_devinfo` command:
+
+.. code-block:: sh
+
+ barebox@Genesi Efika MX Smartbook:/ devinfo eth0
+ Parameters:
+ ipaddr: 192.168.23.197
+ serverip: 192.168.23.1
+ gateway: 192.168.23.1
+ netmask: 255.255.0.0
+ ethaddr: 00:1c:49:01:03:4b
+
+The configuration can be changed on the command line with:
+
+.. code-block:: sh
+
+ eth0.ipaddr=172.0.0.10
+
+The :ref:`command_dhcp` command will change the settings based on the answer
+from the DHCP server.
+
+This low level configuration of the network interface is often not necessary. Normally
+the network settings should be edited in ``/env/network/eth0``, then the network interface
+can be brought up using the :ref:`command_ifup` command.
+
+Network filesystems
+-------------------
+
+barebox supports NFS and TFTP as filesystem implementations. See :ref:`filesystems_nfs`
+and :ref:`filesystems_tftp` for more information. After the network device has been
+brought up a network filesystem can be mounted with:
+
+.. code-block:: sh
+
+ mount -t tftp 192.168.2.1 /mnt
+
+or
+
+.. code-block:: sh
+
+ mount -t nfs 192.168.2.1:/export none /mnt
+
+**NOTE** This can often be hidden behind the :ref:`command_automount` command to make
+mounting transparent to the user.
+
+Network console
+---------------
+
+barebox has a udp based network console. If enabled in the config, you will see
+something like this during startup:
+
+ registered netconsole as cs1
+
+By default the network console is disabled during runtime to prevent security
+risks. It can be enabled using:
+
+.. code-block:: sh
+
+ cs1.ip=192.168.23.2
+ cs1.active=ioe
+
+This will send udp packets to 192.168.23.2 on port 6666. On 192.168.23.2 the
+scripts/netconsole script can be used to control barebox:
+
+.. code-block:: sh
+
+ scripts/netconsole <board IP> 6666
+
+The netconsole can be used just like any other console.
diff --git a/Documentation/user/pbl.rst b/Documentation/user/pbl.rst
new file mode 100644
index 0000000..a08d6c9
--- /dev/null
+++ b/Documentation/user/pbl.rst
@@ -0,0 +1,31 @@
+.. _pbl:
+
+PreBootLoader images (PBL)
+==========================
+
+Traditionally barebox generates a raw uncompressed binary. PBL is an effort to
+create self extracting compressed images instead. This helps on some boards
+where storage space is sparse. Another usecase of PBL is on SoCs on which the
+ROM code loads the initial bootloader to (limited) SRAM. With self extracting
+binaries, more binary space becomes available.
+
+PBL is available for ARM and MIPS. It can be enabled in ``make menuconfig`` with
+the ``[*] Pre-Bootloader image`` option.
+
+The user visible difference is that with PBL support ``barebox.bin`` is no longer
+the final binary image, but instead ``arch/$ARCH/pbl/zbarebox.bin``. Use the
+``barebox-flash-image`` link which always points to the correct image.
+
+Technical background
+--------------------
+
+Normal object files are added to the make system using ``obj-y += file.o``.
+With PBL the build system recurses into the source directories a second
+time, this time all files specified with ``pbl-y += file.o`` are compiled.
+This way source code can be shared between regular barebox and PBL. A special
+case is ``lwl-y += file.o`` which expands to ``obj-y`` when PBL is disabled
+and to ``pbl-y`` when PBL is enabled.
+
+**HINT** For getting an overview over the binaries, disassemble barebox.bin
+(``make barebox.S``) with or without PBL support and also disassemble the
+PBL (``make arch/$ARCH/pbl/zbarebox.S``)
diff --git a/Documentation/user/system-setup.rst b/Documentation/user/system-setup.rst
new file mode 100644
index 0000000..35d6147
--- /dev/null
+++ b/Documentation/user/system-setup.rst
@@ -0,0 +1,64 @@
+System Setup
+============
+
+Serial Console Access
+---------------------
+
+As most current development machines don't have serial ports, the usual setup
+is to use a USB-Serial-Converter. Some evaluation boards have such a converter
+on board. After connecting, these usually show up on your host as
+``/dev/ttyUSB#`` or ``/dev/ttyACM#`` (check ``dmesg`` to find out).
+
+On Debian systems, the device node will be accessible to the ``dialout`` group,
+so adding your user to that group (``adduser <user> dialout``) removes the need
+for root privileges.
+
+Using the "screen" program
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The terminal manager ``screen`` can also be used as a simple terminal emulator::
+
+ screen /dev/ttyUSB0 115200
+
+To exit from ``screen``, press ``<CTRL-A> <K> <y>``.
+
+Using the "microcom" program
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+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;a=summary
+
+Usage is simple::
+
+ microcom -p /dev/ttyUSB0
+
+Network Access
+--------------
+
+Having network connectivity between your host and your target will save you a
+lot of time otherwise spent on writing SD cards or using JTAG. The main
+protocols used with barebox are DHCP, TFTP and NFS.
+
+Configuration of dnsmasq for DHCP and TFTP
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The ``dnsmasq`` program can be configured as a DHCP and TFTP server in addition
+to its original DNS functionality::
+
+ sudo ip addr add 192.168.23.1/24 dev <interface>
+ sudo ip link set <interface> up
+ sudo /usr/sbin/dnsmasq --interface=<interface> --no-daemon --log-queries \
+ --enable-tftp --tftp-root=<absolute-path-to-your-images>/ \
+ --dhcp-range=192.168.23.240,192.168.23.250
+
+Configuration of a TFTP Server
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Configuration of a BOOTP / DHCP Server
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Configuring a NFS Server
+^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/Documentation/user/ubi.rst b/Documentation/user/ubi.rst
new file mode 100644
index 0000000..a2e386f
--- /dev/null
+++ b/Documentation/user/ubi.rst
@@ -0,0 +1,138 @@
+UBI/UBIFS support
+=================
+
+barebox has both UBI and UBIFS support. For handling UBI barebox has commands similar to
+the Linux commands :ref:`command_ubiformat`, :ref:`command_ubiattach`, :ref:`command_ubidetach`,
+:ref:`command_ubimkvol` and :ref:`command_ubirmvol`.
+
+The following examples assume we work on the first UBI device. Replace ``ubi0`` with
+the appropriate number when you have multiple UBI devices.
+
+The first step for preparing a pristine Flash for UBI is to :ref:`command_ubiformat` the
+device:
+
+.. code-block:: sh
+
+ ubiformat /dev/nand0.root
+
+If you intend to use a device with UBI you should always use ``ubiformat`` instead of plain
+:ref:`command_erase`. ``ubiformat`` will make sure the erasecounters are preserved and also
+:ref:`ubi_fastmap` won't work when a flash is erased with ``erase``
+
+NOTE: When using the :ref:`ubi_fastmap` feature make sure that the UBI is attached and detached
+once after using ``ubiformat``. This makes sure the Fastmap is written.
+
+After a device has been formatted it can be attached with :ref:`command_ubiattach`.
+
+.. code-block:: sh
+
+ ubiattach /dev/nand0.root
+
+This will create the controlling node ``/dev/ubi0`` and also register all volumes present
+on the device as ``/dev/ubi0.<volname>``. When freshly formatted there won't be any volumes
+present. A volume can be created with:
+
+.. code-block:: sh
+
+ ubimkvol /dev/ubi0 root 0
+
+The first parameter is the controlling node. The second parameter is the name of the volume.
+In this case the volume can be found under ``/dev/ubi.root``. The third parameter contains
+the size. A size of zero means that all available space shall be used.
+
+The next step is to write a UBIFS image to the volume. The image must be created on a host using
+the ``mkfs.ubifs`` command. ``mkfs.ubifs`` requires several arguments for describing the
+flash layout. Values for these arguments can be retrieved from a ``devinfo ubi`` under barebox:
+
+.. code-block:: sh
+
+ barebox@Phytec pcm970:/ devinfo ubi0
+ Parameters:
+ peb_size: 16384
+ leb_size: 15360
+ vid_header_offset: 512
+ min_io_size: 512
+ sub_page_size: 512
+ good_peb_count: 3796
+ bad_peb_count: 4
+ max_erase_counter: 0
+ mean_erase_counter: 0
+ available_pebs: 3713
+ reserved_pebs: 83
+
+To build a UBIFS image for this device the following command is suitable:
+
+.. code-block:: sh
+
+ mkfs.ubifs --min-io-size=512 --leb-size=15360 --max-leb-cnt=4096 -r rootdir \
+ /tftpboot/root.ubifs
+
+The ``--max-leb-cnt`` parameter specifies the maximum number of logical erase blocks
+the UBIFS image can ever have. For this particular device a number of 3713 would be
+enough. If the image shall be used for multiple boards the maximim peb count of all
+boards must be used.
+
+The UBIFS image can be transferred to the board for example with TFTP:
+
+.. code-block:: sh
+
+ cp /mnt/tftp/root.ubifs /dev/ubi0.root
+
+Finally it can be mounted using the :ref:`command_mount` command:
+
+.. code-block:: sh
+
+ mkdir -p /mnt/ubi
+ mount -t ubifs /dev/ubi0.root /mnt/ubi
+
+The second time the UBIFS is mounted the above can be simplified to:
+
+.. code-block:: sh
+
+ ubiattach /dev/nand0.root
+ mount -t ubifs /dev/ubi0.root /mnt/ubi
+
+Mounting the UBIFS can also be made transparent with the automount command.
+With this helper script in ``/env/bin/automount-ubi:``:
+
+.. code-block:: sh
+
+ #!/bin/sh
+
+ if [ ! -e /dev/ubi0 ]; then
+ ubiattach /dev/nand0 || exit 1
+ fi
+
+ mount -t ubifs /dev/ubi0.root $automount_path
+
+
+The command ``automount -d /mnt/ubi/ '/env/bin/automount-ubi'`` will automatically
+attach the UBI device and mount the UBIFS image to ``/mnt/ubi`` whenever ``/mnt/ubi``
+is first accessed. The automount command can be added to ``/env/init/automount`` to
+execute it during startup.
+
+.. _ubi_fastmap:
+
+UBI Fastmap
+-----------
+
+When attaching UBI to a flash device the UBI code has to scan all eraseblocks on the
+flash. Since this can take some time the Fastmap feature has been introduced. It has
+been merged in Linux 3.7. barebox has support for the Fastmap feature, but to use
+it some care must be taken. The Fastmap feature reduces scanning time by adding
+informations to one of the first blocks of a flash. For technical details see
+http://www.linux-mtd.infradead.org/doc/ubi.html#L_fastmap. Since the Fastmap can
+only live near the beginning of a flash the Fastmap code relies on finding a free
+eraseblock there. The above example command make that sure, but Fastmap is incompatible
+with creating a UBI image on a host and directly flashing the UBI image to the
+raw NAND/NOR device. In this case the Fastmap code will not find a free eraseblock
+and the following message will occur during ``ubidetach``:
+
+.. code-block:: sh
+
+ UBI error: ubi_update_fastmap: could not find any anchor PEB
+ UBI warning: ubi_update_fastmap: Unable to write new fastmap, err=-28
+
+The Fastmap is first written after a ``ubidetach``, so it's important to attach/detach
+a UBI volume after using ``ubiformat``.
+
diff --git a/Documentation/user/updating.rst b/Documentation/user/updating.rst
new file mode 100644
index 0000000..0503e7d
--- /dev/null
+++ b/Documentation/user/updating.rst
@@ -0,0 +1,29 @@
+
+.. _update:
+
+Updating barebox
+================
+
+Updating barebox is potentially a dangerous task. When the update fails,
+the board may not start anymore and must be recovered. barebox has a special
+command to make updating barebox easier and safer: :ref:`command_barebox_update`.
+A board can register an update handler to the update command. The handler can
+do additional checks before trying an update, e.g. it's possible
+to check whether the new image actually is a barebox image.
+
+Updating barebox can be as easy as::
+
+ barebox_update /path/to/new/barebox.img
+
+Multiple handlers can be registered to the update mechanism. Usually the device
+barebox has been started from is registered as default (marked with a ``*``)::
+
+ barebox@Genesi Efika MX Smartbook:/ barebox_update -l
+ registered update handlers:
+ * mmc -> /dev/mmc1
+ spinor -> /dev/m25p0
+
+:ref:`command_barebox_update` requires board support, so it may not be
+available for your board. It is recommended to implement it, but you can also
+update barebox manually using :ref:`command_erase` and :ref:`command_cp`
+commands. The exact commands are board specific.
diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
new file mode 100644
index 0000000..9bbfcca
--- /dev/null
+++ b/Documentation/user/usb.rst
@@ -0,0 +1,65 @@
+USB support
+===========
+
+USB host support
+----------------
+
+barebox has support for USB host and USB device mode. USB devices
+take a long time to probe, so they are not probed automatically. Probing
+has to be triggered using the :ref:`command_usb` or :ref:`command_detect` command.
+USB devices in barebox are not hotpluggable. It is expected that USB
+devices are not disconnected while barebox is running.
+
+USB Networking
+^^^^^^^^^^^^^^
+
+barebox supports ASIX compatible devices and the SMSC95xx. After
+detection the device shows up as eth0 and can be used like a regular network
+device.
+
+To use a USB network device together with the :ref:`command_ifup` command, add the
+following to /env/network/eth0-discover:
+
+.. code-block:: sh
+
+ #!/bin/sh
+
+ usb
+
+USB mass storage
+^^^^^^^^^^^^^^^^
+
+barebox supports USB mass storage devices. After probing them with the :ref:`command_usb`
+they show up as ``/dev/diskx`` and can be used like any other device.
+
+USB device support
+------------------
+
+DFU
+^^^
+
+USB Device Firmware Upgrade (DFU) is an official USB device class specification of the USB
+Implementers Forum. It provides a vendor independent way to update the firmware of embedded
+devices. The current specification is version 1.1 and can be downloaded here:
+http://www.usb.org/developers/devclass_docs/DFU_1.1.pdf
+
+On barebox side the update is handled with the :ref:`command_dfu` command. It is passes a list
+of partitions to provide to the host. The partition list has the form ``<file>(<name>)<flags>``.
+``file`` is the path to the device or regular file which shall be updated. ``name`` is the
+name under which the partition shall be provided to the host. For the possible ``flags`` see
+:ref:`command_dfu`. A typical ``dfu`` command could look like this:
+
+.. code-block:: sh
+
+ dfu "/dev/nand0.barebox.bb(barebox)sr,/dev/nand0.kernel.bb(kernel)r,/dev/nand0.root.bb(root)r"
+
+On the host the tool `dfu-util <http://dfu-util.gnumonks.org/>`_ can be used to update the
+partitions. It is available for the most distributions. To update the Kernel for the above
+example the following can be used:
+
+.. code-block:: sh
+
+ dfu-util -D arch/arm/boot/zImage -a kernel
+
+The dfu-util command automatically finds dfu capable devices. If there are multiple devices
+found it has to be specified with the ``-d``/``-p`` options.
diff --git a/Documentation/user/user-manual.rst b/Documentation/user/user-manual.rst
new file mode 100644
index 0000000..4e2a250
--- /dev/null
+++ b/Documentation/user/user-manual.rst
@@ -0,0 +1,33 @@
+.. highlight:: console
+
+barebox user manual
+===================
+
+Contents:
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ introduction
+ system-setup
+ barebox
+ networking
+ automount
+ memory-areas
+ driver-model
+ hush
+ defaultenv-2
+ variables
+ updating
+ devicetree
+ pbl
+ multi-image
+ framebuffer
+ usb
+ ubi
+ booting-linux
+
+* :ref:`search`
+* :ref:`genindex`
+
diff --git a/Documentation/user/variables.rst b/Documentation/user/variables.rst
new file mode 100644
index 0000000..04e1791
--- /dev/null
+++ b/Documentation/user/variables.rst
@@ -0,0 +1,49 @@
+Configuration variables
+=======================
+
+.. _global_device:
+
+The ``global`` device
+---------------------
+
+The ``global`` device is a special purpose device. It only exists as a
+storage for global variables. Some global variables are created internally
+in barebox (see :ref:`magicvars`). Additional variables can be created with
+the :ref:`command_global` command::
+
+ global myvar
+
+This creates the ``global.myvar`` variable which now can be used like any
+other variable. You can also directly assign a value during creation::
+
+ global myvar1=foobar
+
+**NOTE** creating a variable with ``global myvar1=foobar`` looks very similar
+to assigning a value with ``global.myvar1=foobar``, but the latter fails when
+a variable has not been created before.
+
+.. _magicvars:
+
+Magic variables
+---------------
+
+Some variables have special meanings and influence the behaviour
+of barebox. Most but not all of them are consolidated in the :ref:`global_device`
+Since it's hard to remember which variables these are and if the current
+barebox has support for them the :ref:`command_magicvar` command can print a list
+of all variables with special meaning along with a short description::
+
+ barebox@Genesi Efika MX Smartbook:/ magicvar
+ OPTARG optarg for hush builtin getopt
+ PATH colon separated list of pathes to search for executables
+ PS1 hush prompt
+ armlinux_architecture ARM machine ID
+ armlinux_system_rev ARM system revision
+ armlinux_system_serial ARM system serial
+ automount_path mountpath passed to automount scripts
+ bootargs Linux Kernel parameters
+ bootsource The source barebox has been booted from
+ bootsource_instance The instance of the source barebox has been booted from
+ global.boot.default default boot order
+ ...
+
diff --git a/Makefile b/Makefile
index e7e1679..6dad637 100644
--- a/Makefile
+++ b/Makefile
@@ -1076,8 +1076,7 @@ help:
@echo ' enough build support to build external modules'
@echo ' mrproper - Remove all generated files + config + various backup files'
@echo ' distclean - mrproper + remove editor backup and patch files'
- @echo ' docs - start doxygen for all output types (only HTML - FIXME)'
- @echo ' htmldocs - create documentation in HTML format'
+ @echo ' docs - build documentation
@echo ''
@echo 'Configuration targets:'
@$(MAKE) -f $(srctree)/scripts/kconfig/Makefile help
@@ -1125,6 +1124,14 @@ quiet_cmd_tags = GEN $@
tags TAGS cscope: FORCE
$(call cmd,tags)
+SPHINXBUILD = sphinx-build
+ALLSPHINXOPTS = source
+
+docs: FORCE
+ @mkdir -p $(srctree)/Documentation/commands
+ @$(srctree)/Documentation/gen_commands.py $(srctree) $(srctree)/Documentation/commands
+ @$(SPHINXBUILD) -b html -d $(objtree)/doctrees $(srctree)/Documentation \
+ $(objtree)/Documentation/html
endif #ifeq ($(config-targets),1)
endif #ifeq ($(mixed-targets),1)
--
2.0.0
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread* Re: New Documentation for barebox
2014-06-26 8:51 New Documentation for barebox Sascha Hauer
` (6 preceding siblings ...)
2014-06-26 8:51 ` [PATCH 7/7] Documentation: Add new sphinxs docs Sascha Hauer
@ 2014-06-26 9:02 ` Holger Schurig
2014-06-26 9:09 ` Sascha Hauer
2014-06-26 9:36 ` Holger Schurig
` (3 subsequent siblings)
11 siblings, 1 reply; 19+ messages in thread
From: Holger Schurig @ 2014-06-26 9:02 UTC (permalink / raw)
To: Sascha Hauer; +Cc: barebox
Hi,
nice !
I merged remotes/origin/doc into my local checkout of
remotes/origin/next and did "make docs". I got one warning:
schurig@laptop:~/d/mkarm/barebox$ make docs
Making output directory...
Running Sphinx v1.1.2
loading pickled environment... not yet created
building [html]: targets for 204 source files that are out of date
updating environment: 204 added, 0 changed, 0 removed
reading sources... [100%] user/variables
/home/schurig/d/mkarm/barebox/Documentation/devicetree/index.rst:6:
WARNING: toctree glob pattern u'bindings/barebox/*' didn't match any
documents
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] user/variables
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 1 warning.
and in fact, there is no Documentation/devicetree/bindings/barebox
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread* Re: New Documentation for barebox
2014-06-26 9:02 ` New Documentation for barebox Holger Schurig
@ 2014-06-26 9:09 ` Sascha Hauer
0 siblings, 0 replies; 19+ messages in thread
From: Sascha Hauer @ 2014-06-26 9:09 UTC (permalink / raw)
To: Holger Schurig; +Cc: barebox
On Thu, Jun 26, 2014 at 11:02:56AM +0200, Holger Schurig wrote:
> Hi,
>
> nice !
>
>
> I merged remotes/origin/doc into my local checkout of
> remotes/origin/next and did "make docs". I got one warning:
>
> schurig@laptop:~/d/mkarm/barebox$ make docs
> Making output directory...
> Running Sphinx v1.1.2
> loading pickled environment... not yet created
> building [html]: targets for 204 source files that are out of date
> updating environment: 204 added, 0 changed, 0 removed
> reading sources... [100%] user/variables
> /home/schurig/d/mkarm/barebox/Documentation/devicetree/index.rst:6:
> WARNING: toctree glob pattern u'bindings/barebox/*' didn't match any
Oops, it was ignored because it matches a pattern in .gitignore. Try
again, I just fixed it.
Sascha
--
Pengutronix e.K. | |
Industrial Linux Solutions | http://www.pengutronix.de/ |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: New Documentation for barebox
2014-06-26 8:51 New Documentation for barebox Sascha Hauer
` (7 preceding siblings ...)
2014-06-26 9:02 ` New Documentation for barebox Holger Schurig
@ 2014-06-26 9:36 ` Holger Schurig
2014-06-26 18:17 ` Sascha Hauer
2014-06-26 9:54 ` Holger Schurig
` (2 subsequent siblings)
11 siblings, 1 reply; 19+ messages in thread
From: Holger Schurig @ 2014-06-26 9:36 UTC (permalink / raw)
To: Sascha Hauer; +Cc: barebox
Some random annotations. Please comment, after feedback I'll provide a
bunch of patches for this. I don't do the patches right away, because
you may still work currently in that area, so it would only produce
conflicts.
User manuel "2. System setup" should be in an appendix. Nothing here
is really related to barebox itself. It contains just helpful hints.
I would capitalize some headlines, e.g. in the user manual "3.
Barebox", "4. Networking", "6. Memory areas" etc The same for the
two headlines starting in lower-case in the main index.html. Maybe "3.
barebox" can stay lowercase, because barebox is an "Eigenname", dunno.
It looks however a bit ugly when it's lowercase.
After getting barebox there should be a brief mention of the branches,
e.g. difference between next & master.
Configuration: at "make menuconfig" also "make xconfig" should be mentioned.
"3.3. Compilation", shouldn't it be "make ARCH=xxx" ? Ha, maybe it's
just an old habit of me ...
"3.4 Starting Barebox" could get a link to the i.MX USB downloader.
Very fine tool!
"4.2. Network filesystems": hinting on automount for tftp-file system
is a bit moot. Because at the "mount -t tftp AAA BBB" nothing happens,
tftp is, so to say, an automount by itself. I haven't yet used NFS
from barebox, but I guess it is the same there. So I'd remove the
automount reference from this place completely.
"5. Automount", the same, better use sdcard as an example,. not tftp.
"7.2. Device parameters": Better write "HINT: barebox has ..." (e.g.
with a colon). The same applies to the "NOTE" annotations.
"8.1 Hush features" should "let X=$A/2" be there? Many people (ok, it
was just me) look there if they need to calculate in the shell after
finding out that X=$(($A/2)) doesn't work ...
"10. Configuration variable": this should be neared the device
parameters. I'd add a hint that with "devinfo global" one can see all
defined global variables.
several places: the "barebox@Genesi Efika MX Smartbook:/" should be
reduced to "barebox:/", as it is usually irrelevant if that example
was done on an Efika board or not.
"11. Updating barebox", it says that a board can register an update
handler, but doesn't have an example or a link to where / how this
could be done. Or even a link directly to the git tree with a working
example.
"13. Prebootloader": the sentence "Use the barebox-flash-image link
which always points to the correct image" doesn't sound like proper
english.
Abbreviation should be capizalized as well, therefore headline "ram
filesystem" -> "RAM filesystem"
I think that in english one should write "file systems", not
"filesystems". But i may be wrong. But I'm quite sure that the word
"filesystemtype" (in the RAM file system chapter) is too long for any
englishman :-)
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread* Re: New Documentation for barebox
2014-06-26 9:36 ` Holger Schurig
@ 2014-06-26 18:17 ` Sascha Hauer
0 siblings, 0 replies; 19+ messages in thread
From: Sascha Hauer @ 2014-06-26 18:17 UTC (permalink / raw)
To: Holger Schurig; +Cc: barebox
On Thu, Jun 26, 2014 at 11:36:15AM +0200, Holger Schurig wrote:
> Some random annotations. Please comment, after feedback I'll provide a
> bunch of patches for this. I don't do the patches right away, because
> you may still work currently in that area, so it would only produce
> conflicts.
>
>
> User manuel "2. System setup" should be in an appendix. Nothing here
> is really related to barebox itself. It contains just helpful hints.
Ok.
>
> I would capitalize some headlines, e.g. in the user manual "3.
> Barebox", "4. Networking", "6. Memory areas" etc The same for the
> two headlines starting in lower-case in the main index.html. Maybe "3.
> barebox" can stay lowercase, because barebox is an "Eigenname", dunno.
> It looks however a bit ugly when it's lowercase.
I usually write barebox with a small 'b' even at the beginning of a
sentence, but you're right with the other headlines, they should start
with a capital letter.
>
> After getting barebox there should be a brief mention of the branches,
> e.g. difference between next & master.
Very good. I thought that aswell, but forgot to write it.
>
> Configuration: at "make menuconfig" also "make xconfig" should be mentioned.
make nconfig aswell?
>
> "3.3. Compilation", shouldn't it be "make ARCH=xxx" ? Ha, maybe it's
> just an old habit of me ...
>
> "3.4 Starting Barebox" could get a link to the i.MX USB downloader.
> Very fine tool!
This is already in Documentation/boards/imx.rst where I think is a
better place.
>
> "4.2. Network filesystems": hinting on automount for tftp-file system
> is a bit moot. Because at the "mount -t tftp AAA BBB" nothing happens,
> tftp is, so to say, an automount by itself. I haven't yet used NFS
> from barebox, but I guess it is the same there. So I'd remove the
> automount reference from this place completely.
I never thought about tftp being an automount by itself, but you are
right. NFS is different though, it really does network transfers during
mounting.
>
> "5. Automount", the same, better use sdcard as an example,. not tftp.
Ok.
>
> "7.2. Device parameters": Better write "HINT: barebox has ..." (e.g.
> with a colon). The same applies to the "NOTE" annotations.
Have you looked what is rendered with a colon? (I haven't)
>
> "8.1 Hush features" should "let X=$A/2" be there? Many people (ok, it
> was just me) look there if they need to calculate in the shell after
> finding out that X=$(($A/2)) doesn't work ...
Sounds good.
>
> "10. Configuration variable": this should be neared the device
> parameters. I'd add a hint that with "devinfo global" one can see all
> defined global variables.
>
> several places: the "barebox@Genesi Efika MX Smartbook:/" should be
> reduced to "barebox:/", as it is usually irrelevant if that example
> was done on an Efika board or not.
Agreed. That was just the prompt I copy/pasted, but right, it should be
reduced.
>
> "11. Updating barebox", it says that a board can register an update
> handler, but doesn't have an example or a link to where / how this
> could be done. Or even a link directly to the git tree with a working
> example.
That would be something for a developer manual, but ok, a git link
should do it for now.
>
> "13. Prebootloader": the sentence "Use the barebox-flash-image link
> which always points to the correct image" doesn't sound like proper
> english.
I am open for better suggestions. I tend to stand in my own way when I
think about a sentence for too long ;)
>
>
> Abbreviation should be capizalized as well, therefore headline "ram
> filesystem" -> "RAM filesystem"
Yes.
>
> I think that in english one should write "file systems", not
> "filesystems". But i may be wrong. But I'm quite sure that the word
> "filesystemtype" (in the RAM file system chapter) is too long for any
> englishman :-)
You're probably right ;)
Sascha
--
Pengutronix e.K. | |
Industrial Linux Solutions | http://www.pengutronix.de/ |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: New Documentation for barebox
2014-06-26 8:51 New Documentation for barebox Sascha Hauer
` (8 preceding siblings ...)
2014-06-26 9:36 ` Holger Schurig
@ 2014-06-26 9:54 ` Holger Schurig
2014-06-26 10:01 ` Lucas Stach
2014-06-26 10:28 ` Antony Pavlov
2014-06-26 10:31 ` Robert P. J. Day
11 siblings, 1 reply; 19+ messages in thread
From: Holger Schurig @ 2014-06-26 9:54 UTC (permalink / raw)
To: Sascha Hauer; +Cc: barebox
Oh, and I just noticed that two chapters "Getting barebox" are contained:
1. Getting barebox
3.1. Getting barebox
I'd also think that long-term the "user manual" thingy inside the
documention could vanish. Everything could/should/is the user manual,
or?
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread* Re: New Documentation for barebox
2014-06-26 9:54 ` Holger Schurig
@ 2014-06-26 10:01 ` Lucas Stach
2014-06-26 10:11 ` Holger Schurig
0 siblings, 1 reply; 19+ messages in thread
From: Lucas Stach @ 2014-06-26 10:01 UTC (permalink / raw)
To: Holger Schurig; +Cc: barebox
Am Donnerstag, den 26.06.2014, 11:54 +0200 schrieb Holger Schurig:
> Oh, and I just noticed that two chapters "Getting barebox" are contained:
>
> 1. Getting barebox
> 3.1. Getting barebox
>
> I'd also think that long-term the "user manual" thingy inside the
> documention could vanish. Everything could/should/is the user manual,
> or?
>
No, we would like to clearly separate user docs as in how to get barebox
running on a board and what to do in the shell from developer docs that
explain some of the concepts and design decisions of the actual code.
Regards,
Lucas
--
Pengutronix e.K. | Lucas Stach |
Industrial Linux Solutions | http://www.pengutronix.de/ |
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: New Documentation for barebox
2014-06-26 10:01 ` Lucas Stach
@ 2014-06-26 10:11 ` Holger Schurig
0 siblings, 0 replies; 19+ messages in thread
From: Holger Schurig @ 2014-06-26 10:11 UTC (permalink / raw)
To: Lucas Stach; +Cc: barebox
> No, we would like to clearly separate user docs
But still it is unfortunate that two "Getting Barebox" chapters are
there at all, and that they are very near to each.
Also, I think that (necessarily!) the design desicions are now mostly
in the user manual, e.g. device parameters. In the non-user-manual
parts there is hardly contents at all. And most, e.g. the file system
descriptions or the glossary, could very well be moved into the user
manual. Which will lead us to ... the user-manual containing all of
the current HTML docs.
So, let me rephrase it: I also think that long term the whole current
(!) HTML documentation should be part of the user manual.
Simply because there's no developer documentation in the current (!)
HTML, e.g. "How to start a new board" type docs, or an introduction
into the file system structure.
Maybe the PBL chapter is developer documentation, but that is (sic!)
in the user manual ...
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: New Documentation for barebox
2014-06-26 8:51 New Documentation for barebox Sascha Hauer
` (9 preceding siblings ...)
2014-06-26 9:54 ` Holger Schurig
@ 2014-06-26 10:28 ` Antony Pavlov
2014-06-26 15:36 ` Sascha Hauer
2014-06-26 10:31 ` Robert P. J. Day
11 siblings, 1 reply; 19+ messages in thread
From: Antony Pavlov @ 2014-06-26 10:28 UTC (permalink / raw)
To: Sascha Hauer; +Cc: barebox
On Thu, 26 Jun 2014 10:51:31 +0200
Sascha Hauer <s.hauer@pengutronix.de> wrote:
> Hi all,
>
> I am happy to announce new documentation for barebox.
Aghhhh!
All my mips documentation have gone away!
I'm ready to convert old dox-files to new rst-files by myself,
but I need some recomendations.
Could I put rst mips files into Documentation/boards/mips?
> The following series removes the in-tree documentation and replaces
> it with completely rewritten sphinxs based documentation. As of now
> we have a more or less complete user manual. There surely is room
> for improvements but we think that it is good enough already and
> surely better than what we have now.
>
> The documentation is written with Sphinx. Sphinx is
> the Python Documentation Generator, see http://sphinx-doc.org/.
> The files are written in reStructuredText, a format which is
> sufficiently easy to write and nice to read even in sourcecode
> format.
>
> Thank you Jan, Lukas and Jochen for help writing documentation and
> fixing typos.
>
> `make docs` will generate static html files. The plan is to replace
> the existing Wiki Documentation with these files. Florian is currently
> writing template files to make the pages look nice and not-so-standard.
>
> Comments and reviews are very welcome.
>
> Sascha
>
> The following changes since commit bbc70303c7166dbe8e72ea12fdc486c28a60c302:
>
> kernel-install: fix return value check for getline (2014-06-26 09:44:47 +0200)
>
> are available in the git repository at:
>
> git://git.pengutronix.de/git/barebox.git doc
>
> for you to fetch changes up to f77fa0cc6de9c9a26e492016e67b0fdfc2039f91:
>
> Documentation: Add new sphinxs docs (2014-06-26 10:12:32 +0200)
>
> ----------------------------------------------------------------
> Jan Luebbe (2):
> ubiformat: avoid macros in help text
> automount: fix description typo
>
> Sascha Hauer (5):
> commands: addpart: Improve description
> Documentation: remove doxygen documentation
> Documentation: remove remaining documentation
> Documentation: remove devicetree docs
> Documentation: Add new sphinxs docs
>
> Documentation/.gitignore | 1 +
> Documentation/barebox-main.dox | 126 --
> Documentation/board.dox | 94 --
> Documentation/boards.dox | 74 --
> Documentation/boards.rst | 10 +
> Documentation/boards/cirrus-logic.rst | 9 +
> .../boards/edb9xxx/cirrus_logic_edb9301.rst | 10 +
> .../boards/edb9xxx/cirrus_logic_edb9302.rst | 10 +
> .../boards/edb9xxx/cirrus_logic_edb9302a.rst | 10 +
> .../boards/edb9xxx/cirrus_logic_edb9307.rst | 13 +
> .../boards/edb9xxx/cirrus_logic_edb9307a.rst | 13 +
> .../boards/edb9xxx/cirrus_logic_edb9312.rst | 13 +
> .../boards/edb9xxx/cirrus_logic_edb9315.rst | 13 +
> .../boards/edb9xxx/cirrus_logic_edb9315a.rst | 12 +
> Documentation/boards/imx.rst | 103 ++
> Documentation/boards/imx/Garz-Fricke-Cupid.rst | 9 +
> Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst | 38 +
> Documentation/boards/imx/eukrea_cpuimx27.rst | 11 +
> Documentation/boards/imx/synertronixx_scb9328.rst | 12 +
> Documentation/boards/mxs/Chumby-Falconwing.rst | 46 +
> Documentation/boards/mxs/Freescale-i.MX23-evk.rst | 28 +
> Documentation/boards/mxs/KaRo-TX28.rst | 48 +
> Documentation/boards/omap.rst | 40 +
> Documentation/boards/s3c/Digi-a9m2440.rst | 67 +
> Documentation/boards/samsung.rst | 9 +
> Documentation/boards/sandbox.rst | 67 +
> Documentation/boards/tegra.rst | 102 ++
> Documentation/boards/x86.rst | 128 ++
> Documentation/building.dox | 60 -
> Documentation/commands.dox | 111 --
> Documentation/commands.rst | 9 +
> Documentation/conf.py | 262 ++++
> Documentation/console.txt | 13 -
> Documentation/developers_manual.dox | 24 -
> Documentation/devices_drivers.txt | 72 --
> Documentation/devicetree/bindings/barebox.txt | 10 -
> .../bindings/barebox/barebox,environment.txt | 25 -
> .../bindings/leds/{common.txt => common.rst} | 3 +-
> .../misc/{fsl,imx-iim.txt => fsl,imx-iim.rst} | 13 +-
> .../misc/{fsl,imx-ocotp.txt => fsl,imx-ocotp.rst} | 13 +-
> Documentation/devicetree/index.rst | 13 +
> Documentation/download.rst | 16 +
> Documentation/filesystems.rst | 10 +
> Documentation/filesystems/fat.rst | 15 +
> Documentation/filesystems/nfs.rst | 12 +
> Documentation/filesystems/ramfs.rst | 10 +
> Documentation/filesystems/tftp.rst | 16 +
> Documentation/first_steps.dox | 61 -
> Documentation/gen_commands.py | 164 +++
> Documentation/glossary.rst | 18 +
> Documentation/index.rst | 26 +
> Documentation/manual_org.dox | 27 -
> Documentation/omap4_usb_booting.txt | 27 -
> Documentation/porting.txt | 115 --
> Documentation/timekeeping.txt | 13 -
> Documentation/user/automount.rst | 34 +
> Documentation/user/barebox.rst | 178 +++
> Documentation/user/booting-linux.rst | 267 ++++
> Documentation/user/defaultenv-2.rst | 113 ++
> Documentation/user/devicetree.rst | 84 ++
> Documentation/user/driver-model.rst | 91 ++
> Documentation/user/framebuffer.rst | 43 +
> Documentation/user/hush.rst | 52 +
> Documentation/user/introduction.rst | 27 +
> Documentation/user/memory-areas.rst | 27 +
> Documentation/user/multi-image.rst | 54 +
> Documentation/user/networking.rst | 81 ++
> Documentation/user/pbl.rst | 31 +
> Documentation/user/system-setup.rst | 64 +
> Documentation/user/ubi.rst | 138 +++
> Documentation/user/updating.rst | 29 +
> Documentation/user/usb.rst | 65 +
> Documentation/user/user-manual.rst | 33 +
> Documentation/user/variables.rst | 49 +
> Documentation/users_manual.dox | 18 -
> Doxyfile | 1310 --------------------
> Makefile | 21 +-
> arch/architecture.dox | 175 ---
> arch/arm/boards/a9m2410/a9m2410.c | 68 -
> arch/arm/boards/a9m2440/a9m2440.c | 79 --
> arch/arm/boards/beagle/board.c | 31 -
> arch/arm/boards/ccxmx51/ccxmx51.dox | 7 -
> arch/arm/boards/chumby_falconwing/falconwing.c | 138 ---
> arch/arm/boards/edb93xx/edb93xx.dox | 108 --
> .../arm/boards/eukrea_cpuimx27/eukrea_cpuimx27.dox | 11 -
> .../arm/boards/eukrea_cpuimx35/eukrea_cpuimx35.dox | 4 -
> .../arm/boards/eukrea_cpuimx51/eukrea_cpuimx51.dox | 4 -
> arch/arm/boards/freescale-mx21-ads/imx21ads.dox | 5 -
> arch/arm/boards/freescale-mx23-evk/mx23-evk.c | 32 -
> arch/arm/boards/freescale-mx27-ads/imx27ads.dox | 5 -
> arch/arm/boards/freescale-mx35-3ds/3stack.dox | 4 -
> .../arm/boards/freescale-mx51-babbage/mx51-pdk.dox | 4 -
> arch/arm/boards/freescale-mx53-qsb/mx53-pdk.dox | 4 -
> arch/arm/boards/freescale-mx53-smd/mx53-smd.dox | 4 -
> arch/arm/boards/friendlyarm-mini2440/mini2440.c | 159 ---
> arch/arm/boards/guf-cupid/cupid.dox | 9 -
> arch/arm/boards/imx233-olinuxino/imx23-olinuxino.c | 59 -
> arch/arm/boards/karo-tx28/tx28.c | 52 -
> arch/arm/boards/karo-tx51/tx51.dox | 50 -
> arch/arm/boards/module-mb7707/module-mb7707.dox | 29 -
> arch/arm/boards/mx31moboard/mx31moboard.dox | 10 -
> arch/arm/boards/netx/netx.dox | 9 -
> arch/arm/boards/omap343xdsp/board.c | 26 -
> arch/arm/boards/phytec-phycard-imx27/pca100.dox | 8 -
> arch/arm/boards/phytec-phycard-omap3/pca-a-l1.dox | 16 -
> arch/arm/boards/phytec-phycore-imx27/pcm038.dox | 9 -
> arch/arm/boards/phytec-phycore-imx31/pcm037.dox | 11 -
> arch/arm/boards/phytec-phycore-imx35/pcm043.dox | 28 -
> arch/arm/boards/qil-a926x/qil-a9260.dox | 22 -
> arch/arm/boards/scb9328/scb9328.dox | 9 -
> arch/arm/boards/tny-a926x/tny-a9263.dox | 33 -
> arch/arm/boards/tny-a926x/tny-a9g20-lpw.dox | 37 -
> arch/arm/boards/toshiba-ac100/toshiba-ac100.dox | 37 -
> arch/arm/boards/usb-a926x/usb-a9263.dox | 30 -
> arch/arm/boards/usb-a926x/usb-a9g20-lpw.dox | 33 -
> arch/arm/boards/virt2real/virt2real.dox | 41 -
> arch/arm/mach-arm.dox | 67 -
> arch/arm/mach-davinci/mach-davinci.dox | 7 -
> arch/arm/mach-omap/arch-omap.dox | 96 --
> arch/arm/mach-samsung/lowlevel-s3c24x0.S | 8 -
> arch/arm/mach-samsung/mem-s3c24x0.c | 57 -
> arch/blackfin/boards/ipe337/ipe337.dox | 10 -
> arch/blackfin/mach-bf.dox | 9 -
> arch/mips/boards/dlink-dir-320/dlink-dir-320.dox | 38 -
> arch/mips/boards/loongson-ls1b/loongson_ls1b.dox | 47 -
> arch/mips/boards/qemu-malta/qemu-malta.dox | 20 -
> arch/mips/boards/ritmix-rzx50/ritmix-rzx50.dox | 46 -
> arch/mips/boards/tplink-mr3020/tplink-mr3020.dox | 64 -
> arch/mips/mach-bcm47xx/mach-bcm47xx.dox | 7 -
> arch/mips/mach-loongson/mach-loongson.dox | 7 -
> arch/mips/mach-malta/mach-malta.dox | 7 -
> arch/mips/mach-mips.dox | 69 --
> arch/mips/mach-xburst/mach-xburst.dox | 7 -
> arch/ppc/boards/pcm030/pcm030.dox | 8 -
> arch/ppc/mach-ppc.dox | 9 -
> arch/sandbox/os/common.c | 55 -
> arch/x86/boards/x86_generic/generic_pc.c | 34 -
> arch/x86/boot/bioscall.S | 4 -
> arch/x86/lib/bios_disk.S | 3 -
> arch/x86/lib/linux_start.S | 3 -
> arch/x86/mach-x86.dox | 128 --
> commands/automount.c | 2 +-
> commands/bootm.c | 17 -
> commands/cp.c | 14 -
> commands/devinfo.c | 28 -
> commands/dfu.c | 10 -
> commands/echo.c | 8 -
> commands/edit.c | 16 -
> commands/flash.c | 52 -
> commands/gpio.c | 62 -
> commands/led.c | 9 -
> commands/linux16.c | 66 -
> commands/loadenv.c | 9 -
> commands/miitool.c | 6 -
> commands/mount.c | 36 -
> commands/partition.c | 40 +-
> commands/printenv.c | 14 -
> commands/saveenv.c | 18 -
> commands/setenv.c | 13 -
> commands/splash.c | 11 -
> commands/ubiformat.c | 10 +-
> commands/usbserial.c | 4 -
> common/kallsyms.c | 4 -
> include/command.h | 4 -
> include/driver.h | 26 -
> include/i2c/i2c.h | 4 -
> include/linux/mtd/mtd-abi.h | 4 -
> include/linux/mtd/mtd.h | 4 -
> include/spi/spi.h | 4 -
> include/usb/ch9.h | 4 -
> include/usb/composite.h | 4 -
> include/usb/gadget.h | 4 -
> include/usb/usb.h | 4 -
> net/netconsole.c | 28 -
> scripts/doxy_filter.awk | 103 --
> 175 files changed, 2893 insertions(+), 5042 deletions(-)
> delete mode 100644 Documentation/barebox-main.dox
> delete mode 100644 Documentation/board.dox
> delete mode 100644 Documentation/boards.dox
> create mode 100644 Documentation/boards.rst
> create mode 100644 Documentation/boards/cirrus-logic.rst
> create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9301.rst
> create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9302.rst
> create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9302a.rst
> create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9307.rst
> create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9307a.rst
> create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9312.rst
> create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9315.rst
> create mode 100644 Documentation/boards/edb9xxx/cirrus_logic_edb9315a.rst
> create mode 100644 Documentation/boards/imx.rst
> create mode 100644 Documentation/boards/imx/Garz-Fricke-Cupid.rst
> create mode 100644 Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst
> create mode 100644 Documentation/boards/imx/eukrea_cpuimx27.rst
> create mode 100644 Documentation/boards/imx/synertronixx_scb9328.rst
> create mode 100644 Documentation/boards/mxs/Chumby-Falconwing.rst
> create mode 100644 Documentation/boards/mxs/Freescale-i.MX23-evk.rst
> create mode 100644 Documentation/boards/mxs/KaRo-TX28.rst
> create mode 100644 Documentation/boards/omap.rst
> create mode 100644 Documentation/boards/s3c/Digi-a9m2440.rst
> create mode 100644 Documentation/boards/samsung.rst
> create mode 100644 Documentation/boards/sandbox.rst
> create mode 100644 Documentation/boards/tegra.rst
> create mode 100644 Documentation/boards/x86.rst
> delete mode 100644 Documentation/building.dox
> delete mode 100644 Documentation/commands.dox
> create mode 100644 Documentation/commands.rst
> create mode 100644 Documentation/conf.py
> delete mode 100644 Documentation/console.txt
> delete mode 100644 Documentation/developers_manual.dox
> delete mode 100644 Documentation/devices_drivers.txt
> delete mode 100644 Documentation/devicetree/bindings/barebox.txt
> delete mode 100644 Documentation/devicetree/bindings/barebox/barebox,environment.txt
> rename Documentation/devicetree/bindings/leds/{common.txt => common.rst} (86%)
> rename Documentation/devicetree/bindings/misc/{fsl,imx-iim.txt => fsl,imx-iim.rst} (62%)
> rename Documentation/devicetree/bindings/misc/{fsl,imx-ocotp.txt => fsl,imx-ocotp.rst} (64%)
> create mode 100644 Documentation/devicetree/index.rst
> create mode 100644 Documentation/download.rst
> create mode 100644 Documentation/filesystems.rst
> create mode 100644 Documentation/filesystems/fat.rst
> create mode 100644 Documentation/filesystems/nfs.rst
> create mode 100644 Documentation/filesystems/ramfs.rst
> create mode 100644 Documentation/filesystems/tftp.rst
> delete mode 100644 Documentation/first_steps.dox
> create mode 100755 Documentation/gen_commands.py
> create mode 100644 Documentation/glossary.rst
> create mode 100644 Documentation/index.rst
> delete mode 100644 Documentation/manual_org.dox
> delete mode 100644 Documentation/omap4_usb_booting.txt
> delete mode 100644 Documentation/porting.txt
> delete mode 100644 Documentation/timekeeping.txt
> create mode 100644 Documentation/user/automount.rst
> create mode 100644 Documentation/user/barebox.rst
> create mode 100644 Documentation/user/booting-linux.rst
> create mode 100644 Documentation/user/defaultenv-2.rst
> create mode 100644 Documentation/user/devicetree.rst
> create mode 100644 Documentation/user/driver-model.rst
> create mode 100644 Documentation/user/framebuffer.rst
> create mode 100644 Documentation/user/hush.rst
> create mode 100644 Documentation/user/introduction.rst
> create mode 100644 Documentation/user/memory-areas.rst
> create mode 100644 Documentation/user/multi-image.rst
> create mode 100644 Documentation/user/networking.rst
> create mode 100644 Documentation/user/pbl.rst
> create mode 100644 Documentation/user/system-setup.rst
> create mode 100644 Documentation/user/ubi.rst
> create mode 100644 Documentation/user/updating.rst
> create mode 100644 Documentation/user/usb.rst
> create mode 100644 Documentation/user/user-manual.rst
> create mode 100644 Documentation/user/variables.rst
> delete mode 100644 Documentation/users_manual.dox
> delete mode 100644 Doxyfile
> delete mode 100644 arch/architecture.dox
> delete mode 100644 arch/arm/boards/ccxmx51/ccxmx51.dox
> delete mode 100644 arch/arm/boards/edb93xx/edb93xx.dox
> delete mode 100644 arch/arm/boards/eukrea_cpuimx27/eukrea_cpuimx27.dox
> delete mode 100644 arch/arm/boards/eukrea_cpuimx35/eukrea_cpuimx35.dox
> delete mode 100644 arch/arm/boards/eukrea_cpuimx51/eukrea_cpuimx51.dox
> delete mode 100644 arch/arm/boards/freescale-mx21-ads/imx21ads.dox
> delete mode 100644 arch/arm/boards/freescale-mx27-ads/imx27ads.dox
> delete mode 100644 arch/arm/boards/freescale-mx35-3ds/3stack.dox
> delete mode 100644 arch/arm/boards/freescale-mx51-babbage/mx51-pdk.dox
> delete mode 100644 arch/arm/boards/freescale-mx53-qsb/mx53-pdk.dox
> delete mode 100644 arch/arm/boards/freescale-mx53-smd/mx53-smd.dox
> delete mode 100644 arch/arm/boards/guf-cupid/cupid.dox
> delete mode 100644 arch/arm/boards/karo-tx51/tx51.dox
> delete mode 100644 arch/arm/boards/module-mb7707/module-mb7707.dox
> delete mode 100644 arch/arm/boards/mx31moboard/mx31moboard.dox
> delete mode 100644 arch/arm/boards/netx/netx.dox
> delete mode 100644 arch/arm/boards/phytec-phycard-imx27/pca100.dox
> delete mode 100644 arch/arm/boards/phytec-phycard-omap3/pca-a-l1.dox
> delete mode 100644 arch/arm/boards/phytec-phycore-imx27/pcm038.dox
> delete mode 100644 arch/arm/boards/phytec-phycore-imx31/pcm037.dox
> delete mode 100644 arch/arm/boards/phytec-phycore-imx35/pcm043.dox
> delete mode 100644 arch/arm/boards/qil-a926x/qil-a9260.dox
> delete mode 100644 arch/arm/boards/scb9328/scb9328.dox
> delete mode 100644 arch/arm/boards/tny-a926x/tny-a9263.dox
> delete mode 100644 arch/arm/boards/tny-a926x/tny-a9g20-lpw.dox
> delete mode 100644 arch/arm/boards/toshiba-ac100/toshiba-ac100.dox
> delete mode 100644 arch/arm/boards/usb-a926x/usb-a9263.dox
> delete mode 100644 arch/arm/boards/usb-a926x/usb-a9g20-lpw.dox
> delete mode 100644 arch/arm/boards/virt2real/virt2real.dox
> delete mode 100644 arch/arm/mach-arm.dox
> delete mode 100644 arch/arm/mach-davinci/mach-davinci.dox
> delete mode 100644 arch/arm/mach-omap/arch-omap.dox
> delete mode 100644 arch/blackfin/boards/ipe337/ipe337.dox
> delete mode 100644 arch/blackfin/mach-bf.dox
> delete mode 100644 arch/mips/boards/dlink-dir-320/dlink-dir-320.dox
> delete mode 100644 arch/mips/boards/loongson-ls1b/loongson_ls1b.dox
> delete mode 100644 arch/mips/boards/qemu-malta/qemu-malta.dox
> delete mode 100644 arch/mips/boards/ritmix-rzx50/ritmix-rzx50.dox
> delete mode 100644 arch/mips/boards/tplink-mr3020/tplink-mr3020.dox
> delete mode 100644 arch/mips/mach-bcm47xx/mach-bcm47xx.dox
> delete mode 100644 arch/mips/mach-loongson/mach-loongson.dox
> delete mode 100644 arch/mips/mach-malta/mach-malta.dox
> delete mode 100644 arch/mips/mach-mips.dox
> delete mode 100644 arch/mips/mach-xburst/mach-xburst.dox
> delete mode 100644 arch/ppc/boards/pcm030/pcm030.dox
> delete mode 100644 arch/ppc/mach-ppc.dox
> delete mode 100644 arch/x86/mach-x86.dox
> delete mode 100644 scripts/doxy_filter.awk
>
> _______________________________________________
> barebox mailing list
> barebox@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/barebox
--
--
Best regards,
Antony Pavlov
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread* Re: New Documentation for barebox
2014-06-26 10:28 ` Antony Pavlov
@ 2014-06-26 15:36 ` Sascha Hauer
0 siblings, 0 replies; 19+ messages in thread
From: Sascha Hauer @ 2014-06-26 15:36 UTC (permalink / raw)
To: Antony Pavlov; +Cc: barebox
On Thu, Jun 26, 2014 at 02:28:27PM +0400, Antony Pavlov wrote:
> On Thu, 26 Jun 2014 10:51:31 +0200
> Sascha Hauer <s.hauer@pengutronix.de> wrote:
>
> > Hi all,
> >
> > I am happy to announce new documentation for barebox.
>
> Aghhhh!
>
> All my mips documentation have gone away!
Sorry, that was not intentional. I won't merge the branch until the mips
documentation is back.
>
> I'm ready to convert old dox-files to new rst-files by myself,
> but I need some recomendations.
>
> Could I put rst mips files into Documentation/boards/mips?
Sure, whatever suits best for you. For i.MX it makes sense to have some
i.MX document describing the common i.MX stuff. I don't know enough
about MIPS to know if it's best to have SoC type or generic MIPS docs.
Sascha
--
Pengutronix e.K. | |
Industrial Linux Solutions | http://www.pengutronix.de/ |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: New Documentation for barebox
2014-06-26 8:51 New Documentation for barebox Sascha Hauer
` (10 preceding siblings ...)
2014-06-26 10:28 ` Antony Pavlov
@ 2014-06-26 10:31 ` Robert P. J. Day
2014-06-26 18:56 ` Sascha Hauer
11 siblings, 1 reply; 19+ messages in thread
From: Robert P. J. Day @ 2014-06-26 10:31 UTC (permalink / raw)
To: Sascha Hauer; +Cc: barebox
On Thu, 26 Jun 2014, Sascha Hauer wrote:
> Hi all,
>
> I am happy to announce new documentation for barebox.
>
> The following series removes the in-tree documentation and replaces
> it with completely rewritten sphinxs based documentation. As of now
> we have a more or less complete user manual. There surely is room
> for improvements but we think that it is good enough already and
> surely better than what we have now.
>
> The documentation is written with Sphinx. Sphinx is
> the Python Documentation Generator, see http://sphinx-doc.org/.
> The files are written in reStructuredText, a format which is
> sufficiently easy to write and nice to read even in sourcecode
> format.
>
> Thank you Jan, Lukas and Jochen for help writing documentation and
> fixing typos.
>
> `make docs` will generate static html files.
... snip ...
couple quick observations before i put on my editor hat and go
through all this. first, on my fedora rawhide system, running "make
docs" generates quite a few warnings, although the HTML is eventually
built. is it worth digging into the doc generation warnings and trying
to clean them up? anyone else building the docs on fedora rawhide and
see what i'm talking about?
and just from the main page, a couple very pedantic questions:
* should the name "Barebox" be italicized or not? it seems even that
single page bounces back and forth using and not using "@a" in front
of the word "Barebox".
* the "Directory layout" section inserts a space on either side of the
"/" in directory names, as in:
arch / * /
that just looks ... weird.
* oh, final note regarding name "Barebox", i notice some pages (like
the x86_bootloader page) use the uncapitalized name "barebox" -- this
really should be consistent throughout all the docs.
more later after i read more ...
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread* Re: New Documentation for barebox
2014-06-26 10:31 ` Robert P. J. Day
@ 2014-06-26 18:56 ` Sascha Hauer
0 siblings, 0 replies; 19+ messages in thread
From: Sascha Hauer @ 2014-06-26 18:56 UTC (permalink / raw)
To: Robert P. J. Day; +Cc: barebox
On Thu, Jun 26, 2014 at 06:31:10AM -0400, Robert P. J. Day wrote:
> On Thu, 26 Jun 2014, Sascha Hauer wrote:
>
>
> ... snip ...
>
> couple quick observations before i put on my editor hat and go
> through all this. first, on my fedora rawhide system, running "make
> docs" generates quite a few warnings, although the HTML is eventually
> built. is it worth digging into the doc generation warnings and trying
> to clean them up? anyone else building the docs on fedora rawhide and
> see what i'm talking about?
>
> and just from the main page, a couple very pedantic questions:
>
> * should the name "Barebox" be italicized or not? it seems even that
> single page bounces back and forth using and not using "@a" in front
> of the word "Barebox".
>
> * the "Directory layout" section inserts a space on either side of the
> "/" in directory names, as in:
>
> arch / * /
>
> that just looks ... weird.
>
> * oh, final note regarding name "Barebox", i notice some pages (like
> the x86_bootloader page) use the uncapitalized name "barebox" -- this
> really should be consistent throughout all the docs.
It seems you are talking about the old doxygen docs. Please checkout
the doc branch on:
git://git.pengutronix.de/git/barebox.git
There should be only one match for Barebox with a capital 'B' in
Documentation/boards/omap.rst:36:exactly behaves like an external dongle. Barebox does not automatically detect
All others are lowercase.
Sascha
--
Pengutronix e.K. | |
Industrial Linux Solutions | http://www.pengutronix.de/ |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 19+ messages in thread