xref: /openbmc/linux/drivers/scsi/qla4xxx/ql4_83xx.h (revision 29c37341)
1 /*
2  * QLogic iSCSI HBA Driver
3  * Copyright (c)  2003-2013 QLogic Corporation
4  *
5  * See LICENSE.qla4xxx for copyright and licensing details.
6  */
7 
8 #ifndef __QL483XX_H
9 #define __QL483XX_H
10 
11 /* Indirectly Mapped Registers */
12 #define QLA83XX_FLASH_SPI_STATUS	0x2808E010
13 #define QLA83XX_FLASH_SPI_CONTROL	0x2808E014
14 #define QLA83XX_FLASH_STATUS		0x42100004
15 #define QLA83XX_FLASH_CONTROL		0x42110004
16 #define QLA83XX_FLASH_ADDR		0x42110008
17 #define QLA83XX_FLASH_WRDATA		0x4211000C
18 #define QLA83XX_FLASH_RDDATA		0x42110018
19 #define QLA83XX_FLASH_DIRECT_WINDOW	0x42110030
20 #define QLA83XX_FLASH_DIRECT_DATA(DATA) (0x42150000 | (0x0000FFFF&DATA))
21 
22 /* Directly Mapped Registers in 83xx register table */
23 
24 /* Flash access regs */
25 #define QLA83XX_FLASH_LOCK		0x3850
26 #define QLA83XX_FLASH_UNLOCK		0x3854
27 #define QLA83XX_FLASH_LOCK_ID		0x3500
28 
29 /* Driver Lock regs */
30 #define QLA83XX_DRV_LOCK		0x3868
31 #define QLA83XX_DRV_UNLOCK		0x386C
32 #define QLA83XX_DRV_LOCK_ID		0x3504
33 #define QLA83XX_DRV_LOCKRECOVERY	0x379C
34 
35 /* IDC version */
36 #define QLA83XX_IDC_VER_MAJ_VALUE       0x1
37 #define QLA83XX_IDC_VER_MIN_VALUE       0x0
38 
39 /* IDC Registers : Driver Coexistence Defines */
40 #define QLA83XX_CRB_IDC_VER_MAJOR	0x3780
41 #define QLA83XX_CRB_IDC_VER_MINOR	0x3798
42 #define QLA83XX_IDC_DRV_CTRL		0x3790
43 #define QLA83XX_IDC_DRV_AUDIT		0x3794
44 #define QLA83XX_SRE_SHIM_CONTROL	0x0D200284
45 #define QLA83XX_PORT0_RXB_PAUSE_THRS	0x0B2003A4
46 #define QLA83XX_PORT1_RXB_PAUSE_THRS	0x0B2013A4
47 #define QLA83XX_PORT0_RXB_TC_MAX_CELL	0x0B200388
48 #define QLA83XX_PORT1_RXB_TC_MAX_CELL	0x0B201388
49 #define QLA83XX_PORT0_RXB_TC_STATS	0x0B20039C
50 #define QLA83XX_PORT1_RXB_TC_STATS	0x0B20139C
51 #define QLA83XX_PORT2_IFB_PAUSE_THRS	0x0B200704
52 #define QLA83XX_PORT3_IFB_PAUSE_THRS	0x0B201704
53 
54 /* set value to pause threshold value */
55 #define QLA83XX_SET_PAUSE_VAL		0x0
56 #define QLA83XX_SET_TC_MAX_CELL_VAL	0x03FF03FF
57 
58 #define QLA83XX_RESET_CONTROL		0x28084E50
59 #define QLA83XX_RESET_REG		0x28084E60
60 #define QLA83XX_RESET_PORT0		0x28084E70
61 #define QLA83XX_RESET_PORT1		0x28084E80
62 #define QLA83XX_RESET_PORT2		0x28084E90
63 #define QLA83XX_RESET_PORT3		0x28084EA0
64 #define QLA83XX_RESET_SRE_SHIM		0x28084EB0
65 #define QLA83XX_RESET_EPG_SHIM		0x28084EC0
66 #define QLA83XX_RESET_ETHER_PCS		0x28084ED0
67 
68 /* qla_83xx_reg_tbl registers */
69 #define QLA83XX_PEG_HALT_STATUS1	0x34A8
70 #define QLA83XX_PEG_HALT_STATUS2	0x34AC
71 #define QLA83XX_PEG_ALIVE_COUNTER	0x34B0 /* FW_HEARTBEAT */
72 #define QLA83XX_FW_CAPABILITIES		0x3528
73 #define QLA83XX_CRB_DRV_ACTIVE		0x3788 /* IDC_DRV_PRESENCE */
74 #define QLA83XX_CRB_DEV_STATE		0x3784 /* IDC_DEV_STATE */
75 #define QLA83XX_CRB_DRV_STATE		0x378C /* IDC_DRV_ACK */
76 #define QLA83XX_CRB_DRV_SCRATCH		0x3548
77 #define QLA83XX_CRB_DEV_PART_INFO1	0x37E0
78 #define QLA83XX_CRB_DEV_PART_INFO2	0x37E4
79 
80 #define QLA83XX_FW_VER_MAJOR		0x3550
81 #define QLA83XX_FW_VER_MINOR		0x3554
82 #define QLA83XX_FW_VER_SUB		0x3558
83 #define QLA83XX_NPAR_STATE		0x359C
84 #define QLA83XX_FW_IMAGE_VALID		0x35FC
85 #define QLA83XX_CMDPEG_STATE		0x3650
86 #define QLA83XX_ASIC_TEMP		0x37B4
87 #define QLA83XX_FW_API			0x356C
88 #define QLA83XX_DRV_OP_MODE		0x3570
89 
90 #define QLA83XX_CRB_WIN_BASE		0x3800
91 #define QLA83XX_CRB_WIN_FUNC(f)		(QLA83XX_CRB_WIN_BASE+((f)*4))
92 #define QLA83XX_SEM_LOCK_BASE		0x3840
93 #define QLA83XX_SEM_UNLOCK_BASE		0x3844
94 #define QLA83XX_SEM_LOCK_FUNC(f)	(QLA83XX_SEM_LOCK_BASE+((f)*8))
95 #define QLA83XX_SEM_UNLOCK_FUNC(f)	(QLA83XX_SEM_UNLOCK_BASE+((f)*8))
96 #define QLA83XX_LINK_STATE(f)		(0x3698+((f) > 7 ? 4 : 0))
97 #define QLA83XX_LINK_SPEED(f)		(0x36E0+(((f) >> 2) * 4))
98 #define QLA83XX_MAX_LINK_SPEED(f)       (0x36F0+(((f) / 4) * 4))
99 #define QLA83XX_LINK_SPEED_FACTOR	10
100 
101 /* FLASH API Defines */
102 #define QLA83xx_FLASH_MAX_WAIT_USEC	100
103 #define QLA83XX_FLASH_LOCK_TIMEOUT	10000
104 #define QLA83XX_FLASH_SECTOR_SIZE	65536
105 #define QLA83XX_DRV_LOCK_TIMEOUT	2000
106 #define QLA83XX_FLASH_SECTOR_ERASE_CMD	0xdeadbeef
107 #define QLA83XX_FLASH_WRITE_CMD		0xdacdacda
108 #define QLA83XX_FLASH_BUFFER_WRITE_CMD	0xcadcadca
109 #define QLA83XX_FLASH_READ_RETRY_COUNT	2000
110 #define QLA83XX_FLASH_STATUS_READY	0x6
111 #define QLA83XX_FLASH_BUFFER_WRITE_MIN	2
112 #define QLA83XX_FLASH_BUFFER_WRITE_MAX	64
113 #define QLA83XX_FLASH_STATUS_REG_POLL_DELAY 1
114 #define QLA83XX_ERASE_MODE		1
115 #define QLA83XX_WRITE_MODE		2
116 #define QLA83XX_DWORD_WRITE_MODE	3
117 
118 #define QLA83XX_GLOBAL_RESET		0x38CC
119 #define QLA83XX_WILDCARD		0x38F0
120 #define QLA83XX_INFORMANT		0x38FC
121 #define QLA83XX_HOST_MBX_CTRL		0x3038
122 #define QLA83XX_FW_MBX_CTRL		0x303C
123 #define QLA83XX_BOOTLOADER_ADDR		0x355C
124 #define QLA83XX_BOOTLOADER_SIZE		0x3560
125 #define QLA83XX_FW_IMAGE_ADDR		0x3564
126 #define QLA83XX_MBX_INTR_ENABLE		0x1000
127 #define QLA83XX_MBX_INTR_MASK		0x1200
128 
129 /* IDC Control Register bit defines */
130 #define DONTRESET_BIT0		0x1
131 #define GRACEFUL_RESET_BIT1	0x2
132 
133 #define QLA83XX_HALT_STATUS_INFORMATIONAL	(0x1 << 29)
134 #define QLA83XX_HALT_STATUS_FW_RESET		(0x2 << 29)
135 #define QLA83XX_HALT_STATUS_UNRECOVERABLE	(0x4 << 29)
136 
137 /* Firmware image definitions */
138 #define QLA83XX_BOOTLOADER_FLASH_ADDR	0x10000
139 #define QLA83XX_BOOT_FROM_FLASH		0
140 
141 #define QLA83XX_IDC_PARAM_ADDR		0x3e8020
142 /* Reset template definitions */
143 #define QLA83XX_MAX_RESET_SEQ_ENTRIES	16
144 #define QLA83XX_RESTART_TEMPLATE_SIZE	0x2000
145 #define QLA83XX_RESET_TEMPLATE_ADDR	0x4F0000
146 #define QLA83XX_RESET_SEQ_VERSION	0x0101
147 
148 /* Reset template entry opcodes */
149 #define OPCODE_NOP			0x0000
150 #define OPCODE_WRITE_LIST		0x0001
151 #define OPCODE_READ_WRITE_LIST		0x0002
152 #define OPCODE_POLL_LIST		0x0004
153 #define OPCODE_POLL_WRITE_LIST		0x0008
154 #define OPCODE_READ_MODIFY_WRITE	0x0010
155 #define OPCODE_SEQ_PAUSE		0x0020
156 #define OPCODE_SEQ_END			0x0040
157 #define OPCODE_TMPL_END			0x0080
158 #define OPCODE_POLL_READ_LIST		0x0100
159 
160 /* Template Header */
161 #define RESET_TMPLT_HDR_SIGNATURE	0xCAFE
162 struct qla4_83xx_reset_template_hdr {
163 	__le16	version;
164 	__le16	signature;
165 	__le16	size;
166 	__le16	entries;
167 	__le16	hdr_size;
168 	__le16	checksum;
169 	__le16	init_seq_offset;
170 	__le16	start_seq_offset;
171 } __packed;
172 
173 /* Common Entry Header. */
174 struct qla4_83xx_reset_entry_hdr {
175 	__le16 cmd;
176 	__le16 size;
177 	__le16 count;
178 	__le16 delay;
179 } __packed;
180 
181 /* Generic poll entry type. */
182 struct qla4_83xx_poll {
183 	__le32  test_mask;
184 	__le32  test_value;
185 } __packed;
186 
187 /* Read modify write entry type. */
188 struct qla4_83xx_rmw {
189 	__le32  test_mask;
190 	__le32  xor_value;
191 	__le32  or_value;
192 	uint8_t shl;
193 	uint8_t shr;
194 	uint8_t index_a;
195 	uint8_t rsvd;
196 } __packed;
197 
198 /* Generic Entry Item with 2 DWords. */
199 struct qla4_83xx_entry {
200 	__le32 arg1;
201 	__le32 arg2;
202 } __packed;
203 
204 /* Generic Entry Item with 4 DWords.*/
205 struct qla4_83xx_quad_entry {
206 	__le32 dr_addr;
207 	__le32 dr_value;
208 	__le32 ar_addr;
209 	__le32 ar_value;
210 } __packed;
211 
212 struct qla4_83xx_reset_template {
213 	int seq_index;
214 	int seq_error;
215 	int array_index;
216 	uint32_t array[QLA83XX_MAX_RESET_SEQ_ENTRIES];
217 	uint8_t *buff;
218 	uint8_t *stop_offset;
219 	uint8_t *start_offset;
220 	uint8_t *init_offset;
221 	struct qla4_83xx_reset_template_hdr *hdr;
222 	uint8_t seq_end;
223 	uint8_t template_end;
224 };
225 
226 /* POLLRD Entry */
227 struct qla83xx_minidump_entry_pollrd {
228 	struct qla8xxx_minidump_entry_hdr h;
229 	uint32_t select_addr;
230 	uint32_t read_addr;
231 	uint32_t select_value;
232 	uint16_t select_value_stride;
233 	uint16_t op_count;
234 	uint32_t poll_wait;
235 	uint32_t poll_mask;
236 	uint32_t data_size;
237 	uint32_t rsvd_1;
238 };
239 
240 struct qla8044_minidump_entry_rddfe {
241 	struct qla8xxx_minidump_entry_hdr h;
242 	uint32_t addr_1;
243 	uint32_t value;
244 	uint8_t stride;
245 	uint8_t stride2;
246 	uint16_t count;
247 	uint32_t poll;
248 	uint32_t mask;
249 	uint32_t modify_mask;
250 	uint32_t data_size;
251 	uint32_t rsvd;
252 
253 } __packed;
254 
255 struct qla8044_minidump_entry_rdmdio {
256 	struct qla8xxx_minidump_entry_hdr h;
257 
258 	uint32_t addr_1;
259 	uint32_t addr_2;
260 	uint32_t value_1;
261 	uint8_t stride_1;
262 	uint8_t stride_2;
263 	uint16_t count;
264 	uint32_t poll;
265 	uint32_t mask;
266 	uint32_t value_2;
267 	uint32_t data_size;
268 
269 } __packed;
270 
271 struct qla8044_minidump_entry_pollwr {
272 	struct qla8xxx_minidump_entry_hdr h;
273 	uint32_t addr_1;
274 	uint32_t addr_2;
275 	uint32_t value_1;
276 	uint32_t value_2;
277 	uint32_t poll;
278 	uint32_t mask;
279 	uint32_t data_size;
280 	uint32_t rsvd;
281 
282 } __packed;
283 
284 /* RDMUX2 Entry */
285 struct qla83xx_minidump_entry_rdmux2 {
286 	struct qla8xxx_minidump_entry_hdr h;
287 	uint32_t select_addr_1;
288 	uint32_t select_addr_2;
289 	uint32_t select_value_1;
290 	uint32_t select_value_2;
291 	uint32_t op_count;
292 	uint32_t select_value_mask;
293 	uint32_t read_addr;
294 	uint8_t select_value_stride;
295 	uint8_t data_size;
296 	uint8_t rsvd[2];
297 };
298 
299 /* POLLRDMWR Entry */
300 struct qla83xx_minidump_entry_pollrdmwr {
301 	struct qla8xxx_minidump_entry_hdr h;
302 	uint32_t addr_1;
303 	uint32_t addr_2;
304 	uint32_t value_1;
305 	uint32_t value_2;
306 	uint32_t poll_wait;
307 	uint32_t poll_mask;
308 	uint32_t modify_mask;
309 	uint32_t data_size;
310 };
311 
312 /* IDC additional information */
313 struct qla4_83xx_idc_information {
314 	uint32_t request_desc;  /* IDC request descriptor */
315 	uint32_t info1; /* IDC additional info */
316 	uint32_t info2; /* IDC additional info */
317 	uint32_t info3; /* IDC additional info */
318 };
319 
320 #define QLA83XX_PEX_DMA_ENGINE_INDEX		8
321 #define QLA83XX_PEX_DMA_BASE_ADDRESS		0x77320000
322 #define QLA83XX_PEX_DMA_NUM_OFFSET		0x10000
323 #define QLA83XX_PEX_DMA_CMD_ADDR_LOW		0x0
324 #define QLA83XX_PEX_DMA_CMD_ADDR_HIGH		0x04
325 #define QLA83XX_PEX_DMA_CMD_STS_AND_CNTRL	0x08
326 
327 #define QLA83XX_PEX_DMA_READ_SIZE	(16 * 1024)
328 #define QLA83XX_PEX_DMA_MAX_WAIT	(100 * 100) /* Max wait of 100 msecs */
329 
330 /* Read Memory: For Pex-DMA */
331 struct qla4_83xx_minidump_entry_rdmem_pex_dma {
332 	struct qla8xxx_minidump_entry_hdr h;
333 	uint32_t desc_card_addr;
334 	uint16_t dma_desc_cmd;
335 	uint8_t rsvd[2];
336 	uint32_t start_dma_cmd;
337 	uint8_t rsvd2[12];
338 	uint32_t read_addr;
339 	uint32_t read_data_size;
340 };
341 
342 struct qla4_83xx_pex_dma_descriptor {
343 	struct {
344 		uint32_t read_data_size; /* 0-23: size, 24-31: rsvd */
345 		uint8_t rsvd[2];
346 		uint16_t dma_desc_cmd;
347 	} cmd;
348 	uint64_t src_addr;
349 	uint64_t dma_bus_addr; /* 0-3: desc-cmd, 4-7: pci-func,
350 				* 8-15: desc-cmd */
351 	uint8_t rsvd[24];
352 } __packed;
353 
354 #endif
355