path: root/PrmPkg/Samples/Readme.md

# **Platform Runtime Mechanism Sample Modules**

The PRM module samples provided here serve as focused examples of how to perform various tasks in a PRM module. The
samples can also be used to verify the basic infrastructure needed in your firmware implementation is working as
expected by checking that the sample modules are found properly and the handlers perform their tasks as noted.

## **IMPORTANT NOTE**
> The sample modules have currently only been tested on the Visual Studio compiler tool chain. Sample module
build may fail on other tool chains. A future work item is to enable broader build support.

## How to Build PRM Sample Modules
The sample modules are built as part of the normal `PrmPkg` build so you can follow the
[package build instructions](../../Readme.md#how-to-build-prmpkg) and then find the PRM sample binaries in your
workspace build output directory. For example, if your build workspace is called "edk2" and you build
64-bit binaries on the Visual Studio 2017 tool chain, your sample module binaries will be in the following
location: \
``edk2/Build/Prm/DEBUG_VS2017/X64/PrmPkg/Samples``

### Build an Individual PRM Sample Module
Note that the build command does provide the option to build a specific module in a package which can result in
faster build time. If you would like to just build a single PRM module that can be done by specifying the path to
the module INF file with the "-m" argument to `build`. For example, this command builds 32-bit and 64-bit binaries
with Visual Studio 2019: \
``build -p PrmPkg/PrmPkg.dsc -m PrmPkg/Samples/PrmSamplePrintModule/PrmSamplePrintModule.inf -a IA32 -a X64 -t VS2019``

## PRM Sample Module User's Guide

The following table provides an overview of each sample module provided. By nature, different PRM handlers have
different requirements. The information here is summarized for a user to understand how to use a given sample
PRM handler along with GUID/name information to identify the sample PRM modules and their PRM handlers.

It is recommended that all PRM authors write a similar set of documentation for their users to better understand
and interact with their PRM modules.

---
### Module: PRM Sample Print Module
>* Name: `PrmSamplePrintModule`
>* GUID: `1652b3c2-a7a1-46ac-af93-dd6dee446669`
> * Purpose:
>   * Simplest PRM module example
>   * Example of a PRM module with multiple PRM handlers

**Handlers:**
#### Handler: PRM Handler 1
* Name: `PrmHandler1`
* GUID: `d5f2ad5f-a347-4d3e-87bc-c2ce63029cc8`
* Actions:
  * Use an OS-provided function pointer (pointer at the beginning of the parameter buffer) to write the message
    “PRM1 handler sample message!”

* Parameter Buffer Required: Yes
* Parameter Buffer Contents:
  ```c
  typedef struct {

    PRM_OS_SERVICE_DEBUG_PRINT *

  } SAMPLE_OSDEBUGPRINT_PARAMETER_BUFFER;
  ```

* Context Buffer Required: No

* Runtime MMIO Range(s) Required: No

#### Handler: PRM Handler 2
* Name: `PrmHandler2`
* GUID: `a9e7adc3-8cd0-429a-8915-10946ebde318`
* Actions:
  * Use an OS-provided function pointer (pointer at the beginning of the parameter buffer) to write the message
    “PRM2 handler sample message!”

* Parameter Buffer Required: Yes
* Parameter Buffer Contents:
  ```c
  typedef struct {

    PRM_OS_SERVICE_DEBUG_PRINT *

  } SAMPLE_OSDEBUGPRINT_PARAMETER_BUFFER;
  ```

* Context Buffer Required: No

* Runtime MMIO Range(s) Required: No

#### Handler: PRM Handler N
* Name: `PrmHandlerN`
* GUID: `b688c214-4081-4eeb-8d26-1eb5a3bcf11a`
* Actions:
  * Use an OS-provided function pointer (pointer at the beginning of the parameter buffer) to write the message
    “PRMN handler sample message!”

* Parameter Buffer Required: Yes
* Parameter Buffer Contents:
  ```c
  typedef struct {

    PRM_OS_SERVICE_DEBUG_PRINT *

  } SAMPLE_OSDEBUGPRINT_PARAMETER_BUFFER;
  ```

* Context Buffer Required: No

* Runtime MMIO Range(s) Required: No

### Module: PRM Sample ACPI Parameter Buffer
>* Name: `PrmSampleAcpiParameterBufferModule`
>* GUID: `dc2a58a6-5927-4776-b995-d118a27335a2`
> * Purpose:
>   * Provides an example of how to configure an ACPI parameter buffer

**Handlers:**
#### Handler: Check Parameter Buffer PRM Handler
* Name: `CheckParamBufferPrmHandler`
* GUID: `2e4f2d13-6240-4ed0-a401-c723fbdc34e8`
* Actions:
  * Checks for the data signature ‘T’, ‘E’, ‘S’, ‘T’ (DWORD) at the beginning of the parameter buffer.

* Parameter Buffer Required: Yes
* Parameter Buffer Contents:
  * A data signature of ['T', 'E', 'S', 'T'] (DWORD) at the beginning of the buffer.

* Context Buffer Required: No

* Runtime MMIO Range(s) Required: No

### Module: PRM Sample Context Buffer
>* Name: `PrmSampleContextBufferModule`
>* GUID: `5a6cf42b-8bb4-472c-a233-5c4dc4033dc7`
> * Purpose:
>   * Provides an example of how to configure a static data buffer (which is pointed to in a context buffer) in
      firmware and consume the buffer contents at runtime

**Handlers:**
#### Handler: Check Static Data Buffer PRM Handler
* Name: `CheckStaticDataBufferPrmHandler`
* GUID: `e1466081-7562-430f-896b-b0e523dc335a`
* Actions:
  * Checks that the context buffer signature and static data buffer signature match in the context buffer provided.

* Parameter Buffer Required: No

* Context Buffer Required: Yes
  * Static Data Buffer Contents:
  ```c
  #define   SOME_VALUE_ARRAY_MAX_VALUES   16

  typedef struct {
    BOOLEAN       Policy1Enabled;
    BOOLEAN       Policy2Enabled;
    UINT8         SomeValueArray[SOME_VALUE_ARRAY_MAX_VALUES];
  } STATIC_DATA_SAMPLE_CONTEXT_BUFFER_MODULE;
  ```

* Runtime MMIO Range(s) Required: No

### Module: PRM Sample Hardware Access Buffer
>* Name: `PrmSampleHardwareAccessModule`
>* GUID: `0ef93ed7-14ae-425b-928f-b85a6213b57e`
> * Purpose:
>   * Demonstrate access of several types of hardware resources from a PRM module

**Handlers:**
#### Handler: MSR Access Microcode Signature PRM Handler
* Name: `MsrAccessMicrocodeSignaturePrmHandler`
* GUID: `2120cd3c-848b-4d8f-abbb-4b74ce64ac89`
* Actions:
  * Access the loaded microcode signature at MSR 0x8B.

* Parameter Buffer Required: No

* Context Buffer Required: No

* Runtime MMIO Range(s) Required: No

#### Handler: MSR Access MTRR Dump PRM Handler
* Name: `MsrAccessMtrrDumpPrmHandler`
* GUID: `ea0935a7-506b-4159-bbbb-48deeecb6f58`
* Actions:
  * Access the fixed and variable MTRR values using MSRs.

* Parameter Buffer Required: No

* Context Buffer Required: No

* Runtime MMIO Range(s) Required: No

#### Handler: HPET MMIO Access PRM Handler
* Name: `MmioAccessHpetPrmHandler`
* GUID: `1bd1bda9-909a-4614-9699-25ec0c2783f7`
* Actions:
  * Access some HPET registers using MMIO at 0xFED00000.

* Parameter Buffer Required: No

* Context Buffer Required: No

* Runtime MMIO Range(s) Required: Yes
  * Physical Base Address: 0xFED00000
  * Length: 0x1000

#### Handler: MSR Print Microcode Signature PRM Handler
* Name: `MsrPrintMicrocodeSignaturePrmHandler`
* GUID: `5d28b4e7-3867-4aee-aa09-51fc282c3b22`
* Actions:
  * Use the provided print function to print the loaded microcode signature at MSR 0x8B.

* Parameter Buffer Required: Yes
* Parameter Buffer Contents:
  ```c
  typedef struct {

    PRM_OS_SERVICE_DEBUG_PRINT *

  } SAMPLE_OSDEBUGPRINT_PARAMETER_BUFFER;
  ```

* Context Buffer Required: No

* Runtime MMIO Range(s) Required: No

#### Handler: MSR Print MTRR Dump PRM Handler
* Name: `MsrPrintMtrrDumpPrmHandler`
* GUID: `4b64b702-4d2b-4dfe-ac5a-0b4110a2ca47`
* Actions:
  * Use the provided print function to print the fixed and variable MTRR values using MSRs.

* Parameter Buffer Required: Yes
* Parameter Buffer Contents:
  ```c
  typedef struct {

    PRM_OS_SERVICE_DEBUG_PRINT *

  } SAMPLE_OSDEBUGPRINT_PARAMETER_BUFFER;
  ```

* Context Buffer Required: No

* Runtime MMIO Range(s) Required: No

#### Handler: HPET MMIO Print PRM Handler
* Name: `MmioPrintHpetPrmHandler`
* GUID: `8a0efdde-78d0-45f0-aea0-c28245c7e1db`
* Actions:
  * Use the provided print function to print some HPET registers using MMIO at 0xFED00000.

* Parameter Buffer Required: Yes
* Parameter Buffer Contents:
  ```c
  typedef struct {

    PRM_OS_SERVICE_DEBUG_PRINT *

  } SAMPLE_OSDEBUGPRINT_PARAMETER_BUFFER;
  ```

* Context Buffer Required: No

* Runtime MMIO Range(s) Required: Yes
  * Physical Base Address: 0xFED00000
  * Length: 0x1000