From: Qiuxu Zhuo <[email protected]> The sysfs interfaces in the comments in sysfs.c are incorrect. Fix them. Additionally, improve some IFS comments and fix some typos in the comments such as: s/cpu/CPU, s/intel/Intel, s/ifs/IFS.
No functional changes. Signed-off-by: Qiuxu Zhuo <[email protected]> Signed-off-by: Ehab Ababneh <[email protected]> --- drivers/platform/x86/intel/ifs/ifs.h | 16 ++++++++-------- drivers/platform/x86/intel/ifs/load.c | 2 +- drivers/platform/x86/intel/ifs/runtest.c | 8 ++++---- drivers/platform/x86/intel/ifs/sysfs.c | 23 +++++++++++------------ 4 files changed, 24 insertions(+), 25 deletions(-) diff --git a/drivers/platform/x86/intel/ifs/ifs.h b/drivers/platform/x86/intel/ifs/ifs.h index f55528ac517b..0f5cdc1ad14d 100644 --- a/drivers/platform/x86/intel/ifs/ifs.h +++ b/drivers/platform/x86/intel/ifs/ifs.h @@ -35,10 +35,10 @@ * IFS Image Loading * ----------------- * - * The driver loads the tests into memory reserved BIOS local to each CPU - * socket in a two step process using writes to MSRs to first load the - * SHA hashes for the test. Then the tests themselves. Status MSRs provide - * feedback on the success/failure of these steps. + * The driver loads the tests into memory reserved by BIOS, local to each CPU + * socket in a two-step process. It first writes to MSRs to load the SHA hashes + * for the test, followed by the tests themselves. Status MSRs provide feedback + * on the success or failure of these steps. * * The test files are kept in a fixed location: /lib/firmware/intel/ifs_<n>/ * For e.g if there are 3 test files, they would be named in the following @@ -83,14 +83,14 @@ * * Test a specific core:: * - * # echo <cpu#> > /sys/devices/virtual/misc/intel_ifs_<n>/run_test + * # echo <CPU#> > /sys/devices/virtual/misc/intel_ifs_<n>/run_test * - * when HT is enabled any of the sibling cpu# can be specified to test + * when HT is enabled any of the sibling CPU# can be specified to test * its corresponding physical core. Since the tests are per physical core, * the result of testing any thread is same. All siblings must be online * to run a core test. It is only necessary to test one thread. * - * For e.g. to test core corresponding to cpu5 + * For e.g. to test core corresponding to CPU5 * * # echo 5 > /sys/devices/virtual/misc/intel_ifs_<n>/run_test * @@ -284,7 +284,7 @@ struct ifs_test_msrs { }; /** - * struct ifs_data - attributes related to intel IFS driver + * struct ifs_data - attributes related to Intel IFS driver * @loaded_version: stores the currently loaded ifs image version. * @loaded: If a valid test binary has been loaded into the memory * @loading_error: Error occurred on another CPU while loading image diff --git a/drivers/platform/x86/intel/ifs/load.c b/drivers/platform/x86/intel/ifs/load.c index 329400908cb2..dde3f5eb379f 100644 --- a/drivers/platform/x86/intel/ifs/load.c +++ b/drivers/platform/x86/intel/ifs/load.c @@ -108,7 +108,7 @@ static void auth_err_message(struct device *dev, u32 err_code) } /* - * To copy scan hashes and authenticate test chunks, the initiating cpu must point + * To copy scan hashes and authenticate test chunks, the initiating CPU must point * to the EDX:EAX to the test image in linear address. * Run wrmsr(MSR_COPY_SCAN_HASHES) for scan hash copy and run wrmsr(MSR_AUTHENTICATE_AND_COPY_CHUNK) * for scan hash copy and test chunk authentication. diff --git a/drivers/platform/x86/intel/ifs/runtest.c b/drivers/platform/x86/intel/ifs/runtest.c index 1762eab7fe5c..96b538c665f4 100644 --- a/drivers/platform/x86/intel/ifs/runtest.c +++ b/drivers/platform/x86/intel/ifs/runtest.c @@ -149,7 +149,7 @@ static atomic_t array_cpus_in; static atomic_t scan_cpus_in; /* - * Simplified cpu sibling rendezvous loop based on microcode loader __wait_for_cpus() + * Simplified CPU sibling rendezvous loop based on microcode loader wait_for_cpus() */ static void wait_for_sibling_cpu(atomic_t *t, long long timeout) { @@ -389,8 +389,8 @@ static void ifs_array_test_gen1(int cpu, struct device *dev) } /* - * Initiate per core test. It wakes up work queue threads on the target cpu and - * its sibling cpu. Once all sibling threads wake up, the scan test gets executed and + * Initiate per core test. It wakes up work queue threads on the target CPU and + * its sibling CPU. Once all sibling threads wake up, the scan test gets executed and * wait for all sibling threads to finish the scan test. */ int do_core_test(int cpu, struct device *dev) @@ -403,7 +403,7 @@ int do_core_test(int cpu, struct device *dev) cpus_read_lock(); if (!cpu_online(cpu)) { - dev_info(dev, "cannot test on the offline cpu %d\n", cpu); + dev_info(dev, "cannot test on the offline CPU %d\n", cpu); ret = -EINVAL; goto out; } diff --git a/drivers/platform/x86/intel/ifs/sysfs.c b/drivers/platform/x86/intel/ifs/sysfs.c index 01b7502f46b0..287f96bb033e 100644 --- a/drivers/platform/x86/intel/ifs/sysfs.c +++ b/drivers/platform/x86/intel/ifs/sysfs.c @@ -10,14 +10,14 @@ #include "ifs.h" /* - * Protects against simultaneous tests on multiple cores, or - * reloading can file while a test is in progress + * Protect against simultaneous tests on multiple cores and prevent + * the reloading of IFS image file while a test is in progress. */ static DEFINE_SEMAPHORE(ifs_sem, 1); /* - * The sysfs interface to check additional details of last test - * cat /sys/devices/system/platform/ifs/details + * The sysfs interface to check additional details of the last test: + * cat /sys/devices/virtual/misc/intel_ifs_<n>/details */ static ssize_t details_show(struct device *dev, struct device_attribute *attr, @@ -37,9 +37,8 @@ static const char * const status_msg[] = { }; /* - * The sysfs interface to check the test status: - * To check the status of last test - * cat /sys/devices/platform/ifs/status + * The sysfs interface to check the last test status: + * cat /sys/devices/virtual/misc/intel_ifs_<n>/status */ static ssize_t status_show(struct device *dev, struct device_attribute *attr, @@ -53,12 +52,12 @@ static ssize_t status_show(struct device *dev, static DEVICE_ATTR_RO(status); /* - * The sysfs interface for single core testing - * To start test, for example, cpu5 - * echo 5 > /sys/devices/platform/ifs/run_test + * The sysfs interface for single-core testing. + * To start a test, for example on CPU5: + * echo 5 > /sys/devices/virtual/misc/intel_ifs_<n>/run_test * To check the result: - * cat /sys/devices/platform/ifs/result - * The sibling core gets tested at the same time. + * cat /sys/devices/virtual/misc/intel_ifs_<n>/status + * The sibling thread gets tested at the same time. */ static ssize_t run_test_store(struct device *dev, struct device_attribute *attr, -- 2.43.0
