1 /* SPDX-License-Identifier: Apache-2.0 */
3 * WFx hardware interface definitions
5 * Copyright (c) 2018-2019, Silicon Laboratories Inc.
8 #ifndef WFX_HIF_API_CMD_H
9 #define WFX_HIF_API_CMD_H
11 #include "hif_api_general.h"
15 #define HIF_API_SSID_SIZE API_SSID_SIZE
17 enum hif_requests_ids {
18 HIF_REQ_ID_RESET = 0x0a,
19 HIF_REQ_ID_READ_MIB = 0x05,
20 HIF_REQ_ID_WRITE_MIB = 0x06,
21 HIF_REQ_ID_START_SCAN = 0x07,
22 HIF_REQ_ID_STOP_SCAN = 0x08,
24 HIF_REQ_ID_JOIN = 0x0b,
25 HIF_REQ_ID_SET_PM_MODE = 0x10,
26 HIF_REQ_ID_SET_BSS_PARAMS = 0x11,
27 HIF_REQ_ID_ADD_KEY = 0x0c,
28 HIF_REQ_ID_REMOVE_KEY = 0x0d,
29 HIF_REQ_ID_EDCA_QUEUE_PARAMS = 0x13,
30 HIF_REQ_ID_START = 0x17,
31 HIF_REQ_ID_BEACON_TRANSMIT = 0x18,
32 HIF_REQ_ID_UPDATE_IE = 0x1b,
33 HIF_REQ_ID_MAP_LINK = 0x1c,
36 enum hif_confirmations_ids {
37 HIF_CNF_ID_RESET = 0x0a,
38 HIF_CNF_ID_READ_MIB = 0x05,
39 HIF_CNF_ID_WRITE_MIB = 0x06,
40 HIF_CNF_ID_START_SCAN = 0x07,
41 HIF_CNF_ID_STOP_SCAN = 0x08,
43 HIF_CNF_ID_MULTI_TRANSMIT = 0x1e,
44 HIF_CNF_ID_JOIN = 0x0b,
45 HIF_CNF_ID_SET_PM_MODE = 0x10,
46 HIF_CNF_ID_SET_BSS_PARAMS = 0x11,
47 HIF_CNF_ID_ADD_KEY = 0x0c,
48 HIF_CNF_ID_REMOVE_KEY = 0x0d,
49 HIF_CNF_ID_EDCA_QUEUE_PARAMS = 0x13,
50 HIF_CNF_ID_START = 0x17,
51 HIF_CNF_ID_BEACON_TRANSMIT = 0x18,
52 HIF_CNF_ID_UPDATE_IE = 0x1b,
53 HIF_CNF_ID_MAP_LINK = 0x1c,
56 enum hif_indications_ids {
58 HIF_IND_ID_SCAN_CMPL = 0x86,
59 HIF_IND_ID_JOIN_COMPLETE = 0x8f,
60 HIF_IND_ID_SET_PM_MODE_CMPL = 0x89,
61 HIF_IND_ID_SUSPEND_RESUME_TX = 0x8c,
62 HIF_IND_ID_EVENT = 0x85
65 union hif_commands_ids {
66 enum hif_requests_ids request;
67 enum hif_confirmations_ids confirmation;
68 enum hif_indications_ids indication;
72 HIF_STATUS_SUCCESS = 0x0,
73 HIF_STATUS_FAILURE = 0x1,
74 HIF_INVALID_PARAMETER = 0x2,
75 HIF_STATUS_WARNING = 0x3,
76 HIF_ERROR_UNSUPPORTED_MSG_ID = 0x4,
77 HIF_STATUS_DECRYPTFAILURE = 0x10,
78 HIF_STATUS_MICFAILURE = 0x11,
79 HIF_STATUS_NO_KEY_FOUND = 0x12,
80 HIF_STATUS_RETRY_EXCEEDED = 0x13,
81 HIF_STATUS_TX_LIFETIME_EXCEEDED = 0x14,
83 HIF_STATUS_REFUSED = 0x16,
84 HIF_STATUS_BUSY = 0x17
87 struct hif_reset_flags {
94 struct hif_req_reset {
95 struct hif_reset_flags reset_flags;
98 struct hif_cnf_reset {
102 struct hif_req_read_mib {
107 struct hif_cnf_read_mib {
114 struct hif_req_write_mib {
120 struct hif_cnf_write_mib {
124 struct hif_ie_flags {
138 struct hif_req_update_ie {
139 struct hif_ie_flags ie_flags;
141 struct hif_ie_tlv ie[];
144 struct hif_cnf_update_ie {
148 struct hif_scan_type {
154 struct hif_scan_flags {
161 struct hif_auto_scan_param {
167 struct hif_ssid_def {
169 u8 ssid[HIF_API_SSID_SIZE];
172 #define HIF_API_MAX_NB_SSIDS 2
173 #define HIF_API_MAX_NB_CHANNELS 14
175 struct hif_req_start_scan {
177 struct hif_scan_type scan_type;
178 struct hif_scan_flags scan_flags;
179 u8 max_transmit_rate;
180 struct hif_auto_scan_param auto_scan_param;
181 u8 num_of_probe_requests;
185 u32 min_channel_time;
186 u32 max_channel_time;
188 u8 ssid_and_channel_lists[];
191 struct hif_start_scan_req_cstnbssid_body {
193 struct hif_scan_type scan_type;
194 struct hif_scan_flags scan_flags;
195 u8 max_transmit_rate;
196 struct hif_auto_scan_param auto_scan_param;
197 u8 num_of_probe_requests;
201 u32 min_channel_time;
202 u32 max_channel_time;
204 struct hif_ssid_def ssid_def[HIF_API_MAX_NB_SSIDS];
208 struct hif_cnf_start_scan {
212 struct hif_cnf_stop_scan {
216 enum hif_pm_mode_status {
217 HIF_PM_MODE_ACTIVE = 0x0,
218 HIF_PM_MODE_PS = 0x1,
219 HIF_PM_MODE_UNDETERMINED = 0x2
222 struct hif_ind_scan_cmpl {
225 u8 num_channels_completed;
230 HIF_QUEUE_ID_BACKGROUND = 0x0,
231 HIF_QUEUE_ID_BESTEFFORT = 0x1,
232 HIF_QUEUE_ID_VIDEO = 0x2,
233 HIF_QUEUE_ID_VOICE = 0x3
236 enum hif_frame_format {
237 HIF_FRAME_FORMAT_NON_HT = 0x0,
238 HIF_FRAME_FORMAT_MIXED_FORMAT_HT = 0x1,
239 HIF_FRAME_FORMAT_GF_HT_11N = 0x2
243 HIF_STBC_NOT_ALLOWED = 0x0,
244 HIF_STBC_ALLOWED = 0x1
253 struct hif_data_flags {
259 struct hif_tx_flags {
262 u8 retry_policy_index:4;
265 struct hif_ht_tx_parameters {
280 struct hif_queue queue_id;
281 struct hif_data_flags data_flags;
282 struct hif_tx_flags tx_flags;
285 struct hif_ht_tx_parameters ht_tx_parameters;
289 enum hif_qos_ackplcy {
290 HIF_QOS_ACKPLCY_NORMAL = 0x0,
291 HIF_QOS_ACKPLCY_TXNOACK = 0x1,
292 HIF_QOS_ACKPLCY_NOEXPACK = 0x2,
293 HIF_QOS_ACKPLCY_BLCKACK = 0x3
296 struct hif_tx_result_flags {
310 struct hif_tx_result_flags tx_result_flags;
315 struct hif_cnf_multi_transmit {
317 struct hif_cnf_tx tx_conf_payload[];
320 enum hif_ri_flags_encrypt {
321 HIF_RI_FLAGS_UNENCRYPTED = 0x0,
322 HIF_RI_FLAGS_WEP_ENCRYPTED = 0x1,
323 HIF_RI_FLAGS_TKIP_ENCRYPTED = 0x2,
324 HIF_RI_FLAGS_AES_ENCRYPTED = 0x3,
325 HIF_RI_FLAGS_WAPI_ENCRYPTED = 0x4
328 struct hif_rx_flags {
359 struct hif_rx_flags rx_flags;
364 struct hif_req_edca_queue_params {
372 u16 allowed_medium_time;
376 struct hif_cnf_edca_queue_params {
386 HIF_PREAMBLE_LONG = 0x0,
387 HIF_PREAMBLE_SHORT = 0x1,
388 HIF_PREAMBLE_SHORT_LONG12 = 0x2
391 struct hif_join_flags {
393 u8 force_no_beacon:1;
398 struct hif_req_join {
407 struct hif_join_flags join_flags;
409 u8 ssid[HIF_API_SSID_SIZE];
414 struct hif_cnf_join {
418 struct hif_ind_join_complete {
422 struct hif_bss_flags {
423 u8 lost_count_only:1;
427 struct hif_req_set_bss_params {
428 struct hif_bss_flags bss_flags;
429 u8 beacon_lost_count;
431 u32 operational_rate_set;
434 struct hif_cnf_set_bss_params {
444 struct hif_req_set_pm_mode {
445 struct hif_pm_mode pm_mode;
446 u8 fast_psm_idle_period;
447 u8 ap_psm_change_period;
448 u8 min_auto_ps_poll_period;
451 struct hif_cnf_set_pm_mode {
455 struct hif_ind_set_pm_mode_cmpl {
462 struct hif_req_start {
472 u8 ssid[HIF_API_SSID_SIZE];
476 struct hif_cnf_start {
481 HIF_BEACON_STOP = 0x0,
482 HIF_BEACON_START = 0x1
485 struct hif_req_beacon_transmit {
490 struct hif_cnf_beacon_transmit {
494 enum hif_sta_map_direction {
499 struct hif_map_link_flags {
505 struct hif_req_map_link {
506 u8 mac_addr[ETH_ALEN];
507 struct hif_map_link_flags map_link_flags;
511 struct hif_cnf_map_link {
515 struct hif_suspend_resume_flags {
523 struct hif_ind_suspend_resume_tx {
524 struct hif_suspend_resume_flags suspend_resume_flags;
529 #define MAX_KEY_ENTRIES 24
530 #define HIF_API_WEP_KEY_DATA_SIZE 16
531 #define HIF_API_TKIP_KEY_DATA_SIZE 16
532 #define HIF_API_RX_MIC_KEY_SIZE 8
533 #define HIF_API_TX_MIC_KEY_SIZE 8
534 #define HIF_API_AES_KEY_DATA_SIZE 16
535 #define HIF_API_WAPI_KEY_DATA_SIZE 16
536 #define HIF_API_MIC_KEY_DATA_SIZE 16
537 #define HIF_API_IGTK_KEY_DATA_SIZE 16
538 #define HIF_API_RX_SEQUENCE_COUNTER_SIZE 8
539 #define HIF_API_IPN_SIZE 8
542 HIF_KEY_TYPE_WEP_DEFAULT = 0x0,
543 HIF_KEY_TYPE_WEP_PAIRWISE = 0x1,
544 HIF_KEY_TYPE_TKIP_GROUP = 0x2,
545 HIF_KEY_TYPE_TKIP_PAIRWISE = 0x3,
546 HIF_KEY_TYPE_AES_GROUP = 0x4,
547 HIF_KEY_TYPE_AES_PAIRWISE = 0x5,
548 HIF_KEY_TYPE_WAPI_GROUP = 0x6,
549 HIF_KEY_TYPE_WAPI_PAIRWISE = 0x7,
550 HIF_KEY_TYPE_IGTK_GROUP = 0x8,
551 HIF_KEY_TYPE_NONE = 0x9
554 struct hif_wep_pairwise_key {
555 u8 peer_address[ETH_ALEN];
558 u8 key_data[HIF_API_WEP_KEY_DATA_SIZE];
561 struct hif_wep_group_key {
565 u8 key_data[HIF_API_WEP_KEY_DATA_SIZE];
568 struct hif_tkip_pairwise_key {
569 u8 peer_address[ETH_ALEN];
571 u8 tkip_key_data[HIF_API_TKIP_KEY_DATA_SIZE];
572 u8 rx_mic_key[HIF_API_RX_MIC_KEY_SIZE];
573 u8 tx_mic_key[HIF_API_TX_MIC_KEY_SIZE];
576 struct hif_tkip_group_key {
577 u8 tkip_key_data[HIF_API_TKIP_KEY_DATA_SIZE];
578 u8 rx_mic_key[HIF_API_RX_MIC_KEY_SIZE];
581 u8 rx_sequence_counter[HIF_API_RX_SEQUENCE_COUNTER_SIZE];
584 struct hif_aes_pairwise_key {
585 u8 peer_address[ETH_ALEN];
587 u8 aes_key_data[HIF_API_AES_KEY_DATA_SIZE];
590 struct hif_aes_group_key {
591 u8 aes_key_data[HIF_API_AES_KEY_DATA_SIZE];
594 u8 rx_sequence_counter[HIF_API_RX_SEQUENCE_COUNTER_SIZE];
597 struct hif_wapi_pairwise_key {
598 u8 peer_address[ETH_ALEN];
601 u8 wapi_key_data[HIF_API_WAPI_KEY_DATA_SIZE];
602 u8 mic_key_data[HIF_API_MIC_KEY_DATA_SIZE];
605 struct hif_wapi_group_key {
606 u8 wapi_key_data[HIF_API_WAPI_KEY_DATA_SIZE];
607 u8 mic_key_data[HIF_API_MIC_KEY_DATA_SIZE];
612 struct hif_igtk_group_key {
613 u8 igtk_key_data[HIF_API_IGTK_KEY_DATA_SIZE];
616 u8 ipn[HIF_API_IPN_SIZE];
619 union hif_privacy_key_data {
620 struct hif_wep_pairwise_key wep_pairwise_key;
621 struct hif_wep_group_key wep_group_key;
622 struct hif_tkip_pairwise_key tkip_pairwise_key;
623 struct hif_tkip_group_key tkip_group_key;
624 struct hif_aes_pairwise_key aes_pairwise_key;
625 struct hif_aes_group_key aes_group_key;
626 struct hif_wapi_pairwise_key wapi_pairwise_key;
627 struct hif_wapi_group_key wapi_group_key;
628 struct hif_igtk_group_key igtk_group_key;
631 struct hif_req_add_key {
637 union hif_privacy_key_data key;
640 struct hif_cnf_add_key {
644 struct hif_req_remove_key {
649 struct hif_cnf_remove_key {
654 HIF_EVENT_IND_BSSLOST = 0x1,
655 HIF_EVENT_IND_BSSREGAINED = 0x2,
656 HIF_EVENT_IND_RCPI_RSSI = 0x3,
657 HIF_EVENT_IND_PS_MODE_ERROR = 0x4,
658 HIF_EVENT_IND_INACTIVITY = 0x5
661 enum hif_ps_mode_error {
662 HIF_PS_ERROR_NO_ERROR = 0,
663 HIF_PS_ERROR_AP_NOT_RESP_TO_POLL = 1,
664 HIF_PS_ERROR_AP_NOT_RESP_TO_UAPSD_TRIGGER = 2,
665 HIF_PS_ERROR_AP_SENT_UNICAST_IN_DOZE = 3,
666 HIF_PS_ERROR_AP_NO_DATA_AFTER_TIM = 4
669 union hif_event_data {
675 struct hif_ind_event {
677 union hif_event_data event_data;