Skip to content

Commit e8fe368

Browse files
committed
[Doc] Refreshed README and Makefile
1 parent 875c8ab commit e8fe368

File tree

2 files changed

+17
-38
lines changed

2 files changed

+17
-38
lines changed

Makefile

+5-6
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ help:
313313
"| make [all] [clean] [info] [help] [install] [module-install] |\n"\
314314
"| |\n"\
315315
"| V=<n> |\n"\
316-
"| where <n> is the kernel verbose build level |\n"\
316+
"| where <n> is the verbose build level |\n"\
317317
"| |\n"\
318318
"| CC=<COMPILER> |\n"\
319319
"| where <COMPILER> is cc, gcc, clang |\n"\
@@ -382,10 +382,9 @@ help:
382382
"| set ruler left or right bound to <N> frequency ratio |\n"\
383383
"| |\n"\
384384
"| Example: |\n"\
385-
"| make CC=gcc OPTIM_LVL=3 FEAT_DBG=1 ARCH_PMC=PCU |\n"\
386-
"| MSR_CORE_PERF_UCC=MSR_CORE_PERF_FIXED_CTR1 |\n"\
387-
"| MSR_CORE_PERF_URC=MSR_CORE_PERF_FIXED_CTR2 |\n"\
388-
"| HWM_CHIPSET=W83627 MAX_FREQ_HZ=5350000000 |\n"\
385+
"| make CC=gcc OPTIM_LVL=3 FEAT_DBG=1 ARCH_PMC=PCU \\ |\n"\
386+
"| MSR_CORE_PERF_UCC=MSR_CORE_PERF_FIXED_CTR1 \\ |\n"\
387+
"| MSR_CORE_PERF_URC=MSR_CORE_PERF_FIXED_CTR2 \\ |\n"\
388+
"| HWM_CHIPSET=W83627 MAX_FREQ_HZ=5350000000 \\ |\n"\
389389
"| CORE_COUNT=1024 NO_FOOTER=1 NO_UPPER=1 |\n"\
390-
"| clean all |\n"\
391390
"o---------------------------------------------------------------o"

README.md

+12-32
Original file line numberDiff line numberDiff line change
@@ -84,43 +84,21 @@ cd CoreFreq
8484
make -j
8585
```
8686
```console
87-
cc -Wall -Wfatal-errors -Wno-unused-variable -pthread -c x86_64/corefreqd.c \
88-
-D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
89-
-o build/corefreqd.o
90-
cc -Wall -Wfatal-errors -Wno-unused-variable -c x86_64/corefreqm.c \
91-
-D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
92-
-o build/corefreqm.o
93-
cc -Wall -Wfatal-errors -Wno-unused-variable -c x86_64/corefreq-cli.c \
94-
-D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
95-
-o build/corefreq-cli.o
96-
cc -Wall -Wfatal-errors -Wno-unused-variable -c x86_64/corefreq-ui.c \
97-
-D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
98-
-o build/corefreq-ui.o
99-
cc -Wall -Wfatal-errors -Wno-unused-variable -c x86_64/corefreq-cli-rsc.c \
100-
-D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
101-
-o build/corefreq-cli-rsc.o
102-
cc -Wall -Wfatal-errors -Wno-unused-variable -c x86_64/corefreq-cli-json.c \
103-
-D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
104-
-o build/corefreq-cli-json.o
105-
cc -Wall -Wfatal-errors -Wno-unused-variable -c x86_64/corefreq-cli-extra.c \
106-
-D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
107-
-o build/corefreq-cli-extra.o
108-
cc -Wall -Wfatal-errors -Wno-unused-variable x86_64/corefreqd.c x86_64/corefreqm.c \
109-
-D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
110-
-o build/corefreqd -lpthread -lm -lrt
111-
cc -Wall -Wfatal-errors -Wno-unused-variable \
112-
x86_64/corefreq-cli.c x86_64/corefreq-ui.c x86_64/corefreq-cli-rsc.c \
113-
x86_64/corefreq-cli-json.c x86_64/corefreq-cli-extra.c \
114-
-D CORE_COUNT=256 -D TASK_ORDER=5 -D MAX_FREQ_HZ=7125000000 -D UBENCH=0 -D DELAY_TSC=1 \
115-
-o build/corefreq-cli -lm -lrt
116-
make[1]: Entering directory '/usr/lib/modules/x.y.z/build'
87+
CC [build/corefreqd.o]
88+
CC [build/corefreqm.o]
89+
CC [build/corefreq-cli.o]
90+
CC [build/corefreq-ui.o]
91+
CC [build/corefreq-cli-rsc.o]
92+
CC [build/corefreq-cli-json.o]
93+
CC [build/corefreq-cli-extra.o]
94+
LD [build/corefreqd]
95+
LD [build/corefreq-cli]
11796
CC [M] CoreFreq/build/module/corefreqk.o
11897
LD [M] CoreFreq/build/corefreqk.o
11998
MODPOST CoreFreq/build/Module.symvers
12099
CC [M] CoreFreq/build/corefreqk.mod.o
121100
LD [M] CoreFreq/build/corefreqk.ko
122101
BTF [M] CoreFreq/build/corefreqk.ko
123-
make[1]: Leaving directory '/usr/lib/modules/x.y.z/build
124102
```
125103
4. (Optionally) Sign the driver
126104
If module signature verification is enabled into Kernel, you will have to sign the `corefreqk.ko` driver.
@@ -525,6 +503,9 @@ gmake CC=clang
525503
o---------------------------------------------------------------o
526504
| make [all] [clean] [info] [help] [install] [module-install] |
527505
| |
506+
| V=<n> |
507+
| where <n> is the verbose build level |
508+
| |
528509
| CC=<COMPILER> |
529510
| where <COMPILER> is cc, gcc, clang |
530511
| |
@@ -596,7 +577,6 @@ o---------------------------------------------------------------o
596577
| MSR_CORE_PERF_URC=MSR_CORE_PERF_FIXED_CTR2 |
597578
| HWM_CHIPSET=W83627 MAX_FREQ_HZ=5350000000 |
598579
| CORE_COUNT=1024 NO_FOOTER=1 NO_UPPER=1 |
599-
| clean all |
600580
o---------------------------------------------------------------o
601581
```
602582

0 commit comments

Comments
 (0)