1 // SPDX-License-Identifier: GPL-2.0-only
3 * QLogic Fibre Channel HBA Driver
4 * Copyright (c) 2003-2017 QLogic Corporation
7 #include <linux/scatterlist.h>
8 #include <linux/delay.h>
9 #include <linux/nvme.h>
10 #include <linux/nvme-fc.h>
12 static struct nvme_fc_port_template qla_nvme_fc_transport;
14 int qla_nvme_register_remote(struct scsi_qla_host *vha, struct fc_port *fcport)
16 struct qla_nvme_rport *rport;
17 struct nvme_fc_port_info req;
20 if (!IS_ENABLED(CONFIG_NVME_FC))
23 if (!vha->flags.nvme_enabled) {
24 ql_log(ql_log_info, vha, 0x2100,
25 "%s: Not registering target since Host NVME is not enabled\n",
30 if (!vha->nvme_local_port && qla_nvme_register_hba(vha))
33 if (!(fcport->nvme_prli_service_param &
34 (NVME_PRLI_SP_TARGET | NVME_PRLI_SP_DISCOVERY)) ||
35 (fcport->nvme_flag & NVME_FLAG_REGISTERED))
38 fcport->nvme_flag &= ~NVME_FLAG_RESETTING;
40 memset(&req, 0, sizeof(struct nvme_fc_port_info));
41 req.port_name = wwn_to_u64(fcport->port_name);
42 req.node_name = wwn_to_u64(fcport->node_name);
46 if (fcport->nvme_prli_service_param & NVME_PRLI_SP_INITIATOR)
47 req.port_role = FC_PORT_ROLE_NVME_INITIATOR;
49 if (fcport->nvme_prli_service_param & NVME_PRLI_SP_TARGET)
50 req.port_role |= FC_PORT_ROLE_NVME_TARGET;
52 if (fcport->nvme_prli_service_param & NVME_PRLI_SP_DISCOVERY)
53 req.port_role |= FC_PORT_ROLE_NVME_DISCOVERY;
55 req.port_id = fcport->d_id.b24;
57 ql_log(ql_log_info, vha, 0x2102,
58 "%s: traddr=nn-0x%016llx:pn-0x%016llx PortID:%06x\n",
59 __func__, req.node_name, req.port_name,
62 ret = nvme_fc_register_remoteport(vha->nvme_local_port, &req,
63 &fcport->nvme_remote_port);
65 ql_log(ql_log_warn, vha, 0x212e,
66 "Failed to register remote port. Transport returned %d\n",
71 if (fcport->nvme_prli_service_param & NVME_PRLI_SP_SLER)
72 ql_log(ql_log_info, vha, 0x212a,
73 "PortID:%06x Supports SLER\n", req.port_id);
75 if (fcport->nvme_prli_service_param & NVME_PRLI_SP_PI_CTRL)
76 ql_log(ql_log_info, vha, 0x212b,
77 "PortID:%06x Supports PI control\n", req.port_id);
79 rport = fcport->nvme_remote_port->private;
80 rport->fcport = fcport;
82 fcport->nvme_flag |= NVME_FLAG_REGISTERED;
86 /* Allocate a queue for NVMe traffic */
87 static int qla_nvme_alloc_queue(struct nvme_fc_local_port *lport,
88 unsigned int qidx, u16 qsize, void **handle)
90 struct scsi_qla_host *vha;
91 struct qla_hw_data *ha;
92 struct qla_qpair *qpair;
94 /* Map admin queue and 1st IO queue to index 0 */
98 vha = (struct scsi_qla_host *)lport->private;
101 ql_log(ql_log_info, vha, 0x2104,
102 "%s: handle %p, idx =%d, qsize %d\n",
103 __func__, handle, qidx, qsize);
105 if (qidx > qla_nvme_fc_transport.max_hw_queues) {
106 ql_log(ql_log_warn, vha, 0x212f,
107 "%s: Illegal qidx=%d. Max=%d\n",
108 __func__, qidx, qla_nvme_fc_transport.max_hw_queues);
112 /* Use base qpair if max_qpairs is 0 */
113 if (!ha->max_qpairs) {
114 qpair = ha->base_qpair;
116 if (ha->queue_pair_map[qidx]) {
117 *handle = ha->queue_pair_map[qidx];
118 ql_log(ql_log_info, vha, 0x2121,
119 "Returning existing qpair of %p for idx=%x\n",
124 qpair = qla2xxx_create_qpair(vha, 5, vha->vp_idx, true);
126 ql_log(ql_log_warn, vha, 0x2122,
127 "Failed to allocate qpair\n");
136 static void qla_nvme_release_fcp_cmd_kref(struct kref *kref)
138 struct srb *sp = container_of(kref, struct srb, cmd_kref);
139 struct nvme_private *priv = (struct nvme_private *)sp->priv;
140 struct nvmefc_fcp_req *fd;
141 struct srb_iocb *nvme;
147 nvme = &sp->u.iocb_cmd;
148 fd = nvme->u.nvme.desc;
150 spin_lock_irqsave(&priv->cmd_lock, flags);
153 if (priv->comp_status == QLA_SUCCESS) {
154 fd->rcv_rsplen = le16_to_cpu(nvme->u.nvme.rsp_pyld_len);
155 fd->status = NVME_SC_SUCCESS;
158 fd->transferred_length = 0;
159 fd->status = NVME_SC_INTERNAL;
161 spin_unlock_irqrestore(&priv->cmd_lock, flags);
165 qla2xxx_rel_qpair_sp(sp->qpair, sp);
168 static void qla_nvme_release_ls_cmd_kref(struct kref *kref)
170 struct srb *sp = container_of(kref, struct srb, cmd_kref);
171 struct nvme_private *priv = (struct nvme_private *)sp->priv;
172 struct nvmefc_ls_req *fd;
178 spin_lock_irqsave(&priv->cmd_lock, flags);
181 spin_unlock_irqrestore(&priv->cmd_lock, flags);
185 fd->done(fd, priv->comp_status);
190 static void qla_nvme_ls_complete(struct work_struct *work)
192 struct nvme_private *priv =
193 container_of(work, struct nvme_private, ls_work);
195 kref_put(&priv->sp->cmd_kref, qla_nvme_release_ls_cmd_kref);
198 static void qla_nvme_sp_ls_done(srb_t *sp, int res)
200 struct nvme_private *priv = sp->priv;
202 if (WARN_ON_ONCE(kref_read(&sp->cmd_kref) == 0))
208 priv->comp_status = res;
209 INIT_WORK(&priv->ls_work, qla_nvme_ls_complete);
210 schedule_work(&priv->ls_work);
213 /* it assumed that QPair lock is held. */
214 static void qla_nvme_sp_done(srb_t *sp, int res)
216 struct nvme_private *priv = sp->priv;
218 priv->comp_status = res;
219 kref_put(&sp->cmd_kref, qla_nvme_release_fcp_cmd_kref);
224 static void qla_nvme_abort_work(struct work_struct *work)
226 struct nvme_private *priv =
227 container_of(work, struct nvme_private, abort_work);
228 srb_t *sp = priv->sp;
229 fc_port_t *fcport = sp->fcport;
230 struct qla_hw_data *ha = fcport->vha->hw;
233 ql_dbg(ql_dbg_io, fcport->vha, 0xffff,
234 "%s called for sp=%p, hndl=%x on fcport=%p deleted=%d\n",
235 __func__, sp, sp->handle, fcport, fcport->deleted);
237 if (!ha->flags.fw_started && fcport->deleted)
240 if (ha->flags.host_shutting_down) {
241 ql_log(ql_log_info, sp->fcport->vha, 0xffff,
242 "%s Calling done on sp: %p, type: 0x%x\n",
243 __func__, sp, sp->type);
248 rval = ha->isp_ops->abort_command(sp);
250 ql_dbg(ql_dbg_io, fcport->vha, 0x212b,
251 "%s: %s command for sp=%p, handle=%x on fcport=%p rval=%x\n",
252 __func__, (rval != QLA_SUCCESS) ? "Failed to abort" : "Aborted",
253 sp, sp->handle, fcport, rval);
256 /* kref_get was done before work was schedule. */
257 kref_put(&sp->cmd_kref, sp->put_fn);
260 static void qla_nvme_ls_abort(struct nvme_fc_local_port *lport,
261 struct nvme_fc_remote_port *rport, struct nvmefc_ls_req *fd)
263 struct nvme_private *priv = fd->private;
266 spin_lock_irqsave(&priv->cmd_lock, flags);
268 spin_unlock_irqrestore(&priv->cmd_lock, flags);
272 if (!kref_get_unless_zero(&priv->sp->cmd_kref)) {
273 spin_unlock_irqrestore(&priv->cmd_lock, flags);
276 spin_unlock_irqrestore(&priv->cmd_lock, flags);
278 INIT_WORK(&priv->abort_work, qla_nvme_abort_work);
279 schedule_work(&priv->abort_work);
282 static int qla_nvme_ls_req(struct nvme_fc_local_port *lport,
283 struct nvme_fc_remote_port *rport, struct nvmefc_ls_req *fd)
285 struct qla_nvme_rport *qla_rport = rport->private;
286 fc_port_t *fcport = qla_rport->fcport;
287 struct srb_iocb *nvme;
288 struct nvme_private *priv = fd->private;
289 struct scsi_qla_host *vha;
290 int rval = QLA_FUNCTION_FAILED;
291 struct qla_hw_data *ha;
295 if (!fcport || (fcport && fcport->deleted))
301 if (!ha->flags.fw_started)
304 /* Alloc SRB structure */
305 sp = qla2x00_get_sp(vha, fcport, GFP_ATOMIC);
309 sp->type = SRB_NVME_LS;
310 sp->name = "nvme_ls";
311 sp->done = qla_nvme_sp_ls_done;
312 sp->put_fn = qla_nvme_release_ls_cmd_kref;
315 kref_init(&sp->cmd_kref);
316 spin_lock_init(&priv->cmd_lock);
317 nvme = &sp->u.iocb_cmd;
319 nvme->u.nvme.desc = fd;
320 nvme->u.nvme.dir = 0;
322 nvme->u.nvme.cmd_len = fd->rqstlen;
323 nvme->u.nvme.rsp_len = fd->rsplen;
324 nvme->u.nvme.rsp_dma = fd->rspdma;
325 nvme->u.nvme.timeout_sec = fd->timeout;
326 nvme->u.nvme.cmd_dma = fd->rqstdma;
327 dma_sync_single_for_device(&ha->pdev->dev, nvme->u.nvme.cmd_dma,
328 fd->rqstlen, DMA_TO_DEVICE);
330 rval = qla2x00_start_sp(sp);
331 if (rval != QLA_SUCCESS) {
332 ql_log(ql_log_warn, vha, 0x700e,
333 "qla2x00_start_sp failed = %d\n", rval);
343 static void qla_nvme_fcp_abort(struct nvme_fc_local_port *lport,
344 struct nvme_fc_remote_port *rport, void *hw_queue_handle,
345 struct nvmefc_fcp_req *fd)
347 struct nvme_private *priv = fd->private;
350 spin_lock_irqsave(&priv->cmd_lock, flags);
352 spin_unlock_irqrestore(&priv->cmd_lock, flags);
355 if (!kref_get_unless_zero(&priv->sp->cmd_kref)) {
356 spin_unlock_irqrestore(&priv->cmd_lock, flags);
359 spin_unlock_irqrestore(&priv->cmd_lock, flags);
361 INIT_WORK(&priv->abort_work, qla_nvme_abort_work);
362 schedule_work(&priv->abort_work);
365 static inline int qla2x00_start_nvme_mq(srb_t *sp)
370 struct cmd_nvme *cmd_pkt;
375 struct dsd64 *cur_dsd;
376 struct req_que *req = NULL;
377 struct scsi_qla_host *vha = sp->fcport->vha;
378 struct qla_hw_data *ha = vha->hw;
379 struct qla_qpair *qpair = sp->qpair;
380 struct srb_iocb *nvme = &sp->u.iocb_cmd;
381 struct scatterlist *sgl, *sg;
382 struct nvmefc_fcp_req *fd = nvme->u.nvme.desc;
383 struct nvme_fc_cmd_iu *cmd = fd->cmdaddr;
384 uint32_t rval = QLA_SUCCESS;
386 /* Setup qpair pointers */
388 tot_dsds = fd->sg_cnt;
390 /* Acquire qpair specific lock */
391 spin_lock_irqsave(&qpair->qp_lock, flags);
393 handle = qla2xxx_get_next_handle(req);
398 req_cnt = qla24xx_calc_iocbs(vha, tot_dsds);
399 if (req->cnt < (req_cnt + 2)) {
400 if (IS_SHADOW_REG_CAPABLE(ha)) {
403 cnt = rd_reg_dword_relaxed(req->req_q_out);
404 if (qla2x00_check_reg16_for_disconnect(vha, cnt))
408 if (req->ring_index < cnt)
409 req->cnt = cnt - req->ring_index;
411 req->cnt = req->length - (req->ring_index - cnt);
413 if (req->cnt < (req_cnt + 2)){
419 if (unlikely(!fd->sqid)) {
420 if (cmd->sqe.common.opcode == nvme_admin_async_event) {
421 nvme->u.nvme.aen_op = 1;
422 atomic_inc(&ha->nvme_active_aen_cnt);
426 /* Build command packet. */
427 req->current_outstanding_cmd = handle;
428 req->outstanding_cmds[handle] = sp;
432 cmd_pkt = (struct cmd_nvme *)req->ring_ptr;
433 cmd_pkt->handle = make_handle(req->id, handle);
435 /* Zero out remaining portion of packet. */
436 clr_ptr = (uint32_t *)cmd_pkt + 2;
437 memset(clr_ptr, 0, REQUEST_ENTRY_SIZE - 8);
439 cmd_pkt->entry_status = 0;
441 /* Update entry type to indicate Command NVME IOCB */
442 cmd_pkt->entry_type = COMMAND_NVME;
444 /* No data transfer how do we check buffer len == 0?? */
445 if (fd->io_dir == NVMEFC_FCP_READ) {
446 cmd_pkt->control_flags = cpu_to_le16(CF_READ_DATA);
447 qpair->counters.input_bytes += fd->payload_length;
448 qpair->counters.input_requests++;
449 } else if (fd->io_dir == NVMEFC_FCP_WRITE) {
450 cmd_pkt->control_flags = cpu_to_le16(CF_WRITE_DATA);
451 if ((vha->flags.nvme_first_burst) &&
452 (sp->fcport->nvme_prli_service_param &
453 NVME_PRLI_SP_FIRST_BURST)) {
454 if ((fd->payload_length <=
455 sp->fcport->nvme_first_burst_size) ||
456 (sp->fcport->nvme_first_burst_size == 0))
457 cmd_pkt->control_flags |=
458 cpu_to_le16(CF_NVME_FIRST_BURST_ENABLE);
460 qpair->counters.output_bytes += fd->payload_length;
461 qpair->counters.output_requests++;
462 } else if (fd->io_dir == 0) {
463 cmd_pkt->control_flags = 0;
465 /* Set BIT_13 of control flags for Async event */
466 if (vha->flags.nvme2_enabled &&
467 cmd->sqe.common.opcode == nvme_admin_async_event) {
468 cmd_pkt->control_flags |= cpu_to_le16(CF_ADMIN_ASYNC_EVENT);
472 cmd_pkt->nport_handle = cpu_to_le16(sp->fcport->loop_id);
473 cmd_pkt->port_id[0] = sp->fcport->d_id.b.al_pa;
474 cmd_pkt->port_id[1] = sp->fcport->d_id.b.area;
475 cmd_pkt->port_id[2] = sp->fcport->d_id.b.domain;
476 cmd_pkt->vp_index = sp->fcport->vha->vp_idx;
479 cmd_pkt->nvme_rsp_dsd_len = cpu_to_le16(fd->rsplen);
480 put_unaligned_le64(fd->rspdma, &cmd_pkt->nvme_rsp_dseg_address);
483 cmd_pkt->nvme_cmnd_dseg_len = cpu_to_le16(fd->cmdlen);
484 cmd_pkt->nvme_cmnd_dseg_address = cpu_to_le64(fd->cmddma);
486 cmd_pkt->dseg_count = cpu_to_le16(tot_dsds);
487 cmd_pkt->byte_count = cpu_to_le32(fd->payload_length);
489 /* One DSD is available in the Command Type NVME IOCB */
491 cur_dsd = &cmd_pkt->nvme_dsd;
494 /* Load data segments */
495 for_each_sg(sgl, sg, tot_dsds, i) {
496 cont_a64_entry_t *cont_pkt;
498 /* Allocate additional continuation packets? */
499 if (avail_dsds == 0) {
501 * Five DSDs are available in the Continuation
505 /* Adjust ring index */
507 if (req->ring_index == req->length) {
509 req->ring_ptr = req->ring;
513 cont_pkt = (cont_a64_entry_t *)req->ring_ptr;
514 put_unaligned_le32(CONTINUE_A64_TYPE,
515 &cont_pkt->entry_type);
517 cur_dsd = cont_pkt->dsd;
518 avail_dsds = ARRAY_SIZE(cont_pkt->dsd);
521 append_dsd64(&cur_dsd, sg);
525 /* Set total entry count. */
526 cmd_pkt->entry_count = (uint8_t)req_cnt;
529 /* Adjust ring index. */
531 if (req->ring_index == req->length) {
533 req->ring_ptr = req->ring;
538 /* Set chip new ring index. */
539 wrt_reg_dword(req->req_q_in, req->ring_index);
542 spin_unlock_irqrestore(&qpair->qp_lock, flags);
548 static int qla_nvme_post_cmd(struct nvme_fc_local_port *lport,
549 struct nvme_fc_remote_port *rport, void *hw_queue_handle,
550 struct nvmefc_fcp_req *fd)
553 struct srb_iocb *nvme;
554 struct scsi_qla_host *vha;
557 struct qla_qpair *qpair = hw_queue_handle;
558 struct nvme_private *priv = fd->private;
559 struct qla_nvme_rport *qla_rport = rport->private;
562 /* nvme association has been torn down */
566 fcport = qla_rport->fcport;
568 if (!qpair || !fcport)
571 if (!qpair->fw_started || fcport->deleted)
576 if (!(fcport->nvme_flag & NVME_FLAG_REGISTERED))
579 if (test_bit(ABORT_ISP_ACTIVE, &vha->dpc_flags) ||
580 (qpair && !qpair->fw_started) || fcport->deleted)
584 * If we know the dev is going away while the transport is still sending
585 * IO's return busy back to stall the IO Q. This happens when the
586 * link goes away and fw hasn't notified us yet, but IO's are being
587 * returned. If the dev comes back quickly we won't exhaust the IO
588 * retry count at the core.
590 if (fcport->nvme_flag & NVME_FLAG_RESETTING)
593 /* Alloc SRB structure */
594 sp = qla2xxx_get_qpair_sp(vha, qpair, fcport, GFP_ATOMIC);
598 kref_init(&sp->cmd_kref);
599 spin_lock_init(&priv->cmd_lock);
602 sp->type = SRB_NVME_CMD;
603 sp->name = "nvme_cmd";
604 sp->done = qla_nvme_sp_done;
605 sp->put_fn = qla_nvme_release_fcp_cmd_kref;
608 nvme = &sp->u.iocb_cmd;
609 nvme->u.nvme.desc = fd;
611 rval = qla2x00_start_nvme_mq(sp);
612 if (rval != QLA_SUCCESS) {
613 ql_dbg(ql_dbg_io + ql_dbg_verbose, vha, 0x212d,
614 "qla2x00_start_nvme_mq failed = %d\n", rval);
617 qla2xxx_rel_qpair_sp(sp->qpair, sp);
623 static void qla_nvme_localport_delete(struct nvme_fc_local_port *lport)
625 struct scsi_qla_host *vha = lport->private;
627 ql_log(ql_log_info, vha, 0x210f,
628 "localport delete of %p completed.\n", vha->nvme_local_port);
629 vha->nvme_local_port = NULL;
630 complete(&vha->nvme_del_done);
633 static void qla_nvme_remoteport_delete(struct nvme_fc_remote_port *rport)
636 struct qla_nvme_rport *qla_rport = rport->private;
638 fcport = qla_rport->fcport;
639 fcport->nvme_remote_port = NULL;
640 fcport->nvme_flag &= ~NVME_FLAG_REGISTERED;
641 fcport->nvme_flag &= ~NVME_FLAG_DELETING;
642 ql_log(ql_log_info, fcport->vha, 0x2110,
643 "remoteport_delete of %p %8phN completed.\n",
644 fcport, fcport->port_name);
645 complete(&fcport->nvme_del_done);
648 static struct nvme_fc_port_template qla_nvme_fc_transport = {
649 .localport_delete = qla_nvme_localport_delete,
650 .remoteport_delete = qla_nvme_remoteport_delete,
651 .create_queue = qla_nvme_alloc_queue,
652 .delete_queue = NULL,
653 .ls_req = qla_nvme_ls_req,
654 .ls_abort = qla_nvme_ls_abort,
655 .fcp_io = qla_nvme_post_cmd,
656 .fcp_abort = qla_nvme_fcp_abort,
658 .max_sgl_segments = 1024,
659 .max_dif_sgl_segments = 64,
660 .dma_boundary = 0xFFFFFFFF,
662 .remote_priv_sz = sizeof(struct qla_nvme_rport),
663 .lsrqst_priv_sz = sizeof(struct nvme_private),
664 .fcprqst_priv_sz = sizeof(struct nvme_private),
667 void qla_nvme_unregister_remote_port(struct fc_port *fcport)
671 if (!IS_ENABLED(CONFIG_NVME_FC))
674 ql_log(ql_log_warn, NULL, 0x2112,
675 "%s: unregister remoteport on %p %8phN\n",
676 __func__, fcport, fcport->port_name);
678 if (test_bit(PFLG_DRIVER_REMOVING, &fcport->vha->pci_flags))
679 nvme_fc_set_remoteport_devloss(fcport->nvme_remote_port, 0);
681 init_completion(&fcport->nvme_del_done);
682 ret = nvme_fc_unregister_remoteport(fcport->nvme_remote_port);
684 ql_log(ql_log_info, fcport->vha, 0x2114,
685 "%s: Failed to unregister nvme_remote_port (%d)\n",
687 wait_for_completion(&fcport->nvme_del_done);
690 void qla_nvme_delete(struct scsi_qla_host *vha)
694 if (!IS_ENABLED(CONFIG_NVME_FC))
697 if (vha->nvme_local_port) {
698 init_completion(&vha->nvme_del_done);
699 ql_log(ql_log_info, vha, 0x2116,
700 "unregister localport=%p\n",
701 vha->nvme_local_port);
702 nv_ret = nvme_fc_unregister_localport(vha->nvme_local_port);
704 ql_log(ql_log_info, vha, 0x2115,
705 "Unregister of localport failed\n");
707 wait_for_completion(&vha->nvme_del_done);
711 int qla_nvme_register_hba(struct scsi_qla_host *vha)
713 struct nvme_fc_port_template *tmpl;
714 struct qla_hw_data *ha;
715 struct nvme_fc_port_info pinfo;
718 if (!IS_ENABLED(CONFIG_NVME_FC))
722 tmpl = &qla_nvme_fc_transport;
724 WARN_ON(vha->nvme_local_port);
726 qla_nvme_fc_transport.max_hw_queues =
727 min((uint8_t)(qla_nvme_fc_transport.max_hw_queues),
728 (uint8_t)(ha->max_qpairs ? ha->max_qpairs : 1));
730 pinfo.node_name = wwn_to_u64(vha->node_name);
731 pinfo.port_name = wwn_to_u64(vha->port_name);
732 pinfo.port_role = FC_PORT_ROLE_NVME_INITIATOR;
733 pinfo.port_id = vha->d_id.b24;
735 ql_log(ql_log_info, vha, 0xffff,
736 "register_localport: host-traddr=nn-0x%llx:pn-0x%llx on portID:%x\n",
737 pinfo.node_name, pinfo.port_name, pinfo.port_id);
738 qla_nvme_fc_transport.dma_boundary = vha->host->dma_boundary;
740 ret = nvme_fc_register_localport(&pinfo, tmpl,
741 get_device(&ha->pdev->dev), &vha->nvme_local_port);
743 ql_log(ql_log_warn, vha, 0xffff,
744 "register_localport failed: ret=%x\n", ret);
746 vha->nvme_local_port->private = vha;