Merge tag 'char-misc-5.7-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh...
[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_req_read_mib {
99         u16   mib_id;
100         u16   reserved;
101 } __packed;
102
103 struct hif_cnf_read_mib {
104         u32   status;
105         u16   mib_id;
106         u16   length;
107         u8    mib_data[];
108 } __packed;
109
110 struct hif_req_write_mib {
111         u16   mib_id;
112         u16   length;
113         u8    mib_data[];
114 } __packed;
115
116 struct hif_cnf_write_mib {
117         u32   status;
118 } __packed;
119
120 struct hif_ie_flags {
121         u8    beacon:1;
122         u8    probe_resp:1;
123         u8    probe_req:1;
124         u8    reserved1:5;
125         u8    reserved2;
126 } __packed;
127
128 struct hif_ie_tlv {
129         u8    type;
130         u8    length;
131         u8    data[];
132 } __packed;
133
134 struct hif_req_update_ie {
135         struct hif_ie_flags ie_flags;
136         u16   num_ies;
137         struct hif_ie_tlv ie[];
138 } __packed;
139
140 struct hif_cnf_update_ie {
141         u32   status;
142 } __packed;
143
144 struct hif_scan_type {
145         u8    type:1;
146         u8    mode:1;
147         u8    reserved:6;
148 } __packed;
149
150 struct hif_scan_flags {
151         u8    fbg:1;
152         u8    reserved1:1;
153         u8    pre:1;
154         u8    reserved2:5;
155 } __packed;
156
157 struct hif_auto_scan_param {
158         u16   interval;
159         u8    reserved;
160         s8     rssi_thr;
161 } __packed;
162
163 struct hif_ssid_def {
164         u32   ssid_length;
165         u8    ssid[HIF_API_SSID_SIZE];
166 } __packed;
167
168 #define HIF_API_MAX_NB_SSIDS                           2
169 #define HIF_API_MAX_NB_CHANNELS                       14
170
171 struct hif_req_start_scan {
172         u8    band;
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;
178         u8    probe_delay;
179         u8    num_of_ssids;
180         u8    num_of_channels;
181         u32   min_channel_time;
182         u32   max_channel_time;
183         s32    tx_power_level;
184         u8    ssid_and_channel_lists[];
185 } __packed;
186
187 struct hif_req_start_scan_alt {
188         u8    band;
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;
194         u8    probe_delay;
195         u8    num_of_ssids;
196         u8    num_of_channels;
197         u32   min_channel_time;
198         u32   max_channel_time;
199         s32    tx_power_level;
200         struct hif_ssid_def ssid_def[HIF_API_MAX_NB_SSIDS];
201         u8    channel_list[];
202 } __packed;
203
204 struct hif_cnf_start_scan {
205         u32   status;
206 } __packed;
207
208 struct hif_cnf_stop_scan {
209         u32   status;
210 } __packed;
211
212 enum hif_pm_mode_status {
213         HIF_PM_MODE_ACTIVE                         = 0x0,
214         HIF_PM_MODE_PS                             = 0x1,
215         HIF_PM_MODE_UNDETERMINED                   = 0x2
216 };
217
218 struct hif_ind_scan_cmpl {
219         u32   status;
220         u8    pm_mode;
221         u8    num_channels_completed;
222         u16   reserved;
223 } __packed;
224
225 enum hif_queue_id {
226         HIF_QUEUE_ID_BACKGROUND                    = 0x0,
227         HIF_QUEUE_ID_BESTEFFORT                    = 0x1,
228         HIF_QUEUE_ID_VIDEO                         = 0x2,
229         HIF_QUEUE_ID_VOICE                         = 0x3
230 };
231
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
236 };
237
238 enum hif_stbc {
239         HIF_STBC_NOT_ALLOWED                       = 0x0,
240         HIF_STBC_ALLOWED                           = 0x1
241 };
242
243 struct hif_queue {
244         u8    queue_id:2;
245         u8    peer_sta_id:4;
246         u8    reserved:2;
247 } __packed;
248
249 struct hif_data_flags {
250         u8    more:1;
251         u8    fc_offset:3;
252         u8    after_dtim:1;
253         u8    reserved:3;
254 } __packed;
255
256 struct hif_tx_flags {
257         u8    start_exp:1;
258         u8    reserved:3;
259         u8    retry_policy_index:4;
260 } __packed;
261
262 struct hif_ht_tx_parameters {
263         u8    frame_format:4;
264         u8    fec_coding:1;
265         u8    short_gi:1;
266         u8    reserved1:1;
267         u8    stbc:1;
268         u8    reserved2;
269         u8    aggregation:1;
270         u8    reserved3:7;
271         u8    reserved4;
272 } __packed;
273
274 struct hif_req_tx {
275         u32   packet_id;
276         u8    max_tx_rate;
277         struct hif_queue queue_id;
278         struct hif_data_flags data_flags;
279         struct hif_tx_flags tx_flags;
280         u32   reserved;
281         u32   expire_time;
282         struct hif_ht_tx_parameters ht_tx_parameters;
283         u8    frame[];
284 } __packed;
285
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
291 };
292
293 struct hif_tx_result_flags {
294         u8    aggr:1;
295         u8    requeue:1;
296         u8    ack_policy:2;
297         u8    txop_limit:1;
298         u8    reserved1:3;
299         u8    reserved2;
300 } __packed;
301
302 struct hif_cnf_tx {
303         u32   status;
304         u32   packet_id;
305         u8    txed_rate;
306         u8    ack_failures;
307         struct hif_tx_result_flags tx_result_flags;
308         u32   media_delay;
309         u32   tx_queue_delay;
310 } __packed;
311
312 struct hif_cnf_multi_transmit {
313         u32   num_tx_confs;
314         struct hif_cnf_tx   tx_conf_payload[];
315 } __packed;
316
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
323 };
324
325 struct hif_rx_flags {
326         u8    encryp:3;
327         u8    in_aggr:1;
328         u8    first_aggr:1;
329         u8    last_aggr:1;
330         u8    defrag:1;
331         u8    beacon:1;
332         u8    tim:1;
333         u8    bitmap:1;
334         u8    match_ssid:1;
335         u8    match_bssid:1;
336         u8    more:1;
337         u8    reserved1:1;
338         u8    ht:1;
339         u8    stbc:1;
340         u8    match_uc_addr:1;
341         u8    match_mc_addr:1;
342         u8    match_bc_addr:1;
343         u8    key_type:1;
344         u8    key_index:4;
345         u8    reserved2:1;
346         u8    peer_sta_id:4;
347         u8    reserved3:2;
348         u8    reserved4:1;
349 } __packed;
350
351 struct hif_ind_rx {
352         u32   status;
353         u16   channel_number;
354         u8    rxed_rate;
355         u8    rcpi_rssi;
356         struct hif_rx_flags rx_flags;
357         u8    frame[];
358 } __packed;
359
360
361 struct hif_req_edca_queue_params {
362         u8    queue_id;
363         u8    reserved1;
364         u8    aifsn;
365         u8    reserved2;
366         u16   cw_min;
367         u16   cw_max;
368         u16   tx_op_limit;
369         u16   allowed_medium_time;
370         u32   reserved3;
371 } __packed;
372
373 struct hif_cnf_edca_queue_params {
374         u32   status;
375 } __packed;
376
377 struct hif_join_flags {
378         u8    reserved1:2;
379         u8    force_no_beacon:1;
380         u8    force_with_ind:1;
381         u8    reserved2:4;
382 } __packed;
383
384 struct hif_req_join {
385         u8    infrastructure_bss_mode:1;
386         u8    reserved1:7;
387         u8    band;
388         u16   channel_number;
389         u8    bssid[ETH_ALEN];
390         u16   atim_window;
391         u8    short_preamble:1;
392         u8    reserved2:7;
393         u8    probe_for_join;
394         u8    reserved3;
395         struct hif_join_flags join_flags;
396         u32   ssid_length;
397         u8    ssid[HIF_API_SSID_SIZE];
398         u32   beacon_interval;
399         u32   basic_rate_set;
400 } __packed;
401
402 struct hif_cnf_join {
403         u32   status;
404 } __packed;
405
406 struct hif_ind_join_complete {
407         u32   status;
408 } __packed;
409
410 struct hif_bss_flags {
411         u8    lost_count_only:1;
412         u8    reserved:7;
413 } __packed;
414
415 struct hif_req_set_bss_params {
416         struct hif_bss_flags bss_flags;
417         u8    beacon_lost_count;
418         u16   aid;
419         u32   operational_rate_set;
420 } __packed;
421
422 struct hif_cnf_set_bss_params {
423         u32   status;
424 } __packed;
425
426 struct hif_pm_mode {
427         u8    enter_psm:1;
428         u8    reserved:6;
429         u8    fast_psm:1;
430 } __packed;
431
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;
437 } __packed;
438
439 struct hif_cnf_set_pm_mode {
440         u32   status;
441 } __packed;
442
443 struct hif_ind_set_pm_mode_cmpl {
444         u32   status;
445         u8    pm_mode;
446         u8    reserved[3];
447 } __packed;
448
449
450 struct hif_req_start {
451         u8    mode;
452         u8    band;
453         u16   channel_number;
454         u32   reserved1;
455         u32   beacon_interval;
456         u8    dtim_period;
457         u8    short_preamble:1;
458         u8    reserved2:7;
459         u8    reserved3;
460         u8    ssid_length;
461         u8    ssid[HIF_API_SSID_SIZE];
462         u32   basic_rate_set;
463 } __packed;
464
465 struct hif_cnf_start {
466         u32   status;
467 } __packed;
468
469 enum hif_beacon {
470         HIF_BEACON_STOP                       = 0x0,
471         HIF_BEACON_START                      = 0x1
472 };
473
474 struct hif_req_beacon_transmit {
475         u8    enable_beaconing;
476         u8    reserved[3];
477 } __packed;
478
479 struct hif_cnf_beacon_transmit {
480         u32   status;
481 } __packed;
482
483 enum hif_sta_map_direction {
484         HIF_STA_MAP                       = 0x0,
485         HIF_STA_UNMAP                     = 0x1
486 };
487
488 struct hif_map_link_flags {
489         u8    map_direction:1;
490         u8    mfpc:1;
491         u8    reserved:6;
492 } __packed;
493
494 struct hif_req_map_link {
495         u8    mac_addr[ETH_ALEN];
496         struct hif_map_link_flags map_link_flags;
497         u8    peer_sta_id;
498 } __packed;
499
500 struct hif_cnf_map_link {
501         u32   status;
502 } __packed;
503
504 struct hif_suspend_resume_flags {
505         u8    resume:1;
506         u8    reserved1:2;
507         u8    bc_mc_only:1;
508         u8    reserved2:4;
509         u8    reserved3;
510 } __packed;
511
512 struct hif_ind_suspend_resume_tx {
513         struct hif_suspend_resume_flags suspend_resume_flags;
514         u16   peer_sta_set;
515 } __packed;
516
517
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
529
530 enum hif_key_type {
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
541 };
542
543 struct hif_wep_pairwise_key {
544         u8    peer_address[ETH_ALEN];
545         u8    reserved;
546         u8    key_length;
547         u8    key_data[HIF_API_WEP_KEY_DATA_SIZE];
548 } __packed;
549
550 struct hif_wep_group_key {
551         u8    key_id;
552         u8    key_length;
553         u8    reserved[2];
554         u8    key_data[HIF_API_WEP_KEY_DATA_SIZE];
555 } __packed;
556
557 struct hif_tkip_pairwise_key {
558         u8    peer_address[ETH_ALEN];
559         u8    reserved[2];
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];
563 } __packed;
564
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];
568         u8    key_id;
569         u8    reserved[3];
570         u8    rx_sequence_counter[HIF_API_RX_SEQUENCE_COUNTER_SIZE];
571 } __packed;
572
573 struct hif_aes_pairwise_key {
574         u8    peer_address[ETH_ALEN];
575         u8    reserved[2];
576         u8    aes_key_data[HIF_API_AES_KEY_DATA_SIZE];
577 } __packed;
578
579 struct hif_aes_group_key {
580         u8    aes_key_data[HIF_API_AES_KEY_DATA_SIZE];
581         u8    key_id;
582         u8    reserved[3];
583         u8    rx_sequence_counter[HIF_API_RX_SEQUENCE_COUNTER_SIZE];
584 } __packed;
585
586 struct hif_wapi_pairwise_key {
587         u8    peer_address[ETH_ALEN];
588         u8    key_id;
589         u8    reserved;
590         u8    wapi_key_data[HIF_API_WAPI_KEY_DATA_SIZE];
591         u8    mic_key_data[HIF_API_MIC_KEY_DATA_SIZE];
592 } __packed;
593
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];
597         u8    key_id;
598         u8    reserved[3];
599 } __packed;
600
601 struct hif_igtk_group_key {
602         u8    igtk_key_data[HIF_API_IGTK_KEY_DATA_SIZE];
603         u8    key_id;
604         u8    reserved[3];
605         u8    ipn[HIF_API_IPN_SIZE];
606 } __packed;
607
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;
618 };
619
620 struct hif_req_add_key {
621         u8    type;
622         u8    entry_index;
623         u8    int_id:2;
624         u8    reserved1:6;
625         u8    reserved2;
626         union hif_privacy_key_data key;
627 } __packed;
628
629 struct hif_cnf_add_key {
630         u32   status;
631 } __packed;
632
633 struct hif_req_remove_key {
634         u8    entry_index;
635         u8    reserved[3];
636 } __packed;
637
638 struct hif_cnf_remove_key {
639         u32   status;
640 } __packed;
641
642 enum hif_event_ind {
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
648 };
649
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
656 };
657
658 union hif_event_data {
659         u8    rcpi_rssi;
660         u32   ps_mode_error;
661         u32   peer_sta_set;
662 };
663
664 struct hif_ind_event {
665         u32   event_id;
666         union hif_event_data event_data;
667 } __packed;
668
669
670 #endif