1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /* Copyright (c) 2019-2020 Marvell International Ltd. All rights reserved */
3
4 #include <linux/bitfield.h>
5 #include <linux/circ_buf.h>
6 #include <linux/device.h>
7 #include <linux/firmware.h>
8 #include <linux/iopoll.h>
9 #include <linux/kernel.h>
10 #include <linux/module.h>
11 #include <linux/pci.h>
12
13 #include "prestera.h"
14
15 #define PRESTERA_MSG_MAX_SIZE 1500
16
17 #define PRESTERA_SUPP_FW_MAJ_VER 4
18 #define PRESTERA_SUPP_FW_MIN_VER 1
19
20 #define PRESTERA_PREV_FW_MAJ_VER 4
21 #define PRESTERA_PREV_FW_MIN_VER 0
22
23 #define PRESTERA_FW_PATH_FMT "mrvl/prestera/mvsw_prestera_fw-v%u.%u.img"
24 #define PRESTERA_FW_ARM64_PATH_FMT "mrvl/prestera/mvsw_prestera_fw_arm64-v%u.%u.img"
25
26 #define PRESTERA_FW_HDR_MAGIC 0x351D9D06
27 #define PRESTERA_FW_DL_TIMEOUT_MS 50000
28 #define PRESTERA_FW_BLK_SZ 1024
29
30 #define PRESTERA_FW_VER_MAJ_MUL 1000000
31 #define PRESTERA_FW_VER_MIN_MUL 1000
32
33 #define PRESTERA_FW_VER_MAJ(v) ((v) / PRESTERA_FW_VER_MAJ_MUL)
34
35 #define PRESTERA_FW_VER_MIN(v) \
36 (((v) - (PRESTERA_FW_VER_MAJ(v) * PRESTERA_FW_VER_MAJ_MUL)) / \
37 PRESTERA_FW_VER_MIN_MUL)
38
39 #define PRESTERA_FW_VER_PATCH(v) \
40 ((v) - (PRESTERA_FW_VER_MAJ(v) * PRESTERA_FW_VER_MAJ_MUL) - \
41 (PRESTERA_FW_VER_MIN(v) * PRESTERA_FW_VER_MIN_MUL))
42
43 enum prestera_pci_bar_t {
44 PRESTERA_PCI_BAR_FW = 2,
45 PRESTERA_PCI_BAR_PP = 4,
46 };
47
48 struct prestera_fw_header {
49 __be32 magic_number;
50 __be32 version_value;
51 u8 reserved[8];
52 };
53
54 struct prestera_ldr_regs {
55 u32 ldr_ready;
56 u32 pad1;
57
58 u32 ldr_img_size;
59 u32 ldr_ctl_flags;
60
61 u32 ldr_buf_offs;
62 u32 ldr_buf_size;
63
64 u32 ldr_buf_rd;
65 u32 pad2;
66 u32 ldr_buf_wr;
67
68 u32 ldr_status;
69 };
70
71 #define PRESTERA_LDR_REG_OFFSET(f) offsetof(struct prestera_ldr_regs, f)
72
73 #define PRESTERA_LDR_READY_MAGIC 0xf00dfeed
74
75 #define PRESTERA_LDR_STATUS_IMG_DL BIT(0)
76 #define PRESTERA_LDR_STATUS_START_FW BIT(1)
77 #define PRESTERA_LDR_STATUS_INVALID_IMG BIT(2)
78 #define PRESTERA_LDR_STATUS_NOMEM BIT(3)
79
80 #define PRESTERA_LDR_REG_BASE(fw) ((fw)->ldr_regs)
81 #define PRESTERA_LDR_REG_ADDR(fw, reg) (PRESTERA_LDR_REG_BASE(fw) + (reg))
82
83 /* fw loader registers */
84 #define PRESTERA_LDR_READY_REG PRESTERA_LDR_REG_OFFSET(ldr_ready)
85 #define PRESTERA_LDR_IMG_SIZE_REG PRESTERA_LDR_REG_OFFSET(ldr_img_size)
86 #define PRESTERA_LDR_CTL_REG PRESTERA_LDR_REG_OFFSET(ldr_ctl_flags)
87 #define PRESTERA_LDR_BUF_SIZE_REG PRESTERA_LDR_REG_OFFSET(ldr_buf_size)
88 #define PRESTERA_LDR_BUF_OFFS_REG PRESTERA_LDR_REG_OFFSET(ldr_buf_offs)
89 #define PRESTERA_LDR_BUF_RD_REG PRESTERA_LDR_REG_OFFSET(ldr_buf_rd)
90 #define PRESTERA_LDR_BUF_WR_REG PRESTERA_LDR_REG_OFFSET(ldr_buf_wr)
91 #define PRESTERA_LDR_STATUS_REG PRESTERA_LDR_REG_OFFSET(ldr_status)
92
93 #define PRESTERA_LDR_CTL_DL_START BIT(0)
94
95 #define PRESTERA_EVT_QNUM_MAX 4
96
97 struct prestera_fw_evtq_regs {
98 u32 rd_idx;
99 u32 pad1;
100 u32 wr_idx;
101 u32 pad2;
102 u32 offs;
103 u32 len;
104 };
105
106 #define PRESTERA_CMD_QNUM_MAX 4
107
108 struct prestera_fw_cmdq_regs {
109 u32 req_ctl;
110 u32 req_len;
111 u32 rcv_ctl;
112 u32 rcv_len;
113 u32 offs;
114 u32 len;
115 };
116
117 struct prestera_fw_regs {
118 u32 fw_ready;
119 u32 cmd_offs;
120 u32 cmd_len;
121 u32 cmd_qnum;
122 u32 evt_offs;
123 u32 evt_qnum;
124
125 u32 fw_status;
126 u32 rx_status;
127
128 struct prestera_fw_cmdq_regs cmdq_list[PRESTERA_EVT_QNUM_MAX];
129 struct prestera_fw_evtq_regs evtq_list[PRESTERA_CMD_QNUM_MAX];
130 };
131
132 #define PRESTERA_FW_REG_OFFSET(f) offsetof(struct prestera_fw_regs, f)
133
134 #define PRESTERA_FW_READY_MAGIC 0xcafebabe
135
136 /* fw registers */
137 #define PRESTERA_FW_READY_REG PRESTERA_FW_REG_OFFSET(fw_ready)
138
139 #define PRESTERA_CMD_BUF_OFFS_REG PRESTERA_FW_REG_OFFSET(cmd_offs)
140 #define PRESTERA_CMD_BUF_LEN_REG PRESTERA_FW_REG_OFFSET(cmd_len)
141 #define PRESTERA_CMD_QNUM_REG PRESTERA_FW_REG_OFFSET(cmd_qnum)
142 #define PRESTERA_EVT_BUF_OFFS_REG PRESTERA_FW_REG_OFFSET(evt_offs)
143 #define PRESTERA_EVT_QNUM_REG PRESTERA_FW_REG_OFFSET(evt_qnum)
144
145 #define PRESTERA_CMDQ_REG_OFFSET(q, f) \
146 (PRESTERA_FW_REG_OFFSET(cmdq_list) + \
147 (q) * sizeof(struct prestera_fw_cmdq_regs) + \
148 offsetof(struct prestera_fw_cmdq_regs, f))
149
150 #define PRESTERA_CMDQ_REQ_CTL_REG(q) PRESTERA_CMDQ_REG_OFFSET(q, req_ctl)
151 #define PRESTERA_CMDQ_REQ_LEN_REG(q) PRESTERA_CMDQ_REG_OFFSET(q, req_len)
152 #define PRESTERA_CMDQ_RCV_CTL_REG(q) PRESTERA_CMDQ_REG_OFFSET(q, rcv_ctl)
153 #define PRESTERA_CMDQ_RCV_LEN_REG(q) PRESTERA_CMDQ_REG_OFFSET(q, rcv_len)
154 #define PRESTERA_CMDQ_OFFS_REG(q) PRESTERA_CMDQ_REG_OFFSET(q, offs)
155 #define PRESTERA_CMDQ_LEN_REG(q) PRESTERA_CMDQ_REG_OFFSET(q, len)
156
157 #define PRESTERA_FW_STATUS_REG PRESTERA_FW_REG_OFFSET(fw_status)
158 #define PRESTERA_RX_STATUS_REG PRESTERA_FW_REG_OFFSET(rx_status)
159
160 /* PRESTERA_CMD_REQ_CTL_REG flags */
161 #define PRESTERA_CMD_F_REQ_SENT BIT(0)
162 #define PRESTERA_CMD_F_REPL_RCVD BIT(1)
163
164 /* PRESTERA_CMD_RCV_CTL_REG flags */
165 #define PRESTERA_CMD_F_REPL_SENT BIT(0)
166
167 #define PRESTERA_FW_EVT_CTL_STATUS_MASK GENMASK(1, 0)
168
169 #define PRESTERA_FW_EVT_CTL_STATUS_ON 0
170 #define PRESTERA_FW_EVT_CTL_STATUS_OFF 1
171
172 #define PRESTERA_EVTQ_REG_OFFSET(q, f) \
173 (PRESTERA_FW_REG_OFFSET(evtq_list) + \
174 (q) * sizeof(struct prestera_fw_evtq_regs) + \
175 offsetof(struct prestera_fw_evtq_regs, f))
176
177 #define PRESTERA_EVTQ_RD_IDX_REG(q) PRESTERA_EVTQ_REG_OFFSET(q, rd_idx)
178 #define PRESTERA_EVTQ_WR_IDX_REG(q) PRESTERA_EVTQ_REG_OFFSET(q, wr_idx)
179 #define PRESTERA_EVTQ_OFFS_REG(q) PRESTERA_EVTQ_REG_OFFSET(q, offs)
180 #define PRESTERA_EVTQ_LEN_REG(q) PRESTERA_EVTQ_REG_OFFSET(q, len)
181
182 #define PRESTERA_FW_REG_BASE(fw) ((fw)->dev.ctl_regs)
183 #define PRESTERA_FW_REG_ADDR(fw, reg) PRESTERA_FW_REG_BASE((fw)) + (reg)
184
185 #define PRESTERA_FW_CMD_DEFAULT_WAIT_MS 30000
186 #define PRESTERA_FW_READY_WAIT_MS 20000
187
188 #define PRESTERA_DEV_ID_AC3X_98DX_55 0xC804
189 #define PRESTERA_DEV_ID_AC3X_98DX_65 0xC80C
190 #define PRESTERA_DEV_ID_ALDRIN2 0xCC1E
191 #define PRESTERA_DEV_ID_98DX7312M 0x981F
192 #define PRESTERA_DEV_ID_98DX3500 0x9820
193 #define PRESTERA_DEV_ID_98DX3501 0x9826
194 #define PRESTERA_DEV_ID_98DX3510 0x9821
195 #define PRESTERA_DEV_ID_98DX3520 0x9822
196
197 struct prestera_fw_evtq {
198 u8 __iomem *addr;
199 size_t len;
200 };
201
202 struct prestera_fw_cmdq {
203 /* serialize access to dev->send_req */
204 struct mutex cmd_mtx;
205 u8 __iomem *addr;
206 size_t len;
207 };
208
209 struct prestera_fw {
210 struct prestera_fw_rev rev_supp;
211 const struct firmware *bin;
212 struct workqueue_struct *wq;
213 struct prestera_device dev;
214 struct pci_dev *pci_dev;
215 u8 __iomem *ldr_regs;
216 u8 __iomem *ldr_ring_buf;
217 u32 ldr_buf_len;
218 u32 ldr_wr_idx;
219 size_t cmd_mbox_len;
220 u8 __iomem *cmd_mbox;
221 struct prestera_fw_cmdq cmd_queue[PRESTERA_CMD_QNUM_MAX];
222 u8 cmd_qnum;
223 struct prestera_fw_evtq evt_queue[PRESTERA_EVT_QNUM_MAX];
224 u8 evt_qnum;
225 struct work_struct evt_work;
226 u8 __iomem *evt_buf;
227 u8 *evt_msg;
228 };
229
230 static int prestera_fw_load(struct prestera_fw *fw);
231
prestera_fw_write(struct prestera_fw * fw,u32 reg,u32 val)232 static void prestera_fw_write(struct prestera_fw *fw, u32 reg, u32 val)
233 {
234 writel(val, PRESTERA_FW_REG_ADDR(fw, reg));
235 }
236
prestera_fw_read(struct prestera_fw * fw,u32 reg)237 static u32 prestera_fw_read(struct prestera_fw *fw, u32 reg)
238 {
239 return readl(PRESTERA_FW_REG_ADDR(fw, reg));
240 }
241
prestera_fw_evtq_len(struct prestera_fw * fw,u8 qid)242 static u32 prestera_fw_evtq_len(struct prestera_fw *fw, u8 qid)
243 {
244 return fw->evt_queue[qid].len;
245 }
246
prestera_fw_evtq_avail(struct prestera_fw * fw,u8 qid)247 static u32 prestera_fw_evtq_avail(struct prestera_fw *fw, u8 qid)
248 {
249 u32 wr_idx = prestera_fw_read(fw, PRESTERA_EVTQ_WR_IDX_REG(qid));
250 u32 rd_idx = prestera_fw_read(fw, PRESTERA_EVTQ_RD_IDX_REG(qid));
251
252 return CIRC_CNT(wr_idx, rd_idx, prestera_fw_evtq_len(fw, qid));
253 }
254
prestera_fw_evtq_rd_set(struct prestera_fw * fw,u8 qid,u32 idx)255 static void prestera_fw_evtq_rd_set(struct prestera_fw *fw,
256 u8 qid, u32 idx)
257 {
258 u32 rd_idx = idx & (prestera_fw_evtq_len(fw, qid) - 1);
259
260 prestera_fw_write(fw, PRESTERA_EVTQ_RD_IDX_REG(qid), rd_idx);
261 }
262
prestera_fw_evtq_buf(struct prestera_fw * fw,u8 qid)263 static u8 __iomem *prestera_fw_evtq_buf(struct prestera_fw *fw, u8 qid)
264 {
265 return fw->evt_queue[qid].addr;
266 }
267
prestera_fw_evtq_read32(struct prestera_fw * fw,u8 qid)268 static u32 prestera_fw_evtq_read32(struct prestera_fw *fw, u8 qid)
269 {
270 u32 rd_idx = prestera_fw_read(fw, PRESTERA_EVTQ_RD_IDX_REG(qid));
271 u32 val;
272
273 val = readl(prestera_fw_evtq_buf(fw, qid) + rd_idx);
274 prestera_fw_evtq_rd_set(fw, qid, rd_idx + 4);
275 return val;
276 }
277
prestera_fw_evtq_read_buf(struct prestera_fw * fw,u8 qid,void * buf,size_t len)278 static ssize_t prestera_fw_evtq_read_buf(struct prestera_fw *fw,
279 u8 qid, void *buf, size_t len)
280 {
281 u32 idx = prestera_fw_read(fw, PRESTERA_EVTQ_RD_IDX_REG(qid));
282 u8 __iomem *evtq_addr = prestera_fw_evtq_buf(fw, qid);
283 u32 *buf32 = buf;
284 int i;
285
286 for (i = 0; i < len / 4; buf32++, i++) {
287 *buf32 = readl_relaxed(evtq_addr + idx);
288 idx = (idx + 4) & (prestera_fw_evtq_len(fw, qid) - 1);
289 }
290
291 prestera_fw_evtq_rd_set(fw, qid, idx);
292
293 return i;
294 }
295
prestera_fw_evtq_pick(struct prestera_fw * fw)296 static u8 prestera_fw_evtq_pick(struct prestera_fw *fw)
297 {
298 int qid;
299
300 for (qid = 0; qid < fw->evt_qnum; qid++) {
301 if (prestera_fw_evtq_avail(fw, qid) >= 4)
302 return qid;
303 }
304
305 return PRESTERA_EVT_QNUM_MAX;
306 }
307
prestera_fw_evt_ctl_status_set(struct prestera_fw * fw,u32 val)308 static void prestera_fw_evt_ctl_status_set(struct prestera_fw *fw, u32 val)
309 {
310 u32 status = prestera_fw_read(fw, PRESTERA_FW_STATUS_REG);
311
312 u32p_replace_bits(&status, val, PRESTERA_FW_EVT_CTL_STATUS_MASK);
313
314 prestera_fw_write(fw, PRESTERA_FW_STATUS_REG, status);
315 }
316
prestera_fw_evt_work_fn(struct work_struct * work)317 static void prestera_fw_evt_work_fn(struct work_struct *work)
318 {
319 struct prestera_fw *fw;
320 void *msg;
321 u8 qid;
322
323 fw = container_of(work, struct prestera_fw, evt_work);
324 msg = fw->evt_msg;
325
326 prestera_fw_evt_ctl_status_set(fw, PRESTERA_FW_EVT_CTL_STATUS_OFF);
327
328 while ((qid = prestera_fw_evtq_pick(fw)) < PRESTERA_EVT_QNUM_MAX) {
329 u32 idx;
330 u32 len;
331
332 len = prestera_fw_evtq_read32(fw, qid);
333 idx = prestera_fw_read(fw, PRESTERA_EVTQ_RD_IDX_REG(qid));
334
335 WARN_ON(prestera_fw_evtq_avail(fw, qid) < len);
336
337 if (WARN_ON(len > PRESTERA_MSG_MAX_SIZE)) {
338 prestera_fw_evtq_rd_set(fw, qid, idx + len);
339 continue;
340 }
341
342 prestera_fw_evtq_read_buf(fw, qid, msg, len);
343
344 if (fw->dev.recv_msg)
345 fw->dev.recv_msg(&fw->dev, msg, len);
346 }
347
348 prestera_fw_evt_ctl_status_set(fw, PRESTERA_FW_EVT_CTL_STATUS_ON);
349 }
350
prestera_fw_wait_reg32(struct prestera_fw * fw,u32 reg,u32 cmp,unsigned int waitms)351 static int prestera_fw_wait_reg32(struct prestera_fw *fw, u32 reg, u32 cmp,
352 unsigned int waitms)
353 {
354 u8 __iomem *addr = PRESTERA_FW_REG_ADDR(fw, reg);
355 u32 val;
356
357 return readl_poll_timeout(addr, val, cmp == val,
358 1 * USEC_PER_MSEC, waitms * USEC_PER_MSEC);
359 }
360
prestera_fw_cmdq_lock(struct prestera_fw * fw,u8 qid)361 static void prestera_fw_cmdq_lock(struct prestera_fw *fw, u8 qid)
362 {
363 mutex_lock(&fw->cmd_queue[qid].cmd_mtx);
364 }
365
prestera_fw_cmdq_unlock(struct prestera_fw * fw,u8 qid)366 static void prestera_fw_cmdq_unlock(struct prestera_fw *fw, u8 qid)
367 {
368 mutex_unlock(&fw->cmd_queue[qid].cmd_mtx);
369 }
370
prestera_fw_cmdq_len(struct prestera_fw * fw,u8 qid)371 static u32 prestera_fw_cmdq_len(struct prestera_fw *fw, u8 qid)
372 {
373 return fw->cmd_queue[qid].len;
374 }
375
prestera_fw_cmdq_buf(struct prestera_fw * fw,u8 qid)376 static u8 __iomem *prestera_fw_cmdq_buf(struct prestera_fw *fw, u8 qid)
377 {
378 return fw->cmd_queue[qid].addr;
379 }
380
prestera_fw_cmd_send(struct prestera_fw * fw,int qid,void * in_msg,size_t in_size,void * out_msg,size_t out_size,unsigned int waitms)381 static int prestera_fw_cmd_send(struct prestera_fw *fw, int qid,
382 void *in_msg, size_t in_size,
383 void *out_msg, size_t out_size,
384 unsigned int waitms)
385 {
386 u32 ret_size;
387 int err;
388
389 if (!waitms)
390 waitms = PRESTERA_FW_CMD_DEFAULT_WAIT_MS;
391
392 if (ALIGN(in_size, 4) > prestera_fw_cmdq_len(fw, qid))
393 return -EMSGSIZE;
394
395 /* wait for finish previous reply from FW */
396 err = prestera_fw_wait_reg32(fw, PRESTERA_CMDQ_RCV_CTL_REG(qid), 0, 30);
397 if (err) {
398 dev_err(fw->dev.dev, "finish reply from FW is timed out\n");
399 return err;
400 }
401
402 prestera_fw_write(fw, PRESTERA_CMDQ_REQ_LEN_REG(qid), in_size);
403
404 memcpy_toio(prestera_fw_cmdq_buf(fw, qid), in_msg, in_size);
405
406 prestera_fw_write(fw, PRESTERA_CMDQ_REQ_CTL_REG(qid),
407 PRESTERA_CMD_F_REQ_SENT);
408
409 /* wait for reply from FW */
410 err = prestera_fw_wait_reg32(fw, PRESTERA_CMDQ_RCV_CTL_REG(qid),
411 PRESTERA_CMD_F_REPL_SENT, waitms);
412 if (err) {
413 dev_err(fw->dev.dev, "reply from FW is timed out\n");
414 goto cmd_exit;
415 }
416
417 ret_size = prestera_fw_read(fw, PRESTERA_CMDQ_RCV_LEN_REG(qid));
418 if (ret_size > out_size) {
419 dev_err(fw->dev.dev, "ret_size (%u) > out_len(%zu)\n",
420 ret_size, out_size);
421 err = -EMSGSIZE;
422 goto cmd_exit;
423 }
424
425 memcpy_fromio(out_msg,
426 prestera_fw_cmdq_buf(fw, qid) + in_size, ret_size);
427
428 cmd_exit:
429 prestera_fw_write(fw, PRESTERA_CMDQ_REQ_CTL_REG(qid),
430 PRESTERA_CMD_F_REPL_RCVD);
431 return err;
432 }
433
prestera_fw_send_req(struct prestera_device * dev,int qid,void * in_msg,size_t in_size,void * out_msg,size_t out_size,unsigned int waitms)434 static int prestera_fw_send_req(struct prestera_device *dev, int qid,
435 void *in_msg, size_t in_size, void *out_msg,
436 size_t out_size, unsigned int waitms)
437 {
438 struct prestera_fw *fw;
439 ssize_t ret;
440
441 fw = container_of(dev, struct prestera_fw, dev);
442
443 prestera_fw_cmdq_lock(fw, qid);
444 ret = prestera_fw_cmd_send(fw, qid, in_msg, in_size, out_msg, out_size,
445 waitms);
446 prestera_fw_cmdq_unlock(fw, qid);
447
448 return ret;
449 }
450
prestera_fw_init(struct prestera_fw * fw)451 static int prestera_fw_init(struct prestera_fw *fw)
452 {
453 u8 __iomem *base;
454 int err;
455 u8 qid;
456
457 fw->dev.send_req = prestera_fw_send_req;
458 fw->ldr_regs = fw->dev.ctl_regs;
459
460 err = prestera_fw_load(fw);
461 if (err)
462 return err;
463
464 err = prestera_fw_wait_reg32(fw, PRESTERA_FW_READY_REG,
465 PRESTERA_FW_READY_MAGIC,
466 PRESTERA_FW_READY_WAIT_MS);
467 if (err) {
468 dev_err(fw->dev.dev, "FW failed to start\n");
469 return err;
470 }
471
472 base = fw->dev.ctl_regs;
473
474 fw->cmd_mbox = base + prestera_fw_read(fw, PRESTERA_CMD_BUF_OFFS_REG);
475 fw->cmd_mbox_len = prestera_fw_read(fw, PRESTERA_CMD_BUF_LEN_REG);
476 fw->cmd_qnum = prestera_fw_read(fw, PRESTERA_CMD_QNUM_REG);
477
478 for (qid = 0; qid < fw->cmd_qnum; qid++) {
479 u32 offs = prestera_fw_read(fw, PRESTERA_CMDQ_OFFS_REG(qid));
480 struct prestera_fw_cmdq *cmdq = &fw->cmd_queue[qid];
481
482 cmdq->len = prestera_fw_read(fw, PRESTERA_CMDQ_LEN_REG(qid));
483 cmdq->addr = fw->cmd_mbox + offs;
484 mutex_init(&cmdq->cmd_mtx);
485 }
486
487 fw->evt_buf = base + prestera_fw_read(fw, PRESTERA_EVT_BUF_OFFS_REG);
488 fw->evt_qnum = prestera_fw_read(fw, PRESTERA_EVT_QNUM_REG);
489 fw->evt_msg = kmalloc(PRESTERA_MSG_MAX_SIZE, GFP_KERNEL);
490 if (!fw->evt_msg)
491 return -ENOMEM;
492
493 for (qid = 0; qid < fw->evt_qnum; qid++) {
494 u32 offs = prestera_fw_read(fw, PRESTERA_EVTQ_OFFS_REG(qid));
495 struct prestera_fw_evtq *evtq = &fw->evt_queue[qid];
496
497 evtq->len = prestera_fw_read(fw, PRESTERA_EVTQ_LEN_REG(qid));
498 evtq->addr = fw->evt_buf + offs;
499 }
500
501 return 0;
502 }
503
prestera_fw_uninit(struct prestera_fw * fw)504 static void prestera_fw_uninit(struct prestera_fw *fw)
505 {
506 kfree(fw->evt_msg);
507 }
508
prestera_pci_irq_handler(int irq,void * dev_id)509 static irqreturn_t prestera_pci_irq_handler(int irq, void *dev_id)
510 {
511 struct prestera_fw *fw = dev_id;
512
513 if (prestera_fw_read(fw, PRESTERA_RX_STATUS_REG)) {
514 prestera_fw_write(fw, PRESTERA_RX_STATUS_REG, 0);
515
516 if (fw->dev.recv_pkt)
517 fw->dev.recv_pkt(&fw->dev);
518 }
519
520 queue_work(fw->wq, &fw->evt_work);
521
522 return IRQ_HANDLED;
523 }
524
prestera_ldr_write(struct prestera_fw * fw,u32 reg,u32 val)525 static void prestera_ldr_write(struct prestera_fw *fw, u32 reg, u32 val)
526 {
527 writel(val, PRESTERA_LDR_REG_ADDR(fw, reg));
528 }
529
prestera_ldr_read(struct prestera_fw * fw,u32 reg)530 static u32 prestera_ldr_read(struct prestera_fw *fw, u32 reg)
531 {
532 return readl(PRESTERA_LDR_REG_ADDR(fw, reg));
533 }
534
prestera_ldr_wait_reg32(struct prestera_fw * fw,u32 reg,u32 cmp,unsigned int waitms)535 static int prestera_ldr_wait_reg32(struct prestera_fw *fw,
536 u32 reg, u32 cmp, unsigned int waitms)
537 {
538 u8 __iomem *addr = PRESTERA_LDR_REG_ADDR(fw, reg);
539 u32 val;
540
541 return readl_poll_timeout(addr, val, cmp == val,
542 10 * USEC_PER_MSEC, waitms * USEC_PER_MSEC);
543 }
544
prestera_ldr_wait_buf(struct prestera_fw * fw,size_t len)545 static int prestera_ldr_wait_buf(struct prestera_fw *fw, size_t len)
546 {
547 u8 __iomem *addr = PRESTERA_LDR_REG_ADDR(fw, PRESTERA_LDR_BUF_RD_REG);
548 u32 buf_len = fw->ldr_buf_len;
549 u32 wr_idx = fw->ldr_wr_idx;
550 u32 rd_idx;
551
552 return readl_poll_timeout(addr, rd_idx,
553 CIRC_SPACE(wr_idx, rd_idx, buf_len) >= len,
554 1 * USEC_PER_MSEC, 100 * USEC_PER_MSEC);
555 }
556
prestera_ldr_wait_dl_finish(struct prestera_fw * fw)557 static int prestera_ldr_wait_dl_finish(struct prestera_fw *fw)
558 {
559 u8 __iomem *addr = PRESTERA_LDR_REG_ADDR(fw, PRESTERA_LDR_STATUS_REG);
560 unsigned long mask = ~(PRESTERA_LDR_STATUS_IMG_DL);
561 u32 val;
562 int err;
563
564 err = readl_poll_timeout(addr, val, val & mask, 10 * USEC_PER_MSEC,
565 PRESTERA_FW_DL_TIMEOUT_MS * USEC_PER_MSEC);
566 if (err) {
567 dev_err(fw->dev.dev, "Timeout to load FW img [state=%d]",
568 prestera_ldr_read(fw, PRESTERA_LDR_STATUS_REG));
569 return err;
570 }
571
572 return 0;
573 }
574
prestera_ldr_wr_idx_move(struct prestera_fw * fw,unsigned int n)575 static void prestera_ldr_wr_idx_move(struct prestera_fw *fw, unsigned int n)
576 {
577 fw->ldr_wr_idx = (fw->ldr_wr_idx + (n)) & (fw->ldr_buf_len - 1);
578 }
579
prestera_ldr_wr_idx_commit(struct prestera_fw * fw)580 static void prestera_ldr_wr_idx_commit(struct prestera_fw *fw)
581 {
582 prestera_ldr_write(fw, PRESTERA_LDR_BUF_WR_REG, fw->ldr_wr_idx);
583 }
584
prestera_ldr_wr_ptr(struct prestera_fw * fw)585 static u8 __iomem *prestera_ldr_wr_ptr(struct prestera_fw *fw)
586 {
587 return fw->ldr_ring_buf + fw->ldr_wr_idx;
588 }
589
prestera_ldr_send(struct prestera_fw * fw,const u8 * buf,size_t len)590 static int prestera_ldr_send(struct prestera_fw *fw, const u8 *buf, size_t len)
591 {
592 int err;
593 int i;
594
595 err = prestera_ldr_wait_buf(fw, len);
596 if (err) {
597 dev_err(fw->dev.dev, "failed wait for sending firmware\n");
598 return err;
599 }
600
601 for (i = 0; i < len; i += 4) {
602 writel_relaxed(*(u32 *)(buf + i), prestera_ldr_wr_ptr(fw));
603 prestera_ldr_wr_idx_move(fw, 4);
604 }
605
606 prestera_ldr_wr_idx_commit(fw);
607 return 0;
608 }
609
prestera_ldr_fw_send(struct prestera_fw * fw,const char * img,u32 fw_size)610 static int prestera_ldr_fw_send(struct prestera_fw *fw,
611 const char *img, u32 fw_size)
612 {
613 u32 status;
614 u32 pos;
615 int err;
616
617 err = prestera_ldr_wait_reg32(fw, PRESTERA_LDR_STATUS_REG,
618 PRESTERA_LDR_STATUS_IMG_DL,
619 5 * MSEC_PER_SEC);
620 if (err) {
621 dev_err(fw->dev.dev, "Loader is not ready to load image\n");
622 return err;
623 }
624
625 for (pos = 0; pos < fw_size; pos += PRESTERA_FW_BLK_SZ) {
626 if (pos + PRESTERA_FW_BLK_SZ > fw_size)
627 break;
628
629 err = prestera_ldr_send(fw, img + pos, PRESTERA_FW_BLK_SZ);
630 if (err)
631 return err;
632 }
633
634 if (pos < fw_size) {
635 err = prestera_ldr_send(fw, img + pos, fw_size - pos);
636 if (err)
637 return err;
638 }
639
640 err = prestera_ldr_wait_dl_finish(fw);
641 if (err)
642 return err;
643
644 status = prestera_ldr_read(fw, PRESTERA_LDR_STATUS_REG);
645
646 switch (status) {
647 case PRESTERA_LDR_STATUS_INVALID_IMG:
648 dev_err(fw->dev.dev, "FW img has bad CRC\n");
649 return -EINVAL;
650 case PRESTERA_LDR_STATUS_NOMEM:
651 dev_err(fw->dev.dev, "Loader has no enough mem\n");
652 return -ENOMEM;
653 }
654
655 return 0;
656 }
657
prestera_fw_rev_parse(const struct prestera_fw_header * hdr,struct prestera_fw_rev * rev)658 static void prestera_fw_rev_parse(const struct prestera_fw_header *hdr,
659 struct prestera_fw_rev *rev)
660 {
661 u32 version = be32_to_cpu(hdr->version_value);
662
663 rev->maj = PRESTERA_FW_VER_MAJ(version);
664 rev->min = PRESTERA_FW_VER_MIN(version);
665 rev->sub = PRESTERA_FW_VER_PATCH(version);
666 }
667
prestera_fw_rev_check(struct prestera_fw * fw)668 static int prestera_fw_rev_check(struct prestera_fw *fw)
669 {
670 struct prestera_fw_rev *rev = &fw->dev.fw_rev;
671
672 if (rev->maj == fw->rev_supp.maj && rev->min >= fw->rev_supp.min)
673 return 0;
674
675 dev_err(fw->dev.dev, "Driver supports FW version only '%u.%u.x'",
676 fw->rev_supp.maj, fw->rev_supp.min);
677
678 return -EINVAL;
679 }
680
prestera_fw_hdr_parse(struct prestera_fw * fw)681 static int prestera_fw_hdr_parse(struct prestera_fw *fw)
682 {
683 struct prestera_fw_rev *rev = &fw->dev.fw_rev;
684 struct prestera_fw_header *hdr;
685 u32 magic;
686
687 if (fw->bin->size < sizeof(*hdr))
688 return -EINVAL;
689
690 hdr = (struct prestera_fw_header *)fw->bin->data;
691
692 magic = be32_to_cpu(hdr->magic_number);
693 if (magic != PRESTERA_FW_HDR_MAGIC) {
694 dev_err(fw->dev.dev, "FW img hdr magic is invalid");
695 return -EINVAL;
696 }
697
698 prestera_fw_rev_parse(hdr, rev);
699
700 dev_info(fw->dev.dev, "FW version '%u.%u.%u'\n",
701 rev->maj, rev->min, rev->sub);
702
703 return prestera_fw_rev_check(fw);
704 }
705
prestera_fw_path_fmt_get(struct prestera_fw * fw)706 static const char *prestera_fw_path_fmt_get(struct prestera_fw *fw)
707 {
708 switch (fw->pci_dev->device) {
709 case PRESTERA_DEV_ID_98DX3500:
710 case PRESTERA_DEV_ID_98DX3501:
711 case PRESTERA_DEV_ID_98DX3510:
712 case PRESTERA_DEV_ID_98DX3520:
713 return PRESTERA_FW_ARM64_PATH_FMT;
714
715 default:
716 return PRESTERA_FW_PATH_FMT;
717 }
718 }
719
prestera_fw_get(struct prestera_fw * fw)720 static int prestera_fw_get(struct prestera_fw *fw)
721 {
722 int ver_maj = PRESTERA_SUPP_FW_MAJ_VER;
723 int ver_min = PRESTERA_SUPP_FW_MIN_VER;
724 char fw_path[128];
725 int err;
726
727 pick_fw_ver:
728 snprintf(fw_path, sizeof(fw_path), prestera_fw_path_fmt_get(fw),
729 ver_maj, ver_min);
730
731 err = request_firmware_direct(&fw->bin, fw_path, fw->dev.dev);
732 if (err) {
733 if (ver_maj != PRESTERA_PREV_FW_MAJ_VER ||
734 ver_min != PRESTERA_PREV_FW_MIN_VER) {
735 ver_maj = PRESTERA_PREV_FW_MAJ_VER;
736 ver_min = PRESTERA_PREV_FW_MIN_VER;
737
738 dev_warn(fw->dev.dev,
739 "missing latest %s firmware, fall-back to previous %u.%u version\n",
740 fw_path, ver_maj, ver_min);
741
742 goto pick_fw_ver;
743 } else {
744 dev_err(fw->dev.dev, "failed to request previous firmware: %s\n",
745 fw_path);
746 return err;
747 }
748 }
749
750 dev_info(fw->dev.dev, "Loading %s ...", fw_path);
751
752 fw->rev_supp.maj = ver_maj;
753 fw->rev_supp.min = ver_min;
754 fw->rev_supp.sub = 0;
755
756 return 0;
757 }
758
prestera_fw_put(struct prestera_fw * fw)759 static void prestera_fw_put(struct prestera_fw *fw)
760 {
761 release_firmware(fw->bin);
762 }
763
prestera_fw_load(struct prestera_fw * fw)764 static int prestera_fw_load(struct prestera_fw *fw)
765 {
766 size_t hlen = sizeof(struct prestera_fw_header);
767 int err;
768
769 err = prestera_ldr_wait_reg32(fw, PRESTERA_LDR_READY_REG,
770 PRESTERA_LDR_READY_MAGIC,
771 5 * MSEC_PER_SEC);
772 if (err) {
773 dev_err(fw->dev.dev, "waiting for FW loader is timed out");
774 return err;
775 }
776
777 fw->ldr_ring_buf = fw->ldr_regs +
778 prestera_ldr_read(fw, PRESTERA_LDR_BUF_OFFS_REG);
779
780 fw->ldr_buf_len =
781 prestera_ldr_read(fw, PRESTERA_LDR_BUF_SIZE_REG);
782
783 fw->ldr_wr_idx = 0;
784
785 err = prestera_fw_get(fw);
786 if (err)
787 return err;
788
789 err = prestera_fw_hdr_parse(fw);
790 if (err) {
791 dev_err(fw->dev.dev, "FW image header is invalid\n");
792 goto out_release;
793 }
794
795 prestera_ldr_write(fw, PRESTERA_LDR_IMG_SIZE_REG, fw->bin->size - hlen);
796 prestera_ldr_write(fw, PRESTERA_LDR_CTL_REG, PRESTERA_LDR_CTL_DL_START);
797
798 err = prestera_ldr_fw_send(fw, fw->bin->data + hlen,
799 fw->bin->size - hlen);
800
801 out_release:
802 prestera_fw_put(fw);
803 return err;
804 }
805
prestera_pci_pp_use_bar2(struct pci_dev * pdev)806 static bool prestera_pci_pp_use_bar2(struct pci_dev *pdev)
807 {
808 switch (pdev->device) {
809 case PRESTERA_DEV_ID_98DX7312M:
810 case PRESTERA_DEV_ID_98DX3500:
811 case PRESTERA_DEV_ID_98DX3501:
812 case PRESTERA_DEV_ID_98DX3510:
813 case PRESTERA_DEV_ID_98DX3520:
814 return true;
815
816 default:
817 return false;
818 }
819 }
820
prestera_pci_pp_bar2_offs(struct pci_dev * pdev)821 static u32 prestera_pci_pp_bar2_offs(struct pci_dev *pdev)
822 {
823 if (pci_resource_len(pdev, 2) == 0x1000000)
824 return 0x0;
825 else
826 return (pci_resource_len(pdev, 2) / 2);
827 }
828
prestera_pci_fw_bar2_offs(struct pci_dev * pdev)829 static u32 prestera_pci_fw_bar2_offs(struct pci_dev *pdev)
830 {
831 if (pci_resource_len(pdev, 2) == 0x1000000)
832 return 0x400000;
833 else
834 return 0x0;
835 }
836
prestera_pci_probe(struct pci_dev * pdev,const struct pci_device_id * id)837 static int prestera_pci_probe(struct pci_dev *pdev,
838 const struct pci_device_id *id)
839 {
840 const char *driver_name = dev_driver_string(&pdev->dev);
841 u8 __iomem *mem_addr, *pp_addr = NULL;
842 struct prestera_fw *fw;
843 int err;
844
845 err = pcim_enable_device(pdev);
846 if (err) {
847 dev_err(&pdev->dev, "pci_enable_device failed\n");
848 goto err_pci_enable_device;
849 }
850
851 err = pcim_request_all_regions(pdev, driver_name);
852 if (err) {
853 dev_err(&pdev->dev, "pcim_request_all_regions failed\n");
854 goto err_pci_request_regions;
855 }
856
857 err = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(30));
858 if (err) {
859 dev_err(&pdev->dev, "fail to set DMA mask\n");
860 goto err_dma_mask;
861 }
862
863 mem_addr = pcim_iomap(pdev, 2, 0);
864 if (!mem_addr) {
865 dev_err(&pdev->dev, "pci mem ioremap failed\n");
866 err = -EIO;
867 goto err_mem_ioremap;
868 }
869
870 /* AC5X devices use second half of BAR2 */
871 if (prestera_pci_pp_use_bar2(pdev)) {
872 pp_addr = mem_addr + prestera_pci_pp_bar2_offs(pdev);
873 mem_addr = mem_addr + prestera_pci_fw_bar2_offs(pdev);
874 } else {
875 pp_addr = pcim_iomap(pdev, 4, 0);
876 if (!pp_addr) {
877 dev_err(&pdev->dev, "pp regs ioremap failed\n");
878 err = -EIO;
879 goto err_pp_ioremap;
880 }
881 }
882
883 pci_set_master(pdev);
884
885 fw = devm_kzalloc(&pdev->dev, sizeof(*fw), GFP_KERNEL);
886 if (!fw) {
887 err = -ENOMEM;
888 goto err_pci_dev_alloc;
889 }
890
891 fw->pci_dev = pdev;
892 fw->dev.ctl_regs = mem_addr;
893 fw->dev.pp_regs = pp_addr;
894 fw->dev.dev = &pdev->dev;
895
896 pci_set_drvdata(pdev, fw);
897
898 err = prestera_fw_init(fw);
899 if (err)
900 goto err_prestera_fw_init;
901
902 dev_info(fw->dev.dev, "Prestera FW is ready\n");
903
904 fw->wq = alloc_workqueue("prestera_fw_wq", WQ_HIGHPRI | WQ_PERCPU, 1);
905 if (!fw->wq) {
906 err = -ENOMEM;
907 goto err_wq_alloc;
908 }
909
910 INIT_WORK(&fw->evt_work, prestera_fw_evt_work_fn);
911
912 err = pci_alloc_irq_vectors(pdev, 1, 1, PCI_IRQ_MSI);
913 if (err < 0) {
914 dev_err(&pdev->dev, "MSI IRQ init failed\n");
915 goto err_irq_alloc;
916 }
917
918 err = request_irq(pci_irq_vector(pdev, 0), prestera_pci_irq_handler,
919 0, driver_name, fw);
920 if (err) {
921 dev_err(&pdev->dev, "fail to request IRQ\n");
922 goto err_request_irq;
923 }
924
925 err = prestera_device_register(&fw->dev);
926 if (err)
927 goto err_prestera_dev_register;
928
929 return 0;
930
931 err_prestera_dev_register:
932 free_irq(pci_irq_vector(pdev, 0), fw);
933 err_request_irq:
934 pci_free_irq_vectors(pdev);
935 err_irq_alloc:
936 destroy_workqueue(fw->wq);
937 err_wq_alloc:
938 prestera_fw_uninit(fw);
939 err_prestera_fw_init:
940 err_pci_dev_alloc:
941 err_pp_ioremap:
942 err_mem_ioremap:
943 err_dma_mask:
944 err_pci_request_regions:
945 err_pci_enable_device:
946 return err;
947 }
948
prestera_pci_remove(struct pci_dev * pdev)949 static void prestera_pci_remove(struct pci_dev *pdev)
950 {
951 struct prestera_fw *fw = pci_get_drvdata(pdev);
952
953 prestera_device_unregister(&fw->dev);
954 free_irq(pci_irq_vector(pdev, 0), fw);
955 pci_free_irq_vectors(pdev);
956 destroy_workqueue(fw->wq);
957 prestera_fw_uninit(fw);
958 }
959
960 static const struct pci_device_id prestera_pci_devices[] = {
961 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_AC3X_98DX_55) },
962 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_AC3X_98DX_65) },
963 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_ALDRIN2) },
964 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_98DX7312M) },
965 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_98DX3500) },
966 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_98DX3501) },
967 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_98DX3510) },
968 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_98DX3520) },
969 { }
970 };
971 MODULE_DEVICE_TABLE(pci, prestera_pci_devices);
972
973 static struct pci_driver prestera_pci_driver = {
974 .name = "Prestera DX",
975 .id_table = prestera_pci_devices,
976 .probe = prestera_pci_probe,
977 .remove = prestera_pci_remove,
978 };
979 module_pci_driver(prestera_pci_driver);
980
981 MODULE_LICENSE("Dual BSD/GPL");
982 MODULE_DESCRIPTION("Marvell Prestera switch PCI interface");
983