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_req_read_mib {
103 struct hif_cnf_read_mib {
110 struct hif_req_write_mib {
116 struct hif_cnf_write_mib {
120 struct hif_ie_flags {
134 struct hif_req_update_ie {
135 struct hif_ie_flags ie_flags;
137 struct hif_ie_tlv ie[];
140 struct hif_cnf_update_ie {
144 struct hif_scan_type {
150 struct hif_scan_flags {
157 struct hif_auto_scan_param {
163 struct hif_ssid_def {
165 u8 ssid[HIF_API_SSID_SIZE];
168 #define HIF_API_MAX_NB_SSIDS 2
169 #define HIF_API_MAX_NB_CHANNELS 14
171 struct hif_req_start_scan {
173 struct hif_scan_type scan_type;
174 struct hif_scan_flags scan_flags;
175 u8 max_transmit_rate;
176 struct hif_auto_scan_param auto_scan_param;
177 u8 num_of_probe_requests;
181 u32 min_channel_time;
182 u32 max_channel_time;
184 u8 ssid_and_channel_lists[];
187 struct hif_req_start_scan_alt {
189 struct hif_scan_type scan_type;
190 struct hif_scan_flags scan_flags;
191 u8 max_transmit_rate;
192 struct hif_auto_scan_param auto_scan_param;
193 u8 num_of_probe_requests;
197 u32 min_channel_time;
198 u32 max_channel_time;
200 struct hif_ssid_def ssid_def[HIF_API_MAX_NB_SSIDS];
204 struct hif_cnf_start_scan {
208 struct hif_cnf_stop_scan {
212 enum hif_pm_mode_status {
213 HIF_PM_MODE_ACTIVE = 0x0,
214 HIF_PM_MODE_PS = 0x1,
215 HIF_PM_MODE_UNDETERMINED = 0x2
218 struct hif_ind_scan_cmpl {
221 u8 num_channels_completed;
226 HIF_QUEUE_ID_BACKGROUND = 0x0,
227 HIF_QUEUE_ID_BESTEFFORT = 0x1,
228 HIF_QUEUE_ID_VIDEO = 0x2,
229 HIF_QUEUE_ID_VOICE = 0x3
232 enum hif_frame_format {
233 HIF_FRAME_FORMAT_NON_HT = 0x0,
234 HIF_FRAME_FORMAT_MIXED_FORMAT_HT = 0x1,
235 HIF_FRAME_FORMAT_GF_HT_11N = 0x2
239 HIF_STBC_NOT_ALLOWED = 0x0,
240 HIF_STBC_ALLOWED = 0x1
249 struct hif_data_flags {
256 struct hif_tx_flags {
259 u8 retry_policy_index:4;
262 struct hif_ht_tx_parameters {
277 struct hif_queue queue_id;
278 struct hif_data_flags data_flags;
279 struct hif_tx_flags tx_flags;
282 struct hif_ht_tx_parameters ht_tx_parameters;
286 enum hif_qos_ackplcy {
287 HIF_QOS_ACKPLCY_NORMAL = 0x0,
288 HIF_QOS_ACKPLCY_TXNOACK = 0x1,
289 HIF_QOS_ACKPLCY_NOEXPACK = 0x2,
290 HIF_QOS_ACKPLCY_BLCKACK = 0x3
293 struct hif_tx_result_flags {
307 struct hif_tx_result_flags tx_result_flags;
312 struct hif_cnf_multi_transmit {
314 struct hif_cnf_tx tx_conf_payload[];
317 enum hif_ri_flags_encrypt {
318 HIF_RI_FLAGS_UNENCRYPTED = 0x0,
319 HIF_RI_FLAGS_WEP_ENCRYPTED = 0x1,
320 HIF_RI_FLAGS_TKIP_ENCRYPTED = 0x2,
321 HIF_RI_FLAGS_AES_ENCRYPTED = 0x3,
322 HIF_RI_FLAGS_WAPI_ENCRYPTED = 0x4
325 struct hif_rx_flags {
356 struct hif_rx_flags rx_flags;
361 struct hif_req_edca_queue_params {
369 u16 allowed_medium_time;
373 struct hif_cnf_edca_queue_params {
377 struct hif_join_flags {
379 u8 force_no_beacon:1;
384 struct hif_req_join {
385 u8 infrastructure_bss_mode:1;
395 struct hif_join_flags join_flags;
397 u8 ssid[HIF_API_SSID_SIZE];
402 struct hif_cnf_join {
406 struct hif_ind_join_complete {
410 struct hif_bss_flags {
411 u8 lost_count_only:1;
415 struct hif_req_set_bss_params {
416 struct hif_bss_flags bss_flags;
417 u8 beacon_lost_count;
419 u32 operational_rate_set;
422 struct hif_cnf_set_bss_params {
432 struct hif_req_set_pm_mode {
433 struct hif_pm_mode pm_mode;
434 u8 fast_psm_idle_period;
435 u8 ap_psm_change_period;
436 u8 min_auto_ps_poll_period;
439 struct hif_cnf_set_pm_mode {
443 struct hif_ind_set_pm_mode_cmpl {
450 struct hif_req_start {
461 u8 ssid[HIF_API_SSID_SIZE];
465 struct hif_cnf_start {
470 HIF_BEACON_STOP = 0x0,
471 HIF_BEACON_START = 0x1
474 struct hif_req_beacon_transmit {
479 struct hif_cnf_beacon_transmit {
483 enum hif_sta_map_direction {
488 struct hif_map_link_flags {
494 struct hif_req_map_link {
495 u8 mac_addr[ETH_ALEN];
496 struct hif_map_link_flags map_link_flags;
500 struct hif_cnf_map_link {
504 struct hif_suspend_resume_flags {
512 struct hif_ind_suspend_resume_tx {
513 struct hif_suspend_resume_flags suspend_resume_flags;
518 #define MAX_KEY_ENTRIES 24
519 #define HIF_API_WEP_KEY_DATA_SIZE 16
520 #define HIF_API_TKIP_KEY_DATA_SIZE 16
521 #define HIF_API_RX_MIC_KEY_SIZE 8
522 #define HIF_API_TX_MIC_KEY_SIZE 8
523 #define HIF_API_AES_KEY_DATA_SIZE 16
524 #define HIF_API_WAPI_KEY_DATA_SIZE 16
525 #define HIF_API_MIC_KEY_DATA_SIZE 16
526 #define HIF_API_IGTK_KEY_DATA_SIZE 16
527 #define HIF_API_RX_SEQUENCE_COUNTER_SIZE 8
528 #define HIF_API_IPN_SIZE 8
531 HIF_KEY_TYPE_WEP_DEFAULT = 0x0,
532 HIF_KEY_TYPE_WEP_PAIRWISE = 0x1,
533 HIF_KEY_TYPE_TKIP_GROUP = 0x2,
534 HIF_KEY_TYPE_TKIP_PAIRWISE = 0x3,
535 HIF_KEY_TYPE_AES_GROUP = 0x4,
536 HIF_KEY_TYPE_AES_PAIRWISE = 0x5,
537 HIF_KEY_TYPE_WAPI_GROUP = 0x6,
538 HIF_KEY_TYPE_WAPI_PAIRWISE = 0x7,
539 HIF_KEY_TYPE_IGTK_GROUP = 0x8,
540 HIF_KEY_TYPE_NONE = 0x9
543 struct hif_wep_pairwise_key {
544 u8 peer_address[ETH_ALEN];
547 u8 key_data[HIF_API_WEP_KEY_DATA_SIZE];
550 struct hif_wep_group_key {
554 u8 key_data[HIF_API_WEP_KEY_DATA_SIZE];
557 struct hif_tkip_pairwise_key {
558 u8 peer_address[ETH_ALEN];
560 u8 tkip_key_data[HIF_API_TKIP_KEY_DATA_SIZE];
561 u8 rx_mic_key[HIF_API_RX_MIC_KEY_SIZE];
562 u8 tx_mic_key[HIF_API_TX_MIC_KEY_SIZE];
565 struct hif_tkip_group_key {
566 u8 tkip_key_data[HIF_API_TKIP_KEY_DATA_SIZE];
567 u8 rx_mic_key[HIF_API_RX_MIC_KEY_SIZE];
570 u8 rx_sequence_counter[HIF_API_RX_SEQUENCE_COUNTER_SIZE];
573 struct hif_aes_pairwise_key {
574 u8 peer_address[ETH_ALEN];
576 u8 aes_key_data[HIF_API_AES_KEY_DATA_SIZE];
579 struct hif_aes_group_key {
580 u8 aes_key_data[HIF_API_AES_KEY_DATA_SIZE];
583 u8 rx_sequence_counter[HIF_API_RX_SEQUENCE_COUNTER_SIZE];
586 struct hif_wapi_pairwise_key {
587 u8 peer_address[ETH_ALEN];
590 u8 wapi_key_data[HIF_API_WAPI_KEY_DATA_SIZE];
591 u8 mic_key_data[HIF_API_MIC_KEY_DATA_SIZE];
594 struct hif_wapi_group_key {
595 u8 wapi_key_data[HIF_API_WAPI_KEY_DATA_SIZE];
596 u8 mic_key_data[HIF_API_MIC_KEY_DATA_SIZE];
601 struct hif_igtk_group_key {
602 u8 igtk_key_data[HIF_API_IGTK_KEY_DATA_SIZE];
605 u8 ipn[HIF_API_IPN_SIZE];
608 union hif_privacy_key_data {
609 struct hif_wep_pairwise_key wep_pairwise_key;
610 struct hif_wep_group_key wep_group_key;
611 struct hif_tkip_pairwise_key tkip_pairwise_key;
612 struct hif_tkip_group_key tkip_group_key;
613 struct hif_aes_pairwise_key aes_pairwise_key;
614 struct hif_aes_group_key aes_group_key;
615 struct hif_wapi_pairwise_key wapi_pairwise_key;
616 struct hif_wapi_group_key wapi_group_key;
617 struct hif_igtk_group_key igtk_group_key;
620 struct hif_req_add_key {
626 union hif_privacy_key_data key;
629 struct hif_cnf_add_key {
633 struct hif_req_remove_key {
638 struct hif_cnf_remove_key {
643 HIF_EVENT_IND_BSSLOST = 0x1,
644 HIF_EVENT_IND_BSSREGAINED = 0x2,
645 HIF_EVENT_IND_RCPI_RSSI = 0x3,
646 HIF_EVENT_IND_PS_MODE_ERROR = 0x4,
647 HIF_EVENT_IND_INACTIVITY = 0x5
650 enum hif_ps_mode_error {
651 HIF_PS_ERROR_NO_ERROR = 0,
652 HIF_PS_ERROR_AP_NOT_RESP_TO_POLL = 1,
653 HIF_PS_ERROR_AP_NOT_RESP_TO_UAPSD_TRIGGER = 2,
654 HIF_PS_ERROR_AP_SENT_UNICAST_IN_DOZE = 3,
655 HIF_PS_ERROR_AP_NO_DATA_AFTER_TIM = 4
658 union hif_event_data {
664 struct hif_ind_event {
666 union hif_event_data event_data;