1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Linux network driver for QLogic BR-series Converged Network Adapter.
4 */
5 /*
6 * Copyright (c) 2005-2014 Brocade Communications Systems, Inc.
7 * Copyright (c) 2014-2015 QLogic Corporation
8 * All rights reserved
9 * www.qlogic.com
10 */
11
12 #ifndef __BFA_IOC_H__
13 #define __BFA_IOC_H__
14
15 #include "bfa_cs.h"
16 #include "bfi.h"
17 #include "cna.h"
18
19 #define BFA_IOC_TOV 3000 /* msecs */
20 #define BFA_IOC_HWSEM_TOV 500 /* msecs */
21 #define BFA_IOC_HB_TOV 500 /* msecs */
22 #define BFA_IOC_POLL_TOV 200 /* msecs */
23 #define BNA_DBG_FWTRC_LEN (BFI_IOC_TRC_ENTS * BFI_IOC_TRC_ENT_SZ + \
24 BFI_IOC_TRC_HDR_SZ)
25
26 /* PCI device information required by IOC */
27 struct bfa_pcidev {
28 int pci_slot;
29 u8 pci_func;
30 u16 device_id;
31 u16 ssid;
32 void __iomem *pci_bar_kva;
33 };
34
35 /* Structure used to remember the DMA-able memory block's KVA and Physical
36 * Address
37 */
38 struct bfa_dma {
39 void *kva; /* ! Kernel virtual address */
40 u64 pa; /* ! Physical address */
41 };
42
43 #define BFA_DMA_ALIGN_SZ 256
44
45 /* smem size for Crossbow and Catapult */
46 #define BFI_SMEM_CB_SIZE 0x200000U /* ! 2MB for crossbow */
47 #define BFI_SMEM_CT_SIZE 0x280000U /* ! 2.5MB for catapult */
48
49 /* BFA dma address assignment macro. (big endian format) */
50 #define bfa_dma_be_addr_set(dma_addr, pa) \
51 __bfa_dma_be_addr_set(&dma_addr, (u64)pa)
52 static inline void
__bfa_dma_be_addr_set(union bfi_addr_u * dma_addr,u64 pa)53 __bfa_dma_be_addr_set(union bfi_addr_u *dma_addr, u64 pa)
54 {
55 dma_addr->a32.addr_lo = (u32) htonl(pa);
56 dma_addr->a32.addr_hi = (u32) htonl(upper_32_bits(pa));
57 }
58
59 #define bfa_alen_set(__alen, __len, __pa) \
60 __bfa_alen_set(__alen, __len, (u64)__pa)
61
62 static inline void
__bfa_alen_set(struct bfi_alen * alen,u32 len,u64 pa)63 __bfa_alen_set(struct bfi_alen *alen, u32 len, u64 pa)
64 {
65 alen->al_len = cpu_to_be32(len);
66 bfa_dma_be_addr_set(alen->al_addr, pa);
67 }
68
69 struct bfa_ioc_regs {
70 void __iomem *hfn_mbox_cmd;
71 void __iomem *hfn_mbox;
72 void __iomem *lpu_mbox_cmd;
73 void __iomem *lpu_mbox;
74 void __iomem *lpu_read_stat;
75 void __iomem *pss_ctl_reg;
76 void __iomem *pss_err_status_reg;
77 void __iomem *app_pll_fast_ctl_reg;
78 void __iomem *app_pll_slow_ctl_reg;
79 void __iomem *ioc_sem_reg;
80 void __iomem *ioc_usage_sem_reg;
81 void __iomem *ioc_init_sem_reg;
82 void __iomem *ioc_usage_reg;
83 void __iomem *host_page_num_fn;
84 void __iomem *heartbeat;
85 void __iomem *ioc_fwstate;
86 void __iomem *alt_ioc_fwstate;
87 void __iomem *ll_halt;
88 void __iomem *alt_ll_halt;
89 void __iomem *err_set;
90 void __iomem *ioc_fail_sync;
91 void __iomem *shirq_isr_next;
92 void __iomem *shirq_msk_next;
93 void __iomem *smem_page_start;
94 u32 smem_pg0;
95 };
96
97 /* IOC Mailbox structures */
98 typedef void (*bfa_mbox_cmd_cbfn_t)(void *cbarg);
99 struct bfa_mbox_cmd {
100 struct list_head qe;
101 bfa_mbox_cmd_cbfn_t cbfn;
102 void *cbarg;
103 u32 msg[BFI_IOC_MSGSZ];
104 };
105
106 /* IOC mailbox module */
107 typedef void (*bfa_ioc_mbox_mcfunc_t)(void *cbarg, struct bfi_mbmsg *m);
108 struct bfa_ioc_mbox_mod {
109 struct list_head cmd_q; /*!< pending mbox queue */
110 int nmclass; /*!< number of handlers */
111 struct {
112 bfa_ioc_mbox_mcfunc_t cbfn; /*!< message handlers */
113 void *cbarg;
114 } mbhdlr[BFI_MC_MAX];
115 };
116
117 /* IOC callback function interfaces */
118 typedef void (*bfa_ioc_enable_cbfn_t)(void *bfa, enum bfa_status status);
119 typedef void (*bfa_ioc_disable_cbfn_t)(void *bfa);
120 typedef void (*bfa_ioc_hbfail_cbfn_t)(void *bfa);
121 typedef void (*bfa_ioc_reset_cbfn_t)(void *bfa);
122 struct bfa_ioc_cbfn {
123 bfa_ioc_enable_cbfn_t enable_cbfn;
124 bfa_ioc_disable_cbfn_t disable_cbfn;
125 bfa_ioc_hbfail_cbfn_t hbfail_cbfn;
126 bfa_ioc_reset_cbfn_t reset_cbfn;
127 };
128
129 /* IOC event notification mechanism. */
130 enum bfa_ioc_event {
131 BFA_IOC_E_ENABLED = 1,
132 BFA_IOC_E_DISABLED = 2,
133 BFA_IOC_E_FAILED = 3,
134 };
135
136 typedef void (*bfa_ioc_notify_cbfn_t)(void *, enum bfa_ioc_event);
137
138 struct bfa_ioc_notify {
139 struct list_head qe;
140 bfa_ioc_notify_cbfn_t cbfn;
141 void *cbarg;
142 };
143
144 /* Initialize a IOC event notification structure */
145 #define bfa_ioc_notify_init(__notify, __cbfn, __cbarg) do { \
146 (__notify)->cbfn = (__cbfn); \
147 (__notify)->cbarg = (__cbarg); \
148 } while (0)
149
150 enum iocpf_event;
151
152 struct bfa_iocpf {
153 void (*fsm)(struct bfa_iocpf *s, enum iocpf_event e);
154 struct bfa_ioc *ioc;
155 bool fw_mismatch_notified;
156 bool auto_recover;
157 u32 poll_time;
158 };
159
160 enum ioc_event;
161
162 struct bfa_ioc {
163 void (*fsm)(struct bfa_ioc *s, enum ioc_event e);
164 struct bfa *bfa;
165 struct bfa_pcidev pcidev;
166 struct timer_list ioc_timer;
167 struct timer_list iocpf_timer;
168 struct timer_list sem_timer;
169 struct timer_list hb_timer;
170 u32 hb_count;
171 struct list_head notify_q;
172 void *dbg_fwsave;
173 int dbg_fwsave_len;
174 bool dbg_fwsave_once;
175 enum bfi_pcifn_class clscode;
176 struct bfa_ioc_regs ioc_regs;
177 struct bfa_ioc_drv_stats stats;
178 bool fcmode;
179 bool pllinit;
180 bool stats_busy; /*!< outstanding stats */
181 u8 port_id;
182
183 struct bfa_dma attr_dma;
184 struct bfi_ioc_attr *attr;
185 struct bfa_ioc_cbfn *cbfn;
186 struct bfa_ioc_mbox_mod mbox_mod;
187 const struct bfa_ioc_hwif *ioc_hwif;
188 struct bfa_iocpf iocpf;
189 enum bfi_asic_gen asic_gen;
190 enum bfi_asic_mode asic_mode;
191 enum bfi_port_mode port0_mode;
192 enum bfi_port_mode port1_mode;
193 enum bfa_mode port_mode;
194 u8 ad_cap_bm; /*!< adapter cap bit mask */
195 u8 port_mode_cfg; /*!< config port mode */
196 };
197
198 struct bfa_ioc_hwif {
199 enum bfa_status (*ioc_pll_init) (void __iomem *rb,
200 enum bfi_asic_mode m);
201 bool (*ioc_firmware_lock) (struct bfa_ioc *ioc);
202 void (*ioc_firmware_unlock) (struct bfa_ioc *ioc);
203 void (*ioc_reg_init) (struct bfa_ioc *ioc);
204 void (*ioc_map_port) (struct bfa_ioc *ioc);
205 void (*ioc_isr_mode_set) (struct bfa_ioc *ioc,
206 bool msix);
207 void (*ioc_notify_fail) (struct bfa_ioc *ioc);
208 void (*ioc_ownership_reset) (struct bfa_ioc *ioc);
209 bool (*ioc_sync_start) (struct bfa_ioc *ioc);
210 void (*ioc_sync_join) (struct bfa_ioc *ioc);
211 void (*ioc_sync_leave) (struct bfa_ioc *ioc);
212 void (*ioc_sync_ack) (struct bfa_ioc *ioc);
213 bool (*ioc_sync_complete) (struct bfa_ioc *ioc);
214 bool (*ioc_lpu_read_stat) (struct bfa_ioc *ioc);
215 void (*ioc_set_fwstate) (struct bfa_ioc *ioc,
216 enum bfi_ioc_state fwstate);
217 enum bfi_ioc_state (*ioc_get_fwstate) (struct bfa_ioc *ioc);
218 void (*ioc_set_alt_fwstate) (struct bfa_ioc *ioc,
219 enum bfi_ioc_state fwstate);
220 enum bfi_ioc_state (*ioc_get_alt_fwstate) (struct bfa_ioc *ioc);
221
222 };
223
224 #define bfa_ioc_pcifn(__ioc) ((__ioc)->pcidev.pci_func)
225 #define bfa_ioc_devid(__ioc) ((__ioc)->pcidev.device_id)
226 #define bfa_ioc_bar0(__ioc) ((__ioc)->pcidev.pci_bar_kva)
227 #define bfa_ioc_portid(__ioc) ((__ioc)->port_id)
228 #define bfa_ioc_asic_gen(__ioc) ((__ioc)->asic_gen)
229 #define bfa_ioc_is_default(__ioc) \
230 (bfa_ioc_pcifn(__ioc) == bfa_ioc_portid(__ioc))
231 #define bfa_ioc_speed_sup(__ioc) \
232 BFI_ADAPTER_GETP(SPEED, (__ioc)->attr->adapter_prop)
233 #define bfa_ioc_get_nports(__ioc) \
234 BFI_ADAPTER_GETP(NPORTS, (__ioc)->attr->adapter_prop)
235
236 #define bfa_ioc_stats(_ioc, _stats) ((_ioc)->stats._stats++)
237 #define bfa_ioc_stats_hb_count(_ioc, _hb_count) \
238 ((_ioc)->stats.hb_count = (_hb_count))
239 #define BFA_IOC_FWIMG_MINSZ (16 * 1024)
240 #define BFA_IOC_FW_SMEM_SIZE(__ioc) \
241 ((bfa_ioc_asic_gen(__ioc) == BFI_ASIC_GEN_CB) \
242 ? BFI_SMEM_CB_SIZE : BFI_SMEM_CT_SIZE)
243 #define BFA_IOC_FLASH_CHUNK_NO(off) (off / BFI_FLASH_CHUNK_SZ_WORDS)
244 #define BFA_IOC_FLASH_OFFSET_IN_CHUNK(off) (off % BFI_FLASH_CHUNK_SZ_WORDS)
245 #define BFA_IOC_FLASH_CHUNK_ADDR(chunkno) (chunkno * BFI_FLASH_CHUNK_SZ_WORDS)
246
247 /* IOC mailbox interface */
248 bool bfa_nw_ioc_mbox_queue(struct bfa_ioc *ioc,
249 struct bfa_mbox_cmd *cmd,
250 bfa_mbox_cmd_cbfn_t cbfn, void *cbarg);
251 void bfa_nw_ioc_mbox_isr(struct bfa_ioc *ioc);
252 void bfa_nw_ioc_mbox_regisr(struct bfa_ioc *ioc, enum bfi_mclass mc,
253 bfa_ioc_mbox_mcfunc_t cbfn, void *cbarg);
254
255 /* IOC interfaces */
256
257 #define bfa_ioc_pll_init_asic(__ioc) \
258 ((__ioc)->ioc_hwif->ioc_pll_init((__ioc)->pcidev.pci_bar_kva, \
259 (__ioc)->asic_mode))
260
261 #define bfa_ioc_lpu_read_stat(__ioc) do { \
262 if ((__ioc)->ioc_hwif->ioc_lpu_read_stat) \
263 ((__ioc)->ioc_hwif->ioc_lpu_read_stat(__ioc)); \
264 } while (0)
265
266 void bfa_nw_ioc_set_ct_hwif(struct bfa_ioc *ioc);
267 void bfa_nw_ioc_set_ct2_hwif(struct bfa_ioc *ioc);
268 void bfa_nw_ioc_ct2_poweron(struct bfa_ioc *ioc);
269
270 void bfa_nw_ioc_attach(struct bfa_ioc *ioc, void *bfa,
271 struct bfa_ioc_cbfn *cbfn);
272 void bfa_nw_ioc_auto_recover(bool auto_recover);
273 void bfa_nw_ioc_detach(struct bfa_ioc *ioc);
274 void bfa_nw_ioc_pci_init(struct bfa_ioc *ioc, struct bfa_pcidev *pcidev,
275 enum bfi_pcifn_class clscode);
276 u32 bfa_nw_ioc_meminfo(void);
277 void bfa_nw_ioc_mem_claim(struct bfa_ioc *ioc, u8 *dm_kva, u64 dm_pa);
278 void bfa_nw_ioc_enable(struct bfa_ioc *ioc);
279 void bfa_nw_ioc_disable(struct bfa_ioc *ioc);
280
281 void bfa_nw_ioc_error_isr(struct bfa_ioc *ioc);
282 bool bfa_nw_ioc_is_disabled(struct bfa_ioc *ioc);
283 bool bfa_nw_ioc_is_operational(struct bfa_ioc *ioc);
284 void bfa_nw_ioc_get_attr(struct bfa_ioc *ioc, struct bfa_ioc_attr *ioc_attr);
285 enum bfa_status bfa_nw_ioc_fwsig_invalidate(struct bfa_ioc *ioc);
286 void bfa_nw_ioc_notify_register(struct bfa_ioc *ioc,
287 struct bfa_ioc_notify *notify);
288 bool bfa_nw_ioc_sem_get(void __iomem *sem_reg);
289 void bfa_nw_ioc_sem_release(void __iomem *sem_reg);
290 void bfa_nw_ioc_hw_sem_release(struct bfa_ioc *ioc);
291 void bfa_nw_ioc_fwver_get(struct bfa_ioc *ioc,
292 struct bfi_ioc_image_hdr *fwhdr);
293 bool bfa_nw_ioc_fwver_cmp(struct bfa_ioc *ioc,
294 struct bfi_ioc_image_hdr *fwhdr);
295 void bfa_nw_ioc_get_mac(struct bfa_ioc *ioc, u8 *mac);
296 void bfa_nw_ioc_debug_memclaim(struct bfa_ioc *ioc, void *dbg_fwsave);
297 int bfa_nw_ioc_debug_fwtrc(struct bfa_ioc *ioc, void *trcdata, int *trclen);
298 int bfa_nw_ioc_debug_fwsave(struct bfa_ioc *ioc, void *trcdata, int *trclen);
299
300 /*
301 * Timeout APIs
302 */
303 void bfa_nw_ioc_timeout(struct bfa_ioc *ioc);
304 void bfa_nw_ioc_hb_check(struct bfa_ioc *ioc);
305 void bfa_nw_iocpf_timeout(struct bfa_ioc *ioc);
306 void bfa_nw_iocpf_sem_timeout(struct bfa_ioc *ioc);
307
308 /*
309 * F/W Image Size & Chunk
310 */
311 u32 *bfa_cb_image_get_chunk(enum bfi_asic_gen asic_gen, u32 off);
312 u32 bfa_cb_image_get_size(enum bfi_asic_gen asic_gen);
313
314 /*
315 * Flash module specific
316 */
317 typedef void (*bfa_cb_flash) (void *cbarg, enum bfa_status status);
318
319 struct bfa_flash {
320 struct bfa_ioc *ioc; /* back pointer to ioc */
321 u32 type; /* partition type */
322 u8 instance; /* partition instance */
323 u8 rsv[3];
324 u32 op_busy; /* operation busy flag */
325 u32 residue; /* residual length */
326 u32 offset; /* offset */
327 enum bfa_status status; /* status */
328 u8 *dbuf_kva; /* dma buf virtual address */
329 u64 dbuf_pa; /* dma buf physical address */
330 bfa_cb_flash cbfn; /* user callback function */
331 void *cbarg; /* user callback arg */
332 u8 *ubuf; /* user supplied buffer */
333 u32 addr_off; /* partition address offset */
334 struct bfa_mbox_cmd mb; /* mailbox */
335 struct bfa_ioc_notify ioc_notify; /* ioc event notify */
336 };
337
338 enum bfa_status bfa_nw_flash_get_attr(struct bfa_flash *flash,
339 struct bfa_flash_attr *attr,
340 bfa_cb_flash cbfn, void *cbarg);
341 enum bfa_status bfa_nw_flash_update_part(struct bfa_flash *flash,
342 u32 type, u8 instance, void *buf, u32 len, u32 offset,
343 bfa_cb_flash cbfn, void *cbarg);
344 enum bfa_status bfa_nw_flash_read_part(struct bfa_flash *flash,
345 u32 type, u8 instance, void *buf, u32 len, u32 offset,
346 bfa_cb_flash cbfn, void *cbarg);
347 u32 bfa_nw_flash_meminfo(void);
348 void bfa_nw_flash_attach(struct bfa_flash *flash,
349 struct bfa_ioc *ioc, void *dev);
350 void bfa_nw_flash_memclaim(struct bfa_flash *flash, u8 *dm_kva, u64 dm_pa);
351
352 #endif /* __BFA_IOC_H__ */
353