Nintendo Switch Brew

PSC services: Difference between revisions

← Older editNewer edit →
No edit summary
Line 187: Line 187:
! Cmd || Name
! Cmd || Name
|-
|-
| 10100 ||
| 10100 || [[#SaveReport]]
|-
|-
| 10101 || [6.0.0+]
| 10101 || [6.0.0+] [[#SaveReportWithUser]]
|-
|-
| 10200 || [6.0.0+]
| 10200 || [6.0.0+] [[#SaveReportForAntiPiracy]]
|-
|-
| 10201 || [6.0.0+]
| 10201 || [6.0.0+] [[#SaveReportWithUserForAntiPiracy]]
|-
|-
| 10300 || [15.0.0+]
| 10300 || [15.0.0+] [[#SendReportWithUser]]
|-
|-
| 11000 || [6.0.0+]
| 11000 || [6.0.0+] [[#NotifyUserList]]
|-
|-
| 11001 || [6.0.0+]
| 11001 || [6.0.0+] [[#NotifyUserDeleted]]
|-
|-
| 11002 || [6.0.0+]
| 11002 || [6.0.0+] [[#NotifyUserRegistered]]
|-
|-
| 11003 || [6.0.0-10.2.0]
| 11003 || [6.0.0-10.2.0] [[#NotifyUserClosed]]
|-
|-
| 11004 || [6.0.0-10.2.0]
| 11004 || [6.0.0-10.2.0] [[#NotifyUserOpened]]
|-
|-
| 11005 || [11.0.0+]
| 11005 || [11.0.0+] [[#NotifyUserClosedWithApplicationId]]
|-
|-
| 11006 || [11.0.0+]
| 11006 || [11.0.0+] [[#NotifyUserOpenedWithApplicationId]]
|-
|-
| 11100 || [6.0.0+]
| 11100 || [6.0.0+] NotifyCompletedNetworkRequestChanged
|-
|-
| 11200 || [6.0.0+]
| 11200 || [6.0.0+] NotifyFriendPresenceChanged
|-
|-
| 11300 || [6.0.0+]
| 11300 || [6.0.0+] NotifyNotificationConnectivityChanged
|-
|-
| 11400 || [6.0.0+]
| 11400 || [6.0.0+] NotifyDeviceOperationModeChanged
|-
|-
| 11500 || [6.0.0+]
| 11500 || [6.0.0+] NotifySystemPowerStateChanged
|-
|-
| 11600 || [6.0.0+]
| 11600 || [6.0.0+] NotifyAppletLaunched
|-
|-
| 11601 || [6.0.0+]
| 11601 || [6.0.0+] NotifyAppletExited
|-
|-
| 11602 || [6.0.0+]
| 11602 || [6.0.0+] NotifyForegroundAppletChanged
|-
|-
| 11700 || [6.0.0+]
| 11700 || [6.0.0+] NotifyControllerCountChanged
|-
|-
| 11800 || [6.0.0+]
| 11800 || [6.0.0+] NotifyAudioInStarted
|-
|-
| 11801 || [6.0.0+]
| 11801 || [6.0.0+] NotifyAudioInStopped
|-
|-
| 11810 || [8.0.0+]
| 11810 || [8.0.0+] NotifyLaunchApplicationStorage
|-
|-
| 11811 || [8.0.0+]
| 11811 || [8.0.0+] NotifyApplicationRightsInfo
|-
|-
| 12000 || [8.0.0+]
| 12000 || [8.0.0+] [[#RegisterWatchdog]]
|-
|-
| 12001 || [8.0.0+]
| 12001 || [8.0.0+] [[#UnregisterWatchdog]]
|-
|-
| 13000 || [8.0.0+] [[#OpenSyslogLogger]]
| 13000 || [8.0.0+] [[#GetSyslogLogger]]
|-
|-
| 13001 || [8.0.0+]
| 13001 || [8.0.0+] [[#SaveSyslogReport]]
|-
|-
| 20100 ||
| 20100 || [[#PopReport]]
|-
|-
| 20200 ||
| 20200 || [[#GetPushEventReadableHandle]]
|-
|-
| 20300 || [6.0.0+]
| 20300 || [6.0.0+] [[#Shutdown]]
|-
|-
| 20400 || [6.0.0+]
| 20400 || [6.0.0+] [[#PopLostByBufferShortageInfo]]
|-
|-
| 20401 || [6.0.0+]
| 20401 || [6.0.0+] [[#GetBufferUsageInfo]]
|-
|-
| 20402 || [7.0.0+]
| 20402 || [7.0.0+] [[#SetDurationReportChatteringDetectionThreshold]]
|-
|-
| 20500 || [8.0.0+]
| 20500 || [8.0.0+] [[#GetWatchdogStatistics]]
|-
|-
| 20600 || [15.0.0+]
| 20600 || [15.0.0+] NotifyForegroundTransmissionResult
|}
|}


== Cmd10100 ==
== SaveReport ==
Takes a type-0x9 input buffer containing the [[#SystemReport|SystemReport]] EventId string, an input [[NCM_services#ProgramId|ProgramId]] from the [[#SystemReport|SystemReport]] and a type-0x5 input buffer containing the [[#SystemReport|SystemReport]] Report. No output.
Takes a type-0x9 input buffer containing the [[#EventId]], an input u64 '''ApplicationId''' and a type-0x5 input buffer containing the [[#SystemReport]]. No output.


The EventId buffer size must be 0x1-0x20, and the last byte in the buffer must be NUL. <code>nn::srepo::detail::VerifyEventId</code> is then used with the EventId buffer, throwing error on failure.
<code>nn::srepo::detail::VerifyEventId</code> is then used with the [[#EventId]], throwing error on failure.


The Report buffer is used with <code>nn::srepo::detail::VerifyReport</code> and with last param = 0x8000, throwing error on failure.
The [[#SystemReport]] is used with <code>nn::srepo::detail::VerifyReport</code> and with last param = 0x8000, throwing error on failure.


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.
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.


== Cmd10101 ==
== SaveReportWithUser ==
Takes a type-0x9 input buffer containing the [[#SystemReport|SystemReport]] EventId string, an input [[NCM_services#ProgramId|ProgramId]] from the [[#SystemReport|SystemReport]], a type-0x5 input buffer containing the [[#SystemReport|SystemReport]] Report and an 0x10-byte input struct. No output.
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 [[#Cmd10100]] except instead of calling the processing func with struct=all-zero, the input struct is passed instead (which must be non-zero).
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).


== Cmd10200 ==
== SaveReportForAntiPiracy ==
Takes a type-0x9 input buffer containing the [[#SystemReport|SystemReport]] EventId string, an input [[NCM_services#ProgramId|ProgramId]] from the [[#SystemReport|SystemReport]] and a type-0x5 input buffer containing the [[#SystemReport|SystemReport]] Report. No output.
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 [[#Cmd10100]] except the [[#SystemReport|SystemReport]] Version field is 1 instead of 0.
Same as [[#SaveReport]] except the [[#SystemReport]] Version field is 1 instead of 0.


== Cmd10201 ==
== SaveReportWithUserForAntiPiracy ==
Takes a type-0x9 input buffer containing the [[#SystemReport|SystemReport]] EventId string, an input [[NCM_services#ProgramId|ProgramId]] from the [[#SystemReport|SystemReport]], a type-0x5 input buffer containing the [[#SystemReport|SystemReport]] Report and an 0x10-byte input struct. No output.
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 [[#Cmd10101]] except the [[#SystemReport|SystemReport]] Version field is 1 instead of 0.
Same as [[#SaveReportWithUser]] except the [[#SystemReport]] Version field is 1 instead of 0.


== Cmd10300 ==
== SendReportWithUser ==
Takes a total of 0x28-bytes of input, a type-0x9 input buffer and a TransferMemory handle. Returns an output [[#IAsyncContext]].
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.
The mapped TransferMemory buffer is used with <code>nn::srepo::detail::VerifyReport</code>, returning an error on failure.


== Cmd11000 ==
== NotifyUserList ==
Takes a type-0x9 input buffer containing an array of a 0x10-byte struct. No output.
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).
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).
Line 298: Line 298:
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.
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.


== Cmd11001 ==
== NotifyUserDeleted ==
Takes a 0x10-byte input struct. No output.
Takes an input [[Account_services#Uid|Uid]]. No output.


This calls the same state-reset func as [[#Cmd11000]], except this passes the input struct instead. Then this returns 0.
This calls the same state-reset func as [[#NotifyUserList]], except this passes the input Uid instead. Then this returns 0.


== Cmd11002 ==
== NotifyUserRegistered ==
Takes a 0x10-byte input struct. No output.
Takes an input [[Account_services#Uid|Uid]]. No output.


This calls the same state-writing func as [[#Cmd11000]], except this passes the input struct instead. Then this returns 0.
This calls the same state-writing func as [[#NotifyUserList]], except this passes the input Uid instead. Then this returns 0.


== Cmd11003 ==
== NotifyUserClosed ==
Takes a 0x10-byte input struct. No output.
Takes an input [[Account_services#Uid|Uid]]. No output.


== Cmd11004 ==
== NotifyUserOpened ==
Takes a 0x10-byte input struct. No output.
Takes an input [[Account_services#Uid|Uid]]. No output.


Identical to [[#Cmd11003]] except different input is passed to the called func (1 instead of 0).
== NotifyUserClosedWithApplicationId ==
Takes an input [[Account_services#Uid|Uid]] and an input u64 '''ApplicationId'''. No output.


== Cmd11005 ==
== NotifyUserOpenedWithApplicationId ==
Takes a total of 0x18-bytes of input. No output.
Takes an input [[Account_services#Uid|Uid]] and an input u64 '''ApplicationId'''. No output.


This replaces [[#Cmd11003]].
== RegisterWatchdog ==
Takes a type-0x9 input buffer, an input s64 "nn::TimeSpanType" and an input u64. Returns an output [[#WatchdogHandle]].


== Cmd11006 ==
== UnregisterWatchdog ==
Takes a total of 0x18-bytes of input. No output.
Takes an input [[#WatchdogHandle]]. No output.


Identical to [[#Cmd11005]] except different input is passed to the called func (1 instead of 0).
== GetSyslogLogger ==
 
This replaces [[#Cmd11004]].
 
== Cmd12001 ==
Takes an input u64. No output.
 
The input u64 is only used for comparing with a field in list entries.
 
== OpenSyslogLogger ==
Takes a type-0x5 input buffer. No output.
Takes a type-0x5 input buffer. No output.


[9.0.0+] No input. Returns 3 u32s of output (sharedmem_size, out1, out2), an [[#ISyslogLogger]], and a SharedMemory handle.
[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.
The SharedMemory is mapped with the returned size and with permissions=RW.


== Cmd13001 ==
== SaveSyslogReport ==
Takes a total of 0x10-bytes of input. No output.
Takes an input u128 "nn::util::Uuid". No output.


== Cmd20100 ==
== PopReport ==
Takes a type-0xA output buffer and a type-0x6 output buffer. Returns a total of 0x10-bytes of output.
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 0x18-bytes of output.
[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 0x10-bytes of output.
[10.0.0+] This now returns an additional output u64 and two output u32s.


This is only usable with srepo:a.
This is only usable with srepo:a.


== Cmd20200 ==
== GetPushEventReadableHandle ==
No input. Returns an output Event handle.
No input. Returns an output Event handle.


This is only usable with srepo:a.
This is only usable with srepo:a.


This Event is signaled by the various other commands when data becomes available with [[#Cmd20100]].
== Shutdown ==
 
== Cmd20300 ==
No input/output.
No input/output.


== Cmd20400 ==
== PopLostByBufferShortageInfo ==
Takes an input u32 index. Returns two output u64s.
Takes an input u32. Returns two output u64s.


The input index must be <=1. This gets data from a state array with the specified index.
The input u32 must be <=1. This gets data from a state array with the specified index.


== Cmd20401 ==
== GetBufferUsageInfo ==
No input. Returns two output u64s.
No input. Returns two output u64s.


The first u64 is a constant value, while the second u64 is from state.
The first u64 is a constant value, while the second u64 is from state.


== Cmd20402 ==
== SetDurationReportChatteringDetectionThreshold ==
Takes an input s64 and u64. No output.
Takes an input s64 "nn::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.
The input s64 must be >=1. The two input fields are written into global state, and various state is also cleared.


== Cmd20500 ==
== GetWatchdogStatistics ==
No input. Returns two output u64s.
No input. Returns an output [[#WatchdogStatistics]].


This gets two u64s from global state.
This gets two u64s from global state.


== Cmd20600 ==
== NotifyForegroundTransmissionResult ==
Takes a 0x10-byte input struct and a Result. No output.
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 Result into that [[#IAsyncContext]]. This Result would then be returned by [[#GetResult]] - the Event from [[#GetSystemEvent]] is also signaled.
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.
This always returns 0.
Line 398: Line 389:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 ||  
| 0 || [[#ReallocateBuffer|ReallocateBuffer]]
|}
|}


=== Cmd0 ===
=== ReallocateBuffer ===
No input. Returns two output u32s.
No input. Returns two output u32s.


This does the same entry-allocation in sharedmem as [[#OpenSyslogLogger]].
This does the same entry-allocation in sharedmem as [[#GetSyslogLogger]].


== IAsyncContext ==
== IAsyncContext ==
Retrieved from "https://switchbrew.org/wiki/PSC_services"