summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorSascha Hauer <s.hauer@pengutronix.de>2009-12-15 09:11:09 +0100
committerSascha Hauer <s.hauer@pengutronix.de>2009-12-15 10:18:30 +0100
commita3ffa97f40dc81f2d6b07ee964f2340fe0c1ba97 (patch)
tree7a9076c1a20df00baeadca9a07d4c1f5cd0611e2 /Documentation
parentcaa5cec7b1c93d660aa89d24eb160ab18e4eb628 (diff)
downloadbarebox-a3ffa97f40dc81f2d6b07ee964f2340fe0c1ba97.tar.gz
barebox-a3ffa97f40dc81f2d6b07ee964f2340fe0c1ba97.tar.xz
rename U-Boot-v2 project to barebox
This has been done with the following script: find -path ./.git -prune -o -type f -print0 | xargs -0 -r sed -i \ -e 's/u2boot/barebox/g' \ -e 's/U2Boot/barebox/g' \ -e 's/U-boot V2/barebox/g' \ -e 's/u-boot v2/barebox/g' \ -e 's/U-Boot V2/barebox/g' \ -e 's/U-Boot-v2/barebox/g' \ -e 's/U_BOOT/BAREBOX/g' \ -e 's/UBOOT/BAREBOX/g' \ -e 's/uboot/barebox/g' \ -e 's/u-boot/barebox/g' \ -e 's/u_boot/barebox/g' \ -e 's/U-Boot/barebox/g' \ -e 's/U-boot/barebox/g' \ -e 's/U-BOOT/barebox/g' find -path ./.git -prune -o \( -name "*u-boot*" -o -name "*uboot*" -o -name "*u_boot*" \) -print0 | \ xargs -0 -r rename 's/u[-_]?boot/barebox/' It needs some manual fixup following in the next patch Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/barebox-main.dox (renamed from Documentation/uboot-main.dox)60
-rw-r--r--Documentation/boards.dox2
-rw-r--r--Documentation/console.txt4
-rw-r--r--Documentation/developers_manual.dox10
-rw-r--r--Documentation/devices_drivers.txt2
-rw-r--r--Documentation/manual_org.dox2
-rw-r--r--Documentation/porting.txt30
-rw-r--r--Documentation/timekeeping.txt4
8 files changed, 57 insertions, 57 deletions
diff --git a/Documentation/uboot-main.dox b/Documentation/barebox-main.dox
index 424e369c6b..2246775269 100644
--- a/Documentation/uboot-main.dox
+++ b/Documentation/barebox-main.dox
@@ -1,9 +1,9 @@
/** @mainpage Universal Bootloader
-@section uboot_v2_intro Introduction
+@section barebox_v2_intro Introduction
-This is u2boot, our proposal for a next generation of the famous U-Boot
-bootloader. U-Boot offers an excellent choice as a bootloader for
+This is barebox, our proposal for a next generation of the famous barebox
+bootloader. barebox offers an excellent choice as a bootloader for
today's embedded systems, seen from a user's point of view.
Nevertheless, there are quite some design flaws which turned out over
the last years and we think that they cannot be solved in a production
@@ -13,7 +13,7 @@ about losing support for old boards.
@par General features include:
- A posix based file API
- - inside U-Boot the usual open/close/read/write/lseek functions are used.
+ - inside barebox the usual open/close/read/write/lseek functions are used.
This makes it familiar to everyone who has programmed under unix systems.
- usual shell commands like ls/cd/mkdir/echo/cat,...
@@ -47,12 +47,12 @@ about losing support for old boards.
the code.
- simulation target
- - U-Boot can be compiled to run under Linux. While this is rather useless
+ - barebox can be compiled to run under Linux. While this is rather useless
in real world this is a great debugging and development aid. New features
can be easily developped and tested on long train journeys and started
under gdb. There is a console driver for linux which emulates a serial
device and a tap based ethernet driver. Linux files can be mapped to
- devices under U-Boot to emulate storage devices.
+ devices under barebox to emulate storage devices.
- device parameter support
- Each device can have a unlimited number of parameters. They can be accessed
@@ -65,22 +65,22 @@ about losing support for old boards.
- getopt
- There is a small getopt implementation. Some commands got really
- complicated (both in code and in usage) due to the fact that U-Boot only
+ complicated (both in code and in usage) due to the fact that barebox only
allowed positional parameters.
- editor
- Scripts can be edited with a small editor. This editor has no features
except the ones really needed: moving the cursor and typing characters.
-@par Building U-Boot
+@par Building barebox
-U-Boot uses the Linux kernel's build system. It consists of two parts:
+barebox uses the Linux kernel's build system. It consists of two parts:
the makefile infrastructure (kbuild), plus a configuration system
-(kconfig). So building U-Boot is very similar to building the Linux
+(kconfig). So building barebox is very similar to building the Linux
kernel.
-For the examples below, we use the User Mode U-Boot implementation, which
-is a port of U-Boot to the Linux userspace. This makes it possible to
+For the examples below, we use the User Mode barebox implementation, which
+is a port of barebox to the Linux userspace. This makes it possible to
test drive the code without having real hardware. So for this test
scenario, ARCH=sandbox is the valid architecture selection. This currently
only works on ia32 hosts and partly on x86-64.
@@ -94,7 +94,7 @@ architecture:
@code # ln -s sandbox cross_arch @endcode
-In order to configure the various aspects of U-Boot, start the U-Boot
+In order to configure the various aspects of barebox, start the barebox
configuration system:
@code # make menuconfig @endcode
@@ -105,49 +105,49 @@ finished (you can simulate this by using the standard demo config file
with 'make sandbox_defconfig'), there is a .config file in the toplevel
directory of the sourcode.
-Once U-Boot is configured, we can start the compilation
+Once barebox is configured, we can start the compilation
@code # make @endcode
-If everything goes well, the result is a file called uboot:
+If everything goes well, the result is a file called barebox:
@code
- # ls -l uboot
- -rwxr-xr-x 1 rsc ptx 114073 Jun 26 22:34 uboot
+ # ls -l barebox
+ -rwxr-xr-x 1 rsc ptx 114073 Jun 26 22:34 barebox
@endcode
-U-Boot usually needs an environment for storing the configuation data.
+barebox usually needs an environment for storing the configuation data.
You can generate an environment using the example environment contained
in examples/environment:
-@code # ./scripts/ubootenv -s -p 0x10000 examples/environment/ env.bin @endcode
+@code # ./scripts/bareboxenv -s -p 0x10000 examples/environment/ env.bin @endcode
To get some files to play with you can generate a cramfs image:
@code # mkcramfs somedir/ cramfs.bin @endcode
-The U-Boot image is a normal Linux executable, so it can be started
+The barebox image is a normal Linux executable, so it can be started
just like every other program:
@code
- # ./uboot -e env.bin -i cramfs.bin
+ # ./barebox -e env.bin -i cramfs.bin
- U-Boot 2.0.0-trunk (Jun 26 2007 - 22:34:38)
+ barebox 2.0.0-trunk (Jun 26 2007 - 22:34:38)
loading environment from /dev/env0
- uboot\> /
+ barebox\> /
@endcode
-Specifying -[ie] \<file\> tells U-Boot to map the file as a device
+Specifying -[ie] \<file\> tells barebox to map the file as a device
under /dev. Files given with '-e' will appear as /dev/env[n]. Files
given with '-i' will appear as /dev/fd[n].
-If U-Boot finds a valid configuration sector on /dev/env0 it will
+If barebox finds a valid configuration sector on /dev/env0 it will
load it to /env. It then executes /env/init if it exists. If you have
-loaded the example environment U-Boot will show you a menu asking for
+loaded the example environment barebox will show you a menu asking for
your settings.
-If you have started U-Boot as root you will find a new tap device on your
-host which you can configure using ifconfig. Once you configured U-Boots
+If you have started barebox as root you will find a new tap device on your
+host which you can configure using ifconfig. Once you configured bareboxs
network settings accordingly you can do a ping or tftpboot.
If you have mapped a cramfs image try mounting it with
@@ -160,7 +160,7 @@ If you have mapped a cramfs image try mounting it with
Memory can be examined as usual using md/mw commands. They both understand
the -f \<file\> option to tell the commands that they should work on the
specified files instead of /dev/mem which holds the complete address space.
-Note that if you call 'md /dev/fd0' (without -f) U-Boot will segfault on
+Note that if you call 'md /dev/fd0' (without -f) barebox will segfault on
the host, because it will interpret /dev/fd0 as a number.
@par Directory layout
@@ -195,7 +195,7 @@ scripts / -> Kconfig system
Documentation / ->
@endverbatim
-@section license U-Boot's License
+@section license barebox's License
@verbatim
This program is free software; you can redistribute it and/or
diff --git a/Documentation/boards.dox b/Documentation/boards.dox
index c4d05d69af..6c958324e1 100644
--- a/Documentation/boards.dox
+++ b/Documentation/boards.dox
@@ -1,6 +1,6 @@
/** @page supported_boards Supported Boards
-This is a list of boards that are currently supported by U-Boot-v2.
+This is a list of boards that are currently supported by barebox.
PowerPC type:
diff --git a/Documentation/console.txt b/Documentation/console.txt
index 7ed67202e4..76b6107ac6 100644
--- a/Documentation/console.txt
+++ b/Documentation/console.txt
@@ -1,6 +1,6 @@
--------------- U-Boot consoles ------------------
+-------------- barebox consoles ------------------
-U-Boot supports multiple consoles which may be simultaneously active.
+barebox supports multiple consoles which may be simultaneously active.
Depending on the configuration none, the first or all consoles are
activated on startup, see CONSOLE_ACTIVATE_FIRST and CONSOLE_ACTIVATE_ALL
options.
diff --git a/Documentation/developers_manual.dox b/Documentation/developers_manual.dox
index ab941e23b8..6326d453bd 100644
--- a/Documentation/developers_manual.dox
+++ b/Documentation/developers_manual.dox
@@ -1,23 +1,23 @@
/** @page developers_manual Developer's Manual
-This part of the documentation is intended for developers of U-Boot-v2.
+This part of the documentation is intended for developers of barebox.
-@section devel_backgrounds Some background knowledge for some frameworks U-Boot-v2
+@section devel_backgrounds Some background knowledge for some frameworks barebox
@li @subpage driver_model
@li @subpage dev_params
-@section devel_hints Hints and tips for simply adapting U-Boot-v2
+@section devel_hints Hints and tips for simply adapting barebox
@li @subpage dev_architecture
@li @subpage dev_cpu
@li @subpage dev_board
-@section devel_themes Various themes about U-Boot-v2
+@section devel_themes Various themes about barebox
@li @subpage how_mount_works
@li @subpage boot_preparation
-@li @subpage uboot_simul
+@li @subpage barebox_simul
@li @subpage io_access_functions
@li @subpage mcfv4e_MCDlib
diff --git a/Documentation/devices_drivers.txt b/Documentation/devices_drivers.txt
index 06e788de86..af929fa8c7 100644
--- a/Documentation/devices_drivers.txt
+++ b/Documentation/devices_drivers.txt
@@ -1,5 +1,5 @@
----------- Devices and drivers in U-Boot --------------
+---------- Devices and drivers in barebox --------------
We follow a rather simplistic driver model here. There is a struct device which
describes a particular device present in the system. A struct driver represents
diff --git a/Documentation/manual_org.dox b/Documentation/manual_org.dox
index f9cb238a4b..6f3b157876 100644
--- a/Documentation/manual_org.dox
+++ b/Documentation/manual_org.dox
@@ -6,7 +6,7 @@ than listed here. But these files are the main control files:
- Documentation
- Documentation/Doxyfile
- - Documentation/uboot-main.dox
+ - Documentation/barebox-main.dox
- Documentation/users_manual.dox
- Documentation/commands.dox
- Documentation/developers_manual.dox
diff --git a/Documentation/porting.txt b/Documentation/porting.txt
index 174a16ba38..ccfe598a74 100644
--- a/Documentation/porting.txt
+++ b/Documentation/porting.txt
@@ -1,5 +1,5 @@
-When porting from old U-Boot the follwing steps must be taken (please complain
+When porting from old barebox the follwing steps must be taken (please complain
if there's something missing here ;)
@@ -9,24 +9,24 @@ if there's something missing here ;)
configured with the Kconfig system feel free to add them there.
- The linker script needs a new section for the initcalls. The handling of the
- U-Boot command table has changed, too. (The commands are now sorted by the
+ barebox command table has changed, too. (The commands are now sorted by the
linker instead at runtime.) To change it you need an entry like the following
in your linker script:
-#include <asm-generic/u-boot.lds.h>
+#include <asm-generic/barebox.lds.h>
- __u_boot_cmd_start = .;
- .u_boot_cmd : { U_BOOT_CMDS }
- __u_boot_cmd_end = .;
+ __barebox_cmd_start = .;
+ .barebox_cmd : { BAREBOX_CMDS }
+ __barebox_cmd_end = .;
- __u_boot_initcalls_start = .;
- .u_boot_initcalls : { INITCALLS }
- __u_boot_initcalls_end = .;
+ __barebox_initcalls_start = .;
+ .barebox_initcalls : { INITCALLS }
+ __barebox_initcalls_end = .;
-- Rename your linker script to u-boot.lds.S and add the following entry to the
+- Rename your linker script to barebox.lds.S and add the following entry to the
Makefile to make sure the linker script is generated:
-extra-y += u-boot.lds
+extra-y += barebox.lds
- Register the devices present in your system in the board specific .c file.
To see anything you have to at least register a console. In scb9328.c this
@@ -72,7 +72,7 @@ extra-y += u-boot.lds
set_mac_address() set the MAC address in the device. All magic previously
done with getenv/setenv(ethaddr) must be removed.
- During startup U-Boot calls get_mac_address() to see if an EEPROM is
+ During startup barebox calls get_mac_address() to see if an EEPROM is
connected. If so, it calls set_mac_address() with this address. This
is done even if networking is not used during startup. This makes sure
that the MAC address is set in the device and Linux can pick it up later.
@@ -91,8 +91,8 @@ extra-y += u-boot.lds
- Adjust start.S. On PowerPC there is at least the Problem that the relocation
offset is defined at compile time. It is easily possible to determine the
- address U-Boot is currently starting from at runtime and thus allowing it
- U-Boot to be started at any address. Look at the relocation code and replace
+ address barebox is currently starting from at runtime and thus allowing it
+ barebox to be started at any address. Look at the relocation code and replace
TEXT_BASE with the following calculation of the runtime address:
bl calc_source /* Calculate Source Address */
@@ -105,7 +105,7 @@ calc_source:
fortunately I know next to nothing of PowerPC assembler, so if you have
a better way to archieve this, please write to the list.)
- On PowerPC U-Boot now runs at the address it was linked to, so you have
+ On PowerPC barebox now runs at the address it was linked to, so you have
to adjust TEXT_BASE to be in RAM. This makes the various fixup relocation
functions unnecessary. On PowerPC the removal of -fPIC saves around 10% of
binary space. It also simplifies debugging because you will see the correct
diff --git a/Documentation/timekeeping.txt b/Documentation/timekeeping.txt
index 9d778117c1..ed5ef62fe0 100644
--- a/Documentation/timekeeping.txt
+++ b/Documentation/timekeeping.txt
@@ -1,6 +1,6 @@
------------- U-Boot timekeeping -------------
+------------ barebox timekeeping -------------
-In U-Boot we use the clocksource mechanism from the Linux Kernel. This makes
+In barebox we use the clocksource mechanism from the Linux Kernel. This makes
it fairly easy to add timer functionality for a new board or architecture.
Apart from initialization there is only one function required:
clocksource_read(). This function returns the current value of a free running