diff --git a/Customization.md b/Customization.md new file mode 100644 index 0000000..bad20e5 --- /dev/null +++ b/Customization.md @@ -0,0 +1,71 @@ +As of v1.1.0, PowerTools supports customizing values for most functionality. This can be useful for advanced uses like overclocking or untested hardware. Please remember that the [terms of the license](https://github.com/NGnius/PowerTools/blob/main/LICENSE) place all responsibility on the user to use these features responsibly. + +# Steam Deck + +The Steam Deck driver has an optional advanced mode which is activated when a valid `pt_oc.json` JSON file is present in the `~/.config/powertools` folder. This file roughly reflects the design of PowerTools internal Steam Deck drivers. + +The structure and default values are defined in [oc_limits.rs](https://github.com/NGnius/PowerTools/blob/dev/backend/src/settings/steam_deck/oc_limits.rs). If you do not understand the [JSON sample](https://github.com/NGnius/PowerTools/blob/dev/pt_oc.json) as well as the [Rust declaration](https://github.com/NGnius/PowerTools/blob/dev/backend/src/settings/steam_deck/oc_limits.rs) you should not use this feature. + +## battery + +The top-level `battery` object contains the custom configuration for the battery part of the Steam Deck driver. Presently, this only contains 1 field. + +### charge_rate + +Bounds for the battery inrush current, in milliamps. The limits are expressed in the format `{"min": u64, "max": u64}`. + +## cpus + +### cpus + +A list of CPU objects corresponding to each hardware CPU thread in the same order as the Linux kernel. Extra CPUs in this list will be ignored, missing CPUs in this list will not be possible to change through PowerTools. + +#### clock_min + +Bounds for the CPU minimum frequency, in MHz. The limits are expressed in the format `{"min": u64, "max": u64}`. + +#### clock_max + +Bounds for the CPU maximum frequency, in MHz. The limits are expressed in the format `{"min": u64, "max": u64}`. + +#### clock_step + +CPU frequency slider quanta. This is a `u64`. + +### global_governors + +A boolean (`true` or `false`) to enable or disable the UI element which sets the governors of all CPUs at once. + +## gpu + +### fast_ppt + +Bounds for the GPU fast PPT value, in W/`ppt_divisor`. The limits are expressed in the format `{"min": u64, "max": u64}`. + +### slow_ppt + +Bounds for the GPU slow PPT value, in W/`ppt_divisor`. The limits are expressed in the format `{"min": u64, "max": u64}`. + +### ppt_divisor + +Divisor for the PPT values. This is a `u64`. + +### ppt_step + +GPU PPT slider quanta. This is a `u64`. + +### clock_min + +Bounds for the GPU minimum frequency, in MHz. The limits are expressed in the format `{"min": u64, "max": u64}`. + +### clock_max + +Bounds for the GPU maximum frequency, in MHz. The limits are expressed in the format `{"min": u64, "max": u64}`. + +### clock_step + +GPU frequency slider quanta. This is a `u64`. + +# Other AMD APUs + +// TODO \ No newline at end of file