Changes

Jump to navigation Jump to search

WLAN services (view source)

Revision as of 17:10, 12 June 2022

7,136 bytes added ,  17:10, 12 June 2022
→‎SetWowlDelayedWakeTime
Line 66: Line 66:  
| 29 || [7.0.0+] [[#FinalizeWlan]]
 
| 29 || [7.0.0+] [[#FinalizeWlan]]
 
|-
 
|-
−
| 30 || [8.0.0+]
+
| 30 || [8.0.0+] [[#SetWowlDelayedWakeTime]]
 
|-
 
|-
 
| 31 || [11.0.0+]
 
| 31 || [11.0.0+]
Line 82: Line 82:  
| 37 || [11.0.0+]
 
| 37 || [11.0.0+]
 
|-
 
|-
−
| 38 || [13.0.0+]
+
| 38 || [13.0.0+] [[#SetDfrts]]
 
|}
 
|}
   Line 95: Line 95:     
Sends command message 0x99 to the state machine.
 
Sends command message 0x99 to the state machine.
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== CloseMode ==
 
== CloseMode ==
Line 100: Line 102:     
Sends command message 0x9A to the state machine.
 
Sends command message 0x9A to the state machine.
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== GetMacAddress ==
 
== GetMacAddress ==
Line 105: Line 109:     
Sends command message 0x18 (GetMacAddress) to the state machine.
 
Sends command message 0x18 (GetMacAddress) to the state machine.
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== StartScan ==
 
== StartScan ==
Line 110: Line 116:     
Sends command messages 0xA (SetWlanInterfaceUpDown) and 0x14 (ScanRequest) to the state machine.
 
Sends command messages 0xA (SetWlanInterfaceUpDown) and 0x14 (ScanRequest) to the state machine.
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== StopScan ==
 
== StopScan ==
Line 115: Line 123:     
Sends command message 0x16 (CancelScan) to the state machine.
 
Sends command message 0x16 (CancelScan) to the state machine.
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== Connect ==
 
== Connect ==
Line 120: Line 130:     
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.
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== CancelConnect ==
 
== CancelConnect ==
Line 125: Line 137:     
Sends command message 0x23 (CancelJoinNetwork) to the state machine.
 
Sends command message 0x23 (CancelJoinNetwork) to the state machine.
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== Disconnect ==
 
== Disconnect ==
Line 130: Line 144:     
Sends command message 0x24 (DisconnectRequest) to the state machine.
 
Sends command message 0x24 (DisconnectRequest) to the state machine.
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== GetSystemEvent ==
 
== GetSystemEvent ==
 
Takes an input u32 '''SystemEventType'''. Returns an output Event handle.
 
Takes an input u32 '''SystemEventType'''. Returns an output Event handle.
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== GetConnectionStatus ==
 
== GetConnectionStatus ==
 
No input. Returns an output [[#ConnectionStatus]].
 
No input. Returns an output [[#ConnectionStatus]].
 +
 +
Sends command message 0x80 (GetState) to the state machine, to check current state. Then this copies data from state to output (unrelated to message 0x80).
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== GetState ==
 
== GetState ==
Line 141: Line 163:     
Sends command message 0x80 (GetState) to the state machine.
 
Sends command message 0x80 (GetState) to the state machine.
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== GetScanResult ==
 
== GetScanResult ==
Line 146: Line 170:     
Sends command message 0x15 (BssInfoListGet) to the state machine.
 
Sends command message 0x15 (BssInfoListGet) to the state machine.
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== GetRssi ==
 
== GetRssi ==
Line 151: Line 177:     
Sends command message 0x2E (GetRssi) to the state machine.
 
Sends command message 0x2E (GetRssi) to the state machine.
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== ChangeRxAntenna ==
 
== ChangeRxAntenna ==
Line 156: Line 184:     
Sends command message 0x30 (SetRxChain) to the state machine.
 
Sends command message 0x30 (SetRxChain) to the state machine.
 +
 +
The input value must be 1-3.
 +
 +
The message handler calls two vfuncs. The first vfunc uses the input u32 directly to configure "rxchain". The second vfunc configures "btc_params" with data determined using the input value.
 +
 +
This is not used on retail.
    
== GetFwVersion ==
 
== GetFwVersion ==
 
Takes a type-0xA output buffer containing a [[#FwVersion]]. No output.
 
Takes a type-0xA output buffer containing a [[#FwVersion]]. No output.
   −
Sends command message 0x33 (GetFwVersion) to the state machine.
+
Sends command message 0x33 (GetFwVersion) to the state machine. The handler validates state, then gets the value for config "ver".
 +
 
 +
This is not used on retail.
    
== RequestSleep ==
 
== RequestSleep ==
Line 166: Line 202:     
Sends command messages 0x24 (DisconnectRequest), 0x34 (RequestSleep), 0x3D and 0x3E to the state machine.
 
Sends command messages 0x24 (DisconnectRequest), 0x34 (RequestSleep), 0x3D and 0x3E to the state machine.
 +
 +
First message GetState is sent, if state is 0x3 it does the following:
 +
 +
* Sends message 0x3D. If successful and the output u8 is 0, this then does the following:
 +
** Uses GetState to check for state 0x2/0x3. On success message DisconnectRequest is sent. If state is invalid or the command message failed, this will Abort.
 +
** Uses GetState to check for state 0x1/0x2/0xA. On success message 0x9A with param=0 is sent. If state is invalid or the command message failed, this will Abort.
 +
 +
Then message RequestSleep is sent. If the Result is not 0x146B (including success), it returns the Result. Otherwise when the Result is that value, it does the following:
 +
 +
* Sends message 0x3E.
 +
** Uses GetState to check for state 0x2/0x3. On success message DisconnectRequest is sent. If state is invalid or the command message failed, this will Abort.
 +
** Uses GetState to check for state 0x1/0x2/0xA. On success message 0x9A with param=0 is sent. If state is invalid or the command message failed, this will Abort.
 +
** Then this cmpl impl func will return the Result from calling itself.
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== RequestWakeUp ==
 
== RequestWakeUp ==
Line 171: Line 222:     
Sends command messages 0x1 (InitalizeWlanDriver), 0x24 (DisconnectRequest), 0x35 (RequestWakeUp), 0x3E, 0x80 (GetState) and 0x81 (GetStateBeforeSleep) to the state machine.
 
Sends command messages 0x1 (InitalizeWlanDriver), 0x24 (DisconnectRequest), 0x35 (RequestWakeUp), 0x3E, 0x80 (GetState) and 0x81 (GetStateBeforeSleep) to the state machine.
 +
 +
First message GetState is sent, returning 0 if state is 0xC, or throwing error if it isn't 0xA. Then message RequestWakeUp is sent, if successful then message 0x3E is sent and 0 is returned.
 +
 +
If RequestWakeUp fails it will immediately return the Result, unless the Result is one of the following:
 +
* 0xE86B (normal non-wowl codepath was previously used during RequestSleep): Sends message InitalizeWlanDriver, returning a Result on failure. Then message GetStateBeforeSleep is sent. If the output state is 0x1, it returns 0. If not 0x2 or the second output field is non-zero, it will Abort. Uses GetState to verify the state is valid, returning the Result from that on failure. Otherwise this will return the Result from sending command request 0x99 with param=0.
 +
* 0xE66B: Sends message 0x3E. Uses GetState to verify the state is valid, when valid then message DisconnectRequest is sent. If state-validation/DisconnectRequest failed this will Abort, otherwise this then returns 0.
 +
 +
This is used by [[Network_Interface_services|nifm]].
    
== ConnectWithWps ==
 
== ConnectWithWps ==
Line 176: Line 235:     
Sends command messages 0xA (SetWlanInterfaceUpDown), 0x11 (SetBeaconLostTimeout) and 0x21 (JoinNetworkStaWithWps) to the state machine.
 
Sends command messages 0xA (SetWlanInterfaceUpDown), 0x11 (SetBeaconLostTimeout) and 0x21 (JoinNetworkStaWithWps) to the state machine.
 +
 +
This is not used on retail.
    
== Cmd18 ==
 
== Cmd18 ==
Line 185: Line 246:     
== Cmd19 ==
 
== Cmd19 ==
−
Takes a [[#MacAddress]], 3 u16s, 3 u32s, no output.
+
Takes an input [[#MacAddress]], three input u16s '''SrcPort''', '''DstPort''' and '''Unk0''', and three input u32s '''SrcIp''', '''DstIp''' and '''Unk1'''. No output.
   −
This copies the input data into state, and sets a flag in state. The input is written into state with the following structure: [[#MacAddress]], u32[0], u32[1], u16[0], u16[1], u32[2], u16[2].
+
This copies the input data into state, and sets a flag in state. The input is written into state with the following structure: [[#MacAddress]], '''SrcIp''', '''DstIp''', '''SrcPort''', '''DstPort''', '''Unk1''', '''Unk0'''.
   −
This data is used during RequestSleep if a state field is set for using it (the codepath using this will throw an error if this data was not set). This data is cleared afterwards regardless of whether it was used. This is used for configuring various config related to wowl/tcpka/etc (wake-on-WLAN/TCP keep-alive). Note that an error is thrown if "wowl_activate" isn't set but sysmodule-side doesn't do so - this seems to be set automatically at some point.
+
This data is used during RequestSleep if a state field is set for using it (the codepath using this will throw an error if this data was not set). This data is cleared afterwards unless sleep was successfully entered with wowl. This is also cleared during RequestWakeUp. This is used for configuring various config related to wowl/tcpka/etc (wake-on-WLAN/TCP keep-alive). Note that an error is thrown if "wowl_activate" isn't set but sysmodule-side doesn't do so - this seems to be set automatically at some point.
    
This is used by [[Network_Interface_services|nifm]].
 
This is used by [[Network_Interface_services|nifm]].
Line 222: Line 283:     
== Cmd24 ==
 
== Cmd24 ==
−
No input, returns a 0x20-byte struct and a 0x38-byte struct.
+
No input, returns a [[#WakeUpStats]] and a [[#SleepStats]].
    
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 235: Line 296:  
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.
+
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]].
    
This is not used on retail.
 
This is not used on retail.
Line 244: Line 305:  
This sends a request which sets a global flag.
 
This sends a request which sets a global flag.
   −
This flag is eventually checked by code which runs via RequestSleep, and in one case with wlan:dtc cmd19 (also used by requests done by nnMain).
+
This flag is eventually checked by code which runs via RequestSleep, and in one case with wlan:dtc cmd19 (also used by requests done by nnMain/RequestWakeUp).
    
This is not used on retail.
 
This is not used on retail.
Line 269: Line 330:  
This is not used on retail.
 
This is not used on retail.
   −
== Cmd30 ==
+
== SetWowlDelayedWakeTime ==
−
Takes an input s32, no output.
+
Unofficial name.
   −
The input s32 must be <=0xE10 (3600) and >= -1. The input value is written into state, then this returns 0.
+
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.
    
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.
Line 279: Line 342:     
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:
 +
* This is only used when the [[#Cmd19|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.
 +
** -1 will skip scheduling that timer, hence waking the system is disabled when RST is received.
 +
** The wificore also supports -3 for immediately waking the system from the frame-handler, however wlan-sysmodule doesn't allow that.
 +
* Frames where the TCP flags do not match ACK will immediately wake the system, + other wake cause(s).
    
== Cmd31 ==
 
== Cmd31 ==
Line 329: Line 399:  
This is not used on retail.
 
This is not used on retail.
   −
== Cmd38 ==
+
== SetDfrts ==
−
Takes an input u32 enum, no output.
+
Unofficial name.
 +
 
 +
Takes an input u32 '''Mode'''. No output.
 +
 
 +
'''Mode''' must be 0 or 1.
   −
The input value must be 0-1.
+
Sends command message 0x32 to the state machine.  
   −
This internally sends a request which is then eventually handled (if the input doesn't match state already + other state fields are valid) by configuring "pm2_sleep_ret_ext" with a global struct selected via the input value. Afterwards another func is called with input value 2.
+
The state machine then handles this by issuing the WLC_SET_VAR ioctl for the "pm2_sleep_ret_ext" variable. '''Mode''' is used to select between 2 sets of hardcoded parameters as follows:
 +
  struct wl_pm2_sleep_ret_ext {
 +
    u8 logic;
 +
    u8 PAD;
 +
    u16 low_ms;
 +
    u16 high_ms;
 +
    u16 rx_pkts_threshold;
 +
    u16 tx_pkts_threshold;
 +
    u16 txrx_pkts_threshold;
 +
    u32 rx_bytes_threshold;
 +
    u32 tx_bytes_threshold;
 +
    u32 txrx_bytes_threshold;
 +
  };
 +
 
 +
  wl_pm2_sleep_ret_ext args = {0};
 +
 
 +
  if (mode == 0) {
 +
    args.logic = 2;
 +
    args.low_ms = 2000;
 +
    args.high_ms = 5000;
 +
    args.rx_pkts_threshold = 10;
 +
  } else if (mode == 1) {
 +
    args.logic = 2;
 +
    args.low_ms = 200;
 +
    args.high_ms = 800;
 +
    args.rx_pkts_threshold = 10;
 +
  }
 +
Afterwards, the WLC_SET_PM ioctl is issued with the argument value 2 (PM2).
    
This is used by [[Network_Interface_services|nifm]].
 
This is used by [[Network_Interface_services|nifm]].
Line 529: Line 630:  
| 11 || EnableSharedMemory
 
| 11 || EnableSharedMemory
 
|-
 
|-
−
| 12 || [6.0.0+]
+
| 12 || [6.0.0+] [[#SetMulticastList]]
 
|}
 
|}
 +
 +
== SetMulticastList ==
 +
Unofficial name.
 +
 +
Takes an input [[#MulticastList]]. No output.
    
= wlan:dtc =
 
= wlan:dtc =
Line 802: Line 908:  
= WpsPin =
 
= WpsPin =
 
This is a 0x8-byte string.
 
This is a 0x8-byte string.
 +
 +
= MulticastList =
 +
This is a 0x31-byte struct.
 +
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset
 +
! Size
 +
! Description
 +
|-
 +
| 0x0 || 0x1 || Count
 +
|-
 +
| 0x1 || 0x30 || Array of [[#MacAddress]]
 +
|}
 +
 +
= WakeUpStats =
 +
This is a 0x20-byte struct.
 +
 +
This is updated during RequestWakeUp. The fields starting with offset +0x4 are updated when handling [[#Cmd19|wowl]], which counter is updated depends on the value of iovar "tcpka_wake_cause".
 +
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset
 +
! Size
 +
! Description
 +
|-
 +
| 0x0 || 0x4 || Number of normal non-wowl wakeups. Also incremented during wowl handling if the output from the func using "tcpka_wake_cause" is 0.
 +
|-
 +
| 0x4 || 0x4 ||
 +
|-
 +
| 0x8 || 0x4 ||
 +
|-
 +
| 0xC || 0x4 ||
 +
|-
 +
| 0x10 || 0x4 ||
 +
|-
 +
| 0x14 || 0x4 ||
 +
|-
 +
| 0x18 || 0x4 ||
 +
|-
 +
| 0x1C || 0x4 || Number of wowl wakeups where the cause is unrecognized.
 +
|}
 +
 +
= SleepStats =
 +
This is a 0x38-byte struct.
 +
 +
During RequestWakeUp when handling [[#Cmd19|wowl]], this data in state is updated by adding each field with the corresponding field from iovar "sleep_stats_get".
 +
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset
 +
! Size
 +
! Description
 +
|-
 +
| 0x0 || 0x4 ||
 +
|-
 +
| 0x4 || 0x4 ||
 +
|-
 +
| 0x8 || 0x4 ||
 +
|-
 +
| 0xC || 0x4 ||
 +
|-
 +
| 0x10 || 0x4 ||
 +
|-
 +
| 0x14 || 0x4 ||
 +
|-
 +
| 0x18 || 0x4 ||
 +
|-
 +
| 0x1C || 0x4 ||
 +
|-
 +
| 0x20 || 0x4 ||
 +
|-
 +
| 0x24 || 0x4 ||
 +
|-
 +
| 0x28 || 0x4 ||
 +
|-
 +
| 0x2C || 0x4 ||
 +
|-
 +
| 0x30 || 0x4 ||
 +
|-
 +
| 0x34 || 0x4 ||
 +
|}
    
= FwVersion =
 
= FwVersion =
Line 842: Line 1,030:  
* [6.0.0+] Besides the version update, added "clm_4356a3_ntd" to the string.
 
* [6.0.0+] Besides the version update, added "clm_4356a3_ntd" to the string.
 
* [7.0.0+] Besides the version update, added "noclminc" to the string.
 
* [7.0.0+] Besides the version update, added "noclminc" to the string.
 +
 +
= Notes =
 +
Originally wlan-sysmodule had a func called from nnMain which (among other things) handled configuring [[Bus_services|GPIO]] WifiReset (uses commands SetDirection and SetValue with input value 1), when not disabled by a system-setting. This GPIO functionality was removed from wlan with [7.0.0+], it was redundant since [[PCIe_services|pcie]] already had code handling that GPIO as well.
    
[[Category:Services]]
 
[[Category:Services]]
Retrieved from "https://switchbrew.org/wiki/Special:MobileDiff/11724...11754"

Navigation menu