From nobody Tue May 14 02:40:17 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) client-ip=66.175.222.108; envelope-from=bounce+27952+111159+1787277+3901457@groups.io; helo=mail02.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+111159+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1699888168; cv=none; d=zohomail.com; s=zohoarc; b=MDUa9UcE4XcrddNiCBOkFoyGyxkdfhDAuq/6jeGvGirwKBHGeVudqDesFPJVnjNiNh8xdKg1XgpjAkgq75GAUPiMuPAVNV9QnB/QqOJ7rodACYeLCjkFpXNm0J0loF6GpsrwNJqO69BUQUki2GYIqxF4YvXX9b+ZRH+ZMbHmemM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1699888168; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:List-Subscribe:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:Sender:Subject:Subject:To:To:Message-Id; bh=DHRW9ZmbtWH79pMASef6On76hMty4altZy8K+uac4gE=; b=ZWQcs+3oPMOJzRIvU6zpmCiKJSfNt45aB6qsq2vlzHLbVE78f8kCc7mzpy49MI+YBo1NERU/Ef3e0g1ZF9KNS2j8qSSf3zfRdIVEP8Vj2n5IOZiv8VwyUUJBoMRR9oHl5jFeUCbtMk3pB8stlj1gw97u5Axbv2V1OWWtvN/Zmr4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+111159+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1699888168069429.21253041141847; Mon, 13 Nov 2023 07:09:28 -0800 (PST) Return-Path: DKIM-Signature: a=rsa-sha256; bh=DHRW9ZmbtWH79pMASef6On76hMty4altZy8K+uac4gE=; c=relaxed/simple; d=groups.io; h=From:To:Cc:Subject:Date:Message-Id:MIME-Version:Precedence:List-Subscribe:List-Help:Sender:List-Id:Mailing-List:Delivered-To:Reply-To:List-Unsubscribe-Post:List-Unsubscribe:Content-Type:Content-Transfer-Encoding; s=20140610; t=1699888167; v=1; b=qdGQQrpo4FfOlvKvIVJG9ExI5seHmOf3q2jPBjxteyEnTncRpS2HlVtEoOepYMzuN7YJN8nl zdMaS59EBVL0gOh8KIqZZvRvqhPPRmjwnE+SscBPdeL6b6ZG+V2uYJypGSB3Gi32C5tx45PFbuI yk5OIdSjbr6pI/vXwFgPq1lo= X-Received: by 127.0.0.2 with SMTP id 4I9cYY1788612xwTJUTSk8BF; Mon, 13 Nov 2023 07:09:27 -0800 X-Received: from mgamail.intel.com (mgamail.intel.com [134.134.136.100]) by mx.groups.io with SMTP id smtpd.web11.39172.1699888166501309351 for ; Mon, 13 Nov 2023 07:09:26 -0800 X-IronPort-AV: E=McAfee;i="6600,9927,10893"; a="456939456" X-IronPort-AV: E=Sophos;i="6.03,299,1694761200"; d="scan'208";a="456939456" X-Received: from orviesa002.jf.intel.com ([10.64.159.142]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 13 Nov 2023 07:09:25 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.03,299,1694761200"; d="scan'208";a="5489571" X-Received: from unknown (HELO mczajkow-MOBL.ger.corp.intel.com) ([10.217.180.29]) by orviesa002-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 13 Nov 2023 07:09:25 -0800 From: "Maciej Czajkowski" To: devel@edk2.groups.io Cc: Michael D Kinney Subject: [edk2-devel][edk2-staging] DeviceSimPkg branch creation Date: Mon, 13 Nov 2023 16:09:19 +0100 Message-Id: <20231113150919.1470-1-maciej.czajkowski@intel.com> MIME-Version: 1.0 Precedence: Bulk List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,maciej.czajkowski@intel.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: X-Gm-Message-State: x6uwyxye9HDDlsfek7nhf78gx1787277AA= Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1699888169559100003 Content-Type: text/plain; charset="utf-8" Hello, I would like to announce DeviceSimPkg branch creation in edk2-staging repos= itory. Branch will be used to develop DeviceSimPkg, a package for developing OS ex= ecutable tests for device focused code. Branch owner: Maciej Czajkowski , GitHub ID: 8= 1293748 (https://github.com/mczaj) Signed-off-by: Maciej Czajkowski Cc: Michael D Kinney Reviewed-by: Michael D Kinney --- 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-ex= ecutable unit tests for code that interacts directly with devices. +This code is referred to as driver code below although code under test doe= sn't have to follow UEFI driver model. \ +Branch owner: Maciej Czajkowski <> + +## 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 provi= ded by MdePkg/MdeModulePkg) and initialize your device access. Details of i= nitialization will vary based on which REGISTER_ACCESS_INTERFACE implemente= r 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 co= de +* 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 REGIST= ER_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 - FakeRegisterSp= aceLib. Please see its Readme for more details on how to use it. + +## GMOCK support + +DeviceSim implements Gmock based mock object for the IoLib functions. Plea= se see GmockIoLib [Readme](DeviceSimPkg/Library/MockIoLib//Readme.md) for d= etails. --=20 2.39.1.windows.1 --------------------------------------------------------------------- Intel Technology Poland sp. z o.o. ul. Slowackiego 173 | 80-298 Gdansk | Sad Rejonowy Gdansk Polnoc | VII Wydz= ial Gospodarczy Krajowego Rejestru Sadowego - KRS 101882 | NIP 957-07-52-31= 6 | Kapital zakladowy 200.000 PLN. Spolka oswiadcza, ze posiada status duzego przedsiebiorcy w rozumieniu usta= wy z dnia 8 marca 2013 r. o przeciwdzialaniu nadmiernym opoznieniom w trans= akcjach handlowych. Ta wiadomosc wraz z zalacznikami jest przeznaczona dla okreslonego adresata= i moze zawierac informacje poufne. W razie przypadkowego otrzymania tej wi= adomosci, prosimy o powiadomienie nadawcy oraz trwale jej usuniecie; jakiek= olwiek przegladanie lub rozpowszechnianie jest zabronione. This e-mail and any attachments may contain confidential material for the s= ole use of the intended recipient(s). If you are not the intended recipient= , please contact the sender and delete all copies; any review or distributi= on by others is strictly prohibited. -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#111159): https://edk2.groups.io/g/devel/message/111159 Mute This Topic: https://groups.io/mt/102563078/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-