[edk2-devel] Resources for Creating Packages

[edk2-devel] Resources for Creating Packages

[ryderkeys via groups.io]

Hello,

(Originally sent to edk2 discuss but it looks like my message has been stuck in moderation for a week, so I thought I would try here instead.)

I am new to UEFI and trying to learn how to use EDK 2. I have been able to build EmulatorPkg with stuart but I had a couple questions on where to go from here. I was hoping someone might be able to give some guidance or pointers. Any help is much appreciated.

1. How can I build a UEFI application with a new package? I see the https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-Writing-Simple-Application suggests to edit an existing package DSC file with the INF file for my module. Which works fine. But where would I begin if I wanted to create my own package without commandeering the build for an already existing package? Would I just have to create a DSC file on my own? Is there a resource I can read on how to create new packages with EDK 2, or is this not the recommended way to get started building applications?

2. What exactly is in MdeModulePkg? I just noticed it has a similar name to MdePkg and wondered what the difference between the two was. The wiki (https://github.com/tianocore/tianocore.github.io/wiki/MdeModulePkg) says "This package provides the modules that conform to UEFI/PI Industry standards. It also provides the defintions(including PPIs/PROTOCOLs/GUIDs and library classes) and libraries instances, which are used for those modules." but I'm not completely sure what this means. Is someone able to elaborate?

Thank you,
Ryder


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#114143): https://edk2.groups.io/g/devel/message/114143
Mute This Topic: https://groups.io/mt/103892486/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] Resources for Creating Packages

[Michael D Kinney]

> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of ryderkeys
> via groups.io
> Sent: Monday, January 22, 2024 10:25 AM
> To: devel@edk2.groups.io
> Subject: [edk2-devel] Resources for Creating Packages
> 
> Hello,
> 
> (Originally sent to edk2 discuss but it looks like my message has been
> stuck in moderation for a week, so I thought I would try here instead.)
> 
> I am new to UEFI and trying to learn how to use EDK 2. I have been able
> to build EmulatorPkg with stuart but I had a couple questions on where
> to go from here. I was hoping someone might be able to give some
> guidance or pointers. Any help is much appreciated.
> 
> 1. How can I build a UEFI application with a new package? I see the
> https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-
> Writing-Simple-Application suggests to edit an existing package DSC file
> with the INF file for my module. Which works fine. But where would I
> begin if I wanted to create my own package without commandeering the
> build for an already existing package? Would I just have to create a DSC
> file on my own? Is there a resource I can read on how to create new
> packages with EDK 2, or is this not the recommended way to get started
> building applications?

There are some detailed instructions in the following document that is
focused on writing UEFI Drivers, but the instructions apply equally well
to UEFI Applications.  Look at the "Building UEFI Drivers" chapter.

* https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draft/edk2-UefiDriverWritersGuide-draft.pdf
* https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draft/
* https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draft/30_building_uefi_drivers/#30-building-uefi-drivers

There is also a wizard to help with creating packages and libraries:

* https://github.com/tianocore/tianocore.github.io/wiki/UEFI-Driver-Wizard

> 
> 2. What exactly is in MdeModulePkg? I just noticed it has a similar name
> to MdePkg and wondered what the difference between the two was. The wiki
> (https://github.com/tianocore/tianocore.github.io/wiki/MdeModulePkg)
> says "This package provides the modules that conform to UEFI/PI Industry
> standards. It also provides the defintions(including
> PPIs/PROTOCOLs/GUIDs and library classes) and libraries instances, which
> are used for those modules." but I'm not completely sure what this
> means. Is someone able to elaborate?

* MdePkg is include files and libraries for Industry Standard/Pubic specifications
* MdeModulePkg is module implementations that only depend on includes from MdePkg
  and any EDK II specific extensions defined in MdeModulePkg. 

> 
> Thank you,
> Ryder
> 
> 
> 
> 



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#114237): https://edk2.groups.io/g/devel/message/114237
Mute This Topic: https://groups.io/mt/103892486/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/12367111/7686176/1913456212/xyzzy [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] Resources for Creating Packages

[Laszlo Ersek]

meta (CC Mike):

On 1/22/24 19:25, ryderkeys via groups.io wrote:
> (Originally sent to edk2 discuss but it looks like my message has
> been stuck in moderation for a week, so I thought I would try here
> instead.)

I'm now checking the moderation queue for edk2-discuss; I seem to have
found your original message there. I'll allow it through in a minute.

Problem: moderators don't get email notifications from groups.io about
new items to moderate. (I certainly don't.) Other mailing list software
tends to send out 1 reminder message per day, IIRC (e.g. Mailman2). This
effectively requires moderators to check the WebUI daily, which is very
annoying -- most of the time, there is nothing to moderate (or just junk
mail to delete), so a daily check is a waste of time.

Problem: on the actual WebUI, a few minutes ago I opened the Pending
box, and it showed me 3 (three) messages. All of those were pending
moderation for edk2-devel. I deleted them (they were all spam), and
logged out. I have now logged back in, and am seeing 8 (eight) messages
pending moderation -- this time for edk2-discuss. The issue is that the
WebUI does not show a *summary* page to moderators -- I happen to be a
moderator for 4 edk2 lists (devel, announce, discuss, rfc), and for
covering all of those, I need to separately select *each list* first,
and then check for pending items. In other words, multiply the annoyance
described in the prior paragraph by four. :/

So, sorry about the delay. This is very easy to miss. Until 2021,
checking all four moderation queues had been part of my daily (morning)
routine, but since then, I've forgotten about it.

Laszlo



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#114293): https://edk2.groups.io/g/devel/message/114293
Mute This Topic: https://groups.io/mt/103892486/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/12367111/7686176/1913456212/xyzzy [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] Resources for Creating Packages

[ryderkeys via groups.io]

On Wednesday, January 24th, 2024 at 8:30 AM, Laszlo Ersek <lersek@redhat.com> wrote:

> meta (CC Mike):
> 
> On 1/22/24 19:25, ryderkeys via groups.io wrote:
> 
> > (Originally sent to edk2 discuss but it looks like my message has
> > been stuck in moderation for a week, so I thought I would try here
> > instead.)
> 
> 
> I'm now checking the moderation queue for edk2-discuss; I seem to have
> found your original message there. I'll allow it through in a minute.
> 
> Problem: moderators don't get email notifications from groups.io about
> new items to moderate. (I certainly don't.) Other mailing list software
> tends to send out 1 reminder message per day, IIRC (e.g. Mailman2). This
> effectively requires moderators to check the WebUI daily, which is very
> annoying -- most of the time, there is nothing to moderate (or just junk
> mail to delete), so a daily check is a waste of time.
> 
> Problem: on the actual WebUI, a few minutes ago I opened the Pending
> box, and it showed me 3 (three) messages. All of those were pending
> moderation for edk2-devel. I deleted them (they were all spam), and
> logged out. I have now logged back in, and am seeing 8 (eight) messages
> pending moderation -- this time for edk2-discuss. The issue is that the
> WebUI does not show a summary page to moderators -- I happen to be a
> moderator for 4 edk2 lists (devel, announce, discuss, rfc), and for
> covering all of those, I need to separately select each list first,
> and then check for pending items. In other words, multiply the annoyance
> described in the prior paragraph by four. :/
> 
> So, sorry about the delay. This is very easy to miss. Until 2021,
> checking all four moderation queues had been part of my daily (morning)
> routine, but since then, I've forgotten about it.
> 
> Laszlo

Hi Michael and Laszlo,

Thank you for help and the links. A document like that was exactly the sort of thing I was looking for, and it was very helpful!

Re: Laszlo thanks for approving the message. I can try my best to pay the help forward. I think https://groups.io/helpcenter/ownersmanual/1/managing-moderator-notifications-about-group-activity/controlling-moderator-notifications-for-individual-groups has some instructions on how to enable email notifications.

Thanks again,
Ryder


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#114731): https://edk2.groups.io/g/devel/message/114731
Mute This Topic: https://groups.io/mt/103892486/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] Resources for Creating Packages

[Laszlo Ersek]

On 1/29/24 19:55, ryderkeys wrote:
> On Wednesday, January 24th, 2024 at 8:30 AM, Laszlo Ersek <lersek@redhat.com> wrote:
> 
>> meta (CC Mike):
>>
>> On 1/22/24 19:25, ryderkeys via groups.io wrote:
>>
>>> (Originally sent to edk2 discuss but it looks like my message has
>>> been stuck in moderation for a week, so I thought I would try here
>>> instead.)
>>
>>
>> I'm now checking the moderation queue for edk2-discuss; I seem to have
>> found your original message there. I'll allow it through in a minute.
>>
>> Problem: moderators don't get email notifications from groups.io about
>> new items to moderate. (I certainly don't.) Other mailing list software
>> tends to send out 1 reminder message per day, IIRC (e.g. Mailman2). This
>> effectively requires moderators to check the WebUI daily, which is very
>> annoying -- most of the time, there is nothing to moderate (or just junk
>> mail to delete), so a daily check is a waste of time.
>>
>> Problem: on the actual WebUI, a few minutes ago I opened the Pending
>> box, and it showed me 3 (three) messages. All of those were pending
>> moderation for edk2-devel. I deleted them (they were all spam), and
>> logged out. I have now logged back in, and am seeing 8 (eight) messages
>> pending moderation -- this time for edk2-discuss. The issue is that the
>> WebUI does not show a summary page to moderators -- I happen to be a
>> moderator for 4 edk2 lists (devel, announce, discuss, rfc), and for
>> covering all of those, I need to separately select each list first,
>> and then check for pending items. In other words, multiply the annoyance
>> described in the prior paragraph by four. :/
>>
>> So, sorry about the delay. This is very easy to miss. Until 2021,
>> checking all four moderation queues had been part of my daily (morning)
>> routine, but since then, I've forgotten about it.
>>
>> Laszlo
> 
> Hi Michael and Laszlo,
> 
> Thank you for help and the links. A document like that was exactly the sort of thing I was looking for, and it was very helpful!
> 
> Re: Laszlo thanks for approving the message. I can try my best to pay the help forward. I think https://groups.io/helpcenter/ownersmanual/1/managing-moderator-notifications-about-group-activity/controlling-moderator-notifications-for-individual-groups has some instructions on how to enable email notifications.

Awesome, thanks! That did the trick!
Laszlo



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#114794): https://edk2.groups.io/g/devel/message/114794
Mute This Topic: https://groups.io/mt/103892486/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/12367111/7686176/1913456212/xyzzy [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-