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