summaryrefslogtreecommitdiffstats
path: root/UnixPkg
diff options
context:
space:
mode:
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2009-07-06 15:01:46 +0000
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2009-07-06 15:01:46 +0000
commit020f7cf4fa994d57c29b03d6e2e6022d9b37b4f6 (patch)
tree14bcf85ee911da92a47d7ac98a6e376577b0ff9c /UnixPkg
parente356f99943603fe9ede19ab4715fa8eed16c0339 (diff)
downloadedk2-020f7cf4fa994d57c29b03d6e2e6022d9b37b4f6.tar.gz
edk2-020f7cf4fa994d57c29b03d6e2e6022d9b37b4f6.tar.bz2
edk2-020f7cf4fa994d57c29b03d6e2e6022d9b37b4f6.zip
add readme.txt for UnixPkg
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8761 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'UnixPkg')
-rw-r--r--UnixPkg/readme.txt32
1 files changed, 32 insertions, 0 deletions
diff --git a/UnixPkg/readme.txt b/UnixPkg/readme.txt
new file mode 100644
index 0000000000..35e2523e0f
--- /dev/null
+++ b/UnixPkg/readme.txt
@@ -0,0 +1,32 @@
+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.
+
+
+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.
+