[PATCH v1 0/7] Extend Last Attempt Status Usage

[PATCH v1 0/7] Extend Last Attempt Status Usage

[Michael Kubacki]

From: Michael Kubacki <michael.kubacki@microsoft.com>

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=2802

This patch series adds more granularity to Last Attempt Status
codes reported during FMP check image and set image operations
that greatly improve precision of the status codes.

The vendor range (0x1000 - 0x4000) was introduced in UEFI
Specification 2.8. That range is used within this patch series
to define three subranges:
  1. FMP driver codes
  2. FMP dependency related codes
  3. FMP device library codes

Most of the vendor range remains allocated to vendor device
library codes. There might be a preference to move some of
these codes explicitly to the UEFI Specification or other
ranges in the Last Attempt Status space. That is left open
to feedback to the series.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Guomin Jiang <guomin.jiang@intel.com>
Cc: Wei6 Xu <wei6.xu@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>

Michael Kubacki (7):
  FmpDevicePkg/SystemResourceTable.h: Add vendor range values
  FmpDevicePkg: Add LastAttemptStatus.h
  FmpDevicePkg/FmpDxe: Add check image path Last Attempt Status
    capability
  FmpDevicePkg/FmpDxe: Improve set image path Last Attempt Status
    granularity
  FmpDevicePkg/LastAttemptStatus.h: Add dependency range codes
  FmpDevicePkg: Add Last Attempt Status support to dependency libs
  FmpDevicePkg/FmpDeviceLib: Add Last Attempt Status to Check/Set API

 FmpDevicePkg/FmpDxe/FmpDxe.c                                                     | 180 +++++++++++++++++---
 FmpDevicePkg/Library/FmpDependencyCheckLib/FmpDependencyCheckLib.c               |  38 +++--
 FmpDevicePkg/Library/FmpDependencyCheckLibNull/FmpDependencyCheckLibNull.c       |   9 +-
 FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c                         |  95 +++++++++--
 FmpDevicePkg/Library/FmpDeviceLibNull/FmpDeviceLib.c                             |  42 +++--
 FmpDevicePkg/Test/UnitTest/Library/FmpDependencyLib/EvaluateDependencyUnitTest.c |   7 +-
 FmpDevicePkg/FmpDxe/FmpDxe.h                                                     |   1 +
 FmpDevicePkg/Include/LastAttemptStatus.h                                         |  81 +++++++++
 FmpDevicePkg/Include/Library/FmpDependencyCheckLib.h                             |   8 +-
 FmpDevicePkg/Include/Library/FmpDependencyLib.h                                  |  44 +++--
 FmpDevicePkg/Include/Library/FmpDeviceLib.h                                      |  44 +++--
 MdePkg/Include/Guid/SystemResourceTable.h                                        |   4 +
 12 files changed, 461 insertions(+), 92 deletions(-)
 create mode 100644 FmpDevicePkg/Include/LastAttemptStatus.h

-- 
2.28.0.windows.1

Re: [PATCH v1 0/7] Extend Last Attempt Status Usage

[Michael D Kinney]

Hi Michael,

I see multiple patches in this series that modify LasAttempStatus.h.

Would it make more sense to add this include file with all the
values in one patch, and then the subsequent patches use the
new values?

Also, should LastAttemptStatus.h start out as a PrivateInclude
since it is only used by components in the FmpDevicePkg?

Thanks,

Mike

> -----Original Message-----
> From: michael.kubacki@outlook.com <michael.kubacki@outlook.com>
> Sent: Friday, August 7, 2020 12:15 AM
> To: devel@edk2.groups.io
> Cc: Gao, Liming <liming.gao@intel.com>; Kinney, Michael D <michael.d.kinney@intel.com>; Jiang, Guomin
> <guomin.jiang@intel.com>; Xu, Wei6 <wei6.xu@intel.com>
> Subject: [PATCH v1 0/7] Extend Last Attempt Status Usage
> 
> From: Michael Kubacki <michael.kubacki@microsoft.com>
> 
> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=2802
> 
> This patch series adds more granularity to Last Attempt Status
> codes reported during FMP check image and set image operations
> that greatly improve precision of the status codes.
> 
> The vendor range (0x1000 - 0x4000) was introduced in UEFI
> Specification 2.8. That range is used within this patch series
> to define three subranges:
>   1. FMP driver codes
>   2. FMP dependency related codes
>   3. FMP device library codes
> 
> Most of the vendor range remains allocated to vendor device
> library codes. There might be a preference to move some of
> these codes explicitly to the UEFI Specification or other
> ranges in the Last Attempt Status space. That is left open
> to feedback to the series.
> 
> Cc: Liming Gao <liming.gao@intel.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Guomin Jiang <guomin.jiang@intel.com>
> Cc: Wei6 Xu <wei6.xu@intel.com>
> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> 
> Michael Kubacki (7):
>   FmpDevicePkg/SystemResourceTable.h: Add vendor range values
>   FmpDevicePkg: Add LastAttemptStatus.h
>   FmpDevicePkg/FmpDxe: Add check image path Last Attempt Status
>     capability
>   FmpDevicePkg/FmpDxe: Improve set image path Last Attempt Status
>     granularity
>   FmpDevicePkg/LastAttemptStatus.h: Add dependency range codes
>   FmpDevicePkg: Add Last Attempt Status support to dependency libs
>   FmpDevicePkg/FmpDeviceLib: Add Last Attempt Status to Check/Set API
> 
>  FmpDevicePkg/FmpDxe/FmpDxe.c                                                     | 180 +++++++++++++++++---
>  FmpDevicePkg/Library/FmpDependencyCheckLib/FmpDependencyCheckLib.c               |  38 +++--
>  FmpDevicePkg/Library/FmpDependencyCheckLibNull/FmpDependencyCheckLibNull.c       |   9 +-
>  FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c                         |  95 +++++++++--
>  FmpDevicePkg/Library/FmpDeviceLibNull/FmpDeviceLib.c                             |  42 +++--
>  FmpDevicePkg/Test/UnitTest/Library/FmpDependencyLib/EvaluateDependencyUnitTest.c |   7 +-
>  FmpDevicePkg/FmpDxe/FmpDxe.h                                                     |   1 +
>  FmpDevicePkg/Include/LastAttemptStatus.h                                         |  81 +++++++++
>  FmpDevicePkg/Include/Library/FmpDependencyCheckLib.h                             |   8 +-
>  FmpDevicePkg/Include/Library/FmpDependencyLib.h                                  |  44 +++--
>  FmpDevicePkg/Include/Library/FmpDeviceLib.h                                      |  44 +++--
>  MdePkg/Include/Guid/SystemResourceTable.h                                        |   4 +
>  12 files changed, 461 insertions(+), 92 deletions(-)
>  create mode 100644 FmpDevicePkg/Include/LastAttemptStatus.h
> 
> --
> 2.28.0.windows.1

Re: [PATCH v1 0/7] Extend Last Attempt Status Usage

[Michael Kubacki]

Hi Mike,

I considered just adding LastAttemptStatus.h in its final state in patch 
2/7 but I wanted to better connect its contents to C file usage across 
the review (and commits that leverage those status codes). I'd be happy 
to move the contents in final form to patch 2 though if that's preferred.

I agree that the file is more appropriate in a PrivateInclude and I'll 
make that change in v2.

Thanks,
Michael

On 8/7/2020 9:56 AM, Kinney, Michael D wrote:
> Hi Michael,
> 
> I see multiple patches in this series that modify LasAttempStatus.h.
> 
> Would it make more sense to add this include file with all the
> values in one patch, and then the subsequent patches use the
> new values?
> 
> Also, should LastAttemptStatus.h start out as a PrivateInclude
> since it is only used by components in the FmpDevicePkg?
> 
> Thanks,
> 
> Mike
> 
>> -----Original Message-----
>> From: michael.kubacki@outlook.com <michael.kubacki@outlook.com>
>> Sent: Friday, August 7, 2020 12:15 AM
>> To: devel@edk2.groups.io
>> Cc: Gao, Liming <liming.gao@intel.com>; Kinney, Michael D <michael.d.kinney@intel.com>; Jiang, Guomin
>> <guomin.jiang@intel.com>; Xu, Wei6 <wei6.xu@intel.com>
>> Subject: [PATCH v1 0/7] Extend Last Attempt Status Usage
>>
>> From: Michael Kubacki <michael.kubacki@microsoft.com>
>>
>> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=2802
>>
>> This patch series adds more granularity to Last Attempt Status
>> codes reported during FMP check image and set image operations
>> that greatly improve precision of the status codes.
>>
>> The vendor range (0x1000 - 0x4000) was introduced in UEFI
>> Specification 2.8. That range is used within this patch series
>> to define three subranges:
>>    1. FMP driver codes
>>    2. FMP dependency related codes
>>    3. FMP device library codes
>>
>> Most of the vendor range remains allocated to vendor device
>> library codes. There might be a preference to move some of
>> these codes explicitly to the UEFI Specification or other
>> ranges in the Last Attempt Status space. That is left open
>> to feedback to the series.
>>
>> Cc: Liming Gao <liming.gao@intel.com>
>> Cc: Michael D Kinney <michael.d.kinney@intel.com>
>> Cc: Guomin Jiang <guomin.jiang@intel.com>
>> Cc: Wei6 Xu <wei6.xu@intel.com>
>> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
>>
>> Michael Kubacki (7):
>>    FmpDevicePkg/SystemResourceTable.h: Add vendor range values
>>    FmpDevicePkg: Add LastAttemptStatus.h
>>    FmpDevicePkg/FmpDxe: Add check image path Last Attempt Status
>>      capability
>>    FmpDevicePkg/FmpDxe: Improve set image path Last Attempt Status
>>      granularity
>>    FmpDevicePkg/LastAttemptStatus.h: Add dependency range codes
>>    FmpDevicePkg: Add Last Attempt Status support to dependency libs
>>    FmpDevicePkg/FmpDeviceLib: Add Last Attempt Status to Check/Set API
>>
>>   FmpDevicePkg/FmpDxe/FmpDxe.c                                                     | 180 +++++++++++++++++---
>>   FmpDevicePkg/Library/FmpDependencyCheckLib/FmpDependencyCheckLib.c               |  38 +++--
>>   FmpDevicePkg/Library/FmpDependencyCheckLibNull/FmpDependencyCheckLibNull.c       |   9 +-
>>   FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c                         |  95 +++++++++--
>>   FmpDevicePkg/Library/FmpDeviceLibNull/FmpDeviceLib.c                             |  42 +++--
>>   FmpDevicePkg/Test/UnitTest/Library/FmpDependencyLib/EvaluateDependencyUnitTest.c |   7 +-
>>   FmpDevicePkg/FmpDxe/FmpDxe.h                                                     |   1 +
>>   FmpDevicePkg/Include/LastAttemptStatus.h                                         |  81 +++++++++
>>   FmpDevicePkg/Include/Library/FmpDependencyCheckLib.h                             |   8 +-
>>   FmpDevicePkg/Include/Library/FmpDependencyLib.h                                  |  44 +++--
>>   FmpDevicePkg/Include/Library/FmpDeviceLib.h                                      |  44 +++--
>>   MdePkg/Include/Guid/SystemResourceTable.h                                        |   4 +
>>   12 files changed, 461 insertions(+), 92 deletions(-)
>>   create mode 100644 FmpDevicePkg/Include/LastAttemptStatus.h
>>
>> --
>> 2.28.0.windows.1
> 

Re: [PATCH v1 0/7] Extend Last Attempt Status Usage

[Michael D Kinney]

Hi Michael,

I would prefer to see all the new status codes in patch 2.

I also just noticed that Patch #1 has an incorrect subject line.  It
should be MdePkg instead of FmpDevicePkg.

Thanks,

Mike

> -----Original Message-----
> From: Michael Kubacki <michael.kubacki@outlook.com>
> Sent: Friday, August 7, 2020 11:14 AM
> To: Kinney, Michael D <michael.d.kinney@intel.com>; devel@edk2.groups.io
> Cc: Gao, Liming <liming.gao@intel.com>; Jiang, Guomin <guomin.jiang@intel.com>; Xu, Wei6 <wei6.xu@intel.com>
> Subject: Re: [PATCH v1 0/7] Extend Last Attempt Status Usage
> 
> Hi Mike,
> 
> I considered just adding LastAttemptStatus.h in its final state in patch
> 2/7 but I wanted to better connect its contents to C file usage across
> the review (and commits that leverage those status codes). I'd be happy
> to move the contents in final form to patch 2 though if that's preferred.
> 
> I agree that the file is more appropriate in a PrivateInclude and I'll
> make that change in v2.
> 
> Thanks,
> Michael
> 
> On 8/7/2020 9:56 AM, Kinney, Michael D wrote:
> > Hi Michael,
> >
> > I see multiple patches in this series that modify LasAttempStatus.h.
> >
> > Would it make more sense to add this include file with all the
> > values in one patch, and then the subsequent patches use the
> > new values?
> >
> > Also, should LastAttemptStatus.h start out as a PrivateInclude
> > since it is only used by components in the FmpDevicePkg?
> >
> > Thanks,
> >
> > Mike
> >
> >> -----Original Message-----
> >> From: michael.kubacki@outlook.com <michael.kubacki@outlook.com>
> >> Sent: Friday, August 7, 2020 12:15 AM
> >> To: devel@edk2.groups.io
> >> Cc: Gao, Liming <liming.gao@intel.com>; Kinney, Michael D <michael.d.kinney@intel.com>; Jiang, Guomin
> >> <guomin.jiang@intel.com>; Xu, Wei6 <wei6.xu@intel.com>
> >> Subject: [PATCH v1 0/7] Extend Last Attempt Status Usage
> >>
> >> From: Michael Kubacki <michael.kubacki@microsoft.com>
> >>
> >> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=2802
> >>
> >> This patch series adds more granularity to Last Attempt Status
> >> codes reported during FMP check image and set image operations
> >> that greatly improve precision of the status codes.
> >>
> >> The vendor range (0x1000 - 0x4000) was introduced in UEFI
> >> Specification 2.8. That range is used within this patch series
> >> to define three subranges:
> >>    1. FMP driver codes
> >>    2. FMP dependency related codes
> >>    3. FMP device library codes
> >>
> >> Most of the vendor range remains allocated to vendor device
> >> library codes. There might be a preference to move some of
> >> these codes explicitly to the UEFI Specification or other
> >> ranges in the Last Attempt Status space. That is left open
> >> to feedback to the series.
> >>
> >> Cc: Liming Gao <liming.gao@intel.com>
> >> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> >> Cc: Guomin Jiang <guomin.jiang@intel.com>
> >> Cc: Wei6 Xu <wei6.xu@intel.com>
> >> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> >>
> >> Michael Kubacki (7):
> >>    FmpDevicePkg/SystemResourceTable.h: Add vendor range values
> >>    FmpDevicePkg: Add LastAttemptStatus.h
> >>    FmpDevicePkg/FmpDxe: Add check image path Last Attempt Status
> >>      capability
> >>    FmpDevicePkg/FmpDxe: Improve set image path Last Attempt Status
> >>      granularity
> >>    FmpDevicePkg/LastAttemptStatus.h: Add dependency range codes
> >>    FmpDevicePkg: Add Last Attempt Status support to dependency libs
> >>    FmpDevicePkg/FmpDeviceLib: Add Last Attempt Status to Check/Set API
> >>
> >>   FmpDevicePkg/FmpDxe/FmpDxe.c                                                     | 180 +++++++++++++++++---
> >>   FmpDevicePkg/Library/FmpDependencyCheckLib/FmpDependencyCheckLib.c               |  38 +++--
> >>   FmpDevicePkg/Library/FmpDependencyCheckLibNull/FmpDependencyCheckLibNull.c       |   9 +-
> >>   FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c                         |  95 +++++++++--
> >>   FmpDevicePkg/Library/FmpDeviceLibNull/FmpDeviceLib.c                             |  42 +++--
> >>   FmpDevicePkg/Test/UnitTest/Library/FmpDependencyLib/EvaluateDependencyUnitTest.c |   7 +-
> >>   FmpDevicePkg/FmpDxe/FmpDxe.h                                                     |   1 +
> >>   FmpDevicePkg/Include/LastAttemptStatus.h                                         |  81 +++++++++
> >>   FmpDevicePkg/Include/Library/FmpDependencyCheckLib.h                             |   8 +-
> >>   FmpDevicePkg/Include/Library/FmpDependencyLib.h                                  |  44 +++--
> >>   FmpDevicePkg/Include/Library/FmpDeviceLib.h                                      |  44 +++--
> >>   MdePkg/Include/Guid/SystemResourceTable.h                                        |   4 +
> >>   12 files changed, 461 insertions(+), 92 deletions(-)
> >>   create mode 100644 FmpDevicePkg/Include/LastAttemptStatus.h
> >>
> >> --
> >> 2.28.0.windows.1
> >