Advanced User Guide - Kyliekyler/MAGNETAR GitHub Wiki

Badge

Advanced User Guide

MAGNETAR invites advanced users to take part of the custom configuration sharing to build a device tailored tweaks that will be used by MAGNETAR community.

Scope

MAGNETAR allows users to build custom configurations using specific parameters such as CPU_FREQUENCY, GPU_FREQUENCY, IB_FREQUENCY, LOOP, and WRITE. These parameters can be adjusted by the user to optimize the performance of the device for specific use cases.

Limitation

While the MAGNETAR allows for customization of the specified parameters, there are certain limitations to the program. The program is limited to the use of only these parameters and cannot be modified to include additional ones. Users will not be able to change the program's underlying architecture or functionality, and the program's performance will depend on the quality of the hardware it is running on.

Additionally, while MAGNETAR custom configuration allows for optimization of performance, it cannot guarantee specific outcomes or results. The effectiveness of the custom configuration will depend on various factors such as the specific use case, the hardware used, and the other applications running on the system.

Format

To start with custom configuration, create a file under MAGNETAR folder on internal storage to be loaded later on using magnetar --config load file after the custom config was made.

The following parameters are used in the configuration file:

  • CPU_FREQUENCY

    This parameter sets CPU Frequency Scaling in percentile format.

    • SMALL_CPU_FREQUENCY

      This parameter only sets Little Cluster CPU Frequency Scaling in percentile format.

    • BIG_CPU_FREQUENCY

      This parameter only sets Big Cluster CPU Frequency Scaling in percentile format.

    • PRIME_CPU_FREQUENCY

      This parameter only sets Prime Cluster CPU Frequency Scaling in percentile format.

  • GPU_FREQUENCY

    This parameter sets GPU Frequency Scaling in percentile format.

  • IB_FREQUENCY

    This parameter sets Input Boost Frequency Scaling in percentile format.

  • WRITE

    This parameter is used in conjunction with a path to a file that will be modified.

  • LOOP

    This parameter is used in conjunction with a path to a file that will be modified in a loop.

These parameters accept just 1 or 6 arguments; any more or less will be removed automatically. The modes are represented by the following 6 arguments: endurance+, endurance, balance, balance+, extreme, and game. Setting only 1 argument will be the default value for all the modes.

It is recommended that your configuration file adhere to the following standard template, including spacing:

# Sample Config

CPU_FREQUENCY 100
GPU_FREQUENCY 80
IB_FREQUENCY 50 60 70 80 90 100

WRITE /path/to/file value
WRITE /another/path/to/file 1 2 3 4 5 6

LOOP /path/to/*/file value
LOOP /another/path/to/*/file a b c d e f

Sharing

The custom configuration can be shared to other MAGNETAR users using the CLI command magnetar --config share and the file will be automatically shared to the config channel.