Nintendo Switch Brew

Settings services: Difference between revisions

← Older editNewer edit →
(50 intermediate revisions by 8 users not shown)
Line 4: Line 4:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Cmd || Name || Notes
|-
| 0 || GetLanguageCode || No input, returns an output [[#LanguageCode]]. This is the current system language.
|-
| 1 || GetAvailableLanguageCodes || Takes a type-0xA buffer containing the [[#LanguageCode]] output array, returns an output s32.
|-
| 2 || [4.0.0+] MakeLanguageCode || Takes an input [[#Language]], returns an output [[#LanguageCode]].
|-
| 3 || GetAvailableLanguageCodeCount || No input, returns an output s32.
|-
| 4 || GetRegionCode || No input, returns a [[#RegionCode]].
|-
| 5 || [4.0.0+] GetAvailableLanguageCodes2 || Takes a type-0x6 buffer containing the [[#LanguageCode]] output array, returns an output s32.
|-
| 6 || [4.0.0+] GetAvailableLanguageCodeCount2 || No input, returns an output s32.
|-
| 7 || [4.0.0+] [[#GetKeyCodeMap]] ||
|-
| 8 || [5.0.0+] GetQuestFlag || Identical to "set:sys" [[#set:sys|GetQuestFlag]].
|-
| 9 || [6.0.0+] GetKeyCodeMap2 ||
|-
| 10 || [9.0.0+] [[#GetFirmwareVersionForDebug]] ||
|}
 
[4.0.0+] Official user-processes now use GetAvailableLanguageCodes2/GetAvailableLanguageCodeCount2 instead of {original commands}.
 
In official user-processes in the [[#Language]]->[[#LanguageCode]] conversion function (MakeLanguageCode):
* During one-time init, GetAvailableLanguageCodes is used to initialize the LanguageCodes array cache, with max_entries=0xF (buffer size in u64s). [4.0.0+] GetAvailableLanguageCodes2 is now used with max_entries 0x40.
* [4.0.0+] When the input [[#Language]] is larger than the cached total_entries from the above command output, or [[#Language]] is negative, command MakeLanguageCode is used instead of the array.
 
== GetKeyCodeMap ==
Takes a type-0x16 output buffer containing KeyCodeMap, official sw uses fixed size 0x1000. This is probably related to HID keyboard.
 
== GetFirmwareVersionForDebug ==
Takes a type-0x16 output buffer containing a 0x80-byte "nn::oe::FirmwareVersionForDebug".
 
This uses [[#GetDebugModeFlag]] internally, if the output flag is 0 an error is thrown.
 
This runs the same code as GetFirmwareVersion2, with the last 0x80-bytes of the [[System_Version_Title|output]] being copied to the output buffer.
 
== Language ==
"nn::settings::Language" (s32) is basically array indices in the output array from GetAvailableLanguageCodes.
 
== LanguageCode ==
This is "nn::settings::LanguageCode".
 
This is an u64, which is a NUL-terminated string.
 
{| class="wikitable" border="1"
|-
! Array-index / [[#Language]] || [[#LanguageCode]] || Icon [[NCA_Content_FS#FS-type3|language]] filename || Name
|-
| 0 || ja || "Japanese" || Japanese
|-
| 1 || en-US || "AmericanEnglish" || EnglishUs
|-
| 2 || fr || "French" || French
|-
| 3 || de || "German" || German
|-
| 4 || it || "Italian" || Italian
|-
| 5 || es || "Spanish" || Spanish
|-
| 6 || zh-CN || "Chinese" || Chinese
|-
| 7 || ko || "Korean" || Korean
|-
| 8 || nl || "Dutch" || Dutch
|-
| 9 || pt || "Portuguese" || Portuguese
|-
| 10 || ru || "Russian" || Russian
|-
| 11 || zh-TW || "Taiwanese" || Taiwanese
|-
| 12 || en-GB || "BritishEnglish" || EnglishUk
|-
| 13 || fr-CA || "CanadianFrench" || FrenchCa
|-
| 14 || es-419 || "LatinAmericanSpanish" || SpanishLatin
|-
| [4.0.0+] 15 || zh-Hans || "SimplifiedChinese" || ChineseSimplified
|-
| [4.0.0+] 16 || zh-Hant || "TraditionalChinese" || ChineseTraditional
|}
 
== RegionCode ==
A region code is a signed 32-bit value representing a particular region. Currently the available regions defined by the system are as follows:
 
{| class="wikitable" border="1"
|-
! Value || Region
|-
| 0 || Japan
|-
|-
| 0 || GetLanguageCode
| 1 || USA
|-
|-
| 1 || GetAvailableLanguageCodes
| 2 || Europe
|-
|-
| 2 || [4.0.0+] MakeLanguageCode
| 3 || Australia
|-
|-
| 3 || GetAvailableLanguageCodeCount
| 4 || China
|-
|-
| 4 || GetRegionCode
| 5 || Korea
|-
|-
| 5 || [4.0.0+] GetAvailableLanguageCodes2
| 6 || Taiwan
|-
|-
| 6 || [4.0.0+] GetAvailableLanguageCodeCount2
| Any other value || Considered an unknown region
|-
|-
| 7 || [4.0.0+] GetKeyCodeMap
|}
|}


= set:fd =
= set:fd =
This is "nn::settings::IFirmwareDebugSettingsServer".
This is "nn::settings::IFirmwareDebugSettingsServer".
[4.0.0+] Only exposed if in [[SPL_services#IsDebugMode|debug mode]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
! Cmd || Name
|-
| 2 || SetSettingsItemValue
|-
|-
| 2 || SetSettingsItemValue ||
| 3 || ResetSettingsItemValue
|-
|-
| 3 || ResetSettingsItemValue ||
| 4 || [[#ISettingsItemKeyIterator|CreateSettingsItemKeyIterator]]
|-
|-
| 4 || CreateSettingsItemKeyIterator || Returns an [[#ISettingsItemKeyIterator]].
| 10 || [4.0.0+] ReadSettings
|-
|-
| 10 || [4.0.0+] ReadSettings ||
| 11 || [4.0.0+] ResetSettings
|-
|-
| 11 || [4.0.0+] ResetSettings ||
| 20 || [4.0.0+] SetWebInspectorFlag
|-
|-
| 20 || [4.0.0+] SetWebInspectorFlag ||
| 21 || [4.0.0+] SetAllowedSslHosts
|-
|-
| 21 || [4.0.0+] SetAllowedSslHosts ||
| 22 || [4.0.0+] SetHostFsMountPoint
|-
|-
| 22 || [4.0.0+] SetHostFsMountPoint ||
| 23 || [9.0.0+] SetMemoryUsageRateFlag
|}
|}


Line 112: Line 210:
| 23 || [4.0.0+] GetLcdVendorId
| 23 || [4.0.0+] GetLcdVendorId
|-
|-
| 24 || [5.0.0+] [[#GetEciDeviceCertificate2]]
|-
| 25 || [5.0.0+] [[#GetEciDeviceKey2]]
|-
| 26 || [5.0.0+] GetAmiiboKey
|-
| 27 || [5.0.0+] GetAmiiboEcqvCertificate
|-
| 28 || [5.0.0+] GetAmiiboEcdsaCertificate
|-
| 29 || [5.0.0+] GetAmiiboEcqvBlsKey
|-
| 30 || [5.0.0+] GetAmiiboEcqvBlsCertificate
|-
| 31 || [5.0.0+] GetAmiiboEcqvBlsRootCertificate
|-
| 32 || [5.0.0+] GetUsbTypeCPowerSourceCircuitVersion
|-
| 33 || [9.0.0+] GetAnalogStickModuleTypeL
|-
| 34 || [9.0.0+] GetAnalogStickModelParameterL
|-
| 35 || [9.0.0+] GetAnalogStickFactoryCalibrationL
|-
| 36 || [9.0.0+] GetAnalogStickModuleTypeR
|-
| 37 || [9.0.0+] GetAnalogStickModelParameterR
|-
| 38 || [9.0.0+] GetAnalogStickFactoryCalibrationR
|-
| 39 || [9.0.0+] GetConsoleSixAxisSensorModuleType
|-
| 40 || [9.0.0+] GetConsoleSixAxisSensorHorizontalOffset
|-
| 41 || [6.0.0+] GetBatteryVersion
|}
|}


Line 152: Line 285:
== GetEciDeviceKey ==
== GetEciDeviceKey ==
Returns the extended device ECC-B233 key (0x50 bytes) from [[Calibration#CAL0|CAL0]]. If the extended key is not programmed then it falls back to the normal device ECC-B233 key (0x30 bytes).
Returns the extended device ECC-B233 key (0x50 bytes) from [[Calibration#CAL0|CAL0]]. If the extended key is not programmed then it falls back to the normal device ECC-B233 key (0x30 bytes).
[5.0.0+] Now returns an additional 4-bytes.


== GetEticketDeviceKey ==
== GetEticketDeviceKey ==
Line 157: Line 292:


Returns the extended ETicket RSA-2048 key (0x240 bytes) from [[Calibration#CAL0|CAL0]]. If the extended key is not programmed then it falls back to the normal ETicket RSA-2048 key (0x220 bytes).
Returns the extended ETicket RSA-2048 key (0x240 bytes) from [[Calibration#CAL0|CAL0]]. If the extended key is not programmed then it falls back to the normal ETicket RSA-2048 key (0x220 bytes).
== GetEciDeviceCertificate2 ==
Same as [[#GetEciDeviceCertificate]], but returns a RSA-2048 variant of the device certificate.
== GetEciDeviceKey2 ==
Same as [[#GetEciDeviceKey]], but returns a RSA-2048 variant of the device key.


== setcal Container Structure ==
== setcal Container Structure ==
Line 192: Line 333:
|-
|-
| 4 || [3.0.0+] GetFirmwareVersion2
| 4 || [3.0.0+] GetFirmwareVersion2
|-
| 5 || [5.0.0+] GetFirmwareVersionDigest
|-
|-
| 7 || GetLockScreenFlag
| 7 || GetLockScreenFlag
Line 269: Line 412:
| 46 || SetForceMuteOnHeadphoneRemoved
| 46 || SetForceMuteOnHeadphoneRemoved
|-
|-
| 47 || GetQuestFlag
| 47 || [[#GetQuestFlag]]
|-
|-
| 48 || SetQuestFlag
| 48 || SetQuestFlag
Line 453: Line 596:
| 138 || [4.0.0+] GetWebInspectorFlag
| 138 || [4.0.0+] GetWebInspectorFlag
|-
|-
| 139 || [4.0.0+] GetAllowedSslHosts
| 139 || [4.0.0+] [[#GetAllowedSslHosts]]
|-
|-
| 140 || [4.0.0+] GetHostFsMountPoint
| 140 || [4.0.0+] GetHostFsMountPoint
|-
| 141 || [5.0.0+] GetRequiresRunRepairTimeReviser
|-
| 142 || [5.0.0+] SetRequiresRunRepairTimeReviser
|-
| 143 || [5.0.0+] SetBlePairingSettings
|-
| 144 || [5.0.0+] GetBlePairingSettings
|-
| 145 || [5.0.0+] GetConsoleSixAxisSensorAngularVelocityTimeBias
|-
| 146 || [5.0.0+] SetConsoleSixAxisSensorAngularVelocityTimeBias
|-
| 147 || [5.0.0+] GetConsoleSixAxisSensorAngularAcceleration
|-
| 148 || [5.0.0+] SetConsoleSixAxisSensorAngularAcceleration
|-
| 149 || [5.0.0+] GetRebootlessSystemUpdateVersion
|-
| 150 || [5.0.0+] GetDeviceTimeZoneLocationUpdatedTime
|-
| 151 || [5.0.0+] SetDeviceTimeZoneLocationUpdatedTime
|-
| 152 || [6.0.0+] GetUserSystemClockAutomaticCorrectionUpdatedTime
|-
| 153 || [6.0.0+] SetUserSystemClockAutomaticCorrectionUpdatedTime
|-
| 154 || [6.0.0+] GetAccountOnlineStorageSettings
|-
| 155 || [6.0.0+] SetAccountOnlineStorageSettings
|-
| 156 || [6.0.0+] GetPctlReadyFlag
|-
| 157 || [6.0.0+] SetPctlReadyFlag
|-
| 158 || [9.0.0+] GetAnalogStickUserCalibrationL
|-
| 159 || [9.0.0+] SetAnalogStickUserCalibrationL
|-
| 160 || [9.0.0+] GetAnalogStickUserCalibrationR
|-
| 161 || [9.0.0+] SetAnalogStickUserCalibrationR
|-
| 162 || [6.0.0+] GetPtmBatteryVersion
|-
| 163 || [6.0.0+] SetPtmBatteryVersion
|-
| 164 || [6.0.0+] GetUsb30HostEnableFlag
|-
| 165 || [6.0.0+] SetUsb30HostEnableFlag
|-
| 166 || [6.0.0+] GetUsb30DeviceEnableFlag
|-
| 167 || [6.0.0+] SetUsb30DeviceEnableFlag
|-
| 168 || [7.0.0+] GetThemeId
|-
| 169 || [7.0.0+] SetThemeId
|-
| 170 || [7.0.0+] GetChineseTraditionalInputMethod
|-
| 171 || [7.0.0+] SetChineseTraditionalInputMethod
|-
| 172 || [7.0.0+] GetPtmCycleCountReliability
|-
| 173 || [7.0.0+] SetPtmCycleCountReliability
|-
| 174 || [9.0.0+] [[#GetHomeMenuScheme]]
|-
| 175 || [7.0.0+] GetThemeSettings
|-
| 176 || [7.0.0+] SetThemeSettings
|-
| 177 || [7.0.0+] GetThemeKey
|-
| 178 || [7.0.0+] SetThemeKey
|-
| 179 || [8.0.0+] GetZoomFlag
|-
| 180 || [8.0.0+] SetZoomFlag
|-
| 181 || [8.0.0+] [[#GetT]]
|-
| 182 || [8.0.0+] [[#SetT]]
|-
| 183 || [9.0.0+] [[#GetPlatformRegion]]
|-
| 184 || [9.0.0+] [[#SetPlatformRegion]]
|-
| 185 || [9.0.0+] [[#GetHomeMenuSchemeModel]]
|-
| 186 || [9.0.0+] GetMemoryUsageRateFlag
|-
| 187 || [9.0.0+] GetTouchScreenMode
|-
| 188 || [9.0.0+] SetTouchScreenMode
|}
|}


Line 497: Line 736:
== GetServiceDiscoveryControlSettings ==
== GetServiceDiscoveryControlSettings ==
Returns 0x01 if [[Safemode|safemode]] needs to be launched.
Returns 0x01 if [[Safemode|safemode]] needs to be launched.
== GetAllowedSslHosts ==
Takes a type-0x6 output buffer, returns an output s32. This buffer contains an array of 0x8-byte "nn::settings::system::AllowedSslHost" entries.
== GetQuestFlag ==
Gets a flag determining whether the console is a kiosk unit (codenamed "Quest"). Used by qlaunch to determine whether to launch Retail Interactive Display Menu.
== GetHomeMenuScheme ==
No input, returns an output 0x14-byte struct "nn::settings::system::HomeMenuScheme".
This struct contains 5 RGBA8 u32s for colors.
The colors are loaded from [[Calibration]], with the set of fields to use selected by ColorVariation. When ColorVariation is invalid (must be 1-4), the following fixed color values are returned: 0xFF323232, 0xFF323232, 0xFFFFFFFF, 0xFFFFFFFF, 0xFF000000.
== GetT ==
No input, returns an output u8 bool flag.
[9.0.0+] This is a wrapper for [[#GetPlatformRegion]]: <code>flag = PlatformRegion==2</code>.
== SetT ==
Takes an input u8 bool flag, no output.
[9.0.0+] This is a wrapper for [[#SetPlatformRegion]]: <code>PlatformRegion = 1 + (flag & 1)</code>.
== GetPlatformRegion ==
No input, returns an output s32.
== SetPlatformRegion ==
Takes an input s32, no output.
== GetHomeMenuSchemeModel ==
No input, returns an output u32.
Loads the 0xB-byte setting <"settings_debug", "home_menu_scheme_model">. Depending on the content of the setting, the output u32 is either determined by the value of this setting, or loaded from [[Calibration]].
= System Config =
There's a common config title (*818), and a config title for each [[SPL_services|HardwareType]].
See [[System_Settings]].


[[Category:Services]]
[[Category:Services]]
Retrieved from "https://switchbrew.org/wiki/Settings_services"