diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..69d8af85afafdaa818339f58cd6110c2f565dfbf --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +A kernel module that exposes the Framework Laptop (13, 16)'s battery charge limit and LEDs to userspace. + +## Building + +By default, this project will try to build a module for your running kernel. + +```console +$ make +``` + +If you need to target a different kernel, set `KDIR`: + +```console +$ make KDIR=/usr/src/linux-6.5 +``` + +## Using + +You can install the module systemwide with `make modules_install`, or you can `insmod ./framework_laptop.ko`. + +### Battery Charge Limit + +- Exposed via `charge_control_end_threshold`, available on `BAT1` + - `/sys/class/power_supply/BAT1/charge_control_end_threshold` + +### LEDs + +- `/sys/class/leds/framework_laptop::kbd_backlight`