[Wiki] Draft of documentation for Signed Capsule Feature

[Wiki] Draft of documentation for Signed Capsule Feature

[Kinney, Michael D]

Hello,

I have started a draft of Wiki pages that describe how to use
and verify the Signed Capsule feature from Jiewen Yao.

I have focused this first draft on the system firmware update 
use case for signed capsules.

https://github.com/mdkinney/edk2/wiki/Capsule-Based-Firmware-Update-and-Firmware-Recovery

https://github.com/mdkinney/edk2/wiki/Capsule-Based-System-Firmware-Update

Please review this content and provide feedback.

I will work on the remaining 3 signed capsule use cases while
the content for this fist use case is reviewed.

I plan to add this content to the edk2 Wiki once the reviews are
completed.

Thanks,

Mike

Re: [Wiki] Draft of documentation for Signed Capsule Feature

[Yao, Jiewen]

HI Mike
Thanks for drafting this WIKI page.

I have some minor suggestion on https://github.com/mdkinney/edk2/wiki/Capsule-Based-Firmware-Update-and-Firmware-Recovery

1) *[UEFI] OsIndicationsSupported and OsIndications UEFI Variables
==> Current EDKII signed capsule solution does not support capsule on disk feature or OsIndications. Can we remove this line or say "it is not supported in current version" to avoid confusing?

2) *[PI] Recovery Block I/O PPI
==> I think Recovery Block I/O 2 PPI should also be included.

Thank you
Yao Jiewen

> -----Original Message-----
> From: Kinney, Michael D
> Sent: Wednesday, November 9, 2016 1:54 AM
> To: edk2-devel@lists.01.org; Kinney, Michael D
> <michael.d.kinney@intel.com>; Yao, Jiewen <jiewen.yao@intel.com>
> Subject: [Wiki] Draft of documentation for Signed Capsule Feature
> 
> Hello,
> 
> I have started a draft of Wiki pages that describe how to use
> and verify the Signed Capsule feature from Jiewen Yao.
> 
> I have focused this first draft on the system firmware update
> use case for signed capsules.
> 
> https://github.com/mdkinney/edk2/wiki/Capsule-Based-Firmware-Update-a
> nd-Firmware-Recovery
> 
> https://github.com/mdkinney/edk2/wiki/Capsule-Based-System-Firmware-U
> pdate
> 
> Please review this content and provide feedback.
> 
> I will work on the remaining 3 signed capsule use cases while
> the content for this fist use case is reviewed.
> 
> I plan to add this content to the edk2 Wiki once the reviews are
> completed.
> 
> Thanks,
> 
> Mike
> 

Re: [Wiki] Draft of documentation for Signed Capsule Feature

[Kinney, Michael D]

Jiewen,

Thanks for the feedback.  I think you are saying that the support for the 
EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED is not implemented.
Right?

In MdeModulePkg/Application/CapsuleApp, I see the following 2 unused #defines:

  #define EFI_CAPSULE_FROM_FILE_DIR                           L"\\EFI\\UpdateCapsule\\"
  #define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED  0x0000000000000004

Should these be removed?

I have updated the Wiki.

Mike

> -----Original Message-----
> From: Yao, Jiewen
> Sent: Tuesday, November 8, 2016 8:57 PM
> To: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-devel@lists.01.org
> Cc: Yao, Jiewen <jiewen.yao@intel.com>
> Subject: RE: [Wiki] Draft of documentation for Signed Capsule Feature
> 
> HI Mike
> Thanks for drafting this WIKI page.
> 
> I have some minor suggestion on https://github.com/mdkinney/edk2/wiki/Capsule-
> Based-Firmware-Update-and-Firmware-Recovery
> 
> 1) *[UEFI] OsIndicationsSupported and OsIndications UEFI Variables
> ==> Current EDKII signed capsule solution does not support capsule on disk
> feature or OsIndications. Can we remove this line or say "it is not supported in
> current version" to avoid confusing?
> 
> 2) *[PI] Recovery Block I/O PPI
> ==> I think Recovery Block I/O 2 PPI should also be included.
> 
> Thank you
> Yao Jiewen
> 
> > -----Original Message-----
> > From: Kinney, Michael D
> > Sent: Wednesday, November 9, 2016 1:54 AM
> > To: edk2-devel@lists.01.org; Kinney, Michael D
> > <michael.d.kinney@intel.com>; Yao, Jiewen <jiewen.yao@intel.com>
> > Subject: [Wiki] Draft of documentation for Signed Capsule Feature
> >
> > Hello,
> >
> > I have started a draft of Wiki pages that describe how to use
> > and verify the Signed Capsule feature from Jiewen Yao.
> >
> > I have focused this first draft on the system firmware update
> > use case for signed capsules.
> >
> > https://github.com/mdkinney/edk2/wiki/Capsule-Based-Firmware-Update-a
> > nd-Firmware-Recovery
> >
> > https://github.com/mdkinney/edk2/wiki/Capsule-Based-System-Firmware-U
> > pdate
> >
> > Please review this content and provide feedback.
> >
> > I will work on the remaining 3 signed capsule use cases while
> > the content for this fist use case is reviewed.
> >
> > I plan to add this content to the edk2 Wiki once the reviews are
> > completed.
> >
> > Thanks,
> >
> > Mike
> >

Re: [Wiki] Draft of documentation for Signed Capsule Feature

[Yao, Jiewen]

Ah, Mike. You are right.

I will remove them. Good catch.

From: Kinney, Michael D
Sent: Thursday, November 10, 2016 2:42 AM
To: Yao, Jiewen <jiewen.yao@intel.com>; edk2-devel@lists.01.org; Kinney, Michael D <michael.d.kinney@intel.com>
Subject: RE: [Wiki] Draft of documentation for Signed Capsule Feature

Jiewen,

Thanks for the feedback.  I think you are saying that the support for the
EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED is not implemented.
Right?

In MdeModulePkg/Application/CapsuleApp, I see the following 2 unused #defines:

  #define EFI_CAPSULE_FROM_FILE_DIR                           L"\\EFI\\UpdateCapsule\\<file:///\\EFI\UpdateCapsule\>"
  #define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED  0x0000000000000004

Should these be removed?

I have updated the Wiki.

Mike

> -----Original Message-----
> From: Yao, Jiewen
> Sent: Tuesday, November 8, 2016 8:57 PM
> To: Kinney, Michael D <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>
> Cc: Yao, Jiewen <jiewen.yao@intel.com<mailto:jiewen.yao@intel.com>>
> Subject: RE: [Wiki] Draft of documentation for Signed Capsule Feature
>
> HI Mike
> Thanks for drafting this WIKI page.
>
> I have some minor suggestion on https://github.com/mdkinney/edk2/wiki/Capsule-
> Based-Firmware-Update-and-Firmware-Recovery
>
> 1) *[UEFI] OsIndicationsSupported and OsIndications UEFI Variables
> ==> Current EDKII signed capsule solution does not support capsule on disk
> feature or OsIndications. Can we remove this line or say "it is not supported in
> current version" to avoid confusing?
>
> 2) *[PI] Recovery Block I/O PPI
> ==> I think Recovery Block I/O 2 PPI should also be included.
>
> Thank you
> Yao Jiewen
>
> > -----Original Message-----
> > From: Kinney, Michael D
> > Sent: Wednesday, November 9, 2016 1:54 AM
> > To: edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>; Kinney, Michael D
> > <michael.d.kinney@intel.com<mailto:michael.d.kinney@intel.com>>; Yao, Jiewen <jiewen.yao@intel.com<mailto:jiewen.yao@intel.com>>
> > Subject: [Wiki] Draft of documentation for Signed Capsule Feature
> >
> > Hello,
> >
> > I have started a draft of Wiki pages that describe how to use
> > and verify the Signed Capsule feature from Jiewen Yao.
> >
> > I have focused this first draft on the system firmware update
> > use case for signed capsules.
> >
> > https://github.com/mdkinney/edk2/wiki/Capsule-Based-Firmware-Update-a
> > nd-Firmware-Recovery
> >
> > https://github.com/mdkinney/edk2/wiki/Capsule-Based-System-Firmware-U
> > pdate
> >
> > Please review this content and provide feedback.
> >
> > I will work on the remaining 3 signed capsule use cases while
> > the content for this fist use case is reviewed.
> >
> > I plan to add this content to the edk2 Wiki once the reviews are
> > completed.
> >
> > Thanks,
> >
> > Mike
> >