Doc updates

This commit is contained in:
Luke D. Jones
2022-08-21 20:23:55 +12:00
parent 1f697b5ff1
commit a32527d1df
3 changed files with 9 additions and 25 deletions

View File

@@ -9,9 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Create new rog-platform crate to manage all i/o in a universal way - Create new rog-platform crate to manage all i/o in a universal way
+ kbd-led handling (requires kernel patches, TUF specific) + kbd-led handling (requires kernel patches, TUF specific)
+ platform handling (asus-nb-wmi) + platform handling (asus-nb-wmi)
+ power (basic, can be extended in future)
+ hidraw + hidraw
+ usbraw + usbraw
- Refactor how ROGCC handles IPC for background open, run-in-bg - Refactor how ROGCC handles IPC for background open, run-in-bg
- Refactor daemon task creation to be simpler (for development)
### Breaking ### Breaking
- DBUS: rename path `/org/asuslinux/RogBios` to `/org/asuslinux/Platform` - DBUS: rename path `/org/asuslinux/RogBios` to `/org/asuslinux/Platform`
- DBUS: renamed `dedicated_graphic_mode` to `gpu_mux_mode` (`GpuMuxMode`) - DBUS: renamed `dedicated_graphic_mode` to `gpu_mux_mode` (`GpuMuxMode`)

View File

@@ -21,8 +21,8 @@ Now includes a GUI, `rog-control-center`.
4. Respect the users resources: be small, light, and fast 4. Respect the users resources: be small, light, and fast
Point 3 means that the list of supported distros is very narrow - fedora is explicitly Point 3 means that the list of supported distros is very narrow - fedora is explicitly
supported, while Ubuntu and openSUSE are level-2 support. All other distros are *not* supported. All other distros are *not* supported (while asusd might still run fine on them).
supported (while asusd might still run fine on them). For best support use fedora 32+ Workstation. For best support use fedora 36+ Workstation.
Point 4? asusd currently uses a tiny fraction of cpu time, and less than 1Mb of ram, the way Point 4? asusd currently uses a tiny fraction of cpu time, and less than 1Mb of ram, the way
a system-level daemon should. a system-level daemon should.
@@ -41,18 +41,10 @@ Bus 001 Device 002: ID 0b05:1866 ASUSTek Computer, Inc. N-KEY Device
``` ```
then it may work without tweaks. Technically all other functions except the LED then it may work without tweaks. Technically all other functions except the LED
and AniMe parts should work regardless of your latop make. Eventually this project and AniMe parts should work regardless of your latop make.
will probably suffer another rename once it becomes generic enough to do so.
### Unsupported (e.g, TUF laptops) **TUF Laptops**: support is coming. I recently aquired one of these machines and have written
various patches for the kernel to add proper support (e.g, RGB control).
- `sudo systemctl mask asusd && sudo systemctl stop asusd`
- `copy asusd-alt.service to /etc/systemd/system/`
- `sudo systemctl enable asusd-alt`
- `sudo systemctl start asusd-alt`
- `asusctl -s`
`asusd-alt.service` is in the `data` dir of this repo.
## Implemented ## Implemented
@@ -66,7 +58,7 @@ will probably suffer another rename once it becomes generic enough to do so.
- [X] Set battery charge limit (with kernel supporting this) - [X] Set battery charge limit (with kernel supporting this)
- [X] Fan curve control on G14 + G15. Requires kernel patch (should reach 5.15 kernel) - [X] Fan curve control on G14 + G15. Requires kernel patch (should reach 5.15 kernel)
- [X] Toggle bios setting for boot/POST sound - [X] Toggle bios setting for boot/POST sound
- [X] Toggle bios setting for "dedicated gfx" mode on supported laptops (g-sync) - [X] Toggle bios setting for "dedicated gfx" mode on supported laptops (g-sync, or called MUX on 2022+ laptops)
# GUI # GUI

View File

@@ -9,17 +9,7 @@ pub mod ctrl_aura;
pub mod ctrl_platform; pub mod ctrl_platform;
/// Control of battery charge level /// Control of battery charge level
pub mod ctrl_power; pub mod ctrl_power;
/// Control CPU min/max freq and turbo, fan mode, fan curves /// Control platform profiles + fan-curves if available
///
/// Intel machines can control:
/// - CPU min/max frequency
/// - CPU turbo enable/disable
/// - Fan mode (normal, boost, silent)
///
/// AMD machines can control:
/// - CPU turbo enable/disable
/// - Fan mode (normal, boost, silent)
/// - Fan min/max RPM curve
pub mod ctrl_profiles; pub mod ctrl_profiles;
/// Laptop matching to determine capabilities /// Laptop matching to determine capabilities
pub mod laptops; pub mod laptops;