Re: [PATCH] OvmfPkg: use StatusCode Router and Handler from MdeModulePkg

[Laszlo Ersek <lersek@redhat.com>]

On 08/02/16 03:13, Laszlo Ersek wrote:

> (1) So, here's what I would like to see in the commit message:
> 
> ----------
> 
> In the Platform Init v1.4a spec,
> - Volume 1 "4.7 Status Code Service" defines the
>   EFI_PEI_REPORT_STATUS_CODE.ReportStatusCode() service,

sorry, the above is a typo, I meant EFI_PEI_SERVICES.ReportStatusCode().


> - Volume 1 "6.3.5 Status Code PPI (Optional)" defines the
>   EFI_PEI_PROGRESS_CODE_PPI (equivalent to the above),
> - Volume 2 "14.2 Status Code Runtime Protocol" defines the
>   EFI_STATUS_CODE_PROTOCOL.
> 
> These allow PEIMs and DXE (and later) modules to report status codes.
> 
> Currently OvmfPkg uses modules from under
> "IntelFrameworkModulePkg/Universal/StatusCode/", which produce the above
> abstractions (PPI and PROTOCOL) directly, and write the status codes, as
> they are reported, to the serial port or to a memory buffer. This is
> called "handling" the status codes.
> 
> In the Platform Init v1.4a spec,
> - Volume 3 "7.2.2 Report Status Code Handler PPI" defines
>   EFI_PEI_RSC_HANDLER_PPI,
> - Volume 3 "7.2.1 Report Status Code Handler Protocol" defines
>   EFI_RSC_HANDLER_PROTOCOL.
> 
> These allow PEIMs and runtime DXE drivers to register several callbacks
> for status code handling.

The woring here would also be better if we said "These allow several
PEIMs and runtime DXE drivers to register callbacks for status code
handling". In other words, "several" should refer to the drivers, not
the callbacks.

> 
> MdeModulePkg offers a PEIM under
> "MdeModulePkg/Universal/ReportStatusCodeRouter/Pei" that procudes both
> EFI_PEI_PROGRESS_CODE_PPI and EFI_PEI_RSC_HANDLER_PPI, and a runtime DXE
> driver under "MdeModulePkg/Universal/ReportStatusCodeRouter/RuntimeDxe"
> that produces both EFI_STATUS_CODE_PROTOCOL and EFI_RSC_HANDLER_PROTOCOL.
> 
> MdeModulePkg also offers status code handler modules under
> MdeModulePkg/Universal/StatusCodeHandler/ that depend on
> EFI_PEI_RSC_HANDLER_PPI and EFI_RSC_HANDLER_PROTOCOL, respectively.
> 
> The StatusCodeHandler modules register themselves with
> ReportStatusCodeRouter through EFI_PEI_RSC_HANDLER_PPI /
> EFI_RSC_HANDLER_PROTOCOL. When another module reports a status code
> through EFI_PEI_PROGRESS_CODE_PPI / EFI_STATUS_CODE_PROTOCOL, it reaches
> phase-matching ReportStatusCodeRouter module first, which in turn passes

"it reaches [the] phase-matching" -- the definite article missing.

Sorry about these typos, it was very late last night when I wrote the email.

Thanks!
Laszlo

> the status code to the pre-registered, phase-matching StatusCodeHandler
> module.
> 
> The status code handling in the StatusCodeHandler modules is identical
> to the one currently provided by the IntelFrameworkModulePkg modules.
> Replace the IntelFareworkModulePkg modules with the MdeModulePkg ones,
> so we can decrease our dependency on IntelFareworkModulePkg.
> 
> ----------