blob: 44a590f80def2e3317b5bc5c0f7e54603550c17a [file] [log] [blame]
Johnny Kimc5c77ba2015-05-11 14:30:56 +09001#ifndef WILC_WLAN_H
2#define WILC_WLAN_H
3
Arnd Bergmann491880e2015-11-16 15:04:55 +01004#include <linux/types.h>
5
Leo Kim7cf241a2015-11-06 11:19:56 +09006#define ISWILC1000(id) ((id & 0xfffff000) == 0x100000 ? 1 : 0)
Arnd Bergmann491880e2015-11-16 15:04:55 +01007
Johnny Kimc5c77ba2015-05-11 14:30:56 +09008/********************************************
9 *
10 * Mac eth header length
11 *
12 ********************************************/
Leo Kim7cf241a2015-11-06 11:19:56 +090013#define DRIVER_HANDLER_SIZE 4
14#define MAX_MAC_HDR_LEN 26 /* QOS_MAC_HDR_LEN */
15#define SUB_MSDU_HEADER_LENGTH 14
16#define SNAP_HDR_LEN 8
17#define ETHERNET_HDR_LEN 14
18#define WORD_ALIGNMENT_PAD 0
Johnny Kimc5c77ba2015-05-11 14:30:56 +090019
Leo Kim7cf241a2015-11-06 11:19:56 +090020#define ETH_ETHERNET_HDR_OFFSET (MAX_MAC_HDR_LEN + \
21 SUB_MSDU_HEADER_LENGTH + \
22 SNAP_HDR_LEN - \
23 ETHERNET_HDR_LEN + \
24 WORD_ALIGNMENT_PAD)
Johnny Kimc5c77ba2015-05-11 14:30:56 +090025
Leo Kim7cf241a2015-11-06 11:19:56 +090026#define HOST_HDR_OFFSET 4
27#define ETHERNET_HDR_LEN 14
28#define IP_HDR_LEN 20
29#define IP_HDR_OFFSET ETHERNET_HDR_LEN
30#define UDP_HDR_OFFSET (IP_HDR_LEN + IP_HDR_OFFSET)
31#define UDP_HDR_LEN 8
32#define UDP_DATA_OFFSET (UDP_HDR_OFFSET + UDP_HDR_LEN)
33#define ETH_CONFIG_PKT_HDR_LEN UDP_DATA_OFFSET
Johnny Kimc5c77ba2015-05-11 14:30:56 +090034
Leo Kim7cf241a2015-11-06 11:19:56 +090035#define ETH_CONFIG_PKT_HDR_OFFSET (ETH_ETHERNET_HDR_OFFSET + \
36 ETH_CONFIG_PKT_HDR_LEN)
Johnny Kimc5c77ba2015-05-11 14:30:56 +090037
38/********************************************
39 *
40 * Endian Conversion
41 *
42 ********************************************/
43
Leo Kim7cf241a2015-11-06 11:19:56 +090044#define BYTE_SWAP(val) (((val & 0x000000FF) << 24) + \
45 ((val & 0x0000FF00) << 8) + \
46 ((val & 0x00FF0000) >> 8) + \
47 ((val & 0xFF000000) >> 24))
Johnny Kimc5c77ba2015-05-11 14:30:56 +090048
49/********************************************
50 *
51 * Register Defines
52 *
53 ********************************************/
Leo Kim7cf241a2015-11-06 11:19:56 +090054#define WILC_PERIPH_REG_BASE 0x1000
55#define WILC_CHANGING_VIR_IF 0x108c
56#define WILC_CHIPID WILC_PERIPH_REG_BASE
57#define WILC_GLB_RESET_0 (WILC_PERIPH_REG_BASE + 0x400)
58#define WILC_PIN_MUX_0 (WILC_PERIPH_REG_BASE + 0x408)
59#define WILC_HOST_TX_CTRL (WILC_PERIPH_REG_BASE + 0x6c)
60#define WILC_HOST_RX_CTRL_0 (WILC_PERIPH_REG_BASE + 0x70)
61#define WILC_HOST_RX_CTRL_1 (WILC_PERIPH_REG_BASE + 0x74)
62#define WILC_HOST_VMM_CTL (WILC_PERIPH_REG_BASE + 0x78)
63#define WILC_HOST_RX_CTRL (WILC_PERIPH_REG_BASE + 0x80)
64#define WILC_HOST_RX_EXTRA_SIZE (WILC_PERIPH_REG_BASE + 0x84)
65#define WILC_HOST_TX_CTRL_1 (WILC_PERIPH_REG_BASE + 0x88)
66#define WILC_MISC (WILC_PERIPH_REG_BASE + 0x428)
67#define WILC_INTR_REG_BASE (WILC_PERIPH_REG_BASE + 0xa00)
68#define WILC_INTR_ENABLE WILC_INTR_REG_BASE
69#define WILC_INTR2_ENABLE (WILC_INTR_REG_BASE + 4)
Johnny Kimc5c77ba2015-05-11 14:30:56 +090070
Leo Kim7cf241a2015-11-06 11:19:56 +090071#define WILC_INTR_POLARITY (WILC_INTR_REG_BASE + 0x10)
72#define WILC_INTR_TYPE (WILC_INTR_REG_BASE + 0x20)
73#define WILC_INTR_CLEAR (WILC_INTR_REG_BASE + 0x30)
74#define WILC_INTR_STATUS (WILC_INTR_REG_BASE + 0x40)
Johnny Kimc5c77ba2015-05-11 14:30:56 +090075
Leo Kim7cf241a2015-11-06 11:19:56 +090076#define WILC_VMM_TBL_SIZE 64
77#define WILC_VMM_TX_TBL_BASE 0x150400
78#define WILC_VMM_RX_TBL_BASE 0x150500
Johnny Kimc5c77ba2015-05-11 14:30:56 +090079
Leo Kim7cf241a2015-11-06 11:19:56 +090080#define WILC_VMM_BASE 0x150000
81#define WILC_VMM_CORE_CTL WILC_VMM_BASE
82#define WILC_VMM_TBL_CTL (WILC_VMM_BASE + 0x4)
83#define WILC_VMM_TBL_ENTRY (WILC_VMM_BASE + 0x8)
84#define WILC_VMM_TBL0_SIZE (WILC_VMM_BASE + 0xc)
85#define WILC_VMM_TO_HOST_SIZE (WILC_VMM_BASE + 0x10)
86#define WILC_VMM_CORE_CFG (WILC_VMM_BASE + 0x14)
87#define WILC_VMM_TBL_ACTIVE (WILC_VMM_BASE + 040)
88#define WILC_VMM_TBL_STATUS (WILC_VMM_BASE + 0x44)
Johnny Kimc5c77ba2015-05-11 14:30:56 +090089
Leo Kim7cf241a2015-11-06 11:19:56 +090090#define WILC_SPI_REG_BASE 0xe800
91#define WILC_SPI_CTL WILC_SPI_REG_BASE
92#define WILC_SPI_MASTER_DMA_ADDR (WILC_SPI_REG_BASE + 0x4)
93#define WILC_SPI_MASTER_DMA_COUNT (WILC_SPI_REG_BASE + 0x8)
94#define WILC_SPI_SLAVE_DMA_ADDR (WILC_SPI_REG_BASE + 0xc)
95#define WILC_SPI_SLAVE_DMA_COUNT (WILC_SPI_REG_BASE + 0x10)
96#define WILC_SPI_TX_MODE (WILC_SPI_REG_BASE + 0x20)
97#define WILC_SPI_PROTOCOL_CONFIG (WILC_SPI_REG_BASE + 0x24)
98#define WILC_SPI_INTR_CTL (WILC_SPI_REG_BASE + 0x2c)
Johnny Kimc5c77ba2015-05-11 14:30:56 +090099
Leo Kim7cf241a2015-11-06 11:19:56 +0900100#define WILC_SPI_PROTOCOL_OFFSET (WILC_SPI_PROTOCOL_CONFIG - \
101 WILC_SPI_REG_BASE)
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900102
Leo Kim7cf241a2015-11-06 11:19:56 +0900103#define WILC_AHB_DATA_MEM_BASE 0x30000
104#define WILC_AHB_SHARE_MEM_BASE 0xd0000
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900105
Leo Kim7cf241a2015-11-06 11:19:56 +0900106#define WILC_VMM_TBL_RX_SHADOW_BASE WILC_AHB_SHARE_MEM_BASE
107#define WILC_VMM_TBL_RX_SHADOW_SIZE 256
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900108
Leo Kim7cf241a2015-11-06 11:19:56 +0900109#define WILC_GP_REG_0 0x149c
110#define WILC_GP_REG_1 0x14a0
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900111
Leo Kim97c14e82015-11-06 11:19:57 +0900112#define WILC_HAVE_SDIO_IRQ_GPIO BIT(0)
113#define WILC_HAVE_USE_PMU BIT(1)
114#define WILC_HAVE_SLEEP_CLK_SRC_RTC BIT(2)
115#define WILC_HAVE_SLEEP_CLK_SRC_XO BIT(3)
116#define WILC_HAVE_EXT_PA_INV_TX_RX BIT(4)
117#define WILC_HAVE_LEGACY_RF_SETTINGS BIT(5)
118#define WILC_HAVE_XTAL_24 BIT(6)
119#define WILC_HAVE_DISABLE_WILC_UART BIT(7)
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900120
121/********************************************
122 *
123 * Wlan Defines
124 *
125 ********************************************/
Leo Kim7cf241a2015-11-06 11:19:56 +0900126#define WILC_CFG_PKT 1
127#define WILC_NET_PKT 0
128#define WILC_MGMT_PKT 2
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900129
Leo Kim7cf241a2015-11-06 11:19:56 +0900130#define WILC_CFG_SET 1
131#define WILC_CFG_QUERY 0
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900132
Leo Kim7cf241a2015-11-06 11:19:56 +0900133#define WILC_CFG_RSP 1
134#define WILC_CFG_RSP_STATUS 2
135#define WILC_CFG_RSP_SCAN 3
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900136
137#ifdef WILC_SDIO
Leo Kim7cf241a2015-11-06 11:19:56 +0900138#define WILC_PLL_TO 4
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900139#else
Leo Kim7cf241a2015-11-06 11:19:56 +0900140#define WILC_PLL_TO 2
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900141#endif
Leo Kim7cf241a2015-11-06 11:19:56 +0900142#define ABORT_INT BIT(31)
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900143
144/*******************************************/
145/* E0 and later Interrupt flags. */
146/*******************************************/
147/*******************************************/
148/* E0 and later Interrupt flags. */
149/* IRQ Status word */
150/* 15:0 = DMA count in words. */
151/* 16: INT0 flag */
152/* 17: INT1 flag */
153/* 18: INT2 flag */
154/* 19: INT3 flag */
155/* 20: INT4 flag */
156/* 21: INT5 flag */
157/*******************************************/
Leo Kim7cf241a2015-11-06 11:19:56 +0900158#define IRG_FLAGS_OFFSET 16
159#define IRQ_DMA_WD_CNT_MASK ((1ul << IRG_FLAGS_OFFSET) - 1)
Leo Kim97c14e82015-11-06 11:19:57 +0900160#define INT_0 BIT(IRG_FLAGS_OFFSET)
161#define INT_1 BIT(IRG_FLAGS_OFFSET + 1)
162#define INT_2 BIT(IRG_FLAGS_OFFSET + 2)
163#define INT_3 BIT(IRG_FLAGS_OFFSET + 3)
164#define INT_4 BIT(IRG_FLAGS_OFFSET + 4)
165#define INT_5 BIT(IRG_FLAGS_OFFSET + 5)
Leo Kim7cf241a2015-11-06 11:19:56 +0900166#define MAX_NUM_INT 6
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900167
168/*******************************************/
169/* E0 and later Interrupt flags. */
170/* IRQ Clear word */
171/* 0: Clear INT0 */
172/* 1: Clear INT1 */
173/* 2: Clear INT2 */
174/* 3: Clear INT3 */
175/* 4: Clear INT4 */
176/* 5: Clear INT5 */
177/* 6: Select VMM table 1 */
178/* 7: Select VMM table 2 */
179/* 8: Enable VMM */
180/*******************************************/
Leo Kim7cf241a2015-11-06 11:19:56 +0900181#define CLR_INT0 BIT(0)
182#define CLR_INT1 BIT(1)
183#define CLR_INT2 BIT(2)
184#define CLR_INT3 BIT(3)
185#define CLR_INT4 BIT(4)
186#define CLR_INT5 BIT(5)
187#define SEL_VMM_TBL0 BIT(6)
188#define SEL_VMM_TBL1 BIT(7)
189#define EN_VMM BIT(8)
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900190
Leo Kim7cf241a2015-11-06 11:19:56 +0900191#define DATA_INT_EXT INT_0
192#define PLL_INT_EXT INT_1
193#define SLEEP_INT_EXT INT_2
194#define ALL_INT_EXT (DATA_INT_EXT | PLL_INT_EXT | SLEEP_INT_EXT)
195#define NUM_INT_EXT 3
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900196
Leo Kim7cf241a2015-11-06 11:19:56 +0900197#define DATA_INT_CLR CLR_INT0
198#define PLL_INT_CLR CLR_INT1
199#define SLEEP_INT_CLR CLR_INT2
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900200
Leo Kim7cf241a2015-11-06 11:19:56 +0900201#define ENABLE_RX_VMM (SEL_VMM_TBL1 | EN_VMM)
202#define ENABLE_TX_VMM (SEL_VMM_TBL0 | EN_VMM)
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900203/*time for expiring the semaphores of cfg packets*/
204#define CFG_PKTS_TIMEOUT 2000
205/********************************************
206 *
207 * Debug Type
208 *
209 ********************************************/
Chaehyun Limfbc2fe12015-09-15 14:06:16 +0900210typedef void (*wilc_debug_func)(u32, char *, ...);
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900211
212/********************************************
213 *
214 * Tx/Rx Queue Structure
215 *
216 ********************************************/
217
218struct txq_entry_t {
219 struct txq_entry_t *next;
220 struct txq_entry_t *prev;
221 int type;
Leo Kim8e556392015-11-06 11:19:51 +0900222 int index;
Chaehyun Lim51e825f2015-09-15 14:06:14 +0900223 u8 *buffer;
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900224 int buffer_size;
225 void *priv;
226 int status;
227 void (*tx_complete_func)(void *, int);
228};
229
230struct rxq_entry_t {
231 struct rxq_entry_t *next;
Chaehyun Lim51e825f2015-09-15 14:06:14 +0900232 u8 *buffer;
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900233 int buffer_size;
234};
235
236/********************************************
237 *
238 * Host IF Structure
239 *
240 ********************************************/
Glen Lee9c800322015-11-06 18:40:22 +0900241struct wilc;
Leo Kim48d0aa92015-11-06 11:20:02 +0900242struct wilc_hif_func {
Glen Lee9c800322015-11-06 18:40:22 +0900243 int (*hif_init)(struct wilc *, wilc_debug_func);
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900244 int (*hif_deinit)(void *);
Chaehyun Limfbc2fe12015-09-15 14:06:16 +0900245 int (*hif_read_reg)(u32, u32 *);
246 int (*hif_write_reg)(u32, u32);
247 int (*hif_block_rx)(u32, u8 *, u32);
248 int (*hif_block_tx)(u32, u8 *, u32);
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900249 int (*hif_sync)(void);
250 int (*hif_clear_int)(void);
Chaehyun Limfbc2fe12015-09-15 14:06:16 +0900251 int (*hif_read_int)(u32 *);
252 int (*hif_clear_int_ext)(u32);
253 int (*hif_read_size)(u32 *);
254 int (*hif_block_tx_ext)(u32, u8 *, u32);
255 int (*hif_block_rx_ext)(u32, u8 *, u32);
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900256 int (*hif_sync_ext)(int);
257 void (*hif_set_max_bus_speed)(void);
258 void (*hif_set_default_bus_speed)(void);
Arnd Bergmann5547c1f2015-11-16 15:05:06 +0100259 int (*enable_interrupt)(struct wilc *nic);
260 void (*disable_interrupt)(struct wilc *nic);
Leo Kim48d0aa92015-11-06 11:20:02 +0900261};
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900262
Arnd Bergmann7d37a4a2015-11-16 15:05:05 +0100263extern const struct wilc_hif_func wilc_hif_spi;
264extern const struct wilc_hif_func wilc_hif_sdio;
Arnd Bergmann491880e2015-11-16 15:04:55 +0100265
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900266/********************************************
267 *
268 * Configuration Structure
269 *
270 ********************************************/
271
Leo Kim7cf241a2015-11-06 11:19:56 +0900272#define MAX_CFG_FRAME_SIZE 1468
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900273
Leo Kim14cdc0a2015-11-06 11:19:59 +0900274struct wilc_cfg_frame {
Chaehyun Lim51e825f2015-09-15 14:06:14 +0900275 u8 ether_header[14];
276 u8 ip_header[20];
277 u8 udp_header[8];
278 u8 wid_header[8];
279 u8 frame[MAX_CFG_FRAME_SIZE];
Leo Kim14cdc0a2015-11-06 11:19:59 +0900280};
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900281
Leo Kimbcddd482015-11-06 11:20:01 +0900282struct wilc_cfg_rsp {
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900283 int type;
Chaehyun Limfbc2fe12015-09-15 14:06:16 +0900284 u32 seq_no;
Leo Kimbcddd482015-11-06 11:20:01 +0900285};
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900286
Arnd Bergmann491880e2015-11-16 15:04:55 +0100287struct wilc;
288
Glen Lee63d7ab82015-10-01 16:03:32 +0900289int wilc_wlan_firmware_download(const u8 *buffer, u32 buffer_size);
Glen Leee42563b2015-10-01 16:03:33 +0900290int wilc_wlan_start(void);
Glen Lee8cec7412015-10-01 16:03:34 +0900291int wilc_wlan_stop(void);
Glen Lee691bbd42015-10-27 18:28:02 +0900292int wilc_wlan_txq_add_net_pkt(struct net_device *dev, void *priv, u8 *buffer,
293 u32 buffer_size, wilc_tx_complete_func_t func);
Leo Kimb1d19292015-11-06 11:13:01 +0900294int wilc_wlan_handle_txq(struct net_device *dev, u32 *txq_count);
Glen Lee50b929e2015-10-27 18:27:40 +0900295void wilc_handle_isr(void *wilc);
Glen Lee2de7cbe2015-10-27 18:27:54 +0900296void wilc_wlan_cleanup(struct net_device *dev);
Glen Lee1028e5a2015-10-01 16:03:40 +0900297int wilc_wlan_cfg_set(int start, u32 wid, u8 *buffer, u32 buffer_size,
Leo Kim9cd034b2015-11-06 11:13:09 +0900298 int commit, u32 drv_handler);
Leo Kim4878bd62015-11-06 11:13:10 +0900299int wilc_wlan_cfg_get(int start, u32 wid, int commit, u32 drv_handler);
Glen Lee894de36b2015-10-01 16:03:42 +0900300int wilc_wlan_cfg_get_val(u32 wid, u8 *buffer, u32 buffer_size);
Glen Lee829c4772015-10-29 12:18:44 +0900301int wilc_wlan_txq_add_mgmt_pkt(struct net_device *dev, void *priv, u8 *buffer,
302 u32 buffer_size, wilc_tx_complete_func_t func);
Arnd Bergmann0e1af732015-11-16 15:04:54 +0100303void wilc_chip_sleep_manually(void);
Arnd Bergmann491880e2015-11-16 15:04:55 +0100304
305void wilc_enable_tcp_ack_filter(bool value);
306int wilc_wlan_get_num_conn_ifcs(void);
307int wilc_mac_xmit(struct sk_buff *skb, struct net_device *dev);
308
309int wilc_mac_open(struct net_device *ndev);
310int wilc_mac_close(struct net_device *ndev);
311
312int wilc_wlan_set_bssid(struct net_device *wilc_netdev, u8 *pBSSID);
313void WILC_WFI_p2p_rx(struct net_device *dev, u8 *buff, u32 size);
314
315extern bool wilc_enable_ps;
316
Johnny Kimc5c77ba2015-05-11 14:30:56 +0900317#endif