xref: /linux/drivers/scsi/bfa/bfa_ioc_cb.c (revision f3539c12d8196ce0a1993364d30b3a18908470d1)
1 /*
2  * Copyright (c) 2005-2014 Brocade Communications Systems, Inc.
3  * Copyright (c) 2014- QLogic Corporation.
4  * All rights reserved
5  * www.qlogic.com
6  *
7  * Linux driver for QLogic BR-series Fibre Channel Host Bus Adapter.
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU General Public License (GPL) Version 2 as
11  * published by the Free Software Foundation
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  */
18 
19 #include "bfad_drv.h"
20 #include "bfa_ioc.h"
21 #include "bfi_reg.h"
22 #include "bfa_defs.h"
23 
24 BFA_TRC_FILE(CNA, IOC_CB);
25 
26 #define bfa_ioc_cb_join_pos(__ioc) ((u32) (1 << BFA_IOC_CB_JOIN_SH))
27 
28 /*
29  * forward declarations
30  */
31 static bfa_boolean_t bfa_ioc_cb_firmware_lock(struct bfa_ioc_s *ioc);
32 static void bfa_ioc_cb_firmware_unlock(struct bfa_ioc_s *ioc);
33 static void bfa_ioc_cb_reg_init(struct bfa_ioc_s *ioc);
34 static void bfa_ioc_cb_map_port(struct bfa_ioc_s *ioc);
35 static void bfa_ioc_cb_isr_mode_set(struct bfa_ioc_s *ioc, bfa_boolean_t msix);
36 static void bfa_ioc_cb_notify_fail(struct bfa_ioc_s *ioc);
37 static void bfa_ioc_cb_ownership_reset(struct bfa_ioc_s *ioc);
38 static bfa_boolean_t bfa_ioc_cb_sync_start(struct bfa_ioc_s *ioc);
39 static void bfa_ioc_cb_sync_join(struct bfa_ioc_s *ioc);
40 static void bfa_ioc_cb_sync_leave(struct bfa_ioc_s *ioc);
41 static void bfa_ioc_cb_sync_ack(struct bfa_ioc_s *ioc);
42 static bfa_boolean_t bfa_ioc_cb_sync_complete(struct bfa_ioc_s *ioc);
43 static void bfa_ioc_cb_set_cur_ioc_fwstate(
44 			struct bfa_ioc_s *ioc, enum bfi_ioc_state fwstate);
45 static enum bfi_ioc_state bfa_ioc_cb_get_cur_ioc_fwstate(struct bfa_ioc_s *ioc);
46 static void bfa_ioc_cb_set_alt_ioc_fwstate(
47 			struct bfa_ioc_s *ioc, enum bfi_ioc_state fwstate);
48 static enum bfi_ioc_state bfa_ioc_cb_get_alt_ioc_fwstate(struct bfa_ioc_s *ioc);
49 
50 static struct bfa_ioc_hwif_s hwif_cb;
51 
52 /*
53  * Called from bfa_ioc_attach() to map asic specific calls.
54  */
55 void
56 bfa_ioc_set_cb_hwif(struct bfa_ioc_s *ioc)
57 {
58 	hwif_cb.ioc_pll_init = bfa_ioc_cb_pll_init;
59 	hwif_cb.ioc_firmware_lock = bfa_ioc_cb_firmware_lock;
60 	hwif_cb.ioc_firmware_unlock = bfa_ioc_cb_firmware_unlock;
61 	hwif_cb.ioc_reg_init = bfa_ioc_cb_reg_init;
62 	hwif_cb.ioc_map_port = bfa_ioc_cb_map_port;
63 	hwif_cb.ioc_isr_mode_set = bfa_ioc_cb_isr_mode_set;
64 	hwif_cb.ioc_notify_fail = bfa_ioc_cb_notify_fail;
65 	hwif_cb.ioc_ownership_reset = bfa_ioc_cb_ownership_reset;
66 	hwif_cb.ioc_sync_start = bfa_ioc_cb_sync_start;
67 	hwif_cb.ioc_sync_join = bfa_ioc_cb_sync_join;
68 	hwif_cb.ioc_sync_leave = bfa_ioc_cb_sync_leave;
69 	hwif_cb.ioc_sync_ack = bfa_ioc_cb_sync_ack;
70 	hwif_cb.ioc_sync_complete = bfa_ioc_cb_sync_complete;
71 	hwif_cb.ioc_set_fwstate = bfa_ioc_cb_set_cur_ioc_fwstate;
72 	hwif_cb.ioc_get_fwstate = bfa_ioc_cb_get_cur_ioc_fwstate;
73 	hwif_cb.ioc_set_alt_fwstate = bfa_ioc_cb_set_alt_ioc_fwstate;
74 	hwif_cb.ioc_get_alt_fwstate = bfa_ioc_cb_get_alt_ioc_fwstate;
75 
76 	ioc->ioc_hwif = &hwif_cb;
77 }
78 
79 /*
80  * Return true if firmware of current driver matches the running firmware.
81  */
82 static bfa_boolean_t
83 bfa_ioc_cb_firmware_lock(struct bfa_ioc_s *ioc)
84 {
85 	enum bfi_ioc_state alt_fwstate, cur_fwstate;
86 	struct bfi_ioc_image_hdr_s fwhdr;
87 
88 	cur_fwstate = bfa_ioc_cb_get_cur_ioc_fwstate(ioc);
89 	bfa_trc(ioc, cur_fwstate);
90 	alt_fwstate = bfa_ioc_cb_get_alt_ioc_fwstate(ioc);
91 	bfa_trc(ioc, alt_fwstate);
92 
93 	/*
94 	 * Uninit implies this is the only driver as of now.
95 	 */
96 	if (cur_fwstate == BFI_IOC_UNINIT)
97 		return BFA_TRUE;
98 	/*
99 	 * Check if another driver with a different firmware is active
100 	 */
101 	bfa_ioc_fwver_get(ioc, &fwhdr);
102 	if (!bfa_ioc_fwver_cmp(ioc, &fwhdr) &&
103 		alt_fwstate != BFI_IOC_DISABLED) {
104 		bfa_trc(ioc, alt_fwstate);
105 		return BFA_FALSE;
106 	}
107 
108 	return BFA_TRUE;
109 }
110 
111 static void
112 bfa_ioc_cb_firmware_unlock(struct bfa_ioc_s *ioc)
113 {
114 }
115 
116 /*
117  * Notify other functions on HB failure.
118  */
119 static void
120 bfa_ioc_cb_notify_fail(struct bfa_ioc_s *ioc)
121 {
122 	writel(~0U, ioc->ioc_regs.err_set);
123 	readl(ioc->ioc_regs.err_set);
124 }
125 
126 /*
127  * Host to LPU mailbox message addresses
128  */
129 static struct { u32 hfn_mbox, lpu_mbox, hfn_pgn; } iocreg_fnreg[] = {
130 	{ HOSTFN0_LPU_MBOX0_0, LPU_HOSTFN0_MBOX0_0, HOST_PAGE_NUM_FN0 },
131 	{ HOSTFN1_LPU_MBOX0_8, LPU_HOSTFN1_MBOX0_8, HOST_PAGE_NUM_FN1 }
132 };
133 
134 /*
135  * Host <-> LPU mailbox command/status registers
136  */
137 static struct { u32 hfn, lpu; } iocreg_mbcmd[] = {
138 
139 	{ HOSTFN0_LPU0_CMD_STAT, LPU0_HOSTFN0_CMD_STAT },
140 	{ HOSTFN1_LPU1_CMD_STAT, LPU1_HOSTFN1_CMD_STAT }
141 };
142 
143 static void
144 bfa_ioc_cb_reg_init(struct bfa_ioc_s *ioc)
145 {
146 	void __iomem *rb;
147 	int		pcifn = bfa_ioc_pcifn(ioc);
148 
149 	rb = bfa_ioc_bar0(ioc);
150 
151 	ioc->ioc_regs.hfn_mbox = rb + iocreg_fnreg[pcifn].hfn_mbox;
152 	ioc->ioc_regs.lpu_mbox = rb + iocreg_fnreg[pcifn].lpu_mbox;
153 	ioc->ioc_regs.host_page_num_fn = rb + iocreg_fnreg[pcifn].hfn_pgn;
154 
155 	if (ioc->port_id == 0) {
156 		ioc->ioc_regs.heartbeat = rb + BFA_IOC0_HBEAT_REG;
157 		ioc->ioc_regs.ioc_fwstate = rb + BFA_IOC0_STATE_REG;
158 		ioc->ioc_regs.alt_ioc_fwstate = rb + BFA_IOC1_STATE_REG;
159 	} else {
160 		ioc->ioc_regs.heartbeat = (rb + BFA_IOC1_HBEAT_REG);
161 		ioc->ioc_regs.ioc_fwstate = (rb + BFA_IOC1_STATE_REG);
162 		ioc->ioc_regs.alt_ioc_fwstate = (rb + BFA_IOC0_STATE_REG);
163 	}
164 
165 	/*
166 	 * Host <-> LPU mailbox command/status registers
167 	 */
168 	ioc->ioc_regs.hfn_mbox_cmd = rb + iocreg_mbcmd[pcifn].hfn;
169 	ioc->ioc_regs.lpu_mbox_cmd = rb + iocreg_mbcmd[pcifn].lpu;
170 
171 	/*
172 	 * PSS control registers
173 	 */
174 	ioc->ioc_regs.pss_ctl_reg = (rb + PSS_CTL_REG);
175 	ioc->ioc_regs.pss_err_status_reg = (rb + PSS_ERR_STATUS_REG);
176 	ioc->ioc_regs.app_pll_fast_ctl_reg = (rb + APP_PLL_LCLK_CTL_REG);
177 	ioc->ioc_regs.app_pll_slow_ctl_reg = (rb + APP_PLL_SCLK_CTL_REG);
178 
179 	/*
180 	 * IOC semaphore registers and serialization
181 	 */
182 	ioc->ioc_regs.ioc_sem_reg = (rb + HOST_SEM0_REG);
183 	ioc->ioc_regs.ioc_init_sem_reg = (rb + HOST_SEM2_REG);
184 
185 	/*
186 	 * sram memory access
187 	 */
188 	ioc->ioc_regs.smem_page_start = (rb + PSS_SMEM_PAGE_START);
189 	ioc->ioc_regs.smem_pg0 = BFI_IOC_SMEM_PG0_CB;
190 
191 	/*
192 	 * err set reg : for notification of hb failure
193 	 */
194 	ioc->ioc_regs.err_set = (rb + ERR_SET_REG);
195 }
196 
197 /*
198  * Initialize IOC to port mapping.
199  */
200 
201 static void
202 bfa_ioc_cb_map_port(struct bfa_ioc_s *ioc)
203 {
204 	/*
205 	 * For crossbow, port id is same as pci function.
206 	 */
207 	ioc->port_id = bfa_ioc_pcifn(ioc);
208 
209 	bfa_trc(ioc, ioc->port_id);
210 }
211 
212 /*
213  * Set interrupt mode for a function: INTX or MSIX
214  */
215 static void
216 bfa_ioc_cb_isr_mode_set(struct bfa_ioc_s *ioc, bfa_boolean_t msix)
217 {
218 }
219 
220 /*
221  * Synchronized IOC failure processing routines
222  */
223 static bfa_boolean_t
224 bfa_ioc_cb_sync_start(struct bfa_ioc_s *ioc)
225 {
226 	u32 ioc_fwstate = readl(ioc->ioc_regs.ioc_fwstate);
227 
228 	/**
229 	 * Driver load time.  If the join bit is set,
230 	 * it is due to an unclean exit by the driver for this
231 	 * PCI fn in the previous incarnation. Whoever comes here first
232 	 * should clean it up, no matter which PCI fn.
233 	 */
234 	if (ioc_fwstate & BFA_IOC_CB_JOIN_MASK) {
235 		writel(BFI_IOC_UNINIT, ioc->ioc_regs.ioc_fwstate);
236 		writel(BFI_IOC_UNINIT, ioc->ioc_regs.alt_ioc_fwstate);
237 		return BFA_TRUE;
238 	}
239 
240 	return bfa_ioc_cb_sync_complete(ioc);
241 }
242 
243 /*
244  * Cleanup hw semaphore and usecnt registers
245  */
246 static void
247 bfa_ioc_cb_ownership_reset(struct bfa_ioc_s *ioc)
248 {
249 
250 	/*
251 	 * Read the hw sem reg to make sure that it is locked
252 	 * before we clear it. If it is not locked, writing 1
253 	 * will lock it instead of clearing it.
254 	 */
255 	readl(ioc->ioc_regs.ioc_sem_reg);
256 	writel(1, ioc->ioc_regs.ioc_sem_reg);
257 }
258 
259 /*
260  * Synchronized IOC failure processing routines
261  */
262 static void
263 bfa_ioc_cb_sync_join(struct bfa_ioc_s *ioc)
264 {
265 	u32 r32 = readl(ioc->ioc_regs.ioc_fwstate);
266 	u32 join_pos = bfa_ioc_cb_join_pos(ioc);
267 
268 	writel((r32 | join_pos), ioc->ioc_regs.ioc_fwstate);
269 }
270 
271 static void
272 bfa_ioc_cb_sync_leave(struct bfa_ioc_s *ioc)
273 {
274 	u32 r32 = readl(ioc->ioc_regs.ioc_fwstate);
275 	u32 join_pos = bfa_ioc_cb_join_pos(ioc);
276 
277 	writel((r32 & ~join_pos), ioc->ioc_regs.ioc_fwstate);
278 }
279 
280 static void
281 bfa_ioc_cb_set_cur_ioc_fwstate(struct bfa_ioc_s *ioc,
282 			enum bfi_ioc_state fwstate)
283 {
284 	u32 r32 = readl(ioc->ioc_regs.ioc_fwstate);
285 
286 	writel((fwstate | (r32 & BFA_IOC_CB_JOIN_MASK)),
287 				ioc->ioc_regs.ioc_fwstate);
288 }
289 
290 static enum bfi_ioc_state
291 bfa_ioc_cb_get_cur_ioc_fwstate(struct bfa_ioc_s *ioc)
292 {
293 	return (enum bfi_ioc_state)(readl(ioc->ioc_regs.ioc_fwstate) &
294 			BFA_IOC_CB_FWSTATE_MASK);
295 }
296 
297 static void
298 bfa_ioc_cb_set_alt_ioc_fwstate(struct bfa_ioc_s *ioc,
299 			enum bfi_ioc_state fwstate)
300 {
301 	u32 r32 = readl(ioc->ioc_regs.alt_ioc_fwstate);
302 
303 	writel((fwstate | (r32 & BFA_IOC_CB_JOIN_MASK)),
304 				ioc->ioc_regs.alt_ioc_fwstate);
305 }
306 
307 static enum bfi_ioc_state
308 bfa_ioc_cb_get_alt_ioc_fwstate(struct bfa_ioc_s *ioc)
309 {
310 	return (enum bfi_ioc_state)(readl(ioc->ioc_regs.alt_ioc_fwstate) &
311 			BFA_IOC_CB_FWSTATE_MASK);
312 }
313 
314 static void
315 bfa_ioc_cb_sync_ack(struct bfa_ioc_s *ioc)
316 {
317 	bfa_ioc_cb_set_cur_ioc_fwstate(ioc, BFI_IOC_FAIL);
318 }
319 
320 static bfa_boolean_t
321 bfa_ioc_cb_sync_complete(struct bfa_ioc_s *ioc)
322 {
323 	u32 fwstate, alt_fwstate;
324 	fwstate = bfa_ioc_cb_get_cur_ioc_fwstate(ioc);
325 
326 	/*
327 	 * At this point, this IOC is hoding the hw sem in the
328 	 * start path (fwcheck) OR in the disable/enable path
329 	 * OR to check if the other IOC has acknowledged failure.
330 	 *
331 	 * So, this IOC can be in UNINIT, INITING, DISABLED, FAIL
332 	 * or in MEMTEST states. In a normal scenario, this IOC
333 	 * can not be in OP state when this function is called.
334 	 *
335 	 * However, this IOC could still be in OP state when
336 	 * the OS driver is starting up, if the OptROM code has
337 	 * left it in that state.
338 	 *
339 	 * If we had marked this IOC's fwstate as BFI_IOC_FAIL
340 	 * in the failure case and now, if the fwstate is not
341 	 * BFI_IOC_FAIL it implies that the other PCI fn have
342 	 * reinitialized the ASIC or this IOC got disabled, so
343 	 * return TRUE.
344 	 */
345 	if (fwstate == BFI_IOC_UNINIT ||
346 		fwstate == BFI_IOC_INITING ||
347 		fwstate == BFI_IOC_DISABLED ||
348 		fwstate == BFI_IOC_MEMTEST ||
349 		fwstate == BFI_IOC_OP)
350 		return BFA_TRUE;
351 	else {
352 		alt_fwstate = bfa_ioc_cb_get_alt_ioc_fwstate(ioc);
353 		if (alt_fwstate == BFI_IOC_FAIL ||
354 			alt_fwstate == BFI_IOC_DISABLED ||
355 			alt_fwstate == BFI_IOC_UNINIT ||
356 			alt_fwstate == BFI_IOC_INITING ||
357 			alt_fwstate == BFI_IOC_MEMTEST)
358 			return BFA_TRUE;
359 		else
360 			return BFA_FALSE;
361 	}
362 }
363 
364 bfa_status_t
365 bfa_ioc_cb_pll_init(void __iomem *rb, enum bfi_asic_mode fcmode)
366 {
367 	u32	pll_sclk, pll_fclk, join_bits;
368 
369 	pll_sclk = __APP_PLL_SCLK_ENABLE | __APP_PLL_SCLK_LRESETN |
370 		__APP_PLL_SCLK_P0_1(3U) |
371 		__APP_PLL_SCLK_JITLMT0_1(3U) |
372 		__APP_PLL_SCLK_CNTLMT0_1(3U);
373 	pll_fclk = __APP_PLL_LCLK_ENABLE | __APP_PLL_LCLK_LRESETN |
374 		__APP_PLL_LCLK_RSEL200500 | __APP_PLL_LCLK_P0_1(3U) |
375 		__APP_PLL_LCLK_JITLMT0_1(3U) |
376 		__APP_PLL_LCLK_CNTLMT0_1(3U);
377 	join_bits = readl(rb + BFA_IOC0_STATE_REG) &
378 			BFA_IOC_CB_JOIN_MASK;
379 	writel((BFI_IOC_UNINIT | join_bits), (rb + BFA_IOC0_STATE_REG));
380 	join_bits = readl(rb + BFA_IOC1_STATE_REG) &
381 			BFA_IOC_CB_JOIN_MASK;
382 	writel((BFI_IOC_UNINIT | join_bits), (rb + BFA_IOC1_STATE_REG));
383 	writel(0xffffffffU, (rb + HOSTFN0_INT_MSK));
384 	writel(0xffffffffU, (rb + HOSTFN1_INT_MSK));
385 	writel(0xffffffffU, (rb + HOSTFN0_INT_STATUS));
386 	writel(0xffffffffU, (rb + HOSTFN1_INT_STATUS));
387 	writel(0xffffffffU, (rb + HOSTFN0_INT_MSK));
388 	writel(0xffffffffU, (rb + HOSTFN1_INT_MSK));
389 	writel(__APP_PLL_SCLK_LOGIC_SOFT_RESET, rb + APP_PLL_SCLK_CTL_REG);
390 	writel(__APP_PLL_SCLK_BYPASS | __APP_PLL_SCLK_LOGIC_SOFT_RESET,
391 			rb + APP_PLL_SCLK_CTL_REG);
392 	writel(__APP_PLL_LCLK_LOGIC_SOFT_RESET, rb + APP_PLL_LCLK_CTL_REG);
393 	writel(__APP_PLL_LCLK_BYPASS | __APP_PLL_LCLK_LOGIC_SOFT_RESET,
394 			rb + APP_PLL_LCLK_CTL_REG);
395 	udelay(2);
396 	writel(__APP_PLL_SCLK_LOGIC_SOFT_RESET, rb + APP_PLL_SCLK_CTL_REG);
397 	writel(__APP_PLL_LCLK_LOGIC_SOFT_RESET, rb + APP_PLL_LCLK_CTL_REG);
398 	writel(pll_sclk | __APP_PLL_SCLK_LOGIC_SOFT_RESET,
399 			rb + APP_PLL_SCLK_CTL_REG);
400 	writel(pll_fclk | __APP_PLL_LCLK_LOGIC_SOFT_RESET,
401 			rb + APP_PLL_LCLK_CTL_REG);
402 	udelay(2000);
403 	writel(0xffffffffU, (rb + HOSTFN0_INT_STATUS));
404 	writel(0xffffffffU, (rb + HOSTFN1_INT_STATUS));
405 	writel(pll_sclk, (rb + APP_PLL_SCLK_CTL_REG));
406 	writel(pll_fclk, (rb + APP_PLL_LCLK_CTL_REG));
407 
408 	return BFA_STATUS_OK;
409 }
410