GNUBoot/coreboot-kgpe-d16
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

util/spd_tools: Update Makefile.inc references to Makefile.mk

Browse source 
Make sure that any new files generated get the Makefile.mk name.

Signed-off-by: Martin Roth <gaumless@gmail.com>
Change-Id: I3880d5911ff8de01751befdffc99ba5a961416f7
Reviewed-on: https://review.coreboot.org/c/coreboot/+/80113
Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Eric Lai <ericllai@google.com>
This commit is contained in:
Martin Roth 2024-01-18 16:24:41 -07:00 committed by Felix Singer
parent 68c73c94db
commit 2dd1218530
2 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
util/spd_tools/README.md
View file

@ -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. maps each supported platform to one of these sets.
* `part_id_gen`: This tool allocates DRAM strap IDs for the different memory * `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 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. integrate the SPD files generated by `spd_gen` into the coreboot build.
## Tool 1 - `spd_gen` ## 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. * 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. * 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 * 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. 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 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 * It prints the DRAM hardware strap ID which should be allocated to each
memory part in the input file. 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 integrate the SPD files generated by `spd_gen` with the coreboot build for
the board. the board.
* It generates a `dram_id.generated.txt` in the same directory as the * 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. useful for itegration with the board schematics.
Sample `Makefile.inc`: Sample `Makefile.mk`:
``` ```
# SPDX-License-Identifier: GPL-2.0-or-later # 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 * Update the file containing the memory parts used by board (variant), by
adding the new memory part name at the end of the file. 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. `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. review.
## How to add support for a new memory technology ## How to add support for a new memory technology

8
util/spd_tools/src/part_id_gen/part_id_gen.go
View file

@ -20,7 +20,7 @@ import (
* It expects the following inputs: * It expects the following inputs:
* Name of the SoC platform, e.g. TGL. * Name of the SoC platform, e.g. TGL.
* Memory technology used by the variant, e.g. lp4x. * 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. * location.
* Text file containing a list of memory part names used by the board. Each line in the file * 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. * is expected to have one memory part name.
@ -29,7 +29,7 @@ const (
SPDManifestFileName = "parts_spd_manifest.generated.txt" SPDManifestFileName = "parts_spd_manifest.generated.txt"
PlatformsManifestFileName = "platforms_manifest.generated.txt" PlatformsManifestFileName = "platforms_manifest.generated.txt"
SPDEmptyFileName = "spd-empty.hex" SPDEmptyFileName = "spd-empty.hex"
MakefileName = "Makefile.inc" MakefileName = "Makefile.mk"
DRAMIdFileName = "dram_id.generated.txt" DRAMIdFileName = "dram_id.generated.txt"
MaxMemoryId = 15 MaxMemoryId = 15
) )
@ -58,7 +58,7 @@ func usage() {
fmt.Printf(" supported platforms: %v\n", supportedPlatforms) fmt.Printf(" supported platforms: %v\n", supportedPlatforms)
fmt.Printf(" mem_technology = Memory technology used by the board\n") fmt.Printf(" mem_technology = Memory technology used by the board\n")
fmt.Printf(" supported technologies: %v\n", supportedMemTechs) 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") 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. * to SPD_SOURCES.
*/ */
func genMakefile(partIdList []partIds, makefileDirName string, SPDDir string, partsDir string) error { func genMakefile(partIdList []partIds, makefileDirName string, SPDDir string, partsDir string) error {