public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* [edk2-platforms][PATCH] edk2-platform: Add Readme under Platform\AMD
@ 2023-06-14  4:22 Chang, Abner
  2023-06-14 16:13 ` [edk2-devel] " Leif Lindholm
  0 siblings, 1 reply; 5+ messages in thread
From: Chang, Abner @ 2023-06-14  4:22 UTC (permalink / raw)
  To: devel
  Cc: Leif Lindholm, Michael D Kinney, Abdul Lateef Attar, Eric Xing,
	Jiangang He

From: Abner Chang <abner.chang@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.chang@amd.com>
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Abdul Lateef Attar <abdattar@amd.com>
Cc: Eric Xing <eric.xing@amd.com>
Cc: Jiangang He <jiangang.he@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
diff --git a/Maintainers.txt b/Maintainers.txt
index 020c72677a..d1d7613ef4 100644
--- a/Maintainers.txt
+++ b/Maintainers.txt
@@ -83,6 +83,11 @@ F: Platform/96Boards/
 M: Ard Biesheuvel <ardb+tianocore@kernel.org>
 M: Leif Lindholm <quic_llindhol@quicinc.com>
 
+AMD
+F: Platform/AMD
+M: Abner Chang <abner.chang@amd.com>
+M: Abdul Lateef Attar <abdattar@amd.com>
+
 AMD Seattle
 F: Platform/AMD/OverdriveBoard/
 F: Platform/LeMaker/CelloBoard/
@@ -91,11 +96,6 @@ F: Silicon/AMD/Styx/
 M: Ard Biesheuvel <ardb+tianocore@kernel.org>
 M: Leif Lindholm <quic_llindhol@quicinc.com>
 
-AMD MinBoard package for MinPlatformPkg
-F: Platform/AMD/AmdMinBoardPkg
-M: Abner Chang <abner.chang@amd.com>
-M: Abdul Lateef Attar <abdattar@amd.com>
-
 Ampere Computing
 F: Platform/Ampere
 F: Silicon/Ampere
-- 
2.37.1.windows.1


^ permalink raw reply related	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2023-06-15 15:25 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-06-14  4:22 [edk2-platforms][PATCH] edk2-platform: Add Readme under Platform\AMD Chang, Abner
2023-06-14 16:13 ` [edk2-devel] " Leif Lindholm
2023-06-14 17:57   ` Chang, Abner
2023-06-15 15:17     ` Leif Lindholm
2023-06-15 15:25       ` Chang, Abner

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox