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

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

[Igor Stoppa]

Explicitly list the targets supported in each section of the instructions
from the x86 README.

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

diff --git a/doc/README.x86 b/doc/README.x86
index af2459c..1105afe 100644
--- a/doc/README.x86
+++ b/doc/README.x86
@@ -19,14 +19,15 @@ 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'.
+aka raw support or bare support. U-Boot becomes a replacement for the BIOS.
+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 +49,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 (raw/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 +90,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 (raw 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 +125,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 (raw 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 +192,7 @@ Offset   Description         Controlling config
 Overall ROM image size is controlled by CONFIG_ROM_SIZE.
 
 
-Intel Galileo instructions:
+Intel Galileo instructions (raw 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
-- 
2.1.4

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

[Bin Meng]

Hi Igor,

On Wed, Aug 12, 2015 at 8:20 PM, Igor Stoppa <igor.stoppa@intel.com> wrote:
> Explicitly list the targets supported in each section of the instructions
> from the x86 README.
>

Nits: we should put tags in the patch/commit title, eg:

x86: Add clarifications to the x86 README

> Signed-off-by: Igor Stoppa <igor.stoppa@intel.com>
> ---
>  doc/README.x86 | 17 ++++++++++-------
>  1 file changed, 10 insertions(+), 7 deletions(-)
>
> diff --git a/doc/README.x86 b/doc/README.x86
> index af2459c..1105afe 100644
> --- a/doc/README.x86
> +++ b/doc/README.x86
> @@ -19,14 +19,15 @@ 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'.
> +aka raw support or bare support. U-Boot becomes a replacement for the BIOS.
> +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 +49,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 (raw/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 +90,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 (raw mode):

I think we don't need add (raw mode) as you already added a section
header above.

>
>  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 +125,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 (raw mode):

Ditto.

>
>  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 +192,7 @@ Offset   Description         Controlling config
>  Overall ROM image size is controlled by CONFIG_ROM_SIZE.
>
>
> -Intel Galileo instructions:
> +Intel Galileo instructions (raw mode):

Ditto.

>
>  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
> --

Regards,
Bin

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

[Simon Glass]

Hi Igor,

On 12 August 2015 at 07:27, Bin Meng <bmeng.cn@gmail.com> wrote:
> Hi Igor,
>
> On Wed, Aug 12, 2015 at 8:20 PM, Igor Stoppa <igor.stoppa@intel.com> wrote:
>> Explicitly list the targets supported in each section of the instructions
>> from the x86 README.
>>
>
> Nits: we should put tags in the patch/commit title, eg:
>
> x86: Add clarifications to the x86 README
>
>> Signed-off-by: Igor Stoppa <igor.stoppa@intel.com>
>> ---
>>  doc/README.x86 | 17 ++++++++++-------
>>  1 file changed, 10 insertions(+), 7 deletions(-)
>>
>> diff --git a/doc/README.x86 b/doc/README.x86
>> index af2459c..1105afe 100644
>> --- a/doc/README.x86
>> +++ b/doc/README.x86
>> @@ -19,14 +19,15 @@ 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'.
>> +aka raw support or bare support. U-Boot becomes a replacement for the BIOS.
>> +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 +49,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 (raw/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 +90,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 (raw mode):
>
> I think we don't need add (raw mode) as you already added a section
> header above.

I prefer 'bare mode' to 'raw mode'. It suggests that U-Boot is running
on the bare metal. Perhaps we should drop the word 'raw' and use
'bare' instead, for consistency?

>
>>
>>  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 +125,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 (raw mode):
>
> Ditto.
>
>>
>>  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 +192,7 @@ Offset   Description         Controlling config
>>  Overall ROM image size is controlled by CONFIG_ROM_SIZE.
>>
>>
>> -Intel Galileo instructions:
>> +Intel Galileo instructions (raw mode):
>
> Ditto.
>
>>
>>  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
>> --
>
> Regards,
> Bin

Regards,
Simon

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

[Stoppa, Igor]

Hi Simon,

On 12 August 2015 at 16:31, Simon Glass <sjg@chromium.org> wrote:

> I prefer 'bare mode' to 'raw mode'. It suggests that U-Boot is running
> on the bare metal. Perhaps we should drop the word 'raw' and use
> 'bare' instead, for consistency?

Yes, I could do it for the entire doc, if this is what you are suggesting.
Also from a new reader's perspective, referring to the same thing by
using 2 names can be confusing.

-- 
igor

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

[Stoppa, Igor]

Hi Bin,

On 12 August 2015 at 16:27, Bin Meng <bmeng.cn@gmail.com> wrote:
> Hi Igor,
>
> On Wed, Aug 12, 2015 at 8:20 PM, Igor Stoppa <igor.stoppa@intel.com> wrote:
>> Explicitly list the targets supported in each section of the instructions
>> from the x86 README.
>>
>
> Nits: we should put tags in the patch/commit title, eg:
>
> x86: Add clarifications to the x86 README

ok, will fix it

[...]

>> -Intel Crown Bay specific instructions:
>> +Intel Crown Bay specific instructions (raw mode):
>
> I think we don't need add (raw mode) as you already added a section
> header above.

This was intentional. You are absolutely right that it's redundant,
but I was trying to make the doc more friendly toward someone (like
yours truly :-) who approaches it for the first time.
Reading it, sometimes I had the feeling I wasn't 100% sure of what a
certain section was referring to.

Some sections are not exactly short.

But if you still think it should be removed, I'll do so.

-- 
igor

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

[Bin Meng]

Hi Igor,

On Wed, Aug 12, 2015 at 9:40 PM, Stoppa, Igor <igor.stoppa@intel.com> wrote:
> Hi Bin,
>
> On 12 August 2015 at 16:27, Bin Meng <bmeng.cn@gmail.com> wrote:
>> Hi Igor,
>>
>> On Wed, Aug 12, 2015 at 8:20 PM, Igor Stoppa <igor.stoppa@intel.com> wrote:
>>> Explicitly list the targets supported in each section of the instructions
>>> from the x86 README.
>>>
>>
>> Nits: we should put tags in the patch/commit title, eg:
>>
>> x86: Add clarifications to the x86 README
>
> ok, will fix it
>
> [...]
>
>>> -Intel Crown Bay specific instructions:
>>> +Intel Crown Bay specific instructions (raw mode):
>>
>> I think we don't need add (raw mode) as you already added a section
>> header above.
>
> This was intentional. You are absolutely right that it's redundant,
> but I was trying to make the doc more friendly toward someone (like
> yours truly :-) who approaches it for the first time.
> Reading it, sometimes I had the feeling I wasn't 100% sure of what a
> certain section was referring to.

I am OK, Simon?

>
> Some sections are not exactly short.
>
> But if you still think it should be removed, I'll do so.
>

Regards,
Bin

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

[Simon Glass]

Hi,

On 12 August 2015 at 07:59, Bin Meng <bmeng.cn@gmail.com> wrote:
> Hi Igor,
>
> On Wed, Aug 12, 2015 at 9:40 PM, Stoppa, Igor <igor.stoppa@intel.com> wrote:
>> Hi Bin,
>>
>> On 12 August 2015 at 16:27, Bin Meng <bmeng.cn@gmail.com> wrote:
>>> Hi Igor,
>>>
>>> On Wed, Aug 12, 2015 at 8:20 PM, Igor Stoppa <igor.stoppa@intel.com> wrote:
>>>> Explicitly list the targets supported in each section of the instructions
>>>> from the x86 README.
>>>>
>>>
>>> Nits: we should put tags in the patch/commit title, eg:
>>>
>>> x86: Add clarifications to the x86 README
>>
>> ok, will fix it
>>
>> [...]
>>
>>>> -Intel Crown Bay specific instructions:
>>>> +Intel Crown Bay specific instructions (raw mode):
>>>
>>> I think we don't need add (raw mode) as you already added a section
>>> header above.
>>
>> This was intentional. You are absolutely right that it's redundant,
>> but I was trying to make the doc more friendly toward someone (like
>> yours truly :-) who approaches it for the first time.
>> Reading it, sometimes I had the feeling I wasn't 100% sure of what a
>> certain section was referring to.
>
> I am OK, Simon?

Yes.

>
>>
>> Some sections are not exactly short.
>>
>> But if you still think it should be removed, I'll do so.
>>
>
> Regards,
> Bin

Regards,
Simon

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

[Igor Stoppa]

* 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
+'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:
-- 
2.1.4

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

[Bin Meng]

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

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

[Stoppa, Igor]

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

-- 
igor

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

[Bin Meng]

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

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

[Igor Stoppa]

* 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 | 32 +++++++++++++++++++++-----------
 1 file changed, 21 insertions(+), 11 deletions(-)

diff --git a/doc/README.x86 b/doc/README.x86
index af2459c..9012541 100644
--- a/doc/README.x86
+++ b/doc/README.x86
@@ -18,15 +18,16 @@ 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, from 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 +49,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
@@ -58,7 +61,9 @@ $ export BUILD_ROM=y
 
 This tells the Makefile to build u-boot.rom as a target.
 
-Link-specific instructions:
+---
+
+Chromebook Link specific instructions for bare mode:
 
 First, you need the following binary blobs:
 
@@ -87,7 +92,9 @@ 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 +129,9 @@ 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
@@ -188,8 +197,9 @@ 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 +262,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:
-- 
2.1.4

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

[Bin Meng]

On Thu, Aug 13, 2015 at 9:43 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 | 32 +++++++++++++++++++++-----------
>  1 file changed, 21 insertions(+), 11 deletions(-)
>
> diff --git a/doc/README.x86 b/doc/README.x86
> index af2459c..9012541 100644
> --- a/doc/README.x86
> +++ b/doc/README.x86
> @@ -18,15 +18,16 @@ 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, from 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 +49,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
> @@ -58,7 +61,9 @@ $ export BUILD_ROM=y
>
>  This tells the Makefile to build u-boot.rom as a target.
>
> -Link-specific instructions:
> +---
> +
> +Chromebook Link specific instructions for bare mode:
>
>  First, you need the following binary blobs:
>
> @@ -87,7 +92,9 @@ 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 +129,9 @@ 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
> @@ -188,8 +197,9 @@ 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 +262,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:
> --

Reviewed-by: Bin Meng <bmeng.cn@gmail.com>

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

[Simon Glass]

On 13 August 2015 at 07:54, Bin Meng <bmeng.cn@gmail.com> wrote:
> On Thu, Aug 13, 2015 at 9:43 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 | 32 +++++++++++++++++++++-----------
>>  1 file changed, 21 insertions(+), 11 deletions(-)
>>
>> diff --git a/doc/README.x86 b/doc/README.x86
>> index af2459c..9012541 100644
>> --- a/doc/README.x86
>> +++ b/doc/README.x86
>> @@ -18,15 +18,16 @@ 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, from 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 +49,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
>> @@ -58,7 +61,9 @@ $ export BUILD_ROM=y
>>
>>  This tells the Makefile to build u-boot.rom as a target.
>>
>> -Link-specific instructions:
>> +---
>> +
>> +Chromebook Link specific instructions for bare mode:
>>
>>  First, you need the following binary blobs:
>>
>> @@ -87,7 +92,9 @@ 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 +129,9 @@ 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
>> @@ -188,8 +197,9 @@ 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 +262,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:
>> --
>
> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>

Applied to u-boot-x86, thanks!

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

[Stoppa, Igor]

Explicitly list the targets supported in each section of the
instructions
from the x86 README.
---
doc/README.x86 | 17 ++++++++++-------
1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/doc/README.x86 b/doc/README.x86
index af2459c..1105afe 100644
--- a/doc/README.x86
+++ b/doc/README.x86
@@ -19,14 +19,15 @@ 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'.
+aka raw support or bare support. U-Boot becomes a replacement for the
BIOS.
+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 +49,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 (raw/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 +90,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 (raw 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 +125,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 (raw 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 +192,7 @@ Offset   Description         Controlling config
Overall ROM image size is controlled by CONFIG_ROM_SIZE.


-Intel Galileo instructions:
+Intel Galileo instructions (raw 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
--
2.1.4

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

[Bin Meng]

+Simon.

Hi Igor,

On Wed, Aug 12, 2015 at 6:41 PM, Stoppa, Igor <igor.stoppa@intel.com> wrote:
> Explicitly list the targets supported in each section of the
> instructions
> from the x86 README.

Please add "Signed-off-by" in your patch.

> ---
> doc/README.x86 | 17 ++++++++++-------
> 1 file changed, 10 insertions(+), 7 deletions(-)
>
> diff --git a/doc/README.x86 b/doc/README.x86
> index af2459c..1105afe 100644
> --- a/doc/README.x86
> +++ b/doc/README.x86
> @@ -19,14 +19,15 @@ 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'.
> +aka raw support or bare support. U-Boot becomes a replacement for the
> BIOS.
> +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 +49,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 (raw/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 +90,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 (raw 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 +125,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 (raw 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 +192,7 @@ Offset   Description         Controlling config
> Overall ROM image size is controlled by CONFIG_ROM_SIZE.
>
>
> -Intel Galileo instructions:
> +Intel Galileo instructions (raw 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
> --

Looks like your patch format is broken. Did you create and send the
patch using "git format-patch" and "git send-email"?

Regards,
Bin

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

[Stoppa, Igor]

Hi Bin,

On 12 August 2015 at 13:59, Bin Meng <bmeng.cn@gmail.com> wrote:
> +Simon.
>
> Hi Igor,
>
> On Wed, Aug 12, 2015 at 6:41 PM, Stoppa, Igor <igor.stoppa@intel.com> wrote:
>> Explicitly list the targets supported in each section of the
>> instructions
>> from the x86 README.
>
> Please add "Signed-off-by" in your patch.

yes, sorry, I forgot it

> Looks like your patch format is broken. Did you create and send the
> patch using "git format-patch" and "git send-email"?

yes, but the last step seems to fail from within the corporate intranet, so I
tried to copy the patch in my mail client

I'll figure out how to send it properly

-- 
igor