public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: Liming Gao <liming.gao@intel.com>
To: edk2-devel@lists.01.org
Cc: Bi Dandan <dandan.bi@intel.com>
Subject: [Patch] ModuleWriteGuide: Add notes to define library instance module type
Date: Wed,  5 Dec 2018 11:59:04 +0800	[thread overview]
Message-ID: <1543982345-13708-3-git-send-email-liming.gao@intel.com> (raw)
In-Reply-To: <1543982345-13708-1-git-send-email-liming.gao@intel.com>

https://bugzilla.tianocore.org/show_bug.cgi?id=834
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.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Liming Gao <liming.gao@intel.com>
Cc: Bi Dandan <dandan.bi@intel.com>
---
 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(+)

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 .efi
   binary image; a UEFI_DRIVER can have .ui or .ver section in .efi binary image;
 
+* Indicate 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.
 
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
 ```
 
+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.
+
 ### 3.2.3 Adding a Package Dependency
 
 The [Packages] section of the INF file describes all packages dependencies of
-- 
2.13.0.windows.1



  parent reply	other threads:[~2018-12-05  3:59 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-12-05  3:59 [Patch] edk2 DecSpec: Support the syntax of the structure array for structure PCD Liming Gao
2018-12-05  3:59 ` [Patch] edk2 Dscspec: Add the syntax to initialize structure PCD with C style value Liming Gao
2018-12-05  3:59 ` Liming Gao [this message]
2018-12-10  1:10   ` [Patch] ModuleWriteGuide: Add notes to define library instance module type Bi, Dandan
2018-12-10  1:44     ` Gao, Liming
2018-12-05  3:59 ` [Patch] Update edk2-stable201903 tag planning with Remove DuetPkg Liming Gao
2018-12-18 10:08 ` [Patch] edk2 DecSpec: Support the syntax of the structure array for structure PCD Feng, Bob C

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1543982345-13708-3-git-send-email-liming.gao@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox