RedBoot for Freescale i.mx27

Transcription

1 RedBoot for Freescale i.mx27 Redboot has been ported to the i.mx27 ADS/EVB boards. This document describes how to load, run and build Redboot images on the board(s). 1 Overview RedBoot is an open source boot firmware based on the ecos Hardware Abstraction Layer. It was designed to be very portable, extensible, and configurable. Some of the features are: Host connectivity via RS-232 or Ethernet Command line interface via RS-232 or Telnet Image downloads via HTTP, TFTP, X-Modem, or Y-Modem Support for compressed images (download and flash load) Flash Image System for managing multiple flash images Flash stored configuration Boot time script execution GDB BOOTP For more information on RedBoot, refer to 2 Board Dip Switches Setup Be sure to follow the switch settings required for the board in order to have Redboot up and running properly. 2.1 i.mx27 EVB Settings Pay attention to these notes before checking the dip switches: - The same Redboot supports both EVB and ADS - Make sure the 26MHz crystal is populated on Y1 on the EVB - Both external UART and internal UART1 has Redboot prompt (except for EVB Rev A) - The CS8900A Ethernet port is the one right next to the UART ports). The other Ethernet port is for the FEC which is not supported by the Redboot yet. - Also make sure the JP46 is jumpered for pin 1 & 2 in order to enable the EEPROM used by CS8900A Ethernet controller for MAC address. - For some EVB boards that have problem booting from NOR flash with the suggested dip switch settings below, try set SW3 [8-5]: ON-OFF-OFF-ON and then power cycle the board. The following table shows the dip switch settings for different boot modes. Switch Label Bootstrap for Flash Programming Boot from 16bit NOR Flash Boot from NAND Flash SW3-8 BOOT0 ON OFF OFF SW3-7 BOOT1 ON ON OFF SW3-6 BOOT2 ON OFF OFF SW3-5 BOOT3 ON ON ON The following table lists the other switch settings: Switch SW3 OFF ON ON OFF S3 ON ON OFF OFF OFF OFF Freescale 1

2 2.2 i.mx27 ADS Settings Switch S7 OFF OFF OFF OFF S9 OFF OFF ON ON OFF OFF S10 ON ON ON ON S11 ON OFF ON ON OFF ON S12 ON ON ON ON S14 OFF OFF ON OFF OFF OFF S15 OFF OFF OFF OFF Pay attention to these notes before checking the dip switches: - The same Redboot supports both EVB and ADS - Both external UART and internal UART1 has Redboot prompt - The CS8900A Ethernet port is the one right next to the UART ports). The other Ethernet port is for the FEC which is not supported by the Redboot yet. The following table shows the dip switch settings for different boot modes. Switch Label Bootstrap for Flash Programming Boot from 16bit NOR Flash Boot from NAND Flash (8-bit) S18-8 BOOT0 ON OFF OFF S18-7 BOOT1 ON ON OFF S18-6 BOOT2 ON OFF OFF S18-5 BOOT3 ON ON ON The rest of the dip switches should remain as default. 3 Image Install Instructions 3.1 Programming Through ARM ADS Following the these steps to do the flash programming using ARM ADS version 1.2 (1.1 will not work): 1. Make sure the dip switches are setup properly as mentioned in the previous section. 2. Copy the proper init_ddr.txt file to c:\program files\arm\adsv1_2\bin. This assumes the ARM tools are installed under C:\Program files directory. If you have a different installation directory, use the one that is suitable for your system. 3. Edit the init_ddr.txt file to fix the path name where the Redboot binary is located on your system. 4. Use a DB-9 serial cable to connect to the internal UART1 and start your terminal program. 5. Power up the ADS board. 6. Start Multi-ICE server on the PC and auto-configure the Multi-ICE server. 7. Start up the ARM AXD Debugger and check configured for Multi-ICE. Open the Control monitor window by selecting 'Control Monitor' from the System Views menu. Select the 'Target' tab. In the target window, right click on ARM926EJ_S_0 and choose properties. Clear all the vector catch checkboxes. Clear the Enable Comms Channel Viewer checkbox. Clear the semihosting checkbox. 8. Open the Command Line Interface by choosing System Views Command Line Interface In the Command Line Interface window, type the following instructions: obey init_ddr.txt 2 Freescale Semiconductor

3 9. In AXD, Execute the image by selecting Go from the 'Execute' menu. 10. Redboot prompt should come up on UART Follow the 3.3 Programming the Running Redboot into Flash on page 4 to burn Redboot into the NOR flash. 3.2 Programming Through ARM RVDS To download the Redboot image and run it, ARM RealView tools can be used (RVDS2.2 with RealView ICE 1.1). The following describes the RealView tools requirement and how to do it via RealView Debugger along with RealView ICE Preparation - ARM RealView Tools Setup (Optional) ARM RealView tools are required only if there is no Redboot in the flash. Once the Redboot is already in the flash such that it can start successfully from external boot, the ARM RealView tools are not needed. In this case, skip to the next section. The following table lists ARM tools requirement based on RVDS2.1. RVDS2.2 can also work. Table 1-1. Resources needed for RealView ICE Configuration Resource Description Source RVDS RealView ARM RealView Tools ARM Developer Suite v 2.1 RealView ICE Version ARM RealView ICE ARM 1.1 License for RealView tools License ARM build183.rvi and Metrowerks-RVI patch- MWZAS1.rvi RV-ICE firmware updates 1. Install the RVDS tools. Get and setup the license for the ARM tools. 2. Install the RealView ICE 1.1 software and download the RV-ICE firmware updates. 3. Set up RealView ICE per the instruction manual that comes with the unit: Connect power unit and ethernet cable to RealView ICE unit. Connect JTAG cable to target board. 4. Power up the target board and RealView ICE unit 5. Do the RealView ICE IP Config procedure 6. Under Windows, run Start->Programs-Arm->RVIce1.1->RealViewIceConfigIP. Select DHCP. Give your ICE unit a name (<your_name>-ice) and enter it in the Host Name box. This will allow the units to be easily identified in the scan operation. Note: you may have to use the MAC address on the ICE box to identify the ICE unit you want to configure the first time if more ICE units are connected to your local area network. 7. Power up the RV-ICE box. Under Windows, run Start->Programs->ARM->RealviewIce1.1->Realview Ice Update. Identify the ICE unit first and then choose the folder that contains the downloaded patches to install build183.rvi first and then Metrowerks-RVI patch-MWZAS1.rvi (must be in this order to have all patches installed correctly). Since the first patch is large, be patient about the update as it may take several minutes. Freescale 3

4 3.2.2 Running Redboot from RVD The following steps describe how to accomplish this using the ARM RealView tools. If you follow steps 1-3 below but could not setup RVD correctly or fail to connect the RVD to the board, try to follow the instructions in the Readme.txt file under rvd_config directory from this release. It is meant to provide easy setup for the RVD. 1. Make sure the board dip switches are setup for internal boot. 2. Start the RealView Debugger and connect to the target board. 3. Under Connection Control Window, right clock on RealView-ICE under ARM-ARM-NW and select Configure Device Info. Under the RVConfig window, click on the RealView ICE and select the IP address of the RealView ICE. Click connect and ignore the warning messages. After this, the RealView ICE window on the left pane shows the IP address of the ICE box. Note that lowering the JTAG speed under the RVConfig should enable more reliable download. Normally 1MHz is recommended. 4. Make sure the debugger is in little endian and NO semihosting or Vector Catch is turned on under RVD: Endianness control is under Connection Properties -> CONNECTION=RealView ICE -> Advanced Information -> Default. Make sure the Endianess is little. Semihosting is under Connection Properties -> CONNECTION=RealView ICE -> Advanced Information - > Default -> ARM_config-> Semihosting. Make sure the enable is False. Vector Catch is under Connection Properties -> CONNECTION=RealView ICE -> Advanced Information - > Default -> ARM_config. Make sure the value for Vector catch is False. Click on the proper name of the core under the Connection Control window. 5. Use a DB-9 serial cable to connect to external UART_A. For i.mx27 EVB/ADS, use internal UART1. 6. Start HyperTerminal at N Under the RVD command window, type: inc ABSOLUTE_PATH\init_sdr.inc The above command requires the absolute path name. So substitute ABSOLUTE_PATH to the one in your environment. Also make sure use the correct one since different boards require different scripts. The init_sdr.inc file also needs to be modified using absolute path name in order to download the Redboot image correctly. For the i.mx27evb boards, use init_ddr.inc. 8. After successful download, run Redboot program by typing F5. Now you should see Redboot prompt on the Hyperterminal. 3.3 Programming the Running Redboot into Flash A new Redboot command romupdate has been provided to program the running Redboot image into the flash. Simply type romupdate under Redboot and once the command is done execution, the Redboot should be programmed inside the flash. 3.4 Starting Redboot from Flash To verify the flashing is successful, disconnect the RealView-ICE and change the dip switch settings for external boot mode (see previous sections for more information). The Redboot prompt should come up from the HyperTerminal after reset. 4 Configuring RedBoot By default, RedBoot is configured to display the command prompt and receive serial keyboard input on certain UART ports with 115,200-8-N-1 settings. On the i.mx27 EVB/ADS board, UART1 is used. In addition to this, EXT_UART_A is supported as well if it is present on the board (except for i.mx27 EVB board). Immediately after programming a new RedBoot image into flash, it may be necessary to reset the board and initialize the flash file system via the command prompt: fis init -f 4 Freescale Semiconductor

5 This should only be done once after programming a new RedBoot image into flash. The system configuration also needs to be set using the fconfig command. The following is one example of how to set it up by assigning a static IP address to the board. If the network supports BOOTP/DHCP and one wants to use it, set true when prompted with Use BOOTP for network configuration in the following example and skip the configurations for Gateway IP address, Local IP address and Local IP address mask. Note that the new configuration doesn t take effect until the board is reset (reset button or reset command). RedBoot> fconfig Run script at boot: false Use BOOTP for network configuration: false Gateway IP address: Local IP address: Local IP address mask: Default server IP address: Board specifics: 0 Console baud rate: DNS server IP address: Set eth0 network hardware address [MAC]: false GDB connection port: 9000 Force console for special debug messages: false Network debug at boot time: false Update RedBoot non-volatile configuration - continue (y/n)? y... Erase from 0xc9fc0000-0xc9fc1000:.... Program from 0x03fd2000-0x03fd3000 at 0xc9fc0000:. RedBoot> Each of the parameters should be modified for the specific network and usage. It is very important that the board specifics parameters be set correctly. These parameters are not used by the RedBoot but are used by some operating systems. Note that some DHCP servers are not configured to support BOOTP requests and as a result a static configuration will be required. The board specifics parameter is a bit mask of board options. At this time, there are no options and board specifics should be 0. The configuration can be listed: RedBoot> fconfig -l Run script at boot: false Use BOOTP for network configuration: false Gateway IP address: Local IP address: Local IP address mask: Default server IP address: Board specifics: 0 Console baud rate: DNS server IP address: Set eth0 network hardware address [MAC]: false GDB connection port: 9000 Force console for special debug messages: false Network debug at boot time: false RedBoot> Freescale 5

6 Parameter settings can be listed along with their short names: RedBoot> fconfig -l -n boot_script: false bootp: false bootp_my_gateway_ip: bootp_my_ip: bootp_my_ip_mask: bootp_server_ip: brd_specs: 0 console_baud_rate: dns_ip: eth0_esa: false gdb_port: 9000 info_console_force: false net_debug: false RedBoot> The names can be used to change individual parameters. For instance, the following will change the BOOTP server IP to : RedBoot> fconfig bootp_server_ip bootp_server_ip: Setting to Update RedBoot non-volatile configuration - continue (y/n)? y... Erase from 0xc9fc0000-0xc9fc1000:.... Program from 0x03fd2000-0x03fd3000 at 0xc9fc0000:. RedBoot> The network configuration can be tested using the ping command: ping -n 3 -h <ip address> -r 10 5 Using RedBoot OS images can be downloaded using RedBoot via Ethernet or the serial port. The downloaded images can be immediately decompressed into SDRAM and executed or they can be stored into flash and decompressed into SDRAM at a later time. All of these instructions assume that RedBoot has been installed onto the ADS board and configured. 5.1 Serial Download To download an image through serial, issue the following command under Redboot prompt: load -r -b 0x m xmodem Redboot now is ready to receive data and printing out character C continuously. To send a file, click on Transfer - > Send File -> Xmodem (under Protocol) -> Browse, choose the file to download and then click on Send. Ymodem can also be chosen for download. 5.2 Ethernet Download Note that TFTP is not a reliable protocol and downloads may sometimes fail (with no error message) on busy networks. Always check the byte count of the download to make sure the download is complete. Besides, some EVB/ ADS boards don t have the correct MAC address programmed in the EEPROM which is used by the Ethernet controller. In that case, try to use the setmac command under Redboot to program a valid MAC address. This MAC address is used when using fconfig and choose false for the following: 6 Freescale Semiconductor

7 Set eth0 network hardware address [MAC]: false If the above is set to true, it means the MAC address from the flash will be used. To download a file via the Ethernet: 1. Set up and configure a TFTP server. 2. Configure the server to load files from the appropriate directories or copy the desired image to the server directory. 3. Test the network configuration: ping -n 3 -h <TFTP server IP address> -r 10 The following discuss how to download and execute different kinds of images. To download and execute an uncompressed image (check that the number of bytes downloaded is correct): load -v -r -b 0x <file name> run To download a compressed image and immediately execute it: load -v -d -r -b 0x <file name> run 5.3 Store Image into Flash and Run it To put downloaded image into the flash after the load command either via serial or Ethernet, use: fis create <image name> To load and execute a compressed image from flash: 1. Load and decompress the image (other image names may be used): fis load -d <image name> 2. Execute the image: run 5.4 Other Helpful Redboot Commands To delete an image: fis delete <image name> To list images: fis list To see available commands, type help. Note that it is possible to configure RedBoot to execute a script at boot. This script could load and run and image from flash or it could even load an image over Ethernet and execute it. For more information on RedBoot, refer to 6 Building RedBoot Building RedBoot can be achieved under either Windows using Cygwin or Linux. These files are required to do this: Table 1-2. Resources needed for Building Redboot Resource Description Source ecostools_linux.t ar.gz arm-elf.zip misc.zip Toolchain needed to build Redboot under Linux Toolchain needed to build Redboot under Windows using Cygwin Ecosconfig executable for Cygwin Freescale 7

8 Resource Description Source ecos_ tar.gz redboot_ zi p The following describes how to setup the build environment first and then gives instructions on how to build the Redboot images. 6.1 Setting up Redboot Build Environment under Linux To simplify the built process, it is recommended to use Freescale's pre-packaged tools to build Redboot. The following has been verified working under Redhat 7.3 and Redhat 9.0 Linux distribution releases. 1. Download ecostools_linux.tar.gz 2. Under Linux, with root user privilege, go to /opt directory (create one if it is not there), untar it with: tar zxvf ecostools.tar.gz This creates /opt/ecostools directory with two subdirectories: gnutools -- GNU tools for compiling, linking, etc. tools -- mainly to have ecosconfig utility program 3. Add /opt/ecostools/gnutools/arm-elf/bin and /opt/ecostools/tools/bin to your environment PATH variable. 6.2 Setting up Redboot Build Environment under Windows To build Redboot under Windows, Cygwin has to be setup first. Follow these steps to have the tools installed under Cygwin: 1. Obtain and install the ARM cross compiler under Cygwin by following the instructions at sources.redhat.com/ecos/build-toolchain.html. Unzip arm-elf.zip into the Cygwin root directory. After unzipping the toolchain, make sure the directory containing arm-elf-gcc.exe is in your PATH environment variable. Note that there have been problems building with the TCL/Tk that is available with Cygwin. We recommend uninstalling the TCL/Tk that comes with Cygwin and using the latest version of Active TCL for Windows available at Make sure the tcl/bin directory is in your PATH envirionment variable 2. Obtain and install the ecos tools and make sure the directory containing ecosconfig.exe is in your PATH environment variable. 6.3 Generating Redboot Image Baseline ecos source for Redboot. The Freescale released patch is on top of this. Freescale Redboot source patch. (unzipped from redboot_ zip file) After the tools are setup properly, follow these instructions to build the Redboot image: 1. Decompress the ecos_ tar.gz base line source code into ~/src/ecos and strip off the top level directory ecos_ (it means move all the files/directories under ecos_ directory up one level and then delete ecos_ directory.) There should be a packages directory under ~/src/ ecos if this is done correctly. 2. Change into the ecos subdirectory and apply the ecos patches from this release: $ cd ecos Under Linux, do: $ bunzip2 -c patch-redboot base.bz2 patch -p1 Under Cygwin, do: $ bunzip2 -c patch-redboot base.bz2 dos2unix patch -p1 8 Freescale Semiconductor

9 The above command assumes the patch file is under the same directory as the ~/src/ecos. Specify the path name for the patch file if necessary. In addition to the base patch, each platform has it own patch. 3. Check for a non-zero return value of the patch command (echo $?), or check to see if there are any rejected patch fragments (find. -name '*.rej' -print). Either of these findings would indicate that the patch did not apply properly. 4. Repeat the above two steps for the platform specific source patch. For i.mx27 EVB/ADS, use patchredboot mx27.bz2. 5. Define the ECOS_REPOSITORY environment variable. If the ecos source is in ~/src/ecos, then simply do: export ECOS_REPOSITORY=~/src/ecos/packages 6. Build RedBoot. The following commands can be done from any directory and it is recommended to create a separate directory from the source in order to have a clean build. For i.mx27 ADS, do: ecosconfig new mx27ads redboot ecosconfig import $ECOS_REPOSITORY/hal/arm/mx27/ads/current/misc/ redboot_romram.ecm ecosconfig tree make This creates the Redboot image (redboot.bin) under install/bin directory. This image can run from either SDRAM or flash. 7 Reprogram Redboot Image Using Redboot If there is Redboot running on the board already and you want to reprogram a newer version of Redboot, you may do: RedBoot> load -v -r -b 0x redboot.bin RedBoot> run 0x This run command will start to execute the newly downloaded Redboot image. To program it into the flash, do RedBoot> romupdate Make sure the boot switches are set correctly and reset the board. The new Redboot image should start. 8 New Redboot Commands The following commands have been added for various Freescale ADS/EVB boards. The intent is to provide a userfriendly and easy-to-use interface for setting up or using certain hardware features such as NAND flash, MAC address in the EEPROM for CS8900A Ethernet controller and reading/writing e-fuses, etc. This section shows these commands and the corresponding help messages. 8.1 setmac Set Ethernet MAC address in EEPROM for onboard CS8900 Ethernet controller setmac [0x##:0x##:0x##:0x##:0x##:0x##] 8.2 Run Run an image at a location with MMU off run [<virtual addr>] 8.3 romupdate Update Redboot in the flash with currently running image romupdate Freescale 9

10 8.4 factive Enable either NOR or NAND flash media for Redboot factive [NOR NAND] 8.5 nand Utility function for NAND flash using raw address (linear offset from the starting of the NAND flash) nand {cmds} Erase nand flash contents nand erase -f <raw address> -l <length> [-o] [-z] -o: force erase (even for bad blocks) -z: mark bad (testing only!) Show nand flash info nand info [-f <raw address>] [-l <length>] Read data from nand flash into RAM nand read -f <raw address> -b <memory_load_address> -l <image_length> Show a page main/spare areas or spare area only (-s) nand show -f <raw page address> [-s] Write data from RAM into nand flash nand write -f <raw address> -b <memory_address> -l <image_length> Various NAND debug features nand debug <0> min debug messages <default> <1> med debug messages <2> max debug messages <3> enable(default)/disable h/w ECC for both r/w <4> disable(default)/enalbe spare-only read <9> enable/disable measurement no parameter - display current debug setup 8.6 clock Setup/Display clock (max AHB=133MHz, max IPG=66.5MHz) Syntax: clock [<core clock in MHz> [:<AHB-to-core divider>[:<ipg-to-ahb divider>]]] If a divider is zero or no divider is specified, the optimal divider values will be chosen. Examples: [clock] -> Show various clocks [clock 532] -> Core=532 AHB=133 IPG=66.5 [clock 399] -> Core=399 AHB=133 IPG=66.5 [clock 532:8] -> Core=532 AHB=66.5(Core/8) IPG=66.5 [clock 532:8:2] -> Core=532 AHB=66.5(Core/8) IPG=33.25(AHB/2) 8.7 fuse_read Read some fuses fuse_read <bank> <row> 8.8 fuse_blow Blow some fuses fuse_blow <bank> <row> <value> 10 Freescale Semiconductor

11 9 Frequently Asked Questions 9.1 Why there is no Redboot prompt on an internal UART port? Double check the dip switch settings as mentioned earlier in this document. 9.2 Why does the Linux CS89x0 driver fail to load? This driver under Linux relies on the MAC address being programmed in the EEPROM to have correct checksum value. Unfortunately, not all the boards coming out of factory have this setup properly. To overcome this, try using setmac command under Redboot and provide some valid MAC address with it. To check if the MAC address is programmed properly in the EEPROM, try setmac without any argument. 9.3 What s the easiest way to re-program a new Redboot image into the flash? Load the new image into SDRAM and use run command to execute it. Then use romupdate to program it into the flash. It works on both NOR flash and NAND flash. 9.4 How does Redboot support NAND flash? There was no explicit NAND support in the original Redboot code base. But almost all of the Freescale ARM based integrated processors have NAND flash controller in them and the development boards all have NAND flash interface and NAND flash cards shipped as standard packages. Besides, more and more customers choose to use NAND as their sole non-volatile storage media. To support these, significant effort has been put in to support NAND flash in Redboot. Features include: Switching between NOR and NAND flash using factive command Same NOR flash commands also apply to NAND flash such as fis and fconfig NAND flash is treated as if it were NOR flash with flat address space starting from 0xE as the base. This address is randomly chosen but is required for fis and fconfig commands. A nand command is added with many features including force erase bad blocks, force to mark a block as bad, etc. This command only takes raw address which is the size offset within the NAND flash. Bad block management has been implemented as well. During boot time, Redboot NAND program scans through the whole NAND device, locates any bad blocks and stores this information into a table. It then reveals only the size of the good blocks to the Redboot flash controller associated with fis and fconfig commands. So these two Redboot commands work on the good blocks with consolidated address space. For example, if the block 1 is bad, this command: fis write -f 0xe b 0x l 0x40000 will automatically pick up the next good block for writing. Some NAND boot support on certain platforms has also been added. 9.5 How to enable NAND boot? On i.mx parts, normally there is no need to blow fuses for NAND boot and booting from NAND flash can be achieved by putting boot switches to the NAND boot mode. 9.6 What s the easiest way to set up RVDS? Follow the Readme.txt doc from the FSL Redboot release under the tools/rvd_config directory. 9.7 How to switch between NOR flash and NAND flash for a running Redboot? Use factive command. Freescale 11

12 9.8 How to use the 27MHz TV-Out card on the ADS/EVB board? For NTSC and PAL television standards, we have to slave the MX27 to the precision 27 MHz clock coming from the TV-out card. The 27 MHz oscillator is a precision device because of the stability and jitter requirements of the television standards. Follow these steps in order to use this 27MHz clock: 1. Plug the TV-OUT card into the TV ENC and LCD CONN connectors on one edge of the ADS/EVB base board. 2. Set the user-switch S15 dip switch 1 on the board as follows: SW15-1 = ON to select the 27 MHz reference oscillator on TV-Out card SW15-1 = OFF to select the normal 26 MHz reference oscillator on the board Also check the Redboot bootup message like: Clock input is 27 MHz to verify if everything is setup correctly. 9.9 How to set the MAC address for the FEC on MX27 EVB/ADS boards? Use fconfig. There is a new entry added for the FEC MAC address. Reboot the board afterwards to ensure it effective How to connect the RV-ICE or Multi-ICE on MX27 EVB board? Since the JTAG connector on the EVB board is not keyed, make sure the red edge of the cable from the ICE align with the connector P24 pin 1 side How to select FEC as default network device on MX27 EVB/ADS boards? Use fconfig. There is a new entry added for selecting default network device.reboot the board afterwards to ensure it effective. If the entry of selecting default network device is not in the entry list of fconfig. Use fconfig -i to reinitalize the configuration. This entry is validate when there are at least two network device. mxc_fec is the device name of FEC. And cs8900a_eth0 is the name of cs8900a. If an incorrect name is inputted, the cs8900a will be selected. 12 Freescale Semiconductor