---?image=assets/images/gitpitch-audience.jpg
@title[Platform Build Win Lab]
tianocore.org Note: PITCHME.md for UEFI / EDK II Training Platform Build Win Lab
Copyright (c) 2018, Intel Corporation. All rights reserved.
Redistribution and use in source (original document form) and 'compiled' forms (converted to PDF, epub, HTML and other formats) with or without modification, are permitted provided that the following conditions are met:
-
Redistributions of source code (original document form) must retain the above copyright notice, this list of conditions and the following disclaimer as the first lines of this file unmodified.
-
Redistributions in compiled form (transformed to other DTDs, converted to PDF, epub, HTML and other formats) must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS DOCUMENTATION IS PROVIDED BY TIANOCORE PROJECT "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL TIANOCORE PROJECT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@title[Lesson Objective]
Lab Setup and Build for Nt32 or Minnowboard Max/Turbot
@fa[certificate gp-bullet-magenta] Pin Visual Studio Command Prompt to Windows
Task Bar
@fa[certificate gp-bullet-green] Lab 1: Build a EDK II Platform using Nt32 package
@fa[certificate gp-bullet-cyan] Lab 2: Hardware Setup for Minnowboard Max/Turbot
@fa[certificate gp-bullet-yellow] Lab 3: Build a EDK II Platform using Minnowboard
Max/Turbot
---?image=assets/images/binary-strings-black2.jpg
@title[Pin VS CMD Prompt Section]
Pin the Visual Studio Command prompt to Windows
Task Bar
---?image=/assets/images/slides2/Slide4.JPG @title[Pin VS CMD Prompt]
@snap[north-east span-25 ]
@fa[windows gp-bullet-cyan]
Windows 10
@snapend
@snap[north-east span-60 ]
Steps to Pin Visual Studio Command Prompt to task bar for Windows 10
- Using the Start menu in Windows 10, Left Click on "Windows Key" Lower Left @fa[windows gp-bullet-cyan]
- Scroll down from the scroll bar on the right until "Visual Studio 201@color[#e49436](n)"
- Left Click "Visual Studio 201@color[#e49436](n)"
@snapend
Note:
---?image=/assets/images/slides2/Slide5.JPG @title[Pin VS CMD Prompt 02]
@snap[north-east span-60 ]
4. Left Click "Visual Studio Tools"
This will open another Windows file explorer window
Note: VS 2013 example, other version of VS maybe different
@snapend
Note:
---?image=/assets/images/slides2/Slide6.JPG @title[Pin VS CMD Prompt 03]
@snap[north-east span-50 ]
5. Select "Developer Command Prompt for VS201n"
6. Right Click to open Windows dialog box
Do not use any of the other
".. Command Prompts"
@snapend Note:
---?image=/assets/images/slides2/Slide7.JPG @title[Pin VS CMD Prompt 04]
@snap[north-east span-40 ]
7. Left Click on
"Pin to to taskbar"
@snapend
Note:
---?image=/assets/images/slides2/Slide8.JPG @title[Pin VS CMD Prompt 05]
@snap[north-east span-50 ]
8. Open the VS Command Prompt
All Windows Labs use this short-cut to Build Edk II platforms and projects using Windows Visual Studio :
2010 / 2012 / 2013 / 2015 or 2017
---?image=assets/images/binary-strings-black2.jpg
@title[End of Pin VS Section]
---?image=assets/images/binary-strings-black2.jpg
@title[Lab 1 -Build OVMF Section]
Setup Nt32Pkg to build and run NT32 emulation
w/ Windows
@title[Optional - Downloading the Edk II Source]
Download the Edk II Source - Optional
OPTIONAL - Open a “git” command prompt and create a source working directory
C:\>mkdir WS
C:\> cd WS
OPTIONAL - Internet Proxies – (company Firewall used for example)
C:\WS> git config --global https.proxy <proxyname>.domain.com:<port>
C:\WS> git config --global http.proxy <proxyname>.domain.com:<port>
OPTIONAL - Download edk2 source tree using Git command prompt
C:\WS> git clone https://github.com/tianocore/edk2.git
@coloryellow Lab Material will have a different “edk2”
Note:
OPTIONAL - Open a “git” command prompt and create a source working directory
- C:\>mkdir WS - C:\> cd WS - OPTIONAL - Internet Proxies – (company Firewall used for example) - C:\WS> git config --global https.proxy .domain.com: - C:\WS> git config --global http.proxy .domain.com: - OPTIONAL - Download edk2 source tree using Git command prompt - C:\WS> git clone https://github.com/tianocore/edk2.git
- NOTE: Lab Material will have a different “edk2”
---?image=assets/images/binary-strings-black2.jpg
@title[Setup Lab Material sub Section]
Lab_Material_FW.zip
@title[Download Lab_Material_FW -getting the Source ]
Download the Lab_Material_FW.zip from : @fa[github gp-bullet-white] github.com Lab_Matrial_FW.zip
OR
Use git clone to download the Lab_Material_FW
$ git clone https://github.com/tianocore-training/Lab_Material_FW.gitDirectory Lab_Material_FW will be created
FW
- Documentation
- DriverWizard
- edk2
- edk2Linux
- LabSampleCode
- Nasm
Note:
---?image=/assets/images/slides2/Slide14.JPG @title[Build Nt32 Edk2 -getting the Source ]
@snap[north-east span-50 ]
–Extract the Source
@snapend@snap[north-west span-100 ]
1. Extract the Downloaded `Lab_Material_FW-master.zip` to `C:\`
@snapend
Note: Extract the Downloaded Lab_Material_FW.zip to Home (this will create a directory FW )
---?image=/assets/images/slides2/Slide15.JPG @title[Build Nt32 Edk2 -getting the Source 02]
@snap[north-east span-50 ]
– Copy `edk2`
@snapend@snap[north-west span-100 ]
2. Open a VS command prompt
3. Create a working space directory "FW"
C:\> mkdir FW
4. From the downloaded "`Lab_Material_FW`" folder, copy and paste folder "`...\edk2`" to `C:/FW`
@snapend
Note:
- Open a VS Command prompt
- Create a working space directory “FW”
C:\> mkdir FW
- From the downloaded Lab_Material_FW folder, copy and paste folder “
..\edk2” toC:/FW
---?image=/assets/images/slides2/Slide16.JPG @title[Build Nt32 Edk2 -get Nasm]
@snap[north-east span-50 ]
–Get Nasm
@snapend@snap[north-west span-100 ]
Copy the `Nasm` directory to `C:\`
@snapend
@title[Build Nte32 Edk2 -install Python]
@snap[north-east span-50 ]
–Download and install Python
-Build `BaseTools`
@snap[north-west span-60 ]
Download and install Python 3.7.x for Windows from:
https://www.python.org
Invoke `Edksetup.bat` to build `BaseTools` @size[.7em]( (now uses Python 3.7.x))
```
C:\> cd FW/edk2
C:\FW\edk2> edksetup.bat Rebuild
```@snapend
@snap[north-east span-45 ]
@snapend
@snap[east span-40 fragment ]
@color[yellow](⇦)
@snap[south-west span-100 ]
@color[white](Building `BaseTools` only needs to be done once )
@snapend
---?image=assets/images/binary-strings-black2.jpg
@title[Build Nt32 sub Section]
---?image=/assets/images/slides2/Slide18.JPG @title[Build Nt32 Edk2 -update target.txt]
@snap[north-east span-50 ]
–Update Target.txt
@snapend@snap[north-west span-100 ]
@size[1.10em](Nt32Pkg) - Build with edk2
Invoke `Edksetup.bat`
```
C:\FW\edk2> edksetup.bat
```
Edit the file "`Conf/target.txt`"
(change `TOOL_CHAIN_TAG`) `Notepad Conf/target.txt`
@snapend
@snap[south-west span-100 ]
Save and Exit
Build Nt32Pkg
```
C:\FW\edk2> build -D BUILD_NEW_SHELL
</pre>
@snapend
@snap[south-east span-40 fragment ]
<p style="line-height:10%" align="left"><span style="font-size:02.80em; " ><br><br>
@color[yellow](⇦)
<br>
</span></p>
@snapend
Note:
- `$ Cd C:/fw/edk2`
- invoke `$ edksetup.bat Rebuild`
- change MYTOOLS to VS2013x86
- `$ Build -D BUILD_NEW_SHELL`
---
@title[Possible Build Errors]
### <p align="right"><span class="gold" >Possible Build Errors</span><br></span></p>
<p style="line-height:80%"><span style="font-size:0.8em" >1. If you get a BUILD Error: Error “`C:/Program `“ not found</span></p>
<ul style="line-height:0.8;">
<li><span style="font-size:0.7em" >First check that you have opened Visual Studio and installed the “C++” </span> </li>
<li><span style="font-size:0.7em" >Open Visual Studio and create a “C++” project </span> </li>
<li><span style="font-size:0.7em" > (This will take some time to install)</span> </li>
</ul>
<p style="line-height:80%"><span style="font-size:0.8em" >2. If you get a BUILD Error: Check if RC.Exe compiler not found is the error -<a href="https://gitpitch.com/tianocore-training/Platform_Build_Win_Lab/master#/56"> here</a> </span> </p>
<p style="line-height:80%"><span style="font-size:0.8em" >3. If you get a BUILD Error: `fatal error C1041: cannot open program database` … Check <a href="https://gitpitch.com/tianocore-training/Platform_Build_Win_Lab/master#/57"> here</a> </span> </p>
Note:
---?image=/assets/images/slides/Slide19.JPG
@title[Build Nt32 Edk2 -build inside VS Prompt]
### <p align="right"><span class="gold" >Build EDK II Nt32</span></span></p>
@snap[north-east span-50 ]
<br>
<p align="right"><span style="font-size:0.8em" ><font color="#e49436">–Inside VS Prompt</font></span></p>
@snapend
Note:
-
---?image=/assets/images/slides2/Slide20.JPG
@title[Build Nt32 Edk2 -invoke Nt32]
### <p align="right"><span class="gold" >Invoke Nt32 Emulation</span></p>
@snap[north-west span-45 ]
<br>
<br>
<p style="line-height:80%" align="left"><span style="font-size:0.8em" >From the command prompt<br><br></span>
<font face="Consolas"><span style="background-color: #000000; font-size:0.55em; ">
C:\FW\edk2> Build Run </span></font></p>
<br>
<p style="line-height:80%" align="left"><span style="font-size:0.6em" > Notice 2 "UGA Window n" opened </span></p>
@snapend
Note:
---?image=assets/images/gitpitch-audience.jpg
@title[End of Section]
<br><br><br><br><br>
## <span class="gold" > End of Lab </span>
<span style="font-size:0.9em" > <a href=''>Return to the beginning</a> </span>
---?image=assets/images/binary-strings-black2.jpg
@title[Lab 2 -Setup MAX HW Section]
<br><br><br><br><br>
## <span class="gold" > Lab 2: Platform HW Setup</span>
<span style="font-size:0.9em" > Setup hardware for MinnowBoard Max/Turbot </span>
---?image=/assets/images/slides2/Slide23.JPG
@title[MAX/Turbot HW]
### <p align="right"><span class="gold" >EDK II Platform (MinnowBoard MAX/Turbot)</span></p>
@snap[south-west span-45 ]
<br>
<p style="line-height:60%" align="left"><span style="font-size:0.6em" >Intel<sup>®</sup> Atom processor E3800 Series<br> (Formerly Bay Trail-I)</span></p>
<br>
@snapend
Note:
This lab shows the build process for an actual platform – Minnowboard.org
- Using Tianocore source
- Open source EDK II plus open source binary obj. packages
---?image=/assets/images/slides2/Slide24.JPG
@title[Workshop Lab Hardware]
### <p align="right"><span class="gold" >MinnowBoard MAX Workshop Lab Hardware</span></p>
@snap[south span-100 ]
<br>
<p style="line-height:80%" ><span style="background-color: #FFFFFF; font-size:0.60em; "> <font color="red"> <b>**Warning</b> do not use any other power supply than 5V or the board will Fry </font></span></p>
<br>
@snapend
Note:
**Warning do not use any other power supply than 5V or the board will Fry
---?image=/assets/images/slides/Slide25.JPG
@title[Instructions for Lab Materials]
### <p align="right"><span class="gold" >Instructions for Lab Materials</span></p>
<span style="font-size:0.9em">Directory `C:\PlatformBuildLab_FW\FW\PlatformBuildLab` </span>
<div class="left">
<ul style="list-style-type:none">
<li><span style="font-size:0.8em">FTDI Driver for Serial UART Cable (COM Port) <a href="http://www.ftdichip.com/FTDrivers.htm "> ftdichip.com/FTDrivers.htm </a></span> </li>
<li><span style="font-size:0.8em">TeraTerm (terminal software for COM Port) <a href="https://en.osdn.jp/projects/ttssh2/releases/"> ttssh2/releases/</a></span> </li>
</ul>
</div>
<div class="right">
<div class="left1"> </span>
</div>
Note:
---?image=/assets/images/slides2/Slide26.JPG
@title[Setup MinnowBoard Max Test System]
<p style="line-height:85%" align="right"><span class="gold" >@size[1.1em](<b>Setup MinnowBoard Max Test System</b>)</span></p>
@snap[north-west span-60 ]
<br>
<br>
<p style="line-height:50%"><span style="font-size:0.7em"><b>Hardware:</b></span></p>
<ul style="list-style-type:none; line-height:0.5;">
<li><span style="font-size:0.5em">- System Under Test (SUT) - MinnowBoard Max </span> </li>
<li><span style="font-size:0.5em">- USB to 3.3V TTL Cable (6 pin to USB Type A) </span> </li>
<li><span style="font-size:0.5em">- 5V power supply </span> </li>
</ul>
<p style="line-height:50%"><span style="font-size:0.6em">
Connect the USB w/ 6 pin header to SUT (MAX) <br><br>
Connect the USB Type A connector to Host (Laptop) <br><br>
On your Host <b>Go</b> to the "<b>Device Manager</b>" in the control panel <br><br>
Under the "<b>Other devices</b>" category you will see a yellow @fa[exclamation-triangle gp-bullet-gold ] with a warning icon next to it. <br><br>
You may already have this driver installed if you do not see a @fa[exclamation-triangle gp-bullet-gold ] warning under "<b>Other devices</b>"
</span> </p>
@snapend
Note:
- Hardware:
- System Under Test (SUT) – MinnowBoard Max
- USB to 3.3V TTL Cable (6 pin to USB Type A)
- 5V power supply
- Connect the USB w/ 6 pin header to SUT (MAX)
- Connect the USB Type A connector to Host (Laptop)
- On your Host Go to the “Device Manager” in the control panel.
- Under the "Other devices" category you will see a yellow ! with a warning icon next to it.
- You may already have this driver installed if you do not see a ! warning under “Other devices”
---?image=/assets/images/slides2/Slide27.JPG
@title[Setup COM port on Host]
<p style="line-height:80%" align="right"><span class="gold" >@size[1.1em](<b>Setup COM port on Host</b>)</span></p>
<p style="line-height:40%"><span style="font-size:0.6em"><br> • Right click yellow @fa[exclamation-triangle gp-bullet-gold ] and select "Update Driver Software" from the <b>Device Manager menu</b></span></p>
@snap[north-west span-75 ]
<br>
<br>
<br>
<p style="line-height:40%"><span style="font-size:0.6em">
• Select "Browse my computer for driver software" <br><br>
• Click the <b>Browse</b> button – Click @fa[check-square gp-bullet-white] on "Include subfolders"<br><br>
• Browse to the location of the folder for the FTDI driver<br><br>
• Click on the folder and press <b>OK</b>
@snapend
@snap[south-west span-30 ]
<p style="line-height:50%"><span style="font-size:0.6em">
• Press <b>Next</b><br>
Driver will be installed
</span> </p>
<br>
<br>
<br>
<br>
<br>
@snapend
Note:
- Right click yellow ! and select "Update Driver Software“ from the Device Manager menu
- Select "Browse my computer for driver software”.
- Click the Browse button. – Click on “Include subfolders”
- Browse to the location of the folder you unzipped earlier for the FIDI driver.
- Click on the folder and press OK.
- Press Next.
- Driver will be installed
---?image=/assets/images/slides2/Slide28.JPG
@title[Setup TeraTerm]
<p style="line-height:80%" align="right"><span class="gold" >@size[1.1em](<b>Setup TeraTerm</b>)</span></p>
@snap[north-west span-35 ]
<br>
<br>
<p style="line-height:50%"><span style="font-size:0.7em">
Unzip and Install TeraTerm<br><br>
Open TeraTerm Software<br><br>
Select the serial port assigned
</span></p>
@snapend
@snap[south-east span-55 ]
<br>
<br>
<p style="line-height:60%" align="left"><span style="font-size:0.6em">
Go to <b>Setup −> Serial Port</b> and set the following:<br>
• Baud: 115200<br>
• Parity: None<br>
• Data Bits: 8<br>
• Stop Bits: 1<br>
• Flow Control: Xon/Xoff
</span></p>
@snapend
Note:
- Unzip and Install TeraTerm
- Open TeraTerm Software
- Select the serial port assigned
- Go to Setup- Serial Port and set the following:
- Baud: 115200
- Parity: None
- Data Bits: 8
- Stop Bits: 1
- Flow Control: Xon/Xoff
---?image=/assets/images/slides2/Slide29.JPG
@title[Power on MinnowBoard MAX]
<p style="line-height:80%" align="right"><span class="gold" >@size[1.1em](<b>Power on MinnowBoard MAX</b>)</span></p>
@snap[north-west span-100 ]
<br>
<br>
<p style="line-height:60%"><span style="font-size:0.8em">
Connect the Power supply cable to the MinnowBoard MAX
<br>
<br>
MinnowBoard MAX should boot to the UEFI Shell in the TeraTerm window.
</span></p>
@snapend
Note:
- Connect the Power supply cable to the MinnowBoard MAX
- MinnowBoard MAX should boot to the UEFI Shell in the TeraTerm window.
---?image=assets/images/gitpitch-audience.jpg
@title[End of Section]
<br><br><br><br><br>
## <span class="gold" > End of Lab </span>
<span style="font-size:0.9em" > @fa[chevron-right gp-bullet-cyan] to continue </span>
---?image=assets/images/binary-strings-black2.jpg
@title[Lab 3 -Build Max/Turbot Section]
<br><br><br><br><br>
## <p align="center"><span class="gold" > Lab 3: Build MinnowBoard Turbot</span></p>
<span style="font-size:0.9em" > </span>
---?image=/assets/images/slides2/Slide23.JPG
@title[MAX/Turbot HW]
### <p align="right"><span class="gold" >EDK II Platform (MinnowBoard MAX/Turbot)</span></p>
@snap[south-west span-45 ]
<br>
<p style="line-height:60%" align="left"><span style="font-size:0.6em" >Intel<sup>®</sup> Atom processor E3800 Series<br> (Formerly Bay Trail-I)</span></p>
<br>
@snapend
Note:
- Intel® Atom processor E3800 Series (Formerly Bay Trail-I)
---?image=/assets/images/slides/Slide33.JPG
@title[MinnowBoard MAX/ Turbot Platform]
<br>
<p align="left"><span class="gold" ><b>Where to get Open Source<BR> MinnowBoard Max</b></span></p>
<br>
- <span style="font-size:0.9em"><font color="yellow">Open Source </font><a href="https://github.com/tianocore/tianocore.github.io/wiki/MinnowBoardMax"> Max Wiki</a></span>
- <span style="font-size:0.9em">V 1.00 -<a href="https://github.com/tianocore/edk2-platforms/tree/devel-MinnowBoardMax-UDK2017"> Github Link</a></span>
- <span style="font-size:0.9em"><font color="white">Binary Object Modules:<br> </font><a href="https://firmware.intel.com/projects/minnowboard-max ">firmware.intel.com</a></span>
- <span style="font-size:0.9em">How to Build<a href="https://firmware.intel.com/sites/default/files/minnowboard_max-rel_1_00-releasenotes.txt"> Release Notes</a></span>
Note:
- Step by step if NOT downloading Lab release of Minnowboard MAX/Turbot
---?image=/assets/images/slides/Slide34.JPG
@title[MinnowBoard MAX/ Turbot Platform]
<br>
<p align="left"><span class="gold" ><b>Where to get Open Source<BR> MinnowBoard Max</b></span></p>
<br>
- <span style="font-size:0.9em"><font color="white">Open Source </font><a href="https://github.com/tianocore/tianocore.github.io/wiki/MinnowBoardMax"> Max Wiki</a></span>
- <span style="font-size:0.9em">V 1.00 -<a href="https://github.com/tianocore/edk2-platforms/tree/devel-MinnowBoardMax-UDK2017"> Github Link</a></span>
- <span style="font-size:0.9em"><font color="Yellow">Binary Object Modules:<br> </font><a href="https://firmware.intel.com/projects/minnowboard-max ">firmware.intel.com</a></span>
- <span style="font-size:0.9em">How to Build<a href="https://firmware.intel.com/sites/default/files/minnowboard_max-rel_1_00-releasenotes.txt"> Release Notes</a></span>
Note:
- Step by step if NOT downloading Lab release of Minnowboard MAX/Turbot
---
@title[Download MinnowBoard MAX Lab Source]
### <p align="right"><span class="gold" >Download MAX Lab Source</span></p>
<span style="font-size:0.9em" >Download the PlatformBuildLab_FW.zip from : </span> @fa[github gp-bullet-white] <span style="font-size:0.7em"><a href="https://github.com/tianocore-training/PlatformBuildLab_FW/archive/master.zip">github.com PlatformBuildLab_FW.zip</a></span><br>
<br>
<span style="font-size:0.9em" >OR<br>Use `git clone` to download the PlatformBuildLab_FW<span>
$ git clone https://github.com/tianocore-training/PlatformBuildLab_FW.git
<span style="font-size:0.9em" >Directory PlatformBuildLab_FW will be created</span>
FW
- PlatformBuildLab
- asl - Asl Compiler
- FTDI-Driver - Serial / USB cable
- Max - Minnowboard Max Source
- MinnowBoard.MAX.FirmwareUpdateX64.efi - UEFI App to flash
- TeraTerm - Terminal app
. . .
Note:
---?image=/assets/images/slides2/Slide36.JPG
@title[MinnowBoard MAX Lab Setup]
### <p align="right"><span class="gold" >MinnowBoard MAX Lab Setup</span></p>
@snap[north-west span-70 ]
<br>
<br>
<br>
<p style="line-height:70%"><span style="font-size:0.8em">
@color[#87E2A9](Previous Lab Setup Requirements)<br></span>
<span style="font-size:0.6em">
NASM<br>
Copy ... `Lab_Material_FW\FW\Nasm` to `C:\` <br><br><br><br>
</span>
<span style="font-size:0.8em">
@color[#87E2A9](Additional Lab Setup -)</span><br>
<span style="font-size:0.6em">
@color[#87E2A9]( `PlatformLab_FW/FW/PlatformBuildLab`)
</span></p>
@snapend
@snap[south-west span-25 ]
<p style="line-height:40%" align="left"><span style="font-size:0.55em">
<b>Directories:</b><br>
•Max<br>
•asl<br>
•FTDI-Driver<br>
•Nasm<br>
•TeraTerm
</snap></p>
<br>
@snapend
@snap[south-east span-80 ]
<p style="line-height:40%" align="left"><span style="font-size:0.55em"><font color="yellow">
<br>
‐ MinnowBoard Max Project source code<br>
‐ Iasl Assembler C:/asl directory<br>
‐ Driver for Serial/USB Uart cable<br>
‐ Nasm Assembly compiler- Same as previous lab<br>
‐ TeraTerm application
</font></snap></p>
<br>
@snapend
Note:
- NASM
- `Copy …Lab_Material_FW\FW\Nasm to C:\`
---?image=/assets/images/slides2/Slide37.JPG
@title[Preparing to Build]
### <p align="right"><span class="gold" >Preparing to Build</span></p>
<p style="line-height:70%"><span style="font-size:0.8em">
Directory `C:\PlatformBuildLab_FW\FW\PlatformBuildLab` from Download or zip
</span></p>
@snap[north-west span-60 ]
<br>
<br>
<br>
<br>
<br>
<br>
<p style="line-height:70%"><span style="font-size:0.8em">
@size[1.5em](<font color="#87E2A9"> ❶</font>) Copy `\Nasm` Folder to `C:\`<br><br><br>
@size[1.5em](<font color="#87E2A9"> ❷</font>) Copy `\asl` Folder to `C:\`
</span></p>
@snapend
Note:
<pre>
Copy \Nasm Folder to C:\
Copy \asl Folder to C:\
</pre>
---?image=/assets/images/slides2/Slide38.JPG
@title[Get the Minnowboard Max Source]
### <p align="right"><span class="gold" >Copy Minnowboard Max Source</span></p>
@snap[north-west span-20 ]
<br>
<br>
<p style="line-height:40%"><span style="font-size:0.8em"><br>@size[1.5em](<font color="#87E2A9"> ❸</font>)</span></p>
@snapend
@snap[north-east span-95 ]
<br>
<br>
<p style="line-height:70%" align="left"><span style="font-size:0.8em">
Open a VS Command Prompt<br>
Create a working space source directory under the home directory<br></span>
<font face="Consolas"><span style="background-color: #000000; font-size:0.50em; ">
C:\> mkdir FW</span></font></span><br><br>
<span style="font-size:0.7em">
From the `FW/PlatformBuildLab` folder, copy and paste folder "`..FW/Max`" to `C:/FW/Max`
</span></p>
@snapend
Note:
- Open a VS prompt
- Create a working space source directory under the home directory
- bash$ mkdir FW
- From the FW/PlatformBuildLab folder, copy and paste folder “FW/Max” to ~src
---?image=/assets/images/slides/Slide39.JPG
@title[Platform Source Directory Structure]
### <p align="right"><span class="gold" >Platform Source Directory Structure </span></p>
Note:
- Platform Source Directory Structure
- Build from /Vlv2TbltDevicePkg directory
---
@title[Steps to Build & Install Firmware]
<br>
### <p align="center"><span class="gold" >Steps to Build & Install Firmware</span></p>
<ul style="list-style-type:none; line-height:0.9;">
<li><span style="font-size:0.9em">@size[1.125em](<font color="yellow"> ❶</font>) Open VS Command prompt </span></li>
<li><span style="font-size:0.9em">@size[1.125em](<font color="yellow"> ❷</font>) Cd to project directory : <br> </span><span style="font-size:0.6em">`C:/fw/Max/edk2-platforms/Vlv2TbltDevicePkg` </span></li>
<li><span style="font-size:0.9em">@size[1.125em](<font color="yellow"> ❸</font>) Invoke the build process</span></li>
<li><span style="font-size:0.9em">@size[1.125em](<font color="yellow"> ❹</font>) Locate build output (.BIN file for BIOS image)</span></li>
<li><span style="font-size:0.9em">@size[1.125em](<font color="yellow"> ❺</font>) Flash binary image onto the platform</span></li>
<li><span style="font-size:0.9em">@size[1.125em](<font color="yellow"> ❻</font>) Reset and verify new firmware</span></li>
</ul>
<br>
<br>
<span style="font-size:0.9em"><font color="yellow"><i><b>Next slides will follow the above steps</b></i></font></span>
Note:
Slide says it all
---?image=/assets/images/slides2/Slide41.JPG
@title[Open a VS Command Prompt]
### <p align="right"><span class="gold" >Open a VS Command Prompt </span></p>
<p style="line-height:80%" align="left"><span style="font-size:0.8em">Follow Steps from <a href="https://gitpitch.com/tianocore-training/Platform_Build_Win_Lab/master#/2">here</a> to Pin the Visual Studio Command Prompt to the Windows Task Bar <br>
@size[1.25em](<font color="yellow"> ❶</font>) Open a Visual Studio Command Prompt<span></p>
Note:
---
@title[Platform Build Scripts]
<p align="right"><span class="gold" >@size[1.1em](<b>Platform Build Scripts</b>)</span></p>
@box[bg-purple-pp text-white rounded my-box-pad2 ](<p style="line-height:70%" align="center"><span style="font-size:0.8em">Platform Build Scripts<br> </span></p>)
<p style="line-height:80%"><span style="font-size:0.8em">Many Platform have a bash or bat script file to pre or post process the EDK II build process</span></p>
<p style="line-height:70%"><span style="font-size:0.7em">For MinnowBoard MAX : `Build_IFWI.bat or Build_IFWI.sh` <br></span>
<span style="font-size:0.7em"><Example:<br>
Build_IFWI <br>
– pre build processing <br>
– calls `vlv_bld` - a platform script to preform the EDK II `build` <br>
– determines date <br>
– board ID<br>
– post build stitching<br>
</span></p>
Note:
For the platform edk II builds usually a script is called that will do pre and post build processing.
There is also this capability that is part of the .dsc but many developers have not taken advantage of this feature
---?image=/assets/images/slides2/Slide42.JPG
@title[Build Process for DEBUG]
### <p align="right"><span class="gold" >Build Process for DEBUG BIOS </span></p>
<p style="line-height:80%" align="left"><span style="font-size:0.8em">
From the VS command Prompt ... Enter:<br>
@size[1.25em](<font color="yellow"> ❷</font>) </span>
<font face="Consolas"><span style="background-color: #000000; font-size:0.650em; ">
cd c:\FW\Max\edk2-Platforms\Vlv2TbltDevicePkg </span></font></span><br>
<span style="font-size:0.8em">
@size[1.25em](<font color="yellow"> ❸</font>) </span>
<font face="Consolas"><span style="background-color: #000000; font-size:0.650em; ">
Build_IFWI.bat /l MNW2 Debug </span></font></p>
Note:
- From the VS Command Prompt … ENTER:
<pre>
$ cd C:\FW\Max\edk2-Platforms\Vlv2TbltDevicePkg
$ Build_IFWI.bat /l MNW2 Debug
</pre>
---
@title[Examine Command Line & Build Parameters]
<p align="right"><span class="gold" >@size[1.1em](<b>Examine Build Parameters</b>)</span></p>
@snap[north-west span-100 ]
<br>
<br>
@box[bg-black text-yellow rounded my-box-pad2 ](<p style="line-height:60%" align="left"><span style="font-size:0.65em; font-family:Consolas; " > build<br><br><br> </span></p>)
@snapend
@snap[north-east span-85 fragment]
<br>
<br>
<p style="line-height:60%" align="left"><span style="font-size:0.60em; font-family:Consolas; " >
<font color="#75deFF">-D SYMBOLIC_DEBUG=TRUE -D LOGGING=TRUE<br>
. . . -D <i> Option (n)</i> </font>
</span></p>
@snapend
@snap[north-east span-30 fragment]
<br>
<br>
<p style="line-height:40%" align="left"><span style="font-size:0.8em"><br></span></p>
@box[bg-white text-black rounded my-box-pad2 ](<p style="line-height:70%" align="left"><span style="font-size:0.8em"><font color="blue"><b> MACROS</font><br> Logging<br> Symbolic Debug<br> </b></span></p>)
@snapend
@snap[north-west span-100 fragment ]
<br>
<br>
<br>
<br>
<p style="line-height:60%" align="left"><span style="font-size:0.8em"><font color="#87E2A9"><br><br><b>Properties from `Conf\Target.txt`</b></font></span></p>
<table id="recTable">
<tr class="fragment">
<td align="left" bgcolor="#404040" height=".0025"><p style="line-height:010%"><span style="font-size:0.460em; font-family:Consolas; " ><b>TARGET</b></span></p></td>
<td align="left" bgcolor="#404040" height=".0025"><p style="line-height:010%"><span style="font-size:0.460em; font-family:Consolas; " ><b>= @color[yellow](DEBUG)</b></span></p></td>
<td align="left" bgcolor="#0070C0" height=".0025"><p style="line-height:010%"><span style="font-size:0.6em" ><b>Build Mode</b></span></p></td>
</tr>
<tr class="fragment">
<td align="left" bgcolor="#404040" height=".0025"><p style="line-height:010%"><span style="font-size:0.460em; font-family:Consolas; " ><b>TARGET_ARCH</b></span></p></td>
<td align="left" bgcolor="#404040" height=".0025"><p style="line-height:010%"><span style="font-size:0.460em; font-family:Consolas; " ><b>= @color[yellow](IA32 X64)</b></span></p></td>
<td align="left" bgcolor="#0070C0" height=".0025"><p style="line-height:010%"><span style="font-size:0.6em" ><b>CPU Architecture</b></span></p></td>
</tr>
<tr class="fragment">
<td align="left" bgcolor="#404040" height=".0025"><p style="line-height:010%"><span style="font-size:0.460em; font-family:Consolas; " ><b>TOOL_CHAIN_TAG</b></span></p></td>
<td align="left" bgcolor="#404040" height=".0025"><p style="line-height:010%"><span style="font-size:0.460em; font-family:Consolas; " ><b>= @color[yellow](VS2013x86)</b></span></p></td>
<td align="left" bgcolor="#0070C0" height=".0025"><p style="line-height:010%"><span style="font-size:0.6em" ><b>VS Tool Chain</b></span></p></td>
</tr>
<tr class="fragment">
<td align="left" bgcolor="#404040" height=".0025"><p style="line-height:010%"><span style="font-size:0.460em; font-family:Consolas; " ><b>ACTIVE_PLATFORM</b></span></p></td>
<td align="left" bgcolor="#404040" height=".0025"><p style="line-height:040%"><span style="font-size:0.460em; font-family:Consolas; " ><b>= @color[yellow](Vlv2TbltDevicePkg /PlatformPkgX64)</b></span></p></td>
<td align="left" bgcolor="#0070C0" height=".0025"><p style="line-height:010%"><span style="font-size:0.6em" ><b>Platform DSC file</b></span></p></td>
</tr>
<tr class="fragment">
<td align="left" bgcolor="#404040" height=".0025"><p style="line-height:040%"><span style="font-size:0.460em; font-family:Consolas; " ><b>MAX_CONCURRENT_ THREAD_NUMBER</b></span></p></td>
<td align="left" bgcolor="#404040" height=".0025"><p style="line-height:010%"><span style="font-size:0.460em; font-family:Consolas; " ><b>= @color[yellow](1)</b></span></p></td>
<td align="left" bgcolor="#0070C0" height=".0025" width="35%"><p style="line-height:010%"><span style="font-size:0.6em" ><b>Thread Count</b></span></p></td>
</tr>
</table>
@snapend
---
@title[Examine Platform Parameters]
<p align="right"><span class="gold" >@size[1.1em](<b>Platform Build and PCD Parameters</b>)</span></p>
@box[bg-purple-pp text-white rounded my-box-pad2 ](<p style="line-height:70%" align="center"><span style="font-size:0.8em">Platform Parameters<br> </span></p>)
<p style="line-height:80%"><span style="font-size:0.8em">Many Platform Parameters are defined in a top .DSC file that controls PCD and build switches</span></p>
<p style="line-height:70%"><span style="font-size:0.7em">For MinnowBoard MAX : `PlatformPkgConfig.dsc` <br>Example:</span></p>
```xml
#
# TRUE is ENABLE. FASLE is DISABLE.
#
// . . .
DEFINE SECURE_BOOT_ENABLE = TRUE
DEFINE USER_IDENTIFICATION_ENABLE = FALSE
DEFINE VARIABLE_INFO_ENABLE = FALSE
DEFINE S3_ENABLE = TRUE
DEFINE CAPSULE_ENABLE = TRUE
DEFINE CAPSULE_RESET_ENABLE = TRUE
// . . .
Note:
many will have "ifdef" statements in the major .dsc file in order to enable a feature or not
---?image=/assets/images/slides2/Slide51.JPG
@title[Build Process for Release]
Build Process for Release
From the VS command Prompt ... Enter:
@size[1.25em]( ❸)
Build_IFWI.bat /l MNW2 Release
@snap[north-east span-30 fragment]
@box[bg-white text-black rounded my-box-pad2 ]( Note MACROS Logging Symbolic Debug Set to FALSE )
@snapend
Note:
From VS Prompt enter:
$ cd Vlv2TbltDevicePkg
$ Build_IFWI.bat /l MNW2 Release
@title[DEBUG & RELEASE Differences]
DEBUG & RELEASE Differences
@box[bg-purple-pp text-white rounded my-box-pad2 fragment](Slower boot because the time it takes to display debug info )
@box[bg-green-pp text-white rounded my-box-pad2 fragment](Larger image because of debug code & embedded info )
@box[bg-gold2 text-white rounded my-box-pad2 fragment](Uses the serial port for debug string output )
@box[bg-royal text-white rounded my-box-pad2 fragment](Contains detailed debug strings that show the boot progress and various ASSERT / TRACE errors )
Note:
DEBUG build …
Contains detailed debug strings that show the boot process, along with various ASSERT/TRACE errors
Uses the serial port for debug string output
Larger image than RELEASE, due to the embedded debug info
Slower boot than RELEASE, due to the time it takes to display the debug info
RELEASE build …
Does not contain the debug strings
Does not use the serial port for debug output
Smaller image than DEBUG
Faster boot than DEBUG
---?image=/assets/images/slides2/Slide57.JPG
@title[Build Process Completed]
Build Process Completed
@size[1.25em]( ❹) Locate the build .BIN image
@snap[south-west span-100 ]
The platform build script post build process will stitch the multiple firmware volumes generated by the EDK II build process into the final .BIN image.
The script displays the location of the final .BIN file
@snapend
Note:
The EDK II build generates multiple firmware volumes, which are combined in the .BIN image
typically the platform script will call a stitching process to combine all the images together in post processing after the EDK II build
---?image=/assets/images/slides/Slide55_1.JPG
@title[Flash onto the MinnowBoard MAX]
Flashing the New BIOS
@snap[north-west span-100 ]
@size[1.25em]( ❺) Flash the binary image
@snapend
1. Access Max Binary image file from build folder
- `C:/fw/Max/Vlv2TbltDevicePkg/Stitch`
- DEBUG MNW2MAX1.X64.D01.0098._date_.bin
- RELEASE MNW2MAX1.X64.R01.0098._date_.bin
2. Copy BIN files to a USB Thumb drive
3. Copy `MinnowBoard.MAX.FirmwareUpdateX64.efi` to a USB thumb drive from `$.../FW/PlatformBuildLab`
4. Boot to UEFI Shell on Max and type "`FS0:`"
Note:
Access Max Binary image file from build folder
C:/fw/Max/Vlv2TbltDevicePkg/Stitch
DEBUG MNW2MAX1.X64.D01.0098.date.bin
RELEASE MNW2MAX1.X64.R01.0098.date.bin
Copy BIN files to a USB Thumb drive
Copy MinnowBoard.MAX.FirmwareUpdateX64.efi to a USB thumb drive from $.../FW/PlatformBuildLab
Boot to UEFI Shell on Max and type "FS0:"
---?image=/assets/images/slides/Slide56_1.JPG
@title[Flash onto the MinnowBoard MAX 02]
Flashing the New BIOS
5. Run update `.efi` utility with either BIN file (Note the “TAB” Key will fill out the command line for you )
FS0:\> MinnowBoard.MAX.FirmwareUpdateX64.efi MNW2MAX1.X64.0098.D01.1801181447.bin
Wait for the new firmware update to finish
6. Reset and boot new firmware
Note:
5. Run update .efi utility with either BIN file (Note the “TAB” Key will fill out the command line for you
FS0:\> MinnowBoard.MAX.FirmwareUpdateX64.efi MNW2MAX1.X64.0098.D01.1801181447.bin
Reset and boot new firmware
---?image=/assets/images/slides/Slide57_1.JPG
@title[Verify after Firmware Update]
Verify after Firmware Update
@snap[north-west span-100 ]
@size[1.25em]( ❻) Reboot and Verify
@snapend
- Verify that the Firmware was updated by checking the Date
- At the shell prompt type “exit”
- The EDK II front page will show the BIOS ID with Date/time stamp
Note:
Verify that the Firmware was updated by checking the Date
At the shell prompt type “exit”
The EDK II front page will show the BIOS ID with Date/time stamp
@title[Summary]
<p align="center"Summary
@fa[certificate gp-bullet-magenta] Pin Visual Studio Command Prompt to Windows Task Bar
@fa[certificate gp-bullet-green] Lab 1: Build a EDK II Platform using Nt32 package
@fa[certificate gp-bullet-cyan] Lab 2: Hardware Setup for Minnowboard Max/Turbot
@fa[certificate gp-bullet-yellow] Lab 3: Build a EDK II Platform using Minnowboard Max/Turbot
---?image=assets/images/gitpitch-audience.jpg
@title[Questions]
@title[return to main]
@size[1.2em](Return to Main Training Page)
Return to Training Table of contents for next presentation link
@snap[north span-30 ]
@snapend
---?image=assets/images/gitpitch-audience.jpg
@title[Logo Slide]
@title[Acknowledgements]
Acknowledgements
/**
Redistribution and use in source (original document form) and 'compiled' forms (converted
to PDF, epub, HTML and other formats) with or without modification, are permitted provided
that the following conditions are met:
Redistributions of source code (original document form) must retain the above copyright
notice, this list of conditions and the following disclaimer as the first lines of this
file unmodified.
Redistributions in compiled form (transformed to other DTDs, converted to PDF, epub, HTML
and other formats) must reproduce the above copyright notice, this list of conditions and
the following disclaimer in the documentation and/or other materials provided with the
distribution.
THIS DOCUMENTATION IS PROVIDED BY TIANOCORE PROJECT "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL TIANOCORE PROJECT BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
Copyright (c) 2019, Intel Corporation. All rights reserved.
**/
---?image=assets/images/binary-strings-black2.jpg
@title[Backup Section]
Back up
@title[Build Errors]
<p align="center"Build Errors
@title[Build Error- RC.exe ]
Build Error- RC.exe
Because RC.Exe is not found, Error Message:
"c:\Program Files (x86)\Windows Kits\8.0\bin\x64\rc.exe"
/Foc:\edkii.svn\Build\NT32IA32\DEBUG_VS2013x86\IA32\MdeModulePkg\Application\HelloWorld\HelloWorld\OUTPUT
\HelloWorldhii.lib
c:\edkii.svn\Build\NT32IA32\DEBUG_VS2013x86\IA32\MdeModulePkg\Application\HelloWorld\HelloWorld\OUTPUT\He
lloWorldhii.rc
'c:\Program' is not recognized as an internal or external command,
operable program or batch file.
NMAKE : fatal error U1077: '"c:\Program Files (x86)\Windows Kits\8.0\bin\x64\rc.exe' : return code '0x1'
Stop.
Find where the RC.EXE is located on your VS Installation:
Example (VS 2013): The RC.exe is located on this machine:
`C:\Program Files (x86)\Windows Kits\8.1\bin\x64`
Edit `Conf/tools_def.txt`
Note:
+++
@title[Build Error- RC.exe 02]
Build Error- RC.exe Cont...
Edit Conf/tools_def.txt
Search for your installation of Visual Studio (2013 or 2015)
Update according to the path for where the RC.EXE is found
# Microsoft Visual Studio 2013 Professional Edition
DEFINE WINSDK8_BIN = c:\Program Files\Windows Kits\8.1\bin\x86\
DEFINE WINSDK8x86_BIN = c:\Program Files (x86)\Windows Kits\8.1\bin\x64
# Microsoft Visual Studio 2015 Professional Edition
DEFINE WINSDK81_BIN = c:\Program Files\Windows Kits\8.1\bin\x86\
DEFINE WINSDK81x86_BIN = c:\Program Files (x86)\Windows Kits\8.1\bin\x64
Note:
@title[Build Error- C1041 ]
Build Error: fatal error C1041:
Build Error from fatal error C1041: cannot open program database
This Error is usually because the location you are building is being shared by another application in Windows. Example: Syncplicity may cause this
Error Message:
k:\fw\edk2\MdePkg\Library\BaseLib\LinkedList.c : fatal error C1041: cannot open program
database
'k:\fw\edk2\build\nt32ia32\debug_vs2013x86\ia32\mdepkg\library\baselib\baselib\vc120.pdb'; if
multiple CL.EXE write to the same .PDB file, please use /FS
NMAKE : fatal error U1077: '"C:\Program Files (x86)\Microsoft Visual Studio
12.0\Vc\bin\cl.exe"' : return code '0x2'
Stop.
Solution: Try using a Workspace that is not shared
---?image=/assets/images/slides/Slide66.JPG
@title[Support for VS 2015 for MinnowBoard MAX]
Support for VS 2015 forMinnowBoard MAX
Note:
The Open Source Max release does not support VS 2015
To work around do the following:
Copy the file
“..Max/edk2/conf/tools_def_VS2015x86.txt” to “..Max/edk2/conf/tools_def.txt”
Check out the differences:
There is a check for VS140COMNTOOLS and if defined setup for VS 2015
See that tools_def.txt replaces /Wx and /W4 with /w to turn off warnings as errors
---?image=/assets/images/slides/Slide67.JPG
@title[Visual Studio Resource Compiler Error – Rc.exe]
Visual Studio Resource Compiler Error – Rc.exe
Note:
The Rc.exe was not found and the build fails
Find where rc.exe is located and update the tools_def.txt
Update Max/edk2/conf/tools_def.txt
- # Microsoft Visual Studio 2013 Professional Edition
- DEFINE WINSDK8x86_BIN = C:\Program Files (x86)\Windows Kits\8.1\bin\x64
- # Microsoft Visual Studio 2015 Professional Edition
- DEFINE WINSDK81x86_BIN = C:\Program Files (x86)\Windows Kits\8.1\bin\x64
- # Microsoft Visual Studio 2017 Professional Edition
- DEFINE WINSDK10_BIN = Location of Rc.exe
---?image=/assets/images/slides/Slide66.JPG
@title[Support for VS 2017 for MinnowBoard MAX]
Support for VS 2017 forMinnowBoard MAX
Note:
The Open Source Max release does not support VS 2017
To work around do the following:
Copy the file
“..Max/edk2/conf/tools_def_VS2015x86.txt” to “..Max/edk2/conf/tools_def.txt”
Check out the differences:
See that tools_def.txt replaces /Wx and /W4 with /w to turn off warnings as errors
At MS Command Prompt
>Set TOOL_CHAIN_TAG=VS2010x86