From 81e0d689c07818d6a6554240947e5ab16bf3afc4 Mon Sep 17 00:00:00 2001 From: Martin Roth Date: Sun, 22 May 2022 18:52:18 -0600 Subject: [PATCH] Documentation: Move intelp2m from description.md to Documention The description.md file for the intelp2m utility wasn't the description that was needed - just a subject, and what language it was written in. It was instead a set of more full documentation, so move it into the Documentation directory and create a new description file. Change-Id: Ia180ae41f91f8b8eb408351a9e44e899edc031d3 Signed-off-by: Martin Roth Reviewed-on: https://review.coreboot.org/c/coreboot/+/64578 Tested-by: build bot (Jenkins) Reviewed-by: Felix Singer --- Documentation/util.md | 1 + .../util/intelp2m}/gopackages.png | Bin Documentation/util/intelp2m/index.md | 177 +++++++++++++++++ util/intelp2m/description.md | 179 +----------------- 4 files changed, 180 insertions(+), 177 deletions(-) rename {util/intelp2m/config => Documentation/util/intelp2m}/gopackages.png (100%) create mode 100644 Documentation/util/intelp2m/index.md diff --git a/Documentation/util.md b/Documentation/util.md index ddcd2a1191..0c50d30eb2 100644 --- a/Documentation/util.md +++ b/Documentation/util.md @@ -157,6 +157,7 @@ the documentation `Bash` * [cbfstool](util/cbfstool/index.md) * [ifdtool](util/ifdtool/index.md) +* [intelp2m](util/intelp2m/index.md) ## Generated documentation diff --git a/util/intelp2m/config/gopackages.png b/Documentation/util/intelp2m/gopackages.png similarity index 100% rename from util/intelp2m/config/gopackages.png rename to Documentation/util/intelp2m/gopackages.png diff --git a/Documentation/util/intelp2m/index.md b/Documentation/util/intelp2m/index.md new file mode 100644 index 0000000000..9064817972 --- /dev/null +++ b/Documentation/util/intelp2m/index.md @@ -0,0 +1,177 @@ +Intel Pad to Macro (intelp2m) converter +======================================= + +This utility allows to convert the configuration DW0/1 registers value +from [inteltool](../inteltool/description.md) dump to coreboot macros. + +```bash +(shell)$ make +(shell)$ ./intelp2m -h +(shell)$ ./intelp2m -file /path/to/inteltool.log +``` + +### Platforms + +It is possible to use templates for parsing files of excellent inteltool.log. +To specify such a pattern, use the option -t