summaryrefslogtreecommitdiff
path: root/util/amdtools
diff options
context:
space:
mode:
authorFelix Held <felix-coreboot@felixheld.de>2022-02-12 18:32:30 +0100
committerFelix Held <felix-coreboot@felixheld.de>2022-02-15 23:32:09 +0000
commit6198a8213a41c2c74dc0adefc62eb1efb31983e9 (patch)
tree86aa3ec4bee0594873b72937e1d71c3699e71bce /util/amdtools
parent8ac40f3ea71fe9087ead28fa3a571f6248e4d74c (diff)
util/amdtools/README: convert to markdown
This change is mostly from CB:56644 patchset 3. Signed-off-by: Martin Roth <martin@coreboot.org> Signed-off-by: Felix Held <felix-coreboot@felixheld.de> Change-Id: Idcee9de9bc409a4dfe7d2f8c18ec5132f2747c33 Reviewed-on: https://review.coreboot.org/c/coreboot/+/61893 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Paul Menzel <paulepanter@mailbox.org> Reviewed-by: Raul Rangel <rrangel@chromium.org>
Diffstat (limited to 'util/amdtools')
-rw-r--r--util/amdtools/README31
-rw-r--r--util/amdtools/README.md27
2 files changed, 27 insertions, 31 deletions
diff --git a/util/amdtools/README b/util/amdtools/README
deleted file mode 100644
index 06e691008b..0000000000
--- a/util/amdtools/README
+++ /dev/null
@@ -1,31 +0,0 @@
-
-
-This is a set of tools to compare (extended) K8 memory settings.
-
-Before you can use them, you need to massage the relevant BKDG sections into
-useable data. Here's how.
-
-First, you need to acquire a copy of the K8 BKDG. Go here:
-
- Rev F: http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/32559.pdf
-
-Then make sure pdftotext is installed (it's in the poppler-utils package on Debian/Ubuntu).
-
-Now run the bkdg through pdftotext:
-
- pdftotext -layout 32559.pdf 32559.txt
-
-Now extract sections 4.5.15 - 4.5.19 from the file, and save it separately, say as bkdg-raw.data.
-
-Finally run the txt file through the parse-bkdg.pl script like so:
-
- parse-bkdg.pl < bkdg-raw.data > bkdg.data
-
-Now we have the bkdg.data file that is used by the other scripts.
-
-If you want to test the scripts without doing all this work, you can use some
-sample input files from the 'example_input/' directory.
-
---
-Ward Vandewege, 2009-10-28.
-ward@jhvc.com
diff --git a/util/amdtools/README.md b/util/amdtools/README.md
new file mode 100644
index 0000000000..c628f55798
--- /dev/null
+++ b/util/amdtools/README.md
@@ -0,0 +1,27 @@
+# amdtools
+Various tools for AMD platforms
+
+## A set of tools to compare (extended) K8 memory settings.
+ - k8-compare-pci-space.pl
+ - k8-interpret-extended-memory-settings.pl
+ - k8-read-mem-settings.sh
+ - parse-bkdg.pl
+
+Before you can use them, you need to massage the relevant BKDG
+sections into useable data. Here's how.
+
+ 1. First, you need to acquire a copy of the K8 BKDG. Go here:
+ Rev F: http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/32559.pdf
+ 2. Make sure pdftotext is installed (it's in the poppler-utils
+ package on Debian/Ubuntu).
+ 3. Run the bkdg through pdftotext:
+ `pdftotext -layout 32559.pdf 32559.txt`
+ 4. Extract sections 4.5.15 - 4.5.19 from the file, and save it
+ separately, say as bkdg-raw.data.
+ 5. Finally run the txt file through the parse-bkdg.pl script like so:
+ `parse-bkdg.pl < bkdg-raw.data > bkdg.data`
+
+Now we have the bkdg.data file that is used by the other scripts.
+
+If you want to test the scripts without doing all this work, you
+can use some sample input files from the 'example_input/' directory.