Nintendo Switch Brew

PSC services: Difference between revisions

← Older edit
No edit summary
 
(66 intermediate revisions by 3 users not shown)
Line 1: Line 1:
PSC (Power State Control) provides services related to power state changes in the system.
PSC (Power State Control) provides services related to power state changes in the system.
= Concept =
psc:m allows a process to register a module that depends on power management in some way. A client calls GetPmModule to receive an IPmModule (Power Managed Module), and then calls IPmModule->Initialize(module_id, module_dependency_list) where module_id is the ModuleId enum member for the client, and the dependency list is an array of module IDs for the modules that this depends on. Initialize() returns an event handle that the client can wait on to be notified of a power state change.
psc:c allows a module to the power state controller for the system (in practice, AM is the only client to the controller). IPmControl->DispatchRequest() is used notify all IPmModules of a state change.
For example, FS registers itself as an IPmModule with dependencies on pinmux, gpio, pcv, tma, and initializes the SD card once those dependencies have registered..
It then does (basically) the following pseudocode (actual code located at .text + 0xB2DB0 in 6.0.0 FS):
    while (true) {
        Fs_IPmModule->WaitSignaled();
       
        Fs_IPmModule->GetRequest(&state);
        switch (state) {
            case WakingUp:
                /* hardware devices are woken up here */
            case GoingToSleep:
                /* hardware devices are put to sleep here */
            case ShuttingDown:
                /* hardware devices are turned off here */
        }
       
        Fs_IPmModule->Acknowledge(state);
    }


= psc:c =
= psc:c =
Line 33: Line 8:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || Initialize
| 0 || [[#Initialize|Initialize]]
|-
|-
| 1 || DispatchRequest
| 1 || [[#DispatchRequest|DispatchRequest]]
|-
|-
| 2 || GetResult
| 2 || [[#GetResult|GetResult]]
|-
|-
| 3 || GetState
| 3 || [[#GetState|GetState]]
|-
|-
| 4 || Cancel
| 4 || [[#Cancel|Cancel]]
|-
|-
| 5 || [1.0.0-6.2.0] PrintModuleInformation
| 5 || [1.0.0-6.2.0] [[#PrintModuleInformation|PrintModuleInformation]]
|-
|-
| 6 || GetModuleInformation
| 6 || [[#GetModuleInformation|GetModuleInformation]]
|-
|-
| 10 || [9.0.0+]
| 7 || [17.0.0+] SetRandomDelay
|-
|-
| 11 || [9.0.0+]
| 10 || [9.0.0+] [[#GetStateLockUpdateEvent|GetStateLockUpdateEvent]]
|-
| 11 || [9.0.0+] [[#IsStateLocked|IsStateLocked]]
|}
|}
== Initialize ==
No input. Returns an output readable Event handle.
== DispatchRequest ==
Takes an input [[#PmState]], an input [[#PmTransitionOrder]] and an input u32 '''Flags'''. No output.
== GetResult ==
No input/output.
== GetState ==
No input. Returns an output [[#PmState]].
== Cancel ==
No input/output.
== PrintModuleInformation ==
No input/output.
== GetModuleInformation ==
Takes two type-0x6 output buffers '''DependencyInformationBefore''' and '''DependencyInformationAfter'''. Returns an output [[#PmModuleTransitionInformation]] and two output u32s '''DependencyInformationBeforeCount''' and '''DependencyInformationAfterCount'''.
== GetStateLockUpdateEvent ==
No input. Returns an output readable Event handle.
== IsStateLocked ==
Takes an input [[#PmState]]. Returns an output bool.


= psc:m =
= psc:m =
Line 57: Line 61:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
! Cmd || Name
|-
|-
| 0 || GetPmModule || Returns an [[#IPmModule]].
| 0 || [[#GetPmModule|GetPmModule]]
|}
|}
== GetPmModule ==
No input. Returns an [[#IPmModule]].


== IPmModule ==
== IPmModule ==
Line 69: Line 76:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || Initialize
| 0 || [[#Initialize_2|Initialize]]
|-
|-
| 1 || GetRequest
| 1 || [[#GetRequest|GetRequest]]
|-
|-
| 2 || Acknowledge
| 2 || [[#Acknowledge|Acknowledge]]
|-
|-
| 3 || Finalize
| 3 || [[#Finalize|Finalize]]
|-
|-
| 4 || [5.1.0+] AcknowledgeEx
| 4 || [5.1.0+] [[#AcknowledgeEx|AcknowledgeEx]]
|}
|}
=== Initialize ===
Takes an input [[#PmModuleId]] and a type-0x5 input buffer '''Dependencies'''. Returns an output Event handle.
=== GetRequest ===
No input. Returns an output [[#PmState]] and an output u32 '''Flags'''.
=== Acknowledge ===
No input/output.
On newer versions this cmd just Aborts - this was replaced by [[#AcknowledgeEx|AcknowledgeEx]].
=== Finalize ===
No input/output.
=== AcknowledgeEx ===
Takes an input [[#PmState]]. No output.


= psc:l =
= psc:l =
This is "nn::psc::sf::IPmStateLock".
This was added with [9.0.0+].
This was added with [9.0.0+].


Line 87: Line 113:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 ||
| 0 || [[#Initialize_3|Initialize]]
|-
|-
| 1 ||
| 1 || [[#Lock|Lock]]
|-
|-
| 2 ||
| 2 || [[#Unlock|Unlock]]
|-
|-
| 3 ||
| 3 || [[#IsLocked|IsLocked]]
|-
|-
| 4 ||
| 4 || [[#GetRelatedState|GetRelatedState]]
|}
|}
== Initialize ==
Takes an input [[#PmState]]. No output.
== Lock ==
No input/output.
== Unlock ==
No input/output.
== IsLocked ==
No input. Returns an output bool.
== GetRelatedState ==
No input. Returns an output [[#PmState]].


= srepo:u, srepo:a =
= srepo:u, srepo:a =
Line 102: Line 143:


These were added with [5.0.0+].
These were added with [5.0.0+].
Some commands are only accessible by srepo:a. srepo:a is only accessible by [[BCAT_services|bcat]] on retail.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 107: Line 150:
! Cmd || Name
! Cmd || Name
|-
|-
| 10100 ||
| 10100 || [[#SaveReport]]
|-
| 10101 || [6.0.0+] [[#SaveReportWithUser]]
|-
| 10200 || [6.0.0+] [[#SaveReportForAntiPiracy]]
|-
|-
| 10101 || [6.0.0+]
| 10201 || [6.0.0+] [[#SaveReportWithUserForAntiPiracy]]
|-
|-
| 10200 || [6.0.0+]
| 10300 || [15.0.0+] [[#SendReportWithUser]]
|-
|-
| 10201 || [6.0.0+]
| 11000 || [6.0.0+] [[#NotifyUserList]]
|-
|-
| 11000 || [6.0.0+]
| 11001 || [6.0.0+] [[#NotifyUserDeleted]]
|-
|-
| 11001 || [6.0.0+]
| 11002 || [6.0.0+] [[#NotifyUserRegistered]]
|-
|-
| 11002 || [6.0.0+]
| 11003 || [6.0.0-10.2.0] [[#NotifyUserClosed]]
|-
|-
| 11003 || [6.0.0+]
| 11004 || [6.0.0-10.2.0] [[#NotifyUserOpened]]
|-
|-
| 11004 || [6.0.0+]
| 11005 || [11.0.0+] [[#NotifyUserClosedWithApplicationId]]
|-
|-
| 11100 || [6.0.0+]
| 11006 || [11.0.0+] [[#NotifyUserOpenedWithApplicationId]]
|-
|-
| 11200 || [6.0.0+]
| 11100 || [6.0.0+] [[#NotifyCompletedNetworkRequestChanged]]
|-
|-
| 11300 || [6.0.0+]
| 11200 || [6.0.0+] [[#NotifyFriendPresenceChanged]]
|-
|-
| 11400 || [6.0.0+]
| 11300 || [6.0.0+] [[#NotifyNotificationConnectivityChanged]]
|-
|-
| 11500 || [6.0.0+]
| 11400 || [6.0.0+] [[#NotifyDeviceOperationModeChanged]]
|-
|-
| 11600 || [6.0.0+]
| 11500 || [6.0.0+] [[#NotifySystemPowerStateChanged]]
|-
|-
| 11601 || [6.0.0+]
| 11600 || [6.0.0+] [[#NotifyAppletLaunched]]
|-
|-
| 11602 || [6.0.0+]
| 11601 || [6.0.0+] [[#NotifyAppletExited]]
|-
|-
| 11700 || [6.0.0+]
| 11602 || [6.0.0+] [[#NotifyForegroundAppletChanged]]
|-
|-
| 11800 || [6.0.0+]
| 11700 || [6.0.0+] [[#NotifyControllerCountChanged]]
|-
|-
| 11801 || [6.0.0+]
| 11800 || [6.0.0+] [[#NotifyAudioInStarted]]
|-
|-
| 11810 || [8.0.0+]
| 11801 || [6.0.0+] [[#NotifyAudioInStopped]]
|-
|-
| 11811 || [8.0.0+]
| 11810 || [8.0.0+] [[#NotifyLaunchApplicationStorage]]
|-
|-
| 12000 || [8.0.0+]
| 11811 || [8.0.0+] [[#NotifyApplicationRightsInfo]]
|-
|-
| 12001 || [8.0.0+]
| 12000 || [8.0.0+] [[#RegisterWatchdog]]
|-
|-
| 13000 || [8.0.0+]
| 12001 || [8.0.0+] [[#UnregisterWatchdog]]
|-
|-
| 13001 || [8.0.0+]
| 12010 || [20.0.0+]
|-
|-
| 20100 ||
| 13000 || [8.0.0+] [[#GetSyslogLogger]]
|-
|-
| 20200 ||
| 13001 || [8.0.0-19.0.1] [[#SaveSyslogReport]]
|-
|-
| 20300 || [6.0.0+]
| 13002 || [19.0.0+]  
|-
|-
| 20400 || [6.0.0+]
| 13003 || [20.0.0+]  
|-
|-
| 20401 || [6.0.0+]
| 13004 || [20.0.0+]  
|-
|-
| 20402 || [7.0.0+]
| 20100 || [[#PopReport]]
|-
|-
| 20500 || [8.0.0+]
| 20200 || [[#GetPushEventReadableHandle]]
|-
| 20300 || [6.0.0+] [[#Shutdown]]
|-
| 20400 || [6.0.0+] [[#PopLostByBufferShortageInfo]]
|-
| 20401 || [6.0.0+] [[#GetBufferUsageInfo]]
|-
| 20402 || [7.0.0+] [[#SetDurationReportChatteringDetectionThreshold]]
|-
| 20500 || [8.0.0+] [[#GetWatchdogStatistics]]
|-
| 20600 || [15.0.0+] [[#NotifyForegroundTransmissionResult]]
|}
|}


== Cmd13000 ==
[20.0.0+] Cmd13002 now takes a total of 8-bytes of input.
Takes a type-0x5 input buffer, no output.
 
== SaveReport ==
Takes a type-0x9 input buffer containing the [[#EventId]], an input u64 '''ApplicationId''' and a type-0x5 input buffer containing the [[#SystemReport]]. No output.
 
[21.0.0+] Now takes an additional 8-bytes of input.


[9.0.0+] No input, returns a total of 0xC-bytes of output, an [[#IUnknown0]], and a handle.
<code>nn::srepo::detail::VerifyEventId</code> is then used with the [[#EventId]], throwing error on failure.


== IUnknown0 ==
The [[#SystemReport]] is used with <code>nn::srepo::detail::VerifyReport</code> and with last param = 0x8000, throwing error on failure.
Added with [9.0.0+].
 
Lastly, the actual processing func is called, returning the Result from here. Besides various cmd input being passed to this etc, this also passes the output from <code>nn::util::GenerateUuid()</code> to this.
 
== SaveReportWithUser ==
Takes a type-0x9 input buffer containing the [[#EventId]], an input u64 '''ApplicationId''', a type-0x5 input buffer containing the [[#SystemReport]] and an input [[Account_services#Uid|Uid]]. No output.
 
[21.0.0+] Now takes an additional 8-bytes of input.
 
Same as [[#SaveReport]] except instead of calling the processing func with Uid=all-zero, the input Uid is passed instead (which must be non-zero).
 
== SaveReportForAntiPiracy ==
Takes a type-0x9 input buffer containing the [[#EventId]], an input u64 '''ApplicationId''' and a type-0x5 input buffer containing the [[#SystemReport]]. No output.
 
Same as [[#SaveReport]] except the [[#SystemReport]] Flags field is 1 instead of 0.
 
== SaveReportWithUserForAntiPiracy ==
Takes a type-0x9 input buffer containing the [[#EventId]], an input u64 '''ApplicationId''', a type-0x5 input buffer containing the [[#SystemReport]] and an input [[Account_services#Uid|Uid]]. No output.
 
Same as [[#SaveReportWithUser]] except the [[#SystemReport]] Flags field is 1 instead of 0.
 
== SendReportWithUser ==
Takes an input [[Account_services#Uid|Uid]], an input u64 '''ApplicationId''', an input bool (padded to u64), two input u32s, a type-0x9 input buffer and a TransferMemory handle. Returns an output [[#IAsyncContext]].
 
The mapped TransferMemory buffer is used with <code>nn::srepo::detail::VerifyReport</code>, returning an error on failure.
 
== NotifyUserList ==
Takes a type-0x9 input buffer containing an array of [[Account_services#Uid|Uid]]. No output.
 
The Sf handler code (func which calls the serv obj vfunc) will throw an error if the buffer size is >0x8F (that is, >8 entries).
 
This gets data from a state list, then clears the is_initialized flag for each entry. Lastly when the input array count is non-zero, this loops through the input array writing each entry into the aforementioned state list. If this would run out of space, it would skip writing that entry and still continue - however this shouldn't be possible with the above Sf check. Then this returns 0.
 
== NotifyUserDeleted ==
Takes an input [[Account_services#Uid|Uid]]. No output.
 
This calls the same state-reset func as [[#NotifyUserList]], except this passes the input Uid instead. Then this returns 0.
 
== NotifyUserRegistered ==
Takes an input [[Account_services#Uid|Uid]]. No output.
 
This calls the same state-writing func as [[#NotifyUserList]], except this passes the input Uid instead. Then this returns 0.
 
== NotifyUserClosed ==
Takes an input [[Account_services#Uid|Uid]]. No output.
 
== NotifyUserOpened ==
Takes an input [[Account_services#Uid|Uid]]. No output.
 
== NotifyUserClosedWithApplicationId ==
Takes an input [[Account_services#Uid|Uid]] and an input u64 '''ApplicationId'''. No output.
 
== NotifyUserOpenedWithApplicationId ==
Takes an input [[Account_services#Uid|Uid]] and an input u64 '''ApplicationId'''. No output.
 
== NotifyCompletedNetworkRequestChanged ==
Takes an input s8 and an input bool. No output.
 
== NotifyFriendPresenceChanged ==
Takes an input [[Account_services#Uid|Uid]] and an input s8 (padded to u64). No output.
 
== NotifyNotificationConnectivityChanged ==
Takes an input s8. No output.
 
== NotifyDeviceOperationModeChanged ==
Takes an input s8. No output.
 
== NotifySystemPowerStateChanged ==
Takes an input s8. No output.
 
== NotifyAppletLaunched ==
Takes an input [[#SfAppletIdentityInfo]]. No output.
 
== NotifyAppletExited ==
Takes an input [[#SfAppletIdentityInfo]]. No output.
 
== NotifyForegroundAppletChanged ==
Takes an input [[#SfAppletIdentityInfo]]. No output.
 
== NotifyControllerCountChanged ==
Takes three input s8s. No output.
 
== NotifyAudioInStarted ==
Takes a type-0x5 input buffer and an input u64. No output.
 
== NotifyAudioInStopped ==
Takes a type-0x5 input buffer and an input u64. No output.
 
== NotifyLaunchApplicationStorage ==
Takes an input u64 '''ApplicationId''' and an input u8 (padded to u64). No output.
 
== NotifyApplicationRightsInfo ==
Takes an input u64 '''ApplicationId''' and an input u32 (padded to u64). No output.
 
If the input u32 is 0 or none of the bits are recognized, this just returns 0. Otherwise the lowest set bit is used to determine a value to write to stack (the ApplicationId is also written afterwards), for passing to a func.
 
{| class="wikitable" border="1"
|-
! Bit || Write value
|-
| 0 || 0x2
|-
| 3 || 0x3
|-
| 4 || 0x4
|-
| 5 || [20.1.0+] 0x5
|-
| 6 || [20.1.0+] 0x6
|}
 
== RegisterWatchdog ==
Takes a type-0x9 input buffer, an input [[#TimeSpanType]] and an input u64. Returns an output [[#WatchdogHandle]].
 
== UnregisterWatchdog ==
Takes an input [[#WatchdogHandle]]. No output.
 
== GetSyslogLogger ==
Takes a type-0x5 input buffer. No output.
 
[9.0.0+] No input. Returns three output u32s, an [[#ISyslogLogger]] and a SharedMemory handle.
 
The SharedMemory is mapped with the returned size and with permissions=RW.
 
== SaveSyslogReport ==
Takes an input u128 "nn::util::Uuid". No output.
 
== PopReport ==
Takes a type-0xA output buffer and a type-0x6 output buffer. Returns an output [[Account_services#Uid|Uid]].
 
[6.0.0+] This now returns an additional output u64 '''ApplicationId''' and an output u128 "nn::util::Uuid".
 
[10.0.0+] This now returns an additional output u64 and two output u32s.
 
This is only usable with srepo:a.
 
== GetPushEventReadableHandle ==
No input. Returns an output Event handle.
 
This is only usable with srepo:a.
 
== Shutdown ==
No input/output.
 
== PopLostByBufferShortageInfo ==
Takes an input u32. Returns two output u64s.
 
The input u32 must be <=1. This gets data from a state array with the specified index.
 
== GetBufferUsageInfo ==
No input. Returns two output u64s.
 
The first u64 is a constant value, while the second u64 is from state.
 
== SetDurationReportChatteringDetectionThreshold ==
Takes an input [[#TimeSpanType]] and an input u64. No output.
 
The input s64 must be >=1. The two input fields are written into global state, and various state is also cleared.
 
== GetWatchdogStatistics ==
No input. Returns an output [[#WatchdogStatistics]].
 
This gets two u64s from global state.
 
== NotifyForegroundTransmissionResult ==
Takes an input u128 "nn::util::Uuid" and an input [[#ResultHolder]]. No output.
 
This goes through the global list of [[#IAsyncContext]] looking for an entry with data matching the input struct, then writes the input [[#ResultHolder]] into that [[#IAsyncContext]]. This Result would then be returned by [[#GetResult]] - the Event from [[#GetSystemEvent]] is also signaled.
 
This always returns 0.
 
== ISyslogLogger ==
This is "nn::srepo::detail::ipc::ISyslogLogger".
 
This was added with [9.0.0+].
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#ReallocateBuffer|ReallocateBuffer]]
|}
 
=== ReallocateBuffer ===
No input. Returns two output u32s.
 
This does the same entry-allocation in sharedmem as [[#GetSyslogLogger]].
 
== IAsyncContext ==
This is "nn::srepo::detail::ipc::IAsyncContext".
 
This was added with [15.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 186: Line 439:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 ||  
| 0 || [[#GetSystemEvent]]
|-
| 1 || [[#Cancel]]
|-
| 2 || [[#GetResult]]
|}
|}


Cmd0: no input, returns a total of 8-bytes of output.
=== GetSystemEvent ===
No input, returns an output Event.
 
=== Cancel ===
No input/output.
 
This just returns 0.
 
=== GetResult ===
No input/output.
 
This checks if the Event from GetSystemEvent was signaled throwing an error if not, otherwise this returns the Result stored in the context object.


= ovln:rcv =
= ovln:rcv =
Line 198: Line 466:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || OpenReceiver
| 0 || [[#OpenReceiver|OpenReceiver]]
|}
|}
== OpenReceiver ==
No input. Returns an [[#IReceiver|IReceiver]].


== IReceiver ==
== IReceiver ==
Line 208: Line 479:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || AddSource
| 0 || [[#AddSource|AddSource]]
|-
|-
| 1 || RemoveSource
| 1 || [[#RemoveSource|RemoveSource]]
|-
|-
| 2 || GetReceiveEventHandle
| 2 || [[#GetReceiveEventHandle|GetReceiveEventHandle]]
|-
|-
| 3 || Receive
| 3 || [[#Receive|Receive]]
|-
|-
| 4 || ReceiveWithTick
| 4 || [[#ReceiveWithTick|ReceiveWithTick]]
|}
|}
=== AddSource ===
Takes an input [[#SourceName|SourceName]]. No output.
=== RemoveSource ===
Takes an input [[#SourceName|SourceName]]. No output.
=== GetReceiveEventHandle ===
No input. Returns an output Event handle.
=== Receive ===
No input. Returns an output [[#RawMessage|RawMessage]].
=== ReceiveWithTick ===
No input. Returns an output [[#RawMessage|RawMessage]] and an output s64.


= ovln:snd =
= ovln:snd =
Line 226: Line 512:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || OpenSender
| 0 || [[#OpenSender|OpenSender]]
|}
|}
== OpenSender ==
Takes an input [[#SourceName|SourceName]] and an input [[#QueueAttribute|QueueAttribute]]. Returns an [[#ISender|ISender]].


== ISender ==
== ISender ==
Line 236: Line 525:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || Send
| 0 || [[#Send|Send]]
|-
|-
| 1 || GetUnreceivedMessageCount
| 1 || [[#GetUnreceivedMessageCount|GetUnreceivedMessageCount]]
|}
|}
=== Send ===
Takes an input [[#RawMessage|RawMessage]] and an input [[#SendOption|SendOption]]. No output.
=== GetUnreceivedMessageCount ===
No input. Returns an output u32.


= time:m =
= time:m =
Line 271: Line 566:
|-
|-
| 15 || [[#SetupEphemeralNetworkSystemClockCore]]
| 15 || [[#SetupEphemeralNetworkSystemClockCore]]
|-
| 20 || [19.0.0+] GetStandardSteadyClockCurrentTimePoint
|-
| 21 || [22.0.0+] GetStandardNetworkSystemClockCurrentTime
|-
|-
| 50 || GetStandardLocalClockOperationEvent
| 50 || GetStandardLocalClockOperationEvent
Line 364: Line 663:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || GetAlarmEvent
| 0 || [[#GetAlarmEvent]]
|-
|-
| 1 || Enable
| 1 || [[#Enable]]
|-
|-
| 2 || Disable
| 2 || [[#Disable]]
|-
|-
| 3 || IsEnabled
| 3 || [[#IsEnabled]]
|-
|-
| 10 || [[#CreateWakeLock]]
| 10 || [[#CreateWakeLock]]
Line 376: Line 675:
| 11 || [[#DestroyWakeLock]]
| 11 || [[#DestroyWakeLock]]
|}
|}
=== GetAlarmEvent ===
No input, returns an output Event handle with EventClearMode=0.
Official sw uses this during object creation.
=== Enable ===
Takes an input u64, no output.
The u64 is a nanoseconds value.
=== Disable ===
No input/output.
Official sw uses [[#IsEnabled]] first, if the output bool is 0 it will skip using the Disable cmd.
=== IsEnabled ===
No input, returns an output bool.


=== CreateWakeLock ===
=== CreateWakeLock ===
Line 381: Line 698:


=== DestroyWakeLock ===
=== DestroyWakeLock ===
No input/output.
Close the session opened by [[#CreateWakeLock]] when the alarm is disabled.
Close the session opened by [[#CreateWakeLock]] when the alarm is disabled.


Line 451: Line 770:
|-
|-
| 501 || [4.0.0+] CalculateSpanBetween ||  
| 501 || [4.0.0+] CalculateSpanBetween ||  
|-
| 600 || [19.0.0+] GetInitialLaunchEndTime ||
|-
| 601 || [22.0.0+] NotifyInitialLaunchSettingsDone ||
|}
|}


Line 490: Line 813:


=== TimeSpanType ===
=== TimeSpanType ===
This is an u64.
This is an s64.


== ISystemClock ==
== ISystemClock ==
Line 680: Line 1,003:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 ||
| 0 || [[#GetInputSourceState]]
|-
|-
| 1 ||
| 1 || [[#GetTriggerTargetEvent]]
|}
|}


== Cmd0 ==
== GetInputSourceState ==
Takes an input u32 '''InsID'''. Returns an u64.
Takes an input u32 '''SourceId'''. Returns an output u64 '''EventTime'''.


== Cmd1 ==
== GetTriggerTargetEvent ==
Takes an input u32 '''InsID''' and an input u64 (unused, official software passes struct pointer). Returns an output Event handle with autoclear disabled.
Takes an input u32 '''SourceId''' and an input u64 (unused, official software passes struct pointer). Returns an output Event handle with autoclear disabled.


= ins:s =
= ins:s =
Line 700: Line 1,023:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 ||
| 0 || [[#GetNotifyEvent]]
|}
 
== GetNotifyEvent ==
Takes an input u32 '''SourceId''' and an input u64 (unused, official software passes struct pointer). Returns an output Event handle with autoclear disabled.
 
= hshl:sys =
This is "nn::hshl::IManager".
 
This was added with [11.0.0+].
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetBatteryPercentage
|-
| 1 || GetChargerType
|-
| 2 || [[#OpenChargeSession]]
|-
| 3 || GetRawBatteryPercentage
|-
| 4 || GetBatteryVoltageLevel
|-
| 5 || [[#OpenThermalSession]]
|-
| 6 || GetAbnormalTemperatureSet
|-
| 7 || [[#OpenClockSession]]
|-
| 8 || GetClockRate
|-
| 9 || [17.0.0+] [[#OpenBridgeSession]]
|-
| 10 || [17.0.0+] GetBridgePowerSupply
|-
| 11 || [18.0.0+] [[#OpenVsysVoltageSession]]
|-
| 12 || [18.0.0+] GetIsBatteryEnoughForFullAwake
|-
| 13 || [19.0.0+] GetIsCharging
|-
| 14 || [20.0.0+]
|-
| 15 || [20.0.0+]
|}
 
== OpenChargeSession ==
No input. Returns an [[#IChargeSession]].
 
== OpenThermalSession ==
No input. Returns an [[#IThermalSession]].
 
== OpenClockSession ==
Takes an input u32. Returns an [[#IClockSession]].
 
== OpenBridgeSession ==
No input. Returns an [[#IBridgeSession]].
 
== OpenVsysVoltageSession ==
No input. Returns an [[#IVsysVoltageSession]].
 
== IChargeSession ==
This is "nn::hshl::IChargeSession".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetStateChangeEvent
|-
| 1 || SetStateChangeSet
|}
 
== IThermalSession ==
This is "nn::hshl::IThermalSession".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetAbnormalTemperatureEvent
|-
| 1 || SetAbnormalTemperatureEventMask
|}
 
== IClockSession ==
This is "nn::hshl::IClockSession".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetStateChangeEvent
|}
 
== IBridgeSession ==
This is "nn::hshl::IBridgeSession".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetStateChangeEvent
|}
 
== IVsysVoltageSession ==
This is "nn::hshl::IVsysVoltageSession".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetStateChangeEvent
|}
 
= hshl:set =
This is "nn::hshl::ISetterManager".
 
This was added with [11.0.0+].
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#OpenChargeSession_2|OpenChargeSession]]
|-
| 1 || [[#OpenThermalSession_2|OpenThermalSession]]
|-
| 2 || SetClockRate
|-
| 3 || [17.0.0+] SetBridgePowerSupply
|-
| 4 || [18.0.0+]
|-
| 5 || [18.0.0+]
|}
 
== OpenChargeSession ==
Takes an input u32. Returns an [[#IChargeSetterSession]].
 
== OpenThermalSession ==
Takes an input u32. Returns an [[#IThermalSetterSession]].
 
== IChargeSetterSession ==
This is "nn::hshl::IChargeSetterSession".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetBatteryPercentage
|-
| 1 || SetRawBatteryPercentage
|-
| 2 || SetChargerType
|-
| 3 || SetBatteryVoltageLevel
|-
| 4 || [18.0.0+]
|-
| 5 || [19.0.0+]
|-
| 6 || [20.0.0+]
|-
| 7 || [20.0.0+]
|}
|}


== Cmd0 ==
== IThermalSetterSession ==
Takes an input u32 '''InsID''' and an input u64 (unused, official software passes struct pointer). Returns an output Event handle with autoclear disabled.
This is "nn::hshl::IThermalSetterSession".


= PSC Module IDs =
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! ID || Module
! Cmd || Name
|-
| 0 || SetAbnormalTemperatureSet
|}
 
= PmModuleId =
This is "nn::psc::PmModuleId".
 
{| class="wikitable" border="1"
|-
|-
| 0x00 ||
! Name || Module
|-
|-
| 0x01 ||
| 0x00 || Reserved0
|-
|-
| 0x02 ||
| 0x01 || Reserved1
|-
|-
| 0x03 ||
| 0x02 || Reserved2
|-
|-
| 0x04 || [[USB_services|PmModuleId_Usb]]
| 0x03 || [[Sockets_services|Socket]]
|-
|-
| 0x05 || [[Sockets_services|PmModuleId_Ethernet]]
| 0x04 || [[USB_services|Usb]]
|-
|-
| 0x06 || [[PTM_services|PmModuleId_Fgm]]
| 0x05 || [[Ethernet_services|Eth]]
|-
|-
| 0x07 || [[PCV_services|PmModuleId_PcvClock]]
| 0x06 || [[PTM_services|Fgm]]
|-
|-
| 0x08 || [[PCV_services|PmModuleId_PcvVoltage]]
| 0x07 || [[PCV_services|PcvClock]]
|-
|-
| 0x09 || [[Bus_services|PmModuleId_Gpio]]
| 0x08 || [[PCV_services|PcvVoltage]]
|-
|-
| 0x0A || [[Bus_services|PmModuleId_Pinmux]]
| 0x09 || [[Bus_services|Gpio]]
|-
|-
| 0x0B || [[Bus_services|PmModuleId_Uart]]
| 0x0A || [[Bus_services|Pinmux]]
|-
|-
| 0x0C || [[Bus_services|PmModuleId_I2c]]
| 0x0B || [[Bus_services|Uart]]
|-
|-
| 0x0D || [[Bus_services|PmModuleId_I2cPcv]]
| 0x0C || [[Bus_services|I2c]]
|-
|-
| 0x0E || [[Bus_services|PmModuleId_Spi]]
| 0x0D || [[Bus_services|I2cPowerBus]]
|-
|-
| 0x0F || [[Bus_services|PmModuleId_Pwm]]
| 0x0E || [[Bus_services|Spi]]
|-
|-
| 0x10 || [[PTM_services|PmModuleId_Psm]]
| 0x0F || [[Bus_services|Pwm]]
|-
|-
| 0x11 || [[PTM_services|PmModuleId_Tc]]
| 0x10 || [[PTM_services|Psm]]
|-
|-
| 0x12 || [[Applet_Manager_services|PmModuleId_Omm]]
| 0x11 || [[PTM_services|Tc]]
|-
|-
| 0x13 || [[PCIe_services|PmModuleId_Pcie]]
| 0x12 || [[OMM_services|Omm]]
|-
|-
| 0x14 || [[Backlight_services|PmModuleId_Lbl]]
| 0x13 || [[PCIe_services|Pcie]]
|-
|-
| 0x15 || [[Nvnflinger_services|PmModuleId_Display]]
| 0x14 || [[Backlight_services|Lbl]]
|-
|-
| 0x16 ||
| 0x15 || [[Nvnflinger_services|Display]]
|-
|-
| 0x17 ||
| 0x16 || [[Display_services|Multimedia]]
|-
|-
| 0x18 || [[HID_services|PmModuleId_Hid]]
| 0x17 || Time
|-
|-
| 0x19 || [[WLAN_services|PmModuleId_WlanSockets]]
| 0x18 || [[HID_services|Hid]]
|-
|-
| 0x1A ||
| 0x19 || [[WLAN_services|SocketWlan]]
|-
|-
| 0x1B || [[Filesystem_services|PmModuleId_Fs]]
| 0x1A || [[WLAN_services|Wlan]]
|-
|-
| 0x1C || [[Audio_services|PmModuleId_Audio]]
| 0x1B || [[Filesystem_services|Fs]]
|-
|-
| 0x1D ||
| 0x1C || [[Audio_services|Audio]]
|-
|-
| 0x1E || [[TMA_services|PmModuleId_TmaHostIo]]
| 0x1D || [[TMA_services|Tm]]
|-
|-
| 0x1F || [[Bluetooth_Driver_services|PmModuleId_Bluetooth]]
| 0x1E || [[TMA_services|TmHostIo]]
|-
|-
| 0x20 || [[PCV_services|PmModuleId_Bpc]]
| 0x1F || [[Bluetooth_Driver_services|Bluetooth]]
|-
|-
| 0x21 || [[PTM_services|PmModuleId_Fan]]
| 0x20 || [[PCV_services|Bpc]]
|-
|-
| 0x22 || [[PTM_services|PmModuleId_Pcm]]
| 0x21 || [[PTM_services|Fan]]
|-
|-
| 0x23 || [[NFC_services|PmModuleId_Nfc]]
| 0x22 || [[PTM_services|Pcm]]
|-
| 0x23 || [[NFC_services|Nfc]]
|-  
|-  
| 0x24 || [[PTM_services|PmModuleId_Apm]]
| 0x24 || [[PTM_services|Apm]]
|-
| 0x25 || [[BTM_services|Btm]]
|-
| 0x26 || [[Network_Interface_services|Nifm]]
|-
| 0x27 || [[Bus_services|GpioLow]]
|-
| 0x28 || [[NPNS_services|Npns]]
|-
| 0x29 || [[Log_services|Lm]]
|-
| 0x2A || [[BCAT_services|Bcat]]
|-
| 0x2B || [[Glue_services|Time]]
|-
| 0x2C || [[Parental_Control_services|Pctl]]
|-
|-
| 0x25 || [[BTM_services|PmModuleId_Btm]]
| 0x2D || [[Error_Report_services|Erpt]]
|-
|-
| 0x26 || [[Network_Interface_services|PmModuleId_Nifm]]
| 0x2E || [[Error_Upload_services|Eupld]]
|-
|-
| 0x27 || [[Bus_services|PmModuleId_GpioLow]]
| 0x2F || [[Friend_services|Friends]]
|-
|-
| 0x28 || [[NPNS_services|PmModuleId_Npns]]
| 0x30 || [[Glue_services|Bgtc]]
|-
|-
| 0x29 || [[Log_services|PmModuleId_Lm]]
| 0x31 || [[Account_services|Account]]
|-
|-
| 0x2A || [[BCAT_services|PmModuleId_Bcat]]
| 0x32 || [[Bus_services|Sasbus]]
|-
|-
| 0x2B || [[Glue_services|PmModuleId_Time]]
| 0x33 || [[NIM_services|Ntc]]
|-
|-
| 0x2C || [[Parental_Control_services|PmModuleId_Pctl]]
| 0x34 || [[OMM_services|Idle]]
|-
|-
| 0x2D || [[Error_Report_services|PmModuleId_Erpt]]
| 0x35 || [[Applet_Manager_services|Tcap]]
|-
|-
| 0x2E || [[Error_Upload_services|PmModuleId_Eupld]]
| 0x36 || [[PTM_services|PsmLow]]
|-
|-
| 0x2F || [[Friend_services|PmModuleId_Friends]]
| 0x37 || [[LDN_services|Ndd]]
|-
|-
| 0x30 || [[Glue_services|PmModuleId_Bgtc]]
| 0x38 || [[OLSC_services|Olsc]]
|-
|-
| 0x31 || [[Account_services|PmModuleId_Account]]
| 0x39 || [[PCV_services|Rtc]]
|-
|-
| 0x32 || [[Bus_services|PmModuleId_Sasbus]]
| 0x3A || [[PCV_services|Regulator]]
|-
|-
| 0x33 || [[NIM_services|PmModuleId_Ntc]]
| 0x3B || [[PCV_services|Clkrst]]
|-
|-
| 0x34 || [[Applet_Manager_services|PmModuleId_Idle]]
| 0x3C || [[Bus_services|Led]]
|-
|-
| 0x35 || [[Applet_Manager_services|PmModuleId_Tcap]]
| 0x3D || [[NS_Services|NuiShell]]
|-
|-
| 0x36 || [[PTM_services|PmModuleId_PsmLow]]
| 0x3E || [[PTM_services|Powctl]]
|-
|-
| 0x37 || [[LDN_services|PmModuleId_Ndd]]
| 0x3F || [[OMM_services|NotificationPresenter]]
|-
|-
| 0x38 || [[OLSC_services|PmModuleId_Olsc]]
| 0x40 || [[Glue_services|Notification]]
|-
|-
| 0x39 ||
| 0x41 || [[Sockets_services|Dhcpc]]
|-
|-
| 0x3A ||
| 0x42 || [[BCAT_services|Mnpp]]
|-
|-
| 0x3B ||
| 0x43 || [[OLSC_services|Sprofile]]
|-
|-
| 0x3C ||
| 0x65 || [[NV_services|NvHost]]
|-
|-
| 0x3D || [[NS_Services|PmModuleId_Ns]]
| 0x69 || NvDbgSvc
|-
|-
| 0x65 || [[NV_services|PmModuleId_Nvservices]]
| 0x6A || Tspm
|-
|-
| 0x7F || [[Applet_Manager_services|PmModuleId_Spsm]]
| 0x7F || [[OMM_services|Spsm]]
|}
|}


= Power Management States =
= PmState =
This is "nn::psc::PmState".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! ID || Name || Description
! Value || Name || Description
|-
| 0 || FullAwake || Everything is awake.
|-
| 1 || MinimumAwake || Preparing to transition to awake.
|-
| 2 || SleepReady || Preparing to transition to sleep.
|-
|-
| Awake || 0 || Everything is awake.
| 3 || EssentialServicesSleepReady || Critical services are ready to sleep.
|-
|-
| ReadyAwaken || 1 || Preparing to transition to awake.
| 4 || EssentialServicesAwake || Critical services are ready to wake up.
|-
|-
| ReadySleep || 2 || Preparing to transition to sleep.
| 5 || ShutdownReady || Preparing to transition to shutdown.
|-
| 6 || Invalid || Default state.
|}
 
= PmTransitionOrder =
This is "nn::psc::PmTransitionOrder".
 
{| class="wikitable" border="1"
|-
|-
| ReadySleepCritical || 3 || Critical services are ready to sleep.
! Value
! Description
|-
|-
| ReadyAwakenCritical || 4 || Critical services are ready to wake up.
| 0 || ToLowerPowerState
|-
|-
| ReadyShutdown || 5 || Preparing to transition to shutdown.
| 1 || ToHigherPowerState
|}
|}
= PmModuleTransitionInformation =
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| TimeBefore
|-
| 0x8
| 0x10
| TimeAfter
|-
| 0x10
| 0x4
| Result
|-
| 0x14
| 0x4
| [[#PmState|StateBefore]]
|-
| 0x18
| 0x4
| [[#PmState|StateAfter]]
|-
| 0x1C
| 0x4
| Reserved
|}
= SystemReport =
This is "nn::srepo::SystemReport".
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x20
| [[#EventId|EventId]]
|-
| 0x20
| 0x8
| ApplicationId
|-
| 0x28
| 0x4
| Flags
|-
| 0x2C
| 0x1
|
|-
| 0x2D
| 0x3
| Reserved
|-
| 0x30
| 0x8
| ReportBufferAddress
|-
| 0x38
| 0x8
| ReportBufferTotalSize
|-
| 0x40
| 0x8
| ReportBufferCurrentSize
|}
= EventId =
This is "nn::srepo::EventId". This is a 0x20-byte string.
= WatchdogHandle =
This is "nn::srepo::WatchdogHandle". This is an u64.
= WatchdogStatistics =
This is "nn::srepo::WatchdogStatistics".
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
|
|-
| 0x8
| 0x8
|
|}
= ResultHolder =
This is "nn::srepo::detail::ipc::ResultHolder". This is an u32.
= SfAppletIdentityInfo =
This is "nn::srepo::detail::ipc::SfAppletIdentityInfo". This is a 0x10-byte struct.
= SourceName =
This is "nn::ovln::SourceName".
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x10
| Name
|}
= RawMessage =
This is "nn::ovln::RawMessage".
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Tag
|-
| 0x4
| 0x4
| DataSize
|-
| 0x8
| 0x78
| Data
|}
= QueueAttribute =
This is "nn::ovln::QueueAttribute".
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| QueueLength
|-
| 0x4
| 0x4
| Reserved
|}
= SendOption =
This is "nn::ovln::SendOption".
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x1
| EnqueuePosition
|-
| 0x1
| 0x1
| OverflowOption
|-
| 0x2
| 0x6
| Reserved
|}
== EnqueuePosition ==
This is "nn::ovln::EnqueuePosition".
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Front
|-
| 1 || Back
|}
== OverflowOption ==
This is "nn::ovln::OverflowOption".
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Error
|-
| 1 || RemoveFront
|-
| 2 || RemoveBack
|-
| 3 || Block
|}
= Notes =
psc:m allows a process to register a module that depends on power management in some way. A client calls GetPmModule to receive an IPmModule (Power Managed Module), and then calls IPmModule->Initialize(module_id, module_dependency_list) where module_id is the ModuleId enum member for the client, and the dependency list is an array of module IDs for the modules that this depends on. Initialize() returns an event handle that the client can wait on to be notified of a power state change.
psc:c allows a module to the power state controller for the system (in practice, AM is the only client to the controller). IPmControl->DispatchRequest() is used notify all IPmModules of a state change.
For example, FS registers itself as an IPmModule with dependencies on pinmux, gpio, pcv, tma, and initializes the SD card once those dependencies have registered..
It then does (basically) the following pseudocode (actual code located at .text + 0xB2DB0 in 6.0.0 FS):
    while (true) {
        Fs_IPmModule->WaitSignaled();
       
        Fs_IPmModule->GetRequest(&state);
        switch (state) {
            case WakingUp:
                /* hardware devices are woken up here */
            case GoingToSleep:
                /* hardware devices are put to sleep here */
            case ShuttingDown:
                /* hardware devices are turned off here */
        }
       
        Fs_IPmModule->Acknowledge(state);
    }


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