0001
0002
0003
0004 #include <linux/bitfield.h>
0005 #include <linux/circ_buf.h>
0006 #include <linux/device.h>
0007 #include <linux/firmware.h>
0008 #include <linux/iopoll.h>
0009 #include <linux/kernel.h>
0010 #include <linux/module.h>
0011 #include <linux/pci.h>
0012
0013 #include "prestera.h"
0014
0015 #define PRESTERA_MSG_MAX_SIZE 1500
0016
0017 #define PRESTERA_SUPP_FW_MAJ_VER 4
0018 #define PRESTERA_SUPP_FW_MIN_VER 0
0019
0020 #define PRESTERA_PREV_FW_MAJ_VER 4
0021 #define PRESTERA_PREV_FW_MIN_VER 0
0022
0023 #define PRESTERA_FW_PATH_FMT "mrvl/prestera/mvsw_prestera_fw-v%u.%u.img"
0024
0025 #define PRESTERA_FW_HDR_MAGIC 0x351D9D06
0026 #define PRESTERA_FW_DL_TIMEOUT_MS 50000
0027 #define PRESTERA_FW_BLK_SZ 1024
0028
0029 #define PRESTERA_FW_VER_MAJ_MUL 1000000
0030 #define PRESTERA_FW_VER_MIN_MUL 1000
0031
0032 #define PRESTERA_FW_VER_MAJ(v) ((v) / PRESTERA_FW_VER_MAJ_MUL)
0033
0034 #define PRESTERA_FW_VER_MIN(v) \
0035 (((v) - (PRESTERA_FW_VER_MAJ(v) * PRESTERA_FW_VER_MAJ_MUL)) / \
0036 PRESTERA_FW_VER_MIN_MUL)
0037
0038 #define PRESTERA_FW_VER_PATCH(v) \
0039 ((v) - (PRESTERA_FW_VER_MAJ(v) * PRESTERA_FW_VER_MAJ_MUL) - \
0040 (PRESTERA_FW_VER_MIN(v) * PRESTERA_FW_VER_MIN_MUL))
0041
0042 enum prestera_pci_bar_t {
0043 PRESTERA_PCI_BAR_FW = 2,
0044 PRESTERA_PCI_BAR_PP = 4,
0045 };
0046
0047 struct prestera_fw_header {
0048 __be32 magic_number;
0049 __be32 version_value;
0050 u8 reserved[8];
0051 };
0052
0053 struct prestera_ldr_regs {
0054 u32 ldr_ready;
0055 u32 pad1;
0056
0057 u32 ldr_img_size;
0058 u32 ldr_ctl_flags;
0059
0060 u32 ldr_buf_offs;
0061 u32 ldr_buf_size;
0062
0063 u32 ldr_buf_rd;
0064 u32 pad2;
0065 u32 ldr_buf_wr;
0066
0067 u32 ldr_status;
0068 };
0069
0070 #define PRESTERA_LDR_REG_OFFSET(f) offsetof(struct prestera_ldr_regs, f)
0071
0072 #define PRESTERA_LDR_READY_MAGIC 0xf00dfeed
0073
0074 #define PRESTERA_LDR_STATUS_IMG_DL BIT(0)
0075 #define PRESTERA_LDR_STATUS_START_FW BIT(1)
0076 #define PRESTERA_LDR_STATUS_INVALID_IMG BIT(2)
0077 #define PRESTERA_LDR_STATUS_NOMEM BIT(3)
0078
0079 #define PRESTERA_LDR_REG_BASE(fw) ((fw)->ldr_regs)
0080 #define PRESTERA_LDR_REG_ADDR(fw, reg) (PRESTERA_LDR_REG_BASE(fw) + (reg))
0081
0082
0083 #define PRESTERA_LDR_READY_REG PRESTERA_LDR_REG_OFFSET(ldr_ready)
0084 #define PRESTERA_LDR_IMG_SIZE_REG PRESTERA_LDR_REG_OFFSET(ldr_img_size)
0085 #define PRESTERA_LDR_CTL_REG PRESTERA_LDR_REG_OFFSET(ldr_ctl_flags)
0086 #define PRESTERA_LDR_BUF_SIZE_REG PRESTERA_LDR_REG_OFFSET(ldr_buf_size)
0087 #define PRESTERA_LDR_BUF_OFFS_REG PRESTERA_LDR_REG_OFFSET(ldr_buf_offs)
0088 #define PRESTERA_LDR_BUF_RD_REG PRESTERA_LDR_REG_OFFSET(ldr_buf_rd)
0089 #define PRESTERA_LDR_BUF_WR_REG PRESTERA_LDR_REG_OFFSET(ldr_buf_wr)
0090 #define PRESTERA_LDR_STATUS_REG PRESTERA_LDR_REG_OFFSET(ldr_status)
0091
0092 #define PRESTERA_LDR_CTL_DL_START BIT(0)
0093
0094 #define PRESTERA_EVT_QNUM_MAX 4
0095
0096 struct prestera_fw_evtq_regs {
0097 u32 rd_idx;
0098 u32 pad1;
0099 u32 wr_idx;
0100 u32 pad2;
0101 u32 offs;
0102 u32 len;
0103 };
0104
0105 #define PRESTERA_CMD_QNUM_MAX 4
0106
0107 struct prestera_fw_cmdq_regs {
0108 u32 req_ctl;
0109 u32 req_len;
0110 u32 rcv_ctl;
0111 u32 rcv_len;
0112 u32 offs;
0113 u32 len;
0114 };
0115
0116 struct prestera_fw_regs {
0117 u32 fw_ready;
0118 u32 cmd_offs;
0119 u32 cmd_len;
0120 u32 cmd_qnum;
0121 u32 evt_offs;
0122 u32 evt_qnum;
0123
0124 u32 fw_status;
0125 u32 rx_status;
0126
0127 struct prestera_fw_cmdq_regs cmdq_list[PRESTERA_EVT_QNUM_MAX];
0128 struct prestera_fw_evtq_regs evtq_list[PRESTERA_CMD_QNUM_MAX];
0129 };
0130
0131 #define PRESTERA_FW_REG_OFFSET(f) offsetof(struct prestera_fw_regs, f)
0132
0133 #define PRESTERA_FW_READY_MAGIC 0xcafebabe
0134
0135
0136 #define PRESTERA_FW_READY_REG PRESTERA_FW_REG_OFFSET(fw_ready)
0137
0138 #define PRESTERA_CMD_BUF_OFFS_REG PRESTERA_FW_REG_OFFSET(cmd_offs)
0139 #define PRESTERA_CMD_BUF_LEN_REG PRESTERA_FW_REG_OFFSET(cmd_len)
0140 #define PRESTERA_CMD_QNUM_REG PRESTERA_FW_REG_OFFSET(cmd_qnum)
0141 #define PRESTERA_EVT_BUF_OFFS_REG PRESTERA_FW_REG_OFFSET(evt_offs)
0142 #define PRESTERA_EVT_QNUM_REG PRESTERA_FW_REG_OFFSET(evt_qnum)
0143
0144 #define PRESTERA_CMDQ_REG_OFFSET(q, f) \
0145 (PRESTERA_FW_REG_OFFSET(cmdq_list) + \
0146 (q) * sizeof(struct prestera_fw_cmdq_regs) + \
0147 offsetof(struct prestera_fw_cmdq_regs, f))
0148
0149 #define PRESTERA_CMDQ_REQ_CTL_REG(q) PRESTERA_CMDQ_REG_OFFSET(q, req_ctl)
0150 #define PRESTERA_CMDQ_REQ_LEN_REG(q) PRESTERA_CMDQ_REG_OFFSET(q, req_len)
0151 #define PRESTERA_CMDQ_RCV_CTL_REG(q) PRESTERA_CMDQ_REG_OFFSET(q, rcv_ctl)
0152 #define PRESTERA_CMDQ_RCV_LEN_REG(q) PRESTERA_CMDQ_REG_OFFSET(q, rcv_len)
0153 #define PRESTERA_CMDQ_OFFS_REG(q) PRESTERA_CMDQ_REG_OFFSET(q, offs)
0154 #define PRESTERA_CMDQ_LEN_REG(q) PRESTERA_CMDQ_REG_OFFSET(q, len)
0155
0156 #define PRESTERA_FW_STATUS_REG PRESTERA_FW_REG_OFFSET(fw_status)
0157 #define PRESTERA_RX_STATUS_REG PRESTERA_FW_REG_OFFSET(rx_status)
0158
0159
0160 #define PRESTERA_CMD_F_REQ_SENT BIT(0)
0161 #define PRESTERA_CMD_F_REPL_RCVD BIT(1)
0162
0163
0164 #define PRESTERA_CMD_F_REPL_SENT BIT(0)
0165
0166 #define PRESTERA_FW_EVT_CTL_STATUS_MASK GENMASK(1, 0)
0167
0168 #define PRESTERA_FW_EVT_CTL_STATUS_ON 0
0169 #define PRESTERA_FW_EVT_CTL_STATUS_OFF 1
0170
0171 #define PRESTERA_EVTQ_REG_OFFSET(q, f) \
0172 (PRESTERA_FW_REG_OFFSET(evtq_list) + \
0173 (q) * sizeof(struct prestera_fw_evtq_regs) + \
0174 offsetof(struct prestera_fw_evtq_regs, f))
0175
0176 #define PRESTERA_EVTQ_RD_IDX_REG(q) PRESTERA_EVTQ_REG_OFFSET(q, rd_idx)
0177 #define PRESTERA_EVTQ_WR_IDX_REG(q) PRESTERA_EVTQ_REG_OFFSET(q, wr_idx)
0178 #define PRESTERA_EVTQ_OFFS_REG(q) PRESTERA_EVTQ_REG_OFFSET(q, offs)
0179 #define PRESTERA_EVTQ_LEN_REG(q) PRESTERA_EVTQ_REG_OFFSET(q, len)
0180
0181 #define PRESTERA_FW_REG_BASE(fw) ((fw)->dev.ctl_regs)
0182 #define PRESTERA_FW_REG_ADDR(fw, reg) PRESTERA_FW_REG_BASE((fw)) + (reg)
0183
0184 #define PRESTERA_FW_CMD_DEFAULT_WAIT_MS 30000
0185 #define PRESTERA_FW_READY_WAIT_MS 20000
0186
0187 struct prestera_fw_evtq {
0188 u8 __iomem *addr;
0189 size_t len;
0190 };
0191
0192 struct prestera_fw_cmdq {
0193
0194 struct mutex cmd_mtx;
0195 u8 __iomem *addr;
0196 size_t len;
0197 };
0198
0199 struct prestera_fw {
0200 struct prestera_fw_rev rev_supp;
0201 const struct firmware *bin;
0202 struct workqueue_struct *wq;
0203 struct prestera_device dev;
0204 u8 __iomem *ldr_regs;
0205 u8 __iomem *ldr_ring_buf;
0206 u32 ldr_buf_len;
0207 u32 ldr_wr_idx;
0208 size_t cmd_mbox_len;
0209 u8 __iomem *cmd_mbox;
0210 struct prestera_fw_cmdq cmd_queue[PRESTERA_CMD_QNUM_MAX];
0211 u8 cmd_qnum;
0212 struct prestera_fw_evtq evt_queue[PRESTERA_EVT_QNUM_MAX];
0213 u8 evt_qnum;
0214 struct work_struct evt_work;
0215 u8 __iomem *evt_buf;
0216 u8 *evt_msg;
0217 };
0218
0219 static int prestera_fw_load(struct prestera_fw *fw);
0220
0221 static void prestera_fw_write(struct prestera_fw *fw, u32 reg, u32 val)
0222 {
0223 writel(val, PRESTERA_FW_REG_ADDR(fw, reg));
0224 }
0225
0226 static u32 prestera_fw_read(struct prestera_fw *fw, u32 reg)
0227 {
0228 return readl(PRESTERA_FW_REG_ADDR(fw, reg));
0229 }
0230
0231 static u32 prestera_fw_evtq_len(struct prestera_fw *fw, u8 qid)
0232 {
0233 return fw->evt_queue[qid].len;
0234 }
0235
0236 static u32 prestera_fw_evtq_avail(struct prestera_fw *fw, u8 qid)
0237 {
0238 u32 wr_idx = prestera_fw_read(fw, PRESTERA_EVTQ_WR_IDX_REG(qid));
0239 u32 rd_idx = prestera_fw_read(fw, PRESTERA_EVTQ_RD_IDX_REG(qid));
0240
0241 return CIRC_CNT(wr_idx, rd_idx, prestera_fw_evtq_len(fw, qid));
0242 }
0243
0244 static void prestera_fw_evtq_rd_set(struct prestera_fw *fw,
0245 u8 qid, u32 idx)
0246 {
0247 u32 rd_idx = idx & (prestera_fw_evtq_len(fw, qid) - 1);
0248
0249 prestera_fw_write(fw, PRESTERA_EVTQ_RD_IDX_REG(qid), rd_idx);
0250 }
0251
0252 static u8 __iomem *prestera_fw_evtq_buf(struct prestera_fw *fw, u8 qid)
0253 {
0254 return fw->evt_queue[qid].addr;
0255 }
0256
0257 static u32 prestera_fw_evtq_read32(struct prestera_fw *fw, u8 qid)
0258 {
0259 u32 rd_idx = prestera_fw_read(fw, PRESTERA_EVTQ_RD_IDX_REG(qid));
0260 u32 val;
0261
0262 val = readl(prestera_fw_evtq_buf(fw, qid) + rd_idx);
0263 prestera_fw_evtq_rd_set(fw, qid, rd_idx + 4);
0264 return val;
0265 }
0266
0267 static ssize_t prestera_fw_evtq_read_buf(struct prestera_fw *fw,
0268 u8 qid, void *buf, size_t len)
0269 {
0270 u32 idx = prestera_fw_read(fw, PRESTERA_EVTQ_RD_IDX_REG(qid));
0271 u8 __iomem *evtq_addr = prestera_fw_evtq_buf(fw, qid);
0272 u32 *buf32 = buf;
0273 int i;
0274
0275 for (i = 0; i < len / 4; buf32++, i++) {
0276 *buf32 = readl_relaxed(evtq_addr + idx);
0277 idx = (idx + 4) & (prestera_fw_evtq_len(fw, qid) - 1);
0278 }
0279
0280 prestera_fw_evtq_rd_set(fw, qid, idx);
0281
0282 return i;
0283 }
0284
0285 static u8 prestera_fw_evtq_pick(struct prestera_fw *fw)
0286 {
0287 int qid;
0288
0289 for (qid = 0; qid < fw->evt_qnum; qid++) {
0290 if (prestera_fw_evtq_avail(fw, qid) >= 4)
0291 return qid;
0292 }
0293
0294 return PRESTERA_EVT_QNUM_MAX;
0295 }
0296
0297 static void prestera_fw_evt_ctl_status_set(struct prestera_fw *fw, u32 val)
0298 {
0299 u32 status = prestera_fw_read(fw, PRESTERA_FW_STATUS_REG);
0300
0301 u32p_replace_bits(&status, val, PRESTERA_FW_EVT_CTL_STATUS_MASK);
0302
0303 prestera_fw_write(fw, PRESTERA_FW_STATUS_REG, status);
0304 }
0305
0306 static void prestera_fw_evt_work_fn(struct work_struct *work)
0307 {
0308 struct prestera_fw *fw;
0309 void *msg;
0310 u8 qid;
0311
0312 fw = container_of(work, struct prestera_fw, evt_work);
0313 msg = fw->evt_msg;
0314
0315 prestera_fw_evt_ctl_status_set(fw, PRESTERA_FW_EVT_CTL_STATUS_OFF);
0316
0317 while ((qid = prestera_fw_evtq_pick(fw)) < PRESTERA_EVT_QNUM_MAX) {
0318 u32 idx;
0319 u32 len;
0320
0321 len = prestera_fw_evtq_read32(fw, qid);
0322 idx = prestera_fw_read(fw, PRESTERA_EVTQ_RD_IDX_REG(qid));
0323
0324 WARN_ON(prestera_fw_evtq_avail(fw, qid) < len);
0325
0326 if (WARN_ON(len > PRESTERA_MSG_MAX_SIZE)) {
0327 prestera_fw_evtq_rd_set(fw, qid, idx + len);
0328 continue;
0329 }
0330
0331 prestera_fw_evtq_read_buf(fw, qid, msg, len);
0332
0333 if (fw->dev.recv_msg)
0334 fw->dev.recv_msg(&fw->dev, msg, len);
0335 }
0336
0337 prestera_fw_evt_ctl_status_set(fw, PRESTERA_FW_EVT_CTL_STATUS_ON);
0338 }
0339
0340 static int prestera_fw_wait_reg32(struct prestera_fw *fw, u32 reg, u32 cmp,
0341 unsigned int waitms)
0342 {
0343 u8 __iomem *addr = PRESTERA_FW_REG_ADDR(fw, reg);
0344 u32 val;
0345
0346 return readl_poll_timeout(addr, val, cmp == val,
0347 1 * USEC_PER_MSEC, waitms * USEC_PER_MSEC);
0348 }
0349
0350 static void prestera_fw_cmdq_lock(struct prestera_fw *fw, u8 qid)
0351 {
0352 mutex_lock(&fw->cmd_queue[qid].cmd_mtx);
0353 }
0354
0355 static void prestera_fw_cmdq_unlock(struct prestera_fw *fw, u8 qid)
0356 {
0357 mutex_unlock(&fw->cmd_queue[qid].cmd_mtx);
0358 }
0359
0360 static u32 prestera_fw_cmdq_len(struct prestera_fw *fw, u8 qid)
0361 {
0362 return fw->cmd_queue[qid].len;
0363 }
0364
0365 static u8 __iomem *prestera_fw_cmdq_buf(struct prestera_fw *fw, u8 qid)
0366 {
0367 return fw->cmd_queue[qid].addr;
0368 }
0369
0370 static int prestera_fw_cmd_send(struct prestera_fw *fw, int qid,
0371 void *in_msg, size_t in_size,
0372 void *out_msg, size_t out_size,
0373 unsigned int waitms)
0374 {
0375 u32 ret_size;
0376 int err;
0377
0378 if (!waitms)
0379 waitms = PRESTERA_FW_CMD_DEFAULT_WAIT_MS;
0380
0381 if (ALIGN(in_size, 4) > prestera_fw_cmdq_len(fw, qid))
0382 return -EMSGSIZE;
0383
0384
0385 err = prestera_fw_wait_reg32(fw, PRESTERA_CMDQ_RCV_CTL_REG(qid), 0, 30);
0386 if (err) {
0387 dev_err(fw->dev.dev, "finish reply from FW is timed out\n");
0388 return err;
0389 }
0390
0391 prestera_fw_write(fw, PRESTERA_CMDQ_REQ_LEN_REG(qid), in_size);
0392
0393 memcpy_toio(prestera_fw_cmdq_buf(fw, qid), in_msg, in_size);
0394
0395 prestera_fw_write(fw, PRESTERA_CMDQ_REQ_CTL_REG(qid),
0396 PRESTERA_CMD_F_REQ_SENT);
0397
0398
0399 err = prestera_fw_wait_reg32(fw, PRESTERA_CMDQ_RCV_CTL_REG(qid),
0400 PRESTERA_CMD_F_REPL_SENT, waitms);
0401 if (err) {
0402 dev_err(fw->dev.dev, "reply from FW is timed out\n");
0403 goto cmd_exit;
0404 }
0405
0406 ret_size = prestera_fw_read(fw, PRESTERA_CMDQ_RCV_LEN_REG(qid));
0407 if (ret_size > out_size) {
0408 dev_err(fw->dev.dev, "ret_size (%u) > out_len(%zu)\n",
0409 ret_size, out_size);
0410 err = -EMSGSIZE;
0411 goto cmd_exit;
0412 }
0413
0414 memcpy_fromio(out_msg,
0415 prestera_fw_cmdq_buf(fw, qid) + in_size, ret_size);
0416
0417 cmd_exit:
0418 prestera_fw_write(fw, PRESTERA_CMDQ_REQ_CTL_REG(qid),
0419 PRESTERA_CMD_F_REPL_RCVD);
0420 return err;
0421 }
0422
0423 static int prestera_fw_send_req(struct prestera_device *dev, int qid,
0424 void *in_msg, size_t in_size, void *out_msg,
0425 size_t out_size, unsigned int waitms)
0426 {
0427 struct prestera_fw *fw;
0428 ssize_t ret;
0429
0430 fw = container_of(dev, struct prestera_fw, dev);
0431
0432 prestera_fw_cmdq_lock(fw, qid);
0433 ret = prestera_fw_cmd_send(fw, qid, in_msg, in_size, out_msg, out_size,
0434 waitms);
0435 prestera_fw_cmdq_unlock(fw, qid);
0436
0437 return ret;
0438 }
0439
0440 static int prestera_fw_init(struct prestera_fw *fw)
0441 {
0442 u8 __iomem *base;
0443 int err;
0444 u8 qid;
0445
0446 fw->dev.send_req = prestera_fw_send_req;
0447 fw->ldr_regs = fw->dev.ctl_regs;
0448
0449 err = prestera_fw_load(fw);
0450 if (err)
0451 return err;
0452
0453 err = prestera_fw_wait_reg32(fw, PRESTERA_FW_READY_REG,
0454 PRESTERA_FW_READY_MAGIC,
0455 PRESTERA_FW_READY_WAIT_MS);
0456 if (err) {
0457 dev_err(fw->dev.dev, "FW failed to start\n");
0458 return err;
0459 }
0460
0461 base = fw->dev.ctl_regs;
0462
0463 fw->cmd_mbox = base + prestera_fw_read(fw, PRESTERA_CMD_BUF_OFFS_REG);
0464 fw->cmd_mbox_len = prestera_fw_read(fw, PRESTERA_CMD_BUF_LEN_REG);
0465 fw->cmd_qnum = prestera_fw_read(fw, PRESTERA_CMD_QNUM_REG);
0466
0467 for (qid = 0; qid < fw->cmd_qnum; qid++) {
0468 u32 offs = prestera_fw_read(fw, PRESTERA_CMDQ_OFFS_REG(qid));
0469 struct prestera_fw_cmdq *cmdq = &fw->cmd_queue[qid];
0470
0471 cmdq->len = prestera_fw_read(fw, PRESTERA_CMDQ_LEN_REG(qid));
0472 cmdq->addr = fw->cmd_mbox + offs;
0473 mutex_init(&cmdq->cmd_mtx);
0474 }
0475
0476 fw->evt_buf = base + prestera_fw_read(fw, PRESTERA_EVT_BUF_OFFS_REG);
0477 fw->evt_qnum = prestera_fw_read(fw, PRESTERA_EVT_QNUM_REG);
0478 fw->evt_msg = kmalloc(PRESTERA_MSG_MAX_SIZE, GFP_KERNEL);
0479 if (!fw->evt_msg)
0480 return -ENOMEM;
0481
0482 for (qid = 0; qid < fw->evt_qnum; qid++) {
0483 u32 offs = prestera_fw_read(fw, PRESTERA_EVTQ_OFFS_REG(qid));
0484 struct prestera_fw_evtq *evtq = &fw->evt_queue[qid];
0485
0486 evtq->len = prestera_fw_read(fw, PRESTERA_EVTQ_LEN_REG(qid));
0487 evtq->addr = fw->evt_buf + offs;
0488 }
0489
0490 return 0;
0491 }
0492
0493 static void prestera_fw_uninit(struct prestera_fw *fw)
0494 {
0495 kfree(fw->evt_msg);
0496 }
0497
0498 static irqreturn_t prestera_pci_irq_handler(int irq, void *dev_id)
0499 {
0500 struct prestera_fw *fw = dev_id;
0501
0502 if (prestera_fw_read(fw, PRESTERA_RX_STATUS_REG)) {
0503 prestera_fw_write(fw, PRESTERA_RX_STATUS_REG, 0);
0504
0505 if (fw->dev.recv_pkt)
0506 fw->dev.recv_pkt(&fw->dev);
0507 }
0508
0509 queue_work(fw->wq, &fw->evt_work);
0510
0511 return IRQ_HANDLED;
0512 }
0513
0514 static void prestera_ldr_write(struct prestera_fw *fw, u32 reg, u32 val)
0515 {
0516 writel(val, PRESTERA_LDR_REG_ADDR(fw, reg));
0517 }
0518
0519 static u32 prestera_ldr_read(struct prestera_fw *fw, u32 reg)
0520 {
0521 return readl(PRESTERA_LDR_REG_ADDR(fw, reg));
0522 }
0523
0524 static int prestera_ldr_wait_reg32(struct prestera_fw *fw,
0525 u32 reg, u32 cmp, unsigned int waitms)
0526 {
0527 u8 __iomem *addr = PRESTERA_LDR_REG_ADDR(fw, reg);
0528 u32 val;
0529
0530 return readl_poll_timeout(addr, val, cmp == val,
0531 10 * USEC_PER_MSEC, waitms * USEC_PER_MSEC);
0532 }
0533
0534 static u32 prestera_ldr_wait_buf(struct prestera_fw *fw, size_t len)
0535 {
0536 u8 __iomem *addr = PRESTERA_LDR_REG_ADDR(fw, PRESTERA_LDR_BUF_RD_REG);
0537 u32 buf_len = fw->ldr_buf_len;
0538 u32 wr_idx = fw->ldr_wr_idx;
0539 u32 rd_idx;
0540
0541 return readl_poll_timeout(addr, rd_idx,
0542 CIRC_SPACE(wr_idx, rd_idx, buf_len) >= len,
0543 1 * USEC_PER_MSEC, 100 * USEC_PER_MSEC);
0544 }
0545
0546 static int prestera_ldr_wait_dl_finish(struct prestera_fw *fw)
0547 {
0548 u8 __iomem *addr = PRESTERA_LDR_REG_ADDR(fw, PRESTERA_LDR_STATUS_REG);
0549 unsigned long mask = ~(PRESTERA_LDR_STATUS_IMG_DL);
0550 u32 val;
0551 int err;
0552
0553 err = readl_poll_timeout(addr, val, val & mask, 10 * USEC_PER_MSEC,
0554 PRESTERA_FW_DL_TIMEOUT_MS * USEC_PER_MSEC);
0555 if (err) {
0556 dev_err(fw->dev.dev, "Timeout to load FW img [state=%d]",
0557 prestera_ldr_read(fw, PRESTERA_LDR_STATUS_REG));
0558 return err;
0559 }
0560
0561 return 0;
0562 }
0563
0564 static void prestera_ldr_wr_idx_move(struct prestera_fw *fw, unsigned int n)
0565 {
0566 fw->ldr_wr_idx = (fw->ldr_wr_idx + (n)) & (fw->ldr_buf_len - 1);
0567 }
0568
0569 static void prestera_ldr_wr_idx_commit(struct prestera_fw *fw)
0570 {
0571 prestera_ldr_write(fw, PRESTERA_LDR_BUF_WR_REG, fw->ldr_wr_idx);
0572 }
0573
0574 static u8 __iomem *prestera_ldr_wr_ptr(struct prestera_fw *fw)
0575 {
0576 return fw->ldr_ring_buf + fw->ldr_wr_idx;
0577 }
0578
0579 static int prestera_ldr_send(struct prestera_fw *fw, const u8 *buf, size_t len)
0580 {
0581 int err;
0582 int i;
0583
0584 err = prestera_ldr_wait_buf(fw, len);
0585 if (err) {
0586 dev_err(fw->dev.dev, "failed wait for sending firmware\n");
0587 return err;
0588 }
0589
0590 for (i = 0; i < len; i += 4) {
0591 writel_relaxed(*(u32 *)(buf + i), prestera_ldr_wr_ptr(fw));
0592 prestera_ldr_wr_idx_move(fw, 4);
0593 }
0594
0595 prestera_ldr_wr_idx_commit(fw);
0596 return 0;
0597 }
0598
0599 static int prestera_ldr_fw_send(struct prestera_fw *fw,
0600 const char *img, u32 fw_size)
0601 {
0602 u32 status;
0603 u32 pos;
0604 int err;
0605
0606 err = prestera_ldr_wait_reg32(fw, PRESTERA_LDR_STATUS_REG,
0607 PRESTERA_LDR_STATUS_IMG_DL,
0608 5 * MSEC_PER_SEC);
0609 if (err) {
0610 dev_err(fw->dev.dev, "Loader is not ready to load image\n");
0611 return err;
0612 }
0613
0614 for (pos = 0; pos < fw_size; pos += PRESTERA_FW_BLK_SZ) {
0615 if (pos + PRESTERA_FW_BLK_SZ > fw_size)
0616 break;
0617
0618 err = prestera_ldr_send(fw, img + pos, PRESTERA_FW_BLK_SZ);
0619 if (err)
0620 return err;
0621 }
0622
0623 if (pos < fw_size) {
0624 err = prestera_ldr_send(fw, img + pos, fw_size - pos);
0625 if (err)
0626 return err;
0627 }
0628
0629 err = prestera_ldr_wait_dl_finish(fw);
0630 if (err)
0631 return err;
0632
0633 status = prestera_ldr_read(fw, PRESTERA_LDR_STATUS_REG);
0634
0635 switch (status) {
0636 case PRESTERA_LDR_STATUS_INVALID_IMG:
0637 dev_err(fw->dev.dev, "FW img has bad CRC\n");
0638 return -EINVAL;
0639 case PRESTERA_LDR_STATUS_NOMEM:
0640 dev_err(fw->dev.dev, "Loader has no enough mem\n");
0641 return -ENOMEM;
0642 }
0643
0644 return 0;
0645 }
0646
0647 static void prestera_fw_rev_parse(const struct prestera_fw_header *hdr,
0648 struct prestera_fw_rev *rev)
0649 {
0650 u32 version = be32_to_cpu(hdr->version_value);
0651
0652 rev->maj = PRESTERA_FW_VER_MAJ(version);
0653 rev->min = PRESTERA_FW_VER_MIN(version);
0654 rev->sub = PRESTERA_FW_VER_PATCH(version);
0655 }
0656
0657 static int prestera_fw_rev_check(struct prestera_fw *fw)
0658 {
0659 struct prestera_fw_rev *rev = &fw->dev.fw_rev;
0660
0661 if (rev->maj == fw->rev_supp.maj && rev->min >= fw->rev_supp.min)
0662 return 0;
0663
0664 dev_err(fw->dev.dev, "Driver supports FW version only '%u.%u.x'",
0665 fw->rev_supp.maj, fw->rev_supp.min);
0666
0667 return -EINVAL;
0668 }
0669
0670 static int prestera_fw_hdr_parse(struct prestera_fw *fw)
0671 {
0672 struct prestera_fw_rev *rev = &fw->dev.fw_rev;
0673 struct prestera_fw_header *hdr;
0674 u32 magic;
0675
0676 hdr = (struct prestera_fw_header *)fw->bin->data;
0677
0678 magic = be32_to_cpu(hdr->magic_number);
0679 if (magic != PRESTERA_FW_HDR_MAGIC) {
0680 dev_err(fw->dev.dev, "FW img hdr magic is invalid");
0681 return -EINVAL;
0682 }
0683
0684 prestera_fw_rev_parse(hdr, rev);
0685
0686 dev_info(fw->dev.dev, "FW version '%u.%u.%u'\n",
0687 rev->maj, rev->min, rev->sub);
0688
0689 return prestera_fw_rev_check(fw);
0690 }
0691
0692 static int prestera_fw_get(struct prestera_fw *fw)
0693 {
0694 int ver_maj = PRESTERA_SUPP_FW_MAJ_VER;
0695 int ver_min = PRESTERA_SUPP_FW_MIN_VER;
0696 char fw_path[128];
0697 int err;
0698
0699 pick_fw_ver:
0700 snprintf(fw_path, sizeof(fw_path), PRESTERA_FW_PATH_FMT,
0701 ver_maj, ver_min);
0702
0703 err = request_firmware_direct(&fw->bin, fw_path, fw->dev.dev);
0704 if (err) {
0705 if (ver_maj == PRESTERA_SUPP_FW_MAJ_VER) {
0706 ver_maj = PRESTERA_PREV_FW_MAJ_VER;
0707 ver_min = PRESTERA_PREV_FW_MIN_VER;
0708
0709 dev_warn(fw->dev.dev,
0710 "missing latest %s firmware, fall-back to previous %u.%u version\n",
0711 fw_path, ver_maj, ver_min);
0712
0713 goto pick_fw_ver;
0714 } else {
0715 dev_err(fw->dev.dev, "failed to request previous firmware: %s\n",
0716 fw_path);
0717 return err;
0718 }
0719 }
0720
0721 dev_info(fw->dev.dev, "Loading %s ...", fw_path);
0722
0723 fw->rev_supp.maj = ver_maj;
0724 fw->rev_supp.min = ver_min;
0725 fw->rev_supp.sub = 0;
0726
0727 return 0;
0728 }
0729
0730 static void prestera_fw_put(struct prestera_fw *fw)
0731 {
0732 release_firmware(fw->bin);
0733 }
0734
0735 static int prestera_fw_load(struct prestera_fw *fw)
0736 {
0737 size_t hlen = sizeof(struct prestera_fw_header);
0738 int err;
0739
0740 err = prestera_ldr_wait_reg32(fw, PRESTERA_LDR_READY_REG,
0741 PRESTERA_LDR_READY_MAGIC,
0742 5 * MSEC_PER_SEC);
0743 if (err) {
0744 dev_err(fw->dev.dev, "waiting for FW loader is timed out");
0745 return err;
0746 }
0747
0748 fw->ldr_ring_buf = fw->ldr_regs +
0749 prestera_ldr_read(fw, PRESTERA_LDR_BUF_OFFS_REG);
0750
0751 fw->ldr_buf_len =
0752 prestera_ldr_read(fw, PRESTERA_LDR_BUF_SIZE_REG);
0753
0754 fw->ldr_wr_idx = 0;
0755
0756 err = prestera_fw_get(fw);
0757 if (err)
0758 return err;
0759
0760 err = prestera_fw_hdr_parse(fw);
0761 if (err) {
0762 dev_err(fw->dev.dev, "FW image header is invalid\n");
0763 goto out_release;
0764 }
0765
0766 prestera_ldr_write(fw, PRESTERA_LDR_IMG_SIZE_REG, fw->bin->size - hlen);
0767 prestera_ldr_write(fw, PRESTERA_LDR_CTL_REG, PRESTERA_LDR_CTL_DL_START);
0768
0769 err = prestera_ldr_fw_send(fw, fw->bin->data + hlen,
0770 fw->bin->size - hlen);
0771
0772 out_release:
0773 prestera_fw_put(fw);
0774 return err;
0775 }
0776
0777 static int prestera_pci_probe(struct pci_dev *pdev,
0778 const struct pci_device_id *id)
0779 {
0780 const char *driver_name = dev_driver_string(&pdev->dev);
0781 struct prestera_fw *fw;
0782 int err;
0783
0784 err = pcim_enable_device(pdev);
0785 if (err)
0786 return err;
0787
0788 err = pcim_iomap_regions(pdev, BIT(PRESTERA_PCI_BAR_FW) |
0789 BIT(PRESTERA_PCI_BAR_PP),
0790 pci_name(pdev));
0791 if (err)
0792 return err;
0793
0794 err = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(30));
0795 if (err) {
0796 dev_err(&pdev->dev, "fail to set DMA mask\n");
0797 goto err_dma_mask;
0798 }
0799
0800 pci_set_master(pdev);
0801
0802 fw = devm_kzalloc(&pdev->dev, sizeof(*fw), GFP_KERNEL);
0803 if (!fw) {
0804 err = -ENOMEM;
0805 goto err_pci_dev_alloc;
0806 }
0807
0808 fw->dev.ctl_regs = pcim_iomap_table(pdev)[PRESTERA_PCI_BAR_FW];
0809 fw->dev.pp_regs = pcim_iomap_table(pdev)[PRESTERA_PCI_BAR_PP];
0810 fw->dev.dev = &pdev->dev;
0811
0812 pci_set_drvdata(pdev, fw);
0813
0814 err = prestera_fw_init(fw);
0815 if (err)
0816 goto err_prestera_fw_init;
0817
0818 dev_info(fw->dev.dev, "Prestera FW is ready\n");
0819
0820 fw->wq = alloc_workqueue("prestera_fw_wq", WQ_HIGHPRI, 1);
0821 if (!fw->wq) {
0822 err = -ENOMEM;
0823 goto err_wq_alloc;
0824 }
0825
0826 INIT_WORK(&fw->evt_work, prestera_fw_evt_work_fn);
0827
0828 err = pci_alloc_irq_vectors(pdev, 1, 1, PCI_IRQ_MSI);
0829 if (err < 0) {
0830 dev_err(&pdev->dev, "MSI IRQ init failed\n");
0831 goto err_irq_alloc;
0832 }
0833
0834 err = request_irq(pci_irq_vector(pdev, 0), prestera_pci_irq_handler,
0835 0, driver_name, fw);
0836 if (err) {
0837 dev_err(&pdev->dev, "fail to request IRQ\n");
0838 goto err_request_irq;
0839 }
0840
0841 err = prestera_device_register(&fw->dev);
0842 if (err)
0843 goto err_prestera_dev_register;
0844
0845 return 0;
0846
0847 err_prestera_dev_register:
0848 free_irq(pci_irq_vector(pdev, 0), fw);
0849 err_request_irq:
0850 pci_free_irq_vectors(pdev);
0851 err_irq_alloc:
0852 destroy_workqueue(fw->wq);
0853 err_wq_alloc:
0854 prestera_fw_uninit(fw);
0855 err_prestera_fw_init:
0856 err_pci_dev_alloc:
0857 err_dma_mask:
0858 return err;
0859 }
0860
0861 static void prestera_pci_remove(struct pci_dev *pdev)
0862 {
0863 struct prestera_fw *fw = pci_get_drvdata(pdev);
0864
0865 prestera_device_unregister(&fw->dev);
0866 free_irq(pci_irq_vector(pdev, 0), fw);
0867 pci_free_irq_vectors(pdev);
0868 destroy_workqueue(fw->wq);
0869 prestera_fw_uninit(fw);
0870 }
0871
0872 static const struct pci_device_id prestera_pci_devices[] = {
0873 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, 0xC804) },
0874 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, 0xC80C) },
0875 { PCI_DEVICE(PCI_VENDOR_ID_MARVELL, 0xCC1E) },
0876 { }
0877 };
0878 MODULE_DEVICE_TABLE(pci, prestera_pci_devices);
0879
0880 static struct pci_driver prestera_pci_driver = {
0881 .name = "Prestera DX",
0882 .id_table = prestera_pci_devices,
0883 .probe = prestera_pci_probe,
0884 .remove = prestera_pci_remove,
0885 };
0886 module_pci_driver(prestera_pci_driver);
0887
0888 MODULE_LICENSE("Dual BSD/GPL");
0889 MODULE_DESCRIPTION("Marvell Prestera switch PCI interface");
