Sys-clk Switch

sys-clk
sys-clk
	File:Sysclkswitch.png
General
Author	RetroNX Team
Type	Plugins
Version	1.0.3
License	Mixed
Last Updated	2023/04/21
Links
	Download
	Website
	Source

Sys-clk is a valuable sysmodule for Nintendo Switch that enables the optimization of CPU, GPU, and memory clocks based on the running application and docking status. This capability enhances the gaming experience by ensuring the system runs at the optimal speed for each game and state, resulting in improved performance and smoother gameplay.

Features

Automatic overclock and underclock depending on the running title and docked state.
Reads presets for titles from the SD card.
Hot reload allows you to change your preset while the game is running with sys-ftpd.
Presets database for a quick and easy overclock on popular games.

How does it work?

The sysmodule adjusts the performance of the CPU, GPU, and RAM of the console based on the game being played and whether the console is docked or not. This is done through sys-clk, which automatically overclocks or underclocks the system according to a preset for each game. The preset allows for setting different frequencies for both docked and handheld modes, with a maximum of six values. These values are capped for safety reasons:

CPU at 1785MHz
GPU at 460MHz without a charger
up to 768MHz with a charger
higher than 768MHz with the official charger.

These limits ensure that the console won't be damaged due to overclocking.

Installation

To install the application, it is required that you have a Nintendo Switch that runs on the Atmosphere Switch and is updated to the latest stable version. After meeting these requirements, simply copy the atmosphere and switch folders onto the root of your sdcard, ensuring that you overwrite files if prompted. Additionally, if you're not updating, copy the config folder to include default settings. These steps should enable you to successfully install the application.

Note: sys-clk-overlay requires to have Tesla installed and running.

Media

How to overclock the Nintendo Switch and view FPS - Sysclk & NX FPS Homebrew mods Atmosphere CFW - (Nevercholt)

Screenshots

Relevant files

Config file allows one to set custom clocks per docked state and title id, described below

/config/sys-clk/config.ini
Log file where the logs are written if enabled

/config/sys-clk/log.txt
Log flag file enables log writing if file exists

/config/sys-clk/log.flag
CSV file where the title id, profile, clocks and temperatures are written if enabled

/config/sys-clk/context.csv
sys-clk manager app (accessible from the hbmenu)

/switch/sys-clk-manager.nro
sys-clk overlay (accessible from anywhere by invoking the Tesla menu)

/switch/.overlays/sys-clk-overlay.ovl
sys-clk core sysmodule

/atmosphere/contents/00FF0000636C6BFF/exefs.nsp /atmosphere/contents/00FF0000636C6BFF/flags/boot2.flag

Config

Presets can be customized by adding them to the ini config file located at /config/sys-clk/config.ini, using the following template for each app

[Application Title ID]
docked_cpu=
docked_gpu=
docked_mem=
handheld_charging_cpu=
handheld_charging_gpu=
handheld_charging_mem=
handheld_charging_usb_cpu=
handheld_charging_usb_gpu=
handheld_charging_usb_mem=
handheld_charging_official_cpu=
handheld_charging_official_gpu=
handheld_charging_official_mem=
handheld_cpu=
handheld_gpu=
handheld_mem=

Replace Application Title ID with the title id of the game/application you're interested in customizing. A list of games title id can be found in the Switchbrew wiki.
Frequencies are expressed in mhz, and will be scaled to the nearest possible values, described in the clock table below.
If any key is omitted, value is empty or set to 0, it will be ignored, and stock clocks will apply.
If charging, sys-clk will look for the frequencies in that order, picking the first found
1. Charger specific config (USB or Official) handheld_charging_usb_X or handheld_charging_official_X
2. Non specific charging config handheld_charging_X
3. Handheld config handheld_X

Example 1: Zelda BOTW

Overclock CPU when docked or charging
Overclock MEM to docked clocks when handheld

Leads to a smoother framerate overall (ex: in the korok forest)

[01007EF00011E000]
docked_cpu=1224
handheld_charging_cpu=1224
handheld_mem=1600

Example 2: Picross

Underclocks on handheld to save battery

[0100BA0003EEA000]
handheld_cpu=816
handheld_gpu=153
handheld_mem=800

Advanced

The [values] section allows you to alter timings in sys-clk, you should not need to edit any of these unless you know what you are doing. Possible values are:

Key	Desc	Default
temp_log_interval_ms	Defines how often sys-clk log temperatures, in milliseconds (`0` to disable)	0 ms
csv_write_interval_ms	Defines how often sys-clk writes to the CSV, in milliseconds (`0` to disable)	0 ms
poll_interval_ms	Defines how fast sys-clk checks and applies profiles, in milliseconds	300 ms

Capping

To protect the battery from excessive strain, clocks requested from config may be capped before applying, depending on your current profile:

	Handheld	Charging (USB)	Charging (Official)	Docked
MEM	-	-	-	-
CPU	-	-	-	-
GPU	460	768	-	-

Clock table (MHz)

MEM clocks

1600 → official docked, boost mode, max clock
1331 → official handheld
1065
800
665

CPU clocks

1785 → max clock, boost mode
1683
1581
1428
1326
1224 → sdev oc
1122
1020 → official docked & handheld
918
816
714
612

GPU clocks

921 → max clock
844
768 → official docked
691
614
537
460 → max handheld
384 → official handheld
307 → official handheld
230
153
76 → boost mode

Notes:

GPU overclock is capped at 460Mhz in handheld and capped at 768Mhz if charging, unless you're using the official charger.
Clocks higher than 768MHz need the official charger is plugged in.

Changelog

v1.0.3

This minor update fixes the overlay not working on HOS >= 16.0.0 by upgrading libtesla and libnx to the latest version.
Thanks to @alula for the PR

v1.0.2

Fix freqs on ResetToStock(); for Boost Mode GPU
libnx compat fixes
libtesla updated from upstream
Use ts:GetTemperature on HOS 14.0.0+ instead of ts:GetTemperatureMilliC
Release files dont enable logs by default anymore

v1.0.1

Fix skin temp not shown in the manager
Fix Korean characters shown incorrectly in the manager
libtesla upstream sync (libnx 4.0.x compat)

v1.0.0

Homebrew app: sys-clk manager, testing grounds of borealis, a new hardware accelerated, Nintendo Switch inspired UI library for PC and Nintendo Switch
Tesla overlay: sys-clk-overlay, powered by libtesla

v0.13.1

Don't keep the time session open (only used at init)
Misc changes from the develop branch (libnx compat, etc) that does not affect features

v0.13.0

Temperature monitoring (SoC; PCB and Skin at customizable interval)
Logging refactor:
- Logs can now be enabled or disabled at runtime
- Prettier logs (clock hz format, shorter text)
- Milliseconds in timestamp
CSV export (timestamp, titleId, profile, clocks, temps at customizable interval)
FW 9.0.0 fixes
HB and crashed apps fixes

v0.12.3

This is a minor update that changed polling timings to accommodate actively scaling titles (ex: BOTW, DOOM...)

v0.12.2

This release adds support for 8.0.0

v0.12.1

This hotfix was made to correct the capping logic that was incorrectly applied to the CPU, consequently underclocking on defined profiles.

v0.12.0

Config loading has been refactored to permit more profile storage, and serve as the groundwork for what's to come
The kip target (which had become irrelevant) and the code required to support it has been removed, consequently enabling pm late loading with no side-effect

v0.11.1

fixes some games running slower than they should be (#6)

v0.11

Adds timestamp and version to logs
Games and profile changes now always trigger a reset to stock values, even for games that would not change clocks on their own

v0.10

Added charging profiles
General fixes

v0.9

First Release.

External links

Gbatemp - https://gbatemp.net/threads/sys-clk-under-overclocking-sysmodule.531372/
Github - https://github.com/retronx-team/sys-clk