From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=192.55.52.88; helo=mga01.intel.com; envelope-from=dandan.bi@intel.com; receiver=edk2-devel@lists.01.org Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 7A4332119683A for ; Sun, 9 Dec 2018 17:10:29 -0800 (PST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga007.fm.intel.com ([10.253.24.52]) by fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 09 Dec 2018 17:10:28 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.56,336,1539673200"; d="scan'208";a="106167855" Received: from fmsmsx104.amr.corp.intel.com ([10.18.124.202]) by fmsmga007.fm.intel.com with ESMTP; 09 Dec 2018 17:10:28 -0800 Received: from fmsmsx125.amr.corp.intel.com (10.18.125.40) by fmsmsx104.amr.corp.intel.com (10.18.124.202) with Microsoft SMTP Server (TLS) id 14.3.408.0; Sun, 9 Dec 2018 17:10:28 -0800 Received: from shsmsx104.ccr.corp.intel.com (10.239.4.70) by FMSMSX125.amr.corp.intel.com (10.18.125.40) with Microsoft SMTP Server (TLS) id 14.3.408.0; Sun, 9 Dec 2018 17:10:28 -0800 Received: from shsmsx102.ccr.corp.intel.com ([169.254.2.182]) by SHSMSX104.ccr.corp.intel.com ([169.254.5.203]) with mapi id 14.03.0415.000; Mon, 10 Dec 2018 09:10:26 +0800 From: "Bi, Dandan" To: "Gao, Liming" , "edk2-devel@lists.01.org" Thread-Topic: [Patch] ModuleWriteGuide: Add notes to define library instance module type Thread-Index: AQHUjE7wYQebFq9WlEeUeCdLH0+x96V3LklA Date: Mon, 10 Dec 2018 01:10:25 +0000 Message-ID: <3C0D5C461C9E904E8F62152F6274C0BB401A2D9B@shsmsx102.ccr.corp.intel.com> References: <1543982345-13708-1-git-send-email-liming.gao@intel.com> <1543982345-13708-3-git-send-email-liming.gao@intel.com> In-Reply-To: <1543982345-13708-3-git-send-email-liming.gao@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Subject: Re: [Patch] ModuleWriteGuide: Add notes to define library instance module type X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 10 Dec 2018 01:10:29 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Hi Liming, Some minor comments inline. Thanks, Dandan > -----Original Message----- > From: Gao, Liming > Sent: Wednesday, December 5, 2018 11:59 AM > To: edk2-devel@lists.01.org > Cc: Bi, Dandan > Subject: [Patch] ModuleWriteGuide: Add notes to define library instance > module type >=20 > https://bugzilla.tianocore.org/show_bug.cgi?id=3D834 > If the library instance supports the cross module types PEIM, UEFI_DIRVER= , > DXE_DRIVER. Its module type can be PEIM or UEFI_DRIVER or DXE_DRIVER. >=20 > Contributed-under: TianoCore Contribution Agreement 1.1 > Signed-off-by: Liming Gao > Cc: Bi Dandan > --- > 3_module_development/31_what_is_an_edk_ii_module.md | 2 ++ > 3_module_development/32_creating_a_module.md | 5 +++++ > 2 files changed, 7 insertions(+) >=20 > diff --git a/3_module_development/31_what_is_an_edk_ii_module.md > b/3_module_development/31_what_is_an_edk_ii_module.md > index ace8d53..9f0fe8d 100644 > --- a/3_module_development/31_what_is_an_edk_ii_module.md > +++ b/3_module_development/31_what_is_an_edk_ii_module.md > @@ -78,6 +78,8 @@ EDK II defines many module types. The module type is > used to: > example, a PEIM/DXE_DRIVER type module can have "depex" section in .ef= i > binary image; a UEFI_DRIVER can have .ui or .ver section in .efi binar= y image; >=20 > +* Indicate EntryPoint() or Constructor() API for different types of modu= les. How about "Indicate different prototypes of EntryPoint() or Constructor() = API for different types of modules"? > + > * Indicate the suitable library instance for different types of modules.= A > library instance will point out what module types are supported in INF= file. >=20 > diff --git a/3_module_development/32_creating_a_module.md > b/3_module_development/32_creating_a_module.md > index 65a4ac7..325156f 100644 > --- a/3_module_development/32_creating_a_module.md > +++ b/3_module_development/32_creating_a_module.md > @@ -197,6 +197,11 @@ instance: > DebugLib > ``` >=20 > +Note: if the library supports the cross module types PEIM, UEFI_DIRVER, > DXE_DRIVER. > +Its module type can be PEIM or UEFI_DRIVER or DXE_DRIVER. If it has the > +library constructor, its module type must be BASE. BASE type library > +constructor has no the input parameter that can link to the cross driver > types. How about "BASE type library constructor has no input parameter that can be= linked to any type of cross driver"? If you agree the updates, please update them before commit, not require V2= patch. > + > ### 3.2.3 Adding a Package Dependency >=20 > The [Packages] section of the INF file describes all packages dependenci= es of > -- > 2.13.0.windows.1