PrmPkg/Readme.md

   1 # **Platform Runtime Mechanism**
   2
   3 Platform Runtime Mechanism (PRM) introduces the capability of moving platform-specific code out of SMM and into a
   4 code module that executes within the OS context. Moving this firmware to the OS context provides better transparency
   5 and mitigates the negative system impact currently accompanied with SMM solutions. Futhermore, the PRM code is
   6 packaged into modules with well-defined entry points, each representing a specific PRM functionality.
   7
   8 The `PrmPkg` maintained in this branch provides a single cohesive set of generic PRM functionality that is intended
   9 to be leveraged by platform firmware with minimal overhead to integrate PRM functionality in the firmware.
  10
  11 ## **IMPORTANT NOTE**
  12 > The code provided in this package and branch are for proof-of-concept purposes only. The code does not represent a
  13 formal design and is not validated at product quality. The development of this feature is shared in the edk2-staging
  14 branch to simplify collaboration by allowing direct code contributions and early feedback throughout its development.
  15
  16 ## How to Build PrmPkg
  17 As noted earlier, resources in `PrmPkg` are intended to be referenced by a platform firmware so it can adopt support
  18 for PRM. In that case, the platform firmware should add the `PrmConfigDxe` and `PrmLoaderDxe` drivers to its DSC and
  19 FDF files so they are built in the platform firmware build and dispatched during its runtime. All that is left is to
  20 add individual PRM modules to the DSC and FDF. These can be built from source or included as binaries into the platform
  21 firmware flash map.
  22
  23 ### PrmPkg Standalone Build
  24 **All changes to `PrmPkg` must not regress the standalone package build**. Any time a change is made to `PrmPkg`, the
  25 package build must be tested. Since this is a forward looking package, to ease potential integration into the edk2
  26 project in the future, the build is tested against the tip of the master branch in the [edk2](https://github.com/tianocore/edk2)
  27 repository.
  28
  29 To build `PrmPkg` as a standalone package:
  30 1. If new to EDK II, follow the directions in [Getting Started with EDK II](https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-with-EDK-II)
  31
  32 2. Clone the *master* branch on the edk2 repository locally \
  33    ``git clone https://github.com/tianocore/edk2.git``
  34
  35 3. Clone the *PlatformRuntimeMechanism* branch on the edk2-staging repository locally \
  36    ``git clone -b PlatformRuntimeMechanism --single-branch https://github.com/tianocore/edk2-staging.git``
  37    > __*Note*__: The *--single-branch* argument is recommended since edk2-staging hosts many branches for completely
  38    unrelated features. If you are just interested in PRM, this will avoid fetching all of the other branches.
  39
  40 4. Change to the edk2 workspace directory \
  41    ``cd edk2``
  42
  43 5. Run *edksetup* to set local environment variables needed for build
  44    * Windows:
  45      * ``edksetup.bat``
  46    * Linux:
  47      * If you have not already built BaseTools:
  48        * ``make -C BaseTools``
  49      * ``. edksetup.sh``
  50
  51 6. Set the PACKAGES_PATH environment variable to include the directory path that contains `PrmPkg`
  52    * Windows example:
  53      *  ``set PACKAGES_PATH=c:\src\edk2-staging``
  54
  55 7. Change to the edk2-staging workspace directory
  56    * Example: ``cd ../edk2-staging``
  57
  58 8. Build PrmPkg \
  59    ``build -p PrmPkg/PrmPkg.dsc -a IA32 -a X64``
  60    > __*Note*__: Due to the way PRM modules are compiled with exports, **only building on Visual Studio compiler tool
  61    chains is currently supported**.
  62
  63 ### Build Flags
  64 As PRM is a new feature at a proof-of-concept (POC) level of maturity, there's some changes to the normal build
  65 available as build flags. By default, if no flags are specified, the build is done with the currently expected plan of
  66 record (POR) configuration.
  67
  68 The following list are the currently defined build flags (if any) that may be passed to the `build` command
  69 (e.g. -D FLAG=VALUE).
  70
  71 * NONE - No build flags are currently used.
  72
  73    Additional detail: The context buffer structure is defined in [PrmContextBuffer.h](PrmPkg/Include/PrmContextBuffer.h).
  74    This structure is passed as the context buffer to PRM handlers. The structure actually passed to PRM handlers is
  75    allocated and populated by the OS where it gets all the information to populate the context buffer from other structures.
  76
  77 ### PRM Platform GUID
  78 **IMPORTANT**
  79
  80 A configuration item that requires user attention is the PRM platform GUID. Each platform that uses PRM must be
  81 uniquely identifiable so that various instances of a PRM module can target the correct platform in PRM module updates.
  82
  83 To apply a unique platform GUID set the following PCD to a unique value in your platform DSC file.
  84   ``gPrmPkgTokenSpaceGuid.PcdPrmPlatformGuid``
  85
  86 The default value assigned in [PrmPkg.dec](PrmPkg/PrmPkg.dec) is zero. By design, this is an invalid value that will
  87 cause an ASSERT if it is not updated.
  88
  89 ## Overview
  90 At a high-level, PRM can be viewed from three levels of granularity:
  91
  92 1. PRM interface - Encompassing the entirety of firmware functionalities and data provided to OS runtime. Most
  93    information is provided through ACPI tables to be agnostic to a UEFI implementation.
  94 2. PRM module - An independently updatable package of PRM handlers. The PRM interface will be composed of multiple
  95    PRM modules. This requirement allows for the separation of OEM and IHV PRM code, each of which can be serviced
  96    independently.
  97 3. PRM handler - The implementation/callback of a single PRM functionality as identified by a GUID.
  98
  99 ## Firmware Design
 100 The firmware has three key generic drivers to support PRM:
 101
 102 1. A PRM Loader driver - Functionality is split across three phases:
 103    1. Discover - Find all PRM modules in the firmware image made available by the platform firmware author.
 104       * This phase includes verifying authenticity/integrity of the image, the image executable type, the export
 105         table is present and the PRM Export Module Descriptor is present and valid.
 106    2. Process - Convert PRM handler GUID to name mappings in the PRM Module Export Descriptor to PRM handler Name
 107       to physical address mappings required to construct the PRM ACPI table.
 108    3. Publish - Publish the PRM ACPI table using the information from the Process phase.
 109
 110 2. A PRM Configuration driver - A generic driver responsible for processing PRM module configuration information
 111    consumed through a `PRM_CONFIG_PROTOCOL` per PRM module instance. Therefore, the `PRM_CONFIG_PROTOCOL` serves
 112    as the dynamic interface for this driver to process PRM module resources and prepare the module's data to be
 113    configured properly for OS runtime.
 114
 115 3. A PRM Module - Not a single driver but a user written PE/COFF image that follows the PRM module authoring process.
 116    A PRM module groups together cohesive sets of PRM functionality into functions referred to as "PRM handlers".
 117
 118 ## PrmPkg Code Organization
 119 The package follows a standard EDK II style package format. The list below contains some notable areas to
 120 explore in the package:
 121
 122 * [ACPI Table Definitions](PrmPkg/PrmLoaderDxe/PrmAcpiTable.h)
 123 * [Common Interface Definitions](PrmPkg/Include)
 124 * [PRM Config Driver](PrmPkg/PrmConfigDxe)
 125 * [PRM Loader Driver](PrmPkg/PrmLoaderDxe)
 126 * [Sample PRM Modules](PrmPkg/Samples)
 127
 128 While the package does provide sample PRM modules to be used as a reference, actual PRM modules should not be
 129 maintained in PrmPkg. It is intended to only contain PRM infrastructure code and a few samples of how to use
 130 that infrastructure. The PrmPkg is meant to be used as-is by firmware that supports PRM. Any shortcomings that
 131 prevent the package from being used as-is should be addressed directly in PrmPkg.
 132
 133 ## PRM Information UEFI Application
 134 A UEFI application is provided in this package called "PrmInfo" that allows a user to display and test PRM
 135 modules on their system.
 136
 137 [Link to application source code](PrmPkg/Application/PrmInfo).
 138
 139 This application is intended to be helpful during PRM enabling by allowing the user to:
 140   1. Confirm that their firmware port of the PRM infrastructure implemented in this package is functioning correctly.
 141   2. Quickly get information about what PRM modules and handlers that are present on a given system.
 142   3. Quickly test PRM handlers without booting into a full operating system.
 143   4. Develop and exercise PRM handlers prior to the availability of an operating system that is PRM aware.
 144
 145 Execute the application help command for detailed usage instructions and examples of how to use the application: \
 146   ``PrmInfo -?``
 147
 148 *Example Usage:*
 149
 150 ![](PrmPkg/Application/PrmInfo/PrmInfo_Usage_Example.gif)
 151
 152 ## PRM Module
 153
 154 > __*Note*__: You can find simple examples of PRM modules in the Samples directory of this package.
 155 > [Samples/Readme.md](PrmPkg/Samples/Readme.md) has more information.
 156
 157 By default, the EDK II implementation of UEFI does not allow images with the subsystem type
 158 IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER to be built with exports.
 159
 160 ```
 161 ERROR - Linker #1294 from LINK : fatal exports and import libraries are not supported with /SUBSYSTEM:EFI_RUNTIME_DRIVER
 162 ```
 163 This can adjusted in the MSVC linker options.
 164
 165 __For the purposes of this POC__, the subsystem type is changed in the firmware build to allow the export table to be
 166 added but the subsystem type in the final image is still 0xC (EFI Runtime Driver). This is important to allow the DXE
 167 dispatcher to use its standard image verification and loading algorithms to load the image into permanent memory during
 168 the DXE execution phase.
 169
 170 All firmware-loaded PRM modules are loaded into a memory buffer of type EfiRuntimeServicesCode. This means the
 171 operating system must preserve all PRM handler code and the buffer will be reflected in the UEFI memory map. The
 172 execution for invoking PRM handlers is the same as that required for UEFI Runtime Services, notably 4KiB or more of
 173 available stack space must be provided and the stack must be 16-byte aligned.
 174
 175 __*Note:*__ Long term it is possible to similarly load the modules into a EfiRuntimeServicesCode buffer and perform
 176 relocation fixups with a new EFI module type for PRM if desired. It was simply not done since it is not essential
 177 for this POC.
 178
 179 Where possible, PRM module information is stored and generated using industry compiler tool chains. This is a key
 180 motivation behind using PE/COFF export tables to expose PRM module information and using a single PRM module binary
 181 definition consistent between firmware and OS load.
 182
 183 ### PRM Module Exports
 184 A PRM module must contain at least two exports: A PRM Module Export Descriptor and at least one PRM handler. Here's
 185 an example of an export table from a PRM module that has a single PRM handler:
 186
 187 ```
 188   0000000000005000: 00 00 00 00 FF FF FF FF 00 00 00 00 3C 50 00 00  ............<P..
 189   0000000000005010: 01 00 00 00 02 00 00 00 02 00 00 00 28 50 00 00  ............(P..
 190   0000000000005020: 30 50 00 00 38 50 00 00 78 13 00 00 20 40 00 00  0P..8P..x... @..
 191   0000000000005030: 5D 50 00 00 7C 50 00 00 00 00 01 00 50 72 6D 53  ]P..|P......PrmS
 192   0000000000005040: 61 6D 70 6C 65 43 6F 6E 74 65 78 74 42 75 66 66  ampleContextBuff
 193   0000000000005050: 65 72 4D 6F 64 75 6C 65 2E 64 6C 6C 00 44 75 6D  erModule.dll.Dum
 194   0000000000005060: 70 53 74 61 74 69 63 44 61 74 61 42 75 66 66 65  pStaticDataBuffe
 195   0000000000005070: 72 50 72 6D 48 61 6E 64 6C 65 72 00 50 72 6D 4D  rPrmHandler.PrmM
 196   0000000000005080: 6F 64 75 6C 65 45 78 70 6F 72 74 44 65 73 63 72  oduleExportDescr
 197   0000000000005090: 69 70 74 6F 72 00                                iptor.
 198
 199     00000000 characteristics
 200     FFFFFFFF time date stamp
 201         0.00 version
 202            1 ordinal base
 203            2 number of functions
 204            2 number of names
 205
 206     ordinal hint RVA      name
 207
 208           1    0 00001378 DumpStaticDataBufferPrmHandler
 209           2    1 00004020 PrmModuleExportDescriptor
 210
 211 ```
 212 ### PRM Image Format
 213 PRM modules are ultimately PE/COFF images. However, when packaged in firmware the PE/COFF image is placed into a
 214 Firmware File System (FFS) file. This is transparent to the operating system but done to better align with the typical
 215 packaging of PE32(+) images managed in the firmware binary image. In the dump of the PRM FV binary image shown earlier,
 216 the FFS sections placed by EDK II build tools ("DXE dependency", "User interface", "Version") that reside alongside the
 217 PE/COFF binary are shown. A PRM module can be placed into a firmware image as a pre-built PE/COFF binary or built
 218 during the firmware build process. In either case, the PE/COFF section is contained in a FFS file as shown in that
 219 image.
 220
 221 ### PRM Module Implementation
 222 To simplify building the PRM Module Export Descriptor, a PRM module implementation can use the following macros to mark
 223 functions as PRM handlers. In this example, a PRM module registers three functions by name as PRM handlers with the
 224 associated GUIDs.
 225
 226 ```
 227 //
 228 // Register the PRM export information for this PRM Module
 229 //
 230 PRM_MODULE_EXPORT (
 231   PRM_HANDLER_EXPORT_ENTRY (PRM_HANDLER_1_GUID, PrmHandler1),
 232   PRM_HANDLER_EXPORT_ENTRY (PRM_HANDLER_2_GUID, PrmHandler2),
 233   PRM_HANDLER_EXPORT_ENTRY (PRM_HANDLER_N_GUID, PrmHandlerN)
 234   );
 235 ```
 236
 237 `PRM_MODULE_EXPORT` take a variable-length argument list of `PRM_HANDLER_EXPORT_ENTRY` entries that each describe an
 238 individual PRM handler being exported for the module. Ultimately, this information is used to define the structure
 239 necessary to statically allocate the PRM Module Export Descriptor Structure (and its PRM Handler Export Descriptor
 240 substructures) in the image.
 241
 242 Another required export for PRM modules is automatically provided in `PrmModule.h`, a header file that pulls together
 243 all the includes needed to author a PRM module. This export is `PRM_MODULE_UPDATE_LOCK_EXPORT`. By including,
 244 `PrmModule.h`, a PRM module has the `PRM_MODULE_UPDATE_LOCK_DESCRIPTOR` automatically exported.
 245
 246 ## PRM Handler Constraints
 247 At this time, PRM handlers are restricted to a maximum identifier length of 128 characters. This is checked when using
 248 the `PRM_HANDLER_EXPORT` macro by using a static assert that reports a violation at build-time.
 249
 250 PRM handlers are **not** allowed to use UEFI Runtime Services and should not rely upon any UEFI constructs. For the
 251 purposes of this POC, this is currently not explicitly enforced but should be in the final changes.