aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 21 insertions, 2 deletions
diff --git a/README.md b/README.md
index 7fa2427..66db318 100644
--- a/README.md
+++ b/README.md
@@ -59,6 +59,25 @@ control, audio processor, etc). It is also not good quality enough to be
upstreamable. It has been sufficient for my usage, so I didn't take the time
to improve it.
+The Linux kernel module should build fine on a system with a recent kernel
+(so far I only tested 5.4 and 5.5) and with the kernel headers available. It
+could be built and installed with the following command:
+
+```
+ cd tas5825m-module
+ make
+ make modules_install
+```
+
+The tricky part is to modify the device tree to get the board recognized by
+the kernel. In the long term the 24L32 EEPROM should be used for that, but I
+haven't look at how it works yet. The patch I use on my system is
+[available](tas5825m-module/dts.patch), it should probably be adapted
+depending on the system and the kernel version. I used the `dtc` tool to dump
+the original device tree binary file into a source format, and later to
+rebuild the binary version. It should be easier to use device tree overlays
+but again I haven't looked at that yet.
+
## Sources
@@ -68,5 +87,5 @@ All the sources of the repository are available
## License
-The contents of this repository is released under the
-[Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0)](LICENSE).
+The contents of this repository, excluding the `tas5825m-module` directory, is
+released under the [Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0)](LICENSE).