https://github.com/shadowblip/ayn-platform
Linux drivers for AYN x86 handhelds providing a hwmon interface for pwm fan control and temperature sensors, as well as RGB control.
https://github.com/shadowblip/ayn-platform
Last synced: about 2 months ago
JSON representation
Linux drivers for AYN x86 handhelds providing a hwmon interface for pwm fan control and temperature sensors, as well as RGB control.
- Host: GitHub
- URL: https://github.com/shadowblip/ayn-platform
- Owner: ShadowBlip
- License: gpl-2.0
- Created: 2023-08-06T16:57:34.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-15T02:47:00.000Z (3 months ago)
- Last Synced: 2025-04-06T20:22:46.202Z (2 months ago)
- Language: C
- Homepage:
- Size: 50.8 KB
- Stars: 6
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Platform driver for AYN x86 handhelds
This driver provides a hwmon interface for PWM control, as well as access
to temperature sensors provided by the system EC
Supported devices include:
- AYN Loki Max
## Build
If you only want to build and test the module (you need headers for your
kernel):
```shell
$ git clone https://github.com/ShadowBlip/ayn-platform.git
$ cd ayn-platform
$ make
```
Then insert the module and check `sensors` and `dmesg` if appropriate:
```shell
# insmod ayn-platform.ko
$ sensors
aynec-isa-0000
Adapter: ISA adapter
fan1: 3007 RPM
Battery: +29.0°C
Motherboard: +41.0°C
Charger IC: +38.0°C
vCore: +48.0°C
CPU Core: +48.0°C
```
## Install
You'll need appropriate headers for your kernel and `dkms` package from your
distribution.
```shell
$ git clone https://github.com/ShadowBlip/ayn-platform.git
$ cd ayn-platform
$ make
# make dkms
```
## Usage
Insert the module with `insmod`. Then look for a `hwmon` device with name
`aynec`, i.e.:
`$ cat /sys/class/hwmon/hwmon?/name`
### Reading fan RPM
`sensors` will show the fan RPM as read from the EC. You can also read the
file `fan1_input` to get the fan RPM.
### Fan Control
***Warning: controlling the fan without an accurate reading of the CPU, GPU,
and Battery temperature can cause irreversible damage to the device. Use at
your own risk!***
#### Automatic Control
This will use the BIOS default fan curve and is the default setting of the EC.
To enable automatic control of the fan (assuming `hwmon5` is our driver, look for
`aynec` in the `name` file):
`# echo 0 > /sys/class/hwmon/hwmon5/pwm1_enable`
#### Manual Control
This mode is useful to explicitly set a fan speed, or with the use of userspace
tools that adjust fan speed using a custom fan curve defined in software.
To enable manual control of the fan (assuming `hwmon5` is our driver, look for
`aynec` in the `name` file):
`# echo 1 > /sys/class/hwmon/hwmon5/pwm1_enable`
Then input values in the range `[0-255]` to the pwm:
`# echo 100 > /sys/class/hwmon/hwmon5/pwm1`
#### User Defined Control
This mode allows the user to override the default BIOS fan curve with a user
defined fan curve. There are 5 set point pairs for temperature and fan speed.
The temperature value is a cutoff for that set point, any CPU temperature
below that point and above the lower set point will run at that set points
fan speed. Temperature is in degrees Celsius.
To enable user defined control of the fan (assuming `hwmon5` is our driver,
look for `aynec` in the `name` file):
`# echo 2 > /sys/class/hwmon/hwmon5/pwm1_enable`
Set an input value in the range `[0-255]` to the pwm:
`# echo 100 > /sys/class/hwmon/hwmon5/pwm1_auto_point1_pwm`
Set an input value in the range `[0-100]` to the temp:
`# echo 50 > /sys/class/hwmon/hwmon5/pwm1_auto_point1_temp`
### RGB Control
RGB control is available using the character files found in the following location:
`/sys/class/leds/multicolor:chassis/` . Writing to the files within this directory
can be done using the pattern `echo | sudo tee `
#### Mode Setting
There are two modes available, `Rainbow Breathing` is represented by the value `0`
and `Manual` is represented by the value `1`. When in Rainbow Breathing mode,
brightness and color intensity changes are ignored. You must be in Manual mode to
adjust the color or brightness of the LED's.
To change modes:
`echo 1 | sudo tee /sys/class/leds/multicolor:chassis/device/led_mode`
#### Identifying and Setting Color Values
You can read the `brightness`, `multi_index`, and `multi_intensity` from their
respective files in `/sys/class/leds/multicolor:chassis/` . Each do the following:
brightness: The current average luminosity of all three colors in the range `[0-255]`.
Setting this to `0` will turn off the LED's while setting it to `255` represents the
maximum luminosity of the selected multi_intensity range.
multi_index: Displays the order of the colors when setting multi_intensity. Set to
`red green blue`.
multi_intensity: The current intensity of each individual color [0-255] where 0 is off
and 255 is most luminous. The value is dispalyed and set with three numbers separated
by a single space. Each of these values is multiplied by the current brightness and
divided by the maximum brightness when setting the true value. A setting of `0 0 0` is
off and `255 255 255` represents all colors at maximum intensity.
## Changing Startup Defaults
The platform driver is fully exposed over systemd udev. This can be used to write udev rules that set attributes at startup.
### Udev Attributes Tree
#### LEDs
```$ udevadm info --attribute-walk /sys/class/leds/multicolor:chassis
looking at device '/devices/platform/ayn-platform/leds/multicolor:chassis':
KERNEL=="multicolor:chassis"
SUBSYSTEM=="leds"
DRIVER==""
ATTR{brightness}=="0"
ATTR{led_mode}=="1"
ATTR{max_brightness}=="255"
ATTR{multi_index}=="red green blue"
ATTR{multi_intensity}=="0 0 0"
ATTR{power/control}=="auto"
ATTR{power/runtime_active_time}=="0"
ATTR{power/runtime_status}=="unsupported"
ATTR{power/runtime_suspended_time}=="0"
ATTR{trigger}=="[none] usb-gadget usb-host rc-feedback kbd-scrolllock kbd-numlock kbd-capslock kbd-kanalock kbd-shiftlock kbd-altgrlock kbd-ctrllock kbd-altlock kbd-shiftllock kbd-shiftrlock kbd-ctrlllock kbd-ctrlrlock ACAD-online >
looking at parent device '/devices/platform/ayn-platform':
KERNELS=="ayn-platform"
SUBSYSTEMS=="platform"
DRIVERS=="ayn-platform"
ATTRS{driver_override}=="(null)"
ATTRS{power/control}=="auto"
ATTRS{power/runtime_active_time}=="0"
ATTRS{power/runtime_status}=="unsupported"
ATTRS{power/runtime_suspended_time}=="0"
looking at parent device '/devices/platform':
KERNELS=="platform"
SUBSYSTEMS==""
DRIVERS==""
ATTRS{power/control}=="auto"
ATTRS{power/runtime_active_time}=="0"
ATTRS{power/runtime_status}=="unsupported"
ATTRS{power/runtime_suspended_time}=="0"
```
#### hwmon
```
$ udevadm info --attribute-walk /sys/class/hwmon/hwmon6
looking at device '/devices/platform/ayn-platform/hwmon/hwmon6':
KERNEL=="hwmon6"
SUBSYSTEM=="hwmon"
DRIVER==""
ATTR{fan1_input}=="3032"
ATTR{name}=="aynec"
ATTR{power/control}=="auto"
ATTR{power/runtime_active_time}=="0"
ATTR{power/runtime_status}=="unsupported"
ATTR{power/runtime_suspended_time}=="0"
ATTR{pwm1}=="64"
ATTR{pwm1_auto_point1_pwm}=="0"
ATTR{pwm1_auto_point1_temp}=="0"
ATTR{pwm1_auto_point2_pwm}=="0"
ATTR{pwm1_auto_point2_temp}=="0"
ATTR{pwm1_auto_point3_pwm}=="0"
ATTR{pwm1_auto_point3_temp}=="0"
ATTR{pwm1_auto_point4_pwm}=="0"
ATTR{pwm1_auto_point4_temp}=="0"
ATTR{pwm1_auto_point5_pwm}=="0"
ATTR{pwm1_auto_point5_temp}=="0"
ATTR{pwm1_enable}=="0"
ATTR{temp1_input}=="35000"
ATTR{temp1_label}=="Battery"
ATTR{temp2_input}=="42000"
ATTR{temp2_label}=="Motherboard"
ATTR{temp3_input}=="53000"
ATTR{temp3_label}=="Charger IC"
ATTR{temp4_input}=="48000"
ATTR{temp4_label}=="vCore"
ATTR{temp5_input}=="47000"
ATTR{temp5_label}=="CPU Core"
looking at parent device '/devices/platform/ayn-platform':
KERNELS=="ayn-platform"
SUBSYSTEMS=="platform"
DRIVERS=="ayn-platform"
ATTRS{driver_override}=="(null)"
ATTRS{power/control}=="auto"
ATTRS{power/runtime_active_time}=="0"
ATTRS{power/runtime_status}=="unsupported"
ATTRS{power/runtime_suspended_time}=="0"
looking at parent device '/devices/platform':
KERNELS=="platform"
SUBSYSTEMS==""
DRIVERS==""
ATTRS{power/control}=="auto"
ATTRS{power/runtime_active_time}=="0"
ATTRS{power/runtime_status}=="unsupported"
ATTRS{power/runtime_suspended_time}=="0"
```
### Creating a rule
You can store a udev rule as `/etc/udev/rules.d/##-rule_name.rules`
All rules will start like this:
`ACTION=="add|change", KERNEL=="multicolor:chassis", SUBSYSTEM=="leds"`
To define a default, add the attribute in the format `ATTR{name}=value`
LEDs valid attributes are:
```
ATTR{brightness}=="[0-255]"
ATTR{led_mode}=="[0-1]"
ATTR{multi_intensity}=="[0-255] [0-255] [0-255]"
```
hwmon valid attributes are:
```
ATTR{pwm1}=="[0-100]"
ATTR{pwm1_auto_point1_pwm}=="[0-255]"
ATTR{pwm1_auto_point1_temp}=="[0-100]"
ATTR{pwm1_auto_point2_pwm}=="[0-255]"
ATTR{pwm1_auto_point2_temp}=="[0-100]"
ATTR{pwm1_auto_point3_pwm}=="[0-255]"
ATTR{pwm1_auto_point3_temp}=="[0-100]"
ATTR{pwm1_auto_point4_pwm}=="[0-255]"
ATTR{pwm1_auto_point4_temp}=="[0-100]"
ATTR{pwm1_auto_point5_pwm}=="[0-255]"
ATTR{pwm1_auto_point5_temp}=="[0-100]"
ATTR{pwm1_enable}=="[0-2]"
```
As en example, to set the LED's to breath:
`
ACTION=="add|change", KERNEL=="multicolor:chassis", SUBSYSTEM=="leds", ATTR{led_mode}=="0"
`
to create the rule in one line:
```shell
$ echo 'ACTION=="add|change", KERNEL=="multicolor:chassis", SUBSYSTEM=="leds", ATTR{led_mode}=="0"' | sudo tee /etc/udev/rules.d/99-led_startup.rules
```