Difference between revisions of "Settings services"
Line 769: | Line 769: | ||
No input, returns an output u32. | 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]]. | + | Loads the 0xB-byte setting <"settings_debug", "home_menu_scheme_model">, throwing an error if loading this fails. Depending on the content of the setting, the output u32 is either determined by the value of this setting, or loaded from [[Calibration]]. |
== ServiceDiscoveryControlSettings == | == ServiceDiscoveryControlSettings == |
Revision as of 19:23, 2 November 2019
set
This is "nn::settings::ISettingsServer".
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" 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 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.
Array-index / #Language | #LanguageCode | Icon 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:
Value | Region |
---|---|
0 | Japan |
1 | USA |
2 | Europe |
3 | Australia |
4 | China |
5 | Korea |
6 | Taiwan |
Any other value | Considered an unknown region |
set:fd
This is "nn::settings::IFirmwareDebugSettingsServer".
[4.0.0+] Only exposed if in debug mode.
Cmd | Name |
---|---|
2 | SetSettingsItemValue |
3 | ResetSettingsItemValue |
4 | CreateSettingsItemKeyIterator |
10 | [4.0.0+] ReadSettings |
11 | [4.0.0+] ResetSettings |
20 | [4.0.0+] SetWebInspectorFlag |
21 | [4.0.0+] SetAllowedSslHosts |
22 | [4.0.0+] SetHostFsMountPoint |
23 | [9.0.0+] SetMemoryUsageRateFlag |
ISettingsItemKeyIterator
Cmd | Name |
---|---|
0 | GoNext |
1 | GetKeySize |
2 | GetKey |
set:cal
This is "nn::settings::IFactorySettingsServer".
Cmd | Name |
---|---|
0 | GetBluetoothBdAddress |
1 | GetConfigurationId1 |
2 | GetAccelerometerOffset |
3 | GetAccelerometerScale |
4 | GetGyroscopeOffset |
5 | GetGyroscopeScale |
6 | GetWirelessLanMacAddress |
7 | GetWirelessLanCountryCodeCount |
8 | GetWirelessLanCountryCodes |
9 | GetSerialNumber |
10 | SetInitialSystemAppletProgramId |
11 | SetOverlayDispProgramId |
12 | GetBatteryLot |
14 | #GetEciDeviceCertificate |
15 | #GetEticketDeviceCertificate |
16 | #GetSslKey |
17 | #GetSslCertificate |
18 | #GetGameCardKey |
19 | #GetGameCardCertificate |
20 | #GetEciDeviceKey |
21 | #GetEticketDeviceKey |
22 | GetSpeakerParameter |
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 |
Used for accessing data calibrated at the factory.
GetEciDeviceCertificate
Takes a type-0x16 output buffer with fixed size 0x180.
Returns the device certificate (ECC signed). This is identical to 3DS DeviceCert/CTCert besides the strings. NIM loads the DeviceId from this.
GetEticketDeviceCertificate
Takes a type-0x16 output buffer with fixed size 0x240.
Returns the ETicket certificate (RSA signed).
GetSslKey
Takes a type-0x16 output buffer with fixed size 0x134.
Returns the extended SSL key (0x130 bytes) from CAL0. If the extended key is not programmed then it falls back to the normal SSL key (0x110 bytes).
Used by SSL-sysmodule, see here.
GetSslCertificate
Takes a type-0x16 output buffer with fixed size 0x804.
Returns a container with the plaintext SSL certificate.
Used by SSL-sysmodule, see here.
GetGameCardKey
Takes a type-0x16 output buffer with fixed size 0x134.
Returns the extended GameCard key (0x130 bytes) from CAL0. If the extended key is not programmed then it falls back to the normal GameCard key (0x110 bytes).
GetGameCardCertificate
Takes a type-0x16 output buffer with fixed size 0x404.
Returns a container with the GameCard certificate.
GetEciDeviceKey
Returns the extended device ECC-B233 key (0x50 bytes) from 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
Takes a type-0x16 output buffer with fixed size 0x244.
Returns the extended ETicket RSA-2048 key (0x240 bytes) from 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
Offset | Size | Name |
---|---|---|
0x0 | 0x4 | Size (same size used for decryption if needed) |
0x4 | {above size} | Actual data starts here. |
This container is used for returning data with variable sizes.
set:sys
This is "nn::settings::ISystemSettingsServer".
Cmd | Name |
---|---|
0 | SetLanguageCode |
1 | SetNetworkSettings |
2 | GetNetworkSettings |
3 | #GetFirmwareVersion |
4 | [3.0.0+] GetFirmwareVersion2 |
5 | [5.0.0+] GetFirmwareVersionDigest |
7 | GetLockScreenFlag |
8 | SetLockScreenFlag |
9 | GetBacklightSettings |
10 | SetBacklightSettings |
11 | SetBluetoothDevicesSettings |
12 | GetBluetoothDevicesSettings |
13 | GetExternalSteadyClockSourceId |
14 | SetExternalSteadyClockSourceId |
15 | GetUserSystemClockContext |
16 | SetUserSystemClockContext |
17 | GetAccountSettings |
18 | SetAccountSettings |
19 | GetAudioVolume |
20 | SetAudioVolume |
21 | GetEulaVersions |
22 | SetEulaVersions |
23 | #GetColorSetId |
24 | #SetColorSetId |
25 | GetConsoleInformationUploadFlag |
26 | SetConsoleInformationUploadFlag |
27 | GetAutomaticApplicationDownloadFlag |
28 | SetAutomaticApplicationDownloadFlag |
29 | GetNotificationSettings |
30 | SetNotificationSettings |
31 | GetAccountNotificationSettings |
32 | SetAccountNotificationSettings |
35 | GetVibrationMasterVolume |
36 | SetVibrationMasterVolume |
37 | GetSettingsItemValueSize |
38 | #GetSettingsItemValue |
39 | GetTvSettings |
40 | SetTvSettings |
41 | GetEdid |
42 | SetEdid |
43 | GetAudioOutputMode |
44 | SetAudioOutputMode |
45 | IsForceMuteOnHeadphoneRemoved |
46 | SetForceMuteOnHeadphoneRemoved |
47 | #GetQuestFlag |
48 | SetQuestFlag |
49 | GetDataDeletionSettings |
50 | SetDataDeletionSettings |
51 | GetInitialSystemAppletProgramId |
52 | GetOverlayDispProgramId |
53 | GetDeviceTimeZoneLocationName |
54 | SetDeviceTimeZoneLocationName |
55 | GetWirelessCertificationFileSize |
56 | GetWirelessCertificationFile |
57 | SetRegionCode |
58 | GetNetworkSystemClockContext |
59 | SetNetworkSystemClockContext |
60 | IsUserSystemClockAutomaticCorrectionEnabled |
61 | SetUserSystemClockAutomaticCorrectionEnabled |
62 | #GetDebugModeFlag |
63 | GetPrimaryAlbumStorage |
64 | SetPrimaryAlbumStorage |
65 | GetUsb30EnableFlag |
66 | SetUsb30EnableFlag |
67 | GetBatteryLot |
68 | #GetSerialNumber |
69 | GetNfcEnableFlag |
70 | SetNfcEnableFlag |
71 | GetSleepSettings |
72 | SetSleepSettings |
73 | GetWirelessLanEnableFlag |
74 | SetWirelessLanEnableFlag |
75 | GetInitialLaunchSettings |
76 | SetInitialLaunchSettings |
77 | GetDeviceNickName |
78 | SetDeviceNickName |
79 | GetProductModel |
80 | GetLdnChannel |
81 | SetLdnChannel |
82 | AcquireTelemetryDirtyFlagEventHandle |
83 | GetTelemetryDirtyFlags |
84 | GetPtmBatteryLot |
85 | SetPtmBatteryLot |
86 | GetPtmFuelGaugeParameter |
87 | SetPtmFuelGaugeParameter |
88 | GetBluetoothEnableFlag |
89 | SetBluetoothEnableFlag |
90 | GetMiiAuthorId |
91 | SetShutdownRtcValue |
92 | GetShutdownRtcValue |
93 | AcquireFatalDirtyFlagEventHandle |
94 | GetFatalDirtyFlags |
95 | [2.0.0+] GetAutoUpdateEnableFlag |
96 | [2.0.0+] SetAutoUpdateEnableFlag |
97 | [2.0.0+] GetNxControllerSettings |
98 | [2.0.0+] SetNxControllerSettings |
99 | [2.0.0+] GetBatteryPercentageFlag |
100 | [2.0.0+] SetBatteryPercentageFlag |
101 | [2.0.0+] GetExternalRtcResetFlag |
102 | [2.0.0+] SetExternalRtcResetFlag |
103 | [3.0.0+] GetUsbFullKeyEnableFlag |
104 | [3.0.0+] SetUsbFullKeyEnableFlag |
105 | [3.0.0+] SetExternalSteadyClockInternalOffset |
106 | [3.0.0+] GetExternalSteadyClockInternalOffset |
107 | [3.0.0+] GetBacklightSettingsEx |
108 | [3.0.0+] SetBacklightSettingsEx |
109 | [3.0.0+] GetHeadphoneVolumeWarningCount |
110 | [3.0.0+] SetHeadphoneVolumeWarningCount |
111 | [3.0.0+] GetBluetoothAfhEnableFlag |
112 | [3.0.0+] SetBluetoothAfhEnableFlag |
113 | [3.0.0+] GetBluetoothBoostEnableFlag |
114 | [3.0.0+] SetBluetoothBoostEnableFlag |
115 | [3.0.0+] GetInRepairProcessEnableFlag |
116 | [3.0.0+] SetInRepairProcessEnableFlag |
117 | [3.0.0+] GetHeadphoneVolumeUpdateFlag |
118 | [3.0.0+] SetHeadphoneVolumeUpdateFlag |
119 | [3.0.0+] NeedsToUpdateHeadphoneVolume |
120 | [3.0.0+] GetPushNotificationActivityModeOnSleep |
121 | [3.0.0+] SetPushNotificationActivityModeOnSleep |
122 | [4.0.0+] #GetServiceDiscoveryControlSettings |
123 | [4.0.0+] SetServiceDiscoveryControlSettings |
124 | [4.0.0+] GetErrorReportSharePermission |
125 | [4.0.0+] SetErrorReportSharePermission |
126 | [4.0.0+] GetAppletLaunchFlags |
127 | [4.0.0+] SetAppletLaunchFlags |
128 | [4.0.0+] GetConsoleSixAxisSensorAccelerationBias |
129 | [4.0.0+] SetConsoleSixAxisSensorAccelerationBias |
130 | [4.0.0+] GetConsoleSixAxisSensorAngularVelocityBias |
131 | [4.0.0+] SetConsoleSixAxisSensorAngularVelocityBias |
132 | [4.0.0+] GetConsoleSixAxisSensorAccelerationGain |
133 | [4.0.0+] SetConsoleSixAxisSensorAccelerationGain |
134 | [4.0.0+] GetConsoleSixAxisSensorAngularVelocityGain |
135 | [4.0.0+] SetConsoleSixAxisSensorAngularVelocityGain |
136 | [4.0.0+] GetKeyboardLayout |
137 | [4.0.0+] SetKeyboardLayout |
138 | [4.0.0+] GetWebInspectorFlag |
139 | [4.0.0+] #GetAllowedSslHosts |
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 |
Official user-processes get a new service session handle each time a set:sys cmd is used, with the session being closed aftewards.
GetFirmwareVersion
Takes a type-0x1A output buffer. User-processes use hard-coded size 0x100.
If needed, reads the content of the System_Version_Title "/file" into state. This is only done once.
Then the above 0x100-byte data is copied to the output buffer.
GetColorSetId
No input, returns an output s32.
This is the current Theme set by System Settings.
- 0: "Basic White"
- 1: "Basic Black"
SetColorSetId
Takes an input s32, no output.
GetSettingsItemValue
Takes two type-0x19 input buffers and a type-0x6 output buffer. Returns an output u64 for the actual size written to the outbuf.
The outbuf_size is compared with the config_size. When config_size is larger than outbuf_size, outbuf_size is used for the memcpy, otherwise config_size is used. Afterwards the size used for the memcpy is written to output(see above).
If loading from main config fails, it will also attempt to load config from various state if the input strings match hard-coded strings.
GetDebugModeFlag
Returns an output u8.
Loads the 1-byte config for <"settings_debug", "is_debug_mode_enabled">. If that fails, value 0x1 is written to output. This uses the same func as ReadSetting internally.
Returned retval is always 0.
GetSerialNumber
Returns the 0x18-byte SerialNumber string.
GetServiceDiscoveryControlSettings
Returns an u32 ServiceDiscoveryControlSettings.
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: Main, Back, Sub, Bezel and Extra.
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: flag = PlatformRegion==2
.
SetT
Takes an input u8 bool flag, no output.
[9.0.0+] This is a wrapper for #SetPlatformRegion: PlatformRegion = 1 + (flag & 1)
.
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">, throwing an error if loading this fails. Depending on the content of the setting, the output u32 is either determined by the value of this setting, or loaded from Calibration.
ServiceDiscoveryControlSettings
This is a 32-bit bitfield.
Bits | Description |
---|---|
0 | IsChangeEnvironmentIdentifierDisabled |
System Config
There's a common config title (*818), and a config title for each HardwareType.
See System_Settings.