-----Original Message-----
From: Chang, Abner (HPS SW/FW Technologist) <abner.chang@...>
Sent: Wednesday, September 23, 2020 11:18 AM
To: rfc@edk2.groups.io; Yao, Jiewen <jiewen.yao@...>;
devel@edk2.groups.io; bret.barkelew@...
Cc: Wang, Nickle (HPS SW) <nickle.wang@...>; Chen, Aaron
<aaron.chen@...>; Fu, Siyuan <siyuan.fu@...>; Wang, Fan
<fan.wang@...>; Wu, Jiaxin <jiaxin.wu@...>; Ni, Ray
<ray.ni@...>; Kinney, Michael D <michael.d.kinney@...>
Subject: RE: [edk2-rfc] [edk2-devel] [RFC] Request for the new package
"RedfishPkg" under edk2 repo

-----Original Message-----
From: rfc@edk2.groups.io [mailto:rfc@edk2.groups.io] On Behalf Of Yao,
Jiewen
Sent: Wednesday, September 23, 2020 10:30 AM
To: devel@edk2.groups.io; Chang, Abner (HPS SW/FW Technologist)
<abner.chang@...>; rfc@edk2.groups.io;
bret.barkelew@...
Cc: Wang, Nickle (HPS SW) <nickle.wang@...>; Chen, Aaron
<aaron.chen@...>; Fu, Siyuan <siyuan.fu@...>; Wang, Fan
<fan.wang@...>; Wu, Jiaxin <jiaxin.wu@...>; Ni, Ray
<ray.ni@...>; Kinney, Michael D <michael.d.kinney@...>
Subject: Re: [edk2-rfc] [edk2-devel] [RFC] Request for the new package
"RedfishPkg" under edk2 repo

Thank you, Abner.
I look forward to the design review in next week. :-)

I notice that the last RedfishPkg update is still 2 years ago.

In order to move staging to master, we need ensure the code meet
production quality, including but not limited to unit test, system test and
security test.

I checked the readme. It mentioned:
===============
Promote to edk2 Trunk
If a subset feature or a bug fix in this staging branch could meet below
requirement, it could be promoted to edk2 trunk and removed from this
staging branch:

Meet all edk2 required quality criteria.
Support both IA32 and X64 Platform.
Work on Redfish Profile Simulator.
Ready for product integration.
===============

Would you please give us an update if there is any extra work to improved
the quality (such as security test) so that we believe the existing RedfishPkg
is production ready for integration back to EDKII master?

We don't have the additional work regards to the security. As the design, any
BIOS to Redfish communicate should be done before End of DXE and with
SecureBoot is enabled.
Yeah, it is welcome to raise any security issues to make a secured edk2 Redfish
solution.
Thanks

Thank you
Yao Jiewen

-----Original Message-----
From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Abner
Chang
Sent: Wednesday, September 23, 2020 10:21 AM
To: rfc@edk2.groups.io; Yao, Jiewen <jiewen.yao@...>;
devel@edk2.groups.io; bret.barkelew@...
Cc: Wang, Nickle (HPS SW) <nickle.wang@...>; Chen, Aaron
<aaron.chen@...>; Fu, Siyuan <siyuan.fu@...>; Wang, Fan
<fan.wang@...>; Wu, Jiaxin <jiaxin.wu@...>; Ni, Ray
<ray.ni@...>; Kinney, Michael D <michael.d.kinney@...>
Subject: Re: [edk2-rfc] [edk2-devel] [RFC] Request for the new package
"RedfishPkg" under edk2 repo

That would take time to run through the process of publishing this
tool (make it as public) on DMTF. I just created the reference of
source code which generated by tool on my personal GitHub (not the
tool itself) https://github.com/changab/Redfish-JSON-C-Struct-Converter-

Lib .

The branch "Master" which are the source code to convert Redfish JSON
schemas to C code. These source code could be built by CMakeLists.txt
(under
src/_build) across platforms.
The branch " edk2-driver-wrapper" are generated by tool with some

"edk2"

options. The edk2 wrapper drivers
(/RedfishCsIntp/RedfishSchemaInterpreter ) are selected (our plan)
into edk2 build process on demand, refer to
https://github.com/tianocore/edk2-staging/tree/UEFI_Redfish#%5B1%5D
Edk2 driver ((/RedfishCsIntp/RedfishSchemaInterpreter) registers
itself to EFI REST JSON Structure Protocol. The upper level users use
EFI REST JSON Structure Protocol to generate Redfish JSON payload from
the C structure or vice versa from JSON to C. Thus upper level user
can use C structure member to refer to the Redfish property with

manipulating JSON objects.

BTW, the naming of RedfishSchemaInterpreter is not sync-up with the
latest UEFI spec and the source code is not generated based on latest

Redfish schema.

This also gives the reference to Bret regards to the answer I had in
the previous email.

No, EFI REST JSON Structure DXE Driver (UEF spec section 29.7.3) is
a centralized manager to manage "EFI Redfish JSON resource to C
structure Converter libraries/drivers" for converting Redfish
resource in the specific schema from JSON format to the C structure or

vice versa.

EFI REST JSON Structure DXE Driver itself doesn't use JSON library,
however "EFI Redfish JSON resource to C structure Converter
libraries/drivers" do use open source jansson library to parse JSON

payload.

"EFI Redfish JSON resource to C structure Converter libraries/drivers"
in above refers to auto-generated source code.

We plan to present this on next week TianoCore design meeting.

-----Original Message-----
From: rfc@edk2.groups.io [mailto:rfc@edk2.groups.io] On Behalf Of
Yao, Jiewen
Sent: Tuesday, September 15, 2020 1:44 PM
To: Chang, Abner (HPS SW/FW Technologist) <abner.chang@...>;
devel@edk2.groups.io; rfc@edk2.groups.io
Cc: Wang, Nickle (HPS SW) <nickle.wang@...>; Chen, Aaron
<aaron.chen@...>; Fu, Siyuan <siyuan.fu@...>; Wang, Fan
<fan.wang@...>; Wu, Jiaxin <jiaxin.wu@...>; Ni, Ray
<ray.ni@...>; Kinney, Michael D <michael.d.kinney@...>
Subject: Re: [edk2-rfc] [edk2-devel] [RFC] Request for the new
package "RedfishPkg" under edk2 repo

Thanks Abner.
Understood now. Yes, we need follow the regulation as always.

I look forward to seeing the DMTF public repo. :-)

Thank you
Yao Jiewen

From: Chang, Abner (HPS SW/FW Technologist)

<abner.chang@...>

Sent: Tuesday, September 15, 2020 1:39 PM
To: devel@edk2.groups.io; Yao, Jiewen <jiewen.yao@...>;
rfc@edk2.groups.io
Cc: Wang, Nickle (HPS SW) <nickle.wang@...>; Chen, Aaron
<aaron.chen@...>; Fu, Siyuan <siyuan.fu@...>; Wang, Fan
<fan.wang@...>; Wu, Jiaxin <jiaxin.wu@...>; Ni, Ray
<ray.ni@...>; Kinney, Michael D <michael.d.kinney@...>
Subject: RE: [edk2-rfc] [edk2-devel] [RFC] Request for the new
package "RedfishPkg" under edk2 repo

Sure Jiewen, we plan to talk about this on Tianocore design meeting

recently.

But I may not provide the reference here because it may against to
the Redfish working group regulations.
I had requested to public this repo two years ago, however both WG
chair and I had no follow up on this. I already restarted the conversation

with him...

just now.

For now, only the implementation of UEFI spec 29.7.2 (Redfish
instance),
29.7.3 and 31.1 will be sent to community for review.

Thanks
Abner


From: devel@edk2.groups.io<mailto:devel@edk2.groups.io>
[mailto:devel@edk2.groups.io] On Behalf Of Yao, Jiewen
Sent: Tuesday, September 15, 2020 12:42 PM
To: devel@edk2.groups.io<mailto:devel@edk2.groups.io>; Chang, Abner
(HPS SW/FW Technologist)
<abner.chang@...<mailto:abner.chang@...>>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)
<nickle.wang@...<mailto:nickle.wang@...>>; Chen, Aaron
<aaron.chen@...<mailto:aaron.chen@...>>; Fu, Siyuan
<siyuan.fu@...<mailto:siyuan.fu@...>>; Wang, Fan
<fan.wang@...<mailto:fan.wang@...>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...>>; Ni, Ray
<ray.ni@...<mailto:ray.ni@...>>; Kinney, Michael D
<michael.d.kinney@...<mailto:michael.d.kinney@...>>
Subject: Re: [edk2-rfc] [edk2-devel] [RFC] Request for the new
package "RedfishPkg" under edk2 repo

HI Abner
If it is DMTF private repo, should we discuss it in EDKII ?

Do we have a public reference somewhere else?

Thank you
Yao Jiewen

From: devel@edk2.groups.io<mailto:devel@edk2.groups.io>
<devel@edk2.groups.io<mailto:devel@edk2.groups.io>> On Behalf Of
Abner Chang
Sent: Tuesday, September 15, 2020 12:23 PM
To: rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>;
devel@edk2.groups.io<mailto:devel@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)
<nickle.wang@...<mailto:nickle.wang@...>>; Chen, Aaron
<aaron.chen@...<mailto:aaron.chen@...>>; Fu, Siyuan
<siyuan.fu@...<mailto:siyuan.fu@...>>; Wang, Fan
<fan.wang@...<mailto:fan.wang@...>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...>>; Ni, Ray
<ray.ni@...<mailto:ray.ni@...>>; Kinney, Michael D
<michael.d.kinney@...<mailto:michael.d.kinney@...>>
Subject: Re: [edk2-rfc] [edk2-devel] [RFC] Request for the new
package "RedfishPkg" under edk2 repo

Hmm. You probably have to join dmtf as a member. That repo is
private for members now, not public yet.


Get Outlook for
Android<INVALID URI REMOVED

3A__aka.ms_ghei36&d=DwMFAg&c=C5b8zRQO1miGmBeVZ2LFWg&r=_SN6

FZBN4Vgi4Ulkskz6qU3NYRO03nHp9P7Z5q59A3E&m=pOqEHDFgI3N3KX0vXeQ

x5x9eAu8iFwKLxaC_oogVwiE&s=JcIdGRVs2CdvN2AKuofiuNTu3UV6lDvgB4Rj

vpRgiXM&e=>
________________________________
From: rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
<rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>> on behalf of Bret
Barkelew via groups.io

<bret.barkelew@...<mailto:bret.barkelew=microsoft.

com@groups.io>>
Sent: Tuesday, September 15, 2020 12:19:29 PM
To: Chang, Abner (HPS SW/FW Technologist)
<abner.chang@...<mailto:abner.chang@...>>;
devel@edk2.groups.io<mailto:devel@edk2.groups.io>
<devel@edk2.groups.io<mailto:devel@edk2.groups.io>>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
<rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>>
Cc: Wang, Nickle (HPS SW)
<nickle.wang@...<mailto:nickle.wang@...>>; Chen, Aaron
<aaron.chen@...<mailto:aaron.chen@...>>;
siyuan.fu@...<mailto:siyuan.fu@...>
<siyuan.fu@...<mailto:siyuan.fu@...>>; Wang, Fan
<fan.wang@...<mailto:fan.wang@...>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...>>; Ni, Ray
<ray.ni@...<mailto:ray.ni@...>>; Kinney, Michael D
<michael.d.kinney@...<mailto:michael.d.kinney@...>>
Subject: Re: [edk2-rfc] [edk2-devel] [RFC] Request for the new
package "RedfishPkg" under edk2 repo

That link didn't work for me.

- Bret

From: Chang, Abner (HPS SW/FW
Technologist)<mailto:abner.chang@...>
Sent: Monday, September 14, 2020 8:59 PM
To:

devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...

r oups.io%3cmailto:devel@edk2.groups.io>>; Bret
Barkelew<mailto:Bret.Barkelew@...>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)<mailto:nickle.wang@...>; Chen,
Aaron<mailto:aaron.chen@...>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang,
Fan<mailto:fan.wang@...>; Wu,
Jiaxin<mailto:jiaxin.wu@...>;
Ni, Ray<mailto:ray.ni@...>; Kinney, Michael
D<mailto:michael.d.kinney@...>
Subject: [EXTERNAL] RE: [edk2-devel] [RFC] Request for the new
package "RedfishPkg" under edk2 repo

No, EFI REST JSON Structure DXE Driver (UEF spec section 29.7.3) is
a centralized manager to manage "EFI Redfish JSON resource to C
structure Converter libraries/drivers" for converting Redfish
resource in the specific schema from JSON format to the C structure or

vice versa.

EFI REST JSON Structure DXE Driver itself doesn't use JSON library,
however "EFI Redfish JSON resource to C structure Converter
libraries/drivers" do use open source jansson library to parse JSON
payload. Furthermore, "EFI Redfish JSON resource to C structure
Converter libraries/drivers" are generated by tool based on the published

Redfish schemas.

https://github.com/DMTF/Redfish-Schema-C-Struct-
Generator<INVALID URI REMOVED
3A__nam06.safelinks.protection.outlook.com_-3Furl-3Dhttps-253A-252F-
252Fgithub.com-252FDMTF-252FRedfish-2DSchema-2DC-2DStruct-
2DGenerator-26data-3D02-257C01-257Cbret.barkelew-

2540microsoft.com-

257C1b8115973f364cea229008d8592bc486-
257C72f988bf86f141af91ab2d7cd011db47-257C1-257C0-
257C637357391811797643-26sdata-
3DLdHAPly4oeVhyC6Xk7p0G0r1y8qVxrLfGZrN9EW5WpE-253D-

26reserved-

3D0&d=DwIF-

g&c=C5b8zRQO1miGmBeVZ2LFWg&r=_SN6FZBN4Vgi4Ulkskz6qU3NYRO03nH

p9P7Z5q59A3E&m=goBsQ2eLlP7qVkOJAy8TPlQ0B6NFvNm4rP58u6ASQxc&s=

j2rR7JmY2HjCtfOOe9ChSWCNKYseOJX2T-
91Z3miShA&e=<https://github.com/DMTF/Redfish-Schema-C-Struct-
Generator%3chttps:/urldefense.proofpoint.com/v2/url?u=https-
3A__nam06.safelinks.protection.outlook.com_-3Furl-3Dhttps-253A-252F-
252Fgithub.com-252FDMTF-252FRedfish-2DSchema-2DC-2DStruct-
2DGenerator-26data-3D02-257C01-257Cbret.barkelew-

2540microsoft.com-

257C1b8115973f364cea229008d8592bc486-
257C72f988bf86f141af91ab2d7cd011db47-257C1-257C0-
257C637357391811797643-26sdata-
3DLdHAPly4oeVhyC6Xk7p0G0r1y8qVxrLfGZrN9EW5WpE-253D-

26reserved-

3D0&d=DwIF-

g&c=C5b8zRQO1miGmBeVZ2LFWg&r=_SN6FZBN4Vgi4Ulkskz6qU3NYRO03nH

p9P7Z5q59A3E&m=goBsQ2eLlP7qVkOJAy8TPlQ0B6NFvNm4rP58u6ASQxc&s=

j2rR7JmY2HjCtfOOe9ChSWCNKYseOJX2T-91Z3miShA&e=> >

From: devel@edk2.groups.io<mailto:devel@edk2.groups.io>
[mailto:devel@edk2.groups.io] On Behalf Of Bret Barkelew via
groups.io
Sent: Tuesday, September 15, 2020 11:41 AM
To: Chang, Abner (HPS SW/FW Technologist)
<abner.chang@...<mailto:abner.chang@...>>;
devel@edk2.groups.io<mailto:devel@edk2.groups.io>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)
<nickle.wang@...<mailto:nickle.wang@...>>; Chen, Aaron
<aaron.chen@...<mailto:aaron.chen@...>>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang, Fan
<fan.wang@...<mailto:fan.wang@...>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...>>; Ni, Ray
<ray.ni@...<mailto:ray.ni@...>>; Kinney, Michael D
<michael.d.kinney@...<mailto:michael.d.kinney@...>>
Subject: Re: [edk2-devel] [RFC] Request for the new package

"RedfishPkg"

under edk2 repo

JSON Structure would probably be worth discussing. I know that there
are other places I've seen JSON used and it may end up that we want
common business logic (similar to using Oniguruma for regex). Do you
parse/format JSON in that one?

- Bret

From: Chang, Abner (HPS SW/FW
Technologist)<mailto:abner.chang@...>
Sent: Monday, September 14, 2020 8:33 PM
To:

devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...

r oups.io%3cmailto:devel@edk2.groups.io>>; Bret
Barkelew<mailto:Bret.Barkelew@...>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)<mailto:nickle.wang@...>; Chen,
Aaron<mailto:aaron.chen@...>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang,
Fan<mailto:fan.wang@...>; Wu,
Jiaxin<mailto:jiaxin.wu@...>;
Ni, Ray<mailto:ray.ni@...>; Kinney, Michael
D<mailto:michael.d.kinney@...>
Subject: [EXTERNAL] RE: [edk2-devel] [RFC] Request for the new
package "RedfishPkg" under edk2 repo

Not many drivers fall in edk2 repo so far, those are drivers with
the corresponding definitions in UEFI spec.

* EFI REST EX UEFI Driver for Redfish service
* EFI Redfish Discover UEFI Driver
* EFI REST JSON Structure DXE Driver

All others have to go through code first policy, will be in edk2-staging repo.

-Abner

From:

devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...

r oups.io%3cmailto:devel@edk2.groups.io>>
[mailto:devel@edk2.groups.io] On Behalf Of Bret Barkelew via
groups.io
Sent: Tuesday, September 15, 2020 11:19 AM
To:

devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...

r oups.io%3cmailto:devel@edk2.groups.io>>; Chang, Abner (HPS SW/FW
Technologist)

<abner.chang@...<mailto:abner.chang@...<mailto:abner.chang

@hpe.com%3cmailto:abner.chang@...>>>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)

<nickle.wang@...<mailto:nickle.wang@...<mailto:nickle.wang

@hpe.com%3cmailto:nickle.wang@...>>>; Chen, Aaron

<aaron.chen@...<mailto:aaron.chen@...<mailto:aaron.chen@h

pe.com%3cmailto:aaron.chen@...>>>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang, Fan

<fan.wang@...<mailto:fan.wang@...<mailto:fan.wang@intel.

c om%3cmailto:fan.wang@...>>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...<mailto:jiaxin.wu@int
el.c om%3cmailto:jiaxin.wu@...>>>; Ni, Ray
<ray.ni@...<mailto:ray.ni@...<mailto:ray.ni@...%3c
mail to:ray.ni@...>>>; Kinney, Michael D

<michael.d.kinney@...<mailto:michael.d.kinney@...<mailto

:m ichael.d.kinney@...%3cmailto:michael.d.kinney@...>>>
Subject: Re: [edk2-devel] [RFC] Request for the new package

"RedfishPkg"

under edk2 repo

I think code review works. I'm primarily interested in seeing how
much code falls under the "edk2" vs "edk2-staging" repos.

- Bret

From: Abner Chang via
groups.io<mailto:abner.chang@...>
Sent: Monday, September 14, 2020 8:12 PM
To:

devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...

r oups.io%3cmailto:devel@edk2.groups.io>>; Chang, Abner (HPS SW/FW
Technologist)<mailto:abner.chang@...>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)<mailto:nickle.wang@...>; Chen,
Aaron<mailto:aaron.chen@...>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang,
Fan<mailto:fan.wang@...>; Wu,
Jiaxin<mailto:jiaxin.wu@...>;
Ni, Ray<mailto:ray.ni@...>; Kinney, Michael
D<mailto:michael.d.kinney@...>
Subject: [EXTERNAL] Re: [edk2-devel] [RFC] Request for the new
package "RedfishPkg" under edk2 repo

Seems no one has comment on this topic. Let's just go through the
code review process.
Thanks

Abner

From:

devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...

r oups.io%3cmailto:devel@edk2.groups.io>>
[mailto:devel@edk2.groups.io] On Behalf Of Abner Chang
Sent: Wednesday, September 9, 2020 11:02 AM
To:

devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...

r oups.io%3cmailto:devel@edk2.groups.io>>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)

<nickle.wang@...<mailto:nickle.wang@...<mailto:nickle.wang

@hpe.com%3cmailto:nickle.wang@...>>>; Chen, Aaron

<aaron.chen@...<mailto:aaron.chen@...<mailto:aaron.chen@h

pe.com%3cmailto:aaron.chen@...>>>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang, Fan

<fan.wang@...<mailto:fan.wang@...<mailto:fan.wang@intel.

c om%3cmailto:fan.wang@...>>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...<mailto:jiaxin.wu@int
el.c om%3cmailto:jiaxin.wu@...>>>; Ni, Ray
<ray.ni@...<mailto:ray.ni@...<mailto:ray.ni@...%3c
mail to:ray.ni@...>>>; Michael D Kinney

<michael.d.kinney@...<mailto:michael.d.kinney@...<mailto

:m ichael.d.kinney@...%3cmailto:michael.d.kinney@...>>>
Subject: Re: [edk2-devel] [RFC] Request for the new package

"RedfishPkg"

under edk2 repo

Add [RFC] to the subject, add Ray and Mike to the loop.

From: Chang, Abner (HPS SW/FW Technologist)
Sent: Tuesday, September 8, 2020 12:06 PM
To:

devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...

r oups.io%3cmailto:devel@edk2.groups.io>>; Chang, Abner (HPS SW/FW
Technologist)

<abner.chang@...<mailto:abner.chang@...<mailto:abner.chang

@hpe.com%3cmailto:abner.chang@...>>>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)

<nickle.wang@...<mailto:nickle.wang@...<mailto:nickle.wang

@hpe.com%3cmailto:nickle.wang@...>>>; Chen, Aaron

<aaron.chen@...<mailto:aaron.chen@...<mailto:aaron.chen@h

pe.com%3cmailto:aaron.chen@...>>>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang, Fan

<fan.wang@...<mailto:fan.wang@...<mailto:fan.wang@intel.

c om%3cmailto:fan.wang@...>>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...<mailto:jiaxin.wu@int
el.c
om%3cmailto:jiaxin.wu@...>>>
Subject: RE: Request for the new package "RedfishPkg" under edk2
repo

This is the RFC for the new package "RedfishPkg" introduced to edk2
repo, I thought mailing system will add [RFC] prefix to the subject.
Sorry for the inconvenience.

From:

devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...

r oups.io%3cmailto:devel@edk2.groups.io>>
[mailto:devel@edk2.groups.io] On Behalf Of Abner Chang
Sent: Tuesday, September 8, 2020 11:48 AM
To: rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)

<nickle.wang@...<mailto:nickle.wang@...<mailto:nickle.wang

@hpe.com%3cmailto:nickle.wang@...>>>; Chen, Aaron

<aaron.chen@...<mailto:aaron.chen@...<mailto:aaron.chen@h

pe.com%3cmailto:aaron.chen@...>>>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang, Fan

<fan.wang@...<mailto:fan.wang@...<mailto:fan.wang@intel.

c om%3cmailto:fan.wang@...>>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...<mailto:jiaxin.wu@int
el.c
om%3cmailto:jiaxin.wu@...>>>;

devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...

r oups.io%3cmailto:devel@edk2.groups.io>>
Subject: [edk2-devel] Request for the new package "RedfishPkg" under
edk2 repo

Hi everyone,
Given that we are going to contribute code of UEFI Redfish edk2
solution, a new package "RedfishPkg" under edk2 repo is necessary
for accommodating the UEFI Redfish driver stacks, that includes

* EFI Redfish Host Interface DXE Driver
* EFI Refish Credential DXE Driver
* EFI REST EX UEFI Driver for Redfish service
* EFI Redfish Discover UEFI Driver
* EFI Redfish Discover Protocol
* EFI Redfish Config UEFI Driver
* EFI BIOS Config To Redfish Dxe Driver
* EFI REST JSON Structure DXE Driver
* EFI Source Coding DXE Driver
* EFI BIOS Resource Provision Generation Protocol
* EFI BIOS Resource Provision Transport Layer Protocol

The architecture have been discussing in TianoCore Design meeting
and the corresponding BZ were created as well.
The code we will start to contribute includes

* Contribute to edk2 repo for those drivers already have the

corresponding

definitions in UEFI spec.
* Contribute code to edk2-staging/UEFI _Redfish for those drivers do

not

have the corresponding definitions in UEFI spec. This is for the
evaluation and require ECR to USWG if community agree with having
this driver for Redfish
edk2 solution.

Please refer to below link for the details,
https://github.com/tianocore/edk2-

staging/blob/UEFI_Redfish/Readme.md<https://urldefense.proofpoint.co

m
/v2/url?u=https-3A__nam06.safelinks.protection.outlook.com_-3Furl-
3Dhttps-253A-252F-252Furldefense.proofpoint.com-252Fv2-252Furl-

253Fu

-
253Dhttps-2D3A-5F-5Fnam06.safelinks.protection.outlook.com-5F-

2D3Fur

l-
2D3Dhttps-2D253A-2D252F-2D252Furldefense.proofpoint.com-2D252Fv2-
2D252Furl-2D253Fu-2D253Dhttps-2D2D3A-2D5F-
2D5Fnam06.safelinks.protection.outlook.com-2D5F-2D2D3Furl-

2D2D3Dhttp

s-
2D2D253A-2D2D252F-2D2D252Fgithub.com-2D2D252Ftianocore-
2D2D252Fedk2-2D2D2Dstaging-2D2D252Fblob-2D2D252FUEFI-
2D2D5FRedfish-2D2D252FReadme.md-2D2D26data-2D2D3D02-

2D2D257C01-

2D2D257Cbret.barkelew-2D2D2540microsoft.com-
2D2D257Cec6961ac4b3143f196be08d859251f68-
2D2D257C72f988bf86f141af91ab2d7cd011db47-2D2D257C1-2D2D257C0-
2D2D257C637357363278947284-2D2D26sdata-
2D2D3Dkt66JYtpN1X1hCrt5cQY3btyQEdoqZYkVPW5J7w8dws-2D2D253D-
2D2D26reserved-2D2D3D0-2D2526d-2D253DDwMF-2D2Dg-2D2526c-
2D253DC5b8zRQO1miGmBeVZ2LFWg-2D2526r-2D253D-
2D5FSN6FZBN4Vgi4Ulkskz6qU3NYRO03nHp9P7Z5q59A3E-2D2526m-
2D253DvNotrFyeoRyYey-2D2D0DOEVOLlZ7unqNGts5l1lH-2D2D4MzqM-
2D2526s-2D253DBO3e8WR8joHCC9lD6Guk5Q2XN8DJ0JCOTy2AfB279q8-
2D2526e-2D253D-2D26data-2D3D02-2D257C01-2D257Cbret.barkelew-
2D2540microsoft.com-2D257C6bd38bf379f64b06f6b808d859282266-
2D257C72f988bf86f141af91ab2d7cd011db47-2D257C1-2D257C0-
2D257C637357376203679617-2D26sdata-2D3D-
2D252Fc1YADqJZbAxtJEfc7R4LRToIVVG-2D252F8P5K9XRzp2RTio-2D253D-
2D26reserved-2D3D0-2526d-253DDwMF-2Dg-2526c-
253DC5b8zRQO1miGmBeVZ2LFWg-2526r-253D-
5FSN6FZBN4Vgi4Ulkskz6qU3NYRO03nHp9P7Z5q59A3E-2526m-
253DDkSlNNriVFNl3jnCeMG8vtCRlB3CgfREapKoapz-2Dcx0-2526s-
253DvXm2LZsMsTXRCNZ9IZvid63RGiDHFF5aL-5F2JBwiL7kg-2526e-253D-
26data-3D02-257C01-257Cbret.barkelew-2540microsoft.com-
257C1b8115973f364cea229008d8592bc486-
257C72f988bf86f141af91ab2d7cd011db47-257C1-257C0-
257C637357391811802634-26sdata-3Dr9JTbIGJH3tmabZ-
252BOtYAjVm5PRXWvuK0Wm2v2NByE1M-253D-26reserved-

3D0&d=DwIF-

g&c=C5b8zRQO1miGmBeVZ2LFWg&r=_SN6FZBN4Vgi4Ulkskz6qU3NYRO03nH

p9P7Z5q59A3E&m=goBsQ2eLlP7qVkOJAy8TPlQ0B6NFvNm4rP58u6ASQxc&s=

2U_MKBpgLtoTglsPa4GJpgQpw6Ga3mBFBfABf7k0TwU&e=<https://urldefen
se.pr

oofpoint.com/v2/url?u=https-

3A__github.c&d=DwIFAg&c=C5b8zRQO1miGmBeV

Z2LFWg&r=_SN6FZBN4Vgi4Ulkskz6qU3NYRO03nHp9P7Z5q59A3E&m=ZDn7D
prnbcQsP

W6LKdgESNPjNoC_STFSKzHiOKNgCiA&s=M-Oc-

aivFloPmCsB8exWifFgGJDh_2Q3qO7

6ai1Hodw&e=
om/tianocore/edk2-

staging/blob/UEFI_Redfish/Readme.md%3chttps:/urldefense.proofpoint.c

o
m/v2/url?u=https-3A__nam06.safelinks.protection.outlook.com_-3Furl-
3Dhttps-253A-252F-252Furldefense.proofpoint.com-252Fv2-252Furl-

253Fu

-
253Dhttps-2D3A-5F-5Fnam06.safelinks.protection.outlook.com-5F-

2D3Fur

l-
2D3Dhttps-2D253A-2D252F-2D252Furldefense.proofpoint.com-2D252Fv2-
2D252Furl-2D253Fu-2D253Dhttps-2D2D3A-2D5F-
2D5Fnam06.safelinks.protection.outlook.com-2D5F-2D2D3Furl-

2D2D3Dhttp

s-
2D2D253A-2D2D252F-2D2D252Fgithub.com-2D2D252Ftianocore-
2D2D252Fedk2-2D2D2Dstaging-2D2D252Fblob-2D2D252FUEFI-
2D2D5FRedfish-2D2D252FReadme.md-2D2D26data-2D2D3D02-

2D2D257C01-

2D2D257Cbret.barkelew-2D2D2540microsoft.com-
2D2D257Cec6961ac4b3143f196be08d859251f68-
2D2D257C72f988bf86f141af91ab2d7cd011db47-2D2D257C1-2D2D257C0-
2D2D257C637357363278947284-2D2D26sdata-
2D2D3Dkt66JYtpN1X1hCrt5cQY3btyQEdoqZYkVPW5J7w8dws-2D2D253D-
2D2D26reserved-2D2D3D0-2D2526d-2D253DDwMF-2D2Dg-2D2526c-
2D253DC5b8zRQO1miGmBeVZ2LFWg-2D2526r-2D253D-
2D5FSN6FZBN4Vgi4Ulkskz6qU3NYRO03nHp9P7Z5q59A3E-2D2526m-
2D253DvNotrFyeoRyYey-2D2D0DOEVOLlZ7unqNGts5l1lH-2D2D4MzqM-
2D2526s-2D253DBO3e8WR8joHCC9lD6Guk5Q2XN8DJ0JCOTy2AfB279q8-
2D2526e-2D253D-2D26data-2D3D02-2D257C01-2D257Cbret.barkelew-
2D2540microsoft.com-2D257C6bd38bf379f64b06f6b808d859282266-
2D257C72f988bf86f141af91ab2d7cd011db47-2D257C1-2D257C0-
2D257C637357376203679617-2D26sdata-2D3D-
2D252Fc1YADqJZbAxtJEfc7R4LRToIVVG-2D252F8P5K9XRzp2RTio-2D253D-
2D26reserved-2D3D0-2526d-253DDwMF-2Dg-2526c-
253DC5b8zRQO1miGmBeVZ2LFWg-2526r-253D-
5FSN6FZBN4Vgi4Ulkskz6qU3NYRO03nHp9P7Z5q59A3E-2526m-
253DDkSlNNriVFNl3jnCeMG8vtCRlB3CgfREapKoapz-2Dcx0-2526s-
253DvXm2LZsMsTXRCNZ9IZvid63RGiDHFF5aL-5F2JBwiL7kg-2526e-253D-
26data-3D02-257C01-257Cbret.barkelew-2540microsoft.com-
257C1b8115973f364cea229008d8592bc486-
257C72f988bf86f141af91ab2d7cd011db47-257C1-257C0-
257C637357391811802634-26sdata-3Dr9JTbIGJH3tmabZ-
252BOtYAjVm5PRXWvuK0Wm2v2NByE1M-253D-26reserved-

3D0&d=DwIF-

g&c=C5b8zRQO1miGmBeVZ2LFWg&r=_SN6FZBN4Vgi4Ulkskz6qU3NYRO03nH

p9P7Z5q59A3E&m=goBsQ2eLlP7qVkOJAy8TPlQ0B6NFvNm4rP58u6ASQxc&s=

2U_MKBpgLtoTglsP> >

Thanks
Abner

-----Original Message-----
From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Abner
Chang
Sent: Wednesday, September 23, 2020 10:21 AM
To: rfc@edk2.groups.io; Yao, Jiewen <jiewen.yao@...>;
devel@edk2.groups.io; bret.barkelew@...
Cc: Wang, Nickle (HPS SW) <nickle.wang@...>; Chen, Aaron
<aaron.chen@...>; Fu, Siyuan <siyuan.fu@...>; Wang, Fan
<fan.wang@...>; Wu, Jiaxin <jiaxin.wu@...>; Ni, Ray
<ray.ni@...>; Kinney, Michael D <michael.d.kinney@...>
Subject: Re: [edk2-rfc] [edk2-devel] [RFC] Request for the new package
"RedfishPkg" under edk2 repo

That would take time to run through the process of publishing this tool (make it
as public) on DMTF. I just created the reference of source code which generated
by tool on my personal GitHub (not the tool itself)
https://github.com/changab/Redfish-JSON-C-Struct-Converter-Lib .

The branch "Master" which are the source code to convert Redfish JSON
schemas to C code. These source code could be built by CMakeLists.txt (under
src/_build) across platforms.
The branch " edk2-driver-wrapper" are generated by tool with some "edk2"
options. The edk2 wrapper drivers (/RedfishCsIntp/RedfishSchemaInterpreter )
are selected (our plan) into edk2 build process on demand, refer to
https://github.com/tianocore/edk2-staging/tree/UEFI_Redfish#%5B1%5D
Edk2 driver ((/RedfishCsIntp/RedfishSchemaInterpreter) registers itself to EFI
REST JSON Structure Protocol. The upper level users use EFI REST JSON Structure
Protocol to generate Redfish JSON payload from the C structure or vice versa
from JSON to C. Thus upper level user can use C structure member to refer to
the Redfish property with manipulating JSON objects.
BTW, the naming of RedfishSchemaInterpreter is not sync-up with the latest
UEFI spec and the source code is not generated based on latest Redfish schema.


This also gives the reference to Bret regards to the answer I had in the previous
email.

No, EFI REST JSON Structure DXE Driver (UEF spec section 29.7.3) is a
centralized manager to manage "EFI Redfish JSON resource to C structure
Converter libraries/drivers" for converting Redfish resource in the specific
schema from JSON format to the C structure or vice versa.
EFI REST JSON Structure DXE Driver itself doesn't use JSON library, however
"EFI Redfish JSON resource to C structure Converter libraries/drivers" do use
open source jansson library to parse JSON payload.

"EFI Redfish JSON resource to C structure Converter libraries/drivers" in above
refers to auto-generated source code.

We plan to present this on next week TianoCore design meeting.

-----Original Message-----
From: rfc@edk2.groups.io [mailto:rfc@edk2.groups.io] On Behalf Of Yao,
Jiewen
Sent: Tuesday, September 15, 2020 1:44 PM
To: Chang, Abner (HPS SW/FW Technologist) <abner.chang@...>;
devel@edk2.groups.io; rfc@edk2.groups.io
Cc: Wang, Nickle (HPS SW) <nickle.wang@...>; Chen, Aaron
<aaron.chen@...>; Fu, Siyuan <siyuan.fu@...>; Wang, Fan
<fan.wang@...>; Wu, Jiaxin <jiaxin.wu@...>; Ni, Ray
<ray.ni@...>; Kinney, Michael D <michael.d.kinney@...>
Subject: Re: [edk2-rfc] [edk2-devel] [RFC] Request for the new package
"RedfishPkg" under edk2 repo

Thanks Abner.
Understood now. Yes, we need follow the regulation as always.

I look forward to seeing the DMTF public repo. :-)

Thank you
Yao Jiewen

From: Chang, Abner (HPS SW/FW Technologist) <abner.chang@...>
Sent: Tuesday, September 15, 2020 1:39 PM
To: devel@edk2.groups.io; Yao, Jiewen <jiewen.yao@...>;
rfc@edk2.groups.io
Cc: Wang, Nickle (HPS SW) <nickle.wang@...>; Chen, Aaron
<aaron.chen@...>; Fu, Siyuan <siyuan.fu@...>; Wang, Fan
<fan.wang@...>; Wu, Jiaxin <jiaxin.wu@...>; Ni, Ray
<ray.ni@...>; Kinney, Michael D <michael.d.kinney@...>
Subject: RE: [edk2-rfc] [edk2-devel] [RFC] Request for the new package
"RedfishPkg" under edk2 repo

Sure Jiewen, we plan to talk about this on Tianocore design meeting recently.
But I may not provide the reference here because it may against to the
Redfish working group regulations.
I had requested to public this repo two years ago, however both WG chair
and I had no follow up on this. I already restarted the conversation with him...
just now.

For now, only the implementation of UEFI spec 29.7.2 (Redfish instance),
29.7.3 and 31.1 will be sent to community for review.

Thanks
Abner


From: devel@edk2.groups.io<mailto:devel@edk2.groups.io>
[mailto:devel@edk2.groups.io] On Behalf Of Yao, Jiewen
Sent: Tuesday, September 15, 2020 12:42 PM
To: devel@edk2.groups.io<mailto:devel@edk2.groups.io>; Chang, Abner
(HPS SW/FW Technologist)
<abner.chang@...<mailto:abner.chang@...>>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)
<nickle.wang@...<mailto:nickle.wang@...>>; Chen, Aaron
<aaron.chen@...<mailto:aaron.chen@...>>; Fu, Siyuan
<siyuan.fu@...<mailto:siyuan.fu@...>>; Wang, Fan
<fan.wang@...<mailto:fan.wang@...>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...>>; Ni, Ray
<ray.ni@...<mailto:ray.ni@...>>; Kinney, Michael D
<michael.d.kinney@...<mailto:michael.d.kinney@...>>
Subject: Re: [edk2-rfc] [edk2-devel] [RFC] Request for the new package
"RedfishPkg" under edk2 repo

HI Abner
If it is DMTF private repo, should we discuss it in EDKII ?

Do we have a public reference somewhere else?

Thank you
Yao Jiewen

From: devel@edk2.groups.io<mailto:devel@edk2.groups.io>
<devel@edk2.groups.io<mailto:devel@edk2.groups.io>> On Behalf Of
Abner Chang
Sent: Tuesday, September 15, 2020 12:23 PM
To: rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>;
devel@edk2.groups.io<mailto:devel@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)
<nickle.wang@...<mailto:nickle.wang@...>>; Chen, Aaron
<aaron.chen@...<mailto:aaron.chen@...>>; Fu, Siyuan
<siyuan.fu@...<mailto:siyuan.fu@...>>; Wang, Fan
<fan.wang@...<mailto:fan.wang@...>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...>>; Ni, Ray
<ray.ni@...<mailto:ray.ni@...>>; Kinney, Michael D
<michael.d.kinney@...<mailto:michael.d.kinney@...>>
Subject: Re: [edk2-rfc] [edk2-devel] [RFC] Request for the new package
"RedfishPkg" under edk2 repo

Hmm. You probably have to join dmtf as a member. That repo is private for
members now, not public yet.


Get Outlook for
Android<INVALID URI REMOVED
3A__aka.ms_ghei36&d=DwMFAg&c=C5b8zRQO1miGmBeVZ2LFWg&r=_SN6
FZBN4Vgi4Ulkskz6qU3NYRO03nHp9P7Z5q59A3E&m=pOqEHDFgI3N3KX0vXeQ
x5x9eAu8iFwKLxaC_oogVwiE&s=JcIdGRVs2CdvN2AKuofiuNTu3UV6lDvgB4Rj
vpRgiXM&e=>
________________________________
From: rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
<rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>> on behalf of Bret
Barkelew via groups.io
<bret.barkelew@...<mailto:bret.barkelew=microsoft.
com@groups.io>>
Sent: Tuesday, September 15, 2020 12:19:29 PM
To: Chang, Abner (HPS SW/FW Technologist)
<abner.chang@...<mailto:abner.chang@...>>;
devel@edk2.groups.io<mailto:devel@edk2.groups.io>
<devel@edk2.groups.io<mailto:devel@edk2.groups.io>>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
<rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>>
Cc: Wang, Nickle (HPS SW)
<nickle.wang@...<mailto:nickle.wang@...>>; Chen, Aaron
<aaron.chen@...<mailto:aaron.chen@...>>;
siyuan.fu@...<mailto:siyuan.fu@...>
<siyuan.fu@...<mailto:siyuan.fu@...>>; Wang, Fan
<fan.wang@...<mailto:fan.wang@...>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...>>; Ni, Ray
<ray.ni@...<mailto:ray.ni@...>>; Kinney, Michael D
<michael.d.kinney@...<mailto:michael.d.kinney@...>>
Subject: Re: [edk2-rfc] [edk2-devel] [RFC] Request for the new package
"RedfishPkg" under edk2 repo

That link didn't work for me.

- Bret

From: Chang, Abner (HPS SW/FW
Technologist)<mailto:abner.chang@...>
Sent: Monday, September 14, 2020 8:59 PM
To:
devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...
oups.io%3cmailto:devel@edk2.groups.io>>; Bret
Barkelew<mailto:Bret.Barkelew@...>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)<mailto:nickle.wang@...>; Chen,
Aaron<mailto:aaron.chen@...>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang,
Fan<mailto:fan.wang@...>; Wu, Jiaxin<mailto:jiaxin.wu@...>;
Ni, Ray<mailto:ray.ni@...>; Kinney, Michael
D<mailto:michael.d.kinney@...>
Subject: [EXTERNAL] RE: [edk2-devel] [RFC] Request for the new package
"RedfishPkg" under edk2 repo

No, EFI REST JSON Structure DXE Driver (UEF spec section 29.7.3) is a
centralized manager to manage "EFI Redfish JSON resource to C structure
Converter libraries/drivers" for converting Redfish resource in the specific
schema from JSON format to the C structure or vice versa.
EFI REST JSON Structure DXE Driver itself doesn't use JSON library, however
"EFI Redfish JSON resource to C structure Converter libraries/drivers" do use
open source jansson library to parse JSON payload. Furthermore, "EFI
Redfish JSON resource to C structure Converter libraries/drivers" are
generated by tool based on the published Redfish schemas.
https://github.com/DMTF/Redfish-Schema-C-Struct-
Generator<INVALID URI REMOVED
3A__nam06.safelinks.protection.outlook.com_-3Furl-3Dhttps-253A-252F-
252Fgithub.com-252FDMTF-252FRedfish-2DSchema-2DC-2DStruct-
2DGenerator-26data-3D02-257C01-257Cbret.barkelew-2540microsoft.com-
257C1b8115973f364cea229008d8592bc486-
257C72f988bf86f141af91ab2d7cd011db47-257C1-257C0-
257C637357391811797643-26sdata-
3DLdHAPly4oeVhyC6Xk7p0G0r1y8qVxrLfGZrN9EW5WpE-253D-26reserved-
3D0&d=DwIF-
g&c=C5b8zRQO1miGmBeVZ2LFWg&r=_SN6FZBN4Vgi4Ulkskz6qU3NYRO03nH
p9P7Z5q59A3E&m=goBsQ2eLlP7qVkOJAy8TPlQ0B6NFvNm4rP58u6ASQxc&s=
j2rR7JmY2HjCtfOOe9ChSWCNKYseOJX2T-
91Z3miShA&e=<https://github.com/DMTF/Redfish-Schema-C-Struct-
Generator%3chttps:/urldefense.proofpoint.com/v2/url?u=https-
3A__nam06.safelinks.protection.outlook.com_-3Furl-3Dhttps-253A-252F-
252Fgithub.com-252FDMTF-252FRedfish-2DSchema-2DC-2DStruct-
2DGenerator-26data-3D02-257C01-257Cbret.barkelew-2540microsoft.com-
257C1b8115973f364cea229008d8592bc486-
257C72f988bf86f141af91ab2d7cd011db47-257C1-257C0-
257C637357391811797643-26sdata-
3DLdHAPly4oeVhyC6Xk7p0G0r1y8qVxrLfGZrN9EW5WpE-253D-26reserved-
3D0&d=DwIF-
g&c=C5b8zRQO1miGmBeVZ2LFWg&r=_SN6FZBN4Vgi4Ulkskz6qU3NYRO03nH
p9P7Z5q59A3E&m=goBsQ2eLlP7qVkOJAy8TPlQ0B6NFvNm4rP58u6ASQxc&s=
j2rR7JmY2HjCtfOOe9ChSWCNKYseOJX2T-91Z3miShA&e=> >

From: devel@edk2.groups.io<mailto:devel@edk2.groups.io>
[mailto:devel@edk2.groups.io] On Behalf Of Bret Barkelew via groups.io
Sent: Tuesday, September 15, 2020 11:41 AM
To: Chang, Abner (HPS SW/FW Technologist)
<abner.chang@...<mailto:abner.chang@...>>;
devel@edk2.groups.io<mailto:devel@edk2.groups.io>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)
<nickle.wang@...<mailto:nickle.wang@...>>; Chen, Aaron
<aaron.chen@...<mailto:aaron.chen@...>>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang, Fan
<fan.wang@...<mailto:fan.wang@...>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...>>; Ni, Ray
<ray.ni@...<mailto:ray.ni@...>>; Kinney, Michael D
<michael.d.kinney@...<mailto:michael.d.kinney@...>>
Subject: Re: [edk2-devel] [RFC] Request for the new package "RedfishPkg"
under edk2 repo

JSON Structure would probably be worth discussing. I know that there are
other places I've seen JSON used and it may end up that we want common
business logic (similar to using Oniguruma for regex). Do you parse/format
JSON in that one?

- Bret

From: Chang, Abner (HPS SW/FW
Technologist)<mailto:abner.chang@...>
Sent: Monday, September 14, 2020 8:33 PM
To:
devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...
oups.io%3cmailto:devel@edk2.groups.io>>; Bret
Barkelew<mailto:Bret.Barkelew@...>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)<mailto:nickle.wang@...>; Chen,
Aaron<mailto:aaron.chen@...>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang,
Fan<mailto:fan.wang@...>; Wu, Jiaxin<mailto:jiaxin.wu@...>;
Ni, Ray<mailto:ray.ni@...>; Kinney, Michael
D<mailto:michael.d.kinney@...>
Subject: [EXTERNAL] RE: [edk2-devel] [RFC] Request for the new package
"RedfishPkg" under edk2 repo

Not many drivers fall in edk2 repo so far, those are drivers with the
corresponding definitions in UEFI spec.

* EFI REST EX UEFI Driver for Redfish service
* EFI Redfish Discover UEFI Driver
* EFI REST JSON Structure DXE Driver

All others have to go through code first policy, will be in edk2-staging repo.

-Abner

From:
devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...
oups.io%3cmailto:devel@edk2.groups.io>> [mailto:devel@edk2.groups.io]
On Behalf Of Bret Barkelew via groups.io
Sent: Tuesday, September 15, 2020 11:19 AM
To:
devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...
oups.io%3cmailto:devel@edk2.groups.io>>; Chang, Abner (HPS SW/FW
Technologist)
<abner.chang@...<mailto:abner.chang@...<mailto:abner.chang
@hpe.com%3cmailto:abner.chang@...>>>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)
<nickle.wang@...<mailto:nickle.wang@...<mailto:nickle.wang
@hpe.com%3cmailto:nickle.wang@...>>>; Chen, Aaron
<aaron.chen@...<mailto:aaron.chen@...<mailto:aaron.chen@h
pe.com%3cmailto:aaron.chen@...>>>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang, Fan
<fan.wang@...<mailto:fan.wang@...<mailto:fan.wang@...
om%3cmailto:fan.wang@...>>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...<mailto:jiaxin.wu@...
om%3cmailto:jiaxin.wu@...>>>; Ni, Ray
<ray.ni@...<mailto:ray.ni@...<mailto:ray.ni@...%3cmail
to:ray.ni@...>>>; Kinney, Michael D
<michael.d.kinney@...<mailto:michael.d.kinney@...<mailto:m
ichael.d.kinney@...%3cmailto:michael.d.kinney@...>>>
Subject: Re: [edk2-devel] [RFC] Request for the new package "RedfishPkg"
under edk2 repo

I think code review works. I'm primarily interested in seeing how much code
falls under the "edk2" vs "edk2-staging" repos.

- Bret

From: Abner Chang via groups.io<mailto:abner.chang@...>
Sent: Monday, September 14, 2020 8:12 PM
To:
devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...
oups.io%3cmailto:devel@edk2.groups.io>>; Chang, Abner (HPS SW/FW
Technologist)<mailto:abner.chang@...>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)<mailto:nickle.wang@...>; Chen,
Aaron<mailto:aaron.chen@...>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang,
Fan<mailto:fan.wang@...>; Wu, Jiaxin<mailto:jiaxin.wu@...>;
Ni, Ray<mailto:ray.ni@...>; Kinney, Michael
D<mailto:michael.d.kinney@...>
Subject: [EXTERNAL] Re: [edk2-devel] [RFC] Request for the new package
"RedfishPkg" under edk2 repo

Seems no one has comment on this topic. Let's just go through the code
review process.
Thanks

Abner

From:
devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...
oups.io%3cmailto:devel@edk2.groups.io>> [mailto:devel@edk2.groups.io]
On Behalf Of Abner Chang
Sent: Wednesday, September 9, 2020 11:02 AM
To:
devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...
oups.io%3cmailto:devel@edk2.groups.io>>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)
<nickle.wang@...<mailto:nickle.wang@...<mailto:nickle.wang
@hpe.com%3cmailto:nickle.wang@...>>>; Chen, Aaron
<aaron.chen@...<mailto:aaron.chen@...<mailto:aaron.chen@h
pe.com%3cmailto:aaron.chen@...>>>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang, Fan
<fan.wang@...<mailto:fan.wang@...<mailto:fan.wang@...
om%3cmailto:fan.wang@...>>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...<mailto:jiaxin.wu@...
om%3cmailto:jiaxin.wu@...>>>; Ni, Ray
<ray.ni@...<mailto:ray.ni@...<mailto:ray.ni@...%3cmail
to:ray.ni@...>>>; Michael D Kinney
<michael.d.kinney@...<mailto:michael.d.kinney@...<mailto:m
ichael.d.kinney@...%3cmailto:michael.d.kinney@...>>>
Subject: Re: [edk2-devel] [RFC] Request for the new package "RedfishPkg"
under edk2 repo

Add [RFC] to the subject, add Ray and Mike to the loop.

From: Chang, Abner (HPS SW/FW Technologist)
Sent: Tuesday, September 8, 2020 12:06 PM
To:
devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...
oups.io%3cmailto:devel@edk2.groups.io>>; Chang, Abner (HPS SW/FW
Technologist)
<abner.chang@...<mailto:abner.chang@...<mailto:abner.chang
@hpe.com%3cmailto:abner.chang@...>>>;
rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)
<nickle.wang@...<mailto:nickle.wang@...<mailto:nickle.wang
@hpe.com%3cmailto:nickle.wang@...>>>; Chen, Aaron
<aaron.chen@...<mailto:aaron.chen@...<mailto:aaron.chen@h
pe.com%3cmailto:aaron.chen@...>>>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang, Fan
<fan.wang@...<mailto:fan.wang@...<mailto:fan.wang@...
om%3cmailto:fan.wang@...>>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...<mailto:jiaxin.wu@...
om%3cmailto:jiaxin.wu@...>>>
Subject: RE: Request for the new package "RedfishPkg" under edk2 repo

This is the RFC for the new package "RedfishPkg" introduced to edk2 repo, I
thought mailing system will add [RFC] prefix to the subject. Sorry for the
inconvenience.

From:
devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...
oups.io%3cmailto:devel@edk2.groups.io>> [mailto:devel@edk2.groups.io]
On Behalf Of Abner Chang
Sent: Tuesday, September 8, 2020 11:48 AM
To: rfc@edk2.groups.io<mailto:rfc@edk2.groups.io>
Cc: Wang, Nickle (HPS SW)
<nickle.wang@...<mailto:nickle.wang@...<mailto:nickle.wang
@hpe.com%3cmailto:nickle.wang@...>>>; Chen, Aaron
<aaron.chen@...<mailto:aaron.chen@...<mailto:aaron.chen@h
pe.com%3cmailto:aaron.chen@...>>>;
siyuan.fu@...<mailto:siyuan.fu@...>; Wang, Fan
<fan.wang@...<mailto:fan.wang@...<mailto:fan.wang@...
om%3cmailto:fan.wang@...>>>; Wu, Jiaxin
<jiaxin.wu@...<mailto:jiaxin.wu@...<mailto:jiaxin.wu@...
om%3cmailto:jiaxin.wu@...>>>;
devel@edk2.groups.io<mailto:devel@edk2.groups.io<mailto:devel@...
oups.io%3cmailto:devel@edk2.groups.io>>
Subject: [edk2-devel] Request for the new package "RedfishPkg" under edk2
repo

Hi everyone,
Given that we are going to contribute code of UEFI Redfish edk2 solution, a
new package "RedfishPkg" under edk2 repo is necessary for accommodating
the UEFI Redfish driver stacks, that includes

* EFI Redfish Host Interface DXE Driver
* EFI Refish Credential DXE Driver
* EFI REST EX UEFI Driver for Redfish service
* EFI Redfish Discover UEFI Driver
* EFI Redfish Discover Protocol
* EFI Redfish Config UEFI Driver
* EFI BIOS Config To Redfish Dxe Driver
* EFI REST JSON Structure DXE Driver
* EFI Source Coding DXE Driver
* EFI BIOS Resource Provision Generation Protocol
* EFI BIOS Resource Provision Transport Layer Protocol

The architecture have been discussing in TianoCore Design meeting and the
corresponding BZ were created as well.
The code we will start to contribute includes

* Contribute to edk2 repo for those drivers already have the corresponding
definitions in UEFI spec.
* Contribute code to edk2-staging/UEFI _Redfish for those drivers do not
have the corresponding definitions in UEFI spec. This is for the evaluation and
require ECR to USWG if community agree with having this driver for Redfish
edk2 solution.

Please refer to below link for the details,
https://github.com/tianocore/edk2-
staging/blob/UEFI_Redfish/Readme.md<https://urldefense.proofpoint.com
/v2/url?u=https-3A__nam06.safelinks.protection.outlook.com_-3Furl-
3Dhttps-253A-252F-252Furldefense.proofpoint.com-252Fv2-252Furl-253Fu-
253Dhttps-2D3A-5F-5Fnam06.safelinks.protection.outlook.com-5F-2D3Furl-
2D3Dhttps-2D253A-2D252F-2D252Furldefense.proofpoint.com-2D252Fv2-
2D252Furl-2D253Fu-2D253Dhttps-2D2D3A-2D5F-
2D5Fnam06.safelinks.protection.outlook.com-2D5F-2D2D3Furl-2D2D3Dhttps-
2D2D253A-2D2D252F-2D2D252Fgithub.com-2D2D252Ftianocore-
2D2D252Fedk2-2D2D2Dstaging-2D2D252Fblob-2D2D252FUEFI-
2D2D5FRedfish-2D2D252FReadme.md-2D2D26data-2D2D3D02-2D2D257C01-
2D2D257Cbret.barkelew-2D2D2540microsoft.com-
2D2D257Cec6961ac4b3143f196be08d859251f68-
2D2D257C72f988bf86f141af91ab2d7cd011db47-2D2D257C1-2D2D257C0-
2D2D257C637357363278947284-2D2D26sdata-
2D2D3Dkt66JYtpN1X1hCrt5cQY3btyQEdoqZYkVPW5J7w8dws-2D2D253D-
2D2D26reserved-2D2D3D0-2D2526d-2D253DDwMF-2D2Dg-2D2526c-
2D253DC5b8zRQO1miGmBeVZ2LFWg-2D2526r-2D253D-
2D5FSN6FZBN4Vgi4Ulkskz6qU3NYRO03nHp9P7Z5q59A3E-2D2526m-
2D253DvNotrFyeoRyYey-2D2D0DOEVOLlZ7unqNGts5l1lH-2D2D4MzqM-
2D2526s-2D253DBO3e8WR8joHCC9lD6Guk5Q2XN8DJ0JCOTy2AfB279q8-
2D2526e-2D253D-2D26data-2D3D02-2D257C01-2D257Cbret.barkelew-
2D2540microsoft.com-2D257C6bd38bf379f64b06f6b808d859282266-
2D257C72f988bf86f141af91ab2d7cd011db47-2D257C1-2D257C0-
2D257C637357376203679617-2D26sdata-2D3D-
2D252Fc1YADqJZbAxtJEfc7R4LRToIVVG-2D252F8P5K9XRzp2RTio-2D253D-
2D26reserved-2D3D0-2526d-253DDwMF-2Dg-2526c-
253DC5b8zRQO1miGmBeVZ2LFWg-2526r-253D-
5FSN6FZBN4Vgi4Ulkskz6qU3NYRO03nHp9P7Z5q59A3E-2526m-
253DDkSlNNriVFNl3jnCeMG8vtCRlB3CgfREapKoapz-2Dcx0-2526s-
253DvXm2LZsMsTXRCNZ9IZvid63RGiDHFF5aL-5F2JBwiL7kg-2526e-253D-
26data-3D02-257C01-257Cbret.barkelew-2540microsoft.com-
257C1b8115973f364cea229008d8592bc486-
257C72f988bf86f141af91ab2d7cd011db47-257C1-257C0-
257C637357391811802634-26sdata-3Dr9JTbIGJH3tmabZ-
252BOtYAjVm5PRXWvuK0Wm2v2NByE1M-253D-26reserved-3D0&d=DwIF-
g&c=C5b8zRQO1miGmBeVZ2LFWg&r=_SN6FZBN4Vgi4Ulkskz6qU3NYRO03nH
p9P7Z5q59A3E&m=goBsQ2eLlP7qVkOJAy8TPlQ0B6NFvNm4rP58u6ASQxc&s=
2U_MKBpgLtoTglsPa4GJpgQpw6Ga3mBFBfABf7k0TwU&e=<https://github.c
om/tianocore/edk2-
staging/blob/UEFI_Redfish/Readme.md%3chttps:/urldefense.proofpoint.co
m/v2/url?u=https-3A__nam06.safelinks.protection.outlook.com_-3Furl-
3Dhttps-253A-252F-252Furldefense.proofpoint.com-252Fv2-252Furl-253Fu-
253Dhttps-2D3A-5F-5Fnam06.safelinks.protection.outlook.com-5F-2D3Furl-
2D3Dhttps-2D253A-2D252F-2D252Furldefense.proofpoint.com-2D252Fv2-
2D252Furl-2D253Fu-2D253Dhttps-2D2D3A-2D5F-
2D5Fnam06.safelinks.protection.outlook.com-2D5F-2D2D3Furl-2D2D3Dhttps-
2D2D253A-2D2D252F-2D2D252Fgithub.com-2D2D252Ftianocore-
2D2D252Fedk2-2D2D2Dstaging-2D2D252Fblob-2D2D252FUEFI-
2D2D5FRedfish-2D2D252FReadme.md-2D2D26data-2D2D3D02-2D2D257C01-
2D2D257Cbret.barkelew-2D2D2540microsoft.com-
2D2D257Cec6961ac4b3143f196be08d859251f68-
2D2D257C72f988bf86f141af91ab2d7cd011db47-2D2D257C1-2D2D257C0-
2D2D257C637357363278947284-2D2D26sdata-
2D2D3Dkt66JYtpN1X1hCrt5cQY3btyQEdoqZYkVPW5J7w8dws-2D2D253D-
2D2D26reserved-2D2D3D0-2D2526d-2D253DDwMF-2D2Dg-2D2526c-
2D253DC5b8zRQO1miGmBeVZ2LFWg-2D2526r-2D253D-
2D5FSN6FZBN4Vgi4Ulkskz6qU3NYRO03nHp9P7Z5q59A3E-2D2526m-
2D253DvNotrFyeoRyYey-2D2D0DOEVOLlZ7unqNGts5l1lH-2D2D4MzqM-
2D2526s-2D253DBO3e8WR8joHCC9lD6Guk5Q2XN8DJ0JCOTy2AfB279q8-
2D2526e-2D253D-2D26data-2D3D02-2D257C01-2D257Cbret.barkelew-
2D2540microsoft.com-2D257C6bd38bf379f64b06f6b808d859282266-
2D257C72f988bf86f141af91ab2d7cd011db47-2D257C1-2D257C0-
2D257C637357376203679617-2D26sdata-2D3D-
2D252Fc1YADqJZbAxtJEfc7R4LRToIVVG-2D252F8P5K9XRzp2RTio-2D253D-
2D26reserved-2D3D0-2526d-253DDwMF-2Dg-2526c-
253DC5b8zRQO1miGmBeVZ2LFWg-2526r-253D-
5FSN6FZBN4Vgi4Ulkskz6qU3NYRO03nHp9P7Z5q59A3E-2526m-
253DDkSlNNriVFNl3jnCeMG8vtCRlB3CgfREapKoapz-2Dcx0-2526s-
253DvXm2LZsMsTXRCNZ9IZvid63RGiDHFF5aL-5F2JBwiL7kg-2526e-253D-
26data-3D02-257C01-257Cbret.barkelew-2540microsoft.com-
257C1b8115973f364cea229008d8592bc486-
257C72f988bf86f141af91ab2d7cd011db47-257C1-257C0-
257C637357391811802634-26sdata-3Dr9JTbIGJH3tmabZ-
252BOtYAjVm5PRXWvuK0Wm2v2NByE1M-253D-26reserved-3D0&d=DwIF-
g&c=C5b8zRQO1miGmBeVZ2LFWg&r=_SN6FZBN4Vgi4Ulkskz6qU3NYRO03nH
p9P7Z5q59A3E&m=goBsQ2eLlP7qVkOJAy8TPlQ0B6NFvNm4rP58u6ASQxc&s=
2U_MKBpgLtoTglsP> >

Thanks
Abner

On Sep 2, 2020, at 12:06 PM, Matthew Carlson < matthewfcarlson@... >
wrote:








Andrew:









I think leveraging the existing edksetup is a great idea. Using the
existing EDK_TOOL_PATH variable could work but it seems clunky. Since the
pip module wouldn't be a path, it seems strange to put a boolean value in
a variable meant to hold a path. I definitely think that the scripts could
print whether they're using the pip modules or the in-source tools. Since
Lazlo suggested that pip will be the default, we could have the in-source
modules notify of the fact that you're using the in-source modules. An
additional feature for the pip module could be printing the version that
they are (since you can use the pip infrastructure to query the version of
a given module within a python script). Another option would be simply
trying the pip module first and then falling back to the in-source module.
There would be a slight speed penalty (likely around 10ms) but since this
would only apply to trim and build, it should have relatively low impact.









Lazlo:




Thank you for the excellent summary of the different pieces of the
discussion along with the links. To answer your first point, I think what
a developer does with their pip module is largely up to them. They could
do a virtual environment, they could just do what the requirements state,
or pip install from a checked out basetools.I do think there are some
variables that the virtual environment sets up that would be a good signal
whether you're in a virtual environment or not. I agree with your approach
of basetools development going into the out of edk2 repo and the
importance of making sure package maintainers test and validate their
areas with the new setup. I would personally try to get this early into
the development cycle, (just after this next stable tag this week) to give
the community and developers the most amount of time to get used to
things. A trial period of one release makes sense.









I also agree that the gateway is important in maintaining cohesion between
the new and the old. Hopefully that's nearing completion.









Hopefully other stewards will weigh in but otherwise we'll move ahead with
a proposed solution in patches next week.









-Matthew Carlson













On Wed, Sep 2, 2020 at 1:49 AM Laszlo Ersek < lersek@... > wrote:

On 09/02/20 02:49, Andrew Fish via groups.io ( http://groups.io/ ) wrote:

On Sep 1, 2020, at 4:35 PM, Matthew Carlson < matthewfcarlson@...

wrote:

Hello all,

A recent topic on the RFC mailing list went out and the work on moving

Basetools/Sources/Python to a separate repo has started. See the RFC
conversation here: https://edk2.groups.io/g/rfc/topic/74009714#270 < https://edk2.groups.io/g/rfc/topic/74009714#270

The repo in question is here: https://github.com/tianocore/edk2-basetools

< https://github.com/tianocore/edk2-basetools >

The current plan is shortly after the stable tag is created, a series

of patches will come into edk2 that redirects the build system into the
new python module as well as adds additional documentation. You can see a
sample of this work here: https://github.com/matthewfcarlson/edk2 < https://github.com/matthewfcarlson/edk2

as this has a branch that has the work required to use the basetools pip

module. The patches won't delete the Basetools/Sources/Python folder but
will allow users to select between them. After a certain grace period, the
python folder will be deleted and the pip module will be the de facto way
of using basetools.

Three questions need to be answered:

1. After the patches that enable the pip module land, how long should

the grace period be?

2. During the grace period, should basetools commits land in both

places or just in the edk2-basetools directory?

3. How should the user be able to select which basetools to use (the

one in EDK2 or the pip module)? Currently the approach being considered is
a simple environmental variable? One of the key considerations is
transparency since it won't be apparent what is being used for a
particular build without some sort of mechanism to notify the developer.
With two seperate versions of Basetools, it becomes very easy for the
version of basetools you're using to not be the one you expect.

Matthew,

I’ll throw out some current developer centric ideas.

1) If you `source edksetup.sh` (edksetup.bat) you get the current

behavior, and you add an argument you get the pip flavor? So maybe
`edksetup.bat pip-basetools`?

2) We have similar issues to this with env variables and the build

command dumps them out when it runs. Can we use the current EDK_TOOL_PATH?
Or maybe add an extra print to show that the pip module is being used?

I've skimmed:

- the earlier discussion linked above (rooted at < https://edk2.groups.io/g/rfc/message/270

),

- the even earlier comments in the "Discussion: Basetools a separate repo"
thread on edk2-devel:

https://edk2.groups.io/g/devel/message/57482
http://mid.mail-archive.com/734D49CCEBEEF84792F5B80ED585239D5C5019CE@SHSMSX104.ccr.corp.intel.com


If I still understand / remember correctly, the way at least *I* would use
the new feature is the following:

- set up a new virtual python environment,

- either install the new pip module "permanently" in the virtual
environment, or else install it in "editable mode" from a git checkout
(but *still* in the virtual environment)

- build edk2 with the virtual environment active

That is, for me anyway, the key distinguishing factor would be that I'd be
in a python virtual environment where this particular python module
existed / were installed.

Does this answer question (3)? Because, in my case anyway, I wouldn't have
to be *notified* about using the separate basetools repo vs. using the one
resident in edk2 -- instead, I'd have to *activate* the separate basetools
repo myself, as first step. So if that activation brings some queriable
feature into the environment (sets a new environment variable or makes a
new python package appear in the environment), then I think it's good
enough -- the usual tools that I run then can query these artifacts.

In short (I guess): commands should use the in-tree variant, unless I
activate the virtual environment that has the basetools PIP module
installed.

I think it would be fine to require that, *if* someone intends to activate
such a python virtual environment, *then* they do so *before* running
"edksetup.sh". So "edksetup.sh" could check for the python env having the
external basetools repo / module active. Hopefully that would be "early
enough".


Regarding the grace period -- questions (1) and (2):

- The patches introducing the new feature to edk2 should be posted to the
list. These patches should also add a warning to "edksetup.sh" that urges
the developer to use the out-of-tree basetools repo / PIP module, in case
"edksetup.sh" determines the current choice is the in-tree variant (that
is, the virtual env is inactive, or does not contain the new PIP module)

- While the patches are pending approval, BaseTools development is put on
hold (no fixes, no features).

- For every package (subsystem) listed in Maintainers.txt, in *both* edk2
*and* edk2-platfomrs, at least one "M" person is required to report back
with a Tested-by, meaning that they built said package successfully with
the new PIP module.

- When this feedback is complete, the patch is merged, and the new PIP
module becomes the default build system (see the edksetup.sh warning
described above).

- Optimally, the above (= comprehensive testing feedback, and merging)
would occur *early* in the development cycle (just after the last stable
tag).

- Going forward, bug reports and feature requests are only addressed in
the new (out-of-tree) module. If someone reports that they have to switch
back, *temporarily*, for whatever reason, to the in-tree variant, and the
in-tree variant no longer builds edk2 for them, then such issues can be
resolved on a case-by-case basis, *after* the issue is reported. Point
being, we make the out-of-tree system the new default because of the
comprehensive and strict initial testing requirements (see above); after
which the old system is preserved for a while only as a fallback. If the
fallback proves lacking later on (but still during the grace period), then
the community works to resolve the issue in one of two ways: either help
the issue reporter eliminate their need to use the fallback in the first
place, or backport the subject bugfix/feature to the fallback.

- After the *next* stable release (which still contains both the fallback
and the support for the out-of-tree PIP module), the fallback is removed.

Ultimately this would make the grace period almost one full development
cycle, in which cycle the new system should be tested comprehensively, and
become the default, near the beginning of the period.

This is just my proposal. Some of the other stewards are temporarily away;
I'd suggest waiting for their feedback too.

To finish up, I would like to highlight something from the earlier RFC:

"""
Contribution/Dev Process:
Since this is a separate repo, it will follow a slightly different
contribution and code review process.
1.      Github PR process will be used for contributions and code review
feedback
a.      The yet to be released “Tianocore PR archiver” will be used to
send to a dedicated list for basetools patch review archive
2.      PRs will only be committed if they keep linear history (no merge
commits)
3.      The PR review must be approved by at least 2 members of the
basetools team (not including the author)
4.      The PR must pass all automated checks
a.      Formatting/style
b.      Unit tests
c.      Code coverage (can’t commit change that would decrease overall %)
d.      DCO enforcement - https://probot.github.io/apps/dco/
e.      See other python requirements from the Python coding standard
5.      Github Issues will be used for non-security sensitive
bugs/issues/feature requests
"""

Point (1a) is a pre-requisite for merging the edk2 patches!

We cannot make the new system the default unless its development process
is integrated with the github-to-email gateway (webhook).

Thanks!
Laszlo

On Sep 2, 2020, at 12:06 PM, Matthew Carlson <matthewfcarlson@...> wrote:

Andrew:

I think leveraging the existing edksetup is a great idea. Using the existing EDK_TOOL_PATH variable could work but it seems clunky. Since the pip module wouldn't be a path, it seems strange to put a boolean value in a variable meant to hold a path. I definitely think that the scripts could print whether they're using the pip modules or the in-source tools. Since Lazlo suggested that pip will be the default, we could have the in-source modules notify of the fact that you're using the in-source modules. An additional feature for the pip module could be printing the version that they are (since you can use the pip infrastructure to query the version of a given module within a python script). Another option would be simply trying the pip module first and then falling back to the in-source module. There would be a slight speed penalty (likely around 10ms) but since this would only apply to trim and build, it should have relatively low impact.

Lazlo:
Thank you for the excellent summary of the different pieces of the discussion along with the links. To answer your first point, I think what a developer does with their pip module is largely up to them. They could do a virtual environment, they could just do what the requirements state, or pip install from a checked out basetools.I do think there are some variables that the virtual environment sets up that would be a good signal whether you're in a virtual environment or not. I agree with your approach of basetools development going into the out of edk2 repo and the importance of making sure package maintainers test and validate their areas with the new setup. I would personally try to get this early into the development cycle, (just after this next stable tag this week) to give the community and developers the most amount of time to get used to things. A trial period of one release makes sense.

I also agree that the gateway is important in maintaining cohesion between the new and the old. Hopefully that's nearing completion.

Hopefully other stewards will weigh in but otherwise we'll move ahead with a proposed solution in patches next week.

-Matthew Carlson


On Wed, Sep 2, 2020 at 1:49 AM Laszlo Ersek <lersek@... <mailto:lersek@...>> wrote:
On 09/02/20 02:49, Andrew Fish via groups.io <http://groups.io/> wrote:

On Sep 1, 2020, at 4:35 PM, Matthew Carlson <matthewfcarlson@... <mailto:matthewfcarlson@...>> wrote:

Hello all,

A recent topic on the RFC mailing list went out and the work on moving Basetools/Sources/Python to a separate repo has started. See the RFC conversation here: https://edk2.groups.io/g/rfc/topic/74009714#270

The repo in question is here: https://github.com/tianocore/edk2-basetools

The current plan is shortly after the stable tag is created, a series of patches will come into edk2 that redirects the build system into the new python module as well as adds additional documentation. You can see a sample of this work here: https://github.com/matthewfcarlson/edk2 as this has a branch that has the work required to use the basetools pip module. The patches won't delete the Basetools/Sources/Python folder but will allow users to select between them. After a certain grace period, the python folder will be deleted and the pip module will be the de facto way of using basetools.

Three questions need to be answered:

1. After the patches that enable the pip module land, how long should the grace period be?
2. During the grace period, should basetools commits land in both places or just in the edk2-basetools directory?
3. How should the user be able to select which basetools to use (the one in EDK2 or the pip module)? Currently the approach being considered is a simple environmental variable? One of the key considerations is transparency since it won't be apparent what is being used for a particular build without some sort of mechanism to notify the developer. With two seperate versions of Basetools, it becomes very easy for the version of basetools you're using to not be the one you expect.

Matthew,

I’ll throw out some current developer centric ideas.

1) If you `source edksetup.sh` (edksetup.bat) you get the current behavior, and you add an argument you get the pip flavor? So maybe `edksetup.bat pip-basetools`?
2) We have similar issues to this with env variables and the build command dumps them out when it runs. Can we use the current EDK_TOOL_PATH? Or maybe add an extra print to show that the pip module is being used?

I've skimmed:

- the earlier discussion linked above (rooted at <https://edk2.groups.io/g/rfc/message/270>),

- the even earlier comments in the "Discussion: Basetools a separate repo" thread on edk2-devel:

https://edk2.groups.io/g/devel/message/57482
http://mid.mail-archive.com/734D49CCEBEEF84792F5B80ED585239D5C5019CE@SHSMSX104.ccr.corp.intel.com

If I still understand / remember correctly, the way at least *I* would use the new feature is the following:

- set up a new virtual python environment,

- either install the new pip module "permanently" in the virtual environment, or else install it in "editable mode" from a git checkout (but *still* in the virtual environment)

- build edk2 with the virtual environment active

That is, for me anyway, the key distinguishing factor would be that I'd be in a python virtual environment where this particular python module existed / were installed.

Does this answer question (3)? Because, in my case anyway, I wouldn't have to be *notified* about using the separate basetools repo vs. using the one resident in edk2 -- instead, I'd have to *activate* the separate basetools repo myself, as first step. So if that activation brings some queriable feature into the environment (sets a new environment variable or makes a new python package appear in the environment), then I think it's good enough -- the usual tools that I run then can query these artifacts.

In short (I guess): commands should use the in-tree variant, unless I activate the virtual environment that has the basetools PIP module installed.

I think it would be fine to require that, *if* someone intends to activate such a python virtual environment, *then* they do so *before* running "edksetup.sh". So "edksetup.sh" could check for the python env having the external basetools repo / module active. Hopefully that would be "early enough".


Regarding the grace period -- questions (1) and (2):

- The patches introducing the new feature to edk2 should be posted to the list. These patches should also add a warning to "edksetup.sh" that urges the developer to use the out-of-tree basetools repo / PIP module, in case "edksetup.sh" determines the current choice is the in-tree variant (that is, the virtual env is inactive, or does not contain the new PIP module)

- While the patches are pending approval, BaseTools development is put on hold (no fixes, no features).

- For every package (subsystem) listed in Maintainers.txt, in *both* edk2 *and* edk2-platfomrs, at least one "M" person is required to report back with a Tested-by, meaning that they built said package successfully with the new PIP module.

- When this feedback is complete, the patch is merged, and the new PIP module becomes the default build system (see the edksetup.sh warning described above).

- Optimally, the above (= comprehensive testing feedback, and merging) would occur *early* in the development cycle (just after the last stable tag).

- Going forward, bug reports and feature requests are only addressed in the new (out-of-tree) module. If someone reports that they have to switch back, *temporarily*, for whatever reason, to the in-tree variant, and the in-tree variant no longer builds edk2 for them, then such issues can be resolved on a case-by-case basis, *after* the issue is reported. Point being, we make the out-of-tree system the new default because of the comprehensive and strict initial testing requirements (see above); after which the old system is preserved for a while only as a fallback. If the fallback proves lacking later on (but still during the grace period), then the community works to resolve the issue in one of two ways: either help the issue reporter eliminate their need to use the fallback in the first place, or backport the subject bugfix/feature to the fallback.

- After the *next* stable release (which still contains both the fallback and the support for the out-of-tree PIP module), the fallback is removed.

Ultimately this would make the grace period almost one full development cycle, in which cycle the new system should be tested comprehensively, and become the default, near the beginning of the period.

This is just my proposal. Some of the other stewards are temporarily away; I'd suggest waiting for their feedback too.

To finish up, I would like to highlight something from the earlier RFC:

"""
Contribution/Dev Process:
Since this is a separate repo, it will follow a slightly different contribution and code review process.
1. Github PR process will be used for contributions and code review feedback
a. The yet to be released “Tianocore PR archiver” will be used to send to a dedicated list for basetools patch review archive
2. PRs will only be committed if they keep linear history (no merge commits)
3. The PR review must be approved by at least 2 members of the basetools team (not including the author)
4. The PR must pass all automated checks
a. Formatting/style
b. Unit tests
c. Code coverage (can’t commit change that would decrease overall %)
d. DCO enforcement - https://probot.github.io/apps/dco/
e. See other python requirements from the Python coding standard
5. Github Issues will be used for non-security sensitive bugs/issues/feature requests
"""

Point (1a) is a pre-requisite for merging the edk2 patches!

We cannot make the new system the default unless its development process is integrated with the github-to-email gateway (webhook).

Thanks!
Laszlo

On 09/02/20 02:49, Andrew Fish via groups.io wrote:

On Sep 1, 2020, at 4:35 PM, Matthew Carlson <matthewfcarlson@...>

wrote:

Hello all,

A recent topic on the RFC mailing list went out and the work on moving

Basetools/Sources/Python to a separate repo has started. See the RFC
conversation here: https://edk2.groups.io/g/rfc/topic/74009714#270 <
https://edk2.groups.io/g/rfc/topic/74009714#270>

The repo in question is here:

https://github.com/tianocore/edk2-basetools <
https://github.com/tianocore/edk2-basetools>

The current plan is shortly after the stable tag is created, a series

of patches will come into edk2 that redirects the build system into the new
python module as well as adds additional documentation. You can see a
sample of this work here: https://github.com/matthewfcarlson/edk2 <
https://github.com/matthewfcarlson/edk2> as this has a branch that has
the work required to use the basetools pip module. The patches won't delete
the Basetools/Sources/Python folder but will allow users to select between
them. After a certain grace period, the python folder will be deleted and
the pip module will be the de facto way of using basetools.

Three questions need to be answered:

1. After the patches that enable the pip module land, how long should

the grace period be?

2. During the grace period, should basetools commits land in both

places or just in the edk2-basetools directory?

3. How should the user be able to select which basetools to use (the

one in EDK2 or the pip module)? Currently the approach being considered is
a simple environmental variable? One of the key considerations is
transparency since it won't be apparent what is being used for a particular
build without some sort of mechanism to notify the developer. With two
seperate versions of Basetools, it becomes very easy for the version of
basetools you're using to not be the one you expect.

Matthew,

I’ll throw out some current developer centric ideas.

1) If you `source edksetup.sh` (edksetup.bat) you get the current

behavior, and you add an argument you get the pip flavor? So maybe
`edksetup.bat pip-basetools`?

2) We have similar issues to this with env variables and the build

command dumps them out when it runs. Can we use the current EDK_TOOL_PATH?
Or maybe add an extra print to show that the pip module is being used?

I've skimmed:

- the earlier discussion linked above (rooted at <
https://edk2.groups.io/g/rfc/message/270>),

- the even earlier comments in the "Discussion: Basetools a separate repo"
thread on edk2-devel:

https://edk2.groups.io/g/devel/message/57482

http://mid.mail-archive.com/734D49CCEBEEF84792F5B80ED585239D5C5019CE@SHSMSX104.ccr.corp.intel.com

If I still understand / remember correctly, the way at least *I* would use
the new feature is the following:

- set up a new virtual python environment,

- either install the new pip module "permanently" in the virtual
environment, or else install it in "editable mode" from a git checkout (but
*still* in the virtual environment)

- build edk2 with the virtual environment active

That is, for me anyway, the key distinguishing factor would be that I'd be
in a python virtual environment where this particular python module existed
/ were installed.

Does this answer question (3)? Because, in my case anyway, I wouldn't have
to be *notified* about using the separate basetools repo vs. using the one
resident in edk2 -- instead, I'd have to *activate* the separate basetools
repo myself, as first step. So if that activation brings some queriable
feature into the environment (sets a new environment variable or makes a
new python package appear in the environment), then I think it's good
enough -- the usual tools that I run then can query these artifacts.

In short (I guess): commands should use the in-tree variant, unless I
activate the virtual environment that has the basetools PIP module
installed.

I think it would be fine to require that, *if* someone intends to activate
such a python virtual environment, *then* they do so *before* running
"edksetup.sh". So "edksetup.sh" could check for the python env having the
external basetools repo / module active. Hopefully that would be "early
enough".


Regarding the grace period -- questions (1) and (2):

- The patches introducing the new feature to edk2 should be posted to the
list. These patches should also add a warning to "edksetup.sh" that urges
the developer to use the out-of-tree basetools repo / PIP module, in case
"edksetup.sh" determines the current choice is the in-tree variant (that
is, the virtual env is inactive, or does not contain the new PIP module)

- While the patches are pending approval, BaseTools development is put on
hold (no fixes, no features).

- For every package (subsystem) listed in Maintainers.txt, in *both* edk2
*and* edk2-platfomrs, at least one "M" person is required to report back
with a Tested-by, meaning that they built said package successfully with
the new PIP module.

- When this feedback is complete, the patch is merged, and the new PIP
module becomes the default build system (see the edksetup.sh warning
described above).

- Optimally, the above (= comprehensive testing feedback, and merging)
would occur *early* in the development cycle (just after the last stable
tag).

- Going forward, bug reports and feature requests are only addressed in
the new (out-of-tree) module. If someone reports that they have to switch
back, *temporarily*, for whatever reason, to the in-tree variant, and the
in-tree variant no longer builds edk2 for them, then such issues can be
resolved on a case-by-case basis, *after* the issue is reported. Point
being, we make the out-of-tree system the new default because of the
comprehensive and strict initial testing requirements (see above); after
which the old system is preserved for a while only as a fallback. If the
fallback proves lacking later on (but still during the grace period), then
the community works to resolve the issue in one of two ways: either help
the issue reporter eliminate their need to use the fallback in the first
place, or backport the subject bugfix/feature to the fallback.

- After the *next* stable release (which still contains both the fallback
and the support for the out-of-tree PIP module), the fallback is removed.

Ultimately this would make the grace period almost one full development
cycle, in which cycle the new system should be tested comprehensively, and
become the default, near the beginning of the period.

This is just my proposal. Some of the other stewards are temporarily away;
I'd suggest waiting for their feedback too.

To finish up, I would like to highlight something from the earlier RFC:

"""
Contribution/Dev Process:
Since this is a separate repo, it will follow a slightly different
contribution and code review process.
1. Github PR process will be used for contributions and code review
feedback
a. The yet to be released “Tianocore PR archiver” will be used to
send to a dedicated list for basetools patch review archive
2. PRs will only be committed if they keep linear history (no merge
commits)
3. The PR review must be approved by at least 2 members of the
basetools team (not including the author)
4. The PR must pass all automated checks
a. Formatting/style
b. Unit tests
c. Code coverage (can’t commit change that would decrease overall %)
d. DCO enforcement - https://probot.github.io/apps/dco/
e. See other python requirements from the Python coding standard
5. Github Issues will be used for non-security sensitive
bugs/issues/feature requests
"""

Point (1a) is a pre-requisite for merging the edk2 patches!

We cannot make the new system the default unless its development process
is integrated with the github-to-email gateway (webhook).

Thanks!
Laszlo

-----Original Message-----
From: Samer El-Haj-Mahmoud <Samer.El-Haj-Mahmoud@...>
Sent: Monday, August 10, 2020 11:37 AM
To: devel@edk2.groups.io; Kinney, Michael D <michael.d.kinney@...>; rfc@edk2.groups.io
Cc: Laszlo Ersek <lersek@...>; Andrew Fish <afish@...>; Leif Lindholm <leif@...>; Samer El-Haj-
Mahmoud <Samer.El-Haj-Mahmoud@...>
Subject: RE: [edk2-devel] [Wiki][Patch V2] Add EDK II Code First Process Wiki Page

Mike,

Looks good as a starting point!

Acked-by: Samer El-Haj-Mahmoud <Samer.El-Haj-Mahmoud@...>


I do have a few questions on this sentence: "Specification text changes are held within the affected source repository,
using the GitHub flavor of markdown, in a file (or split across several files) with .md suffix."

- For TianoCore, is the "affected source repository" this sentence is referring to edk2-staging, or edk2?

- If the proposed specification and associated code starts in a branch in edk2-staging respiratory, when does it get
accepted into edk2/edk2-platforms? Is it when the proposed specification change reaches a certain status (such as
"accepted by industry standard forum"), or when the formal specification (with that proposed change) is published by the
UEFI Forum ?

- Any guidance on the specification text md file(s) names (and location) within the repository?

- If the change includes some graphics, is there any guidance on inclusion of the graphics files in the repository?

Thanks,
--Samer

-----Original Message-----
From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael
D Kinney via groups.io
Sent: Friday, August 7, 2020 9:07 PM
To: devel@edk2.groups.io; Kinney, Michael D
<michael.d.kinney@...>; rfc@edk2.groups.io
Cc: Laszlo Ersek <lersek@...>; Andrew Fish <afish@...>;
Leif Lindholm <leif@...>
Subject: Re: [edk2-devel] [Wiki][Patch V2] Add EDK II Code First Process
Wiki Page

A version of this Wiki page is also provided here for review:

https://github.com/mdkinney/edk2/wiki/EDK-II-Code-First-Process

Mike

-----Original Message-----
From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of

Michael

D Kinney
Sent: Friday, August 7, 2020 6:05 PM
To: devel@edk2.groups.io
Cc: Laszlo Ersek <lersek@...>; Andrew Fish <afish@...>;
Leif Lindholm <leif@...>
Subject: [edk2-devel] [Wiki][Patch V2] Add EDK II Code First Process
Wiki Page

Based on the following RFC:

https://edk2.groups.io/g/rfc/message/258

Additional updates:
* Add examples of all specifications currently maintained by
the UEFI Forums.
* Added specification change template using a CC-BY-4.0 license.
* Add source code example for an enum value
* Minor grammar updates to change from an RFC proposal to an
active process.

Cc: Laszlo Ersek <lersek@...>
Cc: Andrew Fish <afish@...>
Cc: Leif Lindholm <leif@...>
Signed-off-by: Michael D Kinney <michael.d.kinney@...>
---
EDK-II-Code-First-Process.md | 182
+++++++++++++++++++++++++++++++++++
1 file changed, 182 insertions(+)
create mode 100644 EDK-II-Code-First-Process.md

diff --git a/EDK-II-Code-First-Process.md
b/EDK-II-Code-First-Process.md new file mode 100644 index
0000000..d5c938e
--- /dev/null
+++ b/EDK-II-Code-First-Process.md
@@ -0,0 +1,182 @@
+The EDK II Code First Process is a process by which new features can
+be added to UEFI Forum specifications after first having been
+designed and prototyped in the open.
+
+This process lets changes and the development of new features happen
+in the open, without violating the UEFI forum bylaws which prevent
+publication of code for in-draft features/changes.
+
+The process does not in fact change the UEFI bylaws - the change is
+that the development (of both specification and code) happens in the
+open. The resulting specification update is then submitted to the
+appropriate working group as an Engineering Change Request (ECR), and
+voted on. For the UEFI Forum, this is a change in workflow, not a change

in process.

+
+ECRs are tracked in a UEFI Forum Mantis instance, access restricted
+to UEFI Forum Members. TianoCore enables this new process by
+providing areas on [TianoCore
+Bugzilla](https://bugzilla.tianocore.org) to track both specification
+updates and reference implementations and new repositories under

[TianoCore GitHub](https://github.com/tianocore) dedicated to hold "code
first".

+
+# TianoCore Bugzilla
+
+[TianoCore Bugzilla](bugzilla.tianocore.org) has a product categories
+for
+ * ACPI Specification
+ * UEFI Shell Specification
+ * UEFI Platform Initialization Distribution Packaging Specification
+ * UEFI Platform Initialization Specification Specification
+ * UEFI Specification
+
+Each product category has separate components for
+ * Specification
+ * Reference implementation
+
+# TianoCore GitHub
+
+Reference implementations targeting the EDK II open source project
+are held in branches in the
+[edk2-staging](https://github.com/tianocore/edk2-staging)
+repository.
+
+Additional repositories for implementing reference features in
+additional open source projects can be added in the future, as required.
+
+Specification text changes are held within the affected source
+repository, using the GitHub flavor of markdown, in a file (or split
+across several files) with .md suffix. Multiple files are required
+if changes impact multiple specifications or if the specification is
+large and is easier to maintain if the changes are split across multiple

files.

+
+* NOTE: This one may break down where we have a specification change
+affecting
+ multiple specifications, but at that point we can track it with
+multiple
+ TianoCore Bugzilla entries.
+
+## Specification Text Template
+
+The following is a template of specification text changes using the
+GitHub flavor of markdown. The title and complete description of the
+specification changes must be provided in the specification text
+along with the name and version of the specification the change
+applies. The `Status` of the specification change always starts in
+the `Draft` state and is updated based on feedback from the industry
+standard forums. The contents of the specification text are required
+to use the [Creative Commons Attribution 4.0
+International](https://spdx.org/licenses/CC-BY-4.0.html)
+license using a `SPDX-License-Identifier` statement.
+
+```
+# Title: [Must be Filled In]
+
+# Status: [Status]
+
+[Status] must be one of the following:
+* Draft
+* Submitted to industry standard forum
+* Accepted by industry standard forum
+* Accepted by industry standard forum with modifications
+* Rejected by industry standard forum
+
+# Document: [Title and Version]
+
+Here are some examples of [Title and Version]:
+* UEFI Specification Version 2.8
+* ACPI Specification Version 6.3
+* UEFI Shell Specification Version 2.2
+* UEFI Platform Initialization Specification Version 1.7
+* UEFI Platform Initialization Distribution Packaging Specification
+Version 1.1
+
+# License
+
+SPDX-License-Identifier: CC-BY-4.0
+
+# Submitter: [TianoCore Community](https://www.tianocore.org)
+
+# Summary of the change
+
+Required Section
+
+# Benefits of the change
+
+Required Section
+
+# Impact of the change
+
+Required Section
+
+# Detailed description of the change [normative updates]
+
+Required Section
+
+# Special Instructions
+
+Optional Section
+```
+
+# Intended workflow
+
+The entity initiating a specification change enters a Bugzilla in the
+appropriate area of [TianoCore Bugzilla](bugzilla.tianocore.org).
+This entry contains the outline of the change, and the full initial draft

text is attached.

+
+If multiple specification updates are interdependent, especially if
+between different specifications, then multiple Bugzilla entries should be

created.

+These Bugzilla entries *must* be linked together with dependencies.
+
+After the Bugzillas have been created, new branches should be created
+in the relevant repositories for each Bugzilla. The branch names
+must use the following format where #### is the Bugzilla ID and
+<Brief Description> is an optional description of the change.
+
+ BZ####-<Brief Description>
+
+If multiple Bugzilla entries must coexist on a single branch, one of
+them is designated the _top-level_, with dependencies properly
+tracked. That Bugzilla is be the one naming the branch.
+
+# Source Code
+
+In order to ensure draft code does not accidentally leak into
+production use, and to signify when the changeover from draft to
+final happens, *all* new or modified[1] identifiers must be prefixed with

the relevant BZ#### identifiers.

+
+* [1] Modified in a non-backwards-compatible way. If, for example, a

statically

+ sized array is grown - this does not need to be prefixed. But a tag in a
+ comment would be *highly* recommended.
+
+## File names
+
+New public header files require the prefix (i.e.

`Bz1234MyNewProtocol.h`).

+Private header files do not need the prefix.
+
+## Contents
+
+The tagging must follow the coding style used by each affected code

base.

+Examples:
+
+| Released in spec | Draft version in tree | Comment |
+| --- | --- | --- |
+| `FunctionName` | `Bz1234FunctionName` | |
+| `HEADER_MACRO` | `BZ1234_HEADER_MACRO` | |
+
+For data structures or enums, any new or non-backwards-compatible
+structs or fields require a prefix. As above, growing an existing
+array in an existing struct requires no prefix.
+
+| Released in spec | Draft version in tree | Comment |
+| --- | --- | --- |
+| `typedef SOME_STRUCT` | `BZ1234_SOME_STRUCT` | Typedef only [2]

|

+| `StructField` | `Bz1234StructField` | In existing struct[3] |
+| `typedef SOME_ENUM` | `BZ1234_SOME_ENUM` | Typedef only [2]

|

+| `EnumValue` | `BzEnumValue` | In existing enum[3] |
+
+* [2] If the struct or enum definition is separate from the typedef in the

public

+ header, the definition does not need the prefix.
+* [3] Individual fields in newly added struct or enum do not need prefix,

the

+ struct or enum already carried the prefix.
+
+Variable prefixes indicating global scope ('g' or 'm') go before the BZ

prefix.

+
+| Released in spec | Draft version in tree | Comment |
+| --- | --- | --- |
+| `gSomeGuid` | `gBz1234SomeGuid` | |
+
+Local identifiers, including module-global ones (m-prefixed) do not
+require a BZ prefix.
--
2.21.0.windows.1

IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are
not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use
it for any purpose, or store or copy the information in any medium. Thank you.

-----Original Message-----
From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael
D Kinney via groups.io
Sent: Friday, August 7, 2020 9:07 PM
To: devel@edk2.groups.io; Kinney, Michael D
<michael.d.kinney@...>; rfc@edk2.groups.io
Cc: Laszlo Ersek <lersek@...>; Andrew Fish <afish@...>;
Leif Lindholm <leif@...>
Subject: Re: [edk2-devel] [Wiki][Patch V2] Add EDK II Code First Process
Wiki Page

A version of this Wiki page is also provided here for review:

https://github.com/mdkinney/edk2/wiki/EDK-II-Code-First-Process

Mike

-----Original Message-----
From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of

Michael

D Kinney
Sent: Friday, August 7, 2020 6:05 PM
To: devel@edk2.groups.io
Cc: Laszlo Ersek <lersek@...>; Andrew Fish <afish@...>;
Leif Lindholm <leif@...>
Subject: [edk2-devel] [Wiki][Patch V2] Add EDK II Code First Process
Wiki Page

Based on the following RFC:

https://edk2.groups.io/g/rfc/message/258

Additional updates:
* Add examples of all specifications currently maintained by
the UEFI Forums.
* Added specification change template using a CC-BY-4.0 license.
* Add source code example for an enum value
* Minor grammar updates to change from an RFC proposal to an
active process.

Cc: Laszlo Ersek <lersek@...>
Cc: Andrew Fish <afish@...>
Cc: Leif Lindholm <leif@...>
Signed-off-by: Michael D Kinney <michael.d.kinney@...>
---
EDK-II-Code-First-Process.md | 182
+++++++++++++++++++++++++++++++++++
1 file changed, 182 insertions(+)
create mode 100644 EDK-II-Code-First-Process.md

diff --git a/EDK-II-Code-First-Process.md
b/EDK-II-Code-First-Process.md new file mode 100644 index
0000000..d5c938e
--- /dev/null
+++ b/EDK-II-Code-First-Process.md
@@ -0,0 +1,182 @@
+The EDK II Code First Process is a process by which new features can
+be added to UEFI Forum specifications after first having been
+designed and prototyped in the open.
+
+This process lets changes and the development of new features happen
+in the open, without violating the UEFI forum bylaws which prevent
+publication of code for in-draft features/changes.
+
+The process does not in fact change the UEFI bylaws - the change is
+that the development (of both specification and code) happens in the
+open. The resulting specification update is then submitted to the
+appropriate working group as an Engineering Change Request (ECR), and
+voted on. For the UEFI Forum, this is a change in workflow, not a change

in process.

+
+ECRs are tracked in a UEFI Forum Mantis instance, access restricted
+to UEFI Forum Members. TianoCore enables this new process by
+providing areas on [TianoCore
+Bugzilla](https://bugzilla.tianocore.org) to track both specification
+updates and reference implementations and new repositories under

[TianoCore GitHub](https://github.com/tianocore) dedicated to hold "code
first".

+
+# TianoCore Bugzilla
+
+[TianoCore Bugzilla](bugzilla.tianocore.org) has a product categories
+for
+ * ACPI Specification
+ * UEFI Shell Specification
+ * UEFI Platform Initialization Distribution Packaging Specification
+ * UEFI Platform Initialization Specification Specification
+ * UEFI Specification
+
+Each product category has separate components for
+ * Specification
+ * Reference implementation
+
+# TianoCore GitHub
+
+Reference implementations targeting the EDK II open source project
+are held in branches in the
+[edk2-staging](https://github.com/tianocore/edk2-staging)
+repository.
+
+Additional repositories for implementing reference features in
+additional open source projects can be added in the future, as required.
+
+Specification text changes are held within the affected source
+repository, using the GitHub flavor of markdown, in a file (or split
+across several files) with .md suffix. Multiple files are required
+if changes impact multiple specifications or if the specification is
+large and is easier to maintain if the changes are split across multiple

files.

+
+* NOTE: This one may break down where we have a specification change
+affecting
+ multiple specifications, but at that point we can track it with
+multiple
+ TianoCore Bugzilla entries.
+
+## Specification Text Template
+
+The following is a template of specification text changes using the
+GitHub flavor of markdown. The title and complete description of the
+specification changes must be provided in the specification text
+along with the name and version of the specification the change
+applies. The `Status` of the specification change always starts in
+the `Draft` state and is updated based on feedback from the industry
+standard forums. The contents of the specification text are required
+to use the [Creative Commons Attribution 4.0
+International](https://spdx.org/licenses/CC-BY-4.0.html)
+license using a `SPDX-License-Identifier` statement.
+
+```
+# Title: [Must be Filled In]
+
+# Status: [Status]
+
+[Status] must be one of the following:
+* Draft
+* Submitted to industry standard forum
+* Accepted by industry standard forum
+* Accepted by industry standard forum with modifications
+* Rejected by industry standard forum
+
+# Document: [Title and Version]
+
+Here are some examples of [Title and Version]:
+* UEFI Specification Version 2.8
+* ACPI Specification Version 6.3
+* UEFI Shell Specification Version 2.2
+* UEFI Platform Initialization Specification Version 1.7
+* UEFI Platform Initialization Distribution Packaging Specification
+Version 1.1
+
+# License
+
+SPDX-License-Identifier: CC-BY-4.0
+
+# Submitter: [TianoCore Community](https://www.tianocore.org)
+
+# Summary of the change
+
+Required Section
+
+# Benefits of the change
+
+Required Section
+
+# Impact of the change
+
+Required Section
+
+# Detailed description of the change [normative updates]
+
+Required Section
+
+# Special Instructions
+
+Optional Section
+```
+
+# Intended workflow
+
+The entity initiating a specification change enters a Bugzilla in the
+appropriate area of [TianoCore Bugzilla](bugzilla.tianocore.org).
+This entry contains the outline of the change, and the full initial draft

text is attached.

+
+If multiple specification updates are interdependent, especially if
+between different specifications, then multiple Bugzilla entries should be

created.

+These Bugzilla entries *must* be linked together with dependencies.
+
+After the Bugzillas have been created, new branches should be created
+in the relevant repositories for each Bugzilla. The branch names
+must use the following format where #### is the Bugzilla ID and
+<Brief Description> is an optional description of the change.
+
+ BZ####-<Brief Description>
+
+If multiple Bugzilla entries must coexist on a single branch, one of
+them is designated the _top-level_, with dependencies properly
+tracked. That Bugzilla is be the one naming the branch.
+
+# Source Code
+
+In order to ensure draft code does not accidentally leak into
+production use, and to signify when the changeover from draft to
+final happens, *all* new or modified[1] identifiers must be prefixed with

the relevant BZ#### identifiers.

+
+* [1] Modified in a non-backwards-compatible way. If, for example, a

statically

+ sized array is grown - this does not need to be prefixed. But a tag in a
+ comment would be *highly* recommended.
+
+## File names
+
+New public header files require the prefix (i.e.

`Bz1234MyNewProtocol.h`).

+Private header files do not need the prefix.
+
+## Contents
+
+The tagging must follow the coding style used by each affected code

base.

+Examples:
+
+| Released in spec | Draft version in tree | Comment |
+| --- | --- | --- |
+| `FunctionName` | `Bz1234FunctionName` | |
+| `HEADER_MACRO` | `BZ1234_HEADER_MACRO` | |
+
+For data structures or enums, any new or non-backwards-compatible
+structs or fields require a prefix. As above, growing an existing
+array in an existing struct requires no prefix.
+
+| Released in spec | Draft version in tree | Comment |
+| --- | --- | --- |
+| `typedef SOME_STRUCT` | `BZ1234_SOME_STRUCT` | Typedef only [2]

|

+| `StructField` | `Bz1234StructField` | In existing struct[3] |
+| `typedef SOME_ENUM` | `BZ1234_SOME_ENUM` | Typedef only [2]

|

+| `EnumValue` | `BzEnumValue` | In existing enum[3] |
+
+* [2] If the struct or enum definition is separate from the typedef in the

public

+ header, the definition does not need the prefix.
+* [3] Individual fields in newly added struct or enum do not need prefix,

the

+ struct or enum already carried the prefix.
+
+Variable prefixes indicating global scope ('g' or 'm') go before the BZ

prefix.

+
+| Released in spec | Draft version in tree | Comment |
+| --- | --- | --- |
+| `gSomeGuid` | `gBz1234SomeGuid` | |
+
+Local identifiers, including module-global ones (m-prefixed) do not
+require a BZ prefix.
--
2.21.0.windows.1