 |
Morse Micro IoT SDK
2.9.7
|
|
Morse Micro IoT SDK
2.9.7
|
Data Structures | |
| struct | mmwlan_version |
| Structure for retrieving version information from the mmwlan subsystem. More... | |
| struct | mmwlan_bcf_metadata |
| Board configuration file (BCF) metadata. More... | |
| struct | mmwlan_scan_config |
| Scan configuration data structure. More... | |
| struct | mmwlan_twt_config_args |
| Structure for storing Target Wake Time (TWT) configuration arguments. More... | |
| struct | mmwlan_qos_queue_params |
| Structure for storing QoS queue parameters More... | |
| struct | mmwlan_boot_args |
| Arguments data structure for mmwlan_boot(). More... | |
| struct | mmwlan_scan_result |
| Result of the scan request. More... | |
| struct | mmwlan_sta_event_cb_args |
| Argument passed to the STA event callback. More... | |
| struct | mmwlan_sta_args |
| Arguments data structure for mmwlan_sta_enable(). More... | |
| struct | mmwlan_dpp_cb_args |
| Structure passed back when a DPP event occurs. More... | |
| struct | mmwlan_dpp_args |
| Structure to hold the arguments used for the DPP process. More... | |
| struct | mmwlan_scan_args |
| Structure to hold scan arguments. More... | |
| struct | mmwlan_scan_req |
| Structure to hold arguments specific to a given instance of a scan. More... | |
| struct | mmwlan_softap_sta_status |
| Data structure for communicating STA status information for stations connected to a Soft AP. More... | |
| struct | mmwlan_softap_args |
| Arguments data structure for mmwlan_softap_enable(). More... | |
Typedefs | |
| typedef void(* | mmwlan_scan_rx_cb_t) (const struct mmwlan_scan_result *result, void *arg) |
| mmwlan scan rx callback function prototype. More... | |
| typedef void(* | mmwlan_sta_status_cb_t) (enum mmwlan_sta_state sta_state) |
| STA status callback function prototype. More... | |
| typedef void(* | mmwlan_sta_event_cb_t) (const struct mmwlan_sta_event_cb_args *sta_event, void *arg) |
| STA event callback prototype. More... | |
| typedef void(* | mmwlan_scan_complete_cb_t) (enum mmwlan_scan_state scan_state, void *arg) |
| mmwlan scan complete callback function prototype. More... | |
| typedef void(* | mmwlan_softap_sta_status_cb_t) (const struct mmwlan_softap_sta_status *sta_status, void *arg) |
| Type definition for callback to be invoked on change in status of a connected STA. More... | |
Functions | |
| enum mmwlan_status | mmwlan_get_version (struct mmwlan_version *version) |
| Retrieve version information from morselib and the connected Morse transceiver. More... | |
| enum mmwlan_status | mmwlan_get_bcf_metadata (struct mmwlan_bcf_metadata *metadata) |
| Read the metadata from the board configuration file (BCF)r. More... | |
| enum mmwlan_status | mmwlan_override_max_tx_power (uint16_t tx_power_dbm) |
| Override the maximum TX power. More... | |
| enum mmwlan_status | mmwlan_set_rts_threshold (unsigned rts_threshold) |
| Set the RTS threshold. More... | |
| enum mmwlan_status | mmwlan_set_sgi_enabled (bool sgi_enabled) |
| Sets whether or not Short Guard Interval (SGI) support is enabled. More... | |
| enum mmwlan_status | mmwlan_set_subbands_enabled (bool subbands_enabled) |
| Sets whether or not sub-band support is enabled for transmit. More... | |
| enum mmwlan_status | mmwlan_set_power_save_mode (enum mmwlan_ps_mode mode) |
| Sets whether or not the 802.11 power save is enabled. More... | |
| enum mmwlan_status | mmwlan_set_ampdu_enabled (bool ampdu_enabled) |
| Sets whether or not Aggregated MAC Protocol Data Unit (A-MPDU) support is enabled. More... | |
| enum mmwlan_status | mmwlan_set_fragment_threshold (unsigned fragment_threshold) |
| Set the Fragmentation threshold. More... | |
| enum mmwlan_status | mmwlan_set_scan_config (const struct mmwlan_scan_config *config) |
| Update the scan configuration with the given settings. More... | |
| enum mmwlan_status | mmwlan_twt_add_configuration (const struct mmwlan_twt_config_args *twt_config_args) |
| Add configurations for Target Wake Time (TWT). More... | |
| enum mmwlan_status | mmwlan_set_default_qos_queue_params (const struct mmwlan_qos_queue_params *params, size_t count) |
| Updates the default QoS queue configuration to the given values. More... | |
| enum mmwlan_status | mmwlan_set_mcs10_mode (enum mmwlan_mcs10_mode mcs10_mode) |
| Configure the rate adaptation behavior around selecting MCS10. More... | |
| enum mmwlan_status | mmwlan_set_duty_cycle_mode (enum mmwlan_duty_cycle_mode duty_cycle_mode) |
| Configure the duty cycle behavior for air time distribution. More... | |
| enum mmwlan_status | mmwlan_get_duty_cycle_stats (struct mmwlan_duty_cycle_stats *stats) |
| Retrieve the transmit duty cycle configuration and statistics. More... | |
| enum mmwlan_status | mmwlan_boot (const struct mmwlan_boot_args *args) |
| Boot the Morse Micro transceiver and leave it in an idle state. More... | |
| enum mmwlan_status | mmwlan_shutdown (void) |
| Perform a clean shutdown of the Morse Micro transceiver, including cleanly disconnecting from a connected AP, if necessary. More... | |
| enum mmwlan_status | mmwlan_sta_enable (const struct mmwlan_sta_args *args, mmwlan_sta_status_cb_t sta_status_cb) |
| Enable station mode. More... | |
| enum mmwlan_status | mmwlan_sta_disable (void) |
| Disable station mode. More... | |
| enum mmwlan_status | mmwlan_dpp_start (const struct mmwlan_dpp_args *args) |
| Function to start the Device Provisioning Protocol (DPP) process. More... | |
| enum mmwlan_status | mmwlan_dpp_stop (void) |
| Function to stop the DPP process. More... | |
| enum mmwlan_sta_state | mmwlan_get_sta_state (void) |
| Gets the current WLAN STA state. More... | |
| enum mmwlan_status | mmwlan_scan_request (const struct mmwlan_scan_req *scan_req) |
| Request a scan. More... | |
| enum mmwlan_status | mmwlan_scan_abort (void) |
| Abort in progress or pending scans. More... | |
| enum mmwlan_status | mmwlan_softap_enable (const struct mmwlan_softap_args *args) |
| Enable Soft AP mode. More... | |
| enum mmwlan_status | mmwlan_softap_disable (void) |
| Disable Soft AP mode. More... | |
| enum mmwlan_status | mmwlan_get_mac_addr (uint8_t *mac_addr) |
| Gets the MAC address of this device. More... | |
| uint16_t | mmwlan_get_aid (void) |
| Gets the station's AID. More... | |
| enum mmwlan_status | mmwlan_get_bssid (uint8_t *bssid) |
| Gets the BSSID of the AP to which the STA is associated. More... | |
| int32_t | mmwlan_get_rssi (void) |
| Gets the RSSI measured from the AP. More... | |
| enum mmwlan_status | mmwlan_set_listen_interval (uint16_t interval) |
| Sets the listen interval to be indicated in the association response frame. More... | |
| #define MMWLAN_BCF_BOARD_DESC_MAXLEN (31) |
| #define MMWLAN_BCF_BUILD_VERSION_MAXLEN (31) |
| #define MMWLAN_BOOT_ARGS_INIT { 0 } |
| #define MMWLAN_CHIP_ID_STRING_MAXLEN (32) |
| #define MMWLAN_FW_VERSION_MAXLEN (32) |
| #define MMWLAN_MINIMUM_FRAGMENT_THRESHOLD (256) |
Minimum value of fragmentation threshold that can be set with mmwlan_set_fragment_threshold().
| #define MMWLAN_MORSELIB_VERSION_MAXLEN (32) |
| #define MMWLAN_QOS_QUEUE_NUM_ACIS 4 |
The total number of mmwlan_qos_queue_params that exist.
| #define MMWLAN_SCAN_ARGS_INIT { MMWLAN_SCAN_DEFAULT_DWELL_TIME_MS, NULL, 0, { 0 }, 0, MMWLAN_SCAN_DEFAULT_DWELL_ON_HOME_MS } |
Initializer for mmwlan_scan_args.
For example:
| #define MMWLAN_SCAN_CONFIG_INIT { MMWLAN_SCAN_DEFAULT_DWELL_TIME_MS, false, MMWLAN_SCAN_DEFAULT_DWELL_ON_HOME_MS } |
Initializer for mmwlan_scan_config.
| #define MMWLAN_SCAN_DEFAULT_DWELL_ON_HOME_MS (200) |
| #define MMWLAN_SCAN_DEFAULT_DWELL_TIME_MS (30) |
Default value for mmwlan_scan_args.dwell_time_ms.
Note that reducing the dwell time below this value may impact scan reliability.
| #define MMWLAN_SCAN_MIN_DWELL_TIME_MS (15) |
Minimum value for mmwlan_scan_args.dwell_time_ms.
| #define MMWLAN_SCAN_REQ_INIT { NULL, NULL, NULL, MMWLAN_SCAN_ARGS_INIT } |
Initializer for mmwlan_scan_req.
For example:
| #define MMWLAN_SOFTAP_ARGS_INIT |
Initializer for mmwlan_softap_args.
| #define MMWLAN_STA_ARGS_INIT |
Initializer for mmwlan_sta_args.
| #define MMWLAN_TWT_CONFIG_ARGS_INIT |
Initializer for mmwlan_twt_config_args.
For example:
| typedef void(* mmwlan_scan_complete_cb_t) (enum mmwlan_scan_state scan_state, void *arg) |
| typedef void(* mmwlan_scan_rx_cb_t) (const struct mmwlan_scan_result *result, void *arg) |
| typedef void(* mmwlan_softap_sta_status_cb_t) (const struct mmwlan_softap_sta_status *sta_status, void *arg) |
Type definition for callback to be invoked on change in status of a connected STA.
| sta_status | The STA status information. |
| arg | Opaque argument that was provided when the callback was registered. |
| typedef void(* mmwlan_sta_event_cb_t) (const struct mmwlan_sta_event_cb_args *sta_event, void *arg) |
| typedef void(* mmwlan_sta_status_cb_t) (enum mmwlan_sta_state sta_state) |
| enum mmwlan_dpp_event |
| enum mmwlan_dpp_pb_result |
Enumeration of results for MMWLAN_DPP_EVT_PB_RESULT.
| enum mmwlan_mcs10_mode |
| enum mmwlan_scan_state |
Enumeration of states in Scan mode.
| enum mmwlan_sta_event |
Enumeration of STA events.
| enum mmwlan_sta_state |
| enum mmwlan_station_type |
| enum mmwlan_status mmwlan_boot | ( | const struct mmwlan_boot_args * | args | ) |
Boot the Morse Micro transceiver and leave it in an idle state.
| args | Boot arguments. May be NULL, in which case default values will be used. |
| enum mmwlan_status mmwlan_dpp_start | ( | const struct mmwlan_dpp_args * | args | ) |
Function to start the Device Provisioning Protocol (DPP) process.
This will return once DPP has successfully started. Feedback will be provided via the dpp_event_cb.
mmwlan_dpp_stop() MUST be called before mmwlan_shutdown() is called.| args | Reference to the dpp arguments to use. |
MMWLAN_SUCCESS on success, else an appropriate error code.| enum mmwlan_status mmwlan_dpp_stop | ( | void | ) |
Function to stop the DPP process.
MMWLAN_SUCCESS on success, else an appropriate error code.| uint16_t mmwlan_get_aid | ( | void | ) |
Gets the station's AID.
| enum mmwlan_status mmwlan_get_bcf_metadata | ( | struct mmwlan_bcf_metadata * | metadata | ) |
Read the metadata from the board configuration file (BCF)r.
| metadata | Pointer to a metadata data structure to be filled out on success. |
MMWLAN_SUCCESS on success else an error code. | enum mmwlan_status mmwlan_get_bssid | ( | uint8_t * | bssid | ) |
Gets the BSSID of the AP to which the STA is associated.
| bssid | Buffer to receive the BSSID. Length must be MMWLAN_MAC_ADDR_LEN. Will be set to 00:00:00:00:00:00 if the station is not currently associated. |
| enum mmwlan_status mmwlan_get_duty_cycle_stats | ( | struct mmwlan_duty_cycle_stats * | stats | ) |
Retrieve the transmit duty cycle configuration and statistics.
| stats | Pointer to a duty cycle statistics structure. |
| enum mmwlan_status mmwlan_get_mac_addr | ( | uint8_t * | mac_addr | ) |
Gets the MAC address of this device.
The MAC address address comes from one of the following sources, in descending priority order:
mmhal_read_mac_addr() 02:01:XX:XX:XX:XXmmhal_read_mac_addr()) then the transceiver must have been booted at least once before this function is invoked.| mac_addr | Buffer to receive the MAC address. Length must be MMWLAN_MAC_ADDR_LEN. |
| int32_t mmwlan_get_rssi | ( | void | ) |
Gets the RSSI measured from the AP.
When power save is enabled, this will only be updated when traffic is received from the AP.
| enum mmwlan_sta_state mmwlan_get_sta_state | ( | void | ) |
Gets the current WLAN STA state.
| enum mmwlan_status mmwlan_get_version | ( | struct mmwlan_version * | version | ) |
Retrieve version information from morselib and the connected Morse transceiver.
| version | The data structure to fill out with version information. |
fw_version field of version will be set to a zero length string.MMWLAN_SUCCESS on success else an error code. | enum mmwlan_status mmwlan_override_max_tx_power | ( | uint16_t | tx_power_dbm | ) |
Override the maximum TX power.
If no override is specified then the maximum TX power used will be the maximum TX power allowed for the channel in the current regulatory domain.
| tx_power_dbm | The maximum TX power override to set (in dBm). Set to zero to disable the override. |
| enum mmwlan_status mmwlan_scan_abort | ( | void | ) |
Abort in progress or pending scans.
The scan callback will be called back with result code MMWLAN_SCAN_TERMINATED for all aborted scans.
| enum mmwlan_status mmwlan_scan_request | ( | const struct mmwlan_scan_req * | scan_req | ) |
Request a scan.
If the transceiver is not already powered on, it will be powered on before the scan is initiated. The power on procedure will block this function. The transceiver will remain powered on after scan completion and must be shutdown by invoking mmwlan_shutdown().
| scan_req | Scan request instance. See mmwlan_scan_req. |
| enum mmwlan_status mmwlan_set_ampdu_enabled | ( | bool | ampdu_enabled | ) |
Sets whether or not Aggregated MAC Protocol Data Unit (A-MPDU) support is enabled.
This defaults to enabled, if not set otherwise.
| ampdu_enabled | Boolean value indicating whether AMPDU support should be enabled. |
| enum mmwlan_status mmwlan_set_default_qos_queue_params | ( | const struct mmwlan_qos_queue_params * | params, |
| size_t | count | ||
| ) |
Updates the default QoS queue configuration to the given values.
These values will be made active while the station is connecting to an Access Point.
| params | Array of QoS queue parameters. This array does not need to be sorted in Access Category Index (ACI) order, since the ACI is specified as part of the mmwlan_qos_queue_params structure. The same ACI must not be specified more than once in this array. If a parameter for a given ACI is not included in this list then its configuration will be left unchanged. |
| count | The number of elements in the params array. Must be at least 1 and no more than MMWLAN_QOS_QUEUE_NUM_ACIS. |
| enum mmwlan_status mmwlan_set_duty_cycle_mode | ( | enum mmwlan_duty_cycle_mode | duty_cycle_mode | ) |
Configure the duty cycle behavior for air time distribution.
| duty_cycle_mode | Sets the duty cycle mode. See mmwlan_duty_cycle_mode for what each mode means. |
| enum mmwlan_status mmwlan_set_fragment_threshold | ( | unsigned | fragment_threshold | ) |
Set the Fragmentation threshold.
Maximum length of the frame, beyond which packets must be fragmented into two or more frames.
| fragment_threshold | The fragmentation threshold (in octets) to set, or zero to disable the fragmentation threshold. Minimum value (if not zero) is given by MMWLAN_MINIMUM_FRAGMENT_THRESHOLD. |
| enum mmwlan_status mmwlan_set_listen_interval | ( | uint16_t | interval | ) |
Sets the listen interval to be indicated in the association response frame.
This informs the AP how often the STA will wake up. The AP uses the listen interval in determining the lifetime of frames that it buffers for a STA.
| [in] | interval | Interval value in beacon or short beacon units. e.g. 5 will set the listen interval to the interval between 5 beacons. 0 will disable this feature. |
MMWLAN_SUCCESS on success, else an appropriate error code. | enum mmwlan_status mmwlan_set_mcs10_mode | ( | enum mmwlan_mcs10_mode | mcs10_mode | ) |
Configure the rate adaptation behavior around selecting MCS10.
| mcs10_mode | Sets the MCS10 mode. See mmwlan_mcs10_mode for what each mode means. |
| enum mmwlan_status mmwlan_set_power_save_mode | ( | enum mmwlan_ps_mode | mode | ) |
Sets whether or not the 802.11 power save is enabled.
Defaults to MMWLAN_PS_ENABLED
| mode | enum indicating which 802.11 power save mode to use. |
| enum mmwlan_status mmwlan_set_rts_threshold | ( | unsigned | rts_threshold | ) |
Set the RTS threshold.
When packets larger than the RTS threshold are transmitted they are protected by an RTS/CTS exchange.
| rts_threshold | The RTS threshold (in octets) to set, or 0 to disable. |
| enum mmwlan_status mmwlan_set_scan_config | ( | const struct mmwlan_scan_config * | config | ) |
Update the scan configuration with the given settings.
| config | The new configuration to set. |
| enum mmwlan_status mmwlan_set_sgi_enabled | ( | bool | sgi_enabled | ) |
Sets whether or not Short Guard Interval (SGI) support is enabled.
Defaults to enabled if not set otherwise.
| sgi_enabled | Boolean value indicating whether SGI support should be enabled. |
| enum mmwlan_status mmwlan_set_subbands_enabled | ( | bool | subbands_enabled | ) |
Sets whether or not sub-band support is enabled for transmit.
Defaults to enabled if not set otherwise.
| subbands_enabled | Boolean value indicating whether sub-band support should be enabled. |
| enum mmwlan_status mmwlan_shutdown | ( | void | ) |
Perform a clean shutdown of the Morse Micro transceiver, including cleanly disconnecting from a connected AP, if necessary.
Has no effect if the transceiver is already shutdown.
| enum mmwlan_status mmwlan_softap_disable | ( | void | ) |
Disable Soft AP mode.
This will disconnect any stations from the AP. It will also shut down the transceiver if nothing else is holding it open. Note that if the transceiver was booted by mmwlan_boot() then this function will not shut down the transceiver.
| enum mmwlan_status mmwlan_softap_enable | ( | const struct mmwlan_softap_args * | args | ) |
Enable Soft AP mode.
This will power on the transceiver then start Access Point mode.
| args | Arguments (e.g., SSID, etc.). See mmwlan_softap_args. |
| enum mmwlan_status mmwlan_sta_disable | ( | void | ) |
Disable station mode.
This will disconnect from the AP. It will also shut down the transceiver if nothing else is holding it open. Note that if the transceiver was booted by mmwlan_boot() then this function will not shut down the transceiver.
| enum mmwlan_status mmwlan_sta_enable | ( | const struct mmwlan_sta_args * | args, |
| mmwlan_sta_status_cb_t | sta_status_cb | ||
| ) |
Enable station mode.
This will power on the transceiver then initiate connection to the given Access Point. If station mode is already enabled when this function is invoked then it will disconnect from (if already connected) and initiate connection to the given AP.
sta_status_cb) must not block and MMWLAN API functions may not be invoked from the callback. args->extra_assoc_ies buffer will be made if args->extra_assoc_ies_len is non-zero. Caller is responsible for freeing the buffer in args after this function is called.sta_status_cb parameter should not be used. Please use mmwlan_sta_args.ext_sta_status_cb as the preferred callback method.| args | STA arguments (e.g., SSID, etc.). See mmwlan_sta_args. |
| sta_status_cb | Optional callback to be invoked on STA state changes. May be NULL. Must be NULL if args->ext_sta_status_cb is not NULL. |
| enum mmwlan_status mmwlan_twt_add_configuration | ( | const struct mmwlan_twt_config_args * | twt_config_args | ) |
Add configurations for Target Wake Time (TWT).
| twt_config_args | TWT configuration arguments mmwlan_twt_config_args. |