2 * carl9170 firmware - used by the ar9170 wireless device
4 * Firmware context definition
6 * Copyright 2009, 2010 Christian Lamparter <chunkeey@googlemail.com>
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.
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.
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.
23 #ifndef __CARL9170FW_CARL9170_H
24 #define __CARL9170FW_CARL9170_H
26 #include "generated/autoconf.h"
37 struct carl9170_bar_ctx {
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),
51 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
53 enum carl9170_ep0_action {
54 CARL9170_EP0_NO_ACTION = 0,
55 CARL9170_EP0_STALL = BIT(0),
56 CARL9170_EP0_TRIGGER = BIT(1),
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,
67 * This platform - being an odd 32-bit architecture - prefers to
68 * have 32-Bit variables.
71 struct firmware_context_struct {
73 unsigned int ticks_per_msec;
74 unsigned int counter; /* main() cycles */
77 unsigned int watchdog_enable;
81 /* Host Interface DMA queues */
82 struct dma_queue up_queue; /* used to send frames to the host */
83 struct dma_queue down_queue; /* stores incoming frames from the host */
87 /* Hardware DMA queues */
88 struct dma_queue tx_queue[__AR9170_NUM_TX_QUEUES]; /* wlan tx queue */
89 struct dma_queue rx_queue; /* wlan rx queue */
91 #ifdef CONFIG_CARL9170FW_DELAYED_TX
92 struct dma_queue tx_delay[__AR9170_NUM_TX_QUEUES];
93 struct dma_queue tx_retry;
94 unsigned int tx_trigger;
95 #endif /* CONFIG_CARL9170FW_DELAYED_TX */
97 /* Hardware DMA queue unstuck/fix detection */
98 unsigned int last_tx_desc_num[__AR9170_NUM_TX_QUEUES];
99 struct dma_desc *last_tx_desc[__AR9170_NUM_TX_QUEUES];
100 unsigned int mac_reset;
101 unsigned int soft_int;
104 unsigned int rx_filter;
107 unsigned int rx_total;
108 unsigned int rx_overruns;
110 #ifdef CONFIG_CARL9170FW_TX_AMPDU
111 /* tx aggregate scheduling */
112 struct carl9170_tx_superframe *ampdu_prev[__AR9170_NUM_TX_QUEUES];
113 #endif /* CONFIG_CARL9170FW_TX_AMPDU */
115 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
117 struct dma_queue cab_queue[CARL9170_INTF_NUM];
118 unsigned int cab_queue_len[CARL9170_INTF_NUM];
119 unsigned int cab_flush_time;
120 enum carl9170_cab_trigger cab_flush_trigger[CARL9170_INTF_NUM];
121 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
124 unsigned int tx_status_pending,
127 struct carl9170_tx_status tx_status_cache[CARL9170_TX_STATUS_NUM];
129 #ifdef CONFIG_CARL9170FW_HANDLE_BACK_REQ
130 /* BA(R) Request Handler */
131 struct dma_desc *ba_desc;
132 struct carl9170_bar_ctx ba_cache[CONFIG_CARL9170FW_BACK_REQS_NUM];
133 unsigned int ba_desc_available,
136 #endif /* CONFIG_CARL9170FW_HANDLE_BACK_REQ */
142 alternate_interface_setting;
143 enum carl9170_ep0_action ep0_action;
145 void *ep0_txrx_buffer;
146 unsigned int ep0_txrx_len,
149 struct ar9170_usb_config *cfg_desc;
150 struct ar9170_usb_config *os_cfg_desc;
153 * special buffers for command & response handling
155 * the firmware uses a sort of ring-buffer to communicate
158 unsigned int int_pending,
162 struct dma_desc *int_desc;
163 struct carl9170_rsp int_buf[CARL9170_INT_RQ_CACHES];
165 #ifdef CONFIG_CARL9170FW_DEBUG_USB
167 unsigned int put_index;
168 uint8_t put_buffer[CARL9170_MAX_CMD_PAYLOAD_LEN];
169 #endif /* CONFIG_CARL9170FW_DEBUG_USB */
174 #ifdef CONFIG_CARL9170FW_RADIO_FUNCTIONS
175 /* (cached) ar9170_rf_init */
178 unsigned int frequency;
179 unsigned int ht_settings;
181 #ifdef CONFIG_CARL9170FW_PSM
182 struct carl9170_psm psm;
183 #endif /* CONFIG_CARL9170FW_PSM */
184 #endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
187 #ifdef CONFIG_CARL9170FW_GPIO_INTERRUPT
188 struct carl9170_gpio cached_gpio_state;
189 #endif /*CONFIG_CARL9170FW_GPIO_INTERRUPT */
193 * global firmware context struct.
195 * NOTE: This struct will zeroed out in start()
197 extern struct firmware_context_struct fw;
198 #endif /* __CARL9170FW_CARL9170_H */