1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /* Copyright (c) 2019-2020 Marvell International Ltd. All rights reserved */
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>
15 #define PRESTERA_MSG_MAX_SIZE 1500
17 #define PRESTERA_SUPP_FW_MAJ_VER 4
18 #define PRESTERA_SUPP_FW_MIN_VER 1
20 #define PRESTERA_PREV_FW_MAJ_VER 4
21 #define PRESTERA_PREV_FW_MIN_VER 0
23 #define PRESTERA_FW_PATH_FMT "/*(DEBLOBBED)*/"
24 #define PRESTERA_FW_ARM64_PATH_FMT "/*(DEBLOBBED)*/"
26 #define PRESTERA_FW_HDR_MAGIC 0x351D9D06
27 #define PRESTERA_FW_DL_TIMEOUT_MS 50000
28 #define PRESTERA_FW_BLK_SZ 1024
30 #define PRESTERA_FW_VER_MAJ_MUL 1000000
31 #define PRESTERA_FW_VER_MIN_MUL 1000
33 #define PRESTERA_FW_VER_MAJ(v) ((v) / PRESTERA_FW_VER_MAJ_MUL)
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)
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))
43 enum prestera_pci_bar_t {
44 PRESTERA_PCI_BAR_FW = 2,
45 PRESTERA_PCI_BAR_PP = 4,
48 struct prestera_fw_header {
54 struct prestera_ldr_regs {
71 #define PRESTERA_LDR_REG_OFFSET(f) offsetof(struct prestera_ldr_regs, f)
73 #define PRESTERA_LDR_READY_MAGIC 0xf00dfeed
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)
80 #define PRESTERA_LDR_REG_BASE(fw) ((fw)->ldr_regs)
81 #define PRESTERA_LDR_REG_ADDR(fw, reg) (PRESTERA_LDR_REG_BASE(fw) + (reg))
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)
93 #define PRESTERA_LDR_CTL_DL_START BIT(0)
95 #define PRESTERA_EVT_QNUM_MAX 4
97 struct prestera_fw_evtq_regs {
106 #define PRESTERA_CMD_QNUM_MAX 4
108 struct prestera_fw_cmdq_regs {
117 struct prestera_fw_regs {
128 struct prestera_fw_cmdq_regs cmdq_list[PRESTERA_EVT_QNUM_MAX];
129 struct prestera_fw_evtq_regs evtq_list[PRESTERA_CMD_QNUM_MAX];
132 #define PRESTERA_FW_REG_OFFSET(f) offsetof(struct prestera_fw_regs, f)
134 #define PRESTERA_FW_READY_MAGIC 0xcafebabe
137 #define PRESTERA_FW_READY_REG PRESTERA_FW_REG_OFFSET(fw_ready)
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)
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))
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)
157 #define PRESTERA_FW_STATUS_REG PRESTERA_FW_REG_OFFSET(fw_status)
158 #define PRESTERA_RX_STATUS_REG PRESTERA_FW_REG_OFFSET(rx_status)
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)
164 /* PRESTERA_CMD_RCV_CTL_REG flags */
165 #define PRESTERA_CMD_F_REPL_SENT BIT(0)
167 #define PRESTERA_FW_EVT_CTL_STATUS_MASK GENMASK(1, 0)
169 #define PRESTERA_FW_EVT_CTL_STATUS_ON 0
170 #define PRESTERA_FW_EVT_CTL_STATUS_OFF 1
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))
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)
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)
185 #define PRESTERA_FW_CMD_DEFAULT_WAIT_MS 30000
186 #define PRESTERA_FW_READY_WAIT_MS 20000
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
197 struct prestera_fw_evtq {
202 struct prestera_fw_cmdq {
203 /* serialize access to dev->send_req */
204 struct mutex cmd_mtx;
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;
220 u8 __iomem *cmd_mbox;
221 struct prestera_fw_cmdq cmd_queue[PRESTERA_CMD_QNUM_MAX];
223 struct prestera_fw_evtq evt_queue[PRESTERA_EVT_QNUM_MAX];
225 struct work_struct evt_work;
230 static int prestera_fw_load(struct prestera_fw *fw);
232 static void prestera_fw_write(struct prestera_fw *fw, u32 reg, u32 val)
234 writel(val, PRESTERA_FW_REG_ADDR(fw, reg));
237 static u32 prestera_fw_read(struct prestera_fw *fw, u32 reg)
239 return readl(PRESTERA_FW_REG_ADDR(fw, reg));
242 static u32 prestera_fw_evtq_len(struct prestera_fw *fw, u8 qid)
244 return fw->evt_queue[qid].len;
247 static u32 prestera_fw_evtq_avail(struct prestera_fw *fw, u8 qid)
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));
252 return CIRC_CNT(wr_idx, rd_idx, prestera_fw_evtq_len(fw, qid));
255 static void prestera_fw_evtq_rd_set(struct prestera_fw *fw,
258 u32 rd_idx = idx & (prestera_fw_evtq_len(fw, qid) - 1);
260 prestera_fw_write(fw, PRESTERA_EVTQ_RD_IDX_REG(qid), rd_idx);
263 static u8 __iomem *prestera_fw_evtq_buf(struct prestera_fw *fw, u8 qid)
265 return fw->evt_queue[qid].addr;
268 static u32 prestera_fw_evtq_read32(struct prestera_fw *fw, u8 qid)
270 u32 rd_idx = prestera_fw_read(fw, PRESTERA_EVTQ_RD_IDX_REG(qid));
273 val = readl(prestera_fw_evtq_buf(fw, qid) + rd_idx);
274 prestera_fw_evtq_rd_set(fw, qid, rd_idx + 4);
278 static ssize_t prestera_fw_evtq_read_buf(struct prestera_fw *fw,
279 u8 qid, void *buf, size_t len)
281 u32 idx = prestera_fw_read(fw, PRESTERA_EVTQ_RD_IDX_REG(qid));
282 u8 __iomem *evtq_addr = prestera_fw_evtq_buf(fw, qid);
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);
291 prestera_fw_evtq_rd_set(fw, qid, idx);
296 static u8 prestera_fw_evtq_pick(struct prestera_fw *fw)
300 for (qid = 0; qid < fw->evt_qnum; qid++) {
301 if (prestera_fw_evtq_avail(fw, qid) >= 4)
305 return PRESTERA_EVT_QNUM_MAX;
308 static void prestera_fw_evt_ctl_status_set(struct prestera_fw *fw, u32 val)
310 u32 status = prestera_fw_read(fw, PRESTERA_FW_STATUS_REG);
312 u32p_replace_bits(&status, val, PRESTERA_FW_EVT_CTL_STATUS_MASK);
314 prestera_fw_write(fw, PRESTERA_FW_STATUS_REG, status);
317 static void prestera_fw_evt_work_fn(struct work_struct *work)
319 struct prestera_fw *fw;
323 fw = container_of(work, struct prestera_fw, evt_work);
326 prestera_fw_evt_ctl_status_set(fw, PRESTERA_FW_EVT_CTL_STATUS_OFF);
328 while ((qid = prestera_fw_evtq_pick(fw)) < PRESTERA_EVT_QNUM_MAX) {
332 len = prestera_fw_evtq_read32(fw, qid);
333 idx = prestera_fw_read(fw, PRESTERA_EVTQ_RD_IDX_REG(qid));
335 WARN_ON(prestera_fw_evtq_avail(fw, qid) < len);
337 if (WARN_ON(len > PRESTERA_MSG_MAX_SIZE)) {
338 prestera_fw_evtq_rd_set(fw, qid, idx + len);
342 prestera_fw_evtq_read_buf(fw, qid, msg, len);
344 if (fw->dev.recv_msg)
345 fw->dev.recv_msg(&fw->dev, msg, len);
348 prestera_fw_evt_ctl_status_set(fw, PRESTERA_FW_EVT_CTL_STATUS_ON);
351 static int prestera_fw_wait_reg32(struct prestera_fw *fw, u32 reg, u32 cmp,
354 u8 __iomem *addr = PRESTERA_FW_REG_ADDR(fw, reg);
357 return readl_poll_timeout(addr, val, cmp == val,
358 1 * USEC_PER_MSEC, waitms * USEC_PER_MSEC);
361 static void prestera_fw_cmdq_lock(struct prestera_fw *fw, u8 qid)
363 mutex_lock(&fw->cmd_queue[qid].cmd_mtx);
366 static void prestera_fw_cmdq_unlock(struct prestera_fw *fw, u8 qid)
368 mutex_unlock(&fw->cmd_queue[qid].cmd_mtx);
371 static u32 prestera_fw_cmdq_len(struct prestera_fw *fw, u8 qid)
373 return fw->cmd_queue[qid].len;
376 static u8 __iomem *prestera_fw_cmdq_buf(struct prestera_fw *fw, u8 qid)
378 return fw->cmd_queue[qid].addr;
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,
390 waitms = PRESTERA_FW_CMD_DEFAULT_WAIT_MS;
392 if (ALIGN(in_size, 4) > prestera_fw_cmdq_len(fw, qid))
395 /* wait for finish previous reply from FW */
396 err = prestera_fw_wait_reg32(fw, PRESTERA_CMDQ_RCV_CTL_REG(qid), 0, 30);
398 dev_err(fw->dev.dev, "finish reply from FW is timed out\n");
402 prestera_fw_write(fw, PRESTERA_CMDQ_REQ_LEN_REG(qid), in_size);
404 memcpy_toio(prestera_fw_cmdq_buf(fw, qid), in_msg, in_size);
406 prestera_fw_write(fw, PRESTERA_CMDQ_REQ_CTL_REG(qid),
407 PRESTERA_CMD_F_REQ_SENT);
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);
413 dev_err(fw->dev.dev, "reply from FW is timed out\n");
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",
425 memcpy_fromio(out_msg,
426 prestera_fw_cmdq_buf(fw, qid) + in_size, ret_size);
429 prestera_fw_write(fw, PRESTERA_CMDQ_REQ_CTL_REG(qid),
430 PRESTERA_CMD_F_REPL_RCVD);
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)
438 struct prestera_fw *fw;
441 fw = container_of(dev, struct prestera_fw, dev);
443 prestera_fw_cmdq_lock(fw, qid);
444 ret = prestera_fw_cmd_send(fw, qid, in_msg, in_size, out_msg, out_size,
446 prestera_fw_cmdq_unlock(fw, qid);
451 static int prestera_fw_init(struct prestera_fw *fw)
457 fw->dev.send_req = prestera_fw_send_req;
458 fw->ldr_regs = fw->dev.ctl_regs;
460 err = prestera_fw_load(fw);
464 err = prestera_fw_wait_reg32(fw, PRESTERA_FW_READY_REG,
465 PRESTERA_FW_READY_MAGIC,
466 PRESTERA_FW_READY_WAIT_MS);
468 dev_err(fw->dev.dev, "FW failed to start\n");
472 base = fw->dev.ctl_regs;
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);
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];
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);
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);
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];
497 evtq->len = prestera_fw_read(fw, PRESTERA_EVTQ_LEN_REG(qid));
498 evtq->addr = fw->evt_buf + offs;
504 static void prestera_fw_uninit(struct prestera_fw *fw)
509 static irqreturn_t prestera_pci_irq_handler(int irq, void *dev_id)
511 struct prestera_fw *fw = dev_id;
513 if (prestera_fw_read(fw, PRESTERA_RX_STATUS_REG)) {
514 prestera_fw_write(fw, PRESTERA_RX_STATUS_REG, 0);
516 if (fw->dev.recv_pkt)
517 fw->dev.recv_pkt(&fw->dev);
520 queue_work(fw->wq, &fw->evt_work);
525 static void prestera_ldr_write(struct prestera_fw *fw, u32 reg, u32 val)
527 writel(val, PRESTERA_LDR_REG_ADDR(fw, reg));
530 static u32 prestera_ldr_read(struct prestera_fw *fw, u32 reg)
532 return readl(PRESTERA_LDR_REG_ADDR(fw, reg));
535 static int prestera_ldr_wait_reg32(struct prestera_fw *fw,
536 u32 reg, u32 cmp, unsigned int waitms)
538 u8 __iomem *addr = PRESTERA_LDR_REG_ADDR(fw, reg);
541 return readl_poll_timeout(addr, val, cmp == val,
542 10 * USEC_PER_MSEC, waitms * USEC_PER_MSEC);
545 static u32 prestera_ldr_wait_buf(struct prestera_fw *fw, size_t len)
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;
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);
557 static int prestera_ldr_wait_dl_finish(struct prestera_fw *fw)
559 u8 __iomem *addr = PRESTERA_LDR_REG_ADDR(fw, PRESTERA_LDR_STATUS_REG);
560 unsigned long mask = ~(PRESTERA_LDR_STATUS_IMG_DL);
564 err = readl_poll_timeout(addr, val, val & mask, 10 * USEC_PER_MSEC,
565 PRESTERA_FW_DL_TIMEOUT_MS * USEC_PER_MSEC);
567 dev_err(fw->dev.dev, "Timeout to load FW img [state=%d]",
568 prestera_ldr_read(fw, PRESTERA_LDR_STATUS_REG));
575 static void prestera_ldr_wr_idx_move(struct prestera_fw *fw, unsigned int n)
577 fw->ldr_wr_idx = (fw->ldr_wr_idx + (n)) & (fw->ldr_buf_len - 1);
580 static void prestera_ldr_wr_idx_commit(struct prestera_fw *fw)
582 prestera_ldr_write(fw, PRESTERA_LDR_BUF_WR_REG, fw->ldr_wr_idx);
585 static u8 __iomem *prestera_ldr_wr_ptr(struct prestera_fw *fw)
587 return fw->ldr_ring_buf + fw->ldr_wr_idx;
590 static int prestera_ldr_send(struct prestera_fw *fw, const u8 *buf, size_t len)
595 err = prestera_ldr_wait_buf(fw, len);
597 dev_err(fw->dev.dev, "failed wait for sending firmware\n");
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);
606 prestera_ldr_wr_idx_commit(fw);
610 static int prestera_ldr_fw_send(struct prestera_fw *fw,
611 const char *img, u32 fw_size)
617 err = prestera_ldr_wait_reg32(fw, PRESTERA_LDR_STATUS_REG,
618 PRESTERA_LDR_STATUS_IMG_DL,
621 dev_err(fw->dev.dev, "Loader is not ready to load image\n");
625 for (pos = 0; pos < fw_size; pos += PRESTERA_FW_BLK_SZ) {
626 if (pos + PRESTERA_FW_BLK_SZ > fw_size)
629 err = prestera_ldr_send(fw, img + pos, PRESTERA_FW_BLK_SZ);
635 err = prestera_ldr_send(fw, img + pos, fw_size - pos);
640 err = prestera_ldr_wait_dl_finish(fw);
644 status = prestera_ldr_read(fw, PRESTERA_LDR_STATUS_REG);
647 case PRESTERA_LDR_STATUS_INVALID_IMG:
648 dev_err(fw->dev.dev, "FW img has bad CRC\n");
650 case PRESTERA_LDR_STATUS_NOMEM:
651 dev_err(fw->dev.dev, "Loader has no enough mem\n");
658 static void prestera_fw_rev_parse(const struct prestera_fw_header *hdr,
659 struct prestera_fw_rev *rev)
661 u32 version = be32_to_cpu(hdr->version_value);
663 rev->maj = PRESTERA_FW_VER_MAJ(version);
664 rev->min = PRESTERA_FW_VER_MIN(version);
665 rev->sub = PRESTERA_FW_VER_PATCH(version);
668 static int prestera_fw_rev_check(struct prestera_fw *fw)
670 struct prestera_fw_rev *rev = &fw->dev.fw_rev;
672 if (rev->maj == fw->rev_supp.maj && rev->min >= fw->rev_supp.min)
675 dev_err(fw->dev.dev, "Driver supports FW version only '%u.%u.x'",
676 fw->rev_supp.maj, fw->rev_supp.min);
681 static int prestera_fw_hdr_parse(struct prestera_fw *fw)
683 struct prestera_fw_rev *rev = &fw->dev.fw_rev;
684 struct prestera_fw_header *hdr;
687 hdr = (struct prestera_fw_header *)fw->bin->data;
689 magic = be32_to_cpu(hdr->magic_number);
690 if (magic != PRESTERA_FW_HDR_MAGIC) {
691 dev_err(fw->dev.dev, "FW img hdr magic is invalid");
695 prestera_fw_rev_parse(hdr, rev);
697 dev_info(fw->dev.dev, "FW version '%u.%u.%u'\n",
698 rev->maj, rev->min, rev->sub);
700 return prestera_fw_rev_check(fw);
703 static const char *prestera_fw_path_fmt_get(struct prestera_fw *fw)
705 switch (fw->pci_dev->device) {
706 case PRESTERA_DEV_ID_98DX3500:
707 case PRESTERA_DEV_ID_98DX3501:
708 case PRESTERA_DEV_ID_98DX3510:
709 case PRESTERA_DEV_ID_98DX3520:
710 return PRESTERA_FW_ARM64_PATH_FMT;
713 return PRESTERA_FW_PATH_FMT;
717 static int prestera_fw_get(struct prestera_fw *fw)
719 int ver_maj = PRESTERA_SUPP_FW_MAJ_VER;
720 int ver_min = PRESTERA_SUPP_FW_MIN_VER;
725 snprintf(fw_path, sizeof(fw_path), prestera_fw_path_fmt_get(fw),
728 err = reject_firmware_direct(&fw->bin, fw_path, fw->dev.dev);
730 if (ver_maj != PRESTERA_PREV_FW_MAJ_VER ||
731 ver_min != PRESTERA_PREV_FW_MIN_VER) {
732 ver_maj = PRESTERA_PREV_FW_MAJ_VER;
733 ver_min = PRESTERA_PREV_FW_MIN_VER;
735 dev_warn(fw->dev.dev,
736 "missing latest %s firmware, fall-back to previous %u.%u version\n",
737 fw_path, ver_maj, ver_min);
741 dev_err(fw->dev.dev, "failed to request previous firmware: %s\n",
747 dev_info(fw->dev.dev, "Loading %s ...", fw_path);
749 fw->rev_supp.maj = ver_maj;
750 fw->rev_supp.min = ver_min;
751 fw->rev_supp.sub = 0;
756 static void prestera_fw_put(struct prestera_fw *fw)
758 release_firmware(fw->bin);
761 static int prestera_fw_load(struct prestera_fw *fw)
763 size_t hlen = sizeof(struct prestera_fw_header);
766 err = prestera_ldr_wait_reg32(fw, PRESTERA_LDR_READY_REG,
767 PRESTERA_LDR_READY_MAGIC,
770 dev_err(fw->dev.dev, "waiting for FW loader is timed out");
774 fw->ldr_ring_buf = fw->ldr_regs +
775 prestera_ldr_read(fw, PRESTERA_LDR_BUF_OFFS_REG);
778 prestera_ldr_read(fw, PRESTERA_LDR_BUF_SIZE_REG);
782 err = prestera_fw_get(fw);
786 err = prestera_fw_hdr_parse(fw);
788 dev_err(fw->dev.dev, "FW image header is invalid\n");
792 prestera_ldr_write(fw, PRESTERA_LDR_IMG_SIZE_REG, fw->bin->size - hlen);
793 prestera_ldr_write(fw, PRESTERA_LDR_CTL_REG, PRESTERA_LDR_CTL_DL_START);
795 err = prestera_ldr_fw_send(fw, fw->bin->data + hlen,
796 fw->bin->size - hlen);
803 static bool prestera_pci_pp_use_bar2(struct pci_dev *pdev)
805 switch (pdev->device) {
806 case PRESTERA_DEV_ID_98DX7312M:
807 case PRESTERA_DEV_ID_98DX3500:
808 case PRESTERA_DEV_ID_98DX3501:
809 case PRESTERA_DEV_ID_98DX3510:
810 case PRESTERA_DEV_ID_98DX3520:
818 static u32 prestera_pci_pp_bar2_offs(struct pci_dev *pdev)
820 if (pci_resource_len(pdev, 2) == 0x1000000)
823 return (pci_resource_len(pdev, 2) / 2);
826 static u32 prestera_pci_fw_bar2_offs(struct pci_dev *pdev)
828 if (pci_resource_len(pdev, 2) == 0x1000000)
834 static int prestera_pci_probe(struct pci_dev *pdev,
835 const struct pci_device_id *id)
837 const char *driver_name = dev_driver_string(&pdev->dev);
838 u8 __iomem *mem_addr, *pp_addr = NULL;
839 struct prestera_fw *fw;
842 err = pcim_enable_device(pdev);
844 dev_err(&pdev->dev, "pci_enable_device failed\n");
845 goto err_pci_enable_device;
848 err = pci_request_regions(pdev, driver_name);
850 dev_err(&pdev->dev, "pci_request_regions failed\n");
851 goto err_pci_request_regions;
854 err = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(30));
856 dev_err(&pdev->dev, "fail to set DMA mask\n");
860 mem_addr = pcim_iomap(pdev, 2, 0);
862 dev_err(&pdev->dev, "pci mem ioremap failed\n");
864 goto err_mem_ioremap;
867 /* AC5X devices use second half of BAR2 */
868 if (prestera_pci_pp_use_bar2(pdev)) {
869 pp_addr = mem_addr + prestera_pci_pp_bar2_offs(pdev);
870 mem_addr = mem_addr + prestera_pci_fw_bar2_offs(pdev);
872 pp_addr = pcim_iomap(pdev, 4, 0);
874 dev_err(&pdev->dev, "pp regs ioremap failed\n");
880 pci_set_master(pdev);
882 fw = devm_kzalloc(&pdev->dev, sizeof(*fw), GFP_KERNEL);
885 goto err_pci_dev_alloc;
889 fw->dev.ctl_regs = mem_addr;
890 fw->dev.pp_regs = pp_addr;
891 fw->dev.dev = &pdev->dev;
893 pci_set_drvdata(pdev, fw);
895 err = prestera_fw_init(fw);
897 goto err_prestera_fw_init;
899 dev_info(fw->dev.dev, "Prestera FW is ready\n");
901 fw->wq = alloc_workqueue("prestera_fw_wq", WQ_HIGHPRI, 1);
907 INIT_WORK(&fw->evt_work, prestera_fw_evt_work_fn);
909 err = pci_alloc_irq_vectors(pdev, 1, 1, PCI_IRQ_MSI);
911 dev_err(&pdev->dev, "MSI IRQ init failed\n");
915 err = request_irq(pci_irq_vector(pdev, 0), prestera_pci_irq_handler,
918 dev_err(&pdev->dev, "fail to request IRQ\n");
919 goto err_request_irq;
922 err = prestera_device_register(&fw->dev);
924 goto err_prestera_dev_register;
928 err_prestera_dev_register:
929 free_irq(pci_irq_vector(pdev, 0), fw);
931 pci_free_irq_vectors(pdev);
933 destroy_workqueue(fw->wq);
935 prestera_fw_uninit(fw);
936 err_prestera_fw_init:
941 pci_release_regions(pdev);
942 err_pci_request_regions:
943 err_pci_enable_device:
947 static void prestera_pci_remove(struct pci_dev *pdev)
949 struct prestera_fw *fw = pci_get_drvdata(pdev);
951 prestera_device_unregister(&fw->dev);
952 free_irq(pci_irq_vector(pdev, 0), fw);
953 pci_free_irq_vectors(pdev);
954 destroy_workqueue(fw->wq);
955 prestera_fw_uninit(fw);
956 pci_release_regions(pdev);
959 static const struct pci_device_id prestera_pci_devices[] = {
960 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_AC3X_98DX_55) },
961 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_AC3X_98DX_65) },
962 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_ALDRIN2) },
963 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_98DX7312M) },
964 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_98DX3500) },
965 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_98DX3501) },
966 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_98DX3510) },
967 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, PRESTERA_DEV_ID_98DX3520) },
970 MODULE_DEVICE_TABLE(pci, prestera_pci_devices);
972 static struct pci_driver prestera_pci_driver = {
973 .name = "Prestera DX",
974 .id_table = prestera_pci_devices,
975 .probe = prestera_pci_probe,
976 .remove = prestera_pci_remove,
978 module_pci_driver(prestera_pci_driver);
980 MODULE_LICENSE("Dual BSD/GPL");
981 MODULE_DESCRIPTION("Marvell Prestera switch PCI interface");