util/spd_tools: Support comments in mem_parts_used

Allow comments prefixed with '#' in mem_parts_used csv file.

BUG=None
TEST=Run gen_part_id with mem_parts_used file containing comments

Change-Id: Ia9e274d45aa06dea7a3a5f8cd1c8ee2b23398876
Signed-off-by: Rob Barnes <robbarnes@google.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/44950
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Furquan Shaikh <furquan@google.com>

9 files changed, 73 insertions, 0 deletions

diff --git a/src/mainboard/google/zork/variants/berknip/spd/mem_parts_used.txt b/src/mainboard/google/zork/variants/berknip/spd/mem_parts_used.txt
index 8e50ea0fcd..1e5ee8a961 100644
--- a/src/mainboard/google/zork/variants/berknip/spd/mem_parts_used.txt
+++ b/src/mainboard/google/zork/variants/berknip/spd/mem_parts_used.txt
@@ -1,3 +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!
+# Each part must also be listed in util/spd_tools/ddr4/global_ddr4_mem_parts.json.txt.
+# 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.
+
+# Part Name, Fixed ID (optional)
 K4A8G165WC-BCTD, 0
 MT40A512M16TB-062E:J, 2
 H5AN8G6NDJR-XNC, 3
diff --git a/src/mainboard/google/zork/variants/dalboz/spd/mem_parts_used.txt b/src/mainboard/google/zork/variants/dalboz/spd/mem_parts_used.txt
index f25485156f..5a104d7bf1 100644
--- a/src/mainboard/google/zork/variants/dalboz/spd/mem_parts_used.txt
+++ b/src/mainboard/google/zork/variants/dalboz/spd/mem_parts_used.txt
@@ -1,3 +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!
+# Each part must also be listed in util/spd_tools/ddr4/global_ddr4_mem_parts.json.txt.
+# 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.
+
+# Part Name, Fixed ID (optional)
 HMA851S6CJR6N-VK, 0
 H5ANAG6NCMR-VKC, 1
 K4A8G165WC-BCTD, 2
diff --git a/src/mainboard/google/zork/variants/dirinboz/spd/mem_parts_used.txt b/src/mainboard/google/zork/variants/dirinboz/spd/mem_parts_used.txt
index 1d19915a01..ba70da3ed3 100644
--- a/src/mainboard/google/zork/variants/dirinboz/spd/mem_parts_used.txt
+++ b/src/mainboard/google/zork/variants/dirinboz/spd/mem_parts_used.txt
@@ -1,3 +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!
+# Each part must also be listed in util/spd_tools/ddr4/global_ddr4_mem_parts.json.txt.
+# 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.
+
+# Part Name, Fixed ID (optional)
 K4A8G165WC-BCTD, 2
 K4A8G165WC-BCWE, 4
 H5AN8G6NDJR-XNC, 5
diff --git a/src/mainboard/google/zork/variants/ezkinil/spd/mem_parts_used.txt b/src/mainboard/google/zork/variants/ezkinil/spd/mem_parts_used.txt
index 27fb51b5e4..a9994a3cc0 100644
--- a/src/mainboard/google/zork/variants/ezkinil/spd/mem_parts_used.txt
+++ b/src/mainboard/google/zork/variants/ezkinil/spd/mem_parts_used.txt
@@ -1,3 +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!
+# Each part must also be listed in util/spd_tools/ddr4/global_ddr4_mem_parts.json.txt.
+# 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.
+
+# Part Name, Fixed ID (optional)
 H5AN8G6NCJR-VKC,0
 MT40A512M16TB-062E:J,2
 MT40A1G16KNR-075:E, 3
diff --git a/src/mainboard/google/zork/variants/morphius/spd/mem_parts_used.txt b/src/mainboard/google/zork/variants/morphius/spd/mem_parts_used.txt
index b56a6b430f..329763962e 100644
--- a/src/mainboard/google/zork/variants/morphius/spd/mem_parts_used.txt
+++ b/src/mainboard/google/zork/variants/morphius/spd/mem_parts_used.txt
@@ -1,3 +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!
+# Each part must also be listed in util/spd_tools/ddr4/global_ddr4_mem_parts.json.txt.
+# 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.
+
+# Part Name, Fixed ID (optional)
 K4AAG165WA-BCWE, 0
 MT40A512M16TB-062E:J, 2
 MT40A1G16KD-062E:E, 3
diff --git a/src/mainboard/google/zork/variants/trembyle/spd/mem_parts_used.txt b/src/mainboard/google/zork/variants/trembyle/spd/mem_parts_used.txt
index f8a7229334..7316ee04a0 100644
--- a/src/mainboard/google/zork/variants/trembyle/spd/mem_parts_used.txt
+++ b/src/mainboard/google/zork/variants/trembyle/spd/mem_parts_used.txt
@@ -1,2 +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.
+# 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.
+
+# Part Name, Fixed ID (optional)
 H5AN8G6NCJR-VKC, 0
 H5ANAG6NCMR-VKC, 1
diff --git a/src/mainboard/google/zork/variants/vilboz/spd/mem_parts_used.txt b/src/mainboard/google/zork/variants/vilboz/spd/mem_parts_used.txt
index ac7b794b4b..6afaeed8e9 100644
--- a/src/mainboard/google/zork/variants/vilboz/spd/mem_parts_used.txt
+++ b/src/mainboard/google/zork/variants/vilboz/spd/mem_parts_used.txt
@@ -1,3 +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!
+# Each part must also be listed in util/spd_tools/ddr4/global_ddr4_mem_parts.json.txt.
+# 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.
+
+# Part Name, Fixed ID (optional)
 H5AN8G6NCJR-VKC, 0
 H5ANAG6NCMR-VKC, 1
 K4A8G165WC-BCWE, 2
diff --git a/src/mainboard/google/zork/variants/woomax/spd/mem_parts_used.txt b/src/mainboard/google/zork/variants/woomax/spd/mem_parts_used.txt
index fcee8664c0..625a8d029f 100644
--- a/src/mainboard/google/zork/variants/woomax/spd/mem_parts_used.txt
+++ b/src/mainboard/google/zork/variants/woomax/spd/mem_parts_used.txt
@@ -1,3 +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!
+# Each part must also be listed in util/spd_tools/ddr4/global_ddr4_mem_parts.json.txt.
+# 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.
+
+# Part Name, Fixed ID (optional)
 H5AN8G6NCJR-XNC, 1
 MT40A512M16TB-062E:J, 8
 H5AN8G6NCJR-XNC, 9
diff --git a/util/spd_tools/ddr4/gen_part_id.go b/util/spd_tools/ddr4/gen_part_id.go
index 29b91fac35..f07e79b45a 100644
--- a/util/spd_tools/ddr4/gen_part_id.go
+++ b/util/spd_tools/ddr4/gen_part_id.go
@@ -68,6 +68,7 @@ func readParts(memPartsUsedFileName string) ([]usedPart, error) {
 	r := csv.NewReader(f)
 	r.FieldsPerRecord = -1 // Allow variable length records
 	r.TrimLeadingSpace = true
+	r.Comment = '#'
 
 	parts := []usedPart{}