From: Lothar Waßmann <LW@KARO-electronics.de>
Date: Fri, 13 Dec 2013 10:02:04 +0000 (+0100)
Subject: doc: updated KARO README files
X-Git-Tag: KARO-TX-2013-12-13~4
X-Git-Url: https://git.karo-electronics.de/?a=commitdiff_plain;h=5bd10b3a3e49384ccca4f32287f8ee526605f6a6;p=karo-tx-uboot.git

doc: updated KARO README files
---

diff --git a/doc/README.KARO-TX28 b/doc/README.KARO-TX28
index 6f3f20e014..1b082f0606 100644
--- a/doc/README.KARO-TX28
+++ b/doc/README.KARO-TX28
@@ -9,7 +9,7 @@ Note: There are currently two variants of the TX28 module, that
       distinguished through the last digit of the module name. Replace
       the '?' in the following description with the corresponding
       number from your TX28 module.
-      E.g. TX28-4031 => 'make tx28-40xx_config'
+      E.g. TX28-4031 => 'make tx28-40x1_config'
 
 Unpacking the source
 --------------------
@@ -24,21 +24,23 @@ git://git.kernelconcepts.de/karo-tx-uboot.git master
 Compiling U-Boot
 ----------------
 export ARCH=arm
-export CROSS_COMPILE=arm-cortexa8-linux-gnueabi-
-make tx28-4?xx_config            (see above Note!)
+export CROSS_COMPILE=arm-926ejs-linux-gnueabi-
+make tx28-4?x?_config            (see above Note!)
 make
 
 
 Flashing U-Boot Image
 ---------------------
 If you want to replace a working U-Boot with a new version, you can
-load the new U-Boot image via TFTP and program it like any other flash
-partition with:
-nand erase.part u-boot;nand write.trimffs ${fileaddr} u-boot ${filesize}
+load the new U-Boot image via TFTP or SD-Card and write it to flash
+with the 'romupdate' command.
 
 If you want to revive a bricked module, U-Boot can be downloaded via
-USB with the 'sbloader' tool in recovery boot mode (Jumper ST3
-on Starterkit-5 baseboard closed). See TX28-U-Boot.pdf for details.
+USB with the 'sbloader' tool in recovery boot mode (Bootmode jumper ST3
+on Starterkit-5 baseboard closed). See TX28_U-Boot.pdf for details.
+
+e.g.: /cdrom/Flashtools/Linux/sbloader/sbloader-x86_32 -s /cdrom/U-Boot/u-boot-tx28-4031.bin
+(This command can be used from within the ARMSK-VM)
 
 
 U-Boot Features
@@ -46,12 +48,24 @@ U-Boot Features
 
 Environment variables:
 
-cpu_clk       <CPU freq [MHz]>
-touchpanel    {tsc2007|edt-ft5x06}
-otg_mode      [host|device|none]
-video_mode    <video mode as understood by Linux fb_find_mode() function>
-              e.g.: VGA-1:640x480MR-24@60
+cpu_clk       <CPU freq [MHz]> CPU clock frequency set after boot.
+
+touchpanel    {tsc2007|edt-ft5x06|imx28-lradc} type of touchpanel.
+	      No touchpanel will be enabled when unset.
+
+otg_mode      [host|device|none] operation mode of the USBOTG port
+
+video_mode    <one of the display names from the Glyn Family Concept or
+	      a video mode as understood by Linux fb_find_mode() function
+              (e.g.: 640x480MR-24@60)>
+	      LCD interface will be disabled when unset.
+
 baseboard     {stk5-v3|stk5-v5} selects type of baseboard
+	      'stk5-v5' setting disables USB Host mode on USBOTG port
+	      and redefines the LCD0 pin as CAN transceiver control pin.
+	      Strings not starting in 'stk5' prevent the STK5 specific
+	      pad initialization to be done.
+
 splashimage   either: memory address (e.g. ${loadaddr}) of a BMP file
 	      to be displayed instead of the built-in logo. Since NAND
 	      flash is not accessible in a memory mapped fashion,
@@ -72,6 +86,7 @@ splashpos     (when 'splashimage' contains a memory address) the
 Note: Some variables (like 'cpu_clk' or 'splashimage') may render the
       board unbootable if incorrectly set. Therefore these variables
       will not be evaluated in case the board has been reset through a
-      watchdog reset or a character is available on the serial console
+      watchdog reset or <CTRL-C> is detected on the serial console
       during startup to give the user a chance to recover from this
-      situation.
+      situation. You should press and hold <CTRL-C> before applying
+      power to the module, for this to work.
diff --git a/doc/README.KARO-TX48 b/doc/README.KARO-TX48
index 8cc6cd9a96..94e21d007e 100644
--- a/doc/README.KARO-TX48
+++ b/doc/README.KARO-TX48
@@ -39,12 +39,24 @@ U-Boot Features
 
 Environment variables:
 
-cpu_clk       <CPU freq [MHz]>
-touchpanel    {tsc2007|edt-ft5x06}
-otg_mode      [host|device|none]
-video_mode    <video mode as understood by Linux fb_find_mode() function>
-              e.g.: 640x480MR-24@60
+cpu_clk       <CPU freq [MHz]> CPU clock frequency set after boot.
+
+touchpanel    {tsc2007|edt-ft5x06|am3359-tscadc} type of touchpanel.
+	      No touchpanel will be enabled when unset.
+
+otg_mode      [host|device|none] operation mode of the USBOTG port
+
+video_mode    <one of the display names from the Glyn Family Concept or
+	      a video mode as understood by Linux fb_find_mode() function
+              (e.g.: 640x480MR-24@60)>
+	      LCD interface will be disabled when unset.
+
 baseboard     {stk5-v3|stk5-v5} selects type of baseboard
+	      'stk5-v5' setting disables USB Host mode on USBOTG port
+	      and redefines the LCD0 pin as CAN transceiver control pin.
+	      Strings not starting in 'stk5' prevent the STK5 specific
+	      pad initialization to be done.
+
 splashimage   either: memory address (e.g. ${loadaddr}) of a BMP file
 	      to be displayed instead of the built-in logo. Since NAND
 	      flash is not accessible in a memory mapped fashion,
@@ -65,6 +77,7 @@ splashpos     (when 'splashimage' contains a memory address) the
 Note: Some variables (like 'cpu_clk' or 'splashimage') may render the
       board unbootable if incorrectly set. Therefore these variables
       will not be evaluated in case the board has been reset through a
-      watchdog reset or a character is available on the serial console
+      watchdog reset or <CTRL-C> is detected on the serial console
       during startup to give the user a chance to recover from this
-      situation.
+      situation. You should press and hold <CTRL-C> before applying
+      power to the module, for this to work.
diff --git a/doc/README.KARO-TX51 b/doc/README.KARO-TX51
index 078e8362ef..586d025fd5 100644
--- a/doc/README.KARO-TX51
+++ b/doc/README.KARO-TX51
@@ -7,14 +7,12 @@ Building U-Boot
 Note: There are currently three variants of the TX51 module, that
       require slightly different U-Boot configurations. They are
       distinguished through the last digit of the module name
-      suffix. The following table lists the module names and the
-      corresponding U-Boot configuration name:
+      suffix. The configuration names depending on the last digit of
+      the module name are:
+      TX51-8??0                 tx51-8xx0_config
+      TX51-8??1                 tx51-8xx1_2_config
+      TX51-8??2                 tx51-8xx1_2_config
 
-      Module Name		U-Boot config
-      ---------------------------------------
-      TX51-8xx0			tx51-8xx0_config
-      TX51-8xx1			tx51-8xx1_2_config
-      TX51-8xx2			tx51-8xx1_2_config
 
 Unpacking the source
 --------------------
@@ -50,15 +48,24 @@ U-Boot Features
 
 Environment variables:
 
-cpu_clk       <CPU freq [MHz]>
-touchpanel    {tsc2007|edt-ft5x06}
-otg_mode      [host|device|none]
-video_mode    <video mode as understood by Linux fb_find_mode() function>
-              e.g.: VGA-1:640x480MR-24@60
+cpu_clk       <CPU freq [MHz]> CPU clock frequency set after boot.
+
+touchpanel    {tsc2007|edt-ft5x06} type of touchpanel.
+	      No touchpanel will be enabled when unset.
+
+otg_mode      [host|device|none] operation mode of the USBOTG port
+
+video_mode    <one of the display names from the Glyn Family Concept or
+	      a video mode as understood by Linux fb_find_mode() function
+              (e.g.: 640x480MR-24@60)>
+	      LCD interface will be disabled when unset.
+
 baseboard     {stk5-v3|stk5-v5} selects type of baseboard
-	      'stk5-v5' setting disables USB Host mode on USBOTG port.
-	      strings not starting in 'stk5' prevent the STK5 specific
+	      'stk5-v5' setting disables USB Host mode on USBOTG port
+	      and redefines the LCD0 pin as CAN transceiver control pin.
+	      Strings not starting in 'stk5' prevent the STK5 specific
 	      pad initialization to be done.
+
 splashimage   either: memory address (e.g. ${loadaddr}) of a BMP file
 	      to be displayed instead of the built-in logo. Since NAND
 	      flash is not accessible in a memory mapped fashion,
@@ -79,6 +86,7 @@ splashpos     (when 'splashimage' contains a memory address) the
 Note: Some variables (like 'cpu_clk' or 'splashimage') may render the
       board unbootable if incorrectly set. Therefore these variables
       will not be evaluated in case the board has been reset through a
-      watchdog reset or a character is available on the serial console
+      watchdog reset or <CTRL-C> is detected on the serial console
       during startup to give the user a chance to recover from this
-      situation.
+      situation. You should press and hold <CTRL-C> before applying
+      power to the module, for this to work.
diff --git a/doc/README.KARO-TX53 b/doc/README.KARO-TX53
index de432bce75..5f8c5404e3 100644
--- a/doc/README.KARO-TX53
+++ b/doc/README.KARO-TX53
@@ -5,11 +5,16 @@ Building U-Boot
 ---------------
 
 Note: There are currently two variants of the TX53 module, that
-      require slightly different U-Boot configurations. They are
-      distinguished through the last digit of the module name. Replace
-      the '?' in the following description with the corresponding
-      number from your TX51 module.
-      E.g. TX53-8031 => 'make tx53-xx31_config'
+      require slightly different U-Boot configurations. The mapping
+      between module names and U-Boot config make targets is as
+      following:
+
+      Module Name       U-Boot config target
+      =====================================
+      TX53-8030		tx53-x030_config'
+      TX53-8130		tx53-x130_config'
+      TX53-1030		tx53-x030_config'
+      TX53-1331		tx53-x131_config'
 
 Unpacking the source
 --------------------
@@ -25,7 +30,7 @@ Compiling U-Boot
 ----------------
 export ARCH=arm
 export CROSS_COMPILE=arm-cortexa8-linux-gnueabi-
-make tx53-xx3?_config            (see above Note!)
+make tx53-x?3?_config            (see above Note!)
 make
 
 
@@ -45,16 +50,24 @@ U-Boot Features
 
 Environment variables:
 
-cpu_clk       <CPU freq [MHz]>
-touchpanel    {tsc2007|edt-ft5x06}
-otg_mode      [host|device|none]
-video_mode    <video mode as understood by Linux fb_find_mode() function>
-              e.g.: VGA-1:640x480MR-24@60
+cpu_clk       <CPU freq [MHz]> CPU clock frequency set after boot.
+
+touchpanel    {tsc2007|edt-ft5x06|egalax_ts} type of touchpanel.
+	      No touchpanel will be enabled when unset.
+
+otg_mode      [host|device|none] operation mode of the USBOTG port
+
+video_mode    <one of the display names from the Glyn Family Concept or
+	      a video mode as understood by Linux fb_find_mode() function
+              (e.g.: 640x480MR-24@60)>
+	      LCD interface will be disabled when unset.
+
 baseboard     {stk5-v3|stk5-v5} selects type of baseboard
-	      'stk5-v5' setting enables CAN transceiver switch on GPIO4_21 and
-	      disables USB Host mode on USBOTG port.
-	      strings not starting in 'stk5' prevent the STK5 specific
+	      'stk5-v5' setting disables USB Host mode on USBOTG port
+	      and redefines the LCD0 pin as CAN transceiver control pin.
+	      Strings not starting in 'stk5' prevent the STK5 specific
 	      pad initialization to be done.
+
 splashimage   either: memory address (e.g. ${loadaddr}) of a BMP file
 	      to be displayed instead of the built-in logo. Since NAND
 	      flash is not accessible in a memory mapped fashion,
@@ -75,6 +88,7 @@ splashpos     (when 'splashimage' contains a memory address) the
 Note: Some variables (like 'cpu_clk' or 'splashimage') may render the
       board unbootable if incorrectly set. Therefore these variables
       will not be evaluated in case the board has been reset through a
-      watchdog reset or a character is available on the serial console
+      watchdog reset or <CTRL-C> is detected on the serial console
       during startup to give the user a chance to recover from this
-      situation.
+      situation. You should press and hold <CTRL-C> before applying
+      power to the module, for this to work.
diff --git a/doc/README.KARO-TX6 b/doc/README.KARO-TX6
new file mode 100644
index 0000000000..edf595e8d3
--- /dev/null
+++ b/doc/README.KARO-TX6
@@ -0,0 +1,102 @@
+                                        U-Boot for TX6
+                                        ==============
+
+Building U-Boot
+---------------
+
+Note: There are currently six variants of the TX6 module, that
+      require slightly different U-Boot configurations. They are
+      distinguished through the 'TX6' suffix 'Q' or 'U' and the
+      numerical suffix of the module name. Replace the '?' in the
+      following description with the corresponding digits from your
+      TX6 module.
+      E.g. TX6Q-1010 => 'make tx6q-1010_config'
+
+Unpacking the source
+--------------------
+mkdir u-boot
+cd u-boot
+tar -xjf /cdrom/U-Boot/u-boot-src.tar.bz2
+
+Alternatively you can access the current source via the git repository:
+git://git.kernelconcepts.de/karo-tx-uboot.git master
+
+
+Compiling U-Boot
+----------------
+export ARCH=arm
+export CROSS_COMPILE=arm-cortexa9-linux-gnueabi-
+make tx6?-??1?_config            (see above Note!)
+make
+
+
+Flashing U-Boot Image
+---------------------
+If you want to replace a working U-Boot with a new version, you can
+load the new U-Boot image via TFTP or SD-Card and write it to flash
+with the 'romupdate' command.
+
+If you want to revive a bricked module, U-Boot can be downloaded via
+USB with the 'sbloader' tool in recovery boot mode (Bootmode jumper ST3
+on Starterkit-5 baseboard closed). See TX6_U-Boot.pdf for details.
+
+e.g.: /cdrom/Flashtools/Linux/sbloader/sbloader-x86_32 -m -s /cdrom/U-Boot/target/u-boot-tx6q-1010.bin
+(This command can be used from within the ARMSK-VM)
+
+MfgTool
+-------
+For Windows users the application MfgTool allows the (re-)flashing of
+U-Boot. For more information either see:
+
+\U-Boot\TX6Q_U-Boot.pdf
+\STK5_TX6Q_Quickstart_Guide.pdf
+\Flashtools\Windows\Mfgtools-TX6...
+
+
+U-Boot Features
+---------------
+
+Environment variables:
+
+cpu_clk       <CPU freq [MHz]> CPU clock frequency set after boot.
+
+touchpanel    {tsc2007|edt-ft5x06|egalax_ts} type of touchpanel.
+	      No touchpanel will be enabled when unset.
+
+otg_mode      [host|device|none] operation mode of the USBOTG port
+
+video_mode    <one of the display names from the Glyn Family Concept or
+	      a video mode as understood by Linux fb_find_mode() function
+              (e.g.: 640x480MR-24@60)>
+	      LCD interface will be disabled when unset.
+
+baseboard     {stk5-v3|stk5-v5} selects type of baseboard
+	      'stk5-v5' setting disables USB Host mode on USBOTG port
+	      and redefines the LCD0 pin as CAN transceiver control pin.
+	      Strings not starting in 'stk5' prevent the STK5 specific
+	      pad initialization to be done.
+
+splashimage   either: memory address (e.g. ${loadaddr}) of a BMP file
+	      to be displayed instead of the built-in logo. Since NAND
+	      flash is not accessible in a memory mapped fashion,
+	      U-Boot will try to load the contents of the flash
+	      partition 'logo.bmp' to the address given with
+	      'splashimage'.
+
+	      or: the name of an MTD partition, that contains a raw
+	      dump of the frame buffer contents which will be loaded
+	      to the framebuffer.
+
+splashpos     (when 'splashimage' contains a memory address) the
+	      position ('x,y') on the screen at which the BMP image
+	      will be displayed.
+	      Setting splashpos to 'm,m' will center the image on the
+	      screen.
+
+Note: Some variables (like 'cpu_clk' or 'splashimage') may render the
+      board unbootable if incorrectly set. Therefore these variables
+      will not be evaluated in case the board has been reset through a
+      watchdog reset or <CTRL-C> is detected on the serial console
+      during startup to give the user a chance to recover from this
+      situation. You should press and hold <CTRL-C> before applying
+      power to the module, for this to work.