diff options
| -rw-r--r-- | util/spd_tools/README.md | 14 | ||||
| -rw-r--r-- | util/spd_tools/src/part_id_gen/part_id_gen.go | 8 |
2 files changed, 11 insertions, 11 deletions
diff --git a/util/spd_tools/README.md b/util/spd_tools/README.md index bed34601cc..e7772c9827 100644 --- a/util/spd_tools/README.md +++ b/util/spd_tools/README.md @@ -25,7 +25,7 @@ IDs (configure DRAM hardware straps) for any memory part used by a board. maps each supported platform to one of these sets. * `part_id_gen`: This tool allocates DRAM strap IDs for the different memory parts used by a board. It takes as input a CSV file of the memory parts used - with optional fixed IDs. It generates a Makefile.inc which is used to + with optional fixed IDs. It generates a Makefile.mk which is used to integrate the SPD files generated by `spd_gen` into the coreboot build. ## Tool 1 - `spd_gen` @@ -465,7 +465,7 @@ This program takes the following 4 inputs: * 1) The SoC platform which the board is based on, e.g. ADL. * 2) The memory technology used by the board, One of ddr4, lp4x, or lp5. -* 3) The path to the directory where the generated Makefile.inc should be placed. +* 3) The path to the directory where the generated Makefile.mk should be placed. * 4) A CSV file containing a list of the memory parts used by the board, with an optional fixed or exclusive ID for each part and an optional SPD override file. A fixed ID is simply an integer and it ensure that part (and any that share the @@ -503,14 +503,14 @@ The `part_id_gen` tool outputs the following: * It prints the DRAM hardware strap ID which should be allocated to each memory part in the input file. -* It generates a `Makefile.inc` in the given directory. This is used to +* It generates a `Makefile.mk` in the given directory. This is used to integrate the SPD files generated by `spd_gen` with the coreboot build for the board. * It generates a `dram_id.generated.txt` in the same directory as the - `Makefile.inc`. This lists the part IDs assigned to each memory part, and is + `Makefile.mk`. This lists the part IDs assigned to each memory part, and is useful for itegration with the board schematics. -Sample `Makefile.inc`: +Sample `Makefile.mk`: ``` # SPDX-License-Identifier: GPL-2.0-or-later @@ -607,9 +607,9 @@ util/spd_tools/bin/part_id_gen \ * Update the file containing the memory parts used by board (variant), by adding the new memory part name at the end of the file. - * Use `part_id_gen` to update the variant's `Makefile.inc` and + * Use `part_id_gen` to update the variant's `Makefile.mk` and `dram_id.generated.txt` with the new part. - * Upload the changes to `Makefile.inc` and `dram_id.generated.txt` for + * Upload the changes to `Makefile.mk` and `dram_id.generated.txt` for review. ## How to add support for a new memory technology diff --git a/util/spd_tools/src/part_id_gen/part_id_gen.go b/util/spd_tools/src/part_id_gen/part_id_gen.go index 699905d9cd..719cfd5306 100644 --- a/util/spd_tools/src/part_id_gen/part_id_gen.go +++ b/util/spd_tools/src/part_id_gen/part_id_gen.go @@ -20,7 +20,7 @@ import ( * It expects the following inputs: * Name of the SoC platform, e.g. TGL. * Memory technology used by the variant, e.g. lp4x. - * Path to Makefile directory. Makefile.inc generated by this program is placed in this + * Path to Makefile directory. Makefile.mk generated by this program is placed in this * location. * Text file containing a list of memory part names used by the board. Each line in the file * is expected to have one memory part name. @@ -29,7 +29,7 @@ const ( SPDManifestFileName = "parts_spd_manifest.generated.txt" PlatformsManifestFileName = "platforms_manifest.generated.txt" SPDEmptyFileName = "spd-empty.hex" - MakefileName = "Makefile.inc" + MakefileName = "Makefile.mk" DRAMIdFileName = "dram_id.generated.txt" MaxMemoryId = 15 ) @@ -58,7 +58,7 @@ func usage() { fmt.Printf(" supported platforms: %v\n", supportedPlatforms) fmt.Printf(" mem_technology = Memory technology used by the board\n") fmt.Printf(" supported technologies: %v\n", supportedMemTechs) - fmt.Printf(" makefile_dir = Directory path where generated Makefile.inc should be placed\n") + fmt.Printf(" makefile_dir = Directory path where generated Makefile.mk should be placed\n") fmt.Printf(" mem_parts_used_file = CSV file containing list of memory parts used by the board and optional fixed ids\n\n\n") } @@ -410,7 +410,7 @@ func genPartIdInfo(parts []usedPart, partToSPDMap map[string]string, SPDToIndexM } /* - * This function generates Makefile.inc under the variant directory path and adds assigned SPDs + * This function generates Makefile.mk under the variant directory path and adds assigned SPDs * to SPD_SOURCES. */ func genMakefile(partIdList []partIds, makefileDirName string, SPDDir string, partsDir string) error { |