-----Original Message-----
From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Leif
Lindholm via groups.io
Sent: Thursday, June 15, 2023 12:13 AM
To: devel@edk2.groups.io; Chang, Abner <abner.ch...@amd.com>
Cc: Michael D Kinney <michael.d.kin...@intel.com>; Attar, AbdulLateef
(Abdul Lateef) <abdullateef.at...@amd.com>; Xing, Eric
<eric.x...@amd.com>; He, Jiangang <jiangang...@amd.com>
Subject: Re: [edk2-devel] [edk2-platforms][PATCH] edk2-platform: Add
Readme under Platform\AMD
Caution: This message originated from an External Source. Use proper caution
when opening attachments, clicking links, or responding.
On 2023-06-14 05:22, Chang, Abner via groups.io wrote:
From: Abner Chang <abner.ch...@amd.com>
For AMD edk2 opensource project and the needs
of opensource AMD platform common modules those can
be leverage across AMD business units, AMD server,
client and S3 (silicon strategic solution) BUs
have the consensus to propose AMD as the maintainer
of Platform/AMD folder. The folder and edk2 package
structure under Platform/AMD is defined in the
Readme for the further upstream works.
We still leave the existing maintainers for
AMD OverdriveBoard which is no conflicts with this
change.
Signed-off-by: Abner Chang <abner.ch...@amd.com>
Cc: Leif Lindholm <quic_llind...@quicinc.com>
Cc: Michael D Kinney <michael.d.kin...@intel.com>
Cc: Abdul Lateef Attar <abdat...@amd.com>
Cc: Eric Xing <eric.x...@amd.com>
Cc: Jiangang He <jiangang...@amd.com>
---
Platform/AMD/Readme.md | 85
++++++++++++++++++++++++++++++++++++++++++
Maintainers.txt | 10 ++---
2 files changed, 90 insertions(+), 5 deletions(-)
create mode 100644 Platform/AMD/Readme.md
diff --git a/Platform/AMD/Readme.md b/Platform/AMD/Readme.md
new file mode 100644
index 0000000000..f39b8140f5
--- /dev/null
+++ b/Platform/AMD/Readme.md
@@ -0,0 +1,85 @@
+# AMD EDK2 Platform
+
+This is AMD folder that provides the edk2 modules to support AMD edk2
firmware
+solution for the server, client (e.g., Notebook) and S3 (Strategic Silicon
Solutions)
+platforms. The board packages under this folder are the firmware reference
code for
+booting certain AMD platforms. The definition of sub-folders is described in
below sections.
+
+## Term and Definitions
+
+* **AMD Platform** (platform in short)
+
+ AMD platform refers to a platform that supports the particular AMD SoC
(processor), such as AMD EPYC Milan and Genoa processors.
+
+* **AMD Board** (board in short)
+
+ AMD board is a generic terminology refers to a board that is designed
based on a
+ specific AMD SoC architecture (also referred as AMD platform). More than
one boards
+ are possibly designed to support an AMD platform with different
configuration, such as 1-processor socket or 2-processor sockets board.
+
+* **AMD edk2 Platform Package** (platform package in short)
+
+ The folder has the AMD edk2 platform common modules.
+
+* **AMD edk2 Board Package** (board package in short)
+
+ The folder has the edk2 meta files to build the necessary edk2 firmware
modules
+ and generate the binary to run on a board.
+
+## Package Definition
+
+* **AmdPlatformPkg**
+
+ AMD platform edk2 package under this folder provides the common edk2
modules those
+ are leverage by platforms. Usually those modules have no dependencies
with
+ particular platforms. The module under this scope can provides a common
implementation
+ for all platforms, or it may just provide a framework but the differences of
implementation could be configured through the PCDs declared in
AmdPlatformPkg.dec, or
+ the board level library provided in the \<Board name\>Pkg.
+
+* **AmdMinBoardPkg**
+
+ This package provides the common edk2 modules those can be leverage
across AMD boards those use MinPlatformPkg framework.
+
+* **\<SoC name\>Board**
+
+ This is the folder named by SoC and accommodate one or multiple board
packages those
+ are designed base on the same SoC platform. <SoC name>Board folder
may contain edk2
+ package meta files directly or the sub-folders named by \<Board
name\>Pkg for a
+ variety configurations of a platform.
+
+* **<Board name\>Pkg**
+
+ This is the folder that contains edk2 package meta files for a board which is
designed base on a platform. Besides the edk2 meta files, <Board name\>Pkg
may also provides
+ edk2 modules which are specifically to a board.
+
+ ```
+ e.g. OverdriveBoard
+ e.g. GenoaBoard
+ |------Board1Pkg
+ |------Board2Pkg
+ ```
+
+ Below is the outline of folder structure under Platform/AMD
+
+ ```
+ Platform/AMD
+ |----AmdPlatformPkg
+ |----AmdMinBoardPkg
+ |----OverdriveBoard
+ |----GenoaBoard
+ | |------Common Modules for Genoa boards
+ | |------Board1Pkg
+ | | |-------Board specific modules
+ | |------Board2Pkg
+ |
+ |----NextGenBoard
+ |------Common Modules for the next generation
+ platform boards
+ |------Board1Pkg
+ |------Board2Pkg
+ |-------Board specific modules
+ ```
+
+
+## Board Support
+Under progress
\ No newline at end of file
*cough* ^
