diff mbox

[U-Boot,1/5] Added documentation for CONFIG_SYS_TEXT_BASE for ARM.

Message ID 20110704174320.GB3016@harvey-pc.matrox.com
State Changes Requested
Headers show

Commit Message

Christopher Harvey July 4, 2011, 5:43 p.m. UTC
Signed-off-by: Christopher Harvey <charvey@matrox.com>
---
 README |    9 +++++++++
 1 files changed, 9 insertions(+), 0 deletions(-)

Comments

Wolfgang Denk July 4, 2011, 7:39 p.m. UTC | #1
Dear Christopher Harvey,

In message <20110704174320.GB3016@harvey-pc.matrox.com> you wrote:
> Signed-off-by: Christopher Harvey <charvey@matrox.com>
> ---
>  README |    9 +++++++++
>  1 files changed, 9 insertions(+), 0 deletions(-)

Please don't make this ARM specific.  CONFIG_SYS_TEXT_BASE has the
same meaning for all architectures.

> diff --git a/README b/README
> index a760cf3..a0090ef 100644
> --- a/README
> +++ b/README
> @@ -2355,6 +2355,15 @@ Configuration Settings:
>  - CONFIG_SYS_SDRAM_BASE:
>  		Physical start address of SDRAM. _Must_ be 0 here.
>  
> +- CONFIG_SYS_TEXT_BASE:
> +		- ARM:
> +		Is the address of the u-boot code that is loaded in memory. 

To be precise: it is the address of the start address of U-Boot in
memory.

Please omit the "that is loaded in memory", because for example on
systems booting from ROM (or NOR flash etc.) nothing gets loaded.

> +		This value can be in ROM space since u-boot can run from
> +		within ROM. ...

Again, not strictly correct.  Only some parts of U-Boot (the part
before relocation) can run from ROM.

> +		        ... CONFIG_SYS_TEXT_BASE is simply called _TEXT_BASE
> +		in some files, like arch/arm/lib/board.c.

I consider this a bad idea. It should not be documented, but rather
fixed.

> +		This value has nothing to do with the relocation destination
> +		in RAM. See doc/README.arm-relocation for more info.

Again, I'm unhappy to see this being ARM specific. It ain't so, on
contrary - we changed ARM to do this so as ARMis in sync with other
architectures.


Best regards,

Wolfgang Denk
diff mbox

Patch

diff --git a/README b/README
index a760cf3..a0090ef 100644
--- a/README
+++ b/README
@@ -2355,6 +2355,15 @@  Configuration Settings:
 - CONFIG_SYS_SDRAM_BASE:
 		Physical start address of SDRAM. _Must_ be 0 here.
 
+- CONFIG_SYS_TEXT_BASE:
+		- ARM:
+		Is the address of the u-boot code that is loaded in memory. 
+		This value can be in ROM space since u-boot can run from
+		within ROM. CONFIG_SYS_TEXT_BASE is simply called _TEXT_BASE
+		in some files, like arch/arm/lib/board.c.
+		This value has nothing to do with the relocation destination
+		in RAM. See doc/README.arm-relocation for more info.
+
 - CONFIG_SYS_MBIO_BASE:
 		Physical start address of Motherboard I/O (if using a
 		Cogent motherboard)