mb/google: order matters in mem_parts_used.txt

* Add comments to mem_parts_used.txt to point out that the order of
the entries matters when assigning IDs, so always add a new part
to the end of the file.
* Update existing mem_parts_used.txt to add the same comment.
* No updates to Zork variants, because they use an optional ID, so
the order actually doesn't matter there.

BUG=b:175898902
TEST=create a new variant of dalboz, trembyle, volteer, waddledee,
or waddledoo, and observe that mem_parts_used.txt has the new
verbiage.

Signed-off-by: Paul Fagerburg <pfagerburg@google.com>
Change-Id: Iffbd8e69a89b1b7c810c5d25c7a6148d459d8b02
Reviewed-on: https://review.coreboot.org/c/coreboot/+/50449
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Martin Roth <martinroth@google.com>
Reviewed-by: Rob Barnes <robbarnes@google.com>

14 files changed, 124 insertions, 14 deletions

diff --git a/src/mainboard/google/dedede/variants/galtic/memory/mem_parts_used.txt b/src/mainboard/google/dedede/variants/galtic/memory/mem_parts_used.txt
index 9fae769262..12da3154e2 100644
--- a/src/mainboard/google/dedede/variants/galtic/memory/mem_parts_used.txt
+++ b/src/mainboard/google/dedede/variants/galtic/memory/mem_parts_used.txt
@@ -1,7 +1,12 @@
 # This is a CSV file containing a list of memory parts used by this variant.
+# One part per line with an optional fixed ID in column 2.
+# Only include a fixed ID if it is required for legacy reasons!
+# Generated IDs are dependent on the order of parts in this file,
+# so new parts must always be added at the end of the file!
+#
 # Generate an updated Makefile.inc and dram_id.generated.txt by running the
-# gen_part_id tool from util/spd_tools/lp4x
-# See util/spd_tools/lp4x/README.md for more details and instructions.
+# gen_part_id tool from util/spd_tools/{ddr4,lp4x}.
+# See util/spd_tools/{ddr4,lp4x}/README.md for more details and instructions.
 
 # Part Name
 H9HCNNNBKMMLXR-NEE, 0
diff --git a/src/mainboard/google/dedede/variants/kracko/memory/mem_parts_used.txt b/src/mainboard/google/dedede/variants/kracko/memory/mem_parts_used.txt
index 26c06b6f40..1bcd3daf70 100644
--- a/src/mainboard/google/dedede/variants/kracko/memory/mem_parts_used.txt
+++ b/src/mainboard/google/dedede/variants/kracko/memory/mem_parts_used.txt
@@ -1,3 +1,14 @@
+# This is a CSV file containing a list of memory parts used by this variant.
+# One part per line with an optional fixed ID in column 2.
+# Only include a fixed ID if it is required for legacy reasons!
+# Generated IDs are dependent on the order of parts in this file,
+# so new parts must always be added at the end of the file!
+#
+# Generate an updated Makefile.inc and dram_id.generated.txt by running the
+# gen_part_id tool from util/spd_tools/{ddr4,lp4x}.
+# See util/spd_tools/{ddr4,lp4x}/README.md for more details and instructions.
+
+# Part Name
 MT53E512M32D2NP-046 WT:E
 H9HCNNNBKMMLXR-NEE
 K4U6E3S4AA-MGCR
diff --git a/src/mainboard/google/dedede/variants/lantis/memory/mem_parts_used.txt b/src/mainboard/google/dedede/variants/lantis/memory/mem_parts_used.txt
index 26c06b6f40..1bcd3daf70 100644
--- a/src/mainboard/google/dedede/variants/lantis/memory/mem_parts_used.txt
+++ b/src/mainboard/google/dedede/variants/lantis/memory/mem_parts_used.txt
@@ -1,3 +1,14 @@
+# This is a CSV file containing a list of memory parts used by this variant.
+# One part per line with an optional fixed ID in column 2.
+# Only include a fixed ID if it is required for legacy reasons!
+# Generated IDs are dependent on the order of parts in this file,
+# so new parts must always be added at the end of the file!
+#
+# Generate an updated Makefile.inc and dram_id.generated.txt by running the
+# gen_part_id tool from util/spd_tools/{ddr4,lp4x}.
+# See util/spd_tools/{ddr4,lp4x}/README.md for more details and instructions.
+
+# Part Name
 MT53E512M32D2NP-046 WT:E
 H9HCNNNBKMMLXR-NEE
 K4U6E3S4AA-MGCR
diff --git a/src/mainboard/google/dedede/variants/metaknight/memory/mem_parts_used.txt b/src/mainboard/google/dedede/variants/metaknight/memory/mem_parts_used.txt
index f05a5af118..8ebc665102 100644
--- a/src/mainboard/google/dedede/variants/metaknight/memory/mem_parts_used.txt
+++ b/src/mainboard/google/dedede/variants/metaknight/memory/mem_parts_used.txt
@@ -1,3 +1,14 @@
+# This is a CSV file containing a list of memory parts used by this variant.
+# One part per line with an optional fixed ID in column 2.
+# Only include a fixed ID if it is required for legacy reasons!
+# Generated IDs are dependent on the order of parts in this file,
+# so new parts must always be added at the end of the file!
+#
+# Generate an updated Makefile.inc and dram_id.generated.txt by running the
+# gen_part_id tool from util/spd_tools/{ddr4,lp4x}.
+# See util/spd_tools/{ddr4,lp4x}/README.md for more details and instructions.
+
+# Part Name
 MT53E512M32D2NP-046 WT:E
 K4U6E3S4AA-MGCR
 H9HCNNNBKMMLXR-NEE
diff --git a/src/mainboard/google/dedede/variants/sasuke/memory/mem_parts_used.txt b/src/mainboard/google/dedede/variants/sasuke/memory/mem_parts_used.txt
index e916160610..68284458e5 100644
--- a/src/mainboard/google/dedede/variants/sasuke/memory/mem_parts_used.txt
+++ b/src/mainboard/google/dedede/variants/sasuke/memory/mem_parts_used.txt
@@ -1 +1,12 @@
+# This is a CSV file containing a list of memory parts used by this variant.
+# One part per line with an optional fixed ID in column 2.
+# Only include a fixed ID if it is required for legacy reasons!
+# Generated IDs are dependent on the order of parts in this file,
+# so new parts must always be added at the end of the file!
+#
+# Generate an updated Makefile.inc and dram_id.generated.txt by running the
+# gen_part_id tool from util/spd_tools/{ddr4,lp4x}.
+# See util/spd_tools/{ddr4,lp4x}/README.md for more details and instructions.
+
+# Part Name
 K4U6E3S4AA-MGCR
diff --git a/src/mainboard/google/dedede/variants/sasukette/memory/mem_parts_used.txt b/src/mainboard/google/dedede/variants/sasukette/memory/mem_parts_used.txt
index e916160610..68284458e5 100644
--- a/src/mainboard/google/dedede/variants/sasukette/memory/mem_parts_used.txt
+++ b/src/mainboard/google/dedede/variants/sasukette/memory/mem_parts_used.txt
@@ -1 +1,12 @@
+# This is a CSV file containing a list of memory parts used by this variant.
+# One part per line with an optional fixed ID in column 2.
+# Only include a fixed ID if it is required for legacy reasons!
+# Generated IDs are dependent on the order of parts in this file,
+# so new parts must always be added at the end of the file!
+#
+# Generate an updated Makefile.inc and dram_id.generated.txt by running the
+# gen_part_id tool from util/spd_tools/{ddr4,lp4x}.
+# See util/spd_tools/{ddr4,lp4x}/README.md for more details and instructions.
+
+# Part Name
 K4U6E3S4AA-MGCR
diff --git a/src/mainboard/google/dedede/variants/storo/memory/mem_parts_used.txt b/src/mainboard/google/dedede/variants/storo/memory/mem_parts_used.txt
index 43363e7e0d..90fc109fbb 100644
--- a/src/mainboard/google/dedede/variants/storo/memory/mem_parts_used.txt
+++ b/src/mainboard/google/dedede/variants/storo/memory/mem_parts_used.txt
@@ -1,3 +1,14 @@
+# This is a CSV file containing a list of memory parts used by this variant.
+# One part per line with an optional fixed ID in column 2.
+# Only include a fixed ID if it is required for legacy reasons!
+# Generated IDs are dependent on the order of parts in this file,
+# so new parts must always be added at the end of the file!
+#
+# Generate an updated Makefile.inc and dram_id.generated.txt by running the
+# gen_part_id tool from util/spd_tools/{ddr4,lp4x}.
+# See util/spd_tools/{ddr4,lp4x}/README.md for more details and instructions.
+
+# Part Name
 MT53E512M32D2NP-046 WT:E
 H9HCNNNBKMMLXR-NEE
 MT53E1G32D2NP-046 WT:A
diff --git a/src/mainboard/google/volteer/variants/copano/memory/mem_parts_used.txt b/src/mainboard/google/volteer/variants/copano/memory/mem_parts_used.txt
index f51b3af398..e4258b530d 100644
--- a/src/mainboard/google/volteer/variants/copano/memory/mem_parts_used.txt
+++ b/src/mainboard/google/volteer/variants/copano/memory/mem_parts_used.txt
@@ -1,4 +1,11 @@
 # This is a CSV file containing a list of memory parts used by this variant.
+# One part per line with an optional fixed ID in column 2.
+# Only include a fixed ID if it is required for legacy reasons!
+# Generated IDs are dependent on the order of parts in this file,
+# so new parts must always be added at the end of the file!
+#
 # Generate an updated Makefile.inc and dram_id.generated.txt by running the
-# gen_part_id tool from util/spd_tools/ddr4 or util/spd_tools/lp4x
+# gen_part_id tool from util/spd_tools/{ddr4,lp4x}.
 # See util/spd_tools/{ddr4,lp4x}/README.md for more details and instructions.
+
+# Part Name
diff --git a/src/mainboard/google/volteer/variants/voema/memory/mem_parts_used.txt b/src/mainboard/google/volteer/variants/voema/memory/mem_parts_used.txt
index c74fe433ba..76eab92b35 100644
--- a/src/mainboard/google/volteer/variants/voema/memory/mem_parts_used.txt
+++ b/src/mainboard/google/volteer/variants/voema/memory/mem_parts_used.txt
@@ -1,3 +1,14 @@
+# This is a CSV file containing a list of memory parts used by this variant.
+# One part per line with an optional fixed ID in column 2.
+# Only include a fixed ID if it is required for legacy reasons!
+# Generated IDs are dependent on the order of parts in this file,
+# so new parts must always be added at the end of the file!
+#
+# Generate an updated Makefile.inc and dram_id.generated.txt by running the
+# gen_part_id tool from util/spd_tools/{ddr4,lp4x}.
+# See util/spd_tools/{ddr4,lp4x}/README.md for more details and instructions.
+
+# Part Name
 MT53E512M64D4NW-046 WT:E
 MT53E1G64D8NW-046 WT:E
 H9HCNNNCRMBLPR-NEE
diff --git a/util/mainboard/google/dalboz/template/spd/mem_parts_used.txt b/util/mainboard/google/dalboz/template/spd/mem_parts_used.txt
index 106a705a36..8124e4f7ed 100644
--- a/util/mainboard/google/dalboz/template/spd/mem_parts_used.txt
+++ b/util/mainboard/google/dalboz/template/spd/mem_parts_used.txt
@@ -1,9 +1,11 @@
 # This is a CSV file containing a list of memory parts used by this variant.
 # One part per line with an optional fixed ID in column 2.
 # Only include a fixed ID if it is required for legacy reasons!
-# Each part must also be listed in util/spd_tools/ddr4/global_ddr4_mem_parts.json.txt.
+# Generated IDs are dependent on the order of parts in this file,
+# so new parts must always be added at the end of the file!
+#
 # Generate an updated Makefile.inc and dram_id.generated.txt by running the
-# gen_part_id tool from util/spd_tools/ddr4.
-# See util/spd_tools/ddr4/README.md for more details and instructions.
+# gen_part_id tool from util/spd_tools/{ddr4,lp4x}.
+# See util/spd_tools/{ddr4,lp4x}/README.md for more details and instructions.
 
 # Part Name, Fixed ID (optional)
diff --git a/util/mainboard/google/trembyle/template/spd/mem_parts_used.txt b/util/mainboard/google/trembyle/template/spd/mem_parts_used.txt
index 106a705a36..8124e4f7ed 100644
--- a/util/mainboard/google/trembyle/template/spd/mem_parts_used.txt
+++ b/util/mainboard/google/trembyle/template/spd/mem_parts_used.txt
@@ -1,9 +1,11 @@
 # This is a CSV file containing a list of memory parts used by this variant.
 # One part per line with an optional fixed ID in column 2.
 # Only include a fixed ID if it is required for legacy reasons!
-# Each part must also be listed in util/spd_tools/ddr4/global_ddr4_mem_parts.json.txt.
+# Generated IDs are dependent on the order of parts in this file,
+# so new parts must always be added at the end of the file!
+#
 # Generate an updated Makefile.inc and dram_id.generated.txt by running the
-# gen_part_id tool from util/spd_tools/ddr4.
-# See util/spd_tools/ddr4/README.md for more details and instructions.
+# gen_part_id tool from util/spd_tools/{ddr4,lp4x}.
+# See util/spd_tools/{ddr4,lp4x}/README.md for more details and instructions.
 
 # Part Name, Fixed ID (optional)
diff --git a/util/mainboard/google/volteer/template/memory/mem_parts_used.txt b/util/mainboard/google/volteer/template/memory/mem_parts_used.txt
index f51b3af398..e4258b530d 100644
--- a/util/mainboard/google/volteer/template/memory/mem_parts_used.txt
+++ b/util/mainboard/google/volteer/template/memory/mem_parts_used.txt
@@ -1,4 +1,11 @@
 # This is a CSV file containing a list of memory parts used by this variant.
+# One part per line with an optional fixed ID in column 2.
+# Only include a fixed ID if it is required for legacy reasons!
+# Generated IDs are dependent on the order of parts in this file,
+# so new parts must always be added at the end of the file!
+#
 # Generate an updated Makefile.inc and dram_id.generated.txt by running the
-# gen_part_id tool from util/spd_tools/ddr4 or util/spd_tools/lp4x
+# gen_part_id tool from util/spd_tools/{ddr4,lp4x}.
 # See util/spd_tools/{ddr4,lp4x}/README.md for more details and instructions.
+
+# Part Name
diff --git a/util/mainboard/google/waddledee/template/memory/mem_parts_used.txt b/util/mainboard/google/waddledee/template/memory/mem_parts_used.txt
index 59381dcf5b..e4258b530d 100644
--- a/util/mainboard/google/waddledee/template/memory/mem_parts_used.txt
+++ b/util/mainboard/google/waddledee/template/memory/mem_parts_used.txt
@@ -1,6 +1,11 @@
 # This is a CSV file containing a list of memory parts used by this variant.
+# One part per line with an optional fixed ID in column 2.
+# Only include a fixed ID if it is required for legacy reasons!
+# Generated IDs are dependent on the order of parts in this file,
+# so new parts must always be added at the end of the file!
+#
 # Generate an updated Makefile.inc and dram_id.generated.txt by running the
-# gen_part_id tool from util/spd_tools/lp4x
-# See util/spd_tools/lp4x/README.md for more details and instructions.
+# gen_part_id tool from util/spd_tools/{ddr4,lp4x}.
+# See util/spd_tools/{ddr4,lp4x}/README.md for more details and instructions.
 
 # Part Name
diff --git a/util/mainboard/google/waddledoo/template/memory/mem_parts_used.txt b/util/mainboard/google/waddledoo/template/memory/mem_parts_used.txt
index 59381dcf5b..e4258b530d 100644
--- a/util/mainboard/google/waddledoo/template/memory/mem_parts_used.txt
+++ b/util/mainboard/google/waddledoo/template/memory/mem_parts_used.txt
@@ -1,6 +1,11 @@
 # This is a CSV file containing a list of memory parts used by this variant.
+# One part per line with an optional fixed ID in column 2.
+# Only include a fixed ID if it is required for legacy reasons!
+# Generated IDs are dependent on the order of parts in this file,
+# so new parts must always be added at the end of the file!
+#
 # Generate an updated Makefile.inc and dram_id.generated.txt by running the
-# gen_part_id tool from util/spd_tools/lp4x
-# See util/spd_tools/lp4x/README.md for more details and instructions.
+# gen_part_id tool from util/spd_tools/{ddr4,lp4x}.
+# See util/spd_tools/{ddr4,lp4x}/README.md for more details and instructions.
 
 # Part Name