Changes

1,119 bytes added ,  19:20, 5 August 2023
Line 24: Line 24:  
| 7 || [[#Disconnect|Disconnect]]
 
| 7 || [[#Disconnect|Disconnect]]
 
|-
 
|-
| 8 || [[#GetSystemEvent|GetSystemEvent]]
+
| 8 || [[#GetConnectionEvent|GetConnectionEvent]]
 
|-
 
|-
 
| 9 || [[#GetConnectionStatus|GetConnectionStatus]]
 
| 9 || [[#GetConnectionStatus|GetConnectionStatus]]
Line 44: Line 44:  
| 17 || [[#ConnectWithWps|ConnectWithWps]]
 
| 17 || [[#ConnectWithWps|ConnectWithWps]]
 
|-
 
|-
| 18 || [3.0.0+]
+
| 18 || [3.0.0+] [[#GetWakeupReason|GetWakeupReason]]
 
|-
 
|-
| 19 || [3.0.0+]
+
| 19 || [3.0.0+] [[#SetTcpSessionInformation|SetTcpSessionInformation]]
 
|-
 
|-
| 20 || [3.0.0+]
+
| 20 || [3.0.0+] [[#RemoveTcpSessionInformation|RemoveTcpSessionInformation]]
 
|-
 
|-
| 21 || [3.0.0+]
+
| 21 || [3.0.0+] [[#GetWakeupReasonRaw|GetWakeupReasonRaw]]
 
|-
 
|-
| 22 || [3.0.0+]
+
| 22 || [3.0.0+] [[#SetWakeupReasonRaw|SetWakeupReasonRaw]]
 
|-
 
|-
| 23 || [3.0.0+]
+
| 23 || [3.0.0+] [[#EnableWowlFeatures|EnableWowlFeatures]]
 
|-
 
|-
| 24 || [3.0.0+]
+
| 24 || [3.0.0+] [[#GetWowlStats|GetWowlStats]]
 
|-
 
|-
| 25 || [3.0.0+]
+
| 25 || [3.0.0+] [[#ClearWowlStats|ClearWowlStats]]
 
|-
 
|-
| 26 || [4.0.0+]
+
| 26 || [4.0.0+] [[#EmulateDriverInitFail|EmulateDriverInitFail]]
 
|-
 
|-
| 27 || [4.0.0+]
+
| 27 || [4.0.0+] [[#GetAllowedChannels|GetAllowedChannels]]
 
|-
 
|-
 
| 28 || [5.0.0+] [[#InitializeWlan|InitializeWlan]]
 
| 28 || [5.0.0+] [[#InitializeWlan|InitializeWlan]]
Line 70: Line 70:  
| 30 || [8.0.0+] [[#SetWowlDelayedWakeTime|SetWowlDelayedWakeTime]]
 
| 30 || [8.0.0+] [[#SetWowlDelayedWakeTime|SetWowlDelayedWakeTime]]
 
|-
 
|-
| 31 || [11.0.0+]
+
| 31 || [11.0.0+] [[#StartConcurrentCommunication|StartConcurrentCommunication]]
 
|-
 
|-
| 32 || [11.0.0+]
+
| 32 || [11.0.0+] [[#StopConcurrentCommunication|StopConcurrentCommunication]]
 
|-
 
|-
| 33 || [11.0.0+]
+
| 33 || [11.0.0+] [[#SendConcurrentData|SendConcurrentData]]
 
|-
 
|-
| 34 || [11.0.0+]
+
| 34 || [11.0.0+] [[#RecvConcurrentData|RecvConcurrentData]]
 
|-
 
|-
| 35 || [11.0.0+]
+
| 35 || [11.0.0+] [[#CancelRecvConcurrentData|CancelRecvConcurrentData]]
 
|-
 
|-
| 36 || [11.0.0+]
+
| 36 || [11.0.0+] [[#SetConcurrentCycle|SetConcurrentCycle]]
 
|-
 
|-
| 37 || [11.0.0+]
+
| 37 || [11.0.0+] [[#SetConcurrentDataRate|SetConcurrentDataRate]]
 
|-
 
|-
| 38 || [13.0.0+] [[#SetDfrts|SetDfrts]]
+
| 38 || [13.0.0+] [[#SetPowerSaveMode|SetPowerSaveMode]]
 
|}
 
|}
  −
[4.0.0+] Connect now takes an additional 4-bytes of input.
  −
  −
[5.0.0+] Cmd24 now returns a total of 0x58-bytes of output instead of 0x5C.
  −
  −
[7.0.0+] Input/output for cmds 27/28 were swapped, perhaps these cmds were swapped?
      
== OpenMode ==
 
== OpenMode ==
Line 132: Line 126:  
== Connect ==
 
== Connect ==
 
Takes an input [[#ConnectParam]]. No output.
 
Takes an input [[#ConnectParam]]. No output.
 +
 +
[4.0.0+] Now takes an additional 4-bytes of input.
    
Sends command messages 0xA (SetWlanInterfaceUpDown), 0x11 (SetBeaconLostTimeout) and 0x20 (JoinNetworkSta) to the state machine.
 
Sends command messages 0xA (SetWlanInterfaceUpDown), 0x11 (SetBeaconLostTimeout) and 0x20 (JoinNetworkSta) to the state machine.
Line 151: Line 147:  
This is used by [[Network_Interface_services|nifm]].
 
This is used by [[Network_Interface_services|nifm]].
   −
== GetSystemEvent ==
+
== GetConnectionEvent ==
 
Takes an input u32 '''SystemEventType'''. Returns an output Event handle.
 
Takes an input u32 '''SystemEventType'''. Returns an output Event handle.
   Line 246: Line 242:  
This is not used on retail.
 
This is not used on retail.
   −
== Cmd18 ==
+
== GetWakeupReason ==
No input, returns an output u32.
+
No input. Returns an output u32.
    
Sends command message 0x80 (GetState) to the state machine, to check current state. Sends command message 0x36 to the state machine to get a value from state, which is then passed to a vfunc call. That func checks bits in the input to determine what value to return, which is then written to the output u32.
 
Sends command message 0x80 (GetState) to the state machine, to check current state. Sends command message 0x36 to the state machine to get a value from state, which is then passed to a vfunc call. That func checks bits in the input to determine what value to return, which is then written to the output u32.
Line 253: Line 249:  
This is not used on retail.
 
This is not used on retail.
   −
== Cmd19 ==
+
== SetTcpSessionInformation ==
 
Takes an input [[#MacAddress]], three input u16s '''SrcPort''', '''DstPort''' and '''Unk0''', and three input u32s '''SrcIp''', '''DstIp''' and '''Unk1'''. No output.
 
Takes an input [[#MacAddress]], three input u16s '''SrcPort''', '''DstPort''' and '''Unk0''', and three input u32s '''SrcIp''', '''DstIp''' and '''Unk1'''. No output.
   Line 262: Line 258:  
This is used by [[Network_Interface_services|nifm]].
 
This is used by [[Network_Interface_services|nifm]].
   −
== Cmd20 ==
+
== RemoveTcpSessionInformation ==
 
No input/output.
 
No input/output.
   −
This clears the state set by [[#Cmd19]].
+
This clears the state set by [[#SetTcpSessionInformation]].
    
This is not used on retail.
 
This is not used on retail.
   −
== Cmd21 ==
+
== GetWakeupReasonRaw ==
No input, returns an output u32.
+
No input. Returns an output u32.
   −
Same as [[#Cmd18]] except the value from the request is returned directly, without calling the vfunc.
+
Same as [[#GetWakeupReason]] except the value from the request is returned directly, without calling the vfunc.
    
This is not used on retail.
 
This is not used on retail.
   −
== Cmd22 ==
+
== SetWakeupReasonRaw ==
Takes an input u32, no output.
+
Takes an input u32. No output.
   −
Same as [[#Cmd21]] except this uses message 0x37 with the input u32. This is handled by writing the u32 into a global field (default value is 0xBC), which is used during configuration for [[#Cmd19|"wowl"]].
+
Same as [[#GetWakeupReasonRaw]] except this uses message 0x37 with the input u32. This is handled by writing the u32 into a global field (default value is 0xBC), which is used during configuration for [[#SetTcpSessionInformation|"wowl"]].
    
This is not used on retail.
 
This is not used on retail.
   −
== Cmd23 ==
+
== EnableWowlFeatures ==
Takes an input u32, no output.
+
Takes an input u32. No output.
   −
Sends command message 0x38 to the state machine. This is handled by writing the input value into a global flags field. The default value is 0x3 (all flag bits set). These flag bits are checked during the RequestSleep code handling the state for [[#Cmd19]].
+
Sends command message 0x38 to the state machine. This is handled by writing the input value into a global flags field. The default value is 0x3 (all flag bits set). These flag bits are checked during the RequestSleep code handling the state for [[#SetTcpSessionInformation]].
    
This is not used on retail.
 
This is not used on retail.
   −
== Cmd24 ==
+
== GetWowlStats ==
No input, returns a [[#WakeUpStats]] and a [[#SleepStats]].
+
No input. Returns a [[#WakeUpStats]] and a [[#SleepStats]].
 +
 
 +
[5.0.0+] Now returns a total of 0x58-bytes of output instead of 0x5C.
    
Sends command message 0x39 to the state machine, with 0x20-bytes from the output being copied to the first output struct. Sends command message 0x3A to the state machine, with 0x38-bytes from the output being copied to the second output struct.
 
Sends command message 0x39 to the state machine, with 0x20-bytes from the output being copied to the first output struct. Sends command message 0x3A to the state machine, with 0x38-bytes from the output being copied to the second output struct.
Line 299: Line 297:  
This is not used on retail.
 
This is not used on retail.
   −
== Cmd25 ==
+
== ClearWowlStats ==
Takes two input bools, no output.
+
Takes two input bools. No output.
    
When the first bool flag is set, sends command message 0x3B to the state machine. When the second bool flag is set, sends command message 0x3C to the state machine. Then 0 is returned.
 
When the first bool flag is set, sends command message 0x3B to the state machine. When the second bool flag is set, sends command message 0x3C to the state machine. Then 0 is returned.
   −
Both requests are handled by clearing various data in state. The first request clears the first state struct returned by [[#Cmd24]], likewise with the second request and the second state struct from [[#Cmd24]].
+
Both requests are handled by clearing various data in state. The first request clears the first state struct returned by [[#GetWowlStats]], likewise with the second request and the second state struct from [[#GetWowlStats]].
    
This is not used on retail.
 
This is not used on retail.
   −
== Cmd26 ==
+
== EmulateDriverInitFail ==
 
No input/output.
 
No input/output.
   Line 317: Line 315:  
This is not used on retail.
 
This is not used on retail.
   −
== Cmd27 ==
+
== GetAllowedChannels ==
Takes a type-0xA output buffer containing an array of 2-byte entries, returns an output u32 total_out.
+
Takes a type-0xA output buffer containing an array of 2-byte entries. Returns an output u32 total_out.
    
This memcpys data from state into the output buffer, clamped to a maximum of 0x40 entries (nifm hard-codes the count to 0x26).
 
This memcpys data from state into the output buffer, clamped to a maximum of 0x40 entries (nifm hard-codes the count to 0x26).
Line 339: Line 337:     
== SetWowlDelayedWakeTime ==
 
== SetWowlDelayedWakeTime ==
Unofficial name.
  −
   
Takes an input s32 '''WowlDelayedWakeTime'''. No output.
 
Takes an input s32 '''WowlDelayedWakeTime'''. No output.
   −
'''WowlDelayedWakeTime''' must be <=0xE10 (3600) and >= -1. This value is written into state (last field in the state struct also used by [[#Cmd19]], which [[#Cmd19]] doesn't write), then this returns 0.
+
'''WowlDelayedWakeTime''' must be <=0xE10 (3600) and >= -1. This value is written into state (last field in the state struct also used by [[#SetTcpSessionInformation]], which [[#SetTcpSessionInformation]] doesn't write), then this returns 0.
    
The user-process code using this cmd also has the above bounds check.
 
The user-process code using this cmd also has the above bounds check.
   −
This is used by wlan during RequestSleep from the same code using the state set by [[#Cmd19]].
+
This is used by wlan during RequestSleep from the same code using the state set by [[#SetTcpSessionInformation]].
    
This cmd is used by [[Network_Interface_services|nifm]] with a value from state, prior to using RequestSleep.
 
This cmd is used by [[Network_Interface_services|nifm]] with a value from state, prior to using RequestSleep.
    
If wificore gets to the point of actually using this for TCP-keep-alive, then it does the following:
 
If wificore gets to the point of actually using this for TCP-keep-alive, then it does the following:
* This is only used when the [[#Cmd19|TCP]] connection is RST.
+
* This is only used when the [[#SetTcpSessionInformation|TCP]] connection is RST.
 
** '''WowlDelayedWakeTime''' is the time in seconds to schedule a timer which will wake the system. 0 will schedule it for immediately.
 
** '''WowlDelayedWakeTime''' is the time in seconds to schedule a timer which will wake the system. 0 will schedule it for immediately.
 
** -1 will skip scheduling that timer, hence waking the system is disabled when RST is received.
 
** -1 will skip scheduling that timer, hence waking the system is disabled when RST is received.
Line 358: Line 354:  
* Frames where the TCP flags do not match ACK will immediately wake the system, + other wake cause(s).
 
* Frames where the TCP flags do not match ACK will immediately wake the system, + other wake cause(s).
   −
== Cmd31 ==
+
== StartConcurrentCommunication ==
 
No input/output.
 
No input/output.
   Line 365: Line 361:  
This is not used on retail.
 
This is not used on retail.
   −
== Cmd32 ==
+
== StopConcurrentCommunication ==
 
No input/output.
 
No input/output.
   Line 372: Line 368:  
This is not used on retail.
 
This is not used on retail.
   −
== Cmd33 ==
+
== SendConcurrentData ==
Takes an input [[#MacAddress]] and a type-0x5 input buffer, no output.
+
Takes an input [[#MacAddress]] and a type-0x5 input buffer. No output.
    
Stubbed, just returns an error.
 
Stubbed, just returns an error.
Line 379: Line 375:  
This is not used on retail.
 
This is not used on retail.
   −
== Cmd34 ==
+
== RecvConcurrentData ==
Takes a type-0x6 output buffer and returns a total of 0x10-bytes.
+
Takes a type-0x6 output buffer. Returns a total of 0x10-bytes.
    
Stubbed, just returns an error.
 
Stubbed, just returns an error.
Line 386: Line 382:  
This is not used on retail.
 
This is not used on retail.
   −
== Cmd35 ==
+
== CancelRecvConcurrentData ==
 
No input/output.
 
No input/output.
   Line 393: Line 389:  
This is not used on retail.
 
This is not used on retail.
   −
== Cmd36 ==
+
== SetConcurrentCycle ==
Takes two input u64s, no output.
+
Takes two input u64s. No output.
    
Stubbed, just returns an error.
 
Stubbed, just returns an error.
Line 400: Line 396:  
This is not used on retail.
 
This is not used on retail.
   −
== Cmd37 ==
+
== SetConcurrentDataRate ==
Takes an input u32, no output.
+
Takes an input u32. No output.
    
Stubbed, just returns an error.
 
Stubbed, just returns an error.
Line 407: Line 403:  
This is not used on retail.
 
This is not used on retail.
   −
== SetDfrts ==
+
== SetPowerSaveMode ==
Unofficial name.
  −
 
   
Takes an input u32 '''Mode'''. No output.
 
Takes an input u32 '''Mode'''. No output.