diff options
Diffstat (limited to 'board/board.dox')
| -rw-r--r-- | board/board.dox | 60 |
1 files changed, 35 insertions, 25 deletions
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. |