summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCyrIng <labs@cyring.fr>2024-08-06 19:01:28 +0200
committerCyrIng <labs@cyring.fr>2024-08-06 19:01:28 +0200
commite8fe368fd302b3e2d5bc0c3eef9496fe24ffb410 (patch)
tree721586e7a7a848eabf763a06c9a1b7f0eb9a34b8
parent875c8ab9362ee0f2f7170fa5054c06d4727241da (diff)
[Doc] Refreshed README and Makefile1.98.1
-rw-r--r--Makefile11
-rw-r--r--README.md44
2 files changed, 17 insertions, 38 deletions
diff --git a/Makefile b/Makefile
index 7dd365f..539fbe6 100644
--- a/Makefile
+++ b/Makefile
@@ -313,7 +313,7 @@ help:
"| make [all] [clean] [info] [help] [install] [module-install] |\n"\
"| |\n"\
"| V=<n> |\n"\
- "| where <n> is the kernel verbose build level |\n"\
+ "| where <n> is the verbose build level |\n"\
"| |\n"\
"| CC=<COMPILER> |\n"\
"| where <COMPILER> is cc, gcc, clang |\n"\
@@ -382,10 +382,9 @@ help:
"| set ruler left or right bound to <N> frequency ratio |\n"\
"| |\n"\
"| Example: |\n"\
- "| make CC=gcc OPTIM_LVL=3 FEAT_DBG=1 ARCH_PMC=PCU |\n"\
- "| MSR_CORE_PERF_UCC=MSR_CORE_PERF_FIXED_CTR1 |\n"\
- "| MSR_CORE_PERF_URC=MSR_CORE_PERF_FIXED_CTR2 |\n"\
- "| HWM_CHIPSET=W83627 MAX_FREQ_HZ=5350000000 |\n"\
+ "| make CC=gcc OPTIM_LVL=3 FEAT_DBG=1 ARCH_PMC=PCU \\ |\n"\
+ "| MSR_CORE_PERF_UCC=MSR_CORE_PERF_FIXED_CTR1 \\ |\n"\
+ "| MSR_CORE_PERF_URC=MSR_CORE_PERF_FIXED_CTR2 \\ |\n"\
+ "| HWM_CHIPSET=W83627 MAX_FREQ_HZ=5350000000 \\ |\n"\
"| CORE_COUNT=1024 NO_FOOTER=1 NO_UPPER=1 |\n"\
- "| clean all |\n"\
"o---------------------------------------------------------------o"
diff --git a/README.md b/README.md
index 11444d9..606db19 100644
--- a/README.md
+++ b/README.md
@@ -84,43 +84,21 @@ cd CoreFreq
make -j
```
```console
-cc -Wall -Wfatal-errors -Wno-unused-variable -pthread -c x86_64/corefreqd.c \
- -D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
- -o build/corefreqd.o
-cc -Wall -Wfatal-errors -Wno-unused-variable -c x86_64/corefreqm.c \
- -D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
- -o build/corefreqm.o
-cc -Wall -Wfatal-errors -Wno-unused-variable -c x86_64/corefreq-cli.c \
- -D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
- -o build/corefreq-cli.o
-cc -Wall -Wfatal-errors -Wno-unused-variable -c x86_64/corefreq-ui.c \
- -D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
- -o build/corefreq-ui.o
-cc -Wall -Wfatal-errors -Wno-unused-variable -c x86_64/corefreq-cli-rsc.c \
- -D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
- -o build/corefreq-cli-rsc.o
-cc -Wall -Wfatal-errors -Wno-unused-variable -c x86_64/corefreq-cli-json.c \
- -D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
- -o build/corefreq-cli-json.o
-cc -Wall -Wfatal-errors -Wno-unused-variable -c x86_64/corefreq-cli-extra.c \
- -D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
- -o build/corefreq-cli-extra.o
-cc -Wall -Wfatal-errors -Wno-unused-variable x86_64/corefreqd.c x86_64/corefreqm.c \
- -D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
- -o build/corefreqd -lpthread -lm -lrt
-cc -Wall -Wfatal-errors -Wno-unused-variable \
- x86_64/corefreq-cli.c x86_64/corefreq-ui.c x86_64/corefreq-cli-rsc.c \
- x86_64/corefreq-cli-json.c x86_64/corefreq-cli-extra.c \
- -D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
- -o build/corefreq-cli -lm -lrt
-make[1]: Entering directory '/usr/lib/modules/x.y.z/build'
+ CC [build/corefreqd.o]
+ CC [build/corefreqm.o]
+ CC [build/corefreq-cli.o]
+ CC [build/corefreq-ui.o]
+ CC [build/corefreq-cli-rsc.o]
+ CC [build/corefreq-cli-json.o]
+ CC [build/corefreq-cli-extra.o]
+ LD [build/corefreqd]
+ LD [build/corefreq-cli]
CC [M] CoreFreq/build/module/corefreqk.o
LD [M] CoreFreq/build/corefreqk.o
MODPOST CoreFreq/build/Module.symvers
CC [M] CoreFreq/build/corefreqk.mod.o
LD [M] CoreFreq/build/corefreqk.ko
BTF [M] CoreFreq/build/corefreqk.ko
-make[1]: Leaving directory '/usr/lib/modules/x.y.z/build
```
4. (Optionally) Sign the driver
If module signature verification is enabled into Kernel, you will have to sign the `corefreqk.ko` driver.
@@ -525,6 +503,9 @@ gmake CC=clang
o---------------------------------------------------------------o
| make [all] [clean] [info] [help] [install] [module-install] |
| |
+| V=<n> |
+| where <n> is the verbose build level |
+| |
| CC=<COMPILER> |
| where <COMPILER> is cc, gcc, clang |
| |
@@ -596,7 +577,6 @@ o---------------------------------------------------------------o
| MSR_CORE_PERF_URC=MSR_CORE_PERF_FIXED_CTR2 |
| HWM_CHIPSET=W83627 MAX_FREQ_HZ=5350000000 |
| CORE_COUNT=1024 NO_FOOTER=1 NO_UPPER=1 |
-| clean all |
o---------------------------------------------------------------o
```