Merge 5.5-rc7 into staging-next
[linux-2.6-microblaze.git] / drivers / staging / wfx / hif_api_cmd.h
1 /* SPDX-License-Identifier: Apache-2.0 */
2 /*
3  * WFx hardware interface definitions
4  *
5  * Copyright (c) 2018-2019, Silicon Laboratories Inc.
6  */
7
8 #ifndef WFX_HIF_API_CMD_H
9 #define WFX_HIF_API_CMD_H
10
11 #include "hif_api_general.h"
12
13 #define HIF_NUM_AC                             4
14
15 #define HIF_API_SSID_SIZE                      API_SSID_SIZE
16
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,
23         HIF_REQ_ID_TX                                = 0x04,
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,
34 };
35
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,
42         HIF_CNF_ID_TX                                = 0x04,
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,
54 };
55
56 enum hif_indications_ids {
57         HIF_IND_ID_RX                                = 0x84,
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
63 };
64
65 union hif_commands_ids {
66         enum hif_requests_ids request;
67         enum hif_confirmations_ids confirmation;
68         enum hif_indications_ids indication;
69 };
70
71 enum hif_status {
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,
82         HIF_REQUEUE                                = 0x15,
83         HIF_STATUS_REFUSED                         = 0x16,
84         HIF_STATUS_BUSY                            = 0x17
85 };
86
87 struct hif_reset_flags {
88         u8    reset_stat:1;
89         u8    reset_all_int:1;
90         u8    reserved1:6;
91         u8    reserved2[3];
92 } __packed;
93
94 struct hif_req_reset {
95         struct hif_reset_flags reset_flags;
96 } __packed;
97
98 struct hif_cnf_reset {
99         u32   status;
100 } __packed;
101
102 struct hif_req_read_mib {
103         u16   mib_id;
104         u16   reserved;
105 } __packed;
106
107 struct hif_cnf_read_mib {
108         u32   status;
109         u16   mib_id;
110         u16   length;
111         u8    mib_data[];
112 } __packed;
113
114 struct hif_req_write_mib {
115         u16   mib_id;
116         u16   length;
117         u8    mib_data[];
118 } __packed;
119
120 struct hif_cnf_write_mib {
121         u32   status;
122 } __packed;
123
124 struct hif_ie_flags {
125         u8    beacon:1;
126         u8    probe_resp:1;
127         u8    probe_req:1;
128         u8    reserved1:5;
129         u8    reserved2;
130 } __packed;
131
132 struct hif_ie_tlv {
133         u8    type;
134         u8    length;
135         u8    data[];
136 } __packed;
137
138 struct hif_req_update_ie {
139         struct hif_ie_flags ie_flags;
140         u16   num_ies;
141         struct hif_ie_tlv ie[];
142 } __packed;
143
144 struct hif_cnf_update_ie {
145         u32   status;
146 } __packed;
147
148 struct hif_scan_type {
149         u8    type:1;
150         u8    mode:1;
151         u8    reserved:6;
152 } __packed;
153
154 struct hif_scan_flags {
155         u8    fbg:1;
156         u8    reserved1:1;
157         u8    pre:1;
158         u8    reserved2:5;
159 } __packed;
160
161 struct hif_auto_scan_param {
162         u16   interval;
163         u8    reserved;
164         s8     rssi_thr;
165 } __packed;
166
167 struct hif_ssid_def {
168         u32   ssid_length;
169         u8    ssid[HIF_API_SSID_SIZE];
170 } __packed;
171
172 #define HIF_API_MAX_NB_SSIDS                           2
173 #define HIF_API_MAX_NB_CHANNELS                       14
174
175 struct hif_req_start_scan {
176         u8    band;
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;
182         u8    probe_delay;
183         u8    num_of_ssids;
184         u8    num_of_channels;
185         u32   min_channel_time;
186         u32   max_channel_time;
187         s32    tx_power_level;
188         u8    ssid_and_channel_lists[];
189 } __packed;
190
191 struct hif_req_start_scan_alt {
192         u8    band;
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;
198         u8    probe_delay;
199         u8    num_of_ssids;
200         u8    num_of_channels;
201         u32   min_channel_time;
202         u32   max_channel_time;
203         s32    tx_power_level;
204         struct hif_ssid_def ssid_def[HIF_API_MAX_NB_SSIDS];
205         u8    channel_list[];
206 } __packed;
207
208 struct hif_cnf_start_scan {
209         u32   status;
210 } __packed;
211
212 struct hif_cnf_stop_scan {
213         u32   status;
214 } __packed;
215
216 enum hif_pm_mode_status {
217         HIF_PM_MODE_ACTIVE                         = 0x0,
218         HIF_PM_MODE_PS                             = 0x1,
219         HIF_PM_MODE_UNDETERMINED                   = 0x2
220 };
221
222 struct hif_ind_scan_cmpl {
223         u32   status;
224         u8    pm_mode;
225         u8    num_channels_completed;
226         u16   reserved;
227 } __packed;
228
229 enum hif_queue_id {
230         HIF_QUEUE_ID_BACKGROUND                    = 0x0,
231         HIF_QUEUE_ID_BESTEFFORT                    = 0x1,
232         HIF_QUEUE_ID_VIDEO                         = 0x2,
233         HIF_QUEUE_ID_VOICE                         = 0x3
234 };
235
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
240 };
241
242 enum hif_stbc {
243         HIF_STBC_NOT_ALLOWED                       = 0x0,
244         HIF_STBC_ALLOWED                           = 0x1
245 };
246
247 struct hif_queue {
248         u8    queue_id:2;
249         u8    peer_sta_id:4;
250         u8    reserved:2;
251 } __packed;
252
253 struct hif_data_flags {
254         u8    more:1;
255         u8    fc_offset:3;
256         u8    after_dtim:1;
257         u8    reserved:3;
258 } __packed;
259
260 struct hif_tx_flags {
261         u8    start_exp:1;
262         u8    reserved:3;
263         u8    retry_policy_index:4;
264 } __packed;
265
266 struct hif_ht_tx_parameters {
267         u8    frame_format:4;
268         u8    fec_coding:1;
269         u8    short_gi:1;
270         u8    reserved1:1;
271         u8    stbc:1;
272         u8    reserved2;
273         u8    aggregation:1;
274         u8    reserved3:7;
275         u8    reserved4;
276 } __packed;
277
278 struct hif_req_tx {
279         u32   packet_id;
280         u8    max_tx_rate;
281         struct hif_queue queue_id;
282         struct hif_data_flags data_flags;
283         struct hif_tx_flags tx_flags;
284         u32   reserved;
285         u32   expire_time;
286         struct hif_ht_tx_parameters ht_tx_parameters;
287         u8    frame[];
288 } __packed;
289
290 enum hif_qos_ackplcy {
291         HIF_QOS_ACKPLCY_NORMAL                         = 0x0,
292         HIF_QOS_ACKPLCY_TXNOACK                        = 0x1,
293         HIF_QOS_ACKPLCY_NOEXPACK                       = 0x2,
294         HIF_QOS_ACKPLCY_BLCKACK                        = 0x3
295 };
296
297 struct hif_tx_result_flags {
298         u8    aggr:1;
299         u8    requeue:1;
300         u8    ack_policy:2;
301         u8    txop_limit:1;
302         u8    reserved1:3;
303         u8    reserved2;
304 } __packed;
305
306 struct hif_cnf_tx {
307         u32   status;
308         u32   packet_id;
309         u8    txed_rate;
310         u8    ack_failures;
311         struct hif_tx_result_flags tx_result_flags;
312         u32   media_delay;
313         u32   tx_queue_delay;
314 } __packed;
315
316 struct hif_cnf_multi_transmit {
317         u32   num_tx_confs;
318         struct hif_cnf_tx   tx_conf_payload[];
319 } __packed;
320
321 enum hif_ri_flags_encrypt {
322         HIF_RI_FLAGS_UNENCRYPTED                   = 0x0,
323         HIF_RI_FLAGS_WEP_ENCRYPTED                 = 0x1,
324         HIF_RI_FLAGS_TKIP_ENCRYPTED                = 0x2,
325         HIF_RI_FLAGS_AES_ENCRYPTED                 = 0x3,
326         HIF_RI_FLAGS_WAPI_ENCRYPTED                = 0x4
327 };
328
329 struct hif_rx_flags {
330         u8    encryp:3;
331         u8    in_aggr:1;
332         u8    first_aggr:1;
333         u8    last_aggr:1;
334         u8    defrag:1;
335         u8    beacon:1;
336         u8    tim:1;
337         u8    bitmap:1;
338         u8    match_ssid:1;
339         u8    match_bssid:1;
340         u8    more:1;
341         u8    reserved1:1;
342         u8    ht:1;
343         u8    stbc:1;
344         u8    match_uc_addr:1;
345         u8    match_mc_addr:1;
346         u8    match_bc_addr:1;
347         u8    key_type:1;
348         u8    key_index:4;
349         u8    reserved2:1;
350         u8    peer_sta_id:4;
351         u8    reserved3:2;
352         u8    reserved4:1;
353 } __packed;
354
355 struct hif_ind_rx {
356         u32   status;
357         u16   channel_number;
358         u8    rxed_rate;
359         u8    rcpi_rssi;
360         struct hif_rx_flags rx_flags;
361         u8    frame[];
362 } __packed;
363
364
365 struct hif_req_edca_queue_params {
366         u8    queue_id;
367         u8    reserved1;
368         u8    aifsn;
369         u8    reserved2;
370         u16   cw_min;
371         u16   cw_max;
372         u16   tx_op_limit;
373         u16   allowed_medium_time;
374         u32   reserved3;
375 } __packed;
376
377 struct hif_cnf_edca_queue_params {
378         u32   status;
379 } __packed;
380
381 struct hif_join_flags {
382         u8    reserved1:2;
383         u8    force_no_beacon:1;
384         u8    force_with_ind:1;
385         u8    reserved2:4;
386 } __packed;
387
388 struct hif_req_join {
389         u8    infrastructure_bss_mode:1;
390         u8    reserved1:7;
391         u8    band;
392         u16   channel_number;
393         u8    bssid[ETH_ALEN];
394         u16   atim_window;
395         u8    short_preamble:1;
396         u8    reserved2:7;
397         u8    probe_for_join;
398         u8    reserved3;
399         struct hif_join_flags join_flags;
400         u32   ssid_length;
401         u8    ssid[HIF_API_SSID_SIZE];
402         u32   beacon_interval;
403         u32   basic_rate_set;
404 } __packed;
405
406 struct hif_cnf_join {
407         u32   status;
408 } __packed;
409
410 struct hif_ind_join_complete {
411         u32   status;
412 } __packed;
413
414 struct hif_bss_flags {
415         u8    lost_count_only:1;
416         u8    reserved:7;
417 } __packed;
418
419 struct hif_req_set_bss_params {
420         struct hif_bss_flags bss_flags;
421         u8    beacon_lost_count;
422         u16   aid;
423         u32   operational_rate_set;
424 } __packed;
425
426 struct hif_cnf_set_bss_params {
427         u32   status;
428 } __packed;
429
430 struct hif_pm_mode {
431         u8    enter_psm:1;
432         u8    reserved:6;
433         u8    fast_psm:1;
434 } __packed;
435
436 struct hif_req_set_pm_mode {
437         struct hif_pm_mode pm_mode;
438         u8    fast_psm_idle_period;
439         u8    ap_psm_change_period;
440         u8    min_auto_ps_poll_period;
441 } __packed;
442
443 struct hif_cnf_set_pm_mode {
444         u32   status;
445 } __packed;
446
447 struct hif_ind_set_pm_mode_cmpl {
448         u32   status;
449         u8    pm_mode;
450         u8    reserved[3];
451 } __packed;
452
453
454 struct hif_req_start {
455         u8    mode;
456         u8    band;
457         u16   channel_number;
458         u32   reserved1;
459         u32   beacon_interval;
460         u8    dtim_period;
461         u8    short_preamble:1;
462         u8    reserved2:7;
463         u8    reserved3;
464         u8    ssid_length;
465         u8    ssid[HIF_API_SSID_SIZE];
466         u32   basic_rate_set;
467 } __packed;
468
469 struct hif_cnf_start {
470         u32   status;
471 } __packed;
472
473 enum hif_beacon {
474         HIF_BEACON_STOP                       = 0x0,
475         HIF_BEACON_START                      = 0x1
476 };
477
478 struct hif_req_beacon_transmit {
479         u8    enable_beaconing;
480         u8    reserved[3];
481 } __packed;
482
483 struct hif_cnf_beacon_transmit {
484         u32   status;
485 } __packed;
486
487 enum hif_sta_map_direction {
488         HIF_STA_MAP                       = 0x0,
489         HIF_STA_UNMAP                     = 0x1
490 };
491
492 struct hif_map_link_flags {
493         u8    map_direction:1;
494         u8    mfpc:1;
495         u8    reserved:6;
496 } __packed;
497
498 struct hif_req_map_link {
499         u8    mac_addr[ETH_ALEN];
500         struct hif_map_link_flags map_link_flags;
501         u8    peer_sta_id;
502 } __packed;
503
504 struct hif_cnf_map_link {
505         u32   status;
506 } __packed;
507
508 struct hif_suspend_resume_flags {
509         u8    resume:1;
510         u8    reserved1:2;
511         u8    bc_mc_only:1;
512         u8    reserved2:4;
513         u8    reserved3;
514 } __packed;
515
516 struct hif_ind_suspend_resume_tx {
517         struct hif_suspend_resume_flags suspend_resume_flags;
518         u16   peer_sta_set;
519 } __packed;
520
521
522 #define MAX_KEY_ENTRIES         24
523 #define HIF_API_WEP_KEY_DATA_SIZE                       16
524 #define HIF_API_TKIP_KEY_DATA_SIZE                      16
525 #define HIF_API_RX_MIC_KEY_SIZE                         8
526 #define HIF_API_TX_MIC_KEY_SIZE                         8
527 #define HIF_API_AES_KEY_DATA_SIZE                       16
528 #define HIF_API_WAPI_KEY_DATA_SIZE                      16
529 #define HIF_API_MIC_KEY_DATA_SIZE                       16
530 #define HIF_API_IGTK_KEY_DATA_SIZE                      16
531 #define HIF_API_RX_SEQUENCE_COUNTER_SIZE                8
532 #define HIF_API_IPN_SIZE                                8
533
534 enum hif_key_type {
535         HIF_KEY_TYPE_WEP_DEFAULT                   = 0x0,
536         HIF_KEY_TYPE_WEP_PAIRWISE                  = 0x1,
537         HIF_KEY_TYPE_TKIP_GROUP                    = 0x2,
538         HIF_KEY_TYPE_TKIP_PAIRWISE                 = 0x3,
539         HIF_KEY_TYPE_AES_GROUP                     = 0x4,
540         HIF_KEY_TYPE_AES_PAIRWISE                  = 0x5,
541         HIF_KEY_TYPE_WAPI_GROUP                    = 0x6,
542         HIF_KEY_TYPE_WAPI_PAIRWISE                 = 0x7,
543         HIF_KEY_TYPE_IGTK_GROUP                    = 0x8,
544         HIF_KEY_TYPE_NONE                          = 0x9
545 };
546
547 struct hif_wep_pairwise_key {
548         u8    peer_address[ETH_ALEN];
549         u8    reserved;
550         u8    key_length;
551         u8    key_data[HIF_API_WEP_KEY_DATA_SIZE];
552 } __packed;
553
554 struct hif_wep_group_key {
555         u8    key_id;
556         u8    key_length;
557         u8    reserved[2];
558         u8    key_data[HIF_API_WEP_KEY_DATA_SIZE];
559 } __packed;
560
561 struct hif_tkip_pairwise_key {
562         u8    peer_address[ETH_ALEN];
563         u8    reserved[2];
564         u8    tkip_key_data[HIF_API_TKIP_KEY_DATA_SIZE];
565         u8    rx_mic_key[HIF_API_RX_MIC_KEY_SIZE];
566         u8    tx_mic_key[HIF_API_TX_MIC_KEY_SIZE];
567 } __packed;
568
569 struct hif_tkip_group_key {
570         u8    tkip_key_data[HIF_API_TKIP_KEY_DATA_SIZE];
571         u8    rx_mic_key[HIF_API_RX_MIC_KEY_SIZE];
572         u8    key_id;
573         u8    reserved[3];
574         u8    rx_sequence_counter[HIF_API_RX_SEQUENCE_COUNTER_SIZE];
575 } __packed;
576
577 struct hif_aes_pairwise_key {
578         u8    peer_address[ETH_ALEN];
579         u8    reserved[2];
580         u8    aes_key_data[HIF_API_AES_KEY_DATA_SIZE];
581 } __packed;
582
583 struct hif_aes_group_key {
584         u8    aes_key_data[HIF_API_AES_KEY_DATA_SIZE];
585         u8    key_id;
586         u8    reserved[3];
587         u8    rx_sequence_counter[HIF_API_RX_SEQUENCE_COUNTER_SIZE];
588 } __packed;
589
590 struct hif_wapi_pairwise_key {
591         u8    peer_address[ETH_ALEN];
592         u8    key_id;
593         u8    reserved;
594         u8    wapi_key_data[HIF_API_WAPI_KEY_DATA_SIZE];
595         u8    mic_key_data[HIF_API_MIC_KEY_DATA_SIZE];
596 } __packed;
597
598 struct hif_wapi_group_key {
599         u8    wapi_key_data[HIF_API_WAPI_KEY_DATA_SIZE];
600         u8    mic_key_data[HIF_API_MIC_KEY_DATA_SIZE];
601         u8    key_id;
602         u8    reserved[3];
603 } __packed;
604
605 struct hif_igtk_group_key {
606         u8    igtk_key_data[HIF_API_IGTK_KEY_DATA_SIZE];
607         u8    key_id;
608         u8    reserved[3];
609         u8    ipn[HIF_API_IPN_SIZE];
610 } __packed;
611
612 union hif_privacy_key_data {
613         struct hif_wep_pairwise_key                       wep_pairwise_key;
614         struct hif_wep_group_key                          wep_group_key;
615         struct hif_tkip_pairwise_key                      tkip_pairwise_key;
616         struct hif_tkip_group_key                         tkip_group_key;
617         struct hif_aes_pairwise_key                       aes_pairwise_key;
618         struct hif_aes_group_key                          aes_group_key;
619         struct hif_wapi_pairwise_key                      wapi_pairwise_key;
620         struct hif_wapi_group_key                         wapi_group_key;
621         struct hif_igtk_group_key                         igtk_group_key;
622 };
623
624 struct hif_req_add_key {
625         u8    type;
626         u8    entry_index;
627         u8    int_id:2;
628         u8    reserved1:6;
629         u8    reserved2;
630         union hif_privacy_key_data key;
631 } __packed;
632
633 struct hif_cnf_add_key {
634         u32   status;
635 } __packed;
636
637 struct hif_req_remove_key {
638         u8    entry_index;
639         u8    reserved[3];
640 } __packed;
641
642 struct hif_cnf_remove_key {
643         u32   status;
644 } __packed;
645
646 enum hif_event_ind {
647         HIF_EVENT_IND_BSSLOST                      = 0x1,
648         HIF_EVENT_IND_BSSREGAINED                  = 0x2,
649         HIF_EVENT_IND_RCPI_RSSI                    = 0x3,
650         HIF_EVENT_IND_PS_MODE_ERROR                = 0x4,
651         HIF_EVENT_IND_INACTIVITY                   = 0x5
652 };
653
654 enum hif_ps_mode_error {
655         HIF_PS_ERROR_NO_ERROR                      = 0,
656         HIF_PS_ERROR_AP_NOT_RESP_TO_POLL           = 1,
657         HIF_PS_ERROR_AP_NOT_RESP_TO_UAPSD_TRIGGER  = 2,
658         HIF_PS_ERROR_AP_SENT_UNICAST_IN_DOZE       = 3,
659         HIF_PS_ERROR_AP_NO_DATA_AFTER_TIM          = 4
660 };
661
662 union hif_event_data {
663         u8    rcpi_rssi;
664         u32   ps_mode_error;
665         u32   peer_sta_set;
666 };
667
668 struct hif_ind_event {
669         u32   event_id;
670         union hif_event_data event_data;
671 } __packed;
672
673
674 #endif