drivers/net/wireless/wl12xx/wl1271_event.h

   1 /*
   2  * This file is part of wl1271
   3  *
   4  * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
   5  * Copyright (C) 2008-2009 Nokia Corporation
   6  *
   7  * Contact: Luciano Coelho <luciano.coelho@nokia.com>
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * version 2 as published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  *
  23  */
  24
  25 #ifndef __WL1271_EVENT_H__
  26 #define __WL1271_EVENT_H__
  27
  28 /*
  29  * Mbox events
  30  *
  31  * The event mechanism is based on a pair of event buffers (buffers A and
  32  * B) at fixed locations in the target's memory. The host processes one
  33  * buffer while the other buffer continues to collect events. If the host
  34  * is not processing events, an interrupt is issued to signal that a buffer
  35  * is ready. Once the host is done with processing events from one buffer,
  36  * it signals the target (with an ACK interrupt) that the event buffer is
  37  * free.
  38  */
  39
  40 enum {
  41         MEASUREMENT_START_EVENT_ID               = BIT(8),
  42         MEASUREMENT_COMPLETE_EVENT_ID            = BIT(9),
  43         SCAN_COMPLETE_EVENT_ID                   = BIT(10),
  44         SCHEDULED_SCAN_COMPLETE_EVENT_ID         = BIT(11),
  45         AP_DISCOVERY_COMPLETE_EVENT_ID           = BIT(12),
  46         PS_REPORT_EVENT_ID                       = BIT(13),
  47         PSPOLL_DELIVERY_FAILURE_EVENT_ID         = BIT(14),
  48         DISCONNECT_EVENT_COMPLETE_ID             = BIT(15),
  49         JOIN_EVENT_COMPLETE_ID                   = BIT(16),
  50         CHANNEL_SWITCH_COMPLETE_EVENT_ID         = BIT(17),
  51         BSS_LOSE_EVENT_ID                        = BIT(18),
  52         REGAINED_BSS_EVENT_ID                    = BIT(19),
  53         ROAMING_TRIGGER_MAX_TX_RETRY_EVENT_ID    = BIT(20),
  54         SOFT_GEMINI_SENSE_EVENT_ID               = BIT(22),
  55         SOFT_GEMINI_PREDICTION_EVENT_ID          = BIT(23),
  56         SOFT_GEMINI_AVALANCHE_EVENT_ID           = BIT(24),
  57         PLT_RX_CALIBRATION_COMPLETE_EVENT_ID     = BIT(25),
  58         DBG_EVENT_ID                             = BIT(26),
  59         HEALTH_CHECK_REPLY_EVENT_ID              = BIT(27),
  60         PERIODIC_SCAN_COMPLETE_EVENT_ID          = BIT(28),
  61         PERIODIC_SCAN_REPORT_EVENT_ID            = BIT(29),
  62         BA_SESSION_TEAR_DOWN_EVENT_ID            = BIT(30),
  63         EVENT_MBOX_ALL_EVENT_ID                  = 0x7fffffff,
  64 };
  65
  66 enum {
  67         EVENT_ENTER_POWER_SAVE_FAIL = 0,
  68         EVENT_ENTER_POWER_SAVE_SUCCESS,
  69         EVENT_EXIT_POWER_SAVE_FAIL,
  70         EVENT_EXIT_POWER_SAVE_SUCCESS,
  71 };
  72
  73 struct event_debug_report {
  74         u8 debug_event_id;
  75         u8 num_params;
  76         __le16 pad;
  77         __le32 report_1;
  78         __le32 report_2;
  79         __le32 report_3;
  80 } __attribute__ ((packed));
  81
  82 #define NUM_OF_RSSI_SNR_TRIGGERS 8
  83
  84 struct event_mailbox {
  85         __le32 events_vector;
  86         __le32 events_mask;
  87         __le32 reserved_1;
  88         __le32 reserved_2;
  89
  90         u8 dbg_event_id;
  91         u8 num_relevant_params;
  92         __le16 reserved_3;
  93         __le32 event_report_p1;
  94         __le32 event_report_p2;
  95         __le32 event_report_p3;
  96
  97         u8 number_of_scan_results;
  98         u8 scan_tag;
  99         u8 reserved_4[2];
 100         __le32 compl_scheduled_scan_status;
 101
 102         __le16 scheduled_scan_attended_channels;
 103         u8 soft_gemini_sense_info;
 104         u8 soft_gemini_protective_info;
 105         s8 rssi_snr_trigger_metric[NUM_OF_RSSI_SNR_TRIGGERS];
 106         u8 channel_switch_status;
 107         u8 scheduled_scan_status;
 108         u8 ps_status;
 109
 110         u8 reserved_5[29];
 111 } __attribute__ ((packed));
 112
 113 int wl1271_event_unmask(struct wl1271 *wl);
 114 void wl1271_event_mbox_config(struct wl1271 *wl);
 115 int wl1271_event_handle(struct wl1271 *wl, u8 mbox, bool do_ack);
 116
 117 #endif