RGBCube/superfreq
1
Fork 0
mirror of https://github.com/RGBCube/superfreq synced 2025-07-27 17:07:44 +00:00
Code Issues Activity

treewide: finish rename

Browse source
This commit is contained in:
RGBCube 2025-06-07 00:46:04 +03:00
parent 841ea830c6
commit da3f7935be
Signed by: RGBCube
SSH key fingerprint: SHA256:CzqbPcfwt+GxFYNnFVCqoN5Itn4YFrshg1TrnACpA5M
6 changed files with 77 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

9
.github/workflows/release.yml vendored
View file

@ -30,11 +30,11 @@ jobs:
include: include:
- os: ubuntu-latest - os: ubuntu-latest
target: x86_64-unknown-linux-gnu target: x86_64-unknown-linux-gnu
name: superfreq-linux-amd64 name: watt-linux-amd64
cross: false cross: false
- os: ubuntu-latest - os: ubuntu-latest
target: aarch64-unknown-linux-gnu target: aarch64-unknown-linux-gnu
name: superfreq-linux-arm64 name: watt-linux-arm64
cross: true cross: true
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
@ -88,16 +88,15 @@ jobs:
uses: robinraju/release-downloader@v1 uses: robinraju/release-downloader@v1
with: with:
tag: ${{ github.ref_name }} tag: ${{ github.ref_name }}
fileName: "superfreq-*" fileName: "watt-*"
out-file-path: "." out-file-path: "."
- name: Generate checksums - name: Generate checksums
run: | run: |
sha256sum superfreq-* > SHA256SUMS sha256sum watt-* > SHA256SUMS
- name: Upload Checksums - name: Upload Checksums
uses: softprops/action-gh-release@v2 uses: softprops/action-gh-release@v2
with: with:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
files: SHA256SUMS files: SHA256SUMS

98
README.md
View file

@ -1,5 +1,5 @@
<h1 id="header" align="center"> <h1 id="header" align="center">
Superfreq Watt
</h1> </h1>
<div align="center"> <div align="center">
@ -8,17 +8,17 @@
<div align="center"> <div align="center">
<br/> <br/>
<a href="#what-is-superfreq">Synopsis</a><br/> <a href="#what-is-watt">Synopsis</a><br/>
<a href="#features">Features</a> | <a href="#usage">Usage</a><br/> <a href="#features">Features</a> | <a href="#usage">Usage</a><br/>
<a href="#contributing">Contributing</a> <a href="#contributing">Contributing</a>
<br/> <br/>
</div> </div>
## What is Superfreq ## What is Watt
Superfreq is a modern CPU frequency and power management utility for Linux Watt is a modern CPU frequency and power management utility for Linux systems.
systems. It provides intelligent control of CPU governors, frequencies, and It provides intelligent control of CPU governors, frequencies, and power-saving
power-saving features, helping optimize both performance and battery life. features, helping optimize both performance and battery life.
It is greatly inspired by auto-cpufreq, but rewritten from ground up to provide It is greatly inspired by auto-cpufreq, but rewritten from ground up to provide
a smoother experience with a more efficient and more correct codebase. Some a smoother experience with a more efficient and more correct codebase. Some
@ -48,81 +48,81 @@ but most common usecases are already implemented.
```bash ```bash
# Show current system information # Show current system information
superfreq info watt info
# Run as a daemon in the background # Run as a daemon in the background
sudo superfreq daemon sudo watt daemon
# Run with verbose logging # Run with verbose logging
sudo superfreq daemon --verbose sudo watt daemon --verbose
# Display comprehensive debug information # Display comprehensive debug information
superfreq debug watt debug
``` ```
### CPU Governor Control ### CPU Governor Control
```bash ```bash
# Set CPU governor for all cores # Set CPU governor for all cores
sudo superfreq set-governor performance sudo watt set-governor performance
# Set CPU governor for a specific core # Set CPU governor for a specific core
sudo superfreq set-governor powersave --core-id 0 sudo watt set-governor powersave --core-id 0
# Force a specific governor mode persistently # Force a specific governor mode persistently
sudo superfreq force-governor performance sudo watt force-governor performance
``` ```
### Turbo Boost Management ### Turbo Boost Management
```bash ```bash
# Always enable turbo boost # Always enable turbo boost
sudo superfreq set-turbo always sudo watt set-turbo always
# Disable turbo boost # Disable turbo boost
sudo superfreq set-turbo never sudo watt set-turbo never
# Let Superfreq manage turbo boost based on conditions # Let Watt manage turbo boost based on conditions
sudo superfreq set-turbo auto sudo watt set-turbo auto
``` ```
### Power and Performance Settings ### Power and Performance Settings
```bash ```bash
# Set Energy Performance Preference (EPP) # Set Energy Performance Preference (EPP)
sudo superfreq set-epp performance sudo watt set-epp performance
# Set Energy Performance Bias (EPB) # Set Energy Performance Bias (EPB)
sudo superfreq set-epb 4 sudo watt set-epb 4
# Set ACPI platform profile # Set ACPI platform profile
sudo superfreq set-platform-profile balanced sudo watt set-platform-profile balanced
``` ```
### Frequency Control ### Frequency Control
```bash ```bash
# Set minimum CPU frequency (in MHz) # Set minimum CPU frequency (in MHz)
sudo superfreq set-min-freq 800 sudo watt set-min-freq 800
# Set maximum CPU frequency (in MHz) # Set maximum CPU frequency (in MHz)
sudo superfreq set-max-freq 3000 sudo watt set-max-freq 3000
# Set per-core frequency limits # Set per-core frequency limits
sudo superfreq set-min-freq 1200 --core-id 0 sudo watt set-min-freq 1200 --core-id 0
sudo superfreq set-max-freq 2800 --core-id 1 sudo watt set-max-freq 2800 --core-id 1
``` ```
### Battery Management ### Battery Management
```bash ```bash
# Set battery charging thresholds to extend battery lifespan # Set battery charging thresholds to extend battery lifespan
sudo superfreq set-battery-thresholds 40 80 # Start charging at 40%, stop at 80% sudo watt set-battery-thresholds 40 80 # Start charging at 40%, stop at 80%
``` ```
Battery charging thresholds help extend battery longevity by preventing constant Battery charging thresholds help extend battery longevity by preventing constant
charging to 100%. Different laptop vendors implement this feature differently, charging to 100%. Different laptop vendors implement this feature differently,
but Superfreq attempts to support multiple vendor implementations including: but Watt attempts to support multiple vendor implementations including:
- Lenovo ThinkPad/IdeaPad (Standard implementation) - Lenovo ThinkPad/IdeaPad (Standard implementation)
- ASUS laptops - ASUS laptops
@ -135,12 +135,12 @@ more than issue reports, as supporting hardware _needs_ hardware.
## Configuration ## Configuration
Superfreq uses TOML configuration files. Default locations: Watt uses TOML configuration files. Default locations:
- `/etc/xdg/superfreq/config.toml` - `/etc/xdg/watt/config.toml`
- `/etc/superfreq.toml` - `/etc/watt.toml`
You can also specify a custom path by setting the `SUPERFREQ_CONFIG` environment You can also specify a custom path by setting the `WATT_CONFIG` environment
variable. variable.
### Sample Configuration ### Sample Configuration
@ -214,7 +214,7 @@ throttle_on_battery = true
# Logging level: Error, Warning, Info, Debug # Logging level: Error, Warning, Info, Debug
log_level = "Info" log_level = "Info"
# Optional stats file path # Optional stats file path
stats_file_path = "/var/run/superfreq-stats" stats_file_path = "/var/run/watt-stats"
# Optional: List of power supplies to ignore # Optional: List of power supplies to ignore
[power_supply_ignore_list] [power_supply_ignore_list]
@ -224,14 +224,14 @@ mouse_battery = "hid-12:34:56:78:90:ab-battery"
## Advanced Features ## Advanced Features
Those are the more advanced features of Superfreq that some users might be more Those are the more advanced features of Watt that some users might be more
inclined to use than others. If you have a use-case that is not covered, please inclined to use than others. If you have a use-case that is not covered, please
create an issue. create an issue.
### Dynamic Turbo Boost Management ### Dynamic Turbo Boost Management
When using `turbo = "auto"` with `enable_auto_turbo = true`, Superfreq When using `turbo = "auto"` with `enable_auto_turbo = true`, Watt dynamically
dynamically controls CPU turbo boost based on: controls CPU turbo boost based on:
- **CPU Load Thresholds**: Enables turbo when load exceeds `load_threshold_high` - **CPU Load Thresholds**: Enables turbo when load exceeds `load_threshold_high`
(default 70%), disables when below `load_threshold_low` (default 30%) (default 70%), disables when below `load_threshold_low` (default 30%)
@ -256,21 +256,21 @@ performance for demanding tasks while conserving energy during light workloads.
The table below explains how different combinations of `turbo` and The table below explains how different combinations of `turbo` and
`enable_auto_turbo` settings affect CPU turbo behavior: `enable_auto_turbo` settings affect CPU turbo behavior:
| Setting | `enable_auto_turbo = true` | `enable_auto_turbo = false` | | Setting | `enable_auto_turbo = true` | `enable_auto_turbo = false` |
| ------------------ | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | | ------------------ | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `turbo = "always"` | **Always enabled**<br>Turbo is always active regardless of CPU load or temperature | **Always enabled**<br>Turbo is always active regardless of CPU load or temperature | | `turbo = "always"` | **Always enabled**<br>Turbo is always active regardless of CPU load or temperature | **Always enabled**<br>Turbo is always active regardless of CPU load or temperature |
| `turbo = "never"` | **Always disabled**<br>Turbo is always disabled regardless of CPU load or temperature | **Always disabled**<br>Turbo is always disabled regardless of CPU load or temperature | | `turbo = "never"` | **Always disabled**<br>Turbo is always disabled regardless of CPU load or temperature | **Always disabled**<br>Turbo is always disabled regardless of CPU load or temperature |
| `turbo = "auto"` | **Dynamically managed**<br>Superfreq enables/disables turbo based on CPU load and temperature thresholds | **System default**<br>Turbo is reset to system's default enabled state and is managed by the hardware/kernel | | `turbo = "auto"` | **Dynamically managed**<br>Watt enables/disables turbo based on CPU load and temperature thresholds | **System default**<br>Turbo is reset to system's default enabled state and is managed by the hardware/kernel |
> [!NOTE] > [!NOTE]
> When `turbo = "auto"` and `enable_auto_turbo = false`, Superfreq ensures that > When `turbo = "auto"` and `enable_auto_turbo = false`, Watt ensures that any
> any previous turbo state restrictions are removed, allowing the > previous turbo state restrictions are removed, allowing the hardware/kernel to
> hardware/kernel to manage turbo behavior according to its default algorithms. > manage turbo behavior according to its default algorithms.
### Adaptive Polling ### Adaptive Polling
Superfreq includes a "sophisticated" (euphemism for complicated) adaptive Watt includes a "sophisticated" (euphemism for complicated) adaptive polling
polling system to try and maximize power efficiency system to try and maximize power efficiency
- **Battery Discharge Analysis** - Automatically adjusts polling frequency based - **Battery Discharge Analysis** - Automatically adjusts polling frequency based
on the battery discharge rate, reducing system activity when battery is on the battery discharge rate, reducing system activity when battery is
@ -294,8 +294,8 @@ idle periods, while maintaining responsiveness when needed.
### Power Supply Filtering ### Power Supply Filtering
Configure Superfreq to ignore certain power supplies (like peripheral batteries) Configure Watt to ignore certain power supplies (like peripheral batteries) that
that might interfere with power state detection. might interfere with power state detection.
## Troubleshooting ## Troubleshooting
@ -319,11 +319,11 @@ Not all features are available on all hardware:
2. **CPU frequencies fluctuating**: May be due to thermal throttling 2. **CPU frequencies fluctuating**: May be due to thermal throttling
3. **Missing CPU information**: Verify kernel module support for your CPU 3. **Missing CPU information**: Verify kernel module support for your CPU
While reporting issues, please attach the results from `superfreq debug`. While reporting issues, please attach the results from `watt debug`.
## Contributing ## Contributing
Contributions to Superfreq are always welcome! Whether it's bug reports, feature Contributions to Watt are always welcome! Whether it's bug reports, feature
requests, or code contributions, please feel free to contribute. requests, or code contributions, please feel free to contribute.
> [!NOTE] > [!NOTE]
@ -357,5 +357,5 @@ before committing to catch possible code smell early.
## License ## License
Superfreq is available under [Mozilla Public License v2.0](LICENSE) for your Watt is available under [Mozilla Public License v2.0](LICENSE) for your
convenience, and at our expense. Please see the license file for more details. convenience, and at our expense. Please see the license file for more details.

14
flake.nix
View file

@ -14,16 +14,16 @@
}); });
in { in {
overlays = { overlays = {
superfreq = final: _: { watt = final: _: {
superfreq = final.callPackage ./nix/package.nix {}; watt = final.callPackage ./nix/package.nix {};
}; };
default = self.overlays.superfreq; default = self.overlays.watt;
}; };
packages = packages =
nixpkgs.lib.mapAttrs (system: pkgs: { nixpkgs.lib.mapAttrs (system: pkgs: {
inherit (pkgs) superfreq; inherit (pkgs) watt;
default = self.packages.${system}.superfreq; default = self.packages.${system}.watt;
}) })
pkgsForEach; pkgsForEach;
@ -34,8 +34,8 @@
pkgsForEach; pkgsForEach;
nixosModules = { nixosModules = {
superfreq = import ./nix/module.nix inputs; watt = import ./nix/module.nix inputs;
default = self.nixosModules.superfreq; default = self.nixosModules.watt;
}; };
formatter = forAllSystems (system: nixpkgs.legacyPackages.${system}.alejandra); formatter = forAllSystems (system: nixpkgs.legacyPackages.${system}.alejandra);

24
nix/module.nix
View file

@ -10,32 +10,32 @@ inputs: {
inherit (lib.lists) optional; inherit (lib.lists) optional;
inherit (lib.meta) getExe; inherit (lib.meta) getExe;
cfg = config.services.superfreq; cfg = config.services.watt;
format = pkgs.formats.toml {}; format = pkgs.formats.toml {};
cfgFile = format.generate "superfreq-config.toml" cfg.settings; cfgFile = format.generate "watt-config.toml" cfg.settings;
in { in {
options.services.superfreq = { options.services.watt = {
enable = mkEnableOption "Automatic CPU speed & power optimizer for Linux"; enable = mkEnableOption "Automatic CPU speed & power optimizer for Linux";
package = mkPackageOption inputs.self.packages.${pkgs.stdenv.system} "superfreq" { package = mkPackageOption inputs.self.packages.${pkgs.stdenv.system} "watt" {
pkgsText = "self.packages.\${pkgs.stdenv.system}"; pkgsText = "self.packages.\${pkgs.stdenv.system}";
}; };
settings = mkOption { settings = mkOption {
default = {}; default = {};
type = submodule {freeformType = format.type;}; type = submodule {freeformType = format.type;};
description = "Configuration for Superfreq."; description = "Configuration for Watt.";
}; };
}; };
config = mkIf cfg.enable { config = mkIf cfg.enable {
environment.systemPackages = [cfg.package]; environment.systemPackages = [cfg.package];
# This is necessary for the Superfreq CLI. The environment variable # This is necessary for the Watt CLI. The environment variable
# passed to the systemd service will take priority in read order. # passed to the systemd service will take priority in read order.
environment.etc."superfreq.toml".source = cfgFile; environment.etc."watt.toml".source = cfgFile;
systemd.services.superfreq = { systemd.services.watt = {
wantedBy = ["multi-user.target"]; wantedBy = ["multi-user.target"];
conflicts = [ conflicts = [
"auto-cpufreq.service" "auto-cpufreq.service"
@ -45,12 +45,12 @@ in {
"thermald.service" "thermald.service"
]; ];
serviceConfig = { serviceConfig = {
Environment = optional (cfg.settings != {}) ["SUPERFREQ_CONFIG=${cfgFile}"]; Environment = optional (cfg.settings != {}) ["WATT_CONFIG=${cfgFile}"];
WorkingDirectory = ""; WorkingDirectory = "";
ExecStart = "${getExe cfg.package} daemon --verbose"; ExecStart = "${getExe cfg.package} daemon --verbose";
Restart = "on-failure"; Restart = "on-failure";
RuntimeDirectory = "superfreq"; RuntimeDirectory = "watt";
RuntimeDirectoryMode = "0755"; RuntimeDirectoryMode = "0755";
}; };
}; };
@ -60,14 +60,14 @@ in {
assertion = !config.services.power-profiles-daemon.enable; assertion = !config.services.power-profiles-daemon.enable;
message = '' message = ''
You have set services.power-profiles-daemon.enable = true; You have set services.power-profiles-daemon.enable = true;
which conflicts with Superfreq. which conflicts with Watt.
''; '';
} }
{ {
assertion = !config.services.auto-cpufreq.enable; assertion = !config.services.auto-cpufreq.enable;
message = '' message = ''
You have set services.auto-cpufreq.enable = true; You have set services.auto-cpufreq.enable = true;
which conflicts with Superfreq. which conflicts with Watt.
''; '';
} }
]; ];

8
nix/package.nix
View file

@ -5,7 +5,7 @@
fs = lib.fileset; fs = lib.fileset;
in in
rustPlatform.buildRustPackage (finalAttrs: { rustPlatform.buildRustPackage (finalAttrs: {
pname = "superfreq"; pname = "watt";
version = "0.1.0"; version = "0.1.0";
src = fs.toSource { src = fs.toSource {
@ -24,14 +24,14 @@ in
meta = { meta = {
description = "Automatic CPU speed & power optimizer for Linux"; description = "Automatic CPU speed & power optimizer for Linux";
longDescription = '' longDescription = ''
Superfreq is a CPU speed & power optimizer for Linux. It uses Watt is a CPU speed & power optimizer for Linux. It uses
the CPU frequency scaling driver to set the CPU frequency the CPU frequency scaling driver to set the CPU frequency
governor and the CPU power management driver to set the CPU governor and the CPU power management driver to set the CPU
power management mode. power management mode.
''; '';
homepage = "https://github.com/NotAShelf/superfreq"; homepage = "https://github.com/NotAShelf/watt";
mainProgram = "superfreq"; mainProgram = "watt";
license = lib.licenses.mpl20; license = lib.licenses.mpl20;
platforms = lib.platforms.linux; platforms = lib.platforms.linux;
}; };

2
src/engine.rs
View file

@ -204,7 +204,7 @@ pub fn determine_and_apply_settings(
manage_auto_turbo(report, selected_profile_config, on_ac_power)?; manage_auto_turbo(report, selected_profile_config, on_ac_power)?;
} else { } else {
log::debug!( log::debug!(
"Superfreq's dynamic turbo management is disabled by configuration. Ensuring system uses its default behavior for automatic turbo control." "Watt's dynamic turbo management is disabled by configuration. Ensuring system uses its default behavior for automatic turbo control."
); );
// Make sure the system is set to its default automatic turbo mode. // Make sure the system is set to its default automatic turbo mode.
// This is important if turbo was previously forced off. // This is important if turbo was previously forced off.