aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/net/wireless/libertas/if_spi.h
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/net/wireless/libertas/if_spi.h')
-rw-r--r--drivers/net/wireless/libertas/if_spi.h208
1 files changed, 208 insertions, 0 deletions
diff --git a/drivers/net/wireless/libertas/if_spi.h b/drivers/net/wireless/libertas/if_spi.h
new file mode 100644
index 00000000000..2103869cc5b
--- /dev/null
+++ b/drivers/net/wireless/libertas/if_spi.h
@@ -0,0 +1,208 @@
1/*
2 * linux/drivers/net/wireless/libertas/if_spi.c
3 *
4 * Driver for Marvell SPI WLAN cards.
5 *
6 * Copyright 2008 Analog Devices Inc.
7 *
8 * Authors:
9 * Andrey Yurovsky <andrey@cozybit.com>
10 * Colin McCabe <colin@cozybit.com>
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or (at
15 * your option) any later version.
16 */
17
18#ifndef _LBS_IF_SPI_H_
19#define _LBS_IF_SPI_H_
20
21#define IPFIELD_ALIGN_OFFSET 2
22#define IF_SPI_CMD_BUF_SIZE 2400
23
24/***************** Firmware *****************/
25struct chip_ident {
26 u16 chip_id;
27 u16 name;
28};
29
30#define MAX_MAIN_FW_LOAD_CRC_ERR 10
31
32/* Chunk size when loading the helper firmware */
33#define HELPER_FW_LOAD_CHUNK_SZ 64
34
35/* Value to write to indicate end of helper firmware dnld */
36#define FIRMWARE_DNLD_OK 0x0000
37
38/* Value to check once the main firmware is downloaded */
39#define SUCCESSFUL_FW_DOWNLOAD_MAGIC 0x88888888
40
41/***************** SPI Interface Unit *****************/
42/* Masks used in SPI register read/write operations */
43#define IF_SPI_READ_OPERATION_MASK 0x0
44#define IF_SPI_WRITE_OPERATION_MASK 0x8000
45
46/* SPI register offsets. 4-byte aligned. */
47#define IF_SPI_DEVICEID_CTRL_REG 0x00 /* DeviceID controller reg */
48#define IF_SPI_IO_READBASE_REG 0x04 /* Read I/O base reg */
49#define IF_SPI_IO_WRITEBASE_REG 0x08 /* Write I/O base reg */
50#define IF_SPI_IO_RDWRPORT_REG 0x0C /* Read/Write I/O port reg */
51
52#define IF_SPI_CMD_READBASE_REG 0x10 /* Read command base reg */
53#define IF_SPI_CMD_WRITEBASE_REG 0x14 /* Write command base reg */
54#define IF_SPI_CMD_RDWRPORT_REG 0x18 /* Read/Write command port reg */
55
56#define IF_SPI_DATA_READBASE_REG 0x1C /* Read data base reg */
57#define IF_SPI_DATA_WRITEBASE_REG 0x20 /* Write data base reg */
58#define IF_SPI_DATA_RDWRPORT_REG 0x24 /* Read/Write data port reg */
59
60#define IF_SPI_SCRATCH_1_REG 0x28 /* Scratch reg 1 */
61#define IF_SPI_SCRATCH_2_REG 0x2C /* Scratch reg 2 */
62#define IF_SPI_SCRATCH_3_REG 0x30 /* Scratch reg 3 */
63#define IF_SPI_SCRATCH_4_REG 0x34 /* Scratch reg 4 */
64
65#define IF_SPI_TX_FRAME_SEQ_NUM_REG 0x38 /* Tx frame sequence number reg */
66#define IF_SPI_TX_FRAME_STATUS_REG 0x3C /* Tx frame status reg */
67
68#define IF_SPI_HOST_INT_CTRL_REG 0x40 /* Host interrupt controller reg */
69
70#define IF_SPI_CARD_INT_CAUSE_REG 0x44 /* Card interrupt cause reg */
71#define IF_SPI_CARD_INT_STATUS_REG 0x48 /* Card interupt status reg */
72#define IF_SPI_CARD_INT_EVENT_MASK_REG 0x4C /* Card interrupt event mask */
73#define IF_SPI_CARD_INT_STATUS_MASK_REG 0x50 /* Card interrupt status mask */
74
75#define IF_SPI_CARD_INT_RESET_SELECT_REG 0x54 /* Card interrupt reset select */
76
77#define IF_SPI_HOST_INT_CAUSE_REG 0x58 /* Host interrupt cause reg */
78#define IF_SPI_HOST_INT_STATUS_REG 0x5C /* Host interrupt status reg */
79#define IF_SPI_HOST_INT_EVENT_MASK_REG 0x60 /* Host interrupt event mask */
80#define IF_SPI_HOST_INT_STATUS_MASK_REG 0x64 /* Host interrupt status mask */
81#define IF_SPI_HOST_INT_RESET_SELECT_REG 0x68 /* Host interrupt reset select */
82
83#define IF_SPI_DELAY_READ_REG 0x6C /* Delay read reg */
84#define IF_SPI_SPU_BUS_MODE_REG 0x70 /* SPU BUS mode reg */
85
86/***************** IF_SPI_DEVICEID_CTRL_REG *****************/
87#define IF_SPI_DEVICEID_CTRL_REG_TO_CARD_ID(dc) ((dc & 0xffff0000)>>16)
88#define IF_SPI_DEVICEID_CTRL_REG_TO_CARD_REV(dc) (dc & 0x000000ff)
89
90/***************** IF_SPI_HOST_INT_CTRL_REG *****************/
91/** Host Interrupt Control bit : Wake up */
92#define IF_SPI_HICT_WAKE_UP (1<<0)
93/** Host Interrupt Control bit : WLAN ready */
94#define IF_SPI_HICT_WLAN_READY (1<<1)
95/*#define IF_SPI_HICT_FIFO_FIRST_HALF_EMPTY (1<<2) */
96/*#define IF_SPI_HICT_FIFO_SECOND_HALF_EMPTY (1<<3) */
97/*#define IF_SPI_HICT_IRQSRC_WLAN (1<<4) */
98/** Host Interrupt Control bit : Tx auto download */
99#define IF_SPI_HICT_TX_DOWNLOAD_OVER_AUTO (1<<5)
100/** Host Interrupt Control bit : Rx auto upload */
101#define IF_SPI_HICT_RX_UPLOAD_OVER_AUTO (1<<6)
102/** Host Interrupt Control bit : Command auto download */
103#define IF_SPI_HICT_CMD_DOWNLOAD_OVER_AUTO (1<<7)
104/** Host Interrupt Control bit : Command auto upload */
105#define IF_SPI_HICT_CMD_UPLOAD_OVER_AUTO (1<<8)
106
107/***************** IF_SPI_CARD_INT_CAUSE_REG *****************/
108/** Card Interrupt Case bit : Tx download over */
109#define IF_SPI_CIC_TX_DOWNLOAD_OVER (1<<0)
110/** Card Interrupt Case bit : Rx upload over */
111#define IF_SPI_CIC_RX_UPLOAD_OVER (1<<1)
112/** Card Interrupt Case bit : Command download over */
113#define IF_SPI_CIC_CMD_DOWNLOAD_OVER (1<<2)
114/** Card Interrupt Case bit : Host event */
115#define IF_SPI_CIC_HOST_EVENT (1<<3)
116/** Card Interrupt Case bit : Command upload over */
117#define IF_SPI_CIC_CMD_UPLOAD_OVER (1<<4)
118/** Card Interrupt Case bit : Power down */
119#define IF_SPI_CIC_POWER_DOWN (1<<5)
120
121/***************** IF_SPI_CARD_INT_STATUS_REG *****************/
122#define IF_SPI_CIS_TX_DOWNLOAD_OVER (1<<0)
123#define IF_SPI_CIS_RX_UPLOAD_OVER (1<<1)
124#define IF_SPI_CIS_CMD_DOWNLOAD_OVER (1<<2)
125#define IF_SPI_CIS_HOST_EVENT (1<<3)
126#define IF_SPI_CIS_CMD_UPLOAD_OVER (1<<4)
127#define IF_SPI_CIS_POWER_DOWN (1<<5)
128
129/***************** IF_SPI_HOST_INT_CAUSE_REG *****************/
130#define IF_SPI_HICU_TX_DOWNLOAD_RDY (1<<0)
131#define IF_SPI_HICU_RX_UPLOAD_RDY (1<<1)
132#define IF_SPI_HICU_CMD_DOWNLOAD_RDY (1<<2)
133#define IF_SPI_HICU_CARD_EVENT (1<<3)
134#define IF_SPI_HICU_CMD_UPLOAD_RDY (1<<4)
135#define IF_SPI_HICU_IO_WR_FIFO_OVERFLOW (1<<5)
136#define IF_SPI_HICU_IO_RD_FIFO_UNDERFLOW (1<<6)
137#define IF_SPI_HICU_DATA_WR_FIFO_OVERFLOW (1<<7)
138#define IF_SPI_HICU_DATA_RD_FIFO_UNDERFLOW (1<<8)
139#define IF_SPI_HICU_CMD_WR_FIFO_OVERFLOW (1<<9)
140#define IF_SPI_HICU_CMD_RD_FIFO_UNDERFLOW (1<<10)
141
142/***************** IF_SPI_HOST_INT_STATUS_REG *****************/
143/** Host Interrupt Status bit : Tx download ready */
144#define IF_SPI_HIST_TX_DOWNLOAD_RDY (1<<0)
145/** Host Interrupt Status bit : Rx upload ready */
146#define IF_SPI_HIST_RX_UPLOAD_RDY (1<<1)
147/** Host Interrupt Status bit : Command download ready */
148#define IF_SPI_HIST_CMD_DOWNLOAD_RDY (1<<2)
149/** Host Interrupt Status bit : Card event */
150#define IF_SPI_HIST_CARD_EVENT (1<<3)
151/** Host Interrupt Status bit : Command upload ready */
152#define IF_SPI_HIST_CMD_UPLOAD_RDY (1<<4)
153/** Host Interrupt Status bit : I/O write FIFO overflow */
154#define IF_SPI_HIST_IO_WR_FIFO_OVERFLOW (1<<5)
155/** Host Interrupt Status bit : I/O read FIFO underflow */
156#define IF_SPI_HIST_IO_RD_FIFO_UNDRFLOW (1<<6)
157/** Host Interrupt Status bit : Data write FIFO overflow */
158#define IF_SPI_HIST_DATA_WR_FIFO_OVERFLOW (1<<7)
159/** Host Interrupt Status bit : Data read FIFO underflow */
160#define IF_SPI_HIST_DATA_RD_FIFO_UNDERFLOW (1<<8)
161/** Host Interrupt Status bit : Command write FIFO overflow */
162#define IF_SPI_HIST_CMD_WR_FIFO_OVERFLOW (1<<9)
163/** Host Interrupt Status bit : Command read FIFO underflow */
164#define IF_SPI_HIST_CMD_RD_FIFO_UNDERFLOW (1<<10)
165
166/***************** IF_SPI_HOST_INT_STATUS_MASK_REG *****************/
167/** Host Interrupt Status Mask bit : Tx download ready */
168#define IF_SPI_HISM_TX_DOWNLOAD_RDY (1<<0)
169/** Host Interrupt Status Mask bit : Rx upload ready */
170#define IF_SPI_HISM_RX_UPLOAD_RDY (1<<1)
171/** Host Interrupt Status Mask bit : Command download ready */
172#define IF_SPI_HISM_CMD_DOWNLOAD_RDY (1<<2)
173/** Host Interrupt Status Mask bit : Card event */
174#define IF_SPI_HISM_CARDEVENT (1<<3)
175/** Host Interrupt Status Mask bit : Command upload ready */
176#define IF_SPI_HISM_CMD_UPLOAD_RDY (1<<4)
177/** Host Interrupt Status Mask bit : I/O write FIFO overflow */
178#define IF_SPI_HISM_IO_WR_FIFO_OVERFLOW (1<<5)
179/** Host Interrupt Status Mask bit : I/O read FIFO underflow */
180#define IF_SPI_HISM_IO_RD_FIFO_UNDERFLOW (1<<6)
181/** Host Interrupt Status Mask bit : Data write FIFO overflow */
182#define IF_SPI_HISM_DATA_WR_FIFO_OVERFLOW (1<<7)
183/** Host Interrupt Status Mask bit : Data write FIFO underflow */
184#define IF_SPI_HISM_DATA_RD_FIFO_UNDERFLOW (1<<8)
185/** Host Interrupt Status Mask bit : Command write FIFO overflow */
186#define IF_SPI_HISM_CMD_WR_FIFO_OVERFLOW (1<<9)
187/** Host Interrupt Status Mask bit : Command write FIFO underflow */
188#define IF_SPI_HISM_CMD_RD_FIFO_UNDERFLOW (1<<10)
189
190/***************** IF_SPI_SPU_BUS_MODE_REG *****************/
191/* SCK edge on which the WLAN module outputs data on MISO */
192#define IF_SPI_BUS_MODE_SPI_CLOCK_PHASE_FALLING 0x8
193#define IF_SPI_BUS_MODE_SPI_CLOCK_PHASE_RISING 0x0
194
195/* In a SPU read operation, there is a delay between writing the SPU
196 * register name and getting back data from the WLAN module.
197 * This can be specified in terms of nanoseconds or in terms of dummy
198 * clock cycles which the master must output before receiving a response. */
199#define IF_SPI_BUS_MODE_DELAY_METHOD_DUMMY_CLOCK 0x4
200#define IF_SPI_BUS_MODE_DELAY_METHOD_TIMED 0x0
201
202/* Some different modes of SPI operation */
203#define IF_SPI_BUS_MODE_8_BIT_ADDRESS_16_BIT_DATA 0x00
204#define IF_SPI_BUS_MODE_8_BIT_ADDRESS_32_BIT_DATA 0x01
205#define IF_SPI_BUS_MODE_16_BIT_ADDRESS_16_BIT_DATA 0x02
206#define IF_SPI_BUS_MODE_16_BIT_ADDRESS_32_BIT_DATA 0x03
207
208#endif