audk/UnixPkg
qhuang8 c8e073513b Minor update code comment in last commitment.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10722 6f19259b-4bc3-4df7-8a09-765794883524
2010-07-30 08:09:44 +00:00
..
BootModePei Update the copyright notice format 2010-04-28 12:31:45 +00:00
CpuRuntimeDxe Update the copyright notice format 2010-04-28 12:31:45 +00:00
FvbServicesRuntimeDxe Update the copyright notice format 2010-04-28 12:31:45 +00:00
Include Complete coding to support X64 EFI ABI in UnixPkg. Code is not currently hooked in or tested, but it is code complete. Only missing step from testing is figuring out how to build with two different ABIs for the same platform. Sec needs a different ABI. May need to add a 2nd build step. 2010-07-29 03:24:13 +00:00
Library Change the GUID value of UnixBaseLib to avoid Guid value collision with BaseLib.inf in MdePkg. 2010-07-26 08:58:14 +00:00
MetronomeDxe Update the copyright notice format 2010-04-28 12:31:45 +00:00
MiscSubClassPlatformDxe Update the copyright notice format 2010-04-28 12:31:45 +00:00
RealTimeClockRuntimeDxe Update the copyright notice format 2010-04-28 12:31:45 +00:00
ResetRuntimeDxe Update the copyright notice format 2010-04-28 12:31:45 +00:00
Sec Add -m32 option for IA32 ASM flag to ensure it is treated as 32-bit for GCC assembler. 2010-07-30 06:48:48 +00:00
TimerDxe Update the copyright notice format 2010-04-28 12:31:45 +00:00
UnixAutoScanPei Update the copyright notice format 2010-04-28 12:31:45 +00:00
UnixBlockIoDxe Fix 64-bit compile bug 2010-07-14 22:51:06 +00:00
UnixBusDriverDxe Update the copyright notice format 2010-04-28 12:31:45 +00:00
UnixConsoleDxe Update the copyright notice format 2010-04-28 12:31:45 +00:00
UnixFirmwareVolumePei Port UnixPkg to also support X64. Currently only supports Unix x86_64 ABI. In the future we can make Sec support x86_64 ABI and the rest of the code support X64 EFI ABI. This will require assembly gaskets to fix the calling convention differences. I currently have noop gaskets in place for x86_64 ABI. This has only been tested on OS X 10.6. 2010-07-22 21:21:38 +00:00
UnixFlashMapPei Port UnixPkg to also support X64. Currently only supports Unix x86_64 ABI. In the future we can make Sec support x86_64 ABI and the rest of the code support X64 EFI ABI. This will require assembly gaskets to fix the calling convention differences. I currently have noop gaskets in place for x86_64 ABI. This has only been tested on OS X 10.6. 2010-07-22 21:21:38 +00:00
UnixSerialIoDxe Update the copyright notice format 2010-04-28 12:31:45 +00:00
UnixSimpleFileSystemDxe Update the copyright notice format 2010-04-28 12:31:45 +00:00
UnixThunkDxe Update the copyright notice format 2010-04-28 12:31:45 +00:00
UnixThunkPpiToProtocolPei Update the copyright notice format 2010-04-28 12:31:45 +00:00
UnixUgaDxe Minor update code comment in last commitment. 2010-07-30 08:09:44 +00:00
Xcode Port UnixPkg to also support X64. Currently only supports Unix x86_64 ABI. In the future we can make Sec support x86_64 ABI and the rest of the code support X64 EFI ABI. This will require assembly gaskets to fix the calling convention differences. I currently have noop gaskets in place for x86_64 ABI. This has only been tested on OS X 10.6. 2010-07-22 21:21:38 +00:00
.gdbinit Added support for Xcode on Snow Leopard. Upaded with bug fixes for Snow Leopard. 2009-12-06 02:00:37 +00:00
UnixPkg.dec Port UnixPkg to also support X64. Currently only supports Unix x86_64 ABI. In the future we can make Sec support x86_64 ABI and the rest of the code support X64 EFI ABI. This will require assembly gaskets to fix the calling convention differences. I currently have noop gaskets in place for x86_64 ABI. This has only been tested on OS X 10.6. 2010-07-22 21:21:38 +00:00
UnixPkg.dsc Port UnixPkg to also support X64. Currently only supports Unix x86_64 ABI. In the future we can make Sec support x86_64 ABI and the rest of the code support X64 EFI ABI. This will require assembly gaskets to fix the calling convention differences. I currently have noop gaskets in place for x86_64 ABI. This has only been tested on OS X 10.6. 2010-07-22 21:21:38 +00:00
UnixPkg.fdf Port UnixPkg to also support X64. Currently only supports Unix x86_64 ABI. In the future we can make Sec support x86_64 ABI and the rest of the code support X64 EFI ABI. This will require assembly gaskets to fix the calling convention differences. I currently have noop gaskets in place for x86_64 ABI. This has only been tested on OS X 10.6. 2010-07-22 21:21:38 +00:00
UnixPkgX64.dsc Port UnixPkg to also support X64. Currently only supports Unix x86_64 ABI. In the future we can make Sec support x86_64 ABI and the rest of the code support X64 EFI ABI. This will require assembly gaskets to fix the calling convention differences. I currently have noop gaskets in place for x86_64 ABI. This has only been tested on OS X 10.6. 2010-07-22 21:21:38 +00:00
UnixPkgX64.fdf Port UnixPkg to also support X64. Currently only supports Unix x86_64 ABI. In the future we can make Sec support x86_64 ABI and the rest of the code support X64 EFI ABI. This will require assembly gaskets to fix the calling convention differences. I currently have noop gaskets in place for x86_64 ABI. This has only been tested on OS X 10.6. 2010-07-22 21:21:38 +00:00
build.sh Add an option to build the GccShell. './build.sh shell' or './build64.sh' will buid the shell. 2010-07-23 22:18:07 +00:00
build64.sh Add an option to build the GccShell. './build.sh shell' or './build64.sh' will buid the shell. 2010-07-23 22:18:07 +00:00
readme.txt Added support for Xcode on Snow Leopard. Upaded with bug fixes for Snow Leopard. 2009-12-06 02:00:37 +00:00

readme.txt

Unix Simulation Platform
========================

UnixPkg is one of platform package which can be built to a platform's firmware from UnixPkg.dsc file.
And this package provide a simulation platform under *INUX environment in IA32 architecture.

- Same points between real platform and simulation platform:
  1) Unix simulation platform also run with firmware device image built from UnixPkg
  2) The working flow of simulation platform also contains SEC/PEI/DXE phase.

- Different points between real platform and simulation platform:
  1) The SEC phase in simulation platform in fact is a *INUX native application which can be run from *INUX shell;
  2) The device in simulation platform is not real hardware but simulation component in API level;
  3) The ThunkBus driver in simulation platform will get virtual device's desription from PCD and create virtual Device

Build
=====
UnixPkg is built with following command:
  build -p UnixPkg/UnixPkg.dsc -a IA32 -t ELFGCC
  Notes: ELFGCC is defined in <Workspace>/Conf/tools_def.txt file. This tool chain use native gcc/binutil instead of 
         cross-compiler like UNIXGCC tool chain.

On Mac OS X you can cd into UnixPkg directory and execute ./build.sh to build. This does not require
setting up the environment like running the build command. Note Snow Leopard or later is required. 
This script should also work for any *INUX, but has not been tested. 

./build.sh run will lanuch the emulator in gdb so you can source level debug via gdb. 


Notes:
=====
On Mac OS X Snow Leopard you can use Xcode 3.2 as a GUI debugger. 
Launch Xcode and open UnixPkg/Xcode/xcode_project/xcode_project.xcodeproj
Under the build menu chose build and debug. shift-cmd-B shows the build results.

Under most *INUX the EFI executables are placed in the emulated EFI memory by the EFI PE/COFF loader
but dlopen() is used to also load the image into the process to support source level debug. 
The entry point for the image is moved from the EFI emulator memory into the dlopen() image. This
is not the case for Mac OS X. On Mac OS X a debugger script is used and the real EFI images in
the emulator are the ones being debugged. 

Also on Mac OS X the stack alignment requirements for IA-32 are 16 bytes and this is more strict
than the EFI ABI. To work around this gasket code was introduced to ensure the stack is always
16 byte aligned when making any POSIX call on Mac OS X. 

To build PE/COFF images with Xcode 3.2 and extra tool call mtoc is required to convert Mach-O 
images into PE/COFF images. The tool only supports EFI PE/COFF images and the instructions on 
how to download it are on the edk2 website.

FAQ
===
1, I fail to build UnixPkg due to "X11/extensions/XShm.h: No such file or directory"?
   The display adapter in UnixPkg is a virtual device written in X11 API. The library of x11proto-xext-dev is required
   for building.

2, I fail to build UnixPkg due to "/usr/bin/ld: cannot find -lXext"?   
   libxext-dev library is required for building.