LDN services: Difference between revisions
(22 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
= ldn:m = | = ldn:m = | ||
This is "nn::ldn::detail::IMonitorServiceCreator". | This is "nn::ldn::detail::IMonitorServiceCreator". | ||
This has IPC max_sessions 5. | |||
[20.2.0+] This has max_sessions 6. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 84: | Line 88: | ||
= ldn:s = | = ldn:s = | ||
This is "nn::ldn::detail::ISystemServiceCreator". | This is "nn::ldn::detail::ISystemServiceCreator". | ||
[18.0.0+] The sdknso uses SessionManager with this, where the additional session-count is 0x3. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 97: | Line 103: | ||
No input. Returns an [[#ISystemLocalCommunicationService]]. | No input. Returns an [[#ISystemLocalCommunicationService]]. | ||
The user-process closes the ISystemServiceCreator object | The user-process closes the ISystemServiceCreator object once finished with it during initialization. Official sw ignores errors from this cmd. | ||
== CreateClientProcessMonitor == | == CreateClientProcessMonitor == | ||
Line 258: | Line 264: | ||
The sdk user-process func will pass value 1 to the cmd when the input [[#Protocol|Protocol]] is 0/1, 3 is passed directly if specified, otherwise Abort. User-processes use SetProtocol immediately after initializing ldn. | The sdk user-process func will pass value 1 to the cmd when the input [[#Protocol|Protocol]] is 0/1, 3 is passed directly if specified, otherwise Abort. User-processes use SetProtocol immediately after initializing ldn. | ||
[20.0.0+] The ldn initialization functionality in sdknso also uses this with value 1 (NX) eventually after the init cmd was used successfully. | |||
The input is validated, then a vfunc is called. | The input is validated, then a vfunc is called. | ||
Line 371: | Line 379: | ||
This is used immediately after object creation. | This is used immediately after object creation. | ||
With [7.0.0+] [[#InitializeWithVersion|InitializeWithVersion]] is used instead. The cmd impl for Initialize uses [[#InitializeWithVersion|InitializeWithVersion]] with | On old sysvers the cmd impl for User/System are identical, except different params are used for the funcs called internally. | ||
With [7.0.0+] [[#InitializeWithVersion|InitializeWithVersion]] is used instead. The cmd impl for Initialize uses [[#InitializeWithVersion|InitializeWithVersion]] with version=0. | |||
=== Finalize === | === Finalize === | ||
Line 390: | Line 400: | ||
=== InitializeWithVersion === | === InitializeWithVersion === | ||
Takes an input PID, | Takes an input PID, a s32 version, and an u64 pid_placeholder. | ||
The priority is determined by whether the interface is User/System: System = 0x38, User = 0x5A. | |||
It then calls the init func, with the cmd input params and the above priority, returning the Result on failure. | |||
On newer sysvers this then adds an entry for the state array used by [[#RegisterClient|RegisterClient]]. | |||
Lastly the input PID and version are written into state, then this returns. | |||
The init func does the following: | |||
* The PID must be non-zero, and the version must not be negative. The priority must be 0x5A or 0x38. | |||
* An error is returned if state fields are invalid. | |||
* The input PID and version are written into state (a state field is also set to interface == User). | |||
* Lastly, a vfunc is called with the input priority, returning the Result from that. | |||
The | The vfunc does the following: | ||
* On newer sysvers, this uses [[Shared_Database_services|pl:s]] RequestApplicationFunctionAuthorizationByProcessId with the input PID and [[Shared_Database_services|ApplicationFunctionAuthorizationId]] = 2 (SecureLdnLocalCommunication), returning the Result on failure. | |||
* Then a message is sent to a msg-queue with the input priority. | |||
The handler for the above message does the following: | |||
* When state is already initialized, runs handling for that. An error is also thrown if the input priority is larger than a state field. | |||
* Initializes state, etc. | |||
* Various [[Network_Interface_services|nifm]] funcs are eventually used. The input priority is used to determine the value for [[Network_Interface_services#CreateRequest|nn::nifm::RequestParameters]]: value 0x4 or value 0x8 is used, depending on priority > 0x59. | |||
** Newer versions also handle ldn lan_emulation [[System_Settings|sys-settings]] here. For the above value, when lan_emulation is enabled it uses value 0x17, with 0x18 additionally used for priority <= 0x59. | |||
* The rest is state init, including setting [[#State|State]] to value 1. Then 0 is returned. | |||
On old sysvers the cmd impl for User/System are identical, except different params are used for the funcs called internally. With newer sysvers the cmd impl is now identical. | |||
[[ | Version values passed by official sw: | ||
{| class="wikitable" border="1" | |||
|- | |||
! Value || SystemVersion | |||
|- | |||
| 0x1 || [7.0.0+] | |||
|- | |||
| 0x2 || [18.0.0+] | |||
|- | |||
| 0x3 || [19.0.0+] | |||
|- | |||
| 0x4 || [20.0.0+] | |||
|} | |||
=== InitializeWithPriority === | === InitializeWithPriority === | ||
Takes an input PID, | Takes an input PID, a s32 version, a s32 priority, and an u64 pid_placeholder. | ||
This is similar to [[#InitializeWithVersion|InitializeWithVersion]] | This is similar to [[#InitializeWithVersion|InitializeWithVersion]]. The input priority is passed directly to the init func which is called here, instead of determining it from whether the interface is User/System. | ||
Official sw passes input value 0x38 for the priority as the default, when the user doesn't specify the priority. | |||
=== EnableActionFrame === | === EnableActionFrame === | ||
Line 473: | Line 517: | ||
| 0 || RegisterClient | | 0 || RegisterClient | ||
|} | |} | ||
=== RegisterClient === | |||
Takes an input PID and an u64 pid_placeholder. | |||
[18.0.0+] [[#CreateClientProcessMonitor|CreateClientProcessMonitor]] and RegisterClient are used by sdknso at the end of the ldn initialization functionality. | |||
If the objptr in IClientProcessMonitor state is already set from using this cmd previously, this just returns 0. | |||
This goes through global state to locate an entry with a matching PID, if none found 0 is returned. The objptr from the state entry is loaded, if NULL this returns 0. This obj is then incref'd and written into the IClientProcessMonitor state. When PID is 0, 0 is returned. It then locates the above state entry again with a matching PID, clearing the entry which matches. Lastly 0 is returned. | |||
The initialization [[#InitializeWithPriority|cmds]] adds an entry to the above global state. | |||
= ldn:u = | = ldn:u = | ||
This is "nn::ldn::detail::IUserServiceCreator". | This is "nn::ldn::detail::IUserServiceCreator". | ||
[18.0.0+] The sdknso uses SessionManager with this, where the additional session-count is 0x3. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 489: | Line 546: | ||
Returns an [[#IUserLocalCommunicationService]]. | Returns an [[#IUserLocalCommunicationService]]. | ||
The user-process closes the IUserServiceCreator object | The user-process closes the IUserServiceCreator object once finished with it during initialization. Official sw ignores errors from this cmd. | ||
== IUserLocalCommunicationService == | == IUserLocalCommunicationService == | ||
This is "nn::ldn::detail::IUserLocalCommunicationService". | This is "nn::ldn::detail::IUserLocalCommunicationService". | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 556: | Line 611: | ||
| 304 || [[#Disconnect|Disconnect]] | | 304 || [[#Disconnect|Disconnect]] | ||
|- | |- | ||
| 400 || [[# | | 400 || [[#Initialize_2|Initialize]] | ||
|- | |- | ||
| 401 || [[# | | 401 || [[#Finalize_2|Finalize]] | ||
|- | |- | ||
| 402 || [7.0.0+] [[# | | 402 || [7.0.0+] [[#InitializeWithVersion|InitializeWithVersion]] | ||
|- | |- | ||
| 403 || [19.0.0+] [[# | | 403 || [19.0.0+] [[#SetOperationMode|SetOperationMode]] | ||
|- | |- | ||
| 500 || [18.0.0+] [[#EnableActionFrame|EnableActionFrame]] | | 500 || [18.0.0+] [[#EnableActionFrame|EnableActionFrame]] | ||
Line 578: | Line 633: | ||
| 601 || [18.0.0+] [[#ResetTxPower|ResetTxPower]] | | 601 || [18.0.0+] [[#ResetTxPower|ResetTxPower]] | ||
|} | |} | ||
= ndd = | = ndd = | ||
Line 980: | Line 1,012: | ||
= NodeInfo = | = NodeInfo = | ||
This is "nn::ldn::NodeInfo". | This is "nn::ldn::NodeInfo". | ||
The first node in the nodes array is always the AccessPoint (NodeId 0x0). NodeId is the index of the node in the nodes array. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 1,035: | Line 1,069: | ||
| 0xC || 0x4 || Reserved | | 0xC || 0x4 || Reserved | ||
|} | |} | ||
* LocalCommunicationId: [[#CreateNetwork|CreateNetwork]], [[#CreateNetworkPrivate|CreateNetworkPrivate]], [[#Connect|Connect]], [[#ConnectPrivate|ConnectPrivate]] (also [[#ScanFilter|ScanFilter]] when enabled with the flag): When -1, this is overwritten with the first LocalCommunicationId from the user-process [[NACP]], if loading fails value 0 is written instead. Otherwise when not -1, if [[NACP]] loading is successful, this field must match one of the LocalCommunicationIds from there. | |||
* SceneId: Arbitrary user data, this can be used for filtering with [[#ScanFilter|ScanFilter]] for example. | |||
= SessionId = | = SessionId = | ||
This is "nn::ldn::SessionId". | This is "nn::ldn::SessionId". | ||
This is used to generate/overwrite the Ssid when needed. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 1,141: | Line 1,180: | ||
This is "nn::ldn::ScanFilter". This is a 0x60-byte struct with 8-byte alignment. | This is "nn::ldn::ScanFilter". This is a 0x60-byte struct with 8-byte alignment. | ||
sdknso copies the input ScanFilter to a tmp struct on stack, which is then used with the cmd. | sdknso copies the input ScanFilter to a tmp struct on stack (with [[#ScanFilterFlag|Flag]] masking), which is then used with the cmd. sdknso only copies Bssid with [[#ScanPrivate|ScanPrivate]], with [[#Scan|Scan]] it also masks out the [[#ScanFilterFlag|Flag]] for Bssid. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 1,161: | Line 1,200: | ||
| 0x5C || 0x4 || [[#ScanFilterFlag|Flag]] | | 0x5C || 0x4 || [[#ScanFilterFlag|Flag]] | ||
|} | |} | ||
Each [[#ScanFilterFlag|Flag]] bit when set enables using the corresponding ScanFilter data. This is usually a compare with the ScanFilter data and the internal [[#NetworkInfo|NetworkInfo]] data. | |||
* NetworkType: (ScanFilter_NetworkType & NetworkInfo_NetworkType) must be non-zero. | |||
* Ssid: The length fields must match, then memcmp is used. | |||
The filtering func also handles validating the Band/Channel, however these fields are internal only and are not exposed in the user ScanFilter. | |||
= ScanFilterFlag = | = ScanFilterFlag = | ||
Line 1,300: | Line 1,346: | ||
This is "nn::ldn::UserConfig". This is a 0x30-byte struct with 1-byte alignment. | This is "nn::ldn::UserConfig". This is a 0x30-byte struct with 1-byte alignment. | ||
sdknso copies the input UserConfig to a tmp struct on stack, which is then used with the cmd. | sdknso copies the input UserConfig to a tmp struct on stack, which is then used with the cmd. Only the first 0x20-bytes are copied, with the rest cleared. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 1,308: | Line 1,354: | ||
! Description | ! Description | ||
|- | |- | ||
| 0x0 || 0x21 || UserName (NUL-terminated string for the user | | 0x0 || 0x21 || UserName (NUL-terminated string for the user name) | ||
|- | |- | ||
| 0x21 || 0xF || Reserved | | 0x21 || 0xF || Reserved | ||
|} | |} | ||
Line 1,891: | Line 1,937: | ||
=== ActionFrame2 === | === ActionFrame2 === | ||
The Action frames used by [[#RecvActionFrame|RecvActionFrame]] have the following structure: | The Action frames used by [[#SendActionFrame|SendActionFrame]]/[[#RecvActionFrame|RecvActionFrame]] have the following structure: | ||
* "Fixed parameters": | * "Fixed parameters": | ||
** "Category code: Vendor Specific (127)" | ** "Category code: Vendor Specific (127)" | ||
Line 1,907: | Line 1,953: | ||
| 0x2 || 0x2 || Protocol ID, must match big-endian 0x0102. | | 0x2 || 0x2 || Protocol ID, must match big-endian 0x0102. | ||
|- | |- | ||
| 0x4 || 0x2 || | | 0x4 || 0x2 || 00 00 | ||
|- | |- | ||
| 0x6 || 0x2 || | | 0x6 || 0x2 || 00 00 | ||
|} | |} | ||
Line 1,940: | Line 1,986: | ||
The key is derived similar to the regular action-frame key (same KeySource), except: the Generation is always [[17.0.0|0x11]], with the following data for hashing: {big-endian LocalCommunicationId} {+0x10 size 0x10-bytes} {[[#ActionFrameSettings]] Passphrase with the specified PassphraseSize}. | The key is derived similar to the regular action-frame key (same KeySource), except: the Generation is always [[17.0.0|0x11]], with the following data for hashing: {big-endian LocalCommunicationId} {+0x10 size 0x10-bytes} {[[#ActionFrameSettings]] Passphrase with the specified PassphraseSize}. | ||
The data payload is the data buffer for [[#SendActionFrame|SendActionFrame]]/[[#RecvActionFrame|RecvActionFrame]]. | |||
== lp2p == | == lp2p == |