package/broadcom-wl/src/wlc/include/proto/bcmevent.h

   1 /*
   2  * Broadcom Event  protocol definitions
   3  *
   4  * Copyright 2006, Broadcom Corporation
   5  * All Rights Reserved.
   6  *
   7  * THIS SOFTWARE IS OFFERED "AS IS", AND BROADCOM GRANTS NO WARRANTIES OF ANY
   8  * KIND, EXPRESS OR IMPLIED, BY STATUTE, COMMUNICATION OR OTHERWISE. BROADCOM
   9  * SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
  10  * FOR A SPECIFIC PURPOSE OR NONINFRINGEMENT CONCERNING THIS SOFTWARE.
  11  *
  12  *
  13  * Dependencies: proto/bcmeth.h
  14  *
  15  * $Id: bcmevent.h,v 1.1.1.3 2006/02/27 03:43:16 honor Exp $
  16  *
  17  */
  18
  19 /*
  20  * Broadcom Ethernet Events protocol defines
  21  *
  22  */
  23
  24 #ifndef _BCMEVENT_H_
  25 #define _BCMEVENT_H_
  26
  27 /* enable structure packing */
  28 #if defined(__GNUC__)
  29 #define PACKED  __attribute__((packed))
  30 #else
  31 #pragma pack(1)
  32 #define PACKED
  33 #endif /* defined(__GNUC__) */
  34
  35 #define BCM_EVENT_MSG_VERSION           1       /* wl_event_msg_t struct version */
  36 #define BCM_MSG_IFNAME_MAX              16      /* max length of interface name */
  37
  38 /* flags */
  39 #define WLC_EVENT_MSG_LINK              0x01    /* link is up */
  40 #define WLC_EVENT_MSG_FLUSHTXQ          0x02    /* flush tx queue on MIC error */
  41 #define WLC_EVENT_MSG_GROUP             0x04    /* group MIC error */
  42
  43 /* theses fields are stored in network order */
  44 typedef struct
  45 {
  46         uint16  version;
  47         uint16  flags;                  /* see flags below */
  48         uint32  event_type;             /* Message (see below) */
  49         uint32  status;                 /* Status code (see below) */
  50         uint32  reason;                 /* Reason code (if applicable) */
  51         uint32  auth_type;              /* WLC_E_AUTH */
  52         uint32  datalen;                /* data buf */
  53         struct ether_addr       addr;   /* Station address (if applicable) */
  54         char    ifname[BCM_MSG_IFNAME_MAX]; /* name of the packet incoming interface */
  55 } PACKED wl_event_msg_t;
  56
  57 /* used by driver msgs */
  58 typedef struct bcm_event {
  59         struct ether_header eth;
  60         bcmeth_hdr_t            bcm_hdr;
  61         wl_event_msg_t          event;
  62         /* data portion follows */
  63 } PACKED bcm_event_t;
  64
  65 #define BCM_MSG_LEN     (sizeof(bcm_event_t) - sizeof(bcmeth_hdr_t) - sizeof(struct ether_header))
  66
  67 /* Event messages */
  68 #define WLC_E_SET_SSID          0       /* indicates status of set SSID */
  69 #define WLC_E_JOIN              1       /* differentiates join IBSS from found (WLC_E_START) IBSS */
  70 #define WLC_E_START             2       /* STA founded an IBSS or AP started a BSS */
  71 #define WLC_E_AUTH              3       /* 802.11 AUTH request */
  72 #define WLC_E_AUTH_IND          4       /* 802.11 AUTH indication */
  73 #define WLC_E_DEAUTH            5       /* 802.11 DEAUTH request */
  74 #define WLC_E_DEAUTH_IND        6       /* 802.11 DEAUTH indication */
  75 #define WLC_E_ASSOC             7       /* 802.11 ASSOC request */
  76 #define WLC_E_ASSOC_IND         8       /* 802.11 ASSOC indication */
  77 #define WLC_E_REASSOC           9       /* 802.11 REASSOC request */
  78 #define WLC_E_REASSOC_IND       10      /* 802.11 REASSOC indication */
  79 #define WLC_E_DISASSOC          11      /* 802.11 DISASSOC request */
  80 #define WLC_E_DISASSOC_IND      12      /* 802.11 DISASSOC indication */
  81 #define WLC_E_QUIET_START       13      /* 802.11h Quiet period started */
  82 #define WLC_E_QUIET_END         14      /* 802.11h Quiet period ended */
  83 #define WLC_E_BEACON_RX         15      /* BEACONS received/lost indication */
  84 #define WLC_E_LINK              16      /* generic link indication */
  85 #define WLC_E_MIC_ERROR         17      /* TKIP MIC error occurred */
  86 #define WLC_E_NDIS_LINK         18      /* NDIS style link indication */
  87 #define WLC_E_ROAM              19      /* roam attempt occurred: indicate status & reason */
  88 #define WLC_E_TXFAIL            20      /* change in dot11FailedCount (txfail) */
  89 #define WLC_E_PMKID_CACHE       21      /* WPA2 pmkid cache indication */
  90 #define WLC_E_RETROGRADE_TSF    22      /* current AP's TSF value went backward */
  91 #define WLC_E_PRUNE             23      /* AP was pruned from join list for reason */
  92 #define WLC_E_AUTOAUTH          24      /* report AutoAuth table entry match for join attempt */
  93 #define WLC_E_EAPOL_MSG         25      /* Event encapsulating an EAPOL message */
  94 #define WLC_E_SCAN_COMPLETE     26      /* Scan results are ready or scan was aborted */
  95 #define WLC_E_ADDTS_IND         27      /* indicate to host addts fail/success */
  96 #define WLC_E_DELTS_IND         28      /* indicate to host delts fail/success */
  97 #define WLC_E_BCNSENT_IND       29      /* indicate to host of beacon transmit */
  98 #define WLC_E_BCNRX_MSG         30      /* Send the received beacon up to the host */
  99 #define WLC_E_LAST              31      /* highest val + 1 for range checking */
 100
 101 /* Event status codes */
 102 #define WLC_E_STATUS_SUCCESS            0       /* operation was successful */
 103 #define WLC_E_STATUS_FAIL               1       /* operation failed */
 104 #define WLC_E_STATUS_TIMEOUT            2       /* operation timed out */
 105 #define WLC_E_STATUS_NO_NETWORKS        3       /* failed due to no matching network found */
 106 #define WLC_E_STATUS_ABORT              4       /* operation was aborted */
 107 #define WLC_E_STATUS_NO_ACK             5       /* protocol failure: packet not ack'd */
 108 #define WLC_E_STATUS_UNSOLICITED        6       /* AUTH or ASSOC packet was unsolicited */
 109 #define WLC_E_STATUS_ATTEMPT            7       /* attempt to assoc to an auto auth configuration */
 110
 111 /* roam reason codes */
 112 #define WLC_E_REASON_INITIAL_ASSOC      0       /* initial assoc */
 113 #define WLC_E_REASON_LOW_RSSI           1       /* roamed due to low RSSI */
 114 #define WLC_E_REASON_DEAUTH             2       /* roamed due to DEAUTH indication */
 115 #define WLC_E_REASON_DISASSOC           3       /* roamed due to DISASSOC indication */
 116 #define WLC_E_REASON_BCNS_LOST          4       /* roamed due to lost beacons */
 117 #define WLC_E_REASON_FAST_ROAM_FAILED   5       /* roamed due to fast roam failure */
 118 #define WLC_E_REASON_DIRECTED_ROAM      6       /* roamed due to request by AP */
 119 #define WLC_E_REASON_TSPEC_REJECTED     7       /* roamed due to TSPEC rejection */
 120 #define WLC_E_REASON_BETTER_AP          8       /* roamed due to finding better AP */
 121
 122 /* prune reason codes */
 123 #define WLC_E_PRUNE_ENCR_MISMATCH       1       /* ecryption mismatch */
 124 #define WLC_E_PRUNE_BCAST_BSSID         2       /* AP uses a broadcast BSSID */
 125 #define WLC_E_PRUNE_MAC_DENY            3       /* STA's MAC addr is in AP's MAC deny list */
 126 #define WLC_E_PRUNE_MAC_NA              4       /* STA's MAC addr is not in AP's MAC allow list */
 127 #define WLC_E_PRUNE_REG_PASSV           5       /* AP not allowed due to regulatory restriction */
 128 #define WLC_E_PRUNE_SPCT_MGMT           6       /* AP does not support STA locale spectrum mgmt */
 129 #define WLC_E_PRUNE_RADAR               7       /* AP is on a radar channel of STA locale */
 130 #define WLC_E_RSN_MISMATCH              8       /* STA does not support AP's RSN */
 131 #define WLC_E_PRUNE_NO_COMMON_RATES     9       /* No rates in common with AP */
 132 #define WLC_E_PRUNE_BASIC_RATES         10      /* STA does not support all basic rates of BSS */
 133 #define WLC_E_PRUNE_CCXFAST_PREVAP      11      /* CCX FAST ROAM: prune previous AP */
 134 #define WLC_E_PRUNE_CIPHER_NA           12      /* BSS's cipher not supported */
 135 #define WLC_E_PRUNE_KNOWN_STA           13      /* AP is already known to us as a STA */
 136 #define WLC_E_PRUNE_CCXFAST_DROAM       14      /* CCX FAST ROAM: prune unqulified AP */
 137 #define WLC_E_PRUNE_WDS_PEER            15      /* AP is already known to us as a WDS peer */
 138 #define WLC_E_PRUNE_QBSS_LOAD           16      /* QBSS LOAD - AAC is too low */
 139 #define WLC_E_PRUNE_HOME_AP             17      /* prune home AP */
 140
 141 /* WLC_SET_CALLBACK data type */
 142 typedef struct wlc_event_cb {
 143         void (*fn)(void *, bcm_event_t *);      /* Callback function */
 144         void *context;                          /* Passed to callback function */
 145 } wlc_event_cb_t;
 146
 147 #undef PACKED
 148 #if !defined(__GNUC__)
 149 #pragma pack()
 150 #endif /* PACKED */
 151
 152 #endif /* _BCMEVENT_H_ */