Edk2
EDK II
Install / Use
/learn @tianocore/Edk2README
============== EDK II Project
A modern, feature-rich, cross-platform firmware development environment for the UEFI and PI specifications from www.uefi.org.
.. image:: https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Ftianocore%2Fedk2-pytool-extensions%2Frefs%2Fheads%2Fmaster%2Fpyproject.toml&query=%24.%5B'requires-python'%5D&style=for-the-badge&logo=python&logoColor=ffd343&label=Minimum%20Python%20Version%20for%20CI&color=3776ab&link=https%3A%2F%2Fwww.python.org%2Fdownloads%2F :alt: CI Minimum Python Version
It is recommended to install this Python version to run the full set of scripts that enable CI in the project.
Other Python requirements for build can be found in the EDK II Build Instructions <https://www.tianocore.org/tianocore-wiki.github.io/build-tooling/build-workflows/edk_ii_tools_list.html>__.
Core CI Build Status
============================= ================= =============== =================== Host Type & Toolchain Build Status Test Status Code Coverage ============================= ================= =============== =================== Windows_VS_ |WindowsCiBuild| |WindowsCiTest| |WindowsCiCoverage| Ubuntu_GCC_ |UbuntuCiBuild| |UbuntuCiTest| |UbuntuCiCoverage| ============================= ================= =============== ===================
More CI Build information <.pytool/Readme.md>__
Platform CI Build Status
Microsoft Windows Visual Studio (VS)
============================= ================= ============= ============= ==============
Toolchain CONFIG DEBUG RELEASE NOOPT
============================= ================= ============= ============= ==============
EmulatorPkg_Win_VS_ | IA32 |em32d| |em32r| |em32n|
| | X64 |em64d| |em64r| |em64n|
| | IA32 FULL |em32fd| |em32fr| |em32fn|
| | X64 FULL |em64fd| |em64fr| |em64fn|
OvmfPkg_Win_VS_ | IA32 |op32d| |op32r| |op32n|
| | X64 |op64d| |op64r| |op64n|
============================= ================= ============= ============= ==============
Ubuntu 24.04
`````````````````
============================= ================= ============= ============= ==============
Toolchain CONFIG DEBUG RELEASE NOOPT
============================= ================= ============= ============= ==============
ArmVirtPkg_Ubuntu_GCC_ | AARCH64 |avAArch64du| |avAArch64ru| |avAArch64nu|
EmulatorPkg_Ubuntu_GCC_ | IA32 **N/A** **N/A** **N/A**
| | X64 |em64du| |em64ru| |em64nu|
| | IA32 FULL **N/A** **N/A** **N/A**
| | X64 FULL |em64fdu| |em64fru| |em64fnu|
OvmfPkg_Ubuntu_GCC_ | IA32 |op32du| |op32ru| |op32nu|
| | X64 |op64du| |op64ru| |op64nu|
============================= ================= ============= ============= ==============
|TCBZ_2639|_ - EmulatorPkg Ubuntu GCC5 Segfaults during execution.
`More ArmVirtPkg CI Build Information <ArmVirtPkg/PlatformCI/ReadMe.md>`__
`More EmulatorPkg CI Build Information <EmulatorPkg/PlatformCI/ReadMe.md>`__
`More OvmfPkg CI Build Information <OvmfPkg/PlatformCI/ReadMe.md>`__
License Details
---------------
The majority of the content in the EDK II open source project uses a
`BSD-2-Clause Plus Patent License <License.txt>`__. The EDK II open
source project contains the following components that are covered by additional
licenses:
- `BaseTools/Plugin/CodeQL/analyze <https://www.apache.org/licenses/LICENSE-2.0>`__
- `BaseTools/Source/C/LzmaCompress <BaseTools/Source/C/LzmaCompress/LZMA-SDK-README.txt>`__
- `BaseTools/Source/C/VfrCompile/Pccts <BaseTools/Source/C/VfrCompile/Pccts/RIGHTS>`__
- `CryptoPkg\Library\BaseCryptLib\SysCall\inet_pton.c <CryptoPkg\Library\BaseCryptLib\SysCall\inet_pton.c>`__
- `CryptoPkg\Library\Include\crypto\dso_conf.h <https://github.com/openssl/openssl/blob/e2e09d9fba1187f8d6aafaa34d4172f56f1ffb72/LICENSE>`__
- `CryptoPkg\Library\Include\openssl\opensslconf.h <https://github.com/openssl/openssl/blob/e2e09d9fba1187f8d6aafaa34d4172f56f1ffb72/LICENSE>`__
- `MdeModulePkg/Library/LzmaCustomDecompressLib <MdeModulePkg/Library/LzmaCustomDecompressLib/LZMA-SDK-README.txt>`__
- `OvmfPkg <OvmfPkg/License.txt>`__
The EDK II open source project uses content from upstream projects as git submodules
that are covered by additional licenses.
- `BaseTools/Source/C/BrotliCompress/brotli <https://github.com/google/brotli/blob/666c3280cc11dc433c303d79a83d4ffbdd12cc8d/LICENSE>`__
- `CryptoPkg/Library/OpensslLib/openssl <https://github.com/openssl/openssl/blob/e2e09d9fba1187f8d6aafaa34d4172f56f1ffb72/LICENSE>`__
- `CryptoPkg/Library/MbedTlsLib/mbedtls <https://github.com/Mbed-TLS/mbedtls/blob/8c89224991adff88d53cd380f42a2baa36f91454/LICENSE>`__
- `MdeModulePkg/Library/BrotliCustomDecompressLib/brotli <https://github.com/google/brotli/blob/666c3280cc11dc433c303d79a83d4ffbdd12cc8d/LICENSE>`__
- `MdeModulePkg/Universal/RegularExpressionDxe/oniguruma <https://github.com/kkos/oniguruma/blob/abfc8ff81df4067f309032467785e06975678f0d/COPYING>`__
- `UnitTestFrameworkPkg/Library/CmockaLib/cmocka <https://github.com/tianocore/edk2-cmocka/blob/f5e2cd77c88d9f792562888d2b70c5a396bfbf7a/COPYING>`__
- `UnitTestFrameworkPkg/Library/GoogleTestLib/googletest <https://github.com/google/googletest/blob/86add13493e5c881d7e4ba77fb91c1f57752b3a4/LICENSE>`__
- `UnitTestFrameworkPkg/Library/SubhookLib/subhook <https://github.com/tianocore/edk2-subhook/blob/83d4e1ebef3588fae48b69a7352cc21801cb70bc/LICENSE.txt>`__
- `RedfishPkg/Library/JsonLib/jansson <https://github.com/akheron/jansson/blob/2882ead5bb90cf12a01b07b2c2361e24960fae02/LICENSE>`__
- `MdePkg/Library/BaseFdtLib/libfdt <https://github.com/devicetree-org/pylibfdt/blob/f39368a217496d32c4091a2dba4045b60649e3a5/BSD-2-Clause>`__
- `MdePkg/Library/MipiSysTLib/mipisyst <https://github.com/MIPI-Alliance/public-mipi-sys-t/blob/aae857d0d05ac65152ed24992a4acd834a0a107c/LICENSE>`__
- `SecurityPkg/DeviceSecurity/SpdmLib/libspdm <https://github.com/DMTF/libspdm/blob/main/LICENSE.md>`__
- `TcgTpmPkg/Library/TpmLib/TPM <https://github.com/TrustedComputingGroup/TPM/blob/main/LICENSE>`__
The EDK II Project is composed of packages. The maintainers for each package
are listed in `Maintainers.txt <Maintainers.txt>`__.
Resources
---------
- `TianoCore <http://www.tianocore.org>`__
- `EDK
II <https://www.tianocore.org/tianocore-wiki.github.io>`__
- `Getting Started with EDK
II <https://www.tianocore.org/tianocore-wiki.github.io/development/tutorials-howto/getting_started_with_edk_ii.html>`__
- `Mailing
Lists <https://www.tianocore.org/tianocore-wiki.github.io/community/communications/mailing_lists.html>`__
- `How To
Contribute <https://www.tianocore.org/tianocore-wiki.github.io/development/contribution-guides/how_to_contribute.html>`__
- `Release
Planning <https://www.tianocore.org/tianocore-wiki.github.io/releases-history/planning-roadmaps/edk_ii_release_planning.html>`__
Code Contributions
------------------
To make a contribution to a TianoCore project, follow these steps.
#. Create a change description in the format specified below to
use in the source control commit log.
#. Your commit message must include your ``Signed-off-by`` signature
#. Submit your code to the TianoCore project using the process
that the project documents on its web page. If the process is
not documented, then submit the code on development email list
for the project.
#. It is preferred that contributions are submitted using the same
copyright license as the base project. When that is not possible,
then contributions using the following licenses can be accepted:
- Apache License, Version 2.0: https://opensource.org/license/apache-2-0/
- BSD (2-clause): https://opensource.org/license/BSD-2-Clause
- BSD (3-clause): https://opensource.org/license/BSD-3-Clause
- MIT: https://opensource.org/license/MIT
- Python-2.0: https://opensource.org/license/Python-2.0
- Zlib: https://opensource.org/license/Zlib
For documentation:
- FreeBSD Documentation License
https://www.freebsd.org/copyright/freebsd-doc-license.html
Contributions of code put into the public domain can also be accepted.
Contributions using other licenses might be accepted, but further
review will be required.
Developer Certificate of Origin
-------------------------------
Your change description should use the standard format for a
commit message, and must include your ``Signed-off-by`` signature.
In order to keep track of who did what, all patches contributed must
include a statement that to the best of the contributor's knowledge
they have the right to contribute it under the specified license.
The test for this is as specified in the `Developer's Certificate of
Origin (DCO) 1.1 <https://developercertificate.org/>`__. The contributor
certifies compliance by adding a line saying
Signed-off-by: Developer Name developer@example.org
where ``Developer Name`` is the contributor's real name, and the email
address is one the developer is reachable through at the time of
contributing.
::
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution wa
