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