docs: update readme

2023-10-20 03:38:08 +09:00
parent f51805a344
commit 1468dc3068
3 changed files with 20 additions and 16 deletions
--- a/README.md
+++ b/README.md
@@ -2,7 +2,6 @@

 [![License: GPL v2](https://img.shields.io/badge/License-GPL_v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
 [![Downloads](https://img.shields.io/github/downloads/hanai3Bi/Switch-OC-Suite/total)](https://github.com/hanai3Bi/Switch-OC-Suite/releases)
-[![ko-fi](https://img.shields.io/badge/support-ko--fi-ff69b4)](https://ko-fi.com/hanai3Bi)

 
     
@@ -42,24 +41,24 @@ Overclocking Suite for Nintendo Switch consoles running Atmosphere CFW.
  - DRAM Overclock (Safe: 1996.8 MHz)

 - Modded sys-clk and ReverseNX-RT
-  - Auto CPU Boost
+  - ~~Auto CPU Boost~~
    - For faster game loading
    - Enable CPU Boost (1785 MHz) when CPU Core#3 (System Core) is stressed (mainly I/O operations).
    - Effective only when charger is connected or governor is enabled.
    - This feature is considered unsafe on Erista, especially when combined with high GPU frequency or with governor enabled.

-  - CPU & GPU frequency governor (Experimental)
+  - ~~CPU & GPU frequency governor (Experimental)~~
    - Adjust frequency based on load. Might decrease power draw but can introduce stutters. Can be turned off for specific titles.
    - Minimum CPU scaling frequency will be set to 1020Mhz on Mariko devices if set profile value is greater than 1020Mhz.

-  - Set charging current (100 mA - 2000 mA) and charging limit (20% - 100%)
+  - ~~Set charging current (100 mA - 2000 mA) and charging limit (20% - 100%)~~
    - Long-term use of charge limit may render the battery gauge inaccurate. Performing full cycles could help recalibration, or try [battery_desync_fix_nx](https://github.com/CTCaer/battery_desync_fix_nx).

  - Global Profile
    - Designated a dummy title id `0xA111111111111111`.
    - Priority: "Temp overrides" > "Application profile" > "Global profile" > "System default".

-  - Sync ReverseNX Mode
+  - ~~Sync ReverseNX Mode~~
    - No need to change clocks manually after toggling modes in ReverseNX (-RT)

 - **[System Settings (Optional)](https://github.com/hanai3Bi/Switch-OC-Suite/blob/master/system_settings.md)**
@@ -91,7 +90,7 @@ Overclocking Suite for Nintendo Switch consoles running Atmosphere CFW.
    </details>

 5. Hekate-ipl bootloader Only
-   - Add `kip1=atmosphere/kips/loader.kip` to boot entry section in `bootloader/hekate_ipl.ini`.
+   - Add `kip1=atmosphere/kips/loader.kip` to last line at boot entry section in `bootloader/hekate_ipl.ini`.

 ## Updating via AIO

@@ -127,3 +126,4 @@ When compilation is done, uncompress the kip to make it work with configurator:
 - Switchroot for their [modified L4T kernel and device tree](https://gitlab.com/switchroot/kernel)
 - ZatchyCatGames for RE and original OC loader patches for Atmosphere
 - KazushiMe for [Switch-OC-Suite](https://github.com/KazushiMe/Switch-OC-Suite)
+- lineon for research and help
--- a/README_kr.md
+++ b/README_kr.md
@@ -2,7 +2,6 @@

 [![License: GPL v2](https://img.shields.io/badge/License-GPL_v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
 [![Downloads](https://img.shields.io/github/downloads/hanai3Bi/Switch-OC-Suite/total)](https://github.com/hanai3Bi/Switch-OC-Suite/releases)
-[![ko-fi](https://img.shields.io/badge/support-ko--fi-ff69b4)](https://ko-fi.com/hanai3Bi)

 이 프로젝트는 매우 위험하며 콘솔을 손상시킬 수 있습니다. 따라서 이 프로젝트를 사용하는걸 권장하지 않습니다. 사용할 경우 모든 책임은 본인에게 있습니다.

--- a/Source/sys-clk-OC/README.md
+++ b/Source/sys-clk-OC/README.md
@@ -83,14 +83,14 @@ To protect the battery from excessive strain, clocks requested from config may b
 |:-------:|:--------:|:--------------:|:-------------------:|:------:|
 | **MEM** | -        | -              | -                   | -      |
 | **CPU** | 1785     | 1785           | 1785                | 1785   |
-| **GPU** | 460      | 768            | -                   | -      |
+| **GPU** | 460      | 768            | 921                 | 921    |


 ### Erista (Unsafe allowed)
 |         | Handheld | Charging (USB) | Charging (Official) | Docked |
 |:-------:|:--------:|:--------------:|:-------------------:|:------:|
 | **MEM** | -        | -              | -                   | -      |
-| **CPU** | 1785     | -              | -                   | -      |
+| **CPU** | 1785     | 1785           | -                   | -      |
 | **GPU** | 460      | 768            | -                   | -      |


@@ -99,15 +99,15 @@ To protect the battery from excessive strain, clocks requested from config may b
 |:-------:|:--------:|:--------------:|:-------------------:|:------:|
 | **MEM** | -        | -              | -                   | -      |
 | **CPU** | 1963     | 1963           | 1963                | 1963   |
-| **GPU** | 998      | 998            | 998                 | 998    |
+| **GPU** | 768      | 921            | 998                 | 998    |


 ### Mariko (Unsafe allowed)
 |         | Handheld | Charging (USB) | Charging (Official) | Docked |
 |:-------:|:--------:|:--------------:|:-------------------:|:------:|
 | **MEM** | -        | -              | -                   | -      |
-| **CPU** | -        | -              | -                   | -      |
-| **GPU** | 998      | -              | -                   | -      |
+| **CPU** | 1963     | 1963           | -                   | -      |
+| **GPU** | 768      | 921            | -                   | -      |


 ## Installation
@@ -207,12 +207,17 @@ The `[values]` section allows you to alter timings in sys-clk, you should not ne
 | Key                      | Desc                                                                          | Default   |
 |:------------------------:|-------------------------------------------------------------------------------|:---------:|
 |**allow_unsafe_freq**     | Allow unsafe frequencies (CPU > 1963.5 MHz, GPU > 921.6 MHz)                  | OFF       |
+|**uncapped_clocks**       | Remove CPU/GPU clock cappings					 		                       | OFF       |
+|**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         | 500 ms    |
+
+Only available for prior to Switch OC Suite 1.9.0
+
+| Key                      | Desc                                                                          | Default   |
 |**auto_cpu_boost**        | Auto-boost CPU when system Core #3 utilization ≥ 95%                          | OFF       |
 |**sync_reversenx_mode**   | Sync nominal profile (mode) with ReverseNX (-Tool and -RT)                    | ON        |
 |**charging_current**      | Charging current limit (100 mA - 2000 mA)                                     | 2000 mA   |
 |**charging_limit_perc**   | Charging limit (20% - 100%)                                                   | 100%(OFF) |
 |**governor_experimental** | CPU & GPU frequency governor (Experimental)                                   | OFF       |
-|**governor_handheld_only**| Use governor only on Handheld Profile		                                   | OFF       |
-|**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         | 500 ms    |
+|**governor_handheld_only**| Use governor only on Handheld Profile		                                   | OFF       |