xref: /freebsd/sys/dev/qlxgb/qla_reg.h (revision ca987d4641cdcd7f27e153db17c5bf064934faf5)
1 /*
2  * Copyright (c) 2011-2013 Qlogic Corporation
3  * All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions
7  *  are met:
8  *
9  *  1. Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  *  2. Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  *
15  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  *  POSSIBILITY OF SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 /*
30  * File: qla_reg.h
31  * Author : David C Somayajulu, Qlogic Corporation, Aliso Viejo, CA 92656.
32  */
33 
34 #ifndef _QLA_REG_H_
35 #define _QLA_REG_H_
36 
37 /*
38  * Begin Definitions for QLA82xx Registers
39  */
40 
41 /*
42  * Register offsets for QLA8022
43  */
44 
45 /******************************
46  * PCIe Registers
47  ******************************/
48 #define Q8_CRB_WINDOW_2M		0x130060
49 
50 #define Q8_INT_VECTOR			0x130100
51 #define Q8_INT_MASK			0x130104
52 
53 #define Q8_INT_TARGET_STATUS_F0		0x130118
54 #define Q8_INT_TARGET_MASK_F0		0x130128
55 #define Q8_INT_TARGET_STATUS_F1		0x130160
56 #define Q8_INT_TARGET_MASK_F1		0x130170
57 #define Q8_INT_TARGET_STATUS_F2		0x130164
58 #define Q8_INT_TARGET_MASK_F2		0x130174
59 #define Q8_INT_TARGET_STATUS_F3		0x130168
60 #define Q8_INT_TARGET_MASK_F3		0x130178
61 #define Q8_INT_TARGET_STATUS_F4		0x130360
62 #define Q8_INT_TARGET_MASK_F4		0x130370
63 #define Q8_INT_TARGET_STATUS_F5		0x130364
64 #define Q8_INT_TARGET_MASK_F5		0x130374
65 #define Q8_INT_TARGET_STATUS_F6		0x130368
66 #define Q8_INT_TARGET_MASK_F6		0x130378
67 #define Q8_INT_TARGET_STATUS_F7		0x13036C
68 #define Q8_INT_TARGET_MASK_F7		0x13037C
69 
70 #define Q8_SEM2_LOCK			0x13C010
71 #define Q8_SEM2_UNLOCK			0x13C014
72 #define Q8_SEM3_LOCK			0x13C018
73 #define Q8_SEM3_UNLOCK			0x13C01C
74 #define Q8_SEM5_LOCK			0x13C028
75 #define Q8_SEM5_UNLOCK			0x13C02C
76 #define Q8_SEM7_LOCK			0x13C038
77 #define Q8_SEM7_UNLOCK			0x13C03C
78 
79 /* Valid bit for a SEM<N>_LOCK registers */
80 #define SEM_LOCK_BIT			0x00000001
81 
82 
83 #define Q8_ROM_LOCKID			0x1B2100
84 
85 /*******************************
86  * Firmware Interface Registers
87  *******************************/
88 #define Q8_FW_VER_MAJOR			0x1B2150
89 #define Q8_FW_VER_MINOR			0x1B2154
90 #define Q8_FW_VER_SUB			0x1B2158
91 #define Q8_FW_VER_BUILD			0x1B2168
92 
93 #define Q8_CMDPEG_STATE			0x1B2250
94 #define Q8_RCVPEG_STATE			0x1B233C
95 /*
96  * definitions for Q8_CMDPEG_STATE
97  */
98 #define CMDPEG_PHAN_INIT_COMPLETE	0xFF01
99 
100 #define Q8_ROM_STATUS			0x1A0004
101 /*
102  * definitions for Q8_ROM_STATUS
103  * bit definitions for Q8_UNM_ROMUSB_GLB_STATUS
104  * 31:3 Reserved; Rest as below
105  */
106 #define	ROM_STATUS_RDY			0x0004
107 #define	ROM_STATUS_DONE			0x0002
108 #define	ROM_STATUS_AUTO_ROM_SHDW	0x0001
109 
110 #define Q8_ASIC_RESET			0x1A0008
111 /*
112  * definitions for Q8_ASIC_RESET
113  */
114 #define ASIC_RESET_RST_XDMA		0x00800000 /* Reset XDMA */
115 #define ASIC_RESET_PEG_ICACHE		0x00000020 /* Reset PEG_ICACHE */
116 #define ASIC_RESET_PEG_DCACHE		0x00000010 /* Reset PEG_DCACHE */
117 #define ASIC_RESET_PEG_3		0x00000008 /* Reset PEG_3 */
118 #define ASIC_RESET_PEG_2		0x00000004 /* Reset PEG_2 */
119 #define ASIC_RESET_PEG_1		0x00000002 /* Reset PEG_1 */
120 #define ASIC_RESET_PEG_0		0x00000001 /* Reset PEG_0 */
121 
122 #define Q8_COLD_BOOT			0x1B21FC
123 /*
124  * definitions for Q8_COLD_BOOT
125  */
126 #define COLD_BOOT_VALUE		0x12345678
127 
128 
129 #define Q8_MIU_TEST_AGT_CTRL		0x180090
130 #define Q8_MIU_TEST_AGT_ADDR_LO		0x180094
131 #define Q8_MIU_TEST_AGT_ADDR_HI		0x180098
132 #define Q8_MIU_TEST_AGT_WRDATA_LO	0x1800A0
133 #define Q8_MIU_TEST_AGT_WRDATA_HI	0x1800A4
134 #define Q8_MIU_TEST_AGT_RDDATA_LO	0x1800A8
135 #define Q8_MIU_TEST_AGT_RDDATA_HI	0x1800AC
136 #define Q8_MIU_TEST_AGT_WRDATA_ULO	0x1800B0
137 #define Q8_MIU_TEST_AGT_WRDATA_UHI	0x1800B4
138 #define Q8_MIU_TEST_AGT_RDDATA_ULO	0x1800B8
139 #define Q8_MIU_TEST_AGT_RDDATA_UHI	0x1800BC
140 
141 #define Q8_PEG_0_RESET			0x160018
142 #define Q8_PEG_0_CLR1			0x160008
143 #define Q8_PEG_0_CLR2			0x16000C
144 #define Q8_PEG_1_CLR1			0x161008
145 #define Q8_PEG_1_CLR2			0x16100C
146 #define Q8_PEG_2_CLR1			0x162008
147 #define Q8_PEG_2_CLR2			0x16200C
148 #define Q8_PEG_3_CLR1			0x163008
149 #define Q8_PEG_3_CLR2			0x16300C
150 #define Q8_PEG_4_CLR1			0x164008
151 #define Q8_PEG_4_CLR2			0x16400C
152 #define Q8_PEG_D_RESET1			0x1650EC
153 #define Q8_PEG_D_RESET2			0x16504C
154 #define Q8_PEG_HALT_STATUS1		0x1B20A8
155 #define Q8_PEG_HALT_STATUS2		0x1B20AC
156 #define Q8_FIRMWARE_HEARTBEAT		0x1B20B0
157 #define Q8_PEG_I_RESET			0x16604C
158 
159 #define Q8_CRB_MAC_BLOCK_START		0x1B21C0
160 
161 /***************************************************
162  * Flash ROM Access Registers ( Indirect Registers )
163  ***************************************************/
164 
165 #define Q8_ROM_INSTR_OPCODE		0x03310004
166 /*
167  * bit definitions for Q8_ROM_INSTR_OPCODE
168  * 31:8 Reserved; Rest Below
169  */
170 #define ROM_OPCODE_WR_STATUS_REG	0x01
171 #define ROM_OPCODE_PROG_PAGE		0x02
172 #define ROM_OPCODE_RD_BYTE		0x03
173 #define ROM_OPCODE_WR_DISABLE		0x04
174 #define ROM_OPCODE_RD_STATUS_REG	0x05
175 #define ROM_OPCODE_WR_ENABLE		0x06
176 #define ROM_OPCODE_FAST_RD		0x0B
177 #define ROM_OPCODE_REL_DEEP_PWR_DWN	0xAB
178 #define ROM_OPCODE_BULK_ERASE		0xC7
179 #define ROM_OPCODE_DEEP_PWR_DWN		0xC9
180 #define ROM_OPCODE_SECTOR_ERASE		0xD8
181 
182 #define Q8_ROM_ADDRESS			0x03310008
183 /*
184  * bit definitions for Q8_ROM_ADDRESS
185  * 31:24 Reserved;
186  * 23:0  Physical ROM Address in bytes
187  */
188 
189 #define Q8_ROM_ADDR_BYTE_COUNT		0x03310010
190 /*
191  * bit definitions for Q8_ROM_ADDR_BYTE_COUNT
192  * 31:2 Reserved;
193  * 1:0  max address bytes for ROM Interface
194  */
195 
196 #define Q8_ROM_DUMMY_BYTE_COUNT		0x03310014
197 /*
198  * bit definitions for Q8_ROM_DUMMY_BYTE_COUNT
199  * 31:2 Reserved;
200  * 1:0 dummy bytes for ROM Instructions
201  */
202 
203 #define Q8_ROM_RD_DATA			0x03310018
204 #define Q8_ROM_WR_DATA                  0x0331000C
205 #define Q8_ROM_DIRECT_WINDOW            0x03310030
206 #define Q8_ROM_DIRECT_DATA_OFFSET       0x03310000
207 
208 
209 #define Q8_NX_CDRP_CMD_RSP		0x1B2218
210 #define Q8_NX_CDRP_ARG1			0x1B221C
211 #define Q8_NX_CDRP_ARG2			0x1B2220
212 #define Q8_NX_CDRP_ARG3			0x1B2224
213 #define Q8_NX_CDRP_SIGNATURE		0x1B2228
214 
215 #define Q8_LINK_STATE			0x1B2298
216 #define Q8_LINK_SPEED_0			0x1B22E8
217 /*
218  * Macros for reading and writing registers
219  */
220 
221 #if defined(__i386__) || defined(__amd64__)
222 #define Q8_MB()    __asm volatile("mfence" ::: "memory")
223 #define Q8_WMB()   __asm volatile("sfence" ::: "memory")
224 #define Q8_RMB()   __asm volatile("lfence" ::: "memory")
225 #else
226 #define Q8_MB()
227 #define Q8_WMB()
228 #define Q8_RMB()
229 #endif
230 
231 #define READ_REG32(ha, reg) bus_read_4((ha->pci_reg), reg)
232 #define READ_OFFSET32(ha, off) READ_REG32(ha, off)
233 
234 #define WRITE_REG32(ha, reg, val) \
235 	{\
236 		bus_write_4((ha->pci_reg), reg, val);\
237 		bus_read_4((ha->pci_reg), reg);\
238 	}
239 
240 #define WRITE_REG32_MB(ha, reg, val) \
241 	{\
242 		Q8_WMB();\
243 		bus_write_4((ha->pci_reg), reg, val);\
244 	}
245 
246 #define WRITE_OFFSET32(ha, off, val)\
247 		{\
248 			bus_write_4((ha->pci_reg), off, val);\
249 			bus_read_4((ha->pci_reg), off);\
250 		}
251 
252 #endif /* #ifndef _QLA_REG_H_ */
253