d7ad3d601785188c0cbdf54efcbb3e89f9902a24
[mirror_edk2.git] / DuetPkg / ReadMe.txt
1 Developer's UEFI Emulation (DUET) on Edk2
2
3 A. Build DUET image on Windows Platform
4 ========================================
5 1. Tools preparation
6
7 To build DUET image, following tools are required:
8
9 1). *Visual Studio 2005*
10 Assume installed at <VS_PATH>,
11 e.g.: C:\Program Files\Microsoft Visual Studio .NET 2003\.
12 2). WinDDK
13 Assume installed at <WIN_DDK_PATH>, e.g.: C:\WINDDK\3790.1830\.
14
15 2. Build steps
16
17 2.1 Build Duet Platform module
18
19 1). run cmd.exe to open command line window.
20 2). enter workspace root directory such as c:\edk2_tree
21 2). run "edksetup.bat"
22 3). run "build -p DuetPkg\DuetPkg.dsc -a IA32" for IA32 architecture platform or
23 "build -p DuetPkg\DuetPkg.dsc -a X64" for X64 architecture platform.
24
25 2.2 Execute post build actions
26 1). enter <Workspace>\DuetPkg directory.
27 2). run "PostBuild.bat IA32" for IA32 architecture platform or
28 "PostBuild.bat X64" for X64 architecture platform.
29
30 Create bootable disk
31 ======================
32
33 3. Create boot disk
34 The following steps are same for IA32 architecture platform or X64 architecture platform.
35
36 3.1 Create floppy boot disk
37 1). enter <Workspace>\DuetPkg directory.
38 2). Insert a floppy disk to drive
39 3). run "CreateBootDisk.bat floppy a: FAT12 IA32" if floppy drive is a: disk and Arch to boot is IA32.
40 or
41 run "CreateBootDisk.bat floppy a: FAT12 X64" if floppy drive is a: disk and Arch to boot is X64.
42 3.2 Create usb boot disk
43 1). enter <Workspace>\DuetPkg directory.
44 2). Plugin usb disk
45 3). run "CreateBootDisk.bat usb e: FAT16 IA32" if usb drive is e: and FAT format is FAT16 and Arch to boot is IA32.
46 or "CreateBootDisk.bat usb e: FAT16 X64" if usb drive is e: and FAT format is FAT16 and Arch to boot is X64.
47 or "CreateBootDisk.bat usb e: FAT32 IA32" if usb drive is e: and FAT format is FAT32 and Arch to boot is IA32.
48 or "CreateBootDisk.bat usb e: FAT32 X64" if usb drive is e: and FAT format is FAT32 and Arch to boot is X64.
49 4). UnPlug usb disk and plugin it again.
50 5). run "CreateBootDisk.bat usb e: FAT16 IA32 step2" if usb drive is e: and FAT format is FAT16 and Arch to boot is IA32.
51 or "CreateBootDisk.bat usb e: FAT16 X64 step2" if usb drive is e: and FAT format is FAT16 and Arch to boot is X64.
52 or "CreateBootDisk.bat usb e: FAT32 IA32 step2" if usb drive is e: and FAT format is FAT32 and Arch to boot is IA32.
53 or "CreateBootDisk.bat usb e: FAT32 X64 step2" if usb drive is e: and FAT format is FAT32 and Arch to boot is X64.
54
55 B. Build DUET image on Linux Platform
56 ======================================
57 1. Tools preparation
58
59 To build DUET image, GCC44 is required:
60 1). Base on below link to create GCC44 build environment.
61 http://tianocore.sourceforge.net/wiki/Using_EDK_II_with_Native_GCC
62
63 2. Build steps
64
65 2.1 Build Duet Platform module
66
67 1). Open the terminal.
68 2). enter workspace root directory such as /edk2_tree
69 3). run ". edksetup.sh BaseTools"
70 4). run "build -p DuetPkg/DuetPkg.dsc -a IA32 -t GCC44" for IA32 architecture platform or
71 "build -p DuetPkg/DuetPkg.dsc -a X64 -t GCC44" for X64 architecture platform.
72
73 2.2 Execute post build actions
74 1). enter /edk2_tree/DuetPkg directory.
75 2). run "./PostBuild.sh IA32 GCC44" for IA32 architecture platform or
76 "./PostBuild.sh X64 GCC44" for X64 architecture platform.
77
78 NOTE: After post build action, you should check the size of EfiLdr at $WORKSPACE/Build/DuetPkg/DEBUG_GCC44 directory, it must less than 470k.
79 If not, you should manually remove some unnecessary drivers at DuetPkg.fdf file.
80
81 3. Create bootable disk
82 The following steps are same for IA32 architecture platform or X64 architecture platform.
83 Now only support floopy.
84
85 3.1 Create floppy boot disk
86 1). enter /edk2_tree/DuetPkg directory.
87 2). Insert a floppy disk to drive
88 3). run "CreateBootDisk.sh" to build floppy drive
89 such as "./CreateBootDisk.sh floppy /media/floppy0 /dev/fd0 FAT12 IA32"