carl9170 firmware: initial WoWLAN support

[carl9170fw.git] / carlfw / include / carl9170.h

diff --git a/carlfw/include/carl9170.h b/carlfw/include/carl9170.h
index 6c19c32d742ca333d6830216a3a6e9e721f2e10c..4b0738d651a3fd0bdc93552284c3ed4e63652b85 100644 (file)
--- a/carlfw/include/carl9170.h
+++ b/carlfw/include/carl9170.h
@@ -3,7 +3,7 @@
  *
  * Firmware context definition
  *
- * Copyright 2009, 2010 Christian Lamparter <chunkeey@googlemail.com>
+ * Copyright 2009-2011 Christian Lamparter <chunkeey@googlemail.com>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -63,6 +63,14 @@ enum carl9170_mac_reset_state {
        CARL9170_MAC_RESET_FORCE,
 };
 
+enum carl9170_suspend_mode {
+       CARL9170_HOST_AWAKE                     = 0,
+       CARL9170_HOST_SUSPENDED,
+       CARL9170_AWAKE_HOST,
+};
+
+typedef void (*fw_desc_callback_t)(void *, const bool);
+
 /*
  * This platform - being an odd 32-bit architecture - prefers to
  * have 32-Bit variables.
@@ -70,11 +78,13 @@ enum carl9170_mac_reset_state {
 
 struct firmware_context_struct {
        /* timer / clocks */
-       unsigned int bogoclock;                 /* supposed to be CPU clock in KHz */
+       unsigned int ticks_per_msec;
        unsigned int counter;                   /* main() cycles */
 
        /* misc */
        unsigned int watchdog_enable;
+       unsigned int reboot;
+       unsigned int suspend_mode;
 
        struct {
                /* Host Interface DMA queues */
@@ -85,27 +95,34 @@ struct firmware_context_struct {
        struct {
                /* Hardware DMA queues */
                struct dma_queue tx_queue[__AR9170_NUM_TX_QUEUES];      /* wlan tx queue */
+               struct dma_queue tx_retry;
                struct dma_queue rx_queue;                              /* wlan rx queue */
 
-#ifdef CONFIG_CARL9170FW_DELAYED_TX
-               struct dma_queue tx_delay[__AR9170_NUM_TX_QUEUES];
-               struct dma_queue tx_retry;
-               unsigned int tx_trigger;
-#endif /* CONFIG_CARL9170FW_DELAYED_TX */
+               /* tx aggregate scheduling */
+               struct carl9170_tx_superframe *ampdu_prev[__AR9170_NUM_TX_QUEUES];
 
                /* Hardware DMA queue unstuck/fix detection */
-               unsigned int last_tx_desc_num[__AR9170_NUM_TX_QUEUES];
-               struct dma_desc *last_tx_desc[__AR9170_NUM_TX_QUEUES];
+               unsigned int last_super_num[__AR9170_NUM_TX_QUEUES];
+               struct carl9170_tx_superframe *last_super[__AR9170_NUM_TX_QUEUES];
+               unsigned int mac_reset;
+               unsigned int soft_int;
+
+               /* rx filter */
+               unsigned int rx_filter;
+
+               /* rx statistics */
                unsigned int rx_total;
                unsigned int rx_overruns;
-               unsigned int mac_reset;
+
+               /* tx sequence control counters */
+               unsigned int sequence[CARL9170_INTF_NUM];
 
 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
                /* CAB */
-               struct dma_queue cab_queue;
-               unsigned int cab_queue_len,
-                            cab_flush_time;
-               enum carl9170_cab_trigger cab_flush_trigger;
+               struct dma_queue cab_queue[CARL9170_INTF_NUM];
+               unsigned int cab_queue_len[CARL9170_INTF_NUM];
+               unsigned int cab_flush_time;
+               enum carl9170_cab_trigger cab_flush_trigger[CARL9170_INTF_NUM];
 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
 
                /* tx status */
@@ -114,20 +131,33 @@ struct firmware_context_struct {
                             tx_status_tail_idx;
                struct carl9170_tx_status tx_status_cache[CARL9170_TX_STATUS_NUM];
 
-#ifdef CONFIG_CARL9170FW_HANDLE_BACK_REQ
+               /* internal descriptor for use within the service routines */
+               struct dma_desc *fw_desc;
+               unsigned int fw_desc_available;
+               void *fw_desc_data;
+               fw_desc_callback_t fw_desc_callback;
+
                /* BA(R) Request Handler */
-               struct dma_desc *ba_desc;
                struct carl9170_bar_ctx ba_cache[CONFIG_CARL9170FW_BACK_REQS_NUM];
-               unsigned int ba_desc_available,
-                            ba_tail_idx,
+               unsigned int ba_tail_idx,
                             ba_head_idx;
-#endif /* CONFIG_CARL9170FW_HANDLE_BACK_REQ */
+
+#ifdef CONFIG_CARL9170FW_WOL
+               struct {
+                       struct carl9170_wol_cmd cmd;
+                       unsigned int last_beacon;
+                       unsigned int lost_null;
+                       unsigned int last_null;
+                       bool wake_up;
+               } wol;
+#endif /* CONFIG_CARL9170FW_WOL */
        } wlan;
 
        struct {
                unsigned int config,
                             interface_setting,
-                            alternate_interface_setting;
+                            alternate_interface_setting,
+                            device_feature;
                enum carl9170_ep0_action ep0_action;
 
                void *ep0_txrx_buffer;
@@ -156,9 +186,6 @@ struct firmware_context_struct {
                uint8_t put_buffer[CARL9170_MAX_CMD_PAYLOAD_LEN];
 #endif /* CONFIG_CARL9170FW_DEBUG_USB */
 
-#ifdef CONFIG_CARL9170FW_USB_WATCHDOG
-               struct carl9170_watchdog_cmd watchdog;
-#endif /* CONFIG CARL9170FW_USB_WATCHDOG */
        } usb;
 
        struct {
@@ -169,9 +196,7 @@ struct firmware_context_struct {
                unsigned int frequency;
                unsigned int ht_settings;
 
-#ifdef CONFIG_CARL9170FW_PSM
                struct carl9170_psm psm;
-#endif /* CONFIG_CARL9170FW_PSM */
 #endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
        } phy;