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, see <http://www.gnu.org/licenses/>.
22 #ifndef __CARL9170FW_CARL9170_H
23 #define __CARL9170FW_CARL9170_H
25 #include "generated/autoconf.h"
36 struct carl9170_bar_ctx {
43 enum carl9170_cab_trigger {
44 CARL9170_CAB_TRIGGER_EMPTY = 0,
45 CARL9170_CAB_TRIGGER_ARMED = BIT(0),
46 CARL9170_CAB_TRIGGER_DEFER = BIT(1),
49 enum carl9170_ep0_action {
50 CARL9170_EP0_NO_ACTION = 0,
51 CARL9170_EP0_STALL = BIT(0),
52 CARL9170_EP0_TRIGGER = BIT(1),
55 enum carl9170_mac_reset_state {
56 CARL9170_MAC_RESET_OFF = 0,
57 CARL9170_MAC_RESET_ARMED,
58 CARL9170_MAC_RESET_RESET,
59 CARL9170_MAC_RESET_FORCE,
62 enum carl9170_suspend_mode {
63 CARL9170_HOST_AWAKE = 0,
64 CARL9170_HOST_SUSPENDED,
68 enum carl9170_phy_state {
73 typedef void (*fw_desc_callback_t)(void *, const bool);
76 * This platform - being an odd 32-bit architecture - prefers to
77 * have 32-Bit variables.
80 struct firmware_context_struct {
82 unsigned int ticks_per_usec;
83 unsigned int counter; /* main() cycles */
86 unsigned int watchdog_enable;
88 unsigned int suspend_mode;
91 /* Host Interface DMA queues */
92 struct dma_queue up_queue; /* used to send frames to the host */
93 struct dma_queue down_queue; /* stores incoming frames from the host */
97 /* Hardware DMA queues */
98 struct dma_queue tx_queue[__AR9170_NUM_TX_QUEUES]; /* wlan tx queue */
99 struct dma_queue tx_retry;
100 struct dma_queue rx_queue; /* wlan rx queue */
102 /* tx aggregate scheduling */
103 struct carl9170_tx_superframe *ampdu_prev[__AR9170_NUM_TX_QUEUES];
105 /* Hardware DMA queue unstuck/fix detection */
106 unsigned int last_super_num[__AR9170_NUM_TX_QUEUES];
107 struct carl9170_tx_superframe *last_super[__AR9170_NUM_TX_QUEUES];
108 unsigned int mac_reset;
109 unsigned int soft_int;
112 unsigned int rx_filter;
114 /* tx sequence control counters */
115 unsigned int sequence[CARL9170_INTF_NUM];
118 struct dma_queue cab_queue[CARL9170_INTF_NUM];
119 unsigned int cab_queue_len[CARL9170_INTF_NUM];
120 unsigned int cab_flush_time;
121 enum carl9170_cab_trigger cab_flush_trigger[CARL9170_INTF_NUM];
124 unsigned int tx_status_pending,
127 struct carl9170_tx_status tx_status_cache[CARL9170_TX_STATUS_NUM];
129 /* internal descriptor for use within the service routines */
130 struct dma_desc *fw_desc;
131 unsigned int fw_desc_available;
133 fw_desc_callback_t fw_desc_callback;
135 /* BA(R) Request Handler */
136 struct carl9170_bar_ctx ba_cache[CONFIG_CARL9170FW_BACK_REQS_NUM];
137 unsigned int ba_tail_idx,
141 unsigned int queued_bar;
147 alternate_interface_setting,
149 enum carl9170_ep0_action ep0_action;
151 void *ep0_txrx_buffer;
152 unsigned int ep0_txrx_len,
155 struct ar9170_usb_config *cfg_desc;
156 struct ar9170_usb_config *os_cfg_desc;
159 * special buffers for command & response handling
161 * the firmware uses a sort of ring-buffer to communicate
164 unsigned int int_pending,
168 struct dma_desc *int_desc;
169 struct carl9170_rsp int_buf[CARL9170_INT_RQ_CACHES];
171 #ifdef CONFIG_CARL9170FW_DEBUG_USB
173 unsigned int put_index;
174 uint8_t put_buffer[CARL9170_MAX_CMD_PAYLOAD_LEN];
175 #endif /* CONFIG_CARL9170FW_DEBUG_USB */
180 #ifdef CONFIG_CARL9170FW_RADIO_FUNCTIONS
181 /* (cached) ar9170_rf_init */
184 unsigned int frequency;
185 unsigned int ht_settings;
187 enum carl9170_phy_state state;
188 struct carl9170_psm psm;
189 #endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
192 unsigned int tally_clock;
193 struct carl9170_tally_rsp tally;
194 unsigned int tx_time;
196 #ifdef CONFIG_CARL9170FW_WOL
198 struct carl9170_wol_cmd cmd;
199 unsigned int last_beacon;
200 unsigned int lost_null;
201 unsigned int last_null;
204 #endif /* CONFIG_CARL9170FW_WOL */
206 #ifdef CONFIG_CARL9170FW_GPIO_INTERRUPT
207 struct carl9170_gpio cached_gpio_state;
208 #endif /*CONFIG_CARL9170FW_GPIO_INTERRUPT */
212 * global firmware context struct.
214 * NOTE: This struct will zeroed out in start()
216 extern struct firmware_context_struct fw;
217 #endif /* __CARL9170FW_CARL9170_H */