BeagleBoard: Update documentation

- Update build instructions
- Add instructions to test UEFI on qEmu either using the NOR flash or the SD card

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11997 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/BeagleBoardPkg/readme.txt b/BeagleBoardPkg/readme.txt
index 8234fead7358b760c0b46efe8c66677b39aebc96..702b77b1741ac6c643ef1aeab8a44a406f9e080c 100644 (file)
--- a/BeagleBoardPkg/readme.txt
+++ b/BeagleBoardPkg/readme.txt
@@ -1,11 +1,78 @@
-Build:\r
-======\r
-Build requires a bash script.\r
-./build.sh. \r
+On Ubuntu 10.04, in your $(WORKROOT) directory (eg: ~/dev/)\r
 \r
-FAQ:\r
-====\r
-If you get a build error 000E: File/directory not found FatPkg/EnhancedFat/FatDxe/FatDxe.inf\r
+Build UEFI for the BeagleBoard :\r
+================================\r
+# Requirements\r
+sudo apt-get install uuid-dev\r
 \r
-cd $WORKSPACE\r
-svn checkout https://fat-driver2.tianocore.org/svn/fat-driver2/trunk/FatPkg FatPkg --username username
\ No newline at end of file
+# Get the arm-none-eabi Toolchain:\r
+cd $(WORKROOT)\r
+wget http://www.codesourcery.com/sgpp/lite/arm/portal/package7813/public/arm-none-eabi/arm-2010.09-51-arm-none-eabi-i686-pc-linux-gnu.tar.bz2\r
+tar xjf arm-2010.09-51-arm-none-eabi-i686-pc-linux-gnu.tar.bz2\r
+Add the arm-none-eabi toolchain to your path\r
+\r
+# Build UEFI\r
+svn co https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2 edk2 --username guest\r
+cd $(WORKROOT)/edk2\r
+svn co https://edk2-fatdriver2.svn.sourceforge.net/svnroot/edk2-fatdriver2/trunk/FatPkg FatPkg --username guest\r
+patch -p1 < ArmPlatformPkg/Documentation/patches/BaseTools-Pending-Patches.patch\r
+cd BeagleBoardPkg/\r
+./build.sh\r
+\r
+# To Build a Release verion of UEFI\r
+./build.sh RELEASE\r
+\r
+\r
+Test UEFI on qEmu :\r
+===================\r
+\r
+Installing Linaro qEmu:\r
+-----------------------\r
+cd $(WORKROOT)\r
+git clone git://git.linaro.org/qemu/qemu-linaro.git\r
+cd $(WORKROOT)/qemu-linaro\r
+./configure --target-list=arm-softmmu,arm-linux-user,armeb-linux-user\r
+make\r
+\r
+Installing Linaro image Creator:\r
+--------------------------------\r
+wget http://launchpad.net/linaro-image-tools/trunk/0.4.8/+download/linaro-image-tools-0.4.8.tar.gz\r
+tar xzf linaro-image-tools-0.4.8.tar.gz\r
+cd $(WORKROOT)/linaro-image-tools-0.4.8/\r
+sudo apt-get install parted dosfstools uboot-mkimage python-argparse python-dbus python-debian python-parted qemu-arm-static btrfs-tools command-not-found\r
+\r
+Creating u-boot + Linux Linaro image:\r
+-------------------------------------\r
+mkdir $(WORKROOT)/beagle_image && cd $(WORKROOT)/beagle_image\r
+wget http://releases.linaro.org/platform/linaro-m/hwpacks/final/hwpack_linaro-omap3_20101109-1_armel_supported.tar.gz\r
+wget http://releases.linaro.org/platform/linaro-m/headless/release-candidate/linaro-m-headless-tar-20101101-0.tar.gz\r
+sudo $(WORKROOT)/linaro-image-tools-0.4.8/linaro-media-create --image_file beagle_sd.img --dev beagle --binary linaro-m-headless-tar-20101101-0.tar.gz --hwpack hwpack_linaro-omap3_20101109-1_armel_supported.tar.gz\r
+sudo chmod a+rw beagle_sd.img\r
+\r
+Test u-boot + Linux Linaro image on qEmu:\r
+-----------------------------------------\r
+$(WORKROOT)/qemu-linaro/arm-softmmu/qemu-system-arm -M beagle -sd $(WORKROOT)/beagle_image/beagle_sd.img -serial stdio -clock unix\r
+# in u-boot:\r
+boot\r
+\r
+Start UEFI from NOR Flash :\r
+---------------------------\r
+# Adding zImage to beagle_sd.img\r
+mkdir /tmp/beagle_img1\r
+sudo mount -o loop,offset=$[63*512] $(WORKROOT)/beagle_image/beagle_sd.img /tmp/beagle_img1\r
+cp zImage /tmp/beagle_img1\r
+sudo umount /tmp/beagle_img1\r
+\r
+./qemu-system-arm -M beagle -mtdblock /work/tianocore/Build/BeagleBoard/DEBUG_ARMGCC/FV/BeagleBoard_EFI_flashboot.fd -serial stdio -sd /work/linaro-image-tools-0.4.8/beagle_sd.img\r
+\r
+Start UEFI from SD card :\r
+-------------------------\r
+# To replace u-boot by uefi in the SD card\r
+1) Build the BeagleBoard UEFI firmware without the OMAP353x header\r
+cd $(WORKROOT)/edk2/BeagleBoardPkg/\r
+./build.sh -D EDK2_SECOND_STAGE_BOOTOLADER=1\r
+\r
+2) Replace u-boot by UEFI\r
+sudo mount -o loop,offset=$[63*512] $(WORKROOT)/beagle_image/beagle_sd.img /tmp/beagle_img1\r
+sudo cp ../Build/BeagleBoard/DEBUG_ARMGCC/FV/BEAGLEBOARD_EFI.fd /tmp/beagle_img1/u-boot.bin\r
+sudo umount /tmp/beagle_img1\r