carlfw/include/carl9170.h

   1 /*
   2  * carl9170 firmware - used by the ar9170 wireless device
   3  *
   4  * Firmware context definition
   5  *
   6  * Copyright 2009-2011 Christian Lamparter <chunkeey@googlemail.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 #ifndef __CARL9170FW_CARL9170_H
  24 #define __CARL9170FW_CARL9170_H
  25
  26 #include "generated/autoconf.h"
  27 #include "version.h"
  28 #include "config.h"
  29 #include "types.h"
  30 #include "compiler.h"
  31 #include "fwcmd.h"
  32 #include "hw.h"
  33 #include "dma.h"
  34 #include "usb.h"
  35 #include "cmd.h"
  36
  37 struct carl9170_bar_ctx {
  38         uint8_t ta[6];
  39         uint8_t ra[6];
  40         __le16 start_seq_num;
  41         __le16 control;
  42 };
  43
  44 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
  45 enum carl9170_cab_trigger {
  46         CARL9170_CAB_TRIGGER_EMPTY      = 0,
  47         CARL9170_CAB_TRIGGER_ARMED      = BIT(0),
  48         CARL9170_CAB_TRIGGER_DEFER      = BIT(1),
  49 };
  50 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
  51
  52 enum carl9170_ep0_action {
  53         CARL9170_EP0_NO_ACTION          = 0,
  54         CARL9170_EP0_STALL              = BIT(0),
  55         CARL9170_EP0_TRIGGER            = BIT(1),
  56 };
  57
  58 enum carl9170_mac_reset_state {
  59         CARL9170_MAC_RESET_OFF          = 0,
  60         CARL9170_MAC_RESET_ARMED,
  61         CARL9170_MAC_RESET_RESET,
  62         CARL9170_MAC_RESET_FORCE,
  63 };
  64
  65 enum carl9170_suspend_mode {
  66         CARL9170_HOST_AWAKE                     = 0,
  67         CARL9170_HOST_SUSPENDED,
  68         CARL9170_AWAKE_HOST,
  69 };
  70
  71 enum carl9170_phy_state {
  72         CARL9170_PHY_OFF                = 0,
  73         CARL9170_PHY_ON
  74 };
  75
  76 typedef void (*fw_desc_callback_t)(void *, const bool);
  77
  78 /*
  79  * This platform - being an odd 32-bit architecture - prefers to
  80  * have 32-Bit variables.
  81  */
  82
  83 struct firmware_context_struct {
  84         /* timer / clocks */
  85         unsigned int ticks_per_usec;
  86         unsigned int counter;                   /* main() cycles */
  87
  88         /* misc */
  89         unsigned int watchdog_enable;
  90         unsigned int reboot;
  91         unsigned int suspend_mode;
  92
  93         struct {
  94                 /* Host Interface DMA queues */
  95                 struct dma_queue up_queue;      /* used to send frames to the host */
  96                 struct dma_queue down_queue;    /* stores incoming frames from the host */
  97         } pta;
  98
  99         struct {
 100                 /* Hardware DMA queues */
 101                 struct dma_queue tx_queue[__AR9170_NUM_TX_QUEUES];      /* wlan tx queue */
 102                 struct dma_queue tx_retry;
 103                 struct dma_queue rx_queue;                              /* wlan rx queue */
 104
 105                 /* tx aggregate scheduling */
 106                 struct carl9170_tx_superframe *ampdu_prev[__AR9170_NUM_TX_QUEUES];
 107
 108                 /* Hardware DMA queue unstuck/fix detection */
 109                 unsigned int last_super_num[__AR9170_NUM_TX_QUEUES];
 110                 struct carl9170_tx_superframe *last_super[__AR9170_NUM_TX_QUEUES];
 111                 unsigned int mac_reset;
 112                 unsigned int soft_int;
 113
 114                 /* rx filter */
 115                 unsigned int rx_filter;
 116
 117                 /* tx sequence control counters */
 118                 unsigned int sequence[CARL9170_INTF_NUM];
 119
 120 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
 121                 /* CAB */
 122                 struct dma_queue cab_queue[CARL9170_INTF_NUM];
 123                 unsigned int cab_queue_len[CARL9170_INTF_NUM];
 124                 unsigned int cab_flush_time;
 125                 enum carl9170_cab_trigger cab_flush_trigger[CARL9170_INTF_NUM];
 126 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
 127
 128                 /* tx status */
 129                 unsigned int tx_status_pending,
 130                              tx_status_head_idx,
 131                              tx_status_tail_idx;
 132                 struct carl9170_tx_status tx_status_cache[CARL9170_TX_STATUS_NUM];
 133
 134                 /* internal descriptor for use within the service routines */
 135                 struct dma_desc *fw_desc;
 136                 unsigned int fw_desc_available;
 137                 void *fw_desc_data;
 138                 fw_desc_callback_t fw_desc_callback;
 139
 140                 /* BA(R) Request Handler */
 141                 struct carl9170_bar_ctx ba_cache[CONFIG_CARL9170FW_BACK_REQS_NUM];
 142                 unsigned int ba_tail_idx,
 143                              ba_head_idx,
 144                              queued_ba;
 145         } wlan;
 146
 147         struct {
 148                 unsigned int config,
 149                              interface_setting,
 150                              alternate_interface_setting,
 151                              device_feature;
 152                 enum carl9170_ep0_action ep0_action;
 153
 154                 void *ep0_txrx_buffer;
 155                 unsigned int ep0_txrx_len,
 156                              ep0_txrx_pos;
 157
 158                 struct ar9170_usb_config *cfg_desc;
 159                 struct ar9170_usb_config *os_cfg_desc;
 160
 161                 /*
 162                  * special buffers for command & response handling
 163                  *
 164                  * the firmware uses a sort of ring-buffer to communicate
 165                  * to the host.
 166                  */
 167                 unsigned int int_pending,
 168                              int_desc_available,
 169                              int_head_index,
 170                              int_tail_index;
 171                 struct dma_desc *int_desc;
 172                 struct carl9170_rsp int_buf[CARL9170_INT_RQ_CACHES];
 173
 174 #ifdef CONFIG_CARL9170FW_DEBUG_USB
 175                 /* USB printf */
 176                 unsigned int put_index;
 177                 uint8_t put_buffer[CARL9170_MAX_CMD_PAYLOAD_LEN];
 178 #endif /* CONFIG_CARL9170FW_DEBUG_USB */
 179
 180         } usb;
 181
 182         struct {
 183 #ifdef CONFIG_CARL9170FW_RADIO_FUNCTIONS
 184                 /* (cached) ar9170_rf_init */
 185
 186                 /* PHY/RF state */
 187                 unsigned int frequency;
 188                 unsigned int ht_settings;
 189
 190                 enum carl9170_phy_state state;
 191                 struct carl9170_psm psm;
 192 #endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
 193         } phy;
 194
 195         unsigned int tally_clock;
 196         struct carl9170_tally_rsp tally;
 197         unsigned int tx_time;
 198
 199 #ifdef CONFIG_CARL9170FW_WOL
 200         struct {
 201                 struct carl9170_wol_cmd cmd;
 202                 unsigned int last_beacon;
 203                 unsigned int lost_null;
 204                 unsigned int last_null;
 205                 bool wake_up;
 206         } wol;
 207 #endif /* CONFIG_CARL9170FW_WOL */
 208
 209 #ifdef CONFIG_CARL9170FW_GPIO_INTERRUPT
 210         struct carl9170_gpio cached_gpio_state;
 211 #endif /*CONFIG_CARL9170FW_GPIO_INTERRUPT */
 212 };
 213
 214 /*
 215  * global firmware context struct.
 216  *
 217  * NOTE: This struct will zeroed out in start()
 218  */
 219 extern struct firmware_context_struct fw;
 220 #endif /* __CARL9170FW_CARL9170_H */