diff mbox

[U-Boot] x86: Add clarifications to the x86 README

Message ID 1439463625-22433-1-git-send-email-igor.stoppa@intel.com
State Superseded
Delegated to: Simon Glass
Headers show

Commit Message

Stoppa, Igor Aug. 13, 2015, 11 a.m. UTC
* Explicitly list the targets supported in each section of the
instructions from the x86 README.

* Drop references to 'raw mode', in favor of 'bare mode'.

Signed-off-by: Igor Stoppa <igor.stoppa@intel.com>
---
 doc/README.x86 | 24 ++++++++++++++----------
 1 file changed, 14 insertions(+), 10 deletions(-)

Comments

Bin Meng Aug. 13, 2015, 12:57 p.m. UTC | #1
Hi Igor,

On Thu, Aug 13, 2015 at 7:00 PM, Igor Stoppa <igor.stoppa@intel.com> wrote:
> * Explicitly list the targets supported in each section of the
> instructions from the x86 README.
>
> * Drop references to 'raw mode', in favor of 'bare mode'.
>
> Signed-off-by: Igor Stoppa <igor.stoppa@intel.com>
> ---
>  doc/README.x86 | 24 ++++++++++++++----------
>  1 file changed, 14 insertions(+), 10 deletions(-)
>
> diff --git a/doc/README.x86 b/doc/README.x86
> index af2459c..20865a5 100644
> --- a/doc/README.x86
> +++ b/doc/README.x86
> @@ -18,15 +18,17 @@ U-Boot supports running as a coreboot [1] payload on x86. So far only Link
>  work with minimal adjustments on other x86 boards since coreboot deals with
>  most of the low-level details.
>
> -U-Boot also supports booting directly from x86 reset vector without coreboot,
> -aka raw support or bare support. Currently Link, QEMU x86 targets and all
> -Intel boards support running U-Boot 'bare metal'.
> +U-Boot also supports booting directly from x86 reset vector, without coreboot.
> +In this case, known as bare mode, fom the fact that it runs on the

fom?

> +'bare metal', U-Boot acts like a BIOS replacement.

Do you intentionally leave the remaining line (till 80col) blank?

> +Currently Link, QEMU x86 targets and all Intel boards support running U-Boot
> +'bare metal'.
>
>  As for loading an OS, U-Boot supports directly booting a 32-bit or 64-bit
>  Linux kernel as part of a FIT image. It also supports a compressed zImage.
>
> -Build Instructions
> -------------------
> +Build Instructions for U-Boot as coreboot payload
> +-------------------------------------------------
>  Building U-Boot as a coreboot payload is just like building U-Boot for targets
>  on other architectures, like below:
>
> @@ -48,6 +50,8 @@ Change the 'Board configuration file' and 'Board Device Tree Source (dts) file'
>  to point to a new board. You can also change the Cache-As-RAM (CAR) related
>  settings here if the default values do not fit your new board.
>
> +Build Instructions for U-Boot as BIOS replacement (bare mode)
> +-------------------------------------------------------------
>  Building a ROM version of U-Boot (hereafter referred to as u-boot.rom) is a
>  little bit tricky, as generally it requires several binary blobs which are not
>  shipped in the U-Boot source tree. Due to this reason, the u-boot.rom build is
> @@ -87,7 +91,7 @@ Now you can build U-Boot and obtain u-boot.rom:
>  $ make chromebook_link_defconfig
>  $ make all
>
> -Intel Crown Bay specific instructions:
> +Intel Crown Bay specific instructions for bare mode:
>
>  U-Boot support of Intel Crown Bay board [4] relies on a binary blob called
>  Firmware Support Package [5] to perform all the necessary initialization steps
> @@ -122,7 +126,7 @@ Now you can build U-Boot and obtain u-boot.rom
>  $ make crownbay_defconfig
>  $ make all
>
> -Intel Minnowboard Max instructions:
> +Intel Minnowboard Max instructions for bare mode:
>
>  This uses as FSP as with Crown Bay, except it is for the Atom E3800 series.
>  Download this and get the .fd file (BAYTRAIL_FSP_GOLD_003_16-SEP-2014.fd at
> @@ -189,7 +193,7 @@ Offset   Description         Controlling config
>  Overall ROM image size is controlled by CONFIG_ROM_SIZE.
>
>
> -Intel Galileo instructions:
> +Intel Galileo instructions for bare mode:

Please also update the line for "Chromebook Link".

>
>  Only one binary blob is needed for Remote Management Unit (RMU) within Intel
>  Quark SoC. Not like FSP, U-Boot does not call into the binary. The binary is
> @@ -252,8 +256,8 @@ At present it seems that for Minnowboard Max, coreboot does not pass through
>  the video information correctly (it always says the resolution is 0x0). This
>  works correctly for link though.
>
> -Test with QEMU
> ---------------
> +Test with QEMU for bare mode
> +----------------------------
>  QEMU is a fancy emulator that can enable us to test U-Boot without access to
>  a real x86 board. Please make sure your QEMU version is 2.3.0 or above test
>  U-Boot. To launch QEMU with u-boot.rom, call QEMU as follows:
> --

Regards,
Bin
Stoppa, Igor Aug. 13, 2015, 1:19 p.m. UTC | #2
On 13 August 2015 at 15:57, Bin Meng <bmeng.cn@gmail.com> wrote:
> Hi Igor,
>
> On Thu, Aug 13, 2015 at 7:00 PM, Igor Stoppa <igor.stoppa@intel.com> wrote:

[...]

>> +In this case, known as bare mode, fom the fact that it runs on the
>
> fom?

argh, sorry, fixed

>> +'bare metal', U-Boot acts like a BIOS replacement.
>
> Do you intentionally leave the remaining line (till 80col) blank?

It felt more readable. But it's a matter of personal preferences.
Should I leave just a space?

> Please also update the line for "Chromebook Link".

done, thanks
Bin Meng Aug. 13, 2015, 1:24 p.m. UTC | #3
Hi Igor,

On Thu, Aug 13, 2015 at 9:19 PM, Stoppa, Igor <igor.stoppa@intel.com> wrote:
> On 13 August 2015 at 15:57, Bin Meng <bmeng.cn@gmail.com> wrote:
>> Hi Igor,
>>
>> On Thu, Aug 13, 2015 at 7:00 PM, Igor Stoppa <igor.stoppa@intel.com> wrote:
>
> [...]
>
>>> +In this case, known as bare mode, fom the fact that it runs on the
>>
>> fom?
>
> argh, sorry, fixed
>
>>> +'bare metal', U-Boot acts like a BIOS replacement.
>>
>> Do you intentionally leave the remaining line (till 80col) blank?
>
> It felt more readable. But it's a matter of personal preferences.
> Should I leave just a space?

Please just leave a space which is how the other part of this readme does.

>
>> Please also update the line for "Chromebook Link".
>
> done, thanks
>
> --

Regards,
Bin
diff mbox

Patch

diff --git a/doc/README.x86 b/doc/README.x86
index af2459c..20865a5 100644
--- a/doc/README.x86
+++ b/doc/README.x86
@@ -18,15 +18,17 @@  U-Boot supports running as a coreboot [1] payload on x86. So far only Link
 work with minimal adjustments on other x86 boards since coreboot deals with
 most of the low-level details.
 
-U-Boot also supports booting directly from x86 reset vector without coreboot,
-aka raw support or bare support. Currently Link, QEMU x86 targets and all
-Intel boards support running U-Boot 'bare metal'.
+U-Boot also supports booting directly from x86 reset vector, without coreboot.
+In this case, known as bare mode, fom the fact that it runs on the
+'bare metal', U-Boot acts like a BIOS replacement.
+Currently Link, QEMU x86 targets and all Intel boards support running U-Boot 
+'bare metal'.
 
 As for loading an OS, U-Boot supports directly booting a 32-bit or 64-bit
 Linux kernel as part of a FIT image. It also supports a compressed zImage.
 
-Build Instructions
-------------------
+Build Instructions for U-Boot as coreboot payload
+-------------------------------------------------
 Building U-Boot as a coreboot payload is just like building U-Boot for targets
 on other architectures, like below:
 
@@ -48,6 +50,8 @@  Change the 'Board configuration file' and 'Board Device Tree Source (dts) file'
 to point to a new board. You can also change the Cache-As-RAM (CAR) related
 settings here if the default values do not fit your new board.
 
+Build Instructions for U-Boot as BIOS replacement (bare mode)
+-------------------------------------------------------------
 Building a ROM version of U-Boot (hereafter referred to as u-boot.rom) is a
 little bit tricky, as generally it requires several binary blobs which are not
 shipped in the U-Boot source tree. Due to this reason, the u-boot.rom build is
@@ -87,7 +91,7 @@  Now you can build U-Boot and obtain u-boot.rom:
 $ make chromebook_link_defconfig
 $ make all
 
-Intel Crown Bay specific instructions:
+Intel Crown Bay specific instructions for bare mode:
 
 U-Boot support of Intel Crown Bay board [4] relies on a binary blob called
 Firmware Support Package [5] to perform all the necessary initialization steps
@@ -122,7 +126,7 @@  Now you can build U-Boot and obtain u-boot.rom
 $ make crownbay_defconfig
 $ make all
 
-Intel Minnowboard Max instructions:
+Intel Minnowboard Max instructions for bare mode:
 
 This uses as FSP as with Crown Bay, except it is for the Atom E3800 series.
 Download this and get the .fd file (BAYTRAIL_FSP_GOLD_003_16-SEP-2014.fd at
@@ -189,7 +193,7 @@  Offset   Description         Controlling config
 Overall ROM image size is controlled by CONFIG_ROM_SIZE.
 
 
-Intel Galileo instructions:
+Intel Galileo instructions for bare mode:
 
 Only one binary blob is needed for Remote Management Unit (RMU) within Intel
 Quark SoC. Not like FSP, U-Boot does not call into the binary. The binary is
@@ -252,8 +256,8 @@  At present it seems that for Minnowboard Max, coreboot does not pass through
 the video information correctly (it always says the resolution is 0x0). This
 works correctly for link though.
 
-Test with QEMU
---------------
+Test with QEMU for bare mode
+----------------------------
 QEMU is a fancy emulator that can enable us to test U-Boot without access to
 a real x86 board. Please make sure your QEMU version is 2.3.0 or above test
 U-Boot. To launch QEMU with u-boot.rom, call QEMU as follows: