Morse Micro IoT SDK  2.11.2

Detailed Description

Functions

static enum mmagic_status mmagic_controller_get_wlan_country_code (struct mmagic_controller *controller, struct struct_country_code *var)
 Gets country_code setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_country_code (struct mmagic_controller *controller, struct struct_country_code *var)
 Sets country_code setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_ssid (struct mmagic_controller *controller, struct string32 *var)
 Gets ssid setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_ssid (struct mmagic_controller *controller, const char *var)
 Sets ssid setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_password (struct mmagic_controller *controller, struct string100 *var)
 Gets password setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_password (struct mmagic_controller *controller, const char *var)
 Sets password setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_security (struct mmagic_controller *controller, enum mmagic_security_type *var)
 Gets security setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_security (struct mmagic_controller *controller, enum mmagic_security_type var)
 Sets security setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_raw_priority (struct mmagic_controller *controller, int16_t *var)
 Gets raw_priority setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_raw_priority (struct mmagic_controller *controller, int16_t var)
 Sets raw_priority setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_bssid (struct mmagic_controller *controller, struct struct_mac_addr *var)
 Gets bssid setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_bssid (struct mmagic_controller *controller, struct struct_mac_addr *var)
 Sets bssid setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_pmf_mode (struct mmagic_controller *controller, enum mmagic_pmf_mode *var)
 Gets pmf_mode setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_pmf_mode (struct mmagic_controller *controller, enum mmagic_pmf_mode var)
 Sets pmf_mode setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_station_type (struct mmagic_controller *controller, enum mmagic_station_type *var)
 Gets station_type setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_station_type (struct mmagic_controller *controller, enum mmagic_station_type var)
 Sets station_type setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_rts_threshold (struct mmagic_controller *controller, uint32_t *var)
 Gets rts_threshold setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_rts_threshold (struct mmagic_controller *controller, uint32_t var)
 Sets rts_threshold setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_sgi_enabled (struct mmagic_controller *controller, bool *var)
 Gets sgi_enabled setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_sgi_enabled (struct mmagic_controller *controller, bool var)
 Sets sgi_enabled setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_subbands_enabled (struct mmagic_controller *controller, bool *var)
 Gets subbands_enabled setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_subbands_enabled (struct mmagic_controller *controller, bool var)
 Sets subbands_enabled setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_ampdu_enabled (struct mmagic_controller *controller, bool *var)
 Gets ampdu_enabled setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_ampdu_enabled (struct mmagic_controller *controller, bool var)
 Sets ampdu_enabled setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_power_save_mode (struct mmagic_controller *controller, enum mmagic_power_save_mode *var)
 Gets power_save_mode setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_power_save_mode (struct mmagic_controller *controller, enum mmagic_power_save_mode var)
 Sets power_save_mode setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_fragment_threshold (struct mmagic_controller *controller, uint32_t *var)
 Gets fragment_threshold setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_fragment_threshold (struct mmagic_controller *controller, uint32_t var)
 Sets fragment_threshold setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_cac_enabled (struct mmagic_controller *controller, bool *var)
 Gets cac_enabled setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_cac_enabled (struct mmagic_controller *controller, bool var)
 Sets cac_enabled setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_min_health_check_intvl_ms (struct mmagic_controller *controller, uint32_t *var)
 Gets min_health_check_intvl_ms setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_min_health_check_intvl_ms (struct mmagic_controller *controller, uint32_t var)
 Sets min_health_check_intvl_ms setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_max_health_check_intvl_ms (struct mmagic_controller *controller, uint32_t *var)
 Gets max_health_check_intvl_ms setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_max_health_check_intvl_ms (struct mmagic_controller *controller, uint32_t var)
 Sets max_health_check_intvl_ms setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_ndp_probe_enabled (struct mmagic_controller *controller, bool *var)
 Gets ndp_probe_enabled setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_ndp_probe_enabled (struct mmagic_controller *controller, bool var)
 Sets ndp_probe_enabled setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_sta_scan_interval_base_s (struct mmagic_controller *controller, uint16_t *var)
 Gets sta_scan_interval_base_s setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_sta_scan_interval_base_s (struct mmagic_controller *controller, uint16_t var)
 Sets sta_scan_interval_base_s setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_sta_scan_interval_limit_s (struct mmagic_controller *controller, uint16_t *var)
 Gets sta_scan_interval_limit_s setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_sta_scan_interval_limit_s (struct mmagic_controller *controller, uint16_t var)
 Sets sta_scan_interval_limit_s setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_qos_0_params (struct mmagic_controller *controller, struct string32 *var)
 Gets qos_0_params setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_qos_0_params (struct mmagic_controller *controller, const char *var)
 Sets qos_0_params setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_qos_1_params (struct mmagic_controller *controller, struct string32 *var)
 Gets qos_1_params setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_qos_1_params (struct mmagic_controller *controller, const char *var)
 Sets qos_1_params setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_qos_2_params (struct mmagic_controller *controller, struct string32 *var)
 Gets qos_2_params setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_qos_2_params (struct mmagic_controller *controller, const char *var)
 Sets qos_2_params setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_qos_3_params (struct mmagic_controller *controller, struct string32 *var)
 Gets qos_3_params setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_qos_3_params (struct mmagic_controller *controller, const char *var)
 Sets qos_3_params setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_mcs10_mode (struct mmagic_controller *controller, enum mmagic_mcs10_mode *var)
 Gets mcs10_mode setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_mcs10_mode (struct mmagic_controller *controller, enum mmagic_mcs10_mode var)
 Sets mcs10_mode setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_sta_evt_en (struct mmagic_controller *controller, bool *var)
 Gets sta_evt_en setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_sta_evt_en (struct mmagic_controller *controller, bool var)
 Sets sta_evt_en setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_duty_cycle_mode (struct mmagic_controller *controller, enum mmagic_duty_cycle_mode *var)
 Gets duty_cycle_mode setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_duty_cycle_mode (struct mmagic_controller *controller, enum mmagic_duty_cycle_mode var)
 Sets duty_cycle_mode setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_get_wlan_connect_on_boot (struct mmagic_controller *controller, bool *var)
 Gets connect_on_boot setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_set_wlan_connect_on_boot (struct mmagic_controller *controller, bool var)
 Sets connect_on_boot setting for module wlan. More...
 
static enum mmagic_status mmagic_controller_wlan_commit_all (struct mmagic_controller *controller)
 Saves all settings from persistent store. More...
 

Function Documentation

◆ mmagic_controller_get_wlan_ampdu_enabled()

static enum mmagic_status mmagic_controller_get_wlan_ampdu_enabled ( struct mmagic_controller *  controller,
bool *  var 
)
inlinestatic

Gets ampdu_enabled setting for module wlan.

Boolean value indicating whether AMPDU support should be enabled.

Parameters
controllerReference to the controller handle.
varReference to the bool to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1919 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_bssid()

static enum mmagic_status mmagic_controller_get_wlan_bssid ( struct mmagic_controller *  controller,
struct struct_mac_addr var 
)
inlinestatic

Gets bssid setting for module wlan.

BSSID of the ap to associate to, all 0x00 for any.

Parameters
controllerReference to the controller handle.
varReference to the struct_mac_addr to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1475 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_cac_enabled()

static enum mmagic_status mmagic_controller_get_wlan_cac_enabled ( struct mmagic_controller *  controller,
bool *  var 
)
inlinestatic

Gets cac_enabled setting for module wlan.

Whether Centralized Authentication Controlled is enabled on the STA.

Parameters
controllerReference to the controller handle.
varReference to the bool to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2143 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_connect_on_boot()

static enum mmagic_status mmagic_controller_get_wlan_connect_on_boot ( struct mmagic_controller *  controller,
bool *  var 
)
inlinestatic

Gets connect_on_boot setting for module wlan.

On boot attempt to connect immediately to the AP with the current parameters rather than waiting for a connect command on wlan. Defaults to false.

Parameters
controllerReference to the controller handle.
varReference to the bool to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3206 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_country_code()

static enum mmagic_status mmagic_controller_get_wlan_country_code ( struct mmagic_controller *  controller,
struct struct_country_code var 
)
inlinestatic

Gets country_code setting for module wlan.

Two character country code used to identify the regulatory domain.

Parameters
controllerReference to the controller handle.
varReference to the struct_country_code to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1089 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_duty_cycle_mode()

static enum mmagic_status mmagic_controller_get_wlan_duty_cycle_mode ( struct mmagic_controller *  controller,
enum mmagic_duty_cycle_mode var 
)
inlinestatic

Gets duty_cycle_mode setting for module wlan.

The duty cycle air time distribution mode. The duty cycle mode can be set to spread, where the air time is spread evenly across the window; or burst, where air time is available to be consumed immediately.

Parameters
controllerReference to the controller handle.
varReference to the enum_duty_cycle_mode to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3129 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_fragment_threshold()

static enum mmagic_status mmagic_controller_get_wlan_fragment_threshold ( struct mmagic_controller *  controller,
uint32_t *  var 
)
inlinestatic

Gets fragment_threshold setting for module wlan.

Sets the 802.11 fragmentation threshold. The fragmentation threshold (in octets) to set, or 0 to disable.

Parameters
controllerReference to the controller handle.
varReference to the uint32_t to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2068 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_max_health_check_intvl_ms()

static enum mmagic_status mmagic_controller_get_wlan_max_health_check_intvl_ms ( struct mmagic_controller *  controller,
uint32_t *  var 
)
inlinestatic

Gets max_health_check_intvl_ms setting for module wlan.

The maximum interval to wait after the last health check before triggering another. If this parameter is 0 then periodic health checks will be disabled. min_interval_ms must always be less than or equal to max_interval_ms. Set this to UINT32_MAX to have the maximum unbounded. If only max_health_check_intvl_ms is specified, then min_health_check_intvl_ms is assumed to be 0.

Parameters
controllerReference to the controller handle.
varReference to the uint32_t to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2302 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_mcs10_mode()

static enum mmagic_status mmagic_controller_get_wlan_mcs10_mode ( struct mmagic_controller *  controller,
enum mmagic_mcs10_mode var 
)
inlinestatic

Gets mcs10_mode setting for module wlan.

The currently configured MCS10 behavior. This only takes effect after calling the WLAN connect command. This is an enum with 3 modes: disabled, which will never use MCS10, forced, which will always use MCS10 instead of MCS0 if the bandwidth is 1 MHz, and auto, which will use MCS10 on retries instead of MCS0 when the bandwidth is 1 MHz.

Parameters
controllerReference to the controller handle.
varReference to the enum_mcs10_mode to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2974 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_min_health_check_intvl_ms()

static enum mmagic_status mmagic_controller_get_wlan_min_health_check_intvl_ms ( struct mmagic_controller *  controller,
uint32_t *  var 
)
inlinestatic

Gets min_health_check_intvl_ms setting for module wlan.

The minimum interval to wait after the last health check before triggering another. If this parameter is 0 then health checks will always happen at the max_interval_ms value. min_interval_ms must always be less than or equal to max_interval_ms. If only min_health_check_intvl_ms is specified, then max_health_check_intvl_ms is assumed to be unbounded.

Parameters
controllerReference to the controller handle.
varReference to the uint32_t to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2221 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_ndp_probe_enabled()

static enum mmagic_status mmagic_controller_get_wlan_ndp_probe_enabled ( struct mmagic_controller *  controller,
bool *  var 
)
inlinestatic

Gets ndp_probe_enabled setting for module wlan.

Boolean value indicating whether NDP probe support should be enabled. Will only take effect after a connect or scan command is sent.

Parameters
controllerReference to the controller handle.
varReference to the bool to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2380 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_password()

static enum mmagic_status mmagic_controller_get_wlan_password ( struct mmagic_controller *  controller,
struct string100 var 
)
inlinestatic

Gets password setting for module wlan.

Password used when associating, 1-100 characters long.

Parameters
controllerReference to the controller handle.
varReference to the string100 to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1245 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_pmf_mode()

static enum mmagic_status mmagic_controller_get_wlan_pmf_mode ( struct mmagic_controller *  controller,
enum mmagic_pmf_mode var 
)
inlinestatic

Gets pmf_mode setting for module wlan.

Protected Management Frame mode to use (802.11w).

Parameters
controllerReference to the controller handle.
varReference to the enum_pmf_mode to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1549 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_power_save_mode()

static enum mmagic_status mmagic_controller_get_wlan_power_save_mode ( struct mmagic_controller *  controller,
enum mmagic_power_save_mode var 
)
inlinestatic

Gets power_save_mode setting for module wlan.

Sets the 802.11 power save mode.

Parameters
controllerReference to the controller handle.
varReference to the enum_power_save_mode to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1993 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_qos_0_params()

static enum mmagic_status mmagic_controller_get_wlan_qos_0_params ( struct mmagic_controller *  controller,
struct string32 var 
)
inlinestatic

Gets qos_0_params setting for module wlan.

The default QoS queue configuration for Access Category 0 (AC_BE) that is active while the station is connecting to an Access Point. This is a string containing the following comma separated integer values (in order): aifs,cw_min,cw_max,txop_max_us. For example: 3,15,1023,15008. More information about the individual parameters can be found in the API documentation for mmwlan_qos_queue_params.

Parameters
controllerReference to the controller handle.
varReference to the string32 to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2615 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_qos_1_params()

static enum mmagic_status mmagic_controller_get_wlan_qos_1_params ( struct mmagic_controller *  controller,
struct string32 var 
)
inlinestatic

Gets qos_1_params setting for module wlan.

The default QoS queue configuration for Access Category 1 (AC_BK) that is active while the station is connecting to an Access Point. This is a string containing the following comma separated integer values (in order): aifs,cw_min,cw_max,txop_max_us. For example: 7,15,1023,15008. More information about the individual parameters can be found in the API documentation for mmwlan_qos_queue_params.

Parameters
controllerReference to the controller handle.
varReference to the string32 to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2705 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_qos_2_params()

static enum mmagic_status mmagic_controller_get_wlan_qos_2_params ( struct mmagic_controller *  controller,
struct string32 var 
)
inlinestatic

Gets qos_2_params setting for module wlan.

The default QoS queue configuration for Access Category 2 (AC_VI) that is active while the station is connecting to an Access Point. This is a string containing the following comma separated integer values (in order): aifs,cw_min,cw_max,txop_max_us. For example: 2,7,15,15008. More information about the individual parameters can be found in the API documentation for mmwlan_qos_queue_params.

Parameters
controllerReference to the controller handle.
varReference to the string32 to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2795 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_qos_3_params()

static enum mmagic_status mmagic_controller_get_wlan_qos_3_params ( struct mmagic_controller *  controller,
struct string32 var 
)
inlinestatic

Gets qos_3_params setting for module wlan.

The default QoS queue configuration for Access Category 3 (AC_VO) that is active while the station is connecting to an Access Point. This is a string containing the following comma separated integer values (in order): aifs,cw_min,cw_max,txop_max_us. For example: 2,3,7,15008. More information about the individual parameters can be found in the API documentation for mmwlan_qos_queue_params.

Parameters
controllerReference to the controller handle.
varReference to the string32 to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2885 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_raw_priority()

static enum mmagic_status mmagic_controller_get_wlan_raw_priority ( struct mmagic_controller *  controller,
int16_t *  var 
)
inlinestatic

Gets raw_priority setting for module wlan.

Priority to request if raw is supported by the AP. Valid priorities are 0-7. -1 disables RAW.

Parameters
controllerReference to the controller handle.
varReference to the int16_t to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1401 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_rts_threshold()

static enum mmagic_status mmagic_controller_get_wlan_rts_threshold ( struct mmagic_controller *  controller,
uint32_t *  var 
)
inlinestatic

Gets rts_threshold setting for module wlan.

The RTS threshold (in octets) to set, or 0 to disable.

Parameters
controllerReference to the controller handle.
varReference to the uint32_t to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1697 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_security()

static enum mmagic_status mmagic_controller_get_wlan_security ( struct mmagic_controller *  controller,
enum mmagic_security_type var 
)
inlinestatic

Gets security setting for module wlan.

Security type to used when associating.

Parameters
controllerReference to the controller handle.
varReference to the enum_security_type to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1327 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_sgi_enabled()

static enum mmagic_status mmagic_controller_get_wlan_sgi_enabled ( struct mmagic_controller *  controller,
bool *  var 
)
inlinestatic

Gets sgi_enabled setting for module wlan.

Boolean value indicating whether SGI support should be enabled.

Parameters
controllerReference to the controller handle.
varReference to the bool to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1771 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_ssid()

static enum mmagic_status mmagic_controller_get_wlan_ssid ( struct mmagic_controller *  controller,
struct string32 var 
)
inlinestatic

Gets ssid setting for module wlan.

SSID of the AP to connect to, can be 1-32 characters long.

Parameters
controllerReference to the controller handle.
varReference to the string32 to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1163 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_sta_evt_en()

static enum mmagic_status mmagic_controller_get_wlan_sta_evt_en ( struct mmagic_controller *  controller,
bool *  var 
)
inlinestatic

Gets sta_evt_en setting for module wlan.

When set to true, STA event notifications will be provided. Setting this to false will suppress these notifications. Defaults to false.

Parameters
controllerReference to the controller handle.
varReference to the bool to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3052 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_sta_scan_interval_base_s()

static enum mmagic_status mmagic_controller_get_wlan_sta_scan_interval_base_s ( struct mmagic_controller *  controller,
uint16_t *  var 
)
inlinestatic

Gets sta_scan_interval_base_s setting for module wlan.

The base scan interval (in seconds) to use when (re)connecting. See documentation of mmwlan_sta_args.scan_interval_base_s for further details. Note that changes will only take effect on invocation of wlan-connect.

Parameters
controllerReference to the controller handle.
varReference to the uint16_t to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2457 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_sta_scan_interval_limit_s()

static enum mmagic_status mmagic_controller_get_wlan_sta_scan_interval_limit_s ( struct mmagic_controller *  controller,
uint16_t *  var 
)
inlinestatic

Gets sta_scan_interval_limit_s setting for module wlan.

The maximum interval between scan attempts when (re)connecting. See documentation of mmwlan_sta_args.scan_interval_limit_s for further details. Note that changes will only take effect on invocation of wlan-connect.

Parameters
controllerReference to the controller handle.
varReference to the uint16_t to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2535 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_station_type()

static enum mmagic_status mmagic_controller_get_wlan_station_type ( struct mmagic_controller *  controller,
enum mmagic_station_type var 
)
inlinestatic

Gets station_type setting for module wlan.

S1G non-AP STA type.

Parameters
controllerReference to the controller handle.
varReference to the enum_station_type to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1623 of file mmagic_controller.h.

◆ mmagic_controller_get_wlan_subbands_enabled()

static enum mmagic_status mmagic_controller_get_wlan_subbands_enabled ( struct mmagic_controller *  controller,
bool *  var 
)
inlinestatic

Gets subbands_enabled setting for module wlan.

Boolean value indicating whether sub-band support should be enabled.

Parameters
controllerReference to the controller handle.
varReference to the bool to place the received data in.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1845 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_ampdu_enabled()

static enum mmagic_status mmagic_controller_set_wlan_ampdu_enabled ( struct mmagic_controller *  controller,
bool  var 
)
inlinestatic

Sets ampdu_enabled setting for module wlan.

Boolean value indicating whether AMPDU support should be enabled.

Parameters
controllerReference to the controller handle.
varThe bool to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1956 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_bssid()

static enum mmagic_status mmagic_controller_set_wlan_bssid ( struct mmagic_controller *  controller,
struct struct_mac_addr var 
)
inlinestatic

Sets bssid setting for module wlan.

BSSID of the ap to associate to, all 0x00 for any.

Parameters
controllerReference to the controller handle.
varReference to the struct_mac_addr to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1512 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_cac_enabled()

static enum mmagic_status mmagic_controller_set_wlan_cac_enabled ( struct mmagic_controller *  controller,
bool  var 
)
inlinestatic

Sets cac_enabled setting for module wlan.

Whether Centralized Authentication Controlled is enabled on the STA.

Parameters
controllerReference to the controller handle.
varThe bool to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2180 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_connect_on_boot()

static enum mmagic_status mmagic_controller_set_wlan_connect_on_boot ( struct mmagic_controller *  controller,
bool  var 
)
inlinestatic

Sets connect_on_boot setting for module wlan.

On boot attempt to connect immediately to the AP with the current parameters rather than waiting for a connect command on wlan. Defaults to false.

Parameters
controllerReference to the controller handle.
varThe bool to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3244 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_country_code()

static enum mmagic_status mmagic_controller_set_wlan_country_code ( struct mmagic_controller *  controller,
struct struct_country_code var 
)
inlinestatic

Sets country_code setting for module wlan.

Two character country code used to identify the regulatory domain.

Parameters
controllerReference to the controller handle.
varReference to the struct_country_code to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1126 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_duty_cycle_mode()

static enum mmagic_status mmagic_controller_set_wlan_duty_cycle_mode ( struct mmagic_controller *  controller,
enum mmagic_duty_cycle_mode  var 
)
inlinestatic

Sets duty_cycle_mode setting for module wlan.

The duty cycle air time distribution mode. The duty cycle mode can be set to spread, where the air time is spread evenly across the window; or burst, where air time is available to be consumed immediately.

Parameters
controllerReference to the controller handle.
varThe enum_duty_cycle_mode to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3168 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_fragment_threshold()

static enum mmagic_status mmagic_controller_set_wlan_fragment_threshold ( struct mmagic_controller *  controller,
uint32_t  var 
)
inlinestatic

Sets fragment_threshold setting for module wlan.

Sets the 802.11 fragmentation threshold. The fragmentation threshold (in octets) to set, or 0 to disable.

Parameters
controllerReference to the controller handle.
varThe uint32_t to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2106 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_max_health_check_intvl_ms()

static enum mmagic_status mmagic_controller_set_wlan_max_health_check_intvl_ms ( struct mmagic_controller *  controller,
uint32_t  var 
)
inlinestatic

Sets max_health_check_intvl_ms setting for module wlan.

The maximum interval to wait after the last health check before triggering another. If this parameter is 0 then periodic health checks will be disabled. min_interval_ms must always be less than or equal to max_interval_ms. Set this to UINT32_MAX to have the maximum unbounded. If only max_health_check_intvl_ms is specified, then min_health_check_intvl_ms is assumed to be 0.

Parameters
controllerReference to the controller handle.
varThe uint32_t to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2342 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_mcs10_mode()

static enum mmagic_status mmagic_controller_set_wlan_mcs10_mode ( struct mmagic_controller *  controller,
enum mmagic_mcs10_mode  var 
)
inlinestatic

Sets mcs10_mode setting for module wlan.

The currently configured MCS10 behavior. This only takes effect after calling the WLAN connect command. This is an enum with 3 modes: disabled, which will never use MCS10, forced, which will always use MCS10 instead of MCS0 if the bandwidth is 1 MHz, and auto, which will use MCS10 on retries instead of MCS0 when the bandwidth is 1 MHz.

Parameters
controllerReference to the controller handle.
varThe enum_mcs10_mode to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3014 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_min_health_check_intvl_ms()

static enum mmagic_status mmagic_controller_set_wlan_min_health_check_intvl_ms ( struct mmagic_controller *  controller,
uint32_t  var 
)
inlinestatic

Sets min_health_check_intvl_ms setting for module wlan.

The minimum interval to wait after the last health check before triggering another. If this parameter is 0 then health checks will always happen at the max_interval_ms value. min_interval_ms must always be less than or equal to max_interval_ms. If only min_health_check_intvl_ms is specified, then max_health_check_intvl_ms is assumed to be unbounded.

Parameters
controllerReference to the controller handle.
varThe uint32_t to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2262 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_ndp_probe_enabled()

static enum mmagic_status mmagic_controller_set_wlan_ndp_probe_enabled ( struct mmagic_controller *  controller,
bool  var 
)
inlinestatic

Sets ndp_probe_enabled setting for module wlan.

Boolean value indicating whether NDP probe support should be enabled. Will only take effect after a connect or scan command is sent.

Parameters
controllerReference to the controller handle.
varThe bool to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2418 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_password()

static enum mmagic_status mmagic_controller_set_wlan_password ( struct mmagic_controller *  controller,
const char *  var 
)
inlinestatic

Sets password setting for module wlan.

Password used when associating, 1-100 characters long.

Parameters
controllerReference to the controller handle.
varThe string100 to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1282 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_pmf_mode()

static enum mmagic_status mmagic_controller_set_wlan_pmf_mode ( struct mmagic_controller *  controller,
enum mmagic_pmf_mode  var 
)
inlinestatic

Sets pmf_mode setting for module wlan.

Protected Management Frame mode to use (802.11w).

Parameters
controllerReference to the controller handle.
varThe enum_pmf_mode to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1586 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_power_save_mode()

static enum mmagic_status mmagic_controller_set_wlan_power_save_mode ( struct mmagic_controller *  controller,
enum mmagic_power_save_mode  var 
)
inlinestatic

Sets power_save_mode setting for module wlan.

Sets the 802.11 power save mode.

Parameters
controllerReference to the controller handle.
varThe enum_power_save_mode to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2030 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_qos_0_params()

static enum mmagic_status mmagic_controller_set_wlan_qos_0_params ( struct mmagic_controller *  controller,
const char *  var 
)
inlinestatic

Sets qos_0_params setting for module wlan.

The default QoS queue configuration for Access Category 0 (AC_BE) that is active while the station is connecting to an Access Point. This is a string containing the following comma separated integer values (in order): aifs,cw_min,cw_max,txop_max_us. For example: 3,15,1023,15008. More information about the individual parameters can be found in the API documentation for mmwlan_qos_queue_params.

Parameters
controllerReference to the controller handle.
varThe string32 to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2656 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_qos_1_params()

static enum mmagic_status mmagic_controller_set_wlan_qos_1_params ( struct mmagic_controller *  controller,
const char *  var 
)
inlinestatic

Sets qos_1_params setting for module wlan.

The default QoS queue configuration for Access Category 1 (AC_BK) that is active while the station is connecting to an Access Point. This is a string containing the following comma separated integer values (in order): aifs,cw_min,cw_max,txop_max_us. For example: 7,15,1023,15008. More information about the individual parameters can be found in the API documentation for mmwlan_qos_queue_params.

Parameters
controllerReference to the controller handle.
varThe string32 to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2746 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_qos_2_params()

static enum mmagic_status mmagic_controller_set_wlan_qos_2_params ( struct mmagic_controller *  controller,
const char *  var 
)
inlinestatic

Sets qos_2_params setting for module wlan.

The default QoS queue configuration for Access Category 2 (AC_VI) that is active while the station is connecting to an Access Point. This is a string containing the following comma separated integer values (in order): aifs,cw_min,cw_max,txop_max_us. For example: 2,7,15,15008. More information about the individual parameters can be found in the API documentation for mmwlan_qos_queue_params.

Parameters
controllerReference to the controller handle.
varThe string32 to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2836 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_qos_3_params()

static enum mmagic_status mmagic_controller_set_wlan_qos_3_params ( struct mmagic_controller *  controller,
const char *  var 
)
inlinestatic

Sets qos_3_params setting for module wlan.

The default QoS queue configuration for Access Category 3 (AC_VO) that is active while the station is connecting to an Access Point. This is a string containing the following comma separated integer values (in order): aifs,cw_min,cw_max,txop_max_us. For example: 2,3,7,15008. More information about the individual parameters can be found in the API documentation for mmwlan_qos_queue_params.

Parameters
controllerReference to the controller handle.
varThe string32 to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2926 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_raw_priority()

static enum mmagic_status mmagic_controller_set_wlan_raw_priority ( struct mmagic_controller *  controller,
int16_t  var 
)
inlinestatic

Sets raw_priority setting for module wlan.

Priority to request if raw is supported by the AP. Valid priorities are 0-7. -1 disables RAW.

Parameters
controllerReference to the controller handle.
varThe int16_t to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1438 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_rts_threshold()

static enum mmagic_status mmagic_controller_set_wlan_rts_threshold ( struct mmagic_controller *  controller,
uint32_t  var 
)
inlinestatic

Sets rts_threshold setting for module wlan.

The RTS threshold (in octets) to set, or 0 to disable.

Parameters
controllerReference to the controller handle.
varThe uint32_t to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1734 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_security()

static enum mmagic_status mmagic_controller_set_wlan_security ( struct mmagic_controller *  controller,
enum mmagic_security_type  var 
)
inlinestatic

Sets security setting for module wlan.

Security type to used when associating.

Parameters
controllerReference to the controller handle.
varThe enum_security_type to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1364 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_sgi_enabled()

static enum mmagic_status mmagic_controller_set_wlan_sgi_enabled ( struct mmagic_controller *  controller,
bool  var 
)
inlinestatic

Sets sgi_enabled setting for module wlan.

Boolean value indicating whether SGI support should be enabled.

Parameters
controllerReference to the controller handle.
varThe bool to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1808 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_ssid()

static enum mmagic_status mmagic_controller_set_wlan_ssid ( struct mmagic_controller *  controller,
const char *  var 
)
inlinestatic

Sets ssid setting for module wlan.

SSID of the AP to connect to, can be 1-32 characters long.

Parameters
controllerReference to the controller handle.
varThe string32 to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1200 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_sta_evt_en()

static enum mmagic_status mmagic_controller_set_wlan_sta_evt_en ( struct mmagic_controller *  controller,
bool  var 
)
inlinestatic

Sets sta_evt_en setting for module wlan.

When set to true, STA event notifications will be provided. Setting this to false will suppress these notifications. Defaults to false.

Parameters
controllerReference to the controller handle.
varThe bool to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3090 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_sta_scan_interval_base_s()

static enum mmagic_status mmagic_controller_set_wlan_sta_scan_interval_base_s ( struct mmagic_controller *  controller,
uint16_t  var 
)
inlinestatic

Sets sta_scan_interval_base_s setting for module wlan.

The base scan interval (in seconds) to use when (re)connecting. See documentation of mmwlan_sta_args.scan_interval_base_s for further details. Note that changes will only take effect on invocation of wlan-connect.

Parameters
controllerReference to the controller handle.
varThe uint16_t to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2496 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_sta_scan_interval_limit_s()

static enum mmagic_status mmagic_controller_set_wlan_sta_scan_interval_limit_s ( struct mmagic_controller *  controller,
uint16_t  var 
)
inlinestatic

Sets sta_scan_interval_limit_s setting for module wlan.

The maximum interval between scan attempts when (re)connecting. See documentation of mmwlan_sta_args.scan_interval_limit_s for further details. Note that changes will only take effect on invocation of wlan-connect.

Parameters
controllerReference to the controller handle.
varThe uint16_t to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 2574 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_station_type()

static enum mmagic_status mmagic_controller_set_wlan_station_type ( struct mmagic_controller *  controller,
enum mmagic_station_type  var 
)
inlinestatic

Sets station_type setting for module wlan.

S1G non-AP STA type.

Parameters
controllerReference to the controller handle.
varThe enum_station_type to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1660 of file mmagic_controller.h.

◆ mmagic_controller_set_wlan_subbands_enabled()

static enum mmagic_status mmagic_controller_set_wlan_subbands_enabled ( struct mmagic_controller *  controller,
bool  var 
)
inlinestatic

Sets subbands_enabled setting for module wlan.

Boolean value indicating whether sub-band support should be enabled.

Parameters
controllerReference to the controller handle.
varThe bool to write.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 1882 of file mmagic_controller.h.

◆ mmagic_controller_wlan_commit_all()

static enum mmagic_status mmagic_controller_wlan_commit_all ( struct mmagic_controller *  controller)
inlinestatic

Saves all settings from persistent store.

Parameters
controllerReference to the controller handle.
Returns
MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3278 of file mmagic_controller.h.