fw_load: new test of device firmware loading
This test checks the device firmware loading. Since Linux 3.7 it can be loaded
directly (by-pass udev). The test consists of the two parts: userspace and
kernelspace.
Signed-off-by: Alexey Kodanev <alexey.kodanev@oracle.com>
Acked-by: Cyril Hrubis <chrubis@suse.cz>
diff --git a/runtest/kernel_misc b/runtest/kernel_misc
index 47a667e..73e21a7 100644
--- a/runtest/kernel_misc
+++ b/runtest/kernel_misc
@@ -1 +1,2 @@
kmsg01 kmsg01
+fw_load fw_load
diff --git a/testcases/kernel/Makefile b/testcases/kernel/Makefile
index 4b4800d..256a574 100644
--- a/testcases/kernel/Makefile
+++ b/testcases/kernel/Makefile
@@ -38,6 +38,7 @@
SUBDIRS += connectors \
containers \
controllers \
+ firmware \
fs \
hotplug \
io \
diff --git a/testcases/kernel/firmware/Makefile b/testcases/kernel/firmware/Makefile
new file mode 100644
index 0000000..fbacf8d
--- /dev/null
+++ b/testcases/kernel/firmware/Makefile
@@ -0,0 +1,44 @@
+# Copyright (c) 2013 Oracle and/or its affiliates. All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of
+# the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it would be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write the Free Software Foundation,
+# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+top_srcdir ?= ../../..
+
+include $(top_srcdir)/include/mk/env_pre.mk
+
+SUBDIRS =
+REQ_VERSION_MAJOR = 3
+REQ_VERSION_PATCH = 7
+
+ifeq ($(MAKECMDGOALS),clean)
+SKIP = 0
+endif
+
+ifeq ($(WITH_MODULES),yes)
+SKIP ?= $(shell test $(LINUX_VERSION_MAJOR) -gt $(REQ_VERSION_MAJOR); echo $$?)
+ifeq ($(SKIP),1)
+SKIP = $(shell test $(LINUX_VERSION_MAJOR) -eq $(REQ_VERSION_MAJOR); echo $$?)
+ifeq ($(SKIP),0)
+SKIP = $(shell test $(LINUX_VERSION_PATCH) -ge $(REQ_VERSION_PATCH); echo $$?)
+endif
+endif
+endif
+
+ifeq ($(SKIP),0)
+SUBDIRS += fw_load_kernel
+SUBDIRS += fw_load_user
+endif
+
+include $(top_srcdir)/include/mk/generic_trunk_target.mk
diff --git a/testcases/kernel/firmware/fw_load_kernel/.gitignore b/testcases/kernel/firmware/fw_load_kernel/.gitignore
new file mode 100644
index 0000000..180072a
--- /dev/null
+++ b/testcases/kernel/firmware/fw_load_kernel/.gitignore
@@ -0,0 +1,6 @@
+/ltp_fw_load.ko
+/*.cmd
+/modules.order
+/Module.symvers
+/ltp_fw_load.mod.c
+/.tmp_versions/
diff --git a/testcases/kernel/firmware/fw_load_kernel/Makefile b/testcases/kernel/firmware/fw_load_kernel/Makefile
new file mode 100644
index 0000000..076d4ed
--- /dev/null
+++ b/testcases/kernel/firmware/fw_load_kernel/Makefile
@@ -0,0 +1,42 @@
+# Copyright (c) 2013 Oracle and/or its affiliates. All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of
+# the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it would be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write the Free Software Foundation,
+# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+ifneq ($(KERNELRELEASE),)
+
+ifdef CONFIG_FW_LOADER
+obj-m := ltp_fw_load.o
+endif
+
+else
+
+top_srcdir ?= ../../../..
+include $(top_srcdir)/include/mk/env_pre.mk
+
+MAKE_TARGETS := ltp_fw_load.ko
+
+# Ignoring the exit status of commands is done to be forward compatible with
+# kernel internal API changes. The user-space test will return TCONF, if it
+# doesn't find the module (i.e. it wasn't built either due to kernel-devel
+# missing or module build failure).
+ltp_fw_load.ko: ltp_fw_load.c
+ -$(MAKE) -C $(LINUX_DIR) M=$(abs_srcdir)
+ -mv ltp_fw_load.ko ltp_fw_load.ko~
+ -$(MAKE) -C $(LINUX_DIR) M=$(abs_srcdir) clean
+ -mv ltp_fw_load.ko~ ltp_fw_load.ko
+
+include $(top_srcdir)/include/mk/generic_leaf_target.mk
+
+endif
diff --git a/testcases/kernel/firmware/fw_load_kernel/README b/testcases/kernel/firmware/fw_load_kernel/README
new file mode 100644
index 0000000..97507fd
--- /dev/null
+++ b/testcases/kernel/firmware/fw_load_kernel/README
@@ -0,0 +1,16 @@
+The aim of the test is to check device firmware loading. Since kernel 3.7
+firmware loading changed to direct loading (by-pass udev). The test consists
+of the two parts:
+ - userspace part
+ - kernelspace part
+
+This is a kernel module, which is a part of the device firmware loading test.
+It allows to call request_firmware kernel function with specified parameters.
+Template firmware file name and expected firmware file's data size are passed
+as the insmod command line parameters. Then, the number of firmware test files
+should be written to sysfs file 'fwnum' (the maximum number is 32). This write
+will initiate request firmware procedure. In the end, results can be read from
+'result' device sysfs file. Also, some information regarding module loading,
+can be obtained by looking at kernel log file.
+
+It is automatically used by userspace part of the test.
diff --git a/testcases/kernel/firmware/fw_load_kernel/ltp_fw_load.c b/testcases/kernel/firmware/fw_load_kernel/ltp_fw_load.c
new file mode 100644
index 0000000..b7397e8
--- /dev/null
+++ b/testcases/kernel/firmware/fw_load_kernel/ltp_fw_load.c
@@ -0,0 +1,164 @@
+/*
+ * Copyright (c) 2013 Oracle and/or its affiliates. All Rights Reserved.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it would be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * Author:
+ * Alexey Kodanev <alexey.kodanev@oracle.com>
+ *
+ * This module is trying to load external test firmware files (n#_load_tst.fw).
+ * In the end, it writes results to /sys/devices/ltp_fw_load/result file.
+ */
+
+#include <linux/module.h>
+#include <linux/kernel.h>
+#include <linux/init.h>
+#include <linux/device.h>
+#include <linux/string.h>
+#include <linux/firmware.h>
+
+MODULE_LICENSE("GPL");
+MODULE_AUTHOR("Alexey Kodanev <alexey.kodanev@oracle.com>");
+MODULE_DESCRIPTION("This module is checking device firmware loading");
+
+#define TCID "ltp_fw_load"
+
+static char *fw_name = "load_tst.fw";
+static int fw_size = 0x1000;
+static int max_name = 64;
+static int fw;
+
+module_param(fw_name, charp, 0444);
+MODULE_PARM_DESC(fw_name, "Template firmware file name: n#_name");
+
+module_param(fw_size, int, 0444);
+MODULE_PARM_DESC(fw_size, "Firmware file size");
+
+/*
+ * bit mask for each test-case,
+ * if test is passed, bit will be set to 1
+ */
+static int test_result;
+
+static void device_release(struct device *dev)
+{
+ pr_info(TCID ": device released\n");
+}
+
+static struct device tdev = {
+ .init_name = TCID,
+ .release = device_release,
+};
+
+/* read and print firmware data */
+static int fw_read(const u8 *data, size_t size)
+{
+ size_t i;
+ pr_info(TCID ": Firmware has size '%zu'\n", size);
+ if (size != fw_size) {
+ pr_err(TCID ": Expected firmware size '%d'\n", fw_size);
+ return -1;
+ }
+ for (i = 0; i < size; ++i) {
+ if (data[i] != (u8)fw) {
+ pr_err(TCID ": Unexpected firmware data\n");
+ return -1;
+ }
+ }
+ return 0;
+}
+
+static int try_request_fw(const char *name)
+{
+ int err;
+ const struct firmware *fw_entry = NULL;
+ err = request_firmware(&fw_entry, name, &tdev);
+ if (!err) {
+ pr_info(TCID ": firmware '%s' requested\n", name);
+ err = fw_read(fw_entry->data, fw_entry->size);
+ } else
+ pr_err(TCID ": Can't request firmware '%s'\n", name);
+ release_firmware(fw_entry);
+ return err;
+}
+
+/* print test result to sysfs file */
+static ssize_t sys_result(struct device *dev,
+ struct device_attribute *attr, char *buf)
+{
+ return scnprintf(buf, PAGE_SIZE, "%d\n", test_result);
+}
+static DEVICE_ATTR(result, S_IRUSR, sys_result, NULL);
+
+/*
+ * get the number of firmware files and
+ * perform firmware requests
+ */
+static ssize_t sys_fwnum(struct device *dev,
+ struct device_attribute *attr, const char *buf, size_t count)
+{
+ int err, fw_num = 0;
+
+ sscanf(buf, "%d", &fw_num);
+ if (fw_num <= 0 || fw_num > 32) {
+ pr_err(TCID ": Unexpected number of firmwares '%d'", fw_num);
+ return count;
+ }
+ for (fw = 0; fw < fw_num; ++fw) {
+ char name[max_name];
+ snprintf(name, max_name, "n%d_%s", fw, fw_name);
+ err = try_request_fw(name);
+ test_result |= (err == 0) << fw;
+ }
+ return count;
+}
+static DEVICE_ATTR(fwnum, S_IWUSR, NULL, sys_fwnum);
+
+static int test_init(void)
+{
+ int err;
+
+ err = device_register(&tdev);
+ if (err) {
+ pr_err(TCID ": Unable to register device\n");
+ return err;
+ }
+ pr_info(TCID ": device registered\n");
+
+ err = device_create_file(&tdev, &dev_attr_result);
+ if (err) {
+ pr_err(TCID ": Can't create sysfs file 'result'\n");
+ device_unregister(&tdev);
+ return err;
+ }
+ err = device_create_file(&tdev, &dev_attr_fwnum);
+ if (err) {
+ pr_err(TCID ": Can't create sysfs file 'fwnum'\n");
+ device_remove_file(&tdev, &dev_attr_result);
+ device_unregister(&tdev);
+ }
+ return err;
+}
+module_init(test_init);
+
+static void test_exit(void)
+{
+ device_remove_file(&tdev, &dev_attr_result);
+ device_remove_file(&tdev, &dev_attr_fwnum);
+
+ device_unregister(&tdev);
+ pr_info(TCID ": module exited\n");
+}
+module_exit(test_exit);
diff --git a/testcases/kernel/firmware/fw_load_user/.gitignore b/testcases/kernel/firmware/fw_load_user/.gitignore
new file mode 100644
index 0000000..1d08149
--- /dev/null
+++ b/testcases/kernel/firmware/fw_load_user/.gitignore
@@ -0,0 +1 @@
+/fw_load
diff --git a/testcases/kernel/firmware/fw_load_user/Makefile b/testcases/kernel/firmware/fw_load_user/Makefile
new file mode 100644
index 0000000..effd5da
--- /dev/null
+++ b/testcases/kernel/firmware/fw_load_user/Makefile
@@ -0,0 +1,20 @@
+# Copyright (c) 2013 Oracle and/or its affiliates. All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of
+# the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it would be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write the Free Software Foundation,
+# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+top_srcdir ?= ../../../..
+
+include $(top_srcdir)/include/mk/testcases.mk
+include $(top_srcdir)/include/mk/generic_leaf_target.mk
diff --git a/testcases/kernel/firmware/fw_load_user/README b/testcases/kernel/firmware/fw_load_user/README
new file mode 100644
index 0000000..702fac9
--- /dev/null
+++ b/testcases/kernel/firmware/fw_load_user/README
@@ -0,0 +1,11 @@
+The aim of the test is to check device firmware loading. Since kernel 3.7
+firmware loading changed to direct loading (by-pass udev). The test consists
+of the two parts:
+ - userspace part
+ - kernelspace part
+
+This is the userspace part, its tasks are:
+ - create firmware files in the standard firmware paths
+ - load the module and initiate firmware request procedure
+ - read device's result file and print final results
+ - unload the module.
diff --git a/testcases/kernel/firmware/fw_load_user/fw_load.c b/testcases/kernel/firmware/fw_load_user/fw_load.c
new file mode 100644
index 0000000..59189d1
--- /dev/null
+++ b/testcases/kernel/firmware/fw_load_user/fw_load.c
@@ -0,0 +1,219 @@
+/*
+ * Copyright (c) 2013 Oracle and/or its affiliates. All Rights Reserved.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it would be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * Author:
+ * Alexey Kodanev <alexey.kodanev@oracle.com>
+ *
+ * Test checks device firmware loading.
+ */
+
+#define _GNU_SOURCE
+#include <sys/utsname.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <string.h>
+
+#include "test.h"
+#include "usctest.h"
+#include "safe_macros.h"
+#include "tst_module.h"
+
+/* number of test firmware files */
+#define FW_FILES 5
+
+char *TCID = "fw_load";
+int TST_TOTAL = FW_FILES;
+
+static int fw_size = 0x1000;
+
+static const char fw_name[] = "load_tst.fw";
+static const char module_name[] = "ltp_fw_load.ko";
+
+/* paths to module's sysfs files */
+static const char dev_fwnum[] = "/sys/devices/ltp_fw_load/fwnum";
+static const char dev_result[] = "/sys/devices/ltp_fw_load/result";
+
+struct fw_file_info {
+ char *file;
+ char *dir;
+ int fake;
+ int remove_dir;
+ int remove_file;
+};
+
+static struct fw_file_info fw[FW_FILES];
+static int fw_num;
+
+/* test options */
+static char *narg;
+static int nflag;
+static int skip_cleanup;
+static int verbose;
+static const option_t options[] = {
+ {"n:", &nflag, &narg},
+ {"s", &skip_cleanup, NULL},
+ {"v", &verbose, NULL},
+ {NULL, NULL, NULL}
+};
+
+static void help(void);
+static void setup(int argc, char *argv[]);
+static void test_run(void);
+static void cleanup(void);
+
+/*
+ * create firmware files in the fw_paths
+ * @fw_paths: it must be termintated by a NULL pointer
+ */
+static void create_firmware(char *const fw_paths[]);
+
+int main(int argc, char *argv[])
+{
+ setup(argc, argv);
+
+ test_run();
+
+ cleanup();
+
+ tst_exit();
+}
+
+static void help(void)
+{
+ printf(" -n x Write x bytes to firmware file, default is %d\n",
+ fw_size);
+ printf(" -s Skip cleanup\n");
+ printf(" -v Verbose\n");
+}
+
+void setup(int argc, char *argv[])
+{
+ char *msg;
+ msg = parse_opts(argc, argv, options, help);
+ if (msg != NULL)
+ tst_brkm(TBROK, NULL, "OPTION PARSING ERROR - %s", msg);
+
+ if (nflag) {
+ if (sscanf(narg, "%i", &fw_size) != 1)
+ tst_brkm(TBROK, NULL, "-n option arg is not a number");
+ if (fw_size < 0)
+ tst_brkm(TBROK, NULL, "-n option arg is less than 0");
+ }
+
+ tst_require_root(NULL);
+
+ if (tst_kvercmp(3, 7, 0) < 0) {
+ tst_brkm(TCONF, NULL,
+ "Test must be run with kernel 3.7 or newer");
+ }
+
+ char fw_size_param[19];
+ snprintf(fw_size_param, 19, "fw_size=%d", fw_size);
+ char *const mod_params[2] = { fw_size_param, NULL };
+ tst_module_load(NULL, module_name, mod_params);
+
+ tst_sig(FORK, DEF_HANDLER, cleanup);
+
+ /* get current Linux version and make firmware paths */
+ struct utsname uts_name;
+ uname(&uts_name);
+
+ /* 4 firmware paths + NULL */
+ char *fw_paths[5] = { "/lib/firmware", "/lib/firmware/updates" };
+ asprintf(&fw_paths[2], "%s/%s", fw_paths[0], uts_name.release);
+ asprintf(&fw_paths[3], "%s/%s", fw_paths[1], uts_name.release);
+
+ /* create firmware in the hard coded firmware search paths */
+ create_firmware(fw_paths);
+
+ free(fw_paths[2]);
+ free(fw_paths[3]);
+
+ /* make non-existent firmware file */
+ asprintf(&fw[fw_num].file, "/n%d_%s", fw_num, fw_name);
+ fw[fw_num].fake = 1;
+ ++fw_num;
+}
+
+static void test_run(void)
+{
+ /* initiate firmware requests */
+ SAFE_FILE_PRINTF(cleanup, dev_fwnum, "%d", fw_num);
+
+ /* get module results by reading result bit mask */
+ int result = 0;
+ SAFE_FILE_SCANF(cleanup, dev_result, "%d", &result);
+
+ int i, fail, offset;
+ for (i = 0; i < fw_num; ++i) {
+ fail = (result & (1 << i)) == 0 && !fw[i].fake;
+ offset = (fw[i].dir) ? strlen(fw[i].dir) : 0;
+ tst_resm((fail) ? TFAIL : TPASS,
+ "Expect: %s load firmware '...%s'",
+ (fw[i].fake) ? "can't" : "can",
+ fw[i].file + offset);
+ }
+}
+
+static void cleanup(void)
+{
+ if (skip_cleanup)
+ return;
+
+ int i;
+ /* remove subdirs first and then upper level dirs */
+ for (i = fw_num - 1; i >= 0; --i) {
+ if (fw[i].remove_file && remove(fw[i].file) == -1)
+ tst_resm(TWARN, "Can't remove: %s", fw[i].file);
+ free(fw[i].file);
+
+ if (fw[i].remove_dir && remove(fw[i].dir) == -1)
+ tst_resm(TWARN, "Can't remove %s", fw[i].dir);
+ free(fw[i].dir);
+ }
+
+ tst_module_unload(NULL, module_name);
+
+ TEST_CLEANUP;
+}
+
+static void create_firmware(char *const fw_paths[])
+{
+ int i = 0;
+ while (fw_paths[i] != NULL) {
+ struct fw_file_info *fi = &fw[fw_num];
+ fi->dir = strdup(fw_paths[i]);
+ if (access(fi->dir, X_OK) == -1) {
+ /* create dir */
+ SAFE_MKDIR(cleanup, fi->dir, 0755);
+ fi->remove_dir = 1;
+ }
+
+ /* create test firmware file */
+ asprintf(&fi->file, "%s/n%d_%s", fi->dir, fw_num, fw_name);
+
+ FILE *f = SAFE_FOPEN(cleanup, fi->file, "w");
+ fi->remove_file = 1;
+ int k, byte = fw_num;
+ ++fw_num;
+ for (k = 0; k < fw_size; ++k)
+ fputc(byte, f);
+ SAFE_FCLOSE(cleanup, f);
+ ++i;
+ }
+}