fweh.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  1. /*
  2. * Copyright (c) 2012 Broadcom Corporation
  3. *
  4. * Permission to use, copy, modify, and/or distribute this software for any
  5. * purpose with or without fee is hereby granted, provided that the above
  6. * copyright notice and this permission notice appear in all copies.
  7. *
  8. * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  9. * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10. * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  11. * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12. * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
  13. * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  14. * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15. */
  16. #ifndef FWEH_H_
  17. #define FWEH_H_
  18. #include <asm/unaligned.h>
  19. #include <linux/skbuff.h>
  20. #include <linux/if_ether.h>
  21. #include <linux/if.h>
  22. /* formward declarations */
  23. struct brcmf_pub;
  24. struct brcmf_if;
  25. struct brcmf_cfg80211_info;
  26. struct brcmf_event;
  27. /* list of firmware events */
  28. #define BRCMF_FWEH_EVENT_ENUM_DEFLIST \
  29. BRCMF_ENUM_DEF(SET_SSID, 0) \
  30. BRCMF_ENUM_DEF(JOIN, 1) \
  31. BRCMF_ENUM_DEF(START, 2) \
  32. BRCMF_ENUM_DEF(AUTH, 3) \
  33. BRCMF_ENUM_DEF(AUTH_IND, 4) \
  34. BRCMF_ENUM_DEF(DEAUTH, 5) \
  35. BRCMF_ENUM_DEF(DEAUTH_IND, 6) \
  36. BRCMF_ENUM_DEF(ASSOC, 7) \
  37. BRCMF_ENUM_DEF(ASSOC_IND, 8) \
  38. BRCMF_ENUM_DEF(REASSOC, 9) \
  39. BRCMF_ENUM_DEF(REASSOC_IND, 10) \
  40. BRCMF_ENUM_DEF(DISASSOC, 11) \
  41. BRCMF_ENUM_DEF(DISASSOC_IND, 12) \
  42. BRCMF_ENUM_DEF(QUIET_START, 13) \
  43. BRCMF_ENUM_DEF(QUIET_END, 14) \
  44. BRCMF_ENUM_DEF(BEACON_RX, 15) \
  45. BRCMF_ENUM_DEF(LINK, 16) \
  46. BRCMF_ENUM_DEF(MIC_ERROR, 17) \
  47. BRCMF_ENUM_DEF(NDIS_LINK, 18) \
  48. BRCMF_ENUM_DEF(ROAM, 19) \
  49. BRCMF_ENUM_DEF(TXFAIL, 20) \
  50. BRCMF_ENUM_DEF(PMKID_CACHE, 21) \
  51. BRCMF_ENUM_DEF(RETROGRADE_TSF, 22) \
  52. BRCMF_ENUM_DEF(PRUNE, 23) \
  53. BRCMF_ENUM_DEF(AUTOAUTH, 24) \
  54. BRCMF_ENUM_DEF(EAPOL_MSG, 25) \
  55. BRCMF_ENUM_DEF(SCAN_COMPLETE, 26) \
  56. BRCMF_ENUM_DEF(ADDTS_IND, 27) \
  57. BRCMF_ENUM_DEF(DELTS_IND, 28) \
  58. BRCMF_ENUM_DEF(BCNSENT_IND, 29) \
  59. BRCMF_ENUM_DEF(BCNRX_MSG, 30) \
  60. BRCMF_ENUM_DEF(BCNLOST_MSG, 31) \
  61. BRCMF_ENUM_DEF(ROAM_PREP, 32) \
  62. BRCMF_ENUM_DEF(PFN_NET_FOUND, 33) \
  63. BRCMF_ENUM_DEF(PFN_NET_LOST, 34) \
  64. BRCMF_ENUM_DEF(RESET_COMPLETE, 35) \
  65. BRCMF_ENUM_DEF(JOIN_START, 36) \
  66. BRCMF_ENUM_DEF(ROAM_START, 37) \
  67. BRCMF_ENUM_DEF(ASSOC_START, 38) \
  68. BRCMF_ENUM_DEF(IBSS_ASSOC, 39) \
  69. BRCMF_ENUM_DEF(RADIO, 40) \
  70. BRCMF_ENUM_DEF(PSM_WATCHDOG, 41) \
  71. BRCMF_ENUM_DEF(PROBREQ_MSG, 44) \
  72. BRCMF_ENUM_DEF(SCAN_CONFIRM_IND, 45) \
  73. BRCMF_ENUM_DEF(PSK_SUP, 46) \
  74. BRCMF_ENUM_DEF(COUNTRY_CODE_CHANGED, 47) \
  75. BRCMF_ENUM_DEF(EXCEEDED_MEDIUM_TIME, 48) \
  76. BRCMF_ENUM_DEF(ICV_ERROR, 49) \
  77. BRCMF_ENUM_DEF(UNICAST_DECODE_ERROR, 50) \
  78. BRCMF_ENUM_DEF(MULTICAST_DECODE_ERROR, 51) \
  79. BRCMF_ENUM_DEF(TRACE, 52) \
  80. BRCMF_ENUM_DEF(IF, 54) \
  81. BRCMF_ENUM_DEF(P2P_DISC_LISTEN_COMPLETE, 55) \
  82. BRCMF_ENUM_DEF(RSSI, 56) \
  83. BRCMF_ENUM_DEF(PFN_SCAN_COMPLETE, 57) \
  84. BRCMF_ENUM_DEF(EXTLOG_MSG, 58) \
  85. BRCMF_ENUM_DEF(ACTION_FRAME, 59) \
  86. BRCMF_ENUM_DEF(ACTION_FRAME_COMPLETE, 60) \
  87. BRCMF_ENUM_DEF(PRE_ASSOC_IND, 61) \
  88. BRCMF_ENUM_DEF(PRE_REASSOC_IND, 62) \
  89. BRCMF_ENUM_DEF(CHANNEL_ADOPTED, 63) \
  90. BRCMF_ENUM_DEF(AP_STARTED, 64) \
  91. BRCMF_ENUM_DEF(DFS_AP_STOP, 65) \
  92. BRCMF_ENUM_DEF(DFS_AP_RESUME, 66) \
  93. BRCMF_ENUM_DEF(ESCAN_RESULT, 69) \
  94. BRCMF_ENUM_DEF(ACTION_FRAME_OFF_CHAN_COMPLETE, 70) \
  95. BRCMF_ENUM_DEF(PROBERESP_MSG, 71) \
  96. BRCMF_ENUM_DEF(P2P_PROBEREQ_MSG, 72) \
  97. BRCMF_ENUM_DEF(DCS_REQUEST, 73) \
  98. BRCMF_ENUM_DEF(FIFO_CREDIT_MAP, 74) \
  99. BRCMF_ENUM_DEF(ACTION_FRAME_RX, 75) \
  100. BRCMF_ENUM_DEF(BCMC_CREDIT_SUPPORT, 127) \
  101. BRCMF_ENUM_DEF(PSTA_PRIMARY_INTF_IND, 128)
  102. #define BRCMF_ENUM_DEF(id, val) \
  103. BRCMF_E_##id = (val),
  104. /* firmware event codes sent by the dongle */
  105. enum brcmf_fweh_event_code {
  106. BRCMF_FWEH_EVENT_ENUM_DEFLIST
  107. BRCMF_E_LAST
  108. };
  109. #undef BRCMF_ENUM_DEF
  110. #define BRCMF_EVENTING_MASK_LEN DIV_ROUND_UP(BRCMF_E_LAST, 8)
  111. /* flags field values in struct brcmf_event_msg */
  112. #define BRCMF_EVENT_MSG_LINK 0x01
  113. #define BRCMF_EVENT_MSG_FLUSHTXQ 0x02
  114. #define BRCMF_EVENT_MSG_GROUP 0x04
  115. /**
  116. * definitions for event packet validation.
  117. */
  118. #define BRCMF_EVENT_OUI_OFFSET 19
  119. #define BRCM_OUI "\x00\x10\x18"
  120. #define DOT11_OUI_LEN 3
  121. #define BCMILCP_BCM_SUBTYPE_EVENT 1
  122. /**
  123. * struct brcmf_event_msg - firmware event message.
  124. *
  125. * @version: version information.
  126. * @flags: event flags.
  127. * @event_code: firmware event code.
  128. * @status: status information.
  129. * @reason: reason code.
  130. * @auth_type: authentication type.
  131. * @datalen: lenght of event data buffer.
  132. * @addr: ether address.
  133. * @ifname: interface name.
  134. * @ifidx: interface index.
  135. * @bsscfgidx: bsscfg index.
  136. */
  137. struct brcmf_event_msg {
  138. u16 version;
  139. u16 flags;
  140. u32 event_code;
  141. u32 status;
  142. u32 reason;
  143. s32 auth_type;
  144. u32 datalen;
  145. u8 addr[ETH_ALEN];
  146. char ifname[IFNAMSIZ];
  147. u8 ifidx;
  148. u8 bsscfgidx;
  149. };
  150. typedef int (*brcmf_fweh_handler_t)(struct brcmf_if *ifp,
  151. const struct brcmf_event_msg *evtmsg,
  152. void *data);
  153. /**
  154. * struct brcmf_fweh_info - firmware event handling information.
  155. *
  156. * @event_work: event worker.
  157. * @evt_q_lock: lock for event queue protection.
  158. * @event_q: event queue.
  159. * @evt_handler: registered event handlers.
  160. */
  161. struct brcmf_fweh_info {
  162. struct work_struct event_work;
  163. spinlock_t evt_q_lock;
  164. struct list_head event_q;
  165. int (*evt_handler[BRCMF_E_LAST])(struct brcmf_if *ifp,
  166. const struct brcmf_event_msg *evtmsg,
  167. void *data);
  168. };
  169. void brcmf_fweh_attach(struct brcmf_pub *drvr);
  170. void brcmf_fweh_detach(struct brcmf_pub *drvr);
  171. int brcmf_fweh_register(struct brcmf_pub *drvr, enum brcmf_fweh_event_code code,
  172. int (*handler)(struct brcmf_if *ifp,
  173. const struct brcmf_event_msg *evtmsg,
  174. void *data));
  175. void brcmf_fweh_unregister(struct brcmf_pub *drvr,
  176. enum brcmf_fweh_event_code code);
  177. int brcmf_fweh_activate_events(struct brcmf_if *ifp);
  178. void brcmf_fweh_process_event(struct brcmf_pub *drvr,
  179. struct brcmf_event *event_packet);
  180. static inline void brcmf_fweh_process_skb(struct brcmf_pub *drvr,
  181. struct sk_buff *skb)
  182. {
  183. struct brcmf_event *event_packet;
  184. u8 *data;
  185. u16 usr_stype;
  186. /* only process events when protocol matches */
  187. if (skb->protocol != cpu_to_be16(ETH_P_LINK_CTL))
  188. return;
  189. /* check for BRCM oui match */
  190. event_packet = (struct brcmf_event *)skb_mac_header(skb);
  191. data = (u8 *)event_packet;
  192. data += BRCMF_EVENT_OUI_OFFSET;
  193. if (memcmp(BRCM_OUI, data, DOT11_OUI_LEN))
  194. return;
  195. /* final match on usr_subtype */
  196. data += DOT11_OUI_LEN;
  197. usr_stype = get_unaligned_be16(data);
  198. if (usr_stype != BCMILCP_BCM_SUBTYPE_EVENT)
  199. return;
  200. brcmf_fweh_process_event(drvr, event_packet);
  201. }
  202. #endif /* FWEH_H_ */