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-2020, Silicon Laboratories Inc.
   6  */
   7
   8 #ifndef WFX_HIF_API_CMD_H
   9 #define WFX_HIF_API_CMD_H
  10
  11 enum hif_requests_ids {
  12         HIF_REQ_ID_RESET                = 0x0a,
  13         HIF_REQ_ID_READ_MIB             = 0x05,
  14         HIF_REQ_ID_WRITE_MIB            = 0x06,
  15         HIF_REQ_ID_START_SCAN           = 0x07,
  16         HIF_REQ_ID_STOP_SCAN            = 0x08,
  17         HIF_REQ_ID_TX                   = 0x04,
  18         HIF_REQ_ID_JOIN                 = 0x0b,
  19         HIF_REQ_ID_SET_PM_MODE          = 0x10,
  20         HIF_REQ_ID_SET_BSS_PARAMS       = 0x11,
  21         HIF_REQ_ID_ADD_KEY              = 0x0c,
  22         HIF_REQ_ID_REMOVE_KEY           = 0x0d,
  23         HIF_REQ_ID_EDCA_QUEUE_PARAMS    = 0x13,
  24         HIF_REQ_ID_START                = 0x17,
  25         HIF_REQ_ID_BEACON_TRANSMIT      = 0x18,
  26         HIF_REQ_ID_UPDATE_IE            = 0x1b,
  27         HIF_REQ_ID_MAP_LINK             = 0x1c,
  28 };
  29
  30 enum hif_confirmations_ids {
  31         HIF_CNF_ID_RESET                = 0x0a,
  32         HIF_CNF_ID_READ_MIB             = 0x05,
  33         HIF_CNF_ID_WRITE_MIB            = 0x06,
  34         HIF_CNF_ID_START_SCAN           = 0x07,
  35         HIF_CNF_ID_STOP_SCAN            = 0x08,
  36         HIF_CNF_ID_TX                   = 0x04,
  37         HIF_CNF_ID_MULTI_TRANSMIT       = 0x1e,
  38         HIF_CNF_ID_JOIN                 = 0x0b,
  39         HIF_CNF_ID_SET_PM_MODE          = 0x10,
  40         HIF_CNF_ID_SET_BSS_PARAMS       = 0x11,
  41         HIF_CNF_ID_ADD_KEY              = 0x0c,
  42         HIF_CNF_ID_REMOVE_KEY           = 0x0d,
  43         HIF_CNF_ID_EDCA_QUEUE_PARAMS    = 0x13,
  44         HIF_CNF_ID_START                = 0x17,
  45         HIF_CNF_ID_BEACON_TRANSMIT      = 0x18,
  46         HIF_CNF_ID_UPDATE_IE            = 0x1b,
  47         HIF_CNF_ID_MAP_LINK             = 0x1c,
  48 };
  49
  50 enum hif_indications_ids {
  51         HIF_IND_ID_RX                   = 0x84,
  52         HIF_IND_ID_SCAN_CMPL            = 0x86,
  53         HIF_IND_ID_JOIN_COMPLETE        = 0x8f,
  54         HIF_IND_ID_SET_PM_MODE_CMPL     = 0x89,
  55         HIF_IND_ID_SUSPEND_RESUME_TX    = 0x8c,
  56         HIF_IND_ID_EVENT                = 0x85
  57 };
  58
  59 struct hif_req_reset {
  60         u8     reset_stat:1;
  61         u8     reset_all_int:1;
  62         u8     reserved1:6;
  63         u8     reserved2[3];
  64 } __packed;
  65
  66 struct hif_cnf_reset {
  67         __le32 status;
  68 } __packed;
  69
  70 struct hif_req_read_mib {
  71         __le16 mib_id;
  72         __le16 reserved;
  73 } __packed;
  74
  75 struct hif_cnf_read_mib {
  76         __le32 status;
  77         __le16 mib_id;
  78         __le16 length;
  79         u8     mib_data[];
  80 } __packed;
  81
  82 struct hif_req_write_mib {
  83         __le16 mib_id;
  84         __le16 length;
  85         u8     mib_data[];
  86 } __packed;
  87
  88 struct hif_cnf_write_mib {
  89         __le32 status;
  90 } __packed;
  91
  92 struct hif_req_update_ie {
  93         u8     beacon:1;
  94         u8     probe_resp:1;
  95         u8     probe_req:1;
  96         u8     reserved1:5;
  97         u8     reserved2;
  98         __le16 num_ies;
  99         u8     ie[];
 100 } __packed;
 101
 102 struct hif_cnf_update_ie {
 103         __le32 status;
 104 } __packed;
 105
 106 struct hif_ssid_def {
 107         __le32 ssid_length;
 108         u8     ssid[IEEE80211_MAX_SSID_LEN];
 109 } __packed;
 110
 111 #define HIF_API_MAX_NB_SSIDS                           2
 112 #define HIF_API_MAX_NB_CHANNELS                       14
 113
 114 struct hif_req_start_scan_alt {
 115         u8     band;
 116         u8     maintain_current_bss:1;
 117         u8     periodic:1;
 118         u8     reserved1:6;
 119         u8     disallow_ps:1;
 120         u8     reserved2:1;
 121         u8     short_preamble:1;
 122         u8     reserved3:5;
 123         u8     max_transmit_rate;
 124         __le16 periodic_interval;
 125         u8     reserved4;
 126         s8     periodic_rssi_thr;
 127         u8     num_of_probe_requests;
 128         u8     probe_delay;
 129         u8     num_of_ssids;
 130         u8     num_of_channels;
 131         __le32 min_channel_time;
 132         __le32 max_channel_time;
 133         __le32 tx_power_level; // signed value
 134         struct hif_ssid_def ssid_def[HIF_API_MAX_NB_SSIDS];
 135         u8     channel_list[];
 136 } __packed;
 137
 138 struct hif_cnf_start_scan {
 139         __le32 status;
 140 } __packed;
 141
 142 struct hif_cnf_stop_scan {
 143         __le32 status;
 144 } __packed;
 145
 146 enum hif_pm_mode_status {
 147         HIF_PM_MODE_ACTIVE                         = 0x0,
 148         HIF_PM_MODE_PS                             = 0x1,
 149         HIF_PM_MODE_UNDETERMINED                   = 0x2
 150 };
 151
 152 struct hif_ind_scan_cmpl {
 153         __le32 status;
 154         u8     pm_mode;
 155         u8     num_channels_completed;
 156         __le16 reserved;
 157 } __packed;
 158
 159 enum hif_queue_id {
 160         HIF_QUEUE_ID_BACKGROUND                    = 0x0,
 161         HIF_QUEUE_ID_BESTEFFORT                    = 0x1,
 162         HIF_QUEUE_ID_VIDEO                         = 0x2,
 163         HIF_QUEUE_ID_VOICE                         = 0x3
 164 };
 165
 166 enum hif_frame_format {
 167         HIF_FRAME_FORMAT_NON_HT                    = 0x0,
 168         HIF_FRAME_FORMAT_MIXED_FORMAT_HT           = 0x1,
 169         HIF_FRAME_FORMAT_GF_HT_11N                 = 0x2
 170 };
 171
 172 struct hif_req_tx {
 173         // packet_id is not interpreted by the device, so it is not necessary to
 174         // declare it little endian
 175         u32    packet_id;
 176         u8     max_tx_rate;
 177         u8     queue_id:2;
 178         u8     peer_sta_id:4;
 179         u8     reserved1:2;
 180         u8     more:1;
 181         u8     fc_offset:3;
 182         u8     after_dtim:1;
 183         u8     reserved2:3;
 184         u8     start_exp:1;
 185         u8     reserved3:3;
 186         u8     retry_policy_index:4;
 187         __le32 reserved4;
 188         __le32 expire_time;
 189         u8     frame_format:4;
 190         u8     fec_coding:1;
 191         u8     short_gi:1;
 192         u8     reserved5:1;
 193         u8     stbc:1;
 194         u8     reserved6;
 195         u8     aggregation:1;
 196         u8     reserved7:7;
 197         u8     reserved8;
 198         u8     frame[];
 199 } __packed;
 200
 201 enum hif_qos_ackplcy {
 202         HIF_QOS_ACKPLCY_NORMAL                         = 0x0,
 203         HIF_QOS_ACKPLCY_TXNOACK                        = 0x1,
 204         HIF_QOS_ACKPLCY_NOEXPACK                       = 0x2,
 205         HIF_QOS_ACKPLCY_BLCKACK                        = 0x3
 206 };
 207
 208 struct hif_cnf_tx {
 209         __le32 status;
 210         // packet_id is copied from struct hif_req_tx without been interpreted
 211         // by the device, so it is not necessary to declare it little endian
 212         u32    packet_id;
 213         u8     txed_rate;
 214         u8     ack_failures;
 215         u8     aggr:1;
 216         u8     requeue:1;
 217         u8     ack_policy:2;
 218         u8     txop_limit:1;
 219         u8     reserved1:3;
 220         u8     reserved2;
 221         __le32 media_delay;
 222         __le32 tx_queue_delay;
 223 } __packed;
 224
 225 struct hif_cnf_multi_transmit {
 226         u8     num_tx_confs;
 227         u8     reserved[3];
 228         struct hif_cnf_tx tx_conf_payload[];
 229 } __packed;
 230
 231 enum hif_ri_flags_encrypt {
 232         HIF_RI_FLAGS_UNENCRYPTED                   = 0x0,
 233         HIF_RI_FLAGS_WEP_ENCRYPTED                 = 0x1,
 234         HIF_RI_FLAGS_TKIP_ENCRYPTED                = 0x2,
 235         HIF_RI_FLAGS_AES_ENCRYPTED                 = 0x3,
 236         HIF_RI_FLAGS_WAPI_ENCRYPTED                = 0x4
 237 };
 238
 239 struct hif_ind_rx {
 240         __le32 status;
 241         u8     channel_number;
 242         u8     reserved1;
 243         u8     rxed_rate;
 244         u8     rcpi_rssi;
 245         u8     encryp:3;
 246         u8     in_aggr:1;
 247         u8     first_aggr:1;
 248         u8     last_aggr:1;
 249         u8     defrag:1;
 250         u8     beacon:1;
 251         u8     tim:1;
 252         u8     bitmap:1;
 253         u8     match_ssid:1;
 254         u8     match_bssid:1;
 255         u8     more:1;
 256         u8     reserved2:1;
 257         u8     ht:1;
 258         u8     stbc:1;
 259         u8     match_uc_addr:1;
 260         u8     match_mc_addr:1;
 261         u8     match_bc_addr:1;
 262         u8     key_type:1;
 263         u8     key_index:4;
 264         u8     reserved3:1;
 265         u8     peer_sta_id:4;
 266         u8     reserved4:2;
 267         u8     reserved5:1;
 268         u8     frame[];
 269 } __packed;
 270
 271 struct hif_req_edca_queue_params {
 272         u8     queue_id;
 273         u8     reserved1;
 274         u8     aifsn;
 275         u8     reserved2;
 276         __le16 cw_min;
 277         __le16 cw_max;
 278         __le16 tx_op_limit;
 279         __le16 allowed_medium_time;
 280         __le32 reserved3;
 281 } __packed;
 282
 283 struct hif_cnf_edca_queue_params {
 284         __le32 status;
 285 } __packed;
 286
 287 struct hif_req_join {
 288         u8     infrastructure_bss_mode:1;
 289         u8     reserved1:7;
 290         u8     band;
 291         u8     channel_number;
 292         u8     reserved2;
 293         u8     bssid[ETH_ALEN];
 294         __le16 atim_window;
 295         u8     short_preamble:1;
 296         u8     reserved3:7;
 297         u8     probe_for_join;
 298         u8     reserved4;
 299         u8     reserved5:2;
 300         u8     force_no_beacon:1;
 301         u8     force_with_ind:1;
 302         u8     reserved6:4;
 303         __le32 ssid_length;
 304         u8     ssid[IEEE80211_MAX_SSID_LEN];
 305         __le32 beacon_interval;
 306         __le32 basic_rate_set;
 307 } __packed;
 308
 309 struct hif_cnf_join {
 310         __le32 status;
 311 } __packed;
 312
 313 struct hif_ind_join_complete {
 314         __le32 status;
 315 } __packed;
 316
 317 struct hif_req_set_bss_params {
 318         u8     lost_count_only:1;
 319         u8     reserved:7;
 320         u8     beacon_lost_count;
 321         __le16 aid;
 322         __le32 operational_rate_set;
 323 } __packed;
 324
 325 struct hif_cnf_set_bss_params {
 326         __le32 status;
 327 } __packed;
 328
 329 struct hif_req_set_pm_mode {
 330         u8     enter_psm:1;
 331         u8     reserved:6;
 332         u8     fast_psm:1;
 333         u8     fast_psm_idle_period;
 334         u8     ap_psm_change_period;
 335         u8     min_auto_ps_poll_period;
 336 } __packed;
 337
 338 struct hif_cnf_set_pm_mode {
 339         __le32 status;
 340 } __packed;
 341
 342 struct hif_ind_set_pm_mode_cmpl {
 343         __le32 status;
 344         u8     pm_mode;
 345         u8     reserved[3];
 346 } __packed;
 347
 348 struct hif_req_start {
 349         u8     mode;
 350         u8     band;
 351         u8     channel_number;
 352         u8     reserved1;
 353         __le32 reserved2;
 354         __le32 beacon_interval;
 355         u8     dtim_period;
 356         u8     short_preamble:1;
 357         u8     reserved3:7;
 358         u8     reserved4;
 359         u8     ssid_length;
 360         u8     ssid[IEEE80211_MAX_SSID_LEN];
 361         __le32 basic_rate_set;
 362 } __packed;
 363
 364 struct hif_cnf_start {
 365         __le32 status;
 366 } __packed;
 367
 368 struct hif_req_beacon_transmit {
 369         u8     enable_beaconing;
 370         u8     reserved[3];
 371 } __packed;
 372
 373 struct hif_cnf_beacon_transmit {
 374         __le32 status;
 375 } __packed;
 376
 377 #define HIF_LINK_ID_MAX            14
 378 #define HIF_LINK_ID_NOT_ASSOCIATED (HIF_LINK_ID_MAX + 1)
 379
 380 struct hif_req_map_link {
 381         u8     mac_addr[ETH_ALEN];
 382         u8     unmap:1;
 383         u8     mfpc:1;
 384         u8     reserved:6;
 385         u8     peer_sta_id;
 386 } __packed;
 387
 388 struct hif_cnf_map_link {
 389         __le32 status;
 390 } __packed;
 391
 392 struct hif_ind_suspend_resume_tx {
 393         u8     resume:1;
 394         u8     reserved1:2;
 395         u8     bc_mc_only:1;
 396         u8     reserved2:4;
 397         u8     reserved3;
 398         __le16 peer_sta_set;
 399 } __packed;
 400
 401
 402 #define MAX_KEY_ENTRIES         24
 403 #define HIF_API_WEP_KEY_DATA_SIZE                       16
 404 #define HIF_API_TKIP_KEY_DATA_SIZE                      16
 405 #define HIF_API_RX_MIC_KEY_SIZE                         8
 406 #define HIF_API_TX_MIC_KEY_SIZE                         8
 407 #define HIF_API_AES_KEY_DATA_SIZE                       16
 408 #define HIF_API_WAPI_KEY_DATA_SIZE                      16
 409 #define HIF_API_MIC_KEY_DATA_SIZE                       16
 410 #define HIF_API_IGTK_KEY_DATA_SIZE                      16
 411 #define HIF_API_RX_SEQUENCE_COUNTER_SIZE                8
 412 #define HIF_API_IPN_SIZE                                8
 413
 414 enum hif_key_type {
 415         HIF_KEY_TYPE_WEP_DEFAULT                   = 0x0,
 416         HIF_KEY_TYPE_WEP_PAIRWISE                  = 0x1,
 417         HIF_KEY_TYPE_TKIP_GROUP                    = 0x2,
 418         HIF_KEY_TYPE_TKIP_PAIRWISE                 = 0x3,
 419         HIF_KEY_TYPE_AES_GROUP                     = 0x4,
 420         HIF_KEY_TYPE_AES_PAIRWISE                  = 0x5,
 421         HIF_KEY_TYPE_WAPI_GROUP                    = 0x6,
 422         HIF_KEY_TYPE_WAPI_PAIRWISE                 = 0x7,
 423         HIF_KEY_TYPE_IGTK_GROUP                    = 0x8,
 424         HIF_KEY_TYPE_NONE                          = 0x9
 425 };
 426
 427 struct hif_wep_pairwise_key {
 428         u8     peer_address[ETH_ALEN];
 429         u8     reserved;
 430         u8     key_length;
 431         u8     key_data[HIF_API_WEP_KEY_DATA_SIZE];
 432 } __packed;
 433
 434 struct hif_wep_group_key {
 435         u8     key_id;
 436         u8     key_length;
 437         u8     reserved[2];
 438         u8     key_data[HIF_API_WEP_KEY_DATA_SIZE];
 439 } __packed;
 440
 441 struct hif_tkip_pairwise_key {
 442         u8     peer_address[ETH_ALEN];
 443         u8     reserved[2];
 444         u8     tkip_key_data[HIF_API_TKIP_KEY_DATA_SIZE];
 445         u8     rx_mic_key[HIF_API_RX_MIC_KEY_SIZE];
 446         u8     tx_mic_key[HIF_API_TX_MIC_KEY_SIZE];
 447 } __packed;
 448
 449 struct hif_tkip_group_key {
 450         u8     tkip_key_data[HIF_API_TKIP_KEY_DATA_SIZE];
 451         u8     rx_mic_key[HIF_API_RX_MIC_KEY_SIZE];
 452         u8     key_id;
 453         u8     reserved[3];
 454         u8     rx_sequence_counter[HIF_API_RX_SEQUENCE_COUNTER_SIZE];
 455 } __packed;
 456
 457 struct hif_aes_pairwise_key {
 458         u8     peer_address[ETH_ALEN];
 459         u8     reserved[2];
 460         u8     aes_key_data[HIF_API_AES_KEY_DATA_SIZE];
 461 } __packed;
 462
 463 struct hif_aes_group_key {
 464         u8     aes_key_data[HIF_API_AES_KEY_DATA_SIZE];
 465         u8     key_id;
 466         u8     reserved[3];
 467         u8     rx_sequence_counter[HIF_API_RX_SEQUENCE_COUNTER_SIZE];
 468 } __packed;
 469
 470 struct hif_wapi_pairwise_key {
 471         u8     peer_address[ETH_ALEN];
 472         u8     key_id;
 473         u8     reserved;
 474         u8     wapi_key_data[HIF_API_WAPI_KEY_DATA_SIZE];
 475         u8     mic_key_data[HIF_API_MIC_KEY_DATA_SIZE];
 476 } __packed;
 477
 478 struct hif_wapi_group_key {
 479         u8     wapi_key_data[HIF_API_WAPI_KEY_DATA_SIZE];
 480         u8     mic_key_data[HIF_API_MIC_KEY_DATA_SIZE];
 481         u8     key_id;
 482         u8     reserved[3];
 483 } __packed;
 484
 485 struct hif_igtk_group_key {
 486         u8     igtk_key_data[HIF_API_IGTK_KEY_DATA_SIZE];
 487         u8     key_id;
 488         u8     reserved[3];
 489         u8     ipn[HIF_API_IPN_SIZE];
 490 } __packed;
 491
 492 struct hif_req_add_key {
 493         u8     type;
 494         u8     entry_index;
 495         u8     int_id:2;
 496         u8     reserved1:6;
 497         u8     reserved2;
 498         union {
 499                 struct hif_wep_pairwise_key  wep_pairwise_key;
 500                 struct hif_wep_group_key     wep_group_key;
 501                 struct hif_tkip_pairwise_key tkip_pairwise_key;
 502                 struct hif_tkip_group_key    tkip_group_key;
 503                 struct hif_aes_pairwise_key  aes_pairwise_key;
 504                 struct hif_aes_group_key     aes_group_key;
 505                 struct hif_wapi_pairwise_key wapi_pairwise_key;
 506                 struct hif_wapi_group_key    wapi_group_key;
 507                 struct hif_igtk_group_key    igtk_group_key;
 508         } key;
 509 } __packed;
 510
 511 struct hif_cnf_add_key {
 512         __le32 status;
 513 } __packed;
 514
 515 struct hif_req_remove_key {
 516         u8     entry_index;
 517         u8     reserved[3];
 518 } __packed;
 519
 520 struct hif_cnf_remove_key {
 521         __le32 status;
 522 } __packed;
 523
 524 enum hif_event_ind {
 525         HIF_EVENT_IND_BSSLOST                      = 0x1,
 526         HIF_EVENT_IND_BSSREGAINED                  = 0x2,
 527         HIF_EVENT_IND_RCPI_RSSI                    = 0x3,
 528         HIF_EVENT_IND_PS_MODE_ERROR                = 0x4,
 529         HIF_EVENT_IND_INACTIVITY                   = 0x5
 530 };
 531
 532 enum hif_ps_mode_error {
 533         HIF_PS_ERROR_NO_ERROR                      = 0,
 534         HIF_PS_ERROR_AP_NOT_RESP_TO_POLL           = 1,
 535         HIF_PS_ERROR_AP_NOT_RESP_TO_UAPSD_TRIGGER  = 2,
 536         HIF_PS_ERROR_AP_SENT_UNICAST_IN_DOZE       = 3,
 537         HIF_PS_ERROR_AP_NO_DATA_AFTER_TIM          = 4
 538 };
 539
 540 struct hif_ind_event {
 541         __le32 event_id;
 542         union {
 543                 u8     rcpi_rssi;
 544                 __le32 ps_mode_error;
 545                 __le32 peer_sta_set;
 546         } event_data;
 547 } __packed;
 548
 549 #endif