2 * carl9170 firmware - used by the ar9170 wireless device
4 * Firmware context definition
6 * Copyright 2009-2011 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,
66 enum carl9170_suspend_mode {
67 CARL9170_HOST_AWAKE = 0,
68 CARL9170_HOST_SUSPENDED,
72 typedef void (*fw_desc_callback_t)(void *, const bool);
75 * This platform - being an odd 32-bit architecture - prefers to
76 * have 32-Bit variables.
79 struct firmware_context_struct {
81 unsigned int ticks_per_msec;
82 unsigned int counter; /* main() cycles */
85 unsigned int watchdog_enable;
87 unsigned int suspend_mode;
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 */
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 */
101 /* tx aggregate scheduling */
102 struct carl9170_tx_superframe *ampdu_prev[__AR9170_NUM_TX_QUEUES];
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;
111 unsigned int rx_filter;
114 unsigned int rx_total;
115 unsigned int rx_overruns;
117 /* tx sequence control counters */
118 unsigned int sequence[CARL9170_INTF_NUM];
120 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
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 */
129 unsigned int tx_status_pending,
132 struct carl9170_tx_status tx_status_cache[CARL9170_TX_STATUS_NUM];
134 /* internal descriptor for use within the service routines */
135 struct dma_desc *fw_desc;
136 unsigned int fw_desc_available;
138 fw_desc_callback_t fw_desc_callback;
140 /* BA(R) Request Handler */
141 struct carl9170_bar_ctx ba_cache[CONFIG_CARL9170FW_BACK_REQS_NUM];
142 unsigned int ba_tail_idx,
145 #ifdef CONFIG_CARL9170FW_WOL
147 struct carl9170_wol_cmd cmd;
148 unsigned int last_beacon;
149 unsigned int lost_null;
150 unsigned int last_null;
153 #endif /* CONFIG_CARL9170FW_WOL */
159 alternate_interface_setting,
161 enum carl9170_ep0_action ep0_action;
163 void *ep0_txrx_buffer;
164 unsigned int ep0_txrx_len,
167 struct ar9170_usb_config *cfg_desc;
168 struct ar9170_usb_config *os_cfg_desc;
171 * special buffers for command & response handling
173 * the firmware uses a sort of ring-buffer to communicate
176 unsigned int int_pending,
180 struct dma_desc *int_desc;
181 struct carl9170_rsp int_buf[CARL9170_INT_RQ_CACHES];
183 #ifdef CONFIG_CARL9170FW_DEBUG_USB
185 unsigned int put_index;
186 uint8_t put_buffer[CARL9170_MAX_CMD_PAYLOAD_LEN];
187 #endif /* CONFIG_CARL9170FW_DEBUG_USB */
192 #ifdef CONFIG_CARL9170FW_RADIO_FUNCTIONS
193 /* (cached) ar9170_rf_init */
196 unsigned int frequency;
197 unsigned int ht_settings;
199 struct carl9170_psm psm;
200 #endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
203 #ifdef CONFIG_CARL9170FW_GPIO_INTERRUPT
204 struct carl9170_gpio cached_gpio_state;
205 #endif /*CONFIG_CARL9170FW_GPIO_INTERRUPT */
209 * global firmware context struct.
211 * NOTE: This struct will zeroed out in start()
213 extern struct firmware_context_struct fw;
214 #endif /* __CARL9170FW_CARL9170_H */