2 * Copyright (c) 2013, Mellanox Technologies inc. All rights reserved.
4 * This software is available to you under a choice of one of two
5 * licenses. You may choose to be licensed under the terms of the GNU
6 * General Public License (GPL) Version 2, available from the file
7 * COPYING in the main directory of this source tree, or the
8 * OpenIB.org BSD license below:
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
14 * - Redistributions of source code must retain the above
15 * copyright notice, this list of conditions and the following
18 * - Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer in the documentation and/or other materials
21 * provided with the distribution.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33 #include <asm-generic/kmap_types.h>
34 #include <linux/module.h>
35 #include <linux/errno.h>
36 #include <linux/pci.h>
37 #include <linux/dma-mapping.h>
38 #include <linux/slab.h>
39 #include <linux/delay.h>
40 #include <linux/random.h>
41 #include <linux/io-mapping.h>
42 #include <linux/mlx5/driver.h>
43 #include <linux/debugfs.h>
45 #include "mlx5_core.h"
59 LONG_LIST_SIZE = (2ULL * 1024 * 1024 * 1024 / PAGE_SIZE) * 8 + 16 +
60 MLX5_CMD_DATA_BLOCK_SIZE,
61 MED_LIST_SIZE = 16 + MLX5_CMD_DATA_BLOCK_SIZE,
65 MLX5_CMD_DELIVERY_STAT_OK = 0x0,
66 MLX5_CMD_DELIVERY_STAT_SIGNAT_ERR = 0x1,
67 MLX5_CMD_DELIVERY_STAT_TOK_ERR = 0x2,
68 MLX5_CMD_DELIVERY_STAT_BAD_BLK_NUM_ERR = 0x3,
69 MLX5_CMD_DELIVERY_STAT_OUT_PTR_ALIGN_ERR = 0x4,
70 MLX5_CMD_DELIVERY_STAT_IN_PTR_ALIGN_ERR = 0x5,
71 MLX5_CMD_DELIVERY_STAT_FW_ERR = 0x6,
72 MLX5_CMD_DELIVERY_STAT_IN_LENGTH_ERR = 0x7,
73 MLX5_CMD_DELIVERY_STAT_OUT_LENGTH_ERR = 0x8,
74 MLX5_CMD_DELIVERY_STAT_RES_FLD_NOT_CLR_ERR = 0x9,
75 MLX5_CMD_DELIVERY_STAT_CMD_DESCR_ERR = 0x10,
79 MLX5_CMD_STAT_OK = 0x0,
80 MLX5_CMD_STAT_INT_ERR = 0x1,
81 MLX5_CMD_STAT_BAD_OP_ERR = 0x2,
82 MLX5_CMD_STAT_BAD_PARAM_ERR = 0x3,
83 MLX5_CMD_STAT_BAD_SYS_STATE_ERR = 0x4,
84 MLX5_CMD_STAT_BAD_RES_ERR = 0x5,
85 MLX5_CMD_STAT_RES_BUSY = 0x6,
86 MLX5_CMD_STAT_LIM_ERR = 0x8,
87 MLX5_CMD_STAT_BAD_RES_STATE_ERR = 0x9,
88 MLX5_CMD_STAT_IX_ERR = 0xa,
89 MLX5_CMD_STAT_NO_RES_ERR = 0xf,
90 MLX5_CMD_STAT_BAD_INP_LEN_ERR = 0x50,
91 MLX5_CMD_STAT_BAD_OUTP_LEN_ERR = 0x51,
92 MLX5_CMD_STAT_BAD_QP_STATE_ERR = 0x10,
93 MLX5_CMD_STAT_BAD_PKT_ERR = 0x30,
94 MLX5_CMD_STAT_BAD_SIZE_OUTS_CQES_ERR = 0x40,
97 static struct mlx5_cmd_work_ent *alloc_cmd(struct mlx5_cmd *cmd,
98 struct mlx5_cmd_msg *in,
99 struct mlx5_cmd_msg *out,
100 void *uout, int uout_size,
102 void *context, int page_queue)
104 gfp_t alloc_flags = cbk ? GFP_ATOMIC : GFP_KERNEL;
105 struct mlx5_cmd_work_ent *ent;
107 ent = kzalloc(sizeof(*ent), alloc_flags);
109 return ERR_PTR(-ENOMEM);
114 ent->uout_size = uout_size;
116 ent->context = context;
118 ent->page_queue = page_queue;
123 static u8 alloc_token(struct mlx5_cmd *cmd)
127 spin_lock(&cmd->token_lock);
128 token = cmd->token++ % 255 + 1;
129 spin_unlock(&cmd->token_lock);
134 static int alloc_ent(struct mlx5_cmd *cmd)
139 spin_lock_irqsave(&cmd->alloc_lock, flags);
140 ret = find_first_bit(&cmd->bitmask, cmd->max_reg_cmds);
141 if (ret < cmd->max_reg_cmds)
142 clear_bit(ret, &cmd->bitmask);
143 spin_unlock_irqrestore(&cmd->alloc_lock, flags);
145 return ret < cmd->max_reg_cmds ? ret : -ENOMEM;
148 static void free_ent(struct mlx5_cmd *cmd, int idx)
152 spin_lock_irqsave(&cmd->alloc_lock, flags);
153 set_bit(idx, &cmd->bitmask);
154 spin_unlock_irqrestore(&cmd->alloc_lock, flags);
157 static struct mlx5_cmd_layout *get_inst(struct mlx5_cmd *cmd, int idx)
159 return cmd->cmd_buf + (idx << cmd->log_stride);
162 static u8 xor8_buf(void *buf, int len)
168 for (i = 0; i < len; i++)
174 static int verify_block_sig(struct mlx5_cmd_prot_block *block)
176 if (xor8_buf(block->rsvd0, sizeof(*block) - sizeof(block->data) - 1) != 0xff)
179 if (xor8_buf(block, sizeof(*block)) != 0xff)
185 static void calc_block_sig(struct mlx5_cmd_prot_block *block, u8 token,
188 block->token = token;
190 block->ctrl_sig = ~xor8_buf(block->rsvd0, sizeof(*block) -
191 sizeof(block->data) - 2);
192 block->sig = ~xor8_buf(block, sizeof(*block) - 1);
196 static void calc_chain_sig(struct mlx5_cmd_msg *msg, u8 token, int csum)
198 struct mlx5_cmd_mailbox *next = msg->next;
201 calc_block_sig(next->buf, token, csum);
206 static void set_signature(struct mlx5_cmd_work_ent *ent, int csum)
208 ent->lay->sig = ~xor8_buf(ent->lay, sizeof(*ent->lay));
209 calc_chain_sig(ent->in, ent->token, csum);
210 calc_chain_sig(ent->out, ent->token, csum);
213 static void poll_timeout(struct mlx5_cmd_work_ent *ent)
215 unsigned long poll_end = jiffies + msecs_to_jiffies(MLX5_CMD_TIMEOUT_MSEC + 1000);
219 own = ent->lay->status_own;
220 if (!(own & CMD_OWNER_HW)) {
224 usleep_range(5000, 10000);
225 } while (time_before(jiffies, poll_end));
227 ent->ret = -ETIMEDOUT;
230 static void free_cmd(struct mlx5_cmd_work_ent *ent)
236 static int verify_signature(struct mlx5_cmd_work_ent *ent)
238 struct mlx5_cmd_mailbox *next = ent->out->next;
242 sig = xor8_buf(ent->lay, sizeof(*ent->lay));
247 err = verify_block_sig(next->buf);
257 static void dump_buf(void *buf, int size, int data_only, int offset)
262 for (i = 0; i < size; i += 16) {
263 pr_debug("%03x: %08x %08x %08x %08x\n", offset, be32_to_cpu(p[0]),
264 be32_to_cpu(p[1]), be32_to_cpu(p[2]),
273 const char *mlx5_command_str(int command)
276 case MLX5_CMD_OP_QUERY_HCA_CAP:
277 return "QUERY_HCA_CAP";
279 case MLX5_CMD_OP_SET_HCA_CAP:
280 return "SET_HCA_CAP";
282 case MLX5_CMD_OP_QUERY_ADAPTER:
283 return "QUERY_ADAPTER";
285 case MLX5_CMD_OP_INIT_HCA:
288 case MLX5_CMD_OP_TEARDOWN_HCA:
289 return "TEARDOWN_HCA";
291 case MLX5_CMD_OP_ENABLE_HCA:
292 return "MLX5_CMD_OP_ENABLE_HCA";
294 case MLX5_CMD_OP_DISABLE_HCA:
295 return "MLX5_CMD_OP_DISABLE_HCA";
297 case MLX5_CMD_OP_QUERY_PAGES:
298 return "QUERY_PAGES";
300 case MLX5_CMD_OP_MANAGE_PAGES:
301 return "MANAGE_PAGES";
303 case MLX5_CMD_OP_CREATE_MKEY:
304 return "CREATE_MKEY";
306 case MLX5_CMD_OP_QUERY_MKEY:
309 case MLX5_CMD_OP_DESTROY_MKEY:
310 return "DESTROY_MKEY";
312 case MLX5_CMD_OP_QUERY_SPECIAL_CONTEXTS:
313 return "QUERY_SPECIAL_CONTEXTS";
315 case MLX5_CMD_OP_CREATE_EQ:
318 case MLX5_CMD_OP_DESTROY_EQ:
321 case MLX5_CMD_OP_QUERY_EQ:
324 case MLX5_CMD_OP_CREATE_CQ:
327 case MLX5_CMD_OP_DESTROY_CQ:
330 case MLX5_CMD_OP_QUERY_CQ:
333 case MLX5_CMD_OP_MODIFY_CQ:
336 case MLX5_CMD_OP_CREATE_QP:
339 case MLX5_CMD_OP_DESTROY_QP:
342 case MLX5_CMD_OP_RST2INIT_QP:
343 return "RST2INIT_QP";
345 case MLX5_CMD_OP_INIT2RTR_QP:
346 return "INIT2RTR_QP";
348 case MLX5_CMD_OP_RTR2RTS_QP:
351 case MLX5_CMD_OP_RTS2RTS_QP:
354 case MLX5_CMD_OP_SQERR2RTS_QP:
355 return "SQERR2RTS_QP";
357 case MLX5_CMD_OP_2ERR_QP:
360 case MLX5_CMD_OP_2RST_QP:
363 case MLX5_CMD_OP_QUERY_QP:
366 case MLX5_CMD_OP_MAD_IFC:
369 case MLX5_CMD_OP_INIT2INIT_QP:
370 return "INIT2INIT_QP";
372 case MLX5_CMD_OP_CREATE_PSV:
375 case MLX5_CMD_OP_DESTROY_PSV:
376 return "DESTROY_PSV";
378 case MLX5_CMD_OP_CREATE_SRQ:
381 case MLX5_CMD_OP_DESTROY_SRQ:
382 return "DESTROY_SRQ";
384 case MLX5_CMD_OP_QUERY_SRQ:
387 case MLX5_CMD_OP_ARM_RQ:
390 case MLX5_CMD_OP_RESIZE_SRQ:
393 case MLX5_CMD_OP_ALLOC_PD:
396 case MLX5_CMD_OP_DEALLOC_PD:
399 case MLX5_CMD_OP_ALLOC_UAR:
402 case MLX5_CMD_OP_DEALLOC_UAR:
403 return "DEALLOC_UAR";
405 case MLX5_CMD_OP_ATTACH_TO_MCG:
406 return "ATTACH_TO_MCG";
408 case MLX5_CMD_OP_DETACH_FROM_MCG:
409 return "DETACH_FROM_MCG";
411 case MLX5_CMD_OP_ALLOC_XRCD:
414 case MLX5_CMD_OP_DEALLOC_XRCD:
415 return "DEALLOC_XRCD";
417 case MLX5_CMD_OP_ACCESS_REG:
418 return "MLX5_CMD_OP_ACCESS_REG";
420 default: return "unknown command opcode";
424 static void dump_command(struct mlx5_core_dev *dev,
425 struct mlx5_cmd_work_ent *ent, int input)
427 u16 op = be16_to_cpu(((struct mlx5_inbox_hdr *)(ent->lay->in))->opcode);
428 struct mlx5_cmd_msg *msg = input ? ent->in : ent->out;
429 struct mlx5_cmd_mailbox *next = msg->next;
434 data_only = !!(mlx5_core_debug_mask & (1 << MLX5_CMD_DATA));
437 mlx5_core_dbg_mask(dev, 1 << MLX5_CMD_DATA,
438 "dump command data %s(0x%x) %s\n",
439 mlx5_command_str(op), op,
440 input ? "INPUT" : "OUTPUT");
442 mlx5_core_dbg(dev, "dump command %s(0x%x) %s\n",
443 mlx5_command_str(op), op,
444 input ? "INPUT" : "OUTPUT");
448 dump_buf(ent->lay->in, sizeof(ent->lay->in), 1, offset);
449 offset += sizeof(ent->lay->in);
451 dump_buf(ent->lay->out, sizeof(ent->lay->out), 1, offset);
452 offset += sizeof(ent->lay->out);
455 dump_buf(ent->lay, sizeof(*ent->lay), 0, offset);
456 offset += sizeof(*ent->lay);
459 while (next && offset < msg->len) {
461 dump_len = min_t(int, MLX5_CMD_DATA_BLOCK_SIZE, msg->len - offset);
462 dump_buf(next->buf, dump_len, 1, offset);
463 offset += MLX5_CMD_DATA_BLOCK_SIZE;
465 mlx5_core_dbg(dev, "command block:\n");
466 dump_buf(next->buf, sizeof(struct mlx5_cmd_prot_block), 0, offset);
467 offset += sizeof(struct mlx5_cmd_prot_block);
476 static void cmd_work_handler(struct work_struct *work)
478 struct mlx5_cmd_work_ent *ent = container_of(work, struct mlx5_cmd_work_ent, work);
479 struct mlx5_cmd *cmd = ent->cmd;
480 struct mlx5_core_dev *dev = container_of(cmd, struct mlx5_core_dev, cmd);
481 struct mlx5_cmd_layout *lay;
482 struct semaphore *sem;
484 sem = ent->page_queue ? &cmd->pages_sem : &cmd->sem;
486 if (!ent->page_queue) {
487 ent->idx = alloc_ent(cmd);
489 mlx5_core_err(dev, "failed to allocate command entry\n");
494 ent->idx = cmd->max_reg_cmds;
497 ent->token = alloc_token(cmd);
498 cmd->ent_arr[ent->idx] = ent;
499 lay = get_inst(cmd, ent->idx);
501 memset(lay, 0, sizeof(*lay));
502 memcpy(lay->in, ent->in->first.data, sizeof(lay->in));
503 ent->op = be32_to_cpu(lay->in[0]) >> 16;
505 lay->in_ptr = cpu_to_be64(ent->in->next->dma);
506 lay->inlen = cpu_to_be32(ent->in->len);
508 lay->out_ptr = cpu_to_be64(ent->out->next->dma);
509 lay->outlen = cpu_to_be32(ent->out->len);
510 lay->type = MLX5_PCI_CMD_XPORT;
511 lay->token = ent->token;
512 lay->status_own = CMD_OWNER_HW;
513 set_signature(ent, !cmd->checksum_disabled);
514 dump_command(dev, ent, 1);
515 ent->ts1 = ktime_get_ns();
517 /* ring doorbell after the descriptor is valid */
518 mlx5_core_dbg(dev, "writing 0x%x to command doorbell\n", 1 << ent->idx);
520 iowrite32be(1 << ent->idx, &dev->iseg->cmd_dbell);
522 /* if not in polling don't use ent after this point */
523 if (cmd->mode == CMD_MODE_POLLING) {
525 /* make sure we read the descriptor after ownership is SW */
527 mlx5_cmd_comp_handler(dev, 1UL << ent->idx);
531 static const char *deliv_status_to_str(u8 status)
534 case MLX5_CMD_DELIVERY_STAT_OK:
536 case MLX5_CMD_DELIVERY_STAT_SIGNAT_ERR:
537 return "signature error";
538 case MLX5_CMD_DELIVERY_STAT_TOK_ERR:
539 return "token error";
540 case MLX5_CMD_DELIVERY_STAT_BAD_BLK_NUM_ERR:
541 return "bad block number";
542 case MLX5_CMD_DELIVERY_STAT_OUT_PTR_ALIGN_ERR:
543 return "output pointer not aligned to block size";
544 case MLX5_CMD_DELIVERY_STAT_IN_PTR_ALIGN_ERR:
545 return "input pointer not aligned to block size";
546 case MLX5_CMD_DELIVERY_STAT_FW_ERR:
547 return "firmware internal error";
548 case MLX5_CMD_DELIVERY_STAT_IN_LENGTH_ERR:
549 return "command input length error";
550 case MLX5_CMD_DELIVERY_STAT_OUT_LENGTH_ERR:
551 return "command ouput length error";
552 case MLX5_CMD_DELIVERY_STAT_RES_FLD_NOT_CLR_ERR:
553 return "reserved fields not cleared";
554 case MLX5_CMD_DELIVERY_STAT_CMD_DESCR_ERR:
555 return "bad command descriptor type";
557 return "unknown status code";
561 static u16 msg_to_opcode(struct mlx5_cmd_msg *in)
563 struct mlx5_inbox_hdr *hdr = (struct mlx5_inbox_hdr *)(in->first.data);
565 return be16_to_cpu(hdr->opcode);
568 static int wait_func(struct mlx5_core_dev *dev, struct mlx5_cmd_work_ent *ent)
570 unsigned long timeout = msecs_to_jiffies(MLX5_CMD_TIMEOUT_MSEC);
571 struct mlx5_cmd *cmd = &dev->cmd;
574 if (cmd->mode == CMD_MODE_POLLING) {
575 wait_for_completion(&ent->done);
578 if (!wait_for_completion_timeout(&ent->done, timeout))
583 if (err == -ETIMEDOUT) {
584 mlx5_core_warn(dev, "%s(0x%x) timeout. Will cause a leak of a command resource\n",
585 mlx5_command_str(msg_to_opcode(ent->in)),
586 msg_to_opcode(ent->in));
588 mlx5_core_dbg(dev, "err %d, delivery status %s(%d)\n",
589 err, deliv_status_to_str(ent->status), ent->status);
595 * 1. Callback functions may not sleep
596 * 2. page queue commands do not support asynchrous completion
598 static int mlx5_cmd_invoke(struct mlx5_core_dev *dev, struct mlx5_cmd_msg *in,
599 struct mlx5_cmd_msg *out, void *uout, int uout_size,
600 mlx5_cmd_cbk_t callback,
601 void *context, int page_queue, u8 *status)
603 struct mlx5_cmd *cmd = &dev->cmd;
604 struct mlx5_cmd_work_ent *ent;
605 struct mlx5_cmd_stats *stats;
610 if (callback && page_queue)
613 ent = alloc_cmd(cmd, in, out, uout, uout_size, callback, context,
619 init_completion(&ent->done);
621 INIT_WORK(&ent->work, cmd_work_handler);
623 cmd_work_handler(&ent->work);
624 } else if (!queue_work(cmd->wq, &ent->work)) {
625 mlx5_core_warn(dev, "failed to queue work\n");
631 err = wait_func(dev, ent);
632 if (err == -ETIMEDOUT)
635 ds = ent->ts2 - ent->ts1;
636 op = be16_to_cpu(((struct mlx5_inbox_hdr *)in->first.data)->opcode);
637 if (op < ARRAY_SIZE(cmd->stats)) {
638 stats = &cmd->stats[op];
639 spin_lock_irq(&stats->lock);
642 spin_unlock_irq(&stats->lock);
644 mlx5_core_dbg_mask(dev, 1 << MLX5_CMD_TIME,
645 "fw exec time for %s is %lld nsec\n",
646 mlx5_command_str(op), ds);
647 *status = ent->status;
659 static ssize_t dbg_write(struct file *filp, const char __user *buf,
660 size_t count, loff_t *pos)
662 struct mlx5_core_dev *dev = filp->private_data;
663 struct mlx5_cmd_debug *dbg = &dev->cmd.dbg;
667 if (!dbg->in_msg || !dbg->out_msg)
670 if (copy_from_user(lbuf, buf, sizeof(lbuf)))
673 lbuf[sizeof(lbuf) - 1] = 0;
675 if (strcmp(lbuf, "go"))
678 err = mlx5_cmd_exec(dev, dbg->in_msg, dbg->inlen, dbg->out_msg, dbg->outlen);
680 return err ? err : count;
684 static const struct file_operations fops = {
685 .owner = THIS_MODULE,
690 static int mlx5_copy_to_msg(struct mlx5_cmd_msg *to, void *from, int size)
692 struct mlx5_cmd_prot_block *block;
693 struct mlx5_cmd_mailbox *next;
699 copy = min_t(int, size, sizeof(to->first.data));
700 memcpy(to->first.data, from, copy);
711 copy = min_t(int, size, MLX5_CMD_DATA_BLOCK_SIZE);
713 memcpy(block->data, from, copy);
722 static int mlx5_copy_from_msg(void *to, struct mlx5_cmd_msg *from, int size)
724 struct mlx5_cmd_prot_block *block;
725 struct mlx5_cmd_mailbox *next;
731 copy = min_t(int, size, sizeof(from->first.data));
732 memcpy(to, from->first.data, copy);
743 copy = min_t(int, size, MLX5_CMD_DATA_BLOCK_SIZE);
746 memcpy(to, block->data, copy);
755 static struct mlx5_cmd_mailbox *alloc_cmd_box(struct mlx5_core_dev *dev,
758 struct mlx5_cmd_mailbox *mailbox;
760 mailbox = kmalloc(sizeof(*mailbox), flags);
762 return ERR_PTR(-ENOMEM);
764 mailbox->buf = pci_pool_alloc(dev->cmd.pool, flags,
767 mlx5_core_dbg(dev, "failed allocation\n");
769 return ERR_PTR(-ENOMEM);
771 memset(mailbox->buf, 0, sizeof(struct mlx5_cmd_prot_block));
772 mailbox->next = NULL;
777 static void free_cmd_box(struct mlx5_core_dev *dev,
778 struct mlx5_cmd_mailbox *mailbox)
780 pci_pool_free(dev->cmd.pool, mailbox->buf, mailbox->dma);
784 static struct mlx5_cmd_msg *mlx5_alloc_cmd_msg(struct mlx5_core_dev *dev,
785 gfp_t flags, int size)
787 struct mlx5_cmd_mailbox *tmp, *head = NULL;
788 struct mlx5_cmd_prot_block *block;
789 struct mlx5_cmd_msg *msg;
795 msg = kzalloc(sizeof(*msg), flags);
797 return ERR_PTR(-ENOMEM);
799 blen = size - min_t(int, sizeof(msg->first.data), size);
800 n = (blen + MLX5_CMD_DATA_BLOCK_SIZE - 1) / MLX5_CMD_DATA_BLOCK_SIZE;
802 for (i = 0; i < n; i++) {
803 tmp = alloc_cmd_box(dev, flags);
805 mlx5_core_warn(dev, "failed allocating block\n");
812 block->next = cpu_to_be64(tmp->next ? tmp->next->dma : 0);
813 block->block_num = cpu_to_be32(n - i - 1);
823 free_cmd_box(dev, head);
831 static void mlx5_free_cmd_msg(struct mlx5_core_dev *dev,
832 struct mlx5_cmd_msg *msg)
834 struct mlx5_cmd_mailbox *head = msg->next;
835 struct mlx5_cmd_mailbox *next;
839 free_cmd_box(dev, head);
845 static ssize_t data_write(struct file *filp, const char __user *buf,
846 size_t count, loff_t *pos)
848 struct mlx5_core_dev *dev = filp->private_data;
849 struct mlx5_cmd_debug *dbg = &dev->cmd.dbg;
860 ptr = kzalloc(count, GFP_KERNEL);
864 if (copy_from_user(ptr, buf, count)) {
880 static ssize_t data_read(struct file *filp, char __user *buf, size_t count,
883 struct mlx5_core_dev *dev = filp->private_data;
884 struct mlx5_cmd_debug *dbg = &dev->cmd.dbg;
893 copy = min_t(int, count, dbg->outlen);
894 if (copy_to_user(buf, dbg->out_msg, copy))
902 static const struct file_operations dfops = {
903 .owner = THIS_MODULE,
909 static ssize_t outlen_read(struct file *filp, char __user *buf, size_t count,
912 struct mlx5_core_dev *dev = filp->private_data;
913 struct mlx5_cmd_debug *dbg = &dev->cmd.dbg;
920 err = snprintf(outlen, sizeof(outlen), "%d", dbg->outlen);
924 if (copy_to_user(buf, &outlen, err))
932 static ssize_t outlen_write(struct file *filp, const char __user *buf,
933 size_t count, loff_t *pos)
935 struct mlx5_core_dev *dev = filp->private_data;
936 struct mlx5_cmd_debug *dbg = &dev->cmd.dbg;
942 if (*pos != 0 || count > 6)
949 if (copy_from_user(outlen_str, buf, count))
954 err = sscanf(outlen_str, "%d", &outlen);
958 ptr = kzalloc(outlen, GFP_KERNEL);
963 dbg->outlen = outlen;
970 static const struct file_operations olfops = {
971 .owner = THIS_MODULE,
973 .write = outlen_write,
977 static void set_wqname(struct mlx5_core_dev *dev)
979 struct mlx5_cmd *cmd = &dev->cmd;
981 snprintf(cmd->wq_name, sizeof(cmd->wq_name), "mlx5_cmd_%s",
982 dev_name(&dev->pdev->dev));
985 static void clean_debug_files(struct mlx5_core_dev *dev)
987 struct mlx5_cmd_debug *dbg = &dev->cmd.dbg;
989 if (!mlx5_debugfs_root)
992 mlx5_cmdif_debugfs_cleanup(dev);
993 debugfs_remove_recursive(dbg->dbg_root);
996 static int create_debugfs_files(struct mlx5_core_dev *dev)
998 struct mlx5_cmd_debug *dbg = &dev->cmd.dbg;
1001 if (!mlx5_debugfs_root)
1004 dbg->dbg_root = debugfs_create_dir("cmd", dev->priv.dbg_root);
1008 dbg->dbg_in = debugfs_create_file("in", 0400, dbg->dbg_root,
1013 dbg->dbg_out = debugfs_create_file("out", 0200, dbg->dbg_root,
1018 dbg->dbg_outlen = debugfs_create_file("out_len", 0600, dbg->dbg_root,
1020 if (!dbg->dbg_outlen)
1023 dbg->dbg_status = debugfs_create_u8("status", 0600, dbg->dbg_root,
1025 if (!dbg->dbg_status)
1028 dbg->dbg_run = debugfs_create_file("run", 0200, dbg->dbg_root, dev, &fops);
1032 mlx5_cmdif_debugfs_init(dev);
1037 clean_debug_files(dev);
1041 void mlx5_cmd_use_events(struct mlx5_core_dev *dev)
1043 struct mlx5_cmd *cmd = &dev->cmd;
1046 for (i = 0; i < cmd->max_reg_cmds; i++)
1049 down(&cmd->pages_sem);
1051 flush_workqueue(cmd->wq);
1053 cmd->mode = CMD_MODE_EVENTS;
1055 up(&cmd->pages_sem);
1056 for (i = 0; i < cmd->max_reg_cmds; i++)
1060 void mlx5_cmd_use_polling(struct mlx5_core_dev *dev)
1062 struct mlx5_cmd *cmd = &dev->cmd;
1065 for (i = 0; i < cmd->max_reg_cmds; i++)
1068 down(&cmd->pages_sem);
1070 flush_workqueue(cmd->wq);
1071 cmd->mode = CMD_MODE_POLLING;
1073 up(&cmd->pages_sem);
1074 for (i = 0; i < cmd->max_reg_cmds; i++)
1078 static void free_msg(struct mlx5_core_dev *dev, struct mlx5_cmd_msg *msg)
1080 unsigned long flags;
1083 spin_lock_irqsave(&msg->cache->lock, flags);
1084 list_add_tail(&msg->list, &msg->cache->head);
1085 spin_unlock_irqrestore(&msg->cache->lock, flags);
1087 mlx5_free_cmd_msg(dev, msg);
1091 void mlx5_cmd_comp_handler(struct mlx5_core_dev *dev, unsigned long vector)
1093 struct mlx5_cmd *cmd = &dev->cmd;
1094 struct mlx5_cmd_work_ent *ent;
1095 mlx5_cmd_cbk_t callback;
1100 struct mlx5_cmd_stats *stats;
1101 unsigned long flags;
1103 for (i = 0; i < (1 << cmd->log_sz); i++) {
1104 if (test_bit(i, &vector)) {
1105 struct semaphore *sem;
1107 ent = cmd->ent_arr[i];
1108 if (ent->page_queue)
1109 sem = &cmd->pages_sem;
1112 ent->ts2 = ktime_get_ns();
1113 memcpy(ent->out->first.data, ent->lay->out, sizeof(ent->lay->out));
1114 dump_command(dev, ent, 0);
1116 if (!cmd->checksum_disabled)
1117 ent->ret = verify_signature(ent);
1120 ent->status = ent->lay->status_own >> 1;
1121 mlx5_core_dbg(dev, "command completed. ret 0x%x, delivery status %s(0x%x)\n",
1122 ent->ret, deliv_status_to_str(ent->status), ent->status);
1124 free_ent(cmd, ent->idx);
1125 if (ent->callback) {
1126 ds = ent->ts2 - ent->ts1;
1127 if (ent->op < ARRAY_SIZE(cmd->stats)) {
1128 stats = &cmd->stats[ent->op];
1129 spin_lock_irqsave(&stats->lock, flags);
1132 spin_unlock_irqrestore(&stats->lock, flags);
1135 callback = ent->callback;
1136 context = ent->context;
1139 err = mlx5_copy_from_msg(ent->uout,
1143 mlx5_free_cmd_msg(dev, ent->out);
1144 free_msg(dev, ent->in);
1147 callback(err, context);
1149 complete(&ent->done);
1155 EXPORT_SYMBOL(mlx5_cmd_comp_handler);
1157 static int status_to_err(u8 status)
1159 return status ? -1 : 0; /* TBD more meaningful codes */
1162 static struct mlx5_cmd_msg *alloc_msg(struct mlx5_core_dev *dev, int in_size,
1165 struct mlx5_cmd_msg *msg = ERR_PTR(-ENOMEM);
1166 struct mlx5_cmd *cmd = &dev->cmd;
1167 struct cache_ent *ent = NULL;
1169 if (in_size > MED_LIST_SIZE && in_size <= LONG_LIST_SIZE)
1170 ent = &cmd->cache.large;
1171 else if (in_size > 16 && in_size <= MED_LIST_SIZE)
1172 ent = &cmd->cache.med;
1175 spin_lock_irq(&ent->lock);
1176 if (!list_empty(&ent->head)) {
1177 msg = list_entry(ent->head.next, typeof(*msg), list);
1178 /* For cached lists, we must explicitly state what is
1182 list_del(&msg->list);
1184 spin_unlock_irq(&ent->lock);
1188 msg = mlx5_alloc_cmd_msg(dev, gfp, in_size);
1193 static int is_manage_pages(struct mlx5_inbox_hdr *in)
1195 return be16_to_cpu(in->opcode) == MLX5_CMD_OP_MANAGE_PAGES;
1198 static int cmd_exec(struct mlx5_core_dev *dev, void *in, int in_size, void *out,
1199 int out_size, mlx5_cmd_cbk_t callback, void *context)
1201 struct mlx5_cmd_msg *inb;
1202 struct mlx5_cmd_msg *outb;
1208 pages_queue = is_manage_pages(in);
1209 gfp = callback ? GFP_ATOMIC : GFP_KERNEL;
1211 inb = alloc_msg(dev, in_size, gfp);
1217 err = mlx5_copy_to_msg(inb, in, in_size);
1219 mlx5_core_warn(dev, "err %d\n", err);
1223 outb = mlx5_alloc_cmd_msg(dev, gfp, out_size);
1225 err = PTR_ERR(outb);
1229 err = mlx5_cmd_invoke(dev, inb, outb, out, out_size, callback, context,
1230 pages_queue, &status);
1234 mlx5_core_dbg(dev, "err %d, status %d\n", err, status);
1236 err = status_to_err(status);
1241 err = mlx5_copy_from_msg(out, outb, out_size);
1245 mlx5_free_cmd_msg(dev, outb);
1253 int mlx5_cmd_exec(struct mlx5_core_dev *dev, void *in, int in_size, void *out,
1256 return cmd_exec(dev, in, in_size, out, out_size, NULL, NULL);
1258 EXPORT_SYMBOL(mlx5_cmd_exec);
1260 int mlx5_cmd_exec_cb(struct mlx5_core_dev *dev, void *in, int in_size,
1261 void *out, int out_size, mlx5_cmd_cbk_t callback,
1264 return cmd_exec(dev, in, in_size, out, out_size, callback, context);
1266 EXPORT_SYMBOL(mlx5_cmd_exec_cb);
1268 static void destroy_msg_cache(struct mlx5_core_dev *dev)
1270 struct mlx5_cmd *cmd = &dev->cmd;
1271 struct mlx5_cmd_msg *msg;
1272 struct mlx5_cmd_msg *n;
1274 list_for_each_entry_safe(msg, n, &cmd->cache.large.head, list) {
1275 list_del(&msg->list);
1276 mlx5_free_cmd_msg(dev, msg);
1279 list_for_each_entry_safe(msg, n, &cmd->cache.med.head, list) {
1280 list_del(&msg->list);
1281 mlx5_free_cmd_msg(dev, msg);
1285 static int create_msg_cache(struct mlx5_core_dev *dev)
1287 struct mlx5_cmd *cmd = &dev->cmd;
1288 struct mlx5_cmd_msg *msg;
1292 spin_lock_init(&cmd->cache.large.lock);
1293 INIT_LIST_HEAD(&cmd->cache.large.head);
1294 spin_lock_init(&cmd->cache.med.lock);
1295 INIT_LIST_HEAD(&cmd->cache.med.head);
1297 for (i = 0; i < NUM_LONG_LISTS; i++) {
1298 msg = mlx5_alloc_cmd_msg(dev, GFP_KERNEL, LONG_LIST_SIZE);
1303 msg->cache = &cmd->cache.large;
1304 list_add_tail(&msg->list, &cmd->cache.large.head);
1307 for (i = 0; i < NUM_MED_LISTS; i++) {
1308 msg = mlx5_alloc_cmd_msg(dev, GFP_KERNEL, MED_LIST_SIZE);
1313 msg->cache = &cmd->cache.med;
1314 list_add_tail(&msg->list, &cmd->cache.med.head);
1320 destroy_msg_cache(dev);
1324 static int alloc_cmd_page(struct mlx5_core_dev *dev, struct mlx5_cmd *cmd)
1326 struct device *ddev = &dev->pdev->dev;
1328 cmd->cmd_alloc_buf = dma_zalloc_coherent(ddev, MLX5_ADAPTER_PAGE_SIZE,
1329 &cmd->alloc_dma, GFP_KERNEL);
1330 if (!cmd->cmd_alloc_buf)
1333 /* make sure it is aligned to 4K */
1334 if (!((uintptr_t)cmd->cmd_alloc_buf & (MLX5_ADAPTER_PAGE_SIZE - 1))) {
1335 cmd->cmd_buf = cmd->cmd_alloc_buf;
1336 cmd->dma = cmd->alloc_dma;
1337 cmd->alloc_size = MLX5_ADAPTER_PAGE_SIZE;
1341 dma_free_coherent(ddev, MLX5_ADAPTER_PAGE_SIZE, cmd->cmd_alloc_buf,
1343 cmd->cmd_alloc_buf = dma_zalloc_coherent(ddev,
1344 2 * MLX5_ADAPTER_PAGE_SIZE - 1,
1345 &cmd->alloc_dma, GFP_KERNEL);
1346 if (!cmd->cmd_alloc_buf)
1349 cmd->cmd_buf = PTR_ALIGN(cmd->cmd_alloc_buf, MLX5_ADAPTER_PAGE_SIZE);
1350 cmd->dma = ALIGN(cmd->alloc_dma, MLX5_ADAPTER_PAGE_SIZE);
1351 cmd->alloc_size = 2 * MLX5_ADAPTER_PAGE_SIZE - 1;
1355 static void free_cmd_page(struct mlx5_core_dev *dev, struct mlx5_cmd *cmd)
1357 struct device *ddev = &dev->pdev->dev;
1359 dma_free_coherent(ddev, cmd->alloc_size, cmd->cmd_alloc_buf,
1363 int mlx5_cmd_init(struct mlx5_core_dev *dev)
1365 int size = sizeof(struct mlx5_cmd_prot_block);
1366 int align = roundup_pow_of_two(size);
1367 struct mlx5_cmd *cmd = &dev->cmd;
1373 cmd_if_rev = cmdif_rev(dev);
1374 if (cmd_if_rev != CMD_IF_REV) {
1375 dev_err(&dev->pdev->dev,
1376 "Driver cmdif rev(%d) differs from firmware's(%d)\n",
1377 CMD_IF_REV, cmd_if_rev);
1381 cmd->pool = pci_pool_create("mlx5_cmd", dev->pdev, size, align, 0);
1385 err = alloc_cmd_page(dev, cmd);
1389 cmd_l = ioread32be(&dev->iseg->cmdq_addr_l_sz) & 0xff;
1390 cmd->log_sz = cmd_l >> 4 & 0xf;
1391 cmd->log_stride = cmd_l & 0xf;
1392 if (1 << cmd->log_sz > MLX5_MAX_COMMANDS) {
1393 dev_err(&dev->pdev->dev, "firmware reports too many outstanding commands %d\n",
1399 if (cmd->log_sz + cmd->log_stride > MLX5_ADAPTER_PAGE_SHIFT) {
1400 dev_err(&dev->pdev->dev, "command queue size overflow\n");
1405 cmd->checksum_disabled = 1;
1406 cmd->max_reg_cmds = (1 << cmd->log_sz) - 1;
1407 cmd->bitmask = (1 << cmd->max_reg_cmds) - 1;
1409 cmd->cmdif_rev = ioread32be(&dev->iseg->cmdif_rev_fw_sub) >> 16;
1410 if (cmd->cmdif_rev > CMD_IF_REV) {
1411 dev_err(&dev->pdev->dev, "driver does not support command interface version. driver %d, firmware %d\n",
1412 CMD_IF_REV, cmd->cmdif_rev);
1417 spin_lock_init(&cmd->alloc_lock);
1418 spin_lock_init(&cmd->token_lock);
1419 for (i = 0; i < ARRAY_SIZE(cmd->stats); i++)
1420 spin_lock_init(&cmd->stats[i].lock);
1422 sema_init(&cmd->sem, cmd->max_reg_cmds);
1423 sema_init(&cmd->pages_sem, 1);
1425 cmd_h = (u32)((u64)(cmd->dma) >> 32);
1426 cmd_l = (u32)(cmd->dma);
1427 if (cmd_l & 0xfff) {
1428 dev_err(&dev->pdev->dev, "invalid command queue address\n");
1433 iowrite32be(cmd_h, &dev->iseg->cmdq_addr_h);
1434 iowrite32be(cmd_l, &dev->iseg->cmdq_addr_l_sz);
1436 /* Make sure firmware sees the complete address before we proceed */
1439 mlx5_core_dbg(dev, "descriptor at dma 0x%llx\n", (unsigned long long)(cmd->dma));
1441 cmd->mode = CMD_MODE_POLLING;
1443 err = create_msg_cache(dev);
1445 dev_err(&dev->pdev->dev, "failed to create command cache\n");
1450 cmd->wq = create_singlethread_workqueue(cmd->wq_name);
1452 dev_err(&dev->pdev->dev, "failed to create command workqueue\n");
1457 err = create_debugfs_files(dev);
1466 destroy_workqueue(cmd->wq);
1469 destroy_msg_cache(dev);
1472 free_cmd_page(dev, cmd);
1475 pci_pool_destroy(cmd->pool);
1479 EXPORT_SYMBOL(mlx5_cmd_init);
1481 void mlx5_cmd_cleanup(struct mlx5_core_dev *dev)
1483 struct mlx5_cmd *cmd = &dev->cmd;
1485 clean_debug_files(dev);
1486 destroy_workqueue(cmd->wq);
1487 destroy_msg_cache(dev);
1488 free_cmd_page(dev, cmd);
1489 pci_pool_destroy(cmd->pool);
1491 EXPORT_SYMBOL(mlx5_cmd_cleanup);
1493 static const char *cmd_status_str(u8 status)
1496 case MLX5_CMD_STAT_OK:
1498 case MLX5_CMD_STAT_INT_ERR:
1499 return "internal error";
1500 case MLX5_CMD_STAT_BAD_OP_ERR:
1501 return "bad operation";
1502 case MLX5_CMD_STAT_BAD_PARAM_ERR:
1503 return "bad parameter";
1504 case MLX5_CMD_STAT_BAD_SYS_STATE_ERR:
1505 return "bad system state";
1506 case MLX5_CMD_STAT_BAD_RES_ERR:
1507 return "bad resource";
1508 case MLX5_CMD_STAT_RES_BUSY:
1509 return "resource busy";
1510 case MLX5_CMD_STAT_LIM_ERR:
1511 return "limits exceeded";
1512 case MLX5_CMD_STAT_BAD_RES_STATE_ERR:
1513 return "bad resource state";
1514 case MLX5_CMD_STAT_IX_ERR:
1516 case MLX5_CMD_STAT_NO_RES_ERR:
1517 return "no resources";
1518 case MLX5_CMD_STAT_BAD_INP_LEN_ERR:
1519 return "bad input length";
1520 case MLX5_CMD_STAT_BAD_OUTP_LEN_ERR:
1521 return "bad output length";
1522 case MLX5_CMD_STAT_BAD_QP_STATE_ERR:
1523 return "bad QP state";
1524 case MLX5_CMD_STAT_BAD_PKT_ERR:
1525 return "bad packet (discarded)";
1526 case MLX5_CMD_STAT_BAD_SIZE_OUTS_CQES_ERR:
1527 return "bad size too many outstanding CQEs";
1529 return "unknown status";
1533 static int cmd_status_to_err(u8 status)
1536 case MLX5_CMD_STAT_OK: return 0;
1537 case MLX5_CMD_STAT_INT_ERR: return -EIO;
1538 case MLX5_CMD_STAT_BAD_OP_ERR: return -EINVAL;
1539 case MLX5_CMD_STAT_BAD_PARAM_ERR: return -EINVAL;
1540 case MLX5_CMD_STAT_BAD_SYS_STATE_ERR: return -EIO;
1541 case MLX5_CMD_STAT_BAD_RES_ERR: return -EINVAL;
1542 case MLX5_CMD_STAT_RES_BUSY: return -EBUSY;
1543 case MLX5_CMD_STAT_LIM_ERR: return -ENOMEM;
1544 case MLX5_CMD_STAT_BAD_RES_STATE_ERR: return -EINVAL;
1545 case MLX5_CMD_STAT_IX_ERR: return -EINVAL;
1546 case MLX5_CMD_STAT_NO_RES_ERR: return -EAGAIN;
1547 case MLX5_CMD_STAT_BAD_INP_LEN_ERR: return -EIO;
1548 case MLX5_CMD_STAT_BAD_OUTP_LEN_ERR: return -EIO;
1549 case MLX5_CMD_STAT_BAD_QP_STATE_ERR: return -EINVAL;
1550 case MLX5_CMD_STAT_BAD_PKT_ERR: return -EINVAL;
1551 case MLX5_CMD_STAT_BAD_SIZE_OUTS_CQES_ERR: return -EINVAL;
1552 default: return -EIO;
1556 /* this will be available till all the commands use set/get macros */
1557 int mlx5_cmd_status_to_err(struct mlx5_outbox_hdr *hdr)
1562 pr_warn("command failed, status %s(0x%x), syndrome 0x%x\n",
1563 cmd_status_str(hdr->status), hdr->status,
1564 be32_to_cpu(hdr->syndrome));
1566 return cmd_status_to_err(hdr->status);
1569 int mlx5_cmd_status_to_err_v2(void *ptr)
1574 status = be32_to_cpu(*(__be32 *)ptr) >> 24;
1578 syndrome = be32_to_cpu(*(__be32 *)(ptr + 4));
1580 pr_warn("command failed, status %s(0x%x), syndrome 0x%x\n",
1581 cmd_status_str(status), status, syndrome);
1583 return cmd_status_to_err(status);