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         __le32 phy;
  43 };
  44
  45 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
  46 enum carl9170_cab_trigger {
  47         CARL9170_CAB_TRIGGER_EMPTY      = 0,
  48         CARL9170_CAB_TRIGGER_ARMED      = BIT(0),
  49         CARL9170_CAB_TRIGGER_DEFER      = BIT(1),
  50 };
  51 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
  52
  53 enum carl9170_ep0_action {
  54         CARL9170_EP0_NO_ACTION          = 0,
  55         CARL9170_EP0_STALL              = BIT(0),
  56         CARL9170_EP0_TRIGGER            = BIT(1),
  57 };
  58
  59 enum carl9170_mac_reset_state {
  60         CARL9170_MAC_RESET_OFF          = 0,
  61         CARL9170_MAC_RESET_ARMED,
  62         CARL9170_MAC_RESET_RESET,
  63         CARL9170_MAC_RESET_FORCE,
  64 };
  65
  66 enum carl9170_suspend_mode {
  67         CARL9170_HOST_AWAKE                     = 0,
  68         CARL9170_HOST_SUSPENDED,
  69         CARL9170_AWAKE_HOST,
  70 };
  71
  72 typedef void (*fw_desc_callback_t)(void *, const bool);
  73
  74 /*
  75  * This platform - being an odd 32-bit architecture - prefers to
  76  * have 32-Bit variables.
  77  */
  78
  79 struct firmware_context_struct {
  80         /* timer / clocks */
  81         unsigned int ticks_per_msec;
  82         unsigned int counter;                   /* main() cycles */
  83
  84         /* misc */
  85         unsigned int watchdog_enable;
  86         unsigned int reboot;
  87         unsigned int suspend_mode;
  88
  89         struct {
  90                 /* Host Interface DMA queues */
  91                 struct dma_queue up_queue;      /* used to send frames to the host */
  92                 struct dma_queue down_queue;    /* stores incoming frames from the host */
  93         } pta;
  94
  95         struct {
  96                 /* Hardware DMA queues */
  97                 struct dma_queue tx_queue[__AR9170_NUM_TX_QUEUES];      /* wlan tx queue */
  98                 struct dma_queue tx_retry;
  99                 struct dma_queue rx_queue;                              /* wlan rx queue */
 100
 101                 /* tx aggregate scheduling */
 102                 struct carl9170_tx_superframe *ampdu_prev[__AR9170_NUM_TX_QUEUES];
 103
 104                 /* Hardware DMA queue unstuck/fix detection */
 105                 unsigned int last_super_num[__AR9170_NUM_TX_QUEUES];
 106                 struct carl9170_tx_superframe *last_super[__AR9170_NUM_TX_QUEUES];
 107                 unsigned int mac_reset;
 108                 unsigned int soft_int;
 109
 110                 /* rx filter */
 111                 unsigned int rx_filter;
 112
 113                 /* rx statistics */
 114                 unsigned int rx_total;
 115                 unsigned int rx_overruns;
 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
 145 #ifdef CONFIG_CARL9170FW_WOL
 146                 struct {
 147                         struct carl9170_wol_cmd cmd;
 148                         unsigned int last_beacon;
 149                         unsigned int lost_null;
 150                         unsigned int last_null;
 151                         bool wake_up;
 152                 } wol;
 153 #endif /* CONFIG_CARL9170FW_WOL */
 154         } wlan;
 155
 156         struct {
 157                 unsigned int config,
 158                              interface_setting,
 159                              alternate_interface_setting,
 160                              device_feature;
 161                 enum carl9170_ep0_action ep0_action;
 162
 163                 void *ep0_txrx_buffer;
 164                 unsigned int ep0_txrx_len,
 165                              ep0_txrx_pos;
 166
 167                 struct ar9170_usb_config *cfg_desc;
 168                 struct ar9170_usb_config *os_cfg_desc;
 169
 170                 /*
 171                  * special buffers for command & response handling
 172                  *
 173                  * the firmware uses a sort of ring-buffer to communicate
 174                  * to the host.
 175                  */
 176                 unsigned int int_pending,
 177                              int_desc_available,
 178                              int_head_index,
 179                              int_tail_index;
 180                 struct dma_desc *int_desc;
 181                 struct carl9170_rsp int_buf[CARL9170_INT_RQ_CACHES];
 182
 183 #ifdef CONFIG_CARL9170FW_DEBUG_USB
 184                 /* USB printf */
 185                 unsigned int put_index;
 186                 uint8_t put_buffer[CARL9170_MAX_CMD_PAYLOAD_LEN];
 187 #endif /* CONFIG_CARL9170FW_DEBUG_USB */
 188
 189         } usb;
 190
 191         struct {
 192 #ifdef CONFIG_CARL9170FW_RADIO_FUNCTIONS
 193                 /* (cached) ar9170_rf_init */
 194
 195                 /* PHY/RF state */
 196                 unsigned int frequency;
 197                 unsigned int ht_settings;
 198
 199                 struct carl9170_psm psm;
 200 #endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
 201         } phy;
 202
 203 #ifdef CONFIG_CARL9170FW_GPIO_INTERRUPT
 204         struct carl9170_gpio cached_gpio_state;
 205 #endif /*CONFIG_CARL9170FW_GPIO_INTERRUPT */
 206 };
 207
 208 /*
 209  * global firmware context struct.
 210  *
 211  * NOTE: This struct will zeroed out in start()
 212  */
 213 extern struct firmware_context_struct fw;
 214 #endif /* __CARL9170FW_CARL9170_H */