summaryrefslogtreecommitdiffstats
path: root/arch/x86
diff options
context:
space:
mode:
authorSascha Hauer <s.hauer@pengutronix.de>2014-06-17 10:27:03 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2014-06-26 10:09:52 +0200
commit98360be0fefd58bf27df03c47d887dd676a31d73 (patch)
tree76447f0ee3d99f3864bdfb9952178affb5dc9f76 /arch/x86
parent7b82f548580fb52023ed2116784632fd996a51fc (diff)
downloadbarebox-98360be0fefd58bf27df03c47d887dd676a31d73.tar.gz
Documentation: remove doxygen documentation
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>
Diffstat (limited to 'arch/x86')
-rw-r--r--arch/x86/boards/x86_generic/generic_pc.c34
-rw-r--r--arch/x86/boot/bioscall.S4
-rw-r--r--arch/x86/lib/bios_disk.S3
-rw-r--r--arch/x86/lib/linux_start.S3
-rw-r--r--arch/x86/mach-x86.dox128
5 files changed, 0 insertions, 172 deletions
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
--- a/arch/x86/mach-x86.dox
+++ /dev/null
@@ -1,128 +0,0 @@
-/* This document is intended to provide the developer with information
- * how to integrate a new CPU (MACH) into this part of the barebox tree
- */
-
-/** @page dev_x86_mach barebox on x86 at runtime
-
-@section mach_x86_memory_layout barebox's memory layout (BIOS based)
-
-@a barebox uses the following memory layout at runtime when it still depends
-on some kind of BIOS function:
-
-@verbatim
- Addresses
-------------------------
-
- seg:off flat
-
-xxxx:xxxx 0x01xxxxxx end of barebox's malloc area
- . .
-xxxx:xxxx 0x01000000 start of barebox's malloc area
- . .
- . . (used while loading a Linux kernel of type 'bzImage')
- . .
-xxxx:xxxx 0x00100000 start of extended memory and malloc area
- . .
- . . (the big hole)
- . .
-9000:ffff 0x0009ffff end of expected real mode memory
- . .
- . . (used while loading a Linux kernel of type 'bzImage')
- . .
-9000:0000 0x00090000 end of used lower real mode memory
- . .
- . .
- . . Flat mode stack (about 32 kiB)
- . . bss
- . . Data
- . . Text
-0000:7e00 0x00007e00 Real and flat mode barebox code
-0000:7c00 0x00007c00 MBR initial boot loader code
-0000:7a00 0x00007a00 location of the indirect sector (while booting only)
- below: real mode stack
-@endverbatim
-
-@note The start address of 0x0000:7c000 is a fixed one, defined by the BIOS.
-So, for a BIOS based @a barebox this address can't be changed.
-
-While the @a barebox code is runnung in flat mode, all interrupts are disabled.
-But in the CPU only. All other interrupt settings are still valid. This is
-required to be able to call real mode code from inside @a barebox flat mode
-code. Thats why not the PIC is touched nor the IDT.
-
-@todo Add some notes about drive numbers used by the BIOS. They may change
-if one change orders in the BIOS setup. Drive orders and numbers may be
-different at BIOS runtime and Linux runtime! But these numbers are required
-at BIOS runtime for booting and the persistant environment storage.
-
-@attention Currently there is a 4 GiB limit for the disk sizes!
-
-@section mach_x86_image_layout barebox's image layout
-
-@a barebox's binary image layout
-
-@verbatim
- Offset Content
-
- 0x?????
- . 32 bit barebox code
- .
- . 16 bit bootstrap code, BIOS calling code
- 0x00400
- 0x003ff
- . indirect sector
- 0x00200
- 0x001ff
- . MBR
- 0x00000
-@endverbatim
-
-The "indirect sector" is a free area in the image where the sector information
-gets stored when this image will be written to a boot media. This information
-is required to load all parts of the image from the boot media at runtime.
-
-The image gets installed in two ways onto the boot media, depending on the
-need for a persistant storage.
-
-@subsection mach_x86_drive_layout_wops barebox's boot media layout without persistant storage
-
-In this case @a barebox's persistant storage is anywhere:
-
-@verbatim
- Sector Content
----------------------------
- X start of first partition
- .
- ? end of the binary image
- . 32 bit barebox code
- 2 16 bit bootstrap code, BIOS calling code
- 1 indirect sector
- 0 MBR, Partition table, boot code
-@endverbatim
-
-@subsection mach_x86_drive_layout_wps barebox's boot media layout with persistant storage
-
-@a barebox's persistant storage is part of the boot media (more
-space required in front of the first partition) and interferes with the
-boot loader image itself:
-
-@verbatim
- Sector Content
----------------------------
- X start of first partition
- .
- n+? end of the binary image
- . 32 bit barebox code
- n+2 16 bit bootstrap code, BIOS calling code
- n+1 indirect sector
- n end of persistant environment storage
- .
- 1 start of persistant environment storage
- 0 MBR, Partition table, boot code
-@endverbatim
-
-The information where the persistant storage is located is also stored into
-the MBR at specific locations by @p setupmbr. The @a barebox runtime will use
-it to load and store all environment relevant data.
-
-*/