drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.h

   1 // SPDX-License-Identifier: ISC
   2 /*
   3  * Copyright (c) 2012 Broadcom Corporation
   4  */
   5
   6
   7 #ifndef FWEH_H_
   8 #define FWEH_H_
   9
  10 #include <asm/unaligned.h>
  11 #include <linux/skbuff.h>
  12 #include <linux/if_ether.h>
  13 #include <linux/if.h>
  14
  15 /* formward declarations */
  16 struct brcmf_pub;
  17 struct brcmf_if;
  18 struct brcmf_cfg80211_info;
  19
  20 /* list of firmware events */
  21 #define BRCMF_FWEH_EVENT_ENUM_DEFLIST \
  22         BRCMF_ENUM_DEF(SET_SSID, 0) \
  23         BRCMF_ENUM_DEF(JOIN, 1) \
  24         BRCMF_ENUM_DEF(START, 2) \
  25         BRCMF_ENUM_DEF(AUTH, 3) \
  26         BRCMF_ENUM_DEF(AUTH_IND, 4) \
  27         BRCMF_ENUM_DEF(DEAUTH, 5) \
  28         BRCMF_ENUM_DEF(DEAUTH_IND, 6) \
  29         BRCMF_ENUM_DEF(ASSOC, 7) \
  30         BRCMF_ENUM_DEF(ASSOC_IND, 8) \
  31         BRCMF_ENUM_DEF(REASSOC, 9) \
  32         BRCMF_ENUM_DEF(REASSOC_IND, 10) \
  33         BRCMF_ENUM_DEF(DISASSOC, 11) \
  34         BRCMF_ENUM_DEF(DISASSOC_IND, 12) \
  35         BRCMF_ENUM_DEF(QUIET_START, 13) \
  36         BRCMF_ENUM_DEF(QUIET_END, 14) \
  37         BRCMF_ENUM_DEF(BEACON_RX, 15) \
  38         BRCMF_ENUM_DEF(LINK, 16) \
  39         BRCMF_ENUM_DEF(MIC_ERROR, 17) \
  40         BRCMF_ENUM_DEF(NDIS_LINK, 18) \
  41         BRCMF_ENUM_DEF(ROAM, 19) \
  42         BRCMF_ENUM_DEF(TXFAIL, 20) \
  43         BRCMF_ENUM_DEF(PMKID_CACHE, 21) \
  44         BRCMF_ENUM_DEF(RETROGRADE_TSF, 22) \
  45         BRCMF_ENUM_DEF(PRUNE, 23) \
  46         BRCMF_ENUM_DEF(AUTOAUTH, 24) \
  47         BRCMF_ENUM_DEF(EAPOL_MSG, 25) \
  48         BRCMF_ENUM_DEF(SCAN_COMPLETE, 26) \
  49         BRCMF_ENUM_DEF(ADDTS_IND, 27) \
  50         BRCMF_ENUM_DEF(DELTS_IND, 28) \
  51         BRCMF_ENUM_DEF(BCNSENT_IND, 29) \
  52         BRCMF_ENUM_DEF(BCNRX_MSG, 30) \
  53         BRCMF_ENUM_DEF(BCNLOST_MSG, 31) \
  54         BRCMF_ENUM_DEF(ROAM_PREP, 32) \
  55         BRCMF_ENUM_DEF(PFN_NET_FOUND, 33) \
  56         BRCMF_ENUM_DEF(PFN_NET_LOST, 34) \
  57         BRCMF_ENUM_DEF(RESET_COMPLETE, 35) \
  58         BRCMF_ENUM_DEF(JOIN_START, 36) \
  59         BRCMF_ENUM_DEF(ROAM_START, 37) \
  60         BRCMF_ENUM_DEF(ASSOC_START, 38) \
  61         BRCMF_ENUM_DEF(IBSS_ASSOC, 39) \
  62         BRCMF_ENUM_DEF(RADIO, 40) \
  63         BRCMF_ENUM_DEF(PSM_WATCHDOG, 41) \
  64         BRCMF_ENUM_DEF(PROBREQ_MSG, 44) \
  65         BRCMF_ENUM_DEF(SCAN_CONFIRM_IND, 45) \
  66         BRCMF_ENUM_DEF(PSK_SUP, 46) \
  67         BRCMF_ENUM_DEF(COUNTRY_CODE_CHANGED, 47) \
  68         BRCMF_ENUM_DEF(EXCEEDED_MEDIUM_TIME, 48) \
  69         BRCMF_ENUM_DEF(ICV_ERROR, 49) \
  70         BRCMF_ENUM_DEF(UNICAST_DECODE_ERROR, 50) \
  71         BRCMF_ENUM_DEF(MULTICAST_DECODE_ERROR, 51) \
  72         BRCMF_ENUM_DEF(TRACE, 52) \
  73         BRCMF_ENUM_DEF(IF, 54) \
  74         BRCMF_ENUM_DEF(P2P_DISC_LISTEN_COMPLETE, 55) \
  75         BRCMF_ENUM_DEF(RSSI, 56) \
  76         BRCMF_ENUM_DEF(EXTLOG_MSG, 58) \
  77         BRCMF_ENUM_DEF(ACTION_FRAME, 59) \
  78         BRCMF_ENUM_DEF(ACTION_FRAME_COMPLETE, 60) \
  79         BRCMF_ENUM_DEF(PRE_ASSOC_IND, 61) \
  80         BRCMF_ENUM_DEF(PRE_REASSOC_IND, 62) \
  81         BRCMF_ENUM_DEF(CHANNEL_ADOPTED, 63) \
  82         BRCMF_ENUM_DEF(AP_STARTED, 64) \
  83         BRCMF_ENUM_DEF(DFS_AP_STOP, 65) \
  84         BRCMF_ENUM_DEF(DFS_AP_RESUME, 66) \
  85         BRCMF_ENUM_DEF(ESCAN_RESULT, 69) \
  86         BRCMF_ENUM_DEF(ACTION_FRAME_OFF_CHAN_COMPLETE, 70) \
  87         BRCMF_ENUM_DEF(PROBERESP_MSG, 71) \
  88         BRCMF_ENUM_DEF(P2P_PROBEREQ_MSG, 72) \
  89         BRCMF_ENUM_DEF(DCS_REQUEST, 73) \
  90         BRCMF_ENUM_DEF(FIFO_CREDIT_MAP, 74) \
  91         BRCMF_ENUM_DEF(ACTION_FRAME_RX, 75) \
  92         BRCMF_ENUM_DEF(TDLS_PEER_EVENT, 92) \
  93         BRCMF_ENUM_DEF(BCMC_CREDIT_SUPPORT, 127) \
  94         BRCMF_ENUM_DEF(ULP, 146) \
  95         BRCMF_ENUM_DEF(EXT_AUTH_REQ, 187) \
  96         BRCMF_ENUM_DEF(EXT_AUTH_FRAME_RX, 188) \
  97         BRCMF_ENUM_DEF(MGMT_FRAME_TXSTATUS, 189) \
  98         BRCMF_ENUM_DEF(MGMT_FRAME_OFF_CHAN_COMPLETE, 190)
  99
 100 #define BRCMF_ENUM_DEF(id, val) \
 101         BRCMF_E_##id = (val),
 102
 103 /* firmware event codes sent by the dongle */
 104 enum brcmf_fweh_event_code {
 105         BRCMF_FWEH_EVENT_ENUM_DEFLIST
 106         /* this determines event mask length which must match
 107          * minimum length check in device firmware so it is
 108          * hard-coded here.
 109          */
 110         BRCMF_E_LAST = 191
 111 };
 112 #undef BRCMF_ENUM_DEF
 113
 114 #define BRCMF_EVENTING_MASK_LEN         DIV_ROUND_UP(BRCMF_E_LAST, 8)
 115
 116 /* flags field values in struct brcmf_event_msg */
 117 #define BRCMF_EVENT_MSG_LINK            0x01
 118 #define BRCMF_EVENT_MSG_FLUSHTXQ        0x02
 119 #define BRCMF_EVENT_MSG_GROUP           0x04
 120
 121 /* status field values in struct brcmf_event_msg */
 122 #define BRCMF_E_STATUS_SUCCESS                  0
 123 #define BRCMF_E_STATUS_FAIL                     1
 124 #define BRCMF_E_STATUS_TIMEOUT                  2
 125 #define BRCMF_E_STATUS_NO_NETWORKS              3
 126 #define BRCMF_E_STATUS_ABORT                    4
 127 #define BRCMF_E_STATUS_NO_ACK                   5
 128 #define BRCMF_E_STATUS_UNSOLICITED              6
 129 #define BRCMF_E_STATUS_ATTEMPT                  7
 130 #define BRCMF_E_STATUS_PARTIAL                  8
 131 #define BRCMF_E_STATUS_NEWSCAN                  9
 132 #define BRCMF_E_STATUS_NEWASSOC                 10
 133 #define BRCMF_E_STATUS_11HQUIET                 11
 134 #define BRCMF_E_STATUS_SUPPRESS                 12
 135 #define BRCMF_E_STATUS_NOCHANS                  13
 136 #define BRCMF_E_STATUS_CS_ABORT                 15
 137 #define BRCMF_E_STATUS_ERROR                    16
 138
 139 /* status field values for PSK_SUP event */
 140 #define BRCMF_E_STATUS_FWSUP_WAIT_M1            4
 141 #define BRCMF_E_STATUS_FWSUP_PREP_M2            5
 142 #define BRCMF_E_STATUS_FWSUP_COMPLETED          6
 143 #define BRCMF_E_STATUS_FWSUP_TIMEOUT            7
 144 #define BRCMF_E_STATUS_FWSUP_WAIT_M3            8
 145 #define BRCMF_E_STATUS_FWSUP_PREP_M4            9
 146 #define BRCMF_E_STATUS_FWSUP_WAIT_G1            10
 147 #define BRCMF_E_STATUS_FWSUP_PREP_G2            11
 148
 149 /* reason field values in struct brcmf_event_msg */
 150 #define BRCMF_E_REASON_INITIAL_ASSOC            0
 151 #define BRCMF_E_REASON_LOW_RSSI                 1
 152 #define BRCMF_E_REASON_DEAUTH                   2
 153 #define BRCMF_E_REASON_DISASSOC                 3
 154 #define BRCMF_E_REASON_BCNS_LOST                4
 155 #define BRCMF_E_REASON_MINTXRATE                9
 156 #define BRCMF_E_REASON_TXFAIL                   10
 157
 158 #define BRCMF_E_REASON_LINK_BSSCFG_DIS          4
 159 #define BRCMF_E_REASON_FAST_ROAM_FAILED         5
 160 #define BRCMF_E_REASON_DIRECTED_ROAM            6
 161 #define BRCMF_E_REASON_TSPEC_REJECTED           7
 162 #define BRCMF_E_REASON_BETTER_AP                8
 163
 164 #define BRCMF_E_REASON_TDLS_PEER_DISCOVERED     0
 165 #define BRCMF_E_REASON_TDLS_PEER_CONNECTED      1
 166 #define BRCMF_E_REASON_TDLS_PEER_DISCONNECTED   2
 167
 168 /* reason field values for PSK_SUP event */
 169 #define BRCMF_E_REASON_FWSUP_OTHER              0
 170 #define BRCMF_E_REASON_FWSUP_DECRYPT_KEY_DATA   1
 171 #define BRCMF_E_REASON_FWSUP_BAD_UCAST_WEP128   2
 172 #define BRCMF_E_REASON_FWSUP_BAD_UCAST_WEP40    3
 173 #define BRCMF_E_REASON_FWSUP_UNSUP_KEY_LEN      4
 174 #define BRCMF_E_REASON_FWSUP_PW_KEY_CIPHER      5
 175 #define BRCMF_E_REASON_FWSUP_MSG3_TOO_MANY_IE   6
 176 #define BRCMF_E_REASON_FWSUP_MSG3_IE_MISMATCH   7
 177 #define BRCMF_E_REASON_FWSUP_NO_INSTALL_FLAG    8
 178 #define BRCMF_E_REASON_FWSUP_MSG3_NO_GTK        9
 179 #define BRCMF_E_REASON_FWSUP_GRP_KEY_CIPHER     10
 180 #define BRCMF_E_REASON_FWSUP_GRP_MSG1_NO_GTK    11
 181 #define BRCMF_E_REASON_FWSUP_GTK_DECRYPT_FAIL   12
 182 #define BRCMF_E_REASON_FWSUP_SEND_FAIL          13
 183 #define BRCMF_E_REASON_FWSUP_DEAUTH             14
 184 #define BRCMF_E_REASON_FWSUP_WPA_PSK_TMO        15
 185 #define BRCMF_E_REASON_FWSUP_WPA_PSK_M1_TMO     16
 186 #define BRCMF_E_REASON_FWSUP_WPA_PSK_M3_TMO     17
 187
 188 /* action field values for brcmf_ifevent */
 189 #define BRCMF_E_IF_ADD                          1
 190 #define BRCMF_E_IF_DEL                          2
 191 #define BRCMF_E_IF_CHANGE                       3
 192
 193 /* flag field values for brcmf_ifevent */
 194 #define BRCMF_E_IF_FLAG_NOIF                    1
 195
 196 /* role field values for brcmf_ifevent */
 197 #define BRCMF_E_IF_ROLE_STA                     0
 198 #define BRCMF_E_IF_ROLE_AP                      1
 199 #define BRCMF_E_IF_ROLE_WDS                     2
 200 #define BRCMF_E_IF_ROLE_P2P_GO                  3
 201 #define BRCMF_E_IF_ROLE_P2P_CLIENT              4
 202
 203 /**
 204  * definitions for event packet validation.
 205  */
 206 #define BRCM_OUI                                "\x00\x10\x18"
 207 #define BCMILCP_BCM_SUBTYPE_EVENT               1
 208 #define BCMILCP_SUBTYPE_VENDOR_LONG             32769
 209
 210 /**
 211  * struct brcm_ethhdr - broadcom specific ether header.
 212  *
 213  * @subtype: subtype for this packet.
 214  * @length: TODO: length of appended data.
 215  * @version: version indication.
 216  * @oui: OUI of this packet.
 217  * @usr_subtype: subtype for this OUI.
 218  */
 219 struct brcm_ethhdr {
 220         __be16 subtype;
 221         __be16 length;
 222         u8 version;
 223         u8 oui[3];
 224         __be16 usr_subtype;
 225 } __packed;
 226
 227 struct brcmf_event_msg_be {
 228         __be16 version;
 229         __be16 flags;
 230         __be32 event_type;
 231         __be32 status;
 232         __be32 reason;
 233         __be32 auth_type;
 234         __be32 datalen;
 235         u8 addr[ETH_ALEN];
 236         char ifname[IFNAMSIZ];
 237         u8 ifidx;
 238         u8 bsscfgidx;
 239 } __packed;
 240
 241 /**
 242  * struct brcmf_event - contents of broadcom event packet.
 243  *
 244  * @eth: standard ether header.
 245  * @hdr: broadcom specific ether header.
 246  * @msg: common part of the actual event message.
 247  */
 248 struct brcmf_event {
 249         struct ethhdr eth;
 250         struct brcm_ethhdr hdr;
 251         struct brcmf_event_msg_be msg;
 252 } __packed;
 253
 254 /**
 255  * struct brcmf_event_msg - firmware event message.
 256  *
 257  * @version: version information.
 258  * @flags: event flags.
 259  * @event_code: firmware event code.
 260  * @status: status information.
 261  * @reason: reason code.
 262  * @auth_type: authentication type.
 263  * @datalen: length of event data buffer.
 264  * @addr: ether address.
 265  * @ifname: interface name.
 266  * @ifidx: interface index.
 267  * @bsscfgidx: bsscfg index.
 268  */
 269 struct brcmf_event_msg {
 270         u16 version;
 271         u16 flags;
 272         u32 event_code;
 273         u32 status;
 274         u32 reason;
 275         s32 auth_type;
 276         u32 datalen;
 277         u8 addr[ETH_ALEN];
 278         char ifname[IFNAMSIZ];
 279         u8 ifidx;
 280         u8 bsscfgidx;
 281 };
 282
 283 struct brcmf_if_event {
 284         u8 ifidx;
 285         u8 action;
 286         u8 flags;
 287         u8 bsscfgidx;
 288         u8 role;
 289 };
 290
 291 enum event_msgs_ext_command {
 292         EVENTMSGS_NONE          =       0,
 293         EVENTMSGS_SET_BIT       =       1,
 294         EVENTMSGS_RESET_BIT     =       2,
 295         EVENTMSGS_SET_MASK      =       3
 296 };
 297
 298 #define EVENTMSGS_VER 1
 299 #define EVENTMSGS_EXT_STRUCT_SIZE       offsetof(struct eventmsgs_ext, mask[0])
 300
 301 /* len- for SET it would be mask size from the application to the firmware */
 302 /*              for GET it would be actual firmware mask size */
 303 /* maxgetsize - is only used for GET. indicate max mask size that the */
 304 /*                              application can read from the firmware */
 305 struct eventmsgs_ext {
 306         u8      ver;
 307         u8      command;
 308         u8      len;
 309         u8      maxgetsize;
 310         u8      mask[1];
 311 };
 312
 313 typedef int (*brcmf_fweh_handler_t)(struct brcmf_if *ifp,
 314                                     const struct brcmf_event_msg *evtmsg,
 315                                     void *data);
 316
 317 /**
 318  * struct brcmf_fweh_info - firmware event handling information.
 319  *
 320  * @p2pdev_setup_ongoing: P2P device creation in progress.
 321  * @event_work: event worker.
 322  * @evt_q_lock: lock for event queue protection.
 323  * @event_q: event queue.
 324  * @evt_handler: registered event handlers.
 325  */
 326 struct brcmf_fweh_info {
 327         bool p2pdev_setup_ongoing;
 328         struct work_struct event_work;
 329         spinlock_t evt_q_lock;
 330         struct list_head event_q;
 331         int (*evt_handler[BRCMF_E_LAST])(struct brcmf_if *ifp,
 332                                          const struct brcmf_event_msg *evtmsg,
 333                                          void *data);
 334 };
 335
 336 const char *brcmf_fweh_event_name(enum brcmf_fweh_event_code code);
 337
 338 void brcmf_fweh_attach(struct brcmf_pub *drvr);
 339 void brcmf_fweh_detach(struct brcmf_pub *drvr);
 340 int brcmf_fweh_register(struct brcmf_pub *drvr, enum brcmf_fweh_event_code code,
 341                         int (*handler)(struct brcmf_if *ifp,
 342                                        const struct brcmf_event_msg *evtmsg,
 343                                        void *data));
 344 void brcmf_fweh_unregister(struct brcmf_pub *drvr,
 345                            enum brcmf_fweh_event_code code);
 346 int brcmf_fweh_activate_events(struct brcmf_if *ifp);
 347 void brcmf_fweh_process_event(struct brcmf_pub *drvr,
 348                               struct brcmf_event *event_packet,
 349                               u32 packet_len, gfp_t gfp);
 350 void brcmf_fweh_p2pdev_setup(struct brcmf_if *ifp, bool ongoing);
 351
 352 static inline void brcmf_fweh_process_skb(struct brcmf_pub *drvr,
 353                                           struct sk_buff *skb, u16 stype,
 354                                           gfp_t gfp)
 355 {
 356         struct brcmf_event *event_packet;
 357         u16 subtype, usr_stype;
 358
 359         /* only process events when protocol matches */
 360         if (skb->protocol != cpu_to_be16(ETH_P_LINK_CTL))
 361                 return;
 362
 363         if ((skb->len + ETH_HLEN) < sizeof(*event_packet))
 364                 return;
 365
 366         event_packet = (struct brcmf_event *)skb_mac_header(skb);
 367
 368         /* check subtype if needed */
 369         if (unlikely(stype)) {
 370                 subtype = get_unaligned_be16(&event_packet->hdr.subtype);
 371                 if (subtype != stype)
 372                         return;
 373         }
 374
 375         /* check for BRCM oui match */
 376         if (memcmp(BRCM_OUI, &event_packet->hdr.oui[0],
 377                    sizeof(event_packet->hdr.oui)))
 378                 return;
 379
 380         /* final match on usr_subtype */
 381         usr_stype = get_unaligned_be16(&event_packet->hdr.usr_subtype);
 382         if (usr_stype != BCMILCP_BCM_SUBTYPE_EVENT)
 383                 return;
 384
 385         brcmf_fweh_process_event(drvr, event_packet, skb->len + ETH_HLEN, gfp);
 386 }
 387
 388 #endif /* FWEH_H_ */