Skip to contentSkip to conversation

Add example recipes for ext kernel module dependency

RFC PATCH In review Hubert CHAUMETTE 5 participants 12 messages Jul 1, 2020 – Jul 3, 2020

lore
Share & tools
lore
#0 lore raw

cover Add example recipes for ext kernel module dependency

Add example recipes (master an slave) for external kernel module dependency. The master recipe installs shared headers in ${D}${includedir}/${BPN}/ and the slave one accesses them with ccflags-y in its Makefile.

Please review the following changes for suitability for inclusion. If you have any objections or suggestions for improvement, please respond to the patches. If you agree with the changes, please provide your Acked-by.

The following changes since commit 259d2e35e7ba3cbd496d6383e58cfdc22b267f0e:

python3-setuptools: upgrade 47.1.1 -> 47.3.1 (2020-06-30 23:03:02 +0100)

are available in the Git repository at:

git://push.yoctoproject.org/poky-contrib hchaumette/ext-module-dep

Hubert CHAUMETTE (2):
Example for ext kernel modules dependency, master module Example for ext kernel module dependency, slave module

 .../kernel-module-master/files/COPYING        |  15 ++
 .../kernel-module-master/files/Makefile       |  14 ++
 .../files/include/master.h                    |  25 +++
 .../kernel-module-master/files/master.c       | 154 ++++++++++++++++++
 .../kernel-module-master.bb                   |  20 +++
 .../kernel-module-slave/files/COPYING         |  15 ++
 .../kernel-module-slave/files/Makefile        |  16 ++
 .../kernel-module-slave/files/slave.c         |  52 ++++++
 .../kernel-module-slave.bb                    |  17 ++
 9 files changed, 328 insertions(+)
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/COPYING
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/Makefile
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/include/master.h
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/master.c
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/kernel-module-master.bb
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/files/COPYING
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/files/slave.c
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb
Signature · 1 line
2.27.0
#1 lore raw

RFC PATCH 1/2 Example for ext kernel modules dependency, master module

Add /dev/master char device and export a notifier for R/W events. Shared headers are installed to ${D}${includedir}/${BPN}.

---
 .../kernel-module-master/files/COPYING        |  15 ++
 .../kernel-module-master/files/Makefile       |  14 ++
 .../files/include/master.h                    |  25 +++
 .../kernel-module-master/files/master.c       | 154 ++++++++++++++++++
 .../kernel-module-master.bb                   |  20 +++
 5 files changed, 228 insertions(+)
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/COPYING
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/Makefile
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/include/master.h
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/master.c
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/kernel-module-master.bb
meta-skeleton/recipes-kernel/kernel-module-master/files/COPYING new file +15 -0
new file mode 100644
index 0000000000..286d9e8890
@@ -0,0 +1,15 @@
+Copyright (C) 2020 Hubert CHAUMETTE
+
+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 will 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 to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
meta-skeleton/recipes-kernel/kernel-module-master/files/Makefile new file +14 -0
new file mode 100644
index 0000000000..664e966a86
@@ -0,0 +1,14 @@
+obj-m := master.o
+
+SRC := $(PWD)
+
+all:
+	$(MAKE) -C $(KERNEL_SRC) M=$(SRC)
+
+modules_install:
+	$(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install
+
+clean:
+	rm -f *.o *~ core .depend .*.cmd *.ko *.mod.c
+	rm -f Module.markers Module.symvers modules.order
+	rm -rf .tmp_versions Modules.symvers
meta-skeleton/recipes-kernel/kernel-module-master/files/include/master.h new file +25 -0
new file mode 100644
index 0000000000..b7b61b109a
@@ -0,0 +1,25 @@
+/*
+ * External kernel module dependency exemple - master module
+ *
+ * Copyright (C) 2020 Hubert CHAUMETTE
+ */
+
+#ifndef MASTER_H
+#define MASTER_H
+
+#include <linux/notifier.h>
+
+enum master_evt_type {
+	MASTER_EVT_READ,
+	MASTER_EVT_WRITE,
+};
+
+struct master_evt_data {
+	char __user *buf;
+	size_t count;
+};
+
+int master_notifier_register(struct notifier_block *nb);
+int master_notifier_unregister(struct notifier_block *nb);
+
+#endif /* MASTER_H */
meta-skeleton/recipes-kernel/kernel-module-master/files/master.c new file +154 -0

154 lines not on this page · raw message

meta-skeleton/recipes-kernel/kernel-module-master/kernel-module-master.bb new file +20 -0
new file mode 100644
index 0000000000..d20f163334
@@ -0,0 +1,20 @@
+SUMMARY = "External kernel module dependency exemple - master module"
+LICENSE = "GPLv2"
+LIC_FILES_CHKSUM = "file://COPYING;md5=1c5a04927650c42822bb4b1de4641658"
+
+inherit module
+
+PN = "kernel-module-master"
+PV = "0.1"
+
+SRC_URI = "file://Makefile \
+           file://master.c \
+           file://include/master.h \
+           file://COPYING \
+          "
+
+S = "${WORKDIR}"
+
+do_install_append() {
+    install -Dm0644 ${S}/include/master.h ${D}${includedir}/${BPN}/
+}
Signature · 1 line
2.27.0
#4 lore raw

RFC PATCH 2/2 Example for ext kernel module dependency, slave module

In reply to Hubert CHAUMETTE

Registers to the master notifier and displays the string received on R/W.

---
 .../kernel-module-slave/files/COPYING         | 15 ++++++
 .../kernel-module-slave/files/Makefile        | 16 ++++++
 .../kernel-module-slave/files/slave.c         | 52 +++++++++++++++++++
 .../kernel-module-slave.bb                    | 17 ++++++
 4 files changed, 100 insertions(+)
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/files/COPYING
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/files/slave.c
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb
meta-skeleton/recipes-kernel/kernel-module-slave/files/COPYING new file +15 -0
new file mode 100644
index 0000000000..286d9e8890
@@ -0,0 +1,15 @@
+Copyright (C) 2020 Hubert CHAUMETTE
+
+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 will 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 to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile new file +16 -0
new file mode 100644
index 0000000000..edf12b7f31
@@ -0,0 +1,16 @@
+SRC := $(shell pwd)
+
+obj-m := slave.o
+# $src is a Kbuild variable. Using $SRC doesn't work.
+ccflags-y := -I$(src)/recipe-sysroot/usr/include/kernel-module-master/
+
+all:
+	$(MAKE) -C $(KERNEL_SRC) M=$(SRC)
+
+modules_install:
+	$(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install
+
+clean:
+	rm -f *.o *~ core .depend .*.cmd *.ko *.mod.c
+	rm -f Module.markers Module.symvers modules.order
+	rm -rf .tmp_versions Modules.symvers
meta-skeleton/recipes-kernel/kernel-module-slave/files/slave.c new file +52 -0

52 lines not on this page · raw message

meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb new file +17 -0
new file mode 100644
index 0000000000..280fa815f3
@@ -0,0 +1,17 @@
+SUMMARY = "External kernel module dependency exemple - slave module"
+LICENSE = "GPLv2"
+LIC_FILES_CHKSUM = "file://COPYING;md5=1c5a04927650c42822bb4b1de4641658"
+
+inherit module
+
+PN = "kernel-module-slave"
+PV = "0.1"
+
+DEPENDS = "kernel-module-master"
+
+SRC_URI = "file://Makefile \
+           file://slave.c \
+           file://COPYING \
+          "
+
+S = "${WORKDIR}"
Signature · 1 line
2.27.0
#2 lore raw

Re: [poky] [RFC PATCH 1/2] Example for ext kernel modules dependency, master module

In reply to Hubert CHAUMETTE
Quoted 28 lines · Hubert CHAUMETTE via lists.yoctoproject.org

Add /dev/master char device and export a notifier for R/W events. Shared headers are installed to ${D}${includedir}/${BPN}.

---
 .../kernel-module-master/files/COPYING        |  15 ++
 .../kernel-module-master/files/Makefile       |  14 ++
 .../files/include/master.h                    |  25 +++
 .../kernel-module-master/files/master.c       | 154 ++++++++++++++++++
 .../kernel-module-master.bb                   |  20 +++
 5 files changed, 228 insertions(+)
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/COPYING
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/Makefile
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/include/master.h
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/master.c
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/kernel-module-master.bb
meta-skeleton/recipes-kernel/kernel-module-master/files/COPYING new file +5 -0
new file mode 100644
index 0000000000..286d9e8890
@@ -0,0 +1,15 @@
+Copyright (C) 2020 Hubert CHAUMETTE
+
+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

meta-skeleton/recipes-kernel/kernel-module-master/files/COPYING line 15

Quoted 10 lines
meta-skeleton/recipes-kernel/kernel-module-master/files/COPYING new file +10 -0
+(at your option) any later version.
+
+This program is distributed in the hope that it will 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 to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

Can you us the SPDX header here?

Quoted 26 lines
meta-skeleton/recipes-kernel/kernel-module-master/files/Makefile new file +14 -0
new file mode 100644
index 0000000000..664e966a86
@@ -0,0 +1,14 @@
+obj-m := master.o
+
+SRC := $(PWD)
+
+all:
+	$(MAKE) -C $(KERNEL_SRC) M=$(SRC)
+
+modules_install:
+	$(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install
+
+clean:
+	rm -f *.o *~ core .depend .*.cmd *.ko *.mod.c
+	rm -f Module.markers Module.symvers modules.order
+	rm -rf .tmp_versions Modules.symvers
meta-skeleton/recipes-kernel/kernel-module-master/files/include/master.h new file +0 -0
new file mode 100644
index 0000000000..b7b61b109a

meta-skeleton/recipes-kernel/kernel-module-master/files/include/master.h line 4

Quoted 4 lines
meta-skeleton/recipes-kernel/kernel-module-master/files/include/master.h new file +4 -0
@@ -0,0 +1,25 @@
+/*
+ * External kernel module dependency exemple - master module
+ *
+ * Copyright (C) 2020 Hubert CHAUMETTE

Can you us the SPDX header here?

Quoted 209 lines
meta-skeleton/recipes-kernel/kernel-module-master/files/include/master.h new file +21 -0
+ */
+
+#ifndef MASTER_H
+#define MASTER_H
+
+#include <linux/notifier.h>
+
+enum master_evt_type {
+	MASTER_EVT_READ,
+	MASTER_EVT_WRITE,
+};
+
+struct master_evt_data {
+	char __user *buf;
+	size_t count;
+};
+
+int master_notifier_register(struct notifier_block *nb);
+int master_notifier_unregister(struct notifier_block *nb);
+
+#endif /* MASTER_H */
meta-skeleton/recipes-kernel/kernel-module-master/files/master.c new file +154 -0
new file mode 100644
index 0000000000..c94c468abf
@@ -0,0 +1,154 @@
+/*
+ * External kernel module dependency exemple - master module
+ *
+ * Copyright (C) 2020 Hubert CHAUMETTE
+ */
+
+#include <linux/cdev.h>
+#include <linux/fs.h>
+#include <linux/uaccess.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/types.h>
+
+#include "include/master.h"
+
+#define MASTER_NAME	"master"
+#define MASTER_BUF_SZ	128
+
+static DEFINE_MUTEX(master_lock);
+static BLOCKING_NOTIFIER_HEAD(master_chain_head);
+static int master_major;
+static struct class *master_class;
+static char master_buf[MASTER_BUF_SZ] = { 0 };
+static int master_count = 0;
+static struct device *master_device;
+
+int master_notifier_register(struct notifier_block *nb)
+{
+	return blocking_notifier_chain_register(&master_chain_head, nb);
+}
+EXPORT_SYMBOL(master_notifier_register);
+
+int master_notifier_unregister(struct notifier_block *nb)
+{
+	return blocking_notifier_chain_unregister(&master_chain_head, nb);
+}
+EXPORT_SYMBOL(master_notifier_unregister);
+
+static ssize_t master_read(struct file *fp, char __user *buf,
+			   size_t count, loff_t *offset)
+{
+	(void)fp;
+
+	ssize_t ret;
+	size_t read_count = min(master_count - *offset, count);
+	struct master_evt_data data = {
+		.buf = buf,
+		.count = read_count,
+	};
+
+	if (*offset >= master_count - 1)
+		return 0;
+
+	mutex_lock(&master_lock);
+
+	if (copy_to_user(buf, master_buf + *offset, read_count)) {
+		ret = -EFAULT;
+		goto unlock;
+	}
+	*offset += read_count;
+	ret = read_count;
+
+	blocking_notifier_call_chain(&master_chain_head, MASTER_EVT_READ, &data);
+
+unlock:
+	mutex_unlock(&master_lock);
+
+	return ret;
+}
+
+static ssize_t master_write(struct file *fp, const char __user *buf,
+			    size_t count, loff_t *offset)
+{
+	(void)offset;
+	(void)fp;
+
+	ssize_t ret;
+	struct master_evt_data data = {
+		.buf = buf,
+		.count = count,
+	};
+
+	if (count > MASTER_BUF_SZ)
+		return -EFBIG;
+
+	mutex_lock(&master_lock);
+
+	if (copy_from_user(master_buf, buf, count)) {
+		ret = -EFAULT;
+		goto unlock;
+	}
+	ret = count;
+	master_count = count;
+
+	blocking_notifier_call_chain(&master_chain_head, MASTER_EVT_WRITE, &data);
+
+unlock:
+	mutex_unlock(&master_lock);
+
+	return ret;
+}
+
+static const struct file_operations master_fops = {
+	.owner =	THIS_MODULE,
+	.write =	master_write,
+	.read =		master_read,
+	.llseek =	no_llseek,
+};
+
+static int __init master_init(void)
+{
+	int ret = 0;
+
+	master_major = register_chrdev(0, MASTER_NAME, &master_fops);
+	if (master_major < 0) {
+		ret = master_major;
+		goto err;
+	}
+
+	master_class = class_create(THIS_MODULE, MASTER_NAME);
+	if (IS_ERR(master_class)) {
+		ret = PTR_ERR(master_class);
+		goto err_class;
+	}
+
+	master_device = device_create(master_class, NULL, MKDEV(master_major, 0),
+				      NULL, MASTER_NAME);
+	if (IS_ERR(master_device)) {
+		ret = PTR_ERR(master_device);
+		goto err_device;
+	}
+
+	return ret;
+
+err_device:
+	class_destroy(master_class);
+err_class:
+	unregister_chrdev(master_major, MASTER_NAME);
+err:
+	return ret;
+}
+module_init(master_init);
+
+static void __exit master_exit(void)
+{
+	device_destroy(master_class, MKDEV(master_major, 0));
+	class_destroy(master_class);
+	unregister_chrdev(master_major, MASTER_NAME);
+}
+module_exit(master_exit);
+
+MODULE_AUTHOR("Hubert CHAUMETTE");
+MODULE_DESCRIPTION("External kernel module dependency exemple - master module");
+MODULE_LICENSE("GPL");
meta-skeleton/recipes-kernel/kernel-module-master/kernel-module-master.bb new file +20 -0
new file mode 100644
index 0000000000..d20f163334
@@ -0,0 +1,20 @@
+SUMMARY = "External kernel module dependency exemple - master module"
+LICENSE = "GPLv2"
+LIC_FILES_CHKSUM = "file://COPYING;md5=1c5a04927650c42822bb4b1de4641658"
+
+inherit module
+
+PN = "kernel-module-master"
+PV = "0.1"
+
+SRC_URI = "file://Makefile \
+           file://master.c \
+           file://include/master.h \
+           file://COPYING \
+          "
+
+S = "${WORKDIR}"
+
+do_install_append() {
+    install -Dm0644 ${S}/include/master.h ${D}${includedir}/${BPN}/
+}
#5 lore raw

Re: [poky] [RFC PATCH 2/2] Example for ext kernel module dependency, slave module

In reply to Hubert CHAUMETTE

Hi Hubert,

Quoted 41 lines · Hubert CHAUMETTE via lists.yoctoproject.org

Registers to the master notifier and displays the string received on R/W.

---
 .../kernel-module-slave/files/COPYING         | 15 ++++++
 .../kernel-module-slave/files/Makefile        | 16 ++++++
 .../kernel-module-slave/files/slave.c         | 52 +++++++++++++++++++
 .../kernel-module-slave.bb                    | 17 ++++++
 4 files changed, 100 insertions(+)
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/files/COPYING
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/files/slave.c
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb
meta-skeleton/recipes-kernel/kernel-module-slave/files/COPYING new file +15 -0
new file mode 100644
index 0000000000..286d9e8890
@@ -0,0 +1,15 @@
+Copyright (C) 2020 Hubert CHAUMETTE
+
+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 will 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 to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile new file +0 -0
new file mode 100644
index 0000000000..edf12b7f31

meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile line 6

Quoted 6 lines
meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile new file +6 -0
@@ -0,0 +1,16 @@
+SRC := $(shell pwd)
+
+obj-m := slave.o
+# $src is a Kbuild variable. Using $SRC doesn't work.
+ccflags-y := -I$(src)/recipe-sysroot/usr/include/kernel-module-master/
+

This makes your Makefile (hence kernel-module) bound to Yocto which is probably not a real life example (and it is highly suggested to never hardcode CFLAGS, CXXFLAGS, LDFLAGS, CC, etc... in Makefile/CMakeLists/you name it because it is a source of problems we could have avoided in the first place).

Better have a TARGET_CFLAGS += "-I${STAGING_INCDIR}/kernel-module-master"

Also technically, if your "master" is always installing the header in <includedir>/kernel-module-master, maybe it'd actually be better to fix the original code and use #include <kernel-module-master/master.h> ?

Overall, I'm not sure to understand what this has to do with kernel modules and if this is really an example worthy to be in meta-skeleton?

It's basically an example for using DEPENDS and an include file, from this recipe, which is at the "wrong" (read not directly in /usr/include) location from another recipe.

Quoted 58 lines
meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile new file +10 -0
+all:
+	$(MAKE) -C $(KERNEL_SRC) M=$(SRC)
+
+modules_install:
+	$(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install
+
+clean:
+	rm -f *.o *~ core .depend .*.cmd *.ko *.mod.c
+	rm -f Module.markers Module.symvers modules.order
+	rm -rf .tmp_versions Modules.symvers
meta-skeleton/recipes-kernel/kernel-module-slave/files/slave.c new file +42 -0
new file mode 100644
index 0000000000..b1d9b92cc6
@@ -0,0 +1,52 @@
+/*
+ * External kernel module dependency exemple - slave module
+ *
+ * Copyright (C) 2020 Hubert CHAUMETTE
+ */
+
+#include <linux/module.h>
+#include <master.h>
+
+static int slave_notify(struct notifier_block *self,
+			unsigned long action, void *data);
+
+static struct notifier_block slave_nb = {
+	.notifier_call = slave_notify,
+};
+
+static int slave_notify(struct notifier_block *self,
+			unsigned long action, void *data)
+{
+	struct master_evt_data *d = (struct master_evt_data *)data;
+
+	BUG_ON(data == NULL);
+
+	switch (action) {
+	case MASTER_EVT_READ:
+		pr_info("slave: \"%.*s\" read from master\n", d->count, d->buf);
+		break;
+	case MASTER_EVT_WRITE:
+		pr_info("slave: \"%.*s\" written to master\n", d->count, d->buf);
+		break;
+	default:
+		break;
+	}
+
+	return NOTIFY_DONE;
+}
+
+static int __init slave_init(void)
+{
+	return master_notifier_register(&slave_nb);
+}
+module_init(slave_init);

meta-skeleton/recipes-kernel/kernel-module-slave/files/slave.c line 52

Quoted 10 lines
meta-skeleton/recipes-kernel/kernel-module-slave/files/slave.c new file +10 -0
+
+static void __exit slave_exit(void)
+{
+	master_notifier_unregister(&slave_nb);
+}
+module_exit(slave_exit);
+
+MODULE_AUTHOR("Hubert CHAUMETTE");
+MODULE_DESCRIPTION("External kernel module dependency exemple - slave module");
+MODULE_LICENSE("GPL");

GPL or GPLv2?

Also, do those examples **really** need to be named slave/master? I mean they're just exchanging data whose format has been defined into one kernel module.

meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb line 3

Quoted 9 lines
meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb new file +3 -0
new file mode 100644
index 0000000000..280fa815f3
@@ -0,0 +1,17 @@
+SUMMARY = "External kernel module dependency exemple - slave module"
+LICENSE = "GPLv2"
+LIC_FILES_CHKSUM = "file://COPYING;md5=1c5a04927650c42822bb4b1de4641658"

Technically, you could use COMMON_LIC_DIR instead of providing a COPYING file.

Quentin

#8 lore raw

Re: [poky] [RFC PATCH 2/2] Example for ext kernel module dependency, slave module

In reply to Hubert CHAUMETTE
Quoted 4 lines · Hubert CHAUMETTE via lists.yoctoproject.org

Registers to the master notifier and displays the string received on R/W.

Quoted 10 lines
---
 .../kernel-module-slave/files/COPYING         | 15 ++++++
 .../kernel-module-slave/files/Makefile        | 16 ++++++
 .../kernel-module-slave/files/slave.c         | 52 +++++++++++++++++++
 .../kernel-module-slave.bb                    | 17 ++++++
 4 files changed, 100 insertions(+)
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/files/COPYING
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/files/slave.c
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb

I recommend we NACK new code using this terminology. Changing terminology in existing code is difficult and needs to be done carefully. Changing terminology in newly added code should be easy to do.

This could be called kernel-moduler-receiver if I'm understanding the code properly.

Signature · 2 lines
Paul Barker
Konsulko Group
#3 lore raw

Re: [poky] [RFC PATCH 1/2] Example for ext kernel modules dependency, master module

In reply to Hubert CHAUMETTE
Quoted 5 lines · Hubert CHAUMETTE via lists.yoctoproject.org

Add /dev/master char device and export a notifier for R/W events. Shared headers are installed to ${D}${includedir}/${BPN}.

Quoted 12 lines
---
 .../kernel-module-master/files/COPYING        |  15 ++
 .../kernel-module-master/files/Makefile       |  14 ++
 .../files/include/master.h                    |  25 +++
 .../kernel-module-master/files/master.c       | 154 ++++++++++++++++++
 .../kernel-module-master.bb                   |  20 +++
 5 files changed, 228 insertions(+)
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/COPYING
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/Makefile
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/include/master.h
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/files/master.c
 create mode 100644 meta-skeleton/recipes-kernel/kernel-module-master/kernel-module-master.bb

Maybe kernel-module-notifier?

Signature · 2 lines
Paul Barker
Konsulko Group
#9 lore raw

Re: [poky] [RFC PATCH 2/2] Example for ext kernel module dependency, slave module

In reply to Paul Barker

Le 01/07/2020 17:03, Paul Barker a écrit :

Quoted 23 lines
Quoted 18 lines · Hubert CHAUMETTE via lists.yoctoproject.org

Registers to the master notifier and displays the string received on R/W.

---
 .../kernel-module-slave/files/COPYING         | 15 ++++++
 .../kernel-module-slave/files/Makefile        | 16 ++++++
 .../kernel-module-slave/files/slave.c         | 52 
+++++++++++++++++++
 .../kernel-module-slave.bb                    | 17 ++++++
 4 files changed, 100 insertions(+)
 create mode 100644 
meta-skeleton/recipes-kernel/kernel-module-slave/files/COPYING
 create mode 100644 
meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile
 create mode 100644 
meta-skeleton/recipes-kernel/kernel-module-slave/files/slave.c
 create mode 100644 
Quoted 1 line

meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb

Quoted 7 lines

I recommend we NACK new code using this terminology. Changing terminology in existing code is difficult and needs to be done carefully. Changing terminology in newly added code should be easy to do.

This could be called kernel-moduler-receiver if I'm understanding the code properly.

You are understanding properly. Notifier/receiver is ok, it just changes the focus from the dependency to the implementation, but I was not really happy with the naming in the first place.

#10 lore raw
In reply to Hubert CHAUMETTE
Quoted 12 lines · Hubert CHAUMETTE via lists.yoctoproject.org

Add example recipes (master an slave) for external kernel module dependency. The master recipe installs shared headers in ${D}${includedir}/${BPN}/ and the slave one accesses them with ccflags-y in its Makefile.

Please review the following changes for suitability for inclusion. If you have any objections or suggestions for improvement, please respond to the patches. If you agree with the changes, please provide your Acked-by.

The following changes since commit 259d2e35e7ba3cbd496d6383e58cfdc22b267f0e:

python3-setuptools: upgrade 47.1.1 -> 47.3.1 (2020-06-30 23:03:02 +0100)

Quoted 7 lines

are available in the Git repository at:

git://push.yoctoproject.org/poky-contrib hchaumette/ext-module-dep

Hubert CHAUMETTE (2):
Example for ext kernel modules dependency, master module Example for ext kernel module dependency, slave module

There are a few issues here:

As others have mentioned, the use of master/slave here needs to be changed.

The patches also need to be submitted to openembedded-core, not poky.

The shortlog in the git commit doesn't confirm to our patch submission guidelines.

There isn't any test added which actually builds/tests/uses these that I could spot. Should there be?

Cheers,

Richard

#6 lore raw

Re: [poky] [RFC PATCH 2/2] Example for ext kernel module dependency, slave module

In reply to Quentin Schulz

Hi Quentin,

Le 01/07/2020 16:58, Quentin Schulz a écrit :

Quoted 56 lines

Hi Hubert,

Quoted 52 lines · Hubert CHAUMETTE via lists.yoctoproject.org

Registers to the master notifier and displays the string received on R/W.

---
 .../kernel-module-slave/files/COPYING         | 15 ++++++
 .../kernel-module-slave/files/Makefile        | 16 ++++++
 .../kernel-module-slave/files/slave.c         | 52 
+++++++++++++++++++
 .../kernel-module-slave.bb                    | 17 ++++++
 4 files changed, 100 insertions(+)
 create mode 100644 
meta-skeleton/recipes-kernel/kernel-module-slave/files/COPYING
 create mode 100644 
meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile
 create mode 100644 
meta-skeleton/recipes-kernel/kernel-module-slave/files/slave.c
 create mode 100644 

meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb

meta-skeleton/recipes-kernel/kernel-module-slave/files/COPYING new file +15 -0
new file mode 100644
index 0000000000..286d9e8890
@@ -0,0 +1,15 @@
+Copyright (C) 2020 Hubert CHAUMETTE
+
+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 will 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 to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 

USA

meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile new file +5 -0
new file mode 100644
index 0000000000..edf12b7f31
@@ -0,0 +1,16 @@
+SRC := $(shell pwd)
+
+obj-m := slave.o
+# $src is a Kbuild variable. Using $SRC doesn't work.
+ccflags-y := 
Quoted 8 lines

meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile

Quoted 2 lines
meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile new file +1 -1
-I$(src)/recipe-sysroot/usr/include/kernel-module-master/
+

This makes your Makefile (hence kernel-module) bound to Yocto which is probably not a real life example (and it is highly suggested to never hardcode CFLAGS, CXXFLAGS, LDFLAGS, CC, etc... in Makefile/CMakeLists/you name it because it is a source of problems we could have avoided in the first place).

I've used something similar on a yocto-only project, so it is actually a real example, but good point on keeping it independent.

Quoted 1 line

Better have a TARGET_CFLAGS += "-I${STAGING_INCDIR}/kernel-module-master"

I didn't manage to make it work.

Quoted 3 lines

Also technically, if your "master" is always installing the header in <includedir>/kernel-module-master, maybe it'd actually be better to fix the original code and use #include <kernel-module-master/master.h> ?

I use a subdirectory to keep the a kernel header separated from userspace includes.
Also, removing kernel-module-master/ doesn't work: kernel modules don't see the userspace inludedir by default.
Using STAGING_KERNEL_DIR allows to skip the CFLAGS dance but doesn't seem right either (using a third party staging directory seems to be asking for trouble) and I had issues with it (as discussed with Bruce Ashfield earlier).
I'd be happy to know what is the correct way to do it.

Quoted 7 lines

Overall, I'm not sure to understand what this has to do with kernel modules and if this is really an example worthy to be in meta-skeleton?

It's basically an example for using DEPENDS and an include file, from this recipe, which is at the "wrong" (read not directly in /usr/include) location from another recipe.

As said above, kernel modules don't follow the usual rules and would benefit IMO from a standardized example.

Quoted 3 lines
Quoted 1 line

+MODULE_LICENSE("GPL");

GPL or GPLv2

According to https://www.kernel.org/doc/html/latest/process/license-rules.html
it doesn't matter.

Quoted 3 lines

Also, do those examples **really** need to be named slave/master? I mean they're just exchanging data whose format has been defined into one kernel module.

The naming is to emphasize the dependency relationship, the implementation is irrelevant. Would you prefer Paul's notifier/receiver?

Quoted 6 lines
Quoted 6 lines
(quoted diff) +0 -0
new file mode 100644
index 0000000000..280fa815f3

b/meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb

Quoted 8 lines
Quoted 5 lines
meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb new file +3 -0
@@ -0,0 +1,17 @@
+SUMMARY = "External kernel module dependency exemple - slave module"
+LICENSE = "GPLv2"
+LIC_FILES_CHKSUM = 

"file://COPYING;md5=1c5a04927650c42822bb4b1de4641658"

Technically, you could use COMMON_LIC_DIR instead of providing a COPYING file.

I didn't know about that, but doesn't it defeat the point of having a checksum to detect licensing changes?

Regards,

Hubert

#7 lore raw

Re: [poky] [RFC PATCH 2/2] Example for ext kernel module dependency, slave module

Hi Hubert,

On Fri, Jul 03, 2020 at 11:39:54AM +0200, Hubert CHAUMETTE wrote:
[...]

Quoted 11 lines
Quoted 10 lines

meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile line 6

Quoted 4 lines
meta-skeleton/recipes-kernel/kernel-module-slave/files/Makefile new file +3 -1
+# $src is a Kbuild variable. Using $SRC doesn't work.
+ccflags-y :=
-I$(src)/recipe-sysroot/usr/include/kernel-module-master/
+

This makes your Makefile (hence kernel-module) bound to Yocto which is probably not a real life example (and it is highly suggested to never hardcode CFLAGS, CXXFLAGS, LDFLAGS, CC, etc... in Makefile/CMakeLists/you name it because it is a source of problems we could have avoided in the first place).

Quoted 8 lines

I've used something similar on a yocto-only project, so it is actually a real example, but good point on keeping it independent.

Quoted 2 lines

Better have a TARGET_CFLAGS +=
"-I${STAGING_INCDIR}/kernel-module-master"

I didn't manage to make it work.

Well, stupid me thought CFLAGS were used for the kernel modules but they aren't :)

https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/classes/module.bbclass#n38

Not tested but EXTRA_OEMAKE += "EXTRA_CFLAGS=-I${STAGING_INCDIR}/kernel-module-master" could be an option. Or KBUILD_CFLAGS? (c.f.
https://www.kernel.org/doc/html/v5.4/kbuild/makefiles.html#compilation-flags)

Is that proper? /me shrugs
Eager to see what's the proper way.

Quoted 8 lines
Quoted 3 lines

Also technically, if your "master" is always installing the header in <includedir>/kernel-module-master, maybe it'd actually be better to fix the original code and use #include <kernel-module-master/master.h> ?

I use a subdirectory to keep the a kernel header separated from userspace includes.
Also, removing kernel-module-master/ doesn't work: kernel modules don't see the userspace inludedir by default.

I meant to keep the path in the includedir (so <includedir>/kernel-module-master), pass <includedir> in CFLAGS somehow and from the kernel driver source code, include <kernel-module-master/master.h>

Quoted 6 lines

Using STAGING_KERNEL_DIR allows to skip the CFLAGS dance but doesn't seem right either (using a third party staging directory seems to be asking for trouble) and I had issues with it (as discussed with Bruce Ashfield earlier).
I'd be happy to know what is the correct way to do it.

Listen to Bruce, he's definitely much more experience than me on this.

Quoted 11 lines
Quoted 7 lines

Overall, I'm not sure to understand what this has to do with kernel modules and if this is really an example worthy to be in meta-skeleton?

It's basically an example for using DEPENDS and an include file, from this recipe, which is at the "wrong" (read not directly in /usr/include) location from another recipe.

As said above, kernel modules don't follow the usual rules and would benefit IMO from a standardized example.

I was ignorant of the CFLAGS dance required for it so yes, it seems like a good addition to the examples :)

[...]

Quoted 7 lines
Quoted 3 lines

Also, do those examples **really** need to be named slave/master? I mean they're just exchanging data whose format has been defined into one kernel module.

The naming is to emphasize the dependency relationship, the implementation is irrelevant. Would you prefer Paul's notifier/receiver?

Fine :)

Quoted 17 lines
Quoted 8 lines
Quoted 8 lines

diff --git a/meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb b/meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb new file mode 100644
index 0000000000..280fa815f3
--- /dev/null
+++
b/meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb

Quoted 8 lines
Quoted 5 lines
meta-skeleton/recipes-kernel/kernel-module-slave/kernel-module-slave.bb new file +3 -0
@@ -0,0 +1,17 @@
+SUMMARY = "External kernel module dependency exemple - slave module"
+LICENSE = "GPLv2"
+LIC_FILES_CHKSUM =

"file://COPYING;md5=1c5a04927650c42822bb4b1de4641658"

Technically, you could use COMMON_LIC_DIR instead of providing a COPYING file.

Quoted 3 lines

I didn't know about that, but doesn't it defeat the point of having a checksum to detect licensing changes?

Kinda. Now that I'm thinking about it, another solution is to pass the part of the kernel driver where the SPDX license appears with beginline/endline in LIC_FILES_CHKSUM.

No strong feelings about this, I just found it sad to add a file just for the license.

Thanks for the patch and your explanations, learned a few more things today :)

Regards,
Quentin

#11 lore raw
In reply to Richard Purdie

Le 02/07/2020 22:27, Richard Purdie a écrit :

Quoted 23 lines
Quoted 13 lines · Hubert CHAUMETTE via lists.yoctoproject.org

Add example recipes (master an slave) for external kernel module dependency. The master recipe installs shared headers in ${D}${includedir}/${BPN}/ and the slave one accesses them with ccflags-y in its Makefile.

Please review the following changes for suitability for inclusion. If you have any objections or suggestions for improvement, please respond to the patches. If you agree with the changes, please provide your Acked-by.

The following changes since commit 259d2e35e7ba3cbd496d6383e58cfdc22b267f0e:

python3-setuptools: upgrade 47.1.1 -> 47.3.1 (2020-06-30 23:03:02
+0100)

Quoted 7 lines

are available in the Git repository at:

git://push.yoctoproject.org/poky-contrib hchaumette/ext-module-dep

Hubert CHAUMETTE (2):
Example for ext kernel modules dependency, master module Example for ext kernel module dependency, slave module

Quoted 6 lines

There are a few issues here:

As others have mentioned, the use of master/slave here needs to be changed.

The patches also need to be submitted to openembedded-core, not poky.

Alright, I'll do it.

Quoted 2 lines

The shortlog in the git commit doesn't confirm to our patch submission guidelines.

I don't know what to put in "affected area of the code". meta-skeleton?

Quoted 2 lines

There isn't any test added which actually builds/tests/uses these that I could spot. Should there be?

I see there is ptest for package runtime testing, and meta/lib/oeqa/selftest/cases/ for build-time. Does runtime testing make sense in this case?

Quoted 3 lines

Cheers,

Richard

Regards,

Hubert