Zephyr API Documentation 4.0.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
wifi_twt_params Struct Reference

Wi-Fi TWT parameters. More...

#include <wifi_mgmt.h>

Data Fields

enum wifi_twt_operation operation
 TWT operation, see enum wifi_twt_operation.
 
enum wifi_twt_negotiation_type negotiation_type
 TWT negotiation type, see enum wifi_twt_negotiation_type.
 
enum wifi_twt_setup_cmd setup_cmd
 TWT setup command, see enum wifi_twt_setup_cmd.
 
enum wifi_twt_setup_resp_status resp_status
 TWT setup response status, see enum wifi_twt_setup_resp_status.
 
enum wifi_twt_teardown_status teardown_status
 TWT teardown cmd status, see enum wifi_twt_teardown_status.
 
uint8_t dialog_token
 Dialog token, used to map requests to responses.
 
uint8_t flow_id
 Flow ID, used to map setup with teardown.
 
union { 
 
   struct { 
 
      uint64_t   twt_interval 
 Interval = Wake up time + Sleeping time. More...
 
      bool   responder 
 Requestor or responder. More...
 
      bool   trigger 
 Trigger enabled or disabled. More...
 
      bool   implicit 
 Implicit or explicit. More...
 
      bool   announce 
 Announced or unannounced. More...
 
      uint32_t   twt_wake_interval 
 Wake up time. More...
 
      uint32_t   twt_wake_ahead_duration 
 Wake ahead notification is sent earlier than TWT Service period (SP) start based on this duration. More...
 
      bool   twt_info_disable 
 TWT info enabled or disable. More...
 
      uint8_t   twt_exponent 
 TWT exponent. More...
 
      uint16_t   twt_mantissa 
 TWT Mantissa Range: [0-sizeof(UINT16)]. More...
 
   }   setup 
 Setup specific parameters. More...
 
   struct { 
 
      uint16_t   sub_id 
 Broadcast TWT AP config. More...
 
      uint8_t   nominal_wake 
 Range 64-255. More...
 
      uint8_t   max_sta_support 
 Max STA support. More...
 
      uint16_t   twt_mantissa 
 TWT mantissa. More...
 
      uint16_t   twt_offset 
 TWT offset. More...
 
      uint8_t   twt_exponent 
 TWT exponent. More...
 
      uint8_t   sp_gap 
 SP gap. More...
 
   }   btwt 
 Setup specific parameters. More...
 
   struct { 
 
      bool   teardown_all 
 Teardown all flows. More...
 
   }   teardown 
 Teardown specific parameters. More...
 
};  
 
enum wifi_twt_fail_reason fail_reason
 TWT fail reason, see enum wifi_twt_fail_reason.
 

Detailed Description

Wi-Fi TWT parameters.

Field Documentation

◆ [union]

union { ... } wifi_twt_params

◆ announce

bool wifi_twt_params::announce

Announced or unannounced.

◆ [struct]

struct { ... } wifi_twt_params::btwt

Setup specific parameters.

◆ dialog_token

uint8_t wifi_twt_params::dialog_token

Dialog token, used to map requests to responses.

◆ fail_reason

enum wifi_twt_fail_reason wifi_twt_params::fail_reason

TWT fail reason, see enum wifi_twt_fail_reason.

◆ flow_id

uint8_t wifi_twt_params::flow_id

Flow ID, used to map setup with teardown.

◆ implicit

bool wifi_twt_params::implicit

Implicit or explicit.

◆ max_sta_support

uint8_t wifi_twt_params::max_sta_support

Max STA support.

◆ negotiation_type

enum wifi_twt_negotiation_type wifi_twt_params::negotiation_type

TWT negotiation type, see enum wifi_twt_negotiation_type.

◆ nominal_wake

uint8_t wifi_twt_params::nominal_wake

Range 64-255.

◆ operation

enum wifi_twt_operation wifi_twt_params::operation

TWT operation, see enum wifi_twt_operation.

◆ resp_status

enum wifi_twt_setup_resp_status wifi_twt_params::resp_status

TWT setup response status, see enum wifi_twt_setup_resp_status.

◆ responder

bool wifi_twt_params::responder

Requestor or responder.

◆ [struct]

struct { ... } wifi_twt_params::setup

Setup specific parameters.

◆ setup_cmd

enum wifi_twt_setup_cmd wifi_twt_params::setup_cmd

TWT setup command, see enum wifi_twt_setup_cmd.

◆ sp_gap

uint8_t wifi_twt_params::sp_gap

SP gap.

◆ sub_id

uint16_t wifi_twt_params::sub_id

Broadcast TWT AP config.

◆ [struct]

struct { ... } wifi_twt_params::teardown

Teardown specific parameters.

◆ teardown_all

bool wifi_twt_params::teardown_all

Teardown all flows.

◆ teardown_status

enum wifi_twt_teardown_status wifi_twt_params::teardown_status

TWT teardown cmd status, see enum wifi_twt_teardown_status.

◆ trigger

bool wifi_twt_params::trigger

Trigger enabled or disabled.

◆ twt_exponent

uint8_t wifi_twt_params::twt_exponent

TWT exponent.

◆ twt_info_disable

bool wifi_twt_params::twt_info_disable

TWT info enabled or disable.

◆ twt_interval

uint64_t wifi_twt_params::twt_interval

Interval = Wake up time + Sleeping time.

◆ twt_mantissa

uint16_t wifi_twt_params::twt_mantissa

TWT Mantissa Range: [0-sizeof(UINT16)].

TWT mantissa.

◆ twt_offset

uint16_t wifi_twt_params::twt_offset

TWT offset.

◆ twt_wake_ahead_duration

uint32_t wifi_twt_params::twt_wake_ahead_duration

Wake ahead notification is sent earlier than TWT Service period (SP) start based on this duration.

This should give applications ample time to prepare the data before TWT SP starts.

◆ twt_wake_interval

uint32_t wifi_twt_params::twt_wake_interval

Wake up time.


The documentation for this struct was generated from the following file: