ArmPlatformPkg/Documentation/ArmVExpressInstructions.txt

   1 =======================================
   2 = ARM Versatile Express Documentation =
   3 =======================================
   4
   5 Status
   6 ------
   7 Build and Run on EDK2 Subversion revision 11837
   8 Requirements
   9 -       RVCTv3 (untested) or RVCTv4 or ARMGCC (Code Sourcery q201009)
  10 -       Using Ubuntu: gcc, make, uuid-dev
  11 -       Using Cygwin: gcc, make, e2fsprogs (needed for uuid.h)
  12
  13 Serial Terminal settings
  14 -       Baud Rates: 38400
  15 - Data: 8 bit
  16 - Parity: None
  17 - Flow Control: None
  18
  19
  20 Use ICE debugger with Versatile Express
  21 ---------------------------------------
  22 Prior to use ICE debugger with Versatile Express, you will need to update the version of the ICE's firmware.
  23 If you have not installed RealView 4.0 SP3, do it.
  24 Open "RealView ICE Update" and "Install Firmware Update ...". Install "[ARM_INSTALL_PATH]\RVI\Firmware\3.4\11\ARM-RVI-3.4.0-25-base.rvi" and "[ARM_INSTALL_PATH]\RVI\Firmware\3.4\22\ARM-RVI-3.4.59-59-patch.rvi".
  25
  26
  27 Howto build UEFI Versatile Express
  28 ----------------------------------
  29 For Linux
  30 ---------
  31
  32 For the first time
  33 ******************
  34 1. Get EDK2 from Tianocore Subversion repository
  35 svn co https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2 edk2 --username guest
  36
  37 2. Get FatPkg from EDK2 SVN repository:
  38 cd edk2
  39 svn co https://edk2-fatdriver2.svn.sourceforge.net/svnroot/edk2-fatdriver2/trunk/FatPkg FatPkg --username guest
  40
  41 3. Apply BaseTools patches (BaseTools-Pending-Patches.patch combines all the currently pending BaseTools patches)
  42 patch -p1 < ArmPlatformPkg/Documentation/patches/BaseTools-Pending-Patches.patch
  43
  44 4. Set up the environment. And build the EDK2\92s tools
  45 export EDK_TOOLS_PATH=`pwd`/BaseTools
  46 . edksetup.sh `pwd`/BaseTools/
  47 make -C $EDK_TOOLS_PATH
  48
  49 5. Ensure the ARMGCC toolchain is in your PATH environment variable or defined by the ARMGCC_TOOLS_PATH environment variable. Example:
  50 export ARMGCC_TOOLS_PATH=/opt/toolchains/arm-2010.09-arm-none-eabi-i686-pc-linux-gnu/bin/
  51
  52 6. Build the ARM Versatile Express UEFI Firmware
  53 build -a ARM -p ArmPlatformPkg/ArmVExpressPkg/ArmVExpress-CTA9x4.dsc -t ARMGCC
  54
  55 7. Edit the ARM Versatile Express configuration file config.txt to declare the location of the UEFI firmware in NOR Flash
  56 TOTALIMAGES: 5                   ;Number of Images (Max : 32)
  57 NOR0UPDATE: AUTO                 ;Image Update:NONE/AUTO/FORCE
  58 NOR0ADDRESS: BOOT                ;Image Flash Address
  59 NOR0FILE: \SOFTWARE\bm_v209.axf  ;Image File Name
  60 NOR1UPDATE: AUTO                 ;IMAGE UPDATE:NONE/AUTO/FORCE
  61 NOR1ADDRESS: 44000000            ;Image Flash Address
  62 NOR1FILE: \SOFTWARE\sec_uefi.bin ;Image File Name
  63 NOR1LOAD: 0                      ;Image Load Address
  64 NOR1ENTRY: 0                     ;Image Entry Point
  65 NOR2UPDATE: AUTO                 ;IMAGE UPDATE:NONE/AUTO/FORCE
  66 NOR2ADDRESS: 45000000            ;Image Flash Address
  67 NOR2FILE: \SOFTWARE\uefi.bin     ;Image File Name
  68 NOR2LOAD: 45000000               ;Image Load Address
  69 NOR2ENTRY: 45000000              ;Image Entry Point
  70 NOR3UPDATE: AUTO                 ;IMAGE UPDATE:NONE/AUTO/FORCE
  71 NOR3ADDRESS: 46000000            ;Image Flash Address
  72 NOR3FILE: \SOFTWARE\kernel.bin   ;Image File Name
  73 NOR3LOAD: 46000000               ;Image Load Address
  74 NOR3ENTRY: 46000000              ;Image Entry Point
  75 NOR4UPDATE: AUTO                 ;IMAGE UPDATE:NONE/AUTO/FORCE
  76 NOR4ADDRESS: 40000000            ;Image Flash Address
  77 NOR4NAME: BOOTSCRIPT             ;Image Name
  78 NOR4FILE: \SOFTWARE\bootscr.txt  ;Image File Name
  79
  80 8. To select second NOR Flash as a booting device, replace in the ARM Versatile Express file \SITE1\HBI0191B\board.txt:
  81 SCC: 0x004 0x00001F09
  82 By:
  83 SCC: 0x004 0x10001F09
  84
  85 9. Copy Build/ArmVExpress-CTA9x4/DEBUG_ARMGCC/FV/SEC_ARMVEXPRESS_EFI.fd to the ARM Versatile Express mass storage (available when the board is connected through USB to your host machine) under the folder SOTWARE and name sec_uefi.bin. Example for cygwin:
  86 cp Build/ArmVExpress-CTA9x4/DEBUG_ARMGCC/FV/SEC_ARMVEXPRESS_EFI.fd /cygdrive/e/SOFTWARE/sec_uefi.bin
  87
  88 10. Start the ARM Versatile Express board. You should read \93Waiting for firmware at 0x80000000 ...\94 on the serial port.
  89
  90 11. Copy ARMVEXPRESS_EFI.fd at 0x80000000 with RealView Debugger
  91 readfile,raw,nowarn "[EDK2_PATH]\Build\ArmVExpress-CTA9x4\DEBUG_ARMGCC\FV\ARMVEXPRESS_EFI.fd"=0x80000000
  92
  93 12. Resume the execution from RealView Debugger
  94
  95 For all subsequent times
  96 ************************
  97 1. Build ARM Versatile Express UEFI Firmware
  98 build -a ARM -p ArmPlatformPkg/ArmVExpressPkg/ArmVExpress-CTA9x4.dsc -t ARMGCC
  99
 100 2. Start the ARM Versatile Express board. You should read \93Waiting for firmware at 0x80000000 ...\94 on the serial port.
 101
 102 3. Copy ARMVEXPRESS_EFI.fd at 0x80000000 with RealView Debugger
 103 readfile,raw,nowarn "[EDK2_PATH]\Build\ArmVExpress-CTA9x4\DEBUG_ARMGCC\FV\ARMVEXPRESS_EFI.fd"=0x80000000
 104
 105 4. Resume the execution
 106
 107
 108 For RealView Compiler Toolchain on Windows
 109 ------------------------------------------
 110 The command line window needs to be the one from Visual Studio to get the environment variables required to get some development tools (the windows compiler for BaseTools and `nmake`).
 111 The EDK2 toolchain name for ARM RealView Compiler Toolchain under a Windows environment is `RVCT`. The EDK2 build system will automatically pick up the RVCT toolchain defined in your PATH. If you want to use a specific version, set the environment variable 'RVCT_TOOLS_PATH':
 112 set RVCT_TOOLS_PATH=[YOUR_TOOLCHAIN_PATH]
 113
 114
 115 For RealView Compiler Toolchain on Linux
 116 ----------------------------------------
 117 The EDK2 toolchain name for ARM RealView under a Linux environment is `RVCTLINUX`. The EDK2 build system will automatically pick up the RVCT toolchain defined in your PATH. If you want to use a specific version, set the environment variable 'RVCT_TOOLS_PATH':
 118 export RVCT_TOOLS_PATH=[YOUR_TOOLCHAIN_PATH]
 119
 120
 121 For RVCT on Cygwin
 122 ------------------
 123 The EDK2 toolchain name for ARM RealView under a Cygwin environment is `RVCTCYGWIN`. The EDK2 build system will automatically pick up the RVCT toolchain defined in your PATH. If you want to use a specific version, set the environment variable 'RVCT_TOOLS_PATH':
 124 export RVCT_TOOLS_PATH=[YOUR_TOOLCHAIN_PATH]
 125
 126
 127 To support the standalone mode:
 128 -------------------------------
 129 The full ArmVe UEFI firmware can be written into NOR Flash to allow the entire boot sequence to be done after a cold boot.
 130
 131 build -a ARM -p ArmPlatformPkg/ArmVExpressPkg/ArmVExpress-CTA9x4.dsc -t ARMGCC -D EDK2_ARMVE_STANDALONE=1
 132 ARMVEXPRESS_EFI.fd is required to be copied into the ARM Versatile Express board:
 133 cp Build/ArmVExpress-CTA9x4-Standalone/DEBUG_ARMGCC/FV/SEC_ARMVEXPRESS_EFI.fd /cygdrive/e/SOFTWARE/sec_uefi.bin
 134 cp Build/ArmVExpress-CTA9x4-Standalone/DEBUG_ARMGCC/FV/ARMVEXPRESS_EFI.fd /cygdrive/e/SOFTWARE/uefi.bin
 135
 136
 137 Trustzone Support
 138 -----------------
 139 ArmVE's UEFI supports booting Trustzone (two worlds: Secure and Normal Worlds) and No Trustzone (one world: the CPU remains in Secure World) supports. Trustzone support is enabled by Enabling SMC TZASC in the Test Chip SCC Register 1. This register can only be changed by editing the configuration file of your Versatile Express board: E:\SITE1\HBI0191B\board.txt Changing:
 140 SCC: 0x004 0x10001F09
 141 For:
 142 SCC: 0x004 0x10003F09
 143
 144
 145 Booting Linux
 146 -------------
 147 The default entry in the ARM Boot Manager is defined by the PCDs:
 148
 149 - gArmPlatformTokenSpaceGuid.PcdDefaultBootDescription|L"NorFlash"
 150 - gArmPlatformTokenSpaceGuid.PcdDefaultBootDevicePath|L"VenHw(E7223039-5836-41E1-B542-D7EC736C5E59)/MemoryMapped(0,0x46000000,0x462F0000)"
 151 - gArmPlatformTokenSpaceGuid.PcdDefaultBootArgument|"root=/dev/sda2 rootwait debug earlyprintk console=ttyAMA0,38400 mem=1G"
 152 - gArmPlatformTokenSpaceGuid.PcdDefaultBootType|1
 153
 154 The PCD PcdDefaultBootDevicePath expects a Device Path conforms to the UEFI specification.
 155 PcdDefaultBootType defines the type of the image pointed by PcdDefaultBootDevicePath.
 156 -       PcdDefaultBootDevicePath = 0 for an EFI Application
 157 -       PcdDefaultBootDevicePath = 1 for a legacy kernel with ATAG support
 158 -       PcdDefaultBootDevicePath = 2 for a kernel with Flat Device Tree (FDT) support
 159
 160 Example of UEFI Device Path:
 161
 162 // Load FDT binary from the Firmware Volume (mapped at 0x80000000)
 163 #define LINUX_KERNEL  L"MemoryMapped(11,0x80000000,0x6FEFFFFF)\\zImage.fdt"
 164
 165 // Linux Kernel from a SD Card
 166 #define LINUX_KERNEL    L"VenHw(621B6FA5-4DC1-476F-B9D8-52C557D81070)/HD(1,MBR,0x00000000,0xF9,0x3C8907)\\boot\\zImage.fdt"
 167
 168 // Kernel from SATA HD - Partition 2
 169 #define LINUX_KERNEL    L"Acpi(PNP0A03,0)/Pci(0|0)/Pci(0|0)/Pci(5|0)/Pci(0|0)/Sata(0,0,0)/HD(2,MBR,0x00076730,0x1F21BF,0x1F21BF)\\boot\\zImage.fdt"
 170
 171 // Kernel from NOR Flash
 172 #define LINUX_KERNEL            L"VenHw(02118005-9DA7-443a-92D5-781F022AEDBB)/MemoryMapped(0,0x46000000,0x462F0000)"