Hi Maciej, Reviewed-by: Michael D Kinney <michael.d.kin...@intel.com>
I have invited you to the EDK II Staging Maintainer team that allows you to create this new branch in the edk2-staging repo. Mike > -----Original Message----- > From: Czajkowski, Maciej <maciej.czajkow...@intel.com> > Sent: Monday, November 13, 2023 7:09 AM > To: devel@edk2.groups.io > Cc: Kinney, Michael D <michael.d.kin...@intel.com> > Subject: [edk2-devel][edk2-staging] DeviceSimPkg branch creation > > Hello, > > I would like to announce DeviceSimPkg branch creation in edk2-staging > repository. > Branch will be used to develop DeviceSimPkg, a package for developing OS > executable tests > for device focused code. > > Branch owner: Maciej Czajkowski <maciej.czajkow...@intel.com>, GitHub ID: > 81293748 (https://github.com/mczaj) > > Signed-off-by: Maciej Czajkowski <maciej.czajkow...@intel.com> > Cc: Michael D Kinney <michael.d.kin...@intel.com> > --- > Readme.md | 37 +++++++++++++++++++++++++++++++++++++ > 1 file changed, 37 insertions(+) > create mode 100644 Readme.md > > diff --git a/Readme.md b/Readme.md > new file mode 100644 > index 000000000000..96077d0a478c > --- /dev/null > +++ b/Readme.md > @@ -0,0 +1,37 @@ > +# DeviceSimPkg > + > +## Introduction > + > +DeviceSimPkg is a package aimed at providing an environment to write OS- > executable unit tests for code that interacts directly with devices. > +This code is referred to as driver code below although code under test > doesn't have to follow UEFI driver model. \ > +Branch owner: Maciej Czajkowski <<maciej.czajkow...@intel.com>> > + > +## How to use it > +### Using the code > + > +You can refer to UnitTest modules to see the usage details. In general > you will need to link to package libraries (instead of the ones normally > provided by MdePkg/MdeModulePkg) and initialize your device access. > Details of initialization will vary based on which > REGISTER_ACCESS_INTERFACE implementer library you will > +choose. Please refer to corresponding libraries Readmes for details. > + > +## General architecture > + > +On high-level package consists of: > + > +* REGISTER_ACCESS_INTERFACE - interface between device model and driver > code > +* REGISTER_ACCESS_INTERFACE wrappers - libraries that wrap > REGISTER_ACCESS_INTERFACE and present it as a standard UEFI library > +* REGISTER_ACCESS_INTERFACE implementers - libraries that implement > REGISTER_ACCESS_INTERFACE interface > + > +## Wrapper libraries > + > +Currently package implements following wrappers: > + > +* IoLib in > [RegisterAccessIoLib](DeviceSimPkg/Library/RegisterAccessIoLib/Readme.md) > +* PciSegmentLib in RegisterAccessPciSegmentLib > +* PCI_IO_PROTOCOL in RegisterAccessPciIoLib > + > +## REGISTER_ACCESS_INTERFACE implementations > + > +Currently only a single implementation is fully supported - > FakeRegisterSpaceLib. Please see its Readme for more details on how to use > it. > + > +## GMOCK support > + > +DeviceSim implements Gmock based mock object for the IoLib functions. > Please see GmockIoLib [Readme](DeviceSimPkg/Library/MockIoLib//Readme.md) > for details. > -- > 2.39.1.windows.1 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#111824): https://edk2.groups.io/g/devel/message/111824 Mute This Topic: https://groups.io/mt/102563078/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/leave/9847357/21656/1706620634/xyzzy [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
