diff mbox

[U-Boot,v5,07/13] README: document standard image variables

Message ID 1314805054-16250-8-git-send-email-jason.hobbs@calxeda.com
State Accepted
Commit dc0b7b0e619e3f1413e626dde193fe21427ac831
Headers show

Commit Message

Jason Hobbs Aug. 31, 2011, 3:37 p.m. UTC 
With these documented, we can start pushing towards standardizing their
use across boards.

Signed-off-by: Jason Hobbs <jason.hobbs@calxeda.com>
Cc: Mike Frysinger <vapier@gentoo.org>
---
new in v4

changes in v5:
- moved the doc into README alongside the other environment variables.

 README |   19 +++++++++++++++++++
 1 files changed, 19 insertions(+), 0 deletions(-)

Comments

Wolfgang Denk Oct. 17, 2011, 8:19 p.m. UTC | #1 
Dear "Jason Hobbs",

In message <1314805054-16250-8-git-send-email-jason.hobbs@calxeda.com> you wrote:
> With these documented, we can start pushing towards standardizing their
> use across boards.
> 
> Signed-off-by: Jason Hobbs <jason.hobbs@calxeda.com>
> Cc: Mike Frysinger <vapier@gentoo.org>
> ---
> new in v4
> 
> changes in v5:
> - moved the doc into README alongside the other environment variables.
> 
>  README |   19 +++++++++++++++++++
>  1 files changed, 19 insertions(+), 0 deletions(-)
> 
> diff --git a/README b/README
> index 0886987..da4a230 100644
> --- a/README
> +++ b/README
> @@ -3507,6 +3507,25 @@ List of environment variables (most likely not complete):
>  		  Ethernet is encapsulated/received over 802.1q
>  		  VLAN tagged frames.

Applied, thanks.

Best regards,

Wolfgang Denk
diff mbox

Patch

diff --git a/README b/README
index 0886987..da4a230 100644
--- a/README
+++ b/README
@@ -3507,6 +3507,25 @@  List of environment variables (most likely not complete):
 		  Ethernet is encapsulated/received over 802.1q
 		  VLAN tagged frames.
 
+The following image location variables contain the location of images
+used in booting. The "Image" column gives the role of the image and is
+not an environment variable name. The other columns are environment
+variable names. "File Name" gives the name of the file on a TFTP
+server, "RAM Address" gives the location in RAM the image will be
+loaded to, and "Flash Location" gives the image's address in NOR
+flash or offset in NAND flash.
+
+*Note* - these variables don't have to be defined for all boards, some
+boards currenlty use other variables for these purposes, and some
+boards use these variables for other purposes.
+
+Image               File Name        RAM Address       Flash Location
+-----               ---------        -----------       --------------
+u-boot              u-boot           u-boot_addr_r     u-boot_addr
+Linux kernel        bootfile         kernel_addr_r     kernel_addr
+device tree blob    fdtfile          fdt_addr_r        fdt_addr
+ramdisk             ramdiskfile      ramdisk_addr_r    ramdisk_addr
+
 The following environment variables may be used and automatically
 updated by the network boot commands ("bootp" and "rarpboot"),
 depending the information provided by your boot server: