support for Linux raspberrypi 6.1.x kernels

[santiagobarros]

Upon running sudo ./install.sh

this is the output :

> Copying source to /usr/src/cm4io-fan-0.2.0...Done
> Running DKMS install...
> Error!  The /var/lib/dkms/cm4io-fan/0.2.0/6.1.21-v8+/aarch64/dkms.conf for module cm4io-fan includes a BUILD_EXCLUSIVE directive which
> does not match this kernel/arch.  This indicates that it should not be built.
> 

Iam running :

pi@raspberrypi:~/src/cm4io-fan $ uname -a
Linux raspberrypi 6.1.21-v8+ #1642 SMP PREEMPT Mon Apr 3 17:24:16 BST 2023 aarch64 GNU/Linux

What do I need to update in order for the installation to succeed?

[H-sw123]

Could you please let me know if there is a solution to this problem?

[TomHW]

I made a hack in install.sh

diff --git a/install.sh b/install.sh
index bfdbf33..ff5b34c 100755
--- a/install.sh
+++ b/install.sh
@@ -22,6 +22,7 @@ fi
 echo -n "Copying source to ${DRV_DIR}..."
 [[ -d ${DRV_DIR} ]] && rm -r ${DRV_DIR}
 mkdir -p ${DRV_DIR} && git archive HEAD | tar -x -C "/usr/src/${DRV_NAME}-${DRV_VERSION}"
+sed -i -e "s/^BUILD_EXCLUSIVE_KERNEL=.*$/BUILD_EXCLUSIVE_KERNEL=\^6\\.\.*/g" "/usr/src/${DRV_NAME}-${DRV_VERSION}/dkms.conf"
 echo "Done"
 
 # run dkms

The build was successful, but after reboot the fan stopped even when the cpu temperature increased.

[alinjco]

Same issue here.

Kernel: 6.1.21-v8+ (aarch64)

Even if I bypass the BUILD_EXCLUSIVE_KERNEL, the module does not work properly - the fan does not spin.
Help?

[TomHW]

Have a Look at this. After blacklisting emc2305 it works for me.

[alinjco]

Works for me as well. Thanks for the tip.

[ilg-ul]

Andi @neggles, any plan to update the driver for the 6.x kernel?

Bypassing the BUILD_EXCLUSIVE_KERNEL makes the build pass, and the module is listed by the kernel (emc2301: loading out-of-tree module taints kernel.), but just that, the chip is not detected.

[Arthur-Philip-Dent]

Summer is almost over.
And I ran into the same issue with a CM4-IO-BASE-C from WaveShare, which links to your repo.
I'm not saying, You have to fix it. Just if you have time and there is nothing else to do...
:-)

[kbenyous]

Hello,

@Arthur-Philip-Dent Summer is almost over. So cooling is no longer required ;-)
I made it compile and run on a Waveshare CM4-IO-BASE-B, after a rpi-update that updated my kernel to version 6.1.32-v8+.
The cm4io-fan driver was installed with dkms support.
First, I had to comment the BUILD_EXCLUSIVE_KERNEL variable in dkms.conf, before running dkms install cm4io-fan/0.2.0 as specified in the README.

Then, I had to reinstall the kernel from RaspberryPiOS official sources :

apt install --reinstall raspberrypi-bootloader raspberrypi-kernel raspberrypi-kernel-headers

Then I removed any blacklist for emc2305 module in my modprobe configuration. The emc2301 is now supported by the new emc2305 driver. My RPI runs a 6.1.21-v8+ kernel.
And reboot...
The emc2301 module and the cm4io-fan is now visible in the dmesg logs :

[    5.546461] emc2301 10-002f: EMC2301 detected
[    5.546493] emc2301 10-002f: Have 1 fans configured in DT
[    5.546517] emc2301 10-002f: Fan 0 Cooling step is 500 RPM, minimum 1000, max 5000 RPM

It is also visible in the sensors output (package lm-sensors) :

root@mypi:~# sensors
emc2301-i2c-10-2f
Adapter: i2c-22-mux (chan_id 1)
fan1:        2685 RPM

cpu_thermal-virtual-0
Adapter: Virtual device
temp1:        +50.1°C  (crit = +110.0°C)

rpi_volt-isa-0000
Adapter: ISA adapter
in0:              N/A

By the way, thank you very much @neggles for your work.

[Arthur-Philip-Dent]

Hey @kbenyous, I‘m starting to „learn this stuff“, and I thought, it’s a good idea to leave this matter for the “pros”.

I‘m struggling currently on any part I pick up to make a CM4 module working to use it for a project (TeslaUSB) to make a “Pi 4B compatible” SBC running with a piece of software, running on a actual bullseye installation. Just saying “Gadget mode and M.2 SSD and suddenly WiFi doesn’t work anymore… the “silent fan” would help a but not to freak out. And yeah, not so hat at all anymore, we can save some energy. Right. ☺️

But thanks for all the instructions.
Still I have questions.
Will learn.

Best regards,
Arthur

[tht]

Sorry for bringing up that old topic again but I'm struggling here too.

What I did:

git clone https://github.com/neggles/cm4io-fan.git /usr/src/cm4io-fan-0.2.0
cd /usr/src/cm4io-fan-0.2.0
# edit dkms.conf to remove BUILD_EXCLUSIVE_KERNEL
dkms install cm4io-fan/0.2.0

The Output I get:

Sign command: /usr/lib/linux-kbuild-6.1/scripts/sign-file
Signing key: /var/lib/dkms/mok.key
Public certificate (MOK): /var/lib/dkms/mok.pub
Creating symlink /var/lib/dkms/cm4io-fan/0.2.0/source -> /usr/src/cm4io-fan-0.2.0

Building module:
Cleaning build area...
make -j4 KERNELRELEASE=6.1.0-rpi7-rpi-v8....(bad exit status: 2)
Error! Bad return status for module build on kernel: 6.1.0-rpi7-rpi-v8 (aarch64)
Consult /var/lib/dkms/cm4io-fan/0.2.0/build/make.log for more information.

Looking at the referenced /var/lib/dkms/cm4io-fan/0.2.0/build/make.log I see this:

DKMS make.log for cm4io-fan-0.2.0 for kernel 6.1.0-rpi7-rpi-v8 (aarch64)
Wed 20 Dec 08:00:57 GMT 2023
echo "DKMS found at /usr/sbin/dkms"
make -C emc2301  KERNELRELEASE=6.1.0-rpi7-rpi-v8
make -C overlays  KERNELRELEASE=6.1.0-rpi7-rpi-v8
DKMS found at /usr/sbin/dkms
make[1]: Entering directory '/var/lib/dkms/cm4io-fan/0.2.0/build/overlays'
make[1]: Entering directory '/var/lib/dkms/cm4io-fan/0.2.0/build/emc2301'
make -C /lib/modules/6.1.0-rpi7-rpi-v8/build M=$PWD
make -C /lib/modules/6.1.0-rpi7-rpi-v8/build M=/var/lib/dkms/cm4io-fan/0.2.0/build/overlays DTC_INCLUDE=/lib/modules/6.1.0-rpi7-rpi-v8/build/include
make[2]: Entering directory '/usr/src/linux-headers-6.1.0-rpi7-rpi-v8'
make[2]: Entering directory '/usr/src/linux-headers-6.1.0-rpi7-rpi-v8'
  CC [M]  /var/lib/dkms/cm4io-fan/0.2.0/build/emc2301/emc2301.o
make[3]: *** No rule to make target '/var/lib/dkms/cm4io-fan/0.2.0/build/overlays/cm4io-fan.dtbo', needed by '/var/lib/dkms/cm4io-fan/0.2.0/build/overlays/'.  Stop.
make[3]: *** Waiting for unfinished jobs....
make[2]: *** [/usr/src/linux-headers-6.1.0-rpi7-common-rpi/Makefile:2039: /var/lib/dkms/cm4io-fan/0.2.0/build/overlays] Error 2
make[2]: Leaving directory '/usr/src/linux-headers-6.1.0-rpi7-rpi-v8'
make[1]: *** [Makefile:13: all] Error 2
make[1]: Leaving directory '/var/lib/dkms/cm4io-fan/0.2.0/build/overlays'
make: *** [Makefile:17: build-overlays] Error 2
make: *** Waiting for unfinished jobs....
  MODPOST /var/lib/dkms/cm4io-fan/0.2.0/build/emc2301/Module.symvers
  CC [M]  /var/lib/dkms/cm4io-fan/0.2.0/build/emc2301/emc2301.mod.o
  LD [M]  /var/lib/dkms/cm4io-fan/0.2.0/build/emc2301/emc2301.ko
make[2]: Leaving directory '/usr/src/linux-headers-6.1.0-rpi7-rpi-v8'
make[1]: Leaving directory '/var/lib/dkms/cm4io-fan/0.2.0/build/emc2301'

I'm lost here… the Linux-Headers for the current kernel-version are installed. It's a fresh downloaded ans installed 2023-12-11-raspios-bookworm-arm64-lite.

Anyone with an idea what I could be missing here?

[TomHW]

Hi @tht ,
I can reproduce your problem with bookworm. But during system setup it seems that that the file was built. I'm not able to reproduce it but the file's timestamp indicates that it happened at the beginning. I found a log file in the dkms folder:

DKMS make.log for cm4io-fan-0.2.0 for kernel 6.1.21-v8+ (aarch64)
Wed  3 Jan 14:52:54 CET 2024
echo "DKMS found at /usr/sbin/dkms"
make -C emc2301  KERNELRELEASE=6.1.21-v8+
make -C overlays  KERNELRELEASE=6.1.21-v8+
DKMS found at /usr/sbin/dkms
make[1]: Entering directory '/var/lib/dkms/cm4io-fan/0.2.0/build/overlays'
make[1]: Entering directory '/var/lib/dkms/cm4io-fan/0.2.0/build/emc2301'
make -C /lib/modules/6.1.21-v8+/build M=$PWD
make -C /lib/modules/6.1.21-v8+/build M=/var/lib/dkms/cm4io-fan/0.2.0/build/overlays DTC_INCLUDE=/lib/modules/6.1.21-v8+/build/include
make[2]: Entering directory '/usr/src/linux-headers-6.1.21-v8+'
make[2]: Entering directory '/usr/src/linux-headers-6.1.21-v8+'
warning: the compiler differs from the one used to build the kernel
warning: the compiler differs from the one used to build the kernel
  The kernel was built by: gcc (Debian 10.2.1-6) 10.2.1 20210110
  The kernel was built by: gcc (Debian 10.2.1-6) 10.2.1 20210110
  You are using:           gcc (Debian 12.2.0-14) 12.2.0
  You are using:           gcc (Debian 12.2.0-14) 12.2.0
  CC [M]  /var/lib/dkms/cm4io-fan/0.2.0/build/emc2301/emc2301.o
  DTCO    /var/lib/dkms/cm4io-fan/0.2.0/build/overlays/cm4io-fan.dtbo
  MODPOST /var/lib/dkms/cm4io-fan/0.2.0/build/overlays/Module.symvers
make[2]: Leaving directory '/usr/src/linux-headers-6.1.21-v8+'
make[1]: Leaving directory '/var/lib/dkms/cm4io-fan/0.2.0/build/overlays'
  MODPOST /var/lib/dkms/cm4io-fan/0.2.0/build/emc2301/Module.symvers
  CC [M]  /var/lib/dkms/cm4io-fan/0.2.0/build/emc2301/emc2301.mod.o
  LD [M]  /var/lib/dkms/cm4io-fan/0.2.0/build/emc2301/emc2301.ko
make[2]: Leaving directory '/usr/src/linux-headers-6.1.21-v8+'
make[1]: Leaving directory '/var/lib/dkms/cm4io-fan/0.2.0/build/emc2301'

It seems that the kernel 6.1.21-v8+ was used, but after an upgrade I have kernel 6.1.0-rpi7-rpi-v8 and I'm no longer able to build the driver. I added these lines to config.txt:

dtparam=i2c_vc=on
dtoverlay=cm4io-fan,minrpm=500,maxrpm=5000,midtemp=45000,midtemp_hyst=2000,maxtemp=50000,maxtemp_hyst=2000

After Reboot the fan stopped and it starts cooling at 45°. Not satisfying for the moment but it works for me now. If I find time in the next few days I will try to do the installation again.

[TomHW]

Today I made the installation again, here my steps:

1. Make a system upgrade with apt.
2. Install dkms.
3. Clone cm4io-fan repo.
4. Fix install.sh (see my post from April).
5. Run install.sh with no success.
6. Reinstall kernel as mentioned by @kbenyous.

During kernel re-installation the driver will be built with success.

[tht]

Today I made the installation again, here my steps:

1. Make a system upgrade with apt.
2. Install dkms.
3. Clone cm4io-fan repo.
4. Fix install.sh (see my post from April).
5. Run install.sh with no success.
6. Reinstall kernel as mentioned by @kbenyous.

During kernel re-installation the driver will be built with success.

Can confirm… it works for me too after reinstalling the kernel. Strange…

/etc/kernel/postinst.d/dkms:
dkms: running auto installation service for kernel 6.1.21-v8+.
Sign command: /usr/lib/linux-kbuild-6.1/scripts/sign-file
Signing key: /var/lib/dkms/mok.key
Public certificate (MOK): /var/lib/dkms/mok.pub

Building module:
Cleaning build area...
make -j4 KERNELRELEASE=6.1.21-v8+....
Signing module /var/lib/dkms/cm4io-fan/0.2.0/build/emc2301/emc2301.ko

Running the post_build script:
cm4io-fan.dtbo:
 - Post build
   - Copying /var/lib/dkms/cm4io-fan/0.2.0/build/overlays/cm4io-fan.dtbo to /var/lib/dkms/cm4io-fan/0.2.0/6.1.21-v8+/aarch64/module/

Cleaning build area...

emc2301.ko.xz:
Running module version sanity check.
 - Original module
   - No original module exists within this kernel
 - Installation
   - Installing to /lib/modules/6.1.21-v8+/updates/dkms/

Running the post_install script:
cm4io-fan.dtbo:
 - Installation
   - Installing to /boot/overlays/

depmod....
dkms: autoinstall for kernel: 6.1.21-v8+.

Thanks a lot, seems to be working just fine now.

[rahra]

I'm lost here… the Linux-Headers for the current kernel-version are installed. It's a fresh downloaded ans installed 2023-12-11-raspios-bookworm-arm64-lite.

Anyone with an idea what I could be missing here?

Same problem here.
If you manually run sudo make --debug in /var/lib/dkms/cm4io-fan/0.2.0/build it reveals that the build process itself fails for some reason, but I couldn't yet figure out why.

GNU Make 4.3
Built for aarch64-unknown-linux-gnu
Copyright (C) 1988-2020 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
Reading makefiles...
Updating makefiles....
Updating goal targets....
 File '/var/lib/dkms/cm4io-fan/0.2.0/build/overlays/' does not exist.
     File 'FORCE' does not exist.
    Must remake target 'FORCE'.
    Successfully remade target file 'FORCE'.
   Prerequisite 'FORCE' of target '/var/lib/dkms/cm4io-fan/0.2.0/build/overlays/modules.order' does not exist.
  Must remake target '/var/lib/dkms/cm4io-fan/0.2.0/build/overlays/modules.order'.
  Successfully remade target file '/var/lib/dkms/cm4io-fan/0.2.0/build/overlays/modules.order'.
  File '/var/lib/dkms/cm4io-fan/0.2.0/build/overlays/cm4io-fan.dtbo' does not exist.
 Must remake target '/var/lib/dkms/cm4io-fan/0.2.0/build/overlays/cm4io-fan.dtbo'.
make[3]: *** No rule to make target '/var/lib/dkms/cm4io-fan/0.2.0/build/overlays/cm4io-fan.dtbo', needed by '/var/lib/dkms/cm4io-fan/0.2.0/build/overlays/'.  Stop.

[neggles]

Hi all, sorry i've not had time to come back to this for quite a while partly because my CM4 carrier board doesn't have a module on it at the moment (and I don't have a spare)

There were quite a few changes to the way this driver has to hook into the kernel since i last updated it, and i've learned a few more things about how DKMS builds etc. work, so it'll need a bit of rework.

I'll try to come back to this in the near future and get it cleaned up (and updated with some of the other nice bits and pieces from the original author's newer versions, intended for another device)

Sorry for the trouble...