summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuergen Beisert <j.beisert@pengutronix.de>2007-11-08 12:01:52 +0100
committerJuergen Beisert <j.beisert@pengutronix.de>2007-11-08 12:01:52 +0100
commit8fe25ecf1270ab08e0b3baf5e8bae91e8f55eaa9 (patch)
treee7688eb0e6b8a5c8aba5c810719d41888c7de926
parent0a13be8de25ea2ba37f156fbfac0555125f651f3 (diff)
downloadbarebox-8fe25ecf1270ab08e0b3baf5e8bae91e8f55eaa9.tar.gz
barebox-8fe25ecf1270ab08e0b3baf5e8bae91e8f55eaa9.tar.xz
adding various doku
-rw-r--r--Documentation/commands.dox12
-rw-r--r--arch/arm/mach-arm.dox12
-rw-r--r--board/board.dox60
-rw-r--r--commands/cat.c2
-rw-r--r--commands/cd.c5
-rw-r--r--commands/cp.c2
-rw-r--r--commands/edit.c23
-rw-r--r--commands/environment.c18
-rw-r--r--commands/mount.c10
-rw-r--r--commands/net.c27
-rw-r--r--common/env.c18
-rw-r--r--common/hush.c14
-rw-r--r--lib/driver.c34
13 files changed, 163 insertions, 74 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 50e383f3dc..135787c7e7 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -1,15 +1,19 @@
/**
* @page command_reference Supported Shell Commands
- - @subpage sh_command
- @subpage cat_command
- @subpage cd_command
- @subpage cp_command
+ - @subpage devinfo_command
+ - @subpage edit_command
+ - @subpage export_command
+ - @subpage tftp_command
+ - @subpage loadenv_command
+ - @subpage mount_command
- @subpage printenv_command
- @subpage saveenv_command
- - @subpage loadenv_command
- @subpage setenv_command
- - @subpage export_command
- - @subpage mount_command
+ - @subpage sh_command
+ - @subpage rarp_command
*/
diff --git a/arch/arm/mach-arm.dox b/arch/arm/mach-arm.dox
index 8443b731aa..862b3396f1 100644
--- a/arch/arm/mach-arm.dox
+++ b/arch/arm/mach-arm.dox
@@ -12,22 +12,22 @@ FIXME
to: "runtime address != link address". You should only use branches and
do not refer to fixed data. This implies the use of assembler code only.
-The ARM CPU starts at lable <reset> in one of the corresponding start-*.S
+The ARM CPU starts at lable \<reset\> in one of the corresponding start-*.S
files. After some basic hardware setup it can call a function
-<arch_init_lowlevel> if not disabled. This call is intended to give all
+\<arch_init_lowlevel\> if not disabled. This call is intended to give all
developers a chance to use a standard reset vector file, but also do some
special things required only on their specific CPU.
-After handling some MMU related things <board_init_lowlevel> can be called (if
+After handling some MMU related things \<board_init_lowlevel\> can be called (if
not disabled). This is a board specific function for SDRAM setup for example.
As its board specific, your can do whatever you need to bring your board up.
-When <board_init_lowlevel> returns it will be assumed there is now a working
+When \<board_init_lowlevel\> returns it will be assumed there is now a working
RAM that can be used for all further steps.
Next step is relocation of U-Boot itself. It gets copied to RAM and the last
-assembler instruction is a jump into <start_uboot>. This target address is
-the first C instruction in U-Boot. At this point of time:
+assembler instruction is a jump into \<start_uboot\>. This target address is
+the first C instruction in U-Boot. At this point of time:\n
"runtime address == link address".
*/
diff --git a/board/board.dox b/board/board.dox
index 4bc308d1e5..a4c6dc5e96 100644
--- a/board/board.dox
+++ b/board/board.dox
@@ -5,27 +5,33 @@ the U-Boot source tree.
@section board_add_files Files/Directories to be added
- - board/<boardname>
- - board/<boardname>/<boardname>.c
- - board/<boardname>/<boardname>.dox
- - board/<boardname>/Makefile
- - include/configs/<boardname>.h
- - arch/<architecture>/configs/<boardname>_defconfig
+ - board/\<boardname\>
+ - board/\<boardname\>/Makefile
+ - board/\<boardname\>/\<boardname\>.c
+ - board/\<boardname\>/\<boardname\>.dox
+ - include/configs/\<boardname\>.h
+ - arch/\<architecture\>/configs/\<boardname\>_defconfig
-Makefile
+@subsection board_makefile board/\<boardname\>Makefile
+@verbatim
obj-y += all files that builds the BSP (Assembler and/or C files)
+@endverbatim
-@subsection board_doxygen board/<boardname>/<boardname>.dox
+@subsection board_basefile board/\<boardname\>\<boardname\>.c
+
+TBD
+
+@subsection board_doxygen board/\<boardname\>/\<boardname\>.dox
This file should describe in short words your new board, what CPU
it uses, what resources are provided and features it supports.
Use the doxygen style for this kind of documentation. Below you find a
-template for this kind of file
+template for this kind of file:
-@code
-</>** <@>page <boardname> <Manufacturer> <Board's Name>
+@verbatim
+/** @page <boardname> <Manufacturer> <Board's Name>
This board uses an <architecture> based CPU. The board is shipped with:
@@ -35,24 +41,24 @@ This board uses an <architecture> based CPU. The board is shipped with:
and so on.
-*</>
-@endcode
+*/
+@endverbatim
To make your new shiny file visible in the automatically generated
documentation you must sort in the used page lable ("<boardname>" in the
-template above) into Documentation/boards.dox as
+template above) into Documentation/boards.dox as:
-@code
+@verbatim
...
- <@>subpage <boardname>
+ @subpage <boardname>
...
-@endcode
+@endverbatim
at the right architecture.
@note Consider to use an unique page lable.
-@subsection board_lscript board/<boardname>/u-boot.ld.S
+@subsection board_lscript board/\<boardname\>/u-boot.ld.S
If your board needs a special binary U-Boot layout, you can provide a local
board linker script file. This will replace the generic one provided by your
@@ -60,21 +66,25 @@ architecture or CPU support.
Add this file with
-@code
- extra-y += <board_linker_script>
-@endcode
+@verbatim
+ extra-y += <board_linker_script>
+@endverbatim
+
+in your local \b Makefile to the list of files, forwarded to the last linking step.
+
+@section board_defconfig arch/\<architecture\>/configs/\<boardname\>_defconfig
-in your local Makefile to the list of files, forwarded to the last linking step.
+TBD
@section board_mod_files These files needs to be modified:
- modify board/board.doc
- - modify arch/<architecture>/Kconfig
+ - modify arch/\<architecture\>/Kconfig
- add your board (MACH_*) to the list
- add your default text base address for this architecture (ARCH_TEXT_BASE)
- add BOARDINFO with valueable info for your board
- - modify arch/<architecture>/Makefile:
- - add board-$(MACH_*) = <your board_dir>
+ - modify arch/\<architecture\>/Makefile:
+ - add board-$(MACH_*) = \<your board_dir\>
First, the new board should be visible in the menu.
diff --git a/commands/cat.c b/commands/cat.c
index af33eca80c..6596612e95 100644
--- a/commands/cat.c
+++ b/commands/cat.c
@@ -97,7 +97,7 @@ U_BOOT_CMD_END
/**
* @page cat_command cat (concatenate)
*
- * Usage is: cat <file> [<file> ...]
+ * Usage is: cat \<file\> [\<file\> ...]
*
* Concatenate files to stdout. Currently only printable characters
* and \\n and \\t are printed, but this should be optional
diff --git a/commands/cd.c b/commands/cd.c
index 08c3a2d268..5d5cacbf87 100644
--- a/commands/cd.c
+++ b/commands/cd.c
@@ -61,7 +61,8 @@ U_BOOT_CMD_END
/**
* @page cd_command cd (change working directory)
*
- * Usage is: cd [<directory name>]
+ * Usage is: cd [\<directory name>]
*
- * Change to <directory name>. If called without argument, change to / (root)
+ * Change to \<directory name>. If called without argument, change to \b /
+ * (root)
*/
diff --git a/commands/cp.c b/commands/cp.c
index e26ff1fa00..a89bb97d76 100644
--- a/commands/cp.c
+++ b/commands/cp.c
@@ -151,7 +151,7 @@ U_BOOT_CMD_END
/**
* @page cp_command cp (copy)
*
- * Usage: cp <source> [<source>] <destination>
+ * Usage: cp \<source> [\<source>] \<destination>
*
* FIXME
*/
diff --git a/commands/edit.c b/commands/edit.c
index 0795d88abc..3a685ebeef 100644
--- a/commands/edit.c
+++ b/commands/edit.c
@@ -1,6 +1,4 @@
/*
- * edit.c - A tiny editor implementation
- *
* Copyright (c) 2007 Sascha Hauer <s.hauer@pengutronix.de>, Pengutronix
*
* See file CREDITS for list of people who contributed to this
@@ -20,6 +18,11 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/**
+ * @file
+ * @brief A tiny editor implementation
+ */
+
#include <common.h>
#include <command.h>
#include <malloc.h>
@@ -398,6 +401,7 @@ static int do_edit(cmd_tbl_t * cmdtp, int argc, char *argv[])
return 1;
}
+ /* check if we are called as "sedit" insted of "edit" */
if (*argv[0] == 's')
smartscroll = 1;
@@ -564,3 +568,18 @@ U_BOOT_CMD_START(edit)
.usage = "edit a file",
U_BOOT_CMD_HELP(cmd_edit_help)
U_BOOT_CMD_END
+
+
+/**
+ * @page edit_command edit (editor)
+ *
+ * Usage is: [s]edit \<file\>
+ *
+ * This is a very small editor. It's only features are moving the cursor with
+ * the usual keys and typing characters.
+ *
+ * \b \<ctrl-c\> quits the editor without saving,\n
+ * \b \<ctrl-d\> quits the editor with saving the current file.
+ *
+ * If called as \c sedit the editor uses ansi codes to scroll the screen.
+ */
diff --git a/commands/environment.c b/commands/environment.c
index b5517aa977..01e7cfed98 100644
--- a/commands/environment.c
+++ b/commands/environment.c
@@ -227,13 +227,13 @@ U_BOOT_CMD_END
/**
* @page saveenv_command saveenv
*
- * Usage: saveenv [<envfs>] [<directory>]
+ * Usage: saveenv [\<envfs>] [\<directory>]
*
- * Save the files in <directory> to the persistent storage device <envfs>.
- * <envfs> is normally a block in flash, but could be any other file.
+ * Save the files in \<directory> to the persistent storage device \<envfs>.
+ * \<envfs> is normally a block in flash, but could be any other file.
*
- * If ommitted <directory> defaults to /env and <envfs> defaults to
- * /dev/env0.
+ * If ommitted \<directory> defaults to \b /env and \<envfs> defaults to
+ * \b /dev/env0.
*
* @note envfs can only handle files. Directories are skipped silently.
*/
@@ -372,12 +372,12 @@ U_BOOT_CMD_END
/**
* @page loadenv_command loadenv
*
- * Usage: loadenv [<directory>] [<envfs>]
+ * Usage: loadenv [\<directory>] [\<envfs>]
*
- * Load the persistent storage contained in <envfs> to the directory <directory>.
+ * Load the persistent storage contained in \<envfs> to the directory \<directory>.
*
- * If ommitted <directory> defaults to /env and <envfs> defaults to
- * /dev/env0.
+ * If ommitted \<directory> defaults to /env and \<envfs> defaults to
+ * \b /dev/env0.
*
* @note envfs can only handle files. Directories are skipped silently.
*/
diff --git a/commands/mount.c b/commands/mount.c
index dd04bdeeb7..03b63f04d1 100644
--- a/commands/mount.c
+++ b/commands/mount.c
@@ -80,16 +80,16 @@ U_BOOT_CMD_START(mount)
U_BOOT_CMD_END
/** @page mount_command mount
- * Usage: mount [<device> <fstype> <mountpoint>]
+ * Usage: mount [\<device> \<fstype> \<mountpoint>]
*
- * Mounts a filesystem of a given <fstype> on a <device> to a <mountpoint>.
- * <device> can be one of /dev/ * or some arbitrary string if no
+ * Mounts a filesystem of a given \<fstype> on a \<device> to a \<mountpoint>.
+ * \<device> can be one of /dev/ * or some arbitrary string if no
* device is needed for this driver (for example ramfs).
*
- * <fstype> is the filesystem driver to use. Try the 'devinfo' command
+ * \<fstype> is the filesystem driver to use. Try the 'devinfo' command
* for a list of available drivers.
*
- * <mountpoint> must be an empty directory descending directly from the
+ * \<mountpoint> must be an empty directory descending directly from the
* root directory.
*/
diff --git a/commands/net.c b/commands/net.c
index d12559e13f..b9c372a712 100644
--- a/commands/net.c
+++ b/commands/net.c
@@ -1,6 +1,4 @@
/*
- * tftp, rarpboot, dhcp, nfs, cdp - Boot support
- *
* (C) Copyright 2000
* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
*
@@ -23,6 +21,11 @@
* MA 02111-1307 USA
*/
+/**
+ * @file
+ * @brief tftp, rarpboot, dhcp, nfs, cdp - Boot support
+ */
+
#include <common.h>
#include <command.h>
#include <environment.h>
@@ -102,6 +105,16 @@ U_BOOT_CMD_START(tftp)
U_BOOT_CMD_HELP(cmd_tftp_help)
U_BOOT_CMD_END
+/**
+ * @page tftp_command tftp
+ *
+ * Usage is: tftp \<filename\> [\<localfilename\>]
+ *
+ * Load a file via network using BootP/TFTP protocol. FIXME: Where to find it
+ * after loading?
+ * @note This command is available only, if enabled in the menuconfig.
+ */
+
#ifdef CONFIG_NET_RARP
static int do_rarpb (cmd_tbl_t *cmdtp, int argc, char *argv[])
{
@@ -116,6 +129,16 @@ U_BOOT_CMD_START(rarpboot)
U_BOOT_CMD_END
#endif /* CONFIG_NET_RARP */
+/**
+ * @page rarp_command rarp
+ *
+ * Usage is: FIXME
+ *
+ * Load a file via network using rarp/tftp protocol. FIXME: Where to find it
+ * after loading?
+ * @note This command is available only, if enabled in the menuconfig.
+ */
+
#ifdef CONFIG_NET_DHCP
static int do_dhcp (cmd_tbl_t *cmdtp, int argc, char *argv[])
{
diff --git a/common/env.c b/common/env.c
index 98789e0206..96a8ed035b 100644
--- a/common/env.c
+++ b/common/env.c
@@ -306,12 +306,12 @@ U_BOOT_CMD_END
/**
* @page printenv_command printenv
*
- * Usage: printenv [<name>]
+ * Usage: printenv [\<name>]
*
* Print environment variables.
- * If <name> was given, it prints out its content if the environment variable
- * <name> exists.
- * Without the <name> argument all current environment variables are printed.
+ * If \<name> was given, it prints out its content if the environment variable
+ * \<name> exists.
+ * Without the \<name> argument all current environment variables are printed.
*/
#ifdef CONFIG_SIMPLE_PARSER
@@ -342,14 +342,14 @@ U_BOOT_CMD_END
/**
* @page setenv_command setenv
*
- * Usage: setenv <name> [<val>]
+ * Usage: setenv \<name> [\<val>]
*
- * Set environment variable <name> to <val ...>
- * If no <val> was given, the variable <name> will be removed.
+ * Set environment variable \<name> to \<val ...>
+ * If no \<val> was given, the variable \<name> will be removed.
*
* This command can be replaced by using the simpler form in the hush:
*
- * <name> = <val>
+ * \<name> = \<val>
*
* @note This command is only required if the simple
* parser (not the hush) is in use.
@@ -394,7 +394,7 @@ U_BOOT_CMD_END
/**
* @page export_command export
*
- * Usage: export <var>[=value]...
+ * Usage: export \<var>[=value]...
*
* Export an environment variable to subsequently executed scripts
*/
diff --git a/common/hush.c b/common/hush.c
index d85f85718f..c05b5642b7 100644
--- a/common/hush.c
+++ b/common/hush.c
@@ -1574,15 +1574,15 @@ U_BOOT_CMD_END
/** @page sh_command Starting shell
*
- * Usage: sh <filename> [<arguments>]
+ * Usage: sh \<filename\> [\<arguments\>]
*
- * Execute a shell script named <filename> and forward (if given)
- * <arguments> to it.
+ * Execute a shell script named \<filename\> and forward (if given)
+ * \<arguments\> to it.
*
- * Usage: . <filename> [<arguments>]
- * or source <filename> [<arguments>]
+ * Usage: . \<filename\> [\<arguments\>]
+ * or source \<filename\> [\<arguments\>]
*
- * Read and execute commands from <filename> in the current shell environment,
- * forward (if given) <arguments> to it and return the exit status of the last
+ * Read and execute commands from \<filename\> in the current shell environment,
+ * forward (if given) \<arguments\> to it and return the exit status of the last
* command executed from filename.
*/
diff --git a/lib/driver.c b/lib/driver.c
index a356b4e118..e7c98a4d36 100644
--- a/lib/driver.c
+++ b/lib/driver.c
@@ -20,6 +20,11 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/**
+ * @file
+ * @brief U-Boot's driver model, and devinfo command
+ */
+
#include <common.h>
#include <command.h>
#include <driver.h>
@@ -321,7 +326,7 @@ static __maybe_unused char cmd_devinfo_help[] =
"Usage: devinfo [DEVICE]\n"
"If called without arguments devinfo shows a summary about known devices and\n"
"drivers. If called with a device path as argument devinfo shows more detailed\n"
-"informations about this device and its parameters.\n";
+"information about this device and its parameters.\n";
U_BOOT_CMD_START(devinfo)
.maxargs = 2,
@@ -329,3 +334,30 @@ U_BOOT_CMD_START(devinfo)
.usage = "display info about devices and drivers",
U_BOOT_CMD_HELP(cmd_devinfo_help)
U_BOOT_CMD_END
+
+/**
+ * @page devinfo_command devinfo
+ *
+ * Usage is: devinfo /dev/\<device>
+ *
+ * If called without arguments devinfo shows a summary about known devices and
+ * drivers. If called with a device path as argument devinfo shows more
+ * detailed information about this device and its parameters.
+ *
+ * Example from an MPC5200 based system:
+@verbatim
+ uboot:/ devinfo /dev/eth0
+ base : 0x1002b000
+ size : 0x00000000
+ driver: fec_mpc5xxx
+
+ no info available for eth0
+ Parameters:
+ ip = 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
+ *
+ */