xref: /linux/drivers/net/wireless/ti/wl18xx/wl18xx.h (revision 75fb4df7f804229372e073977615a149a4a28dc0)
1 /*
2  * This file is part of wl18xx
3  *
4  * Copyright (C) 2011 Texas Instruments Inc.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * version 2 as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18  * 02110-1301 USA
19  *
20  */
21 
22 #ifndef __WL18XX_PRIV_H__
23 #define __WL18XX_PRIV_H__
24 
25 #include "conf.h"
26 
27 /* minimum FW required for driver */
28 #define WL18XX_CHIP_VER		8
29 #define WL18XX_IFTYPE_VER	5
30 #define WL18XX_MAJOR_VER	WLCORE_FW_VER_IGNORE
31 #define WL18XX_SUBTYPE_VER	WLCORE_FW_VER_IGNORE
32 #define WL18XX_MINOR_VER	39
33 
34 #define WL18XX_CMD_MAX_SIZE          740
35 
36 #define WL18XX_AGGR_BUFFER_SIZE		(13 * PAGE_SIZE)
37 
38 #define WL18XX_NUM_TX_DESCRIPTORS 32
39 #define WL18XX_NUM_RX_DESCRIPTORS 32
40 
41 #define WL18XX_NUM_MAC_ADDRESSES 3
42 
43 #define WL18XX_RX_BA_MAX_SESSIONS 5
44 
45 struct wl18xx_priv {
46 	/* buffer for sending commands to FW */
47 	u8 cmd_buf[WL18XX_CMD_MAX_SIZE];
48 
49 	struct wl18xx_priv_conf conf;
50 
51 	/* Index of last released Tx desc in FW */
52 	u8 last_fw_rls_idx;
53 
54 	/* number of keys requiring extra spare mem-blocks */
55 	int extra_spare_key_count;
56 };
57 
58 #define WL18XX_FW_MAX_TX_STATUS_DESC 33
59 
60 struct wl18xx_fw_status_priv {
61 	/*
62 	 * Index in released_tx_desc for first byte that holds
63 	 * released tx host desc
64 	 */
65 	u8 fw_release_idx;
66 
67 	/*
68 	 * Array of host Tx descriptors, where fw_release_idx
69 	 * indicated the first released idx.
70 	 */
71 	u8 released_tx_desc[WL18XX_FW_MAX_TX_STATUS_DESC];
72 
73 	/* A bitmap representing the currently suspended links. The suspend
74 	 * is short lived, for multi-channel Tx requirements.
75 	 */
76 	__le32 link_suspend_bitmap;
77 
78 	/* packet threshold for an "almost empty" AC,
79 	 * for Tx schedulng purposes
80 	 */
81 	u8 tx_ac_threshold;
82 
83 	/* number of packets to queue up for a link in PS */
84 	u8 tx_ps_threshold;
85 
86 	/* number of packet to queue up for a suspended link */
87 	u8 tx_suspend_threshold;
88 
89 	/* Should have less than this number of packets in queue of a slow
90 	 * link to qualify as high priority link
91 	 */
92 	u8 tx_slow_link_prio_threshold;
93 
94 	/* Should have less than this number of packets in queue of a fast
95 	 * link to qualify as high priority link
96 	 */
97 	u8 tx_fast_link_prio_threshold;
98 
99 	/* Should have less than this number of packets in queue of a slow
100 	 * link before we stop queuing up packets for it.
101 	 */
102 	u8 tx_slow_stop_threshold;
103 
104 	/* Should have less than this number of packets in queue of a fast
105 	 * link before we stop queuing up packets for it.
106 	 */
107 	u8 tx_fast_stop_threshold;
108 
109 	u8 padding[3];
110 };
111 
112 struct wl18xx_fw_packet_counters {
113 	/* Cumulative counter of released packets per AC */
114 	u8 tx_released_pkts[NUM_TX_QUEUES];
115 
116 	/* Cumulative counter of freed packets per HLID */
117 	u8 tx_lnk_free_pkts[WL12XX_MAX_LINKS];
118 
119 	/* Cumulative counter of released Voice memory blocks */
120 	u8 tx_voice_released_blks;
121 
122 	/* Tx rate of the last transmitted packet */
123 	u8 tx_last_rate;
124 
125 	u8 padding[2];
126 } __packed;
127 
128 /* FW status registers */
129 struct wl18xx_fw_status {
130 	__le32 intr;
131 	u8  fw_rx_counter;
132 	u8  drv_rx_counter;
133 	u8  reserved;
134 	u8  tx_results_counter;
135 	__le32 rx_pkt_descs[WL18XX_NUM_RX_DESCRIPTORS];
136 
137 	__le32 fw_localtime;
138 
139 	/*
140 	 * A bitmap (where each bit represents a single HLID)
141 	 * to indicate if the station is in PS mode.
142 	 */
143 	__le32 link_ps_bitmap;
144 
145 	/*
146 	 * A bitmap (where each bit represents a single HLID) to indicate
147 	 * if the station is in Fast mode
148 	 */
149 	__le32 link_fast_bitmap;
150 
151 	/* Cumulative counter of total released mem blocks since FW-reset */
152 	__le32 total_released_blks;
153 
154 	/* Size (in Memory Blocks) of TX pool */
155 	__le32 tx_total;
156 
157 	struct wl18xx_fw_packet_counters counters;
158 
159 	__le32 log_start_addr;
160 
161 	/* Private status to be used by the lower drivers */
162 	struct wl18xx_fw_status_priv priv;
163 } __packed;
164 
165 #define WL18XX_PHY_VERSION_MAX_LEN 20
166 
167 struct wl18xx_static_data_priv {
168 	char phy_version[WL18XX_PHY_VERSION_MAX_LEN];
169 };
170 
171 struct wl18xx_clk_cfg {
172 	u32 n;
173 	u32 m;
174 	u32 p;
175 	u32 q;
176 	bool swallow;
177 };
178 
179 enum {
180 	CLOCK_CONFIG_16_2_M	= 1,
181 	CLOCK_CONFIG_16_368_M,
182 	CLOCK_CONFIG_16_8_M,
183 	CLOCK_CONFIG_19_2_M,
184 	CLOCK_CONFIG_26_M,
185 	CLOCK_CONFIG_32_736_M,
186 	CLOCK_CONFIG_33_6_M,
187 	CLOCK_CONFIG_38_468_M,
188 	CLOCK_CONFIG_52_M,
189 
190 	NUM_CLOCK_CONFIGS,
191 };
192 
193 #endif /* __WL18XX_PRIV_H__ */
194