2 * QLogic Fibre Channel HBA Driver
3 * Copyright (c) 2003-2017 QLogic Corporation
5 * See LICENSE.qla2xxx for copyright and licensing details.
8 #include <linux/scatterlist.h>
9 #include <linux/delay.h>
10 #include <linux/nvme.h>
11 #include <linux/nvme-fc.h>
13 static struct nvme_fc_port_template qla_nvme_fc_transport;
15 int qla_nvme_register_remote(struct scsi_qla_host *vha, struct fc_port *fcport)
17 struct qla_nvme_rport *rport;
18 struct nvme_fc_port_info req;
21 if (!IS_ENABLED(CONFIG_NVME_FC))
24 if (!vha->flags.nvme_enabled) {
25 ql_log(ql_log_info, vha, 0x2100,
26 "%s: Not registering target since Host NVME is not enabled\n",
31 if (!vha->nvme_local_port && qla_nvme_register_hba(vha))
34 if (!(fcport->nvme_prli_service_param &
35 (NVME_PRLI_SP_TARGET | NVME_PRLI_SP_DISCOVERY)) ||
36 (fcport->nvme_flag & NVME_FLAG_REGISTERED))
39 fcport->nvme_flag &= ~NVME_FLAG_RESETTING;
41 memset(&req, 0, sizeof(struct nvme_fc_port_info));
42 req.port_name = wwn_to_u64(fcport->port_name);
43 req.node_name = wwn_to_u64(fcport->node_name);
45 req.dev_loss_tmo = NVME_FC_DEV_LOSS_TMO;
47 if (fcport->nvme_prli_service_param & NVME_PRLI_SP_INITIATOR)
48 req.port_role = FC_PORT_ROLE_NVME_INITIATOR;
50 if (fcport->nvme_prli_service_param & NVME_PRLI_SP_TARGET)
51 req.port_role |= FC_PORT_ROLE_NVME_TARGET;
53 if (fcport->nvme_prli_service_param & NVME_PRLI_SP_DISCOVERY)
54 req.port_role |= FC_PORT_ROLE_NVME_DISCOVERY;
56 req.port_id = fcport->d_id.b24;
58 ql_log(ql_log_info, vha, 0x2102,
59 "%s: traddr=nn-0x%016llx:pn-0x%016llx PortID:%06x\n",
60 __func__, req.node_name, req.port_name,
63 ret = nvme_fc_register_remoteport(vha->nvme_local_port, &req,
64 &fcport->nvme_remote_port);
66 ql_log(ql_log_warn, vha, 0x212e,
67 "Failed to register remote port. Transport returned %d\n",
72 rport = fcport->nvme_remote_port->private;
73 rport->fcport = fcport;
75 fcport->nvme_flag |= NVME_FLAG_REGISTERED;
79 /* Allocate a queue for NVMe traffic */
80 static int qla_nvme_alloc_queue(struct nvme_fc_local_port *lport,
81 unsigned int qidx, u16 qsize, void **handle)
83 struct scsi_qla_host *vha;
84 struct qla_hw_data *ha;
85 struct qla_qpair *qpair;
90 vha = (struct scsi_qla_host *)lport->private;
93 ql_log(ql_log_info, vha, 0x2104,
94 "%s: handle %p, idx =%d, qsize %d\n",
95 __func__, handle, qidx, qsize);
97 if (qidx > qla_nvme_fc_transport.max_hw_queues) {
98 ql_log(ql_log_warn, vha, 0x212f,
99 "%s: Illegal qidx=%d. Max=%d\n",
100 __func__, qidx, qla_nvme_fc_transport.max_hw_queues);
104 if (ha->queue_pair_map[qidx]) {
105 *handle = ha->queue_pair_map[qidx];
106 ql_log(ql_log_info, vha, 0x2121,
107 "Returning existing qpair of %p for idx=%x\n",
112 qpair = qla2xxx_create_qpair(vha, 5, vha->vp_idx, true);
114 ql_log(ql_log_warn, vha, 0x2122,
115 "Failed to allocate qpair\n");
123 static void qla_nvme_release_fcp_cmd_kref(struct kref *kref)
125 struct srb *sp = container_of(kref, struct srb, cmd_kref);
126 struct nvme_private *priv = (struct nvme_private *)sp->priv;
127 struct nvmefc_fcp_req *fd;
128 struct srb_iocb *nvme;
134 nvme = &sp->u.iocb_cmd;
135 fd = nvme->u.nvme.desc;
137 spin_lock_irqsave(&priv->cmd_lock, flags);
140 if (priv->comp_status == QLA_SUCCESS) {
141 fd->rcv_rsplen = nvme->u.nvme.rsp_pyld_len;
144 fd->transferred_length = 0;
147 spin_unlock_irqrestore(&priv->cmd_lock, flags);
151 qla2xxx_rel_qpair_sp(sp->qpair, sp);
154 static void qla_nvme_release_ls_cmd_kref(struct kref *kref)
156 struct srb *sp = container_of(kref, struct srb, cmd_kref);
157 struct nvme_private *priv = (struct nvme_private *)sp->priv;
158 struct nvmefc_ls_req *fd;
164 spin_lock_irqsave(&priv->cmd_lock, flags);
167 spin_unlock_irqrestore(&priv->cmd_lock, flags);
170 fd->done(fd, priv->comp_status);
175 static void qla_nvme_ls_complete(struct work_struct *work)
177 struct nvme_private *priv =
178 container_of(work, struct nvme_private, ls_work);
180 kref_put(&priv->sp->cmd_kref, qla_nvme_release_ls_cmd_kref);
183 static void qla_nvme_sp_ls_done(srb_t *sp, int res)
185 struct nvme_private *priv = sp->priv;
187 if (WARN_ON_ONCE(kref_read(&sp->cmd_kref) == 0))
193 priv->comp_status = res;
194 INIT_WORK(&priv->ls_work, qla_nvme_ls_complete);
195 schedule_work(&priv->ls_work);
198 /* it assumed that QPair lock is held. */
199 static void qla_nvme_sp_done(srb_t *sp, int res)
201 struct nvme_private *priv = sp->priv;
203 priv->comp_status = res;
204 kref_put(&sp->cmd_kref, qla_nvme_release_fcp_cmd_kref);
209 static void qla_nvme_abort_work(struct work_struct *work)
211 struct nvme_private *priv =
212 container_of(work, struct nvme_private, abort_work);
213 srb_t *sp = priv->sp;
214 fc_port_t *fcport = sp->fcport;
215 struct qla_hw_data *ha = fcport->vha->hw;
218 ql_dbg(ql_dbg_io, fcport->vha, 0xffff,
219 "%s called for sp=%p, hndl=%x on fcport=%p deleted=%d\n",
220 __func__, sp, sp->handle, fcport, fcport->deleted);
222 if (!ha->flags.fw_started && fcport->deleted)
225 if (ha->flags.host_shutting_down) {
226 ql_log(ql_log_info, sp->fcport->vha, 0xffff,
227 "%s Calling done on sp: %p, type: 0x%x, sp->ref_count: 0x%x\n",
228 __func__, sp, sp->type, atomic_read(&sp->ref_count));
233 rval = ha->isp_ops->abort_command(sp);
235 ql_dbg(ql_dbg_io, fcport->vha, 0x212b,
236 "%s: %s command for sp=%p, handle=%x on fcport=%p rval=%x\n",
237 __func__, (rval != QLA_SUCCESS) ? "Failed to abort" : "Aborted",
238 sp, sp->handle, fcport, rval);
241 /* kref_get was done before work was schedule. */
242 kref_put(&sp->cmd_kref, sp->put_fn);
245 static void qla_nvme_ls_abort(struct nvme_fc_local_port *lport,
246 struct nvme_fc_remote_port *rport, struct nvmefc_ls_req *fd)
248 struct nvme_private *priv = fd->private;
251 spin_lock_irqsave(&priv->cmd_lock, flags);
253 spin_unlock_irqrestore(&priv->cmd_lock, flags);
257 if (!kref_get_unless_zero(&priv->sp->cmd_kref)) {
258 spin_unlock_irqrestore(&priv->cmd_lock, flags);
261 spin_unlock_irqrestore(&priv->cmd_lock, flags);
263 INIT_WORK(&priv->abort_work, qla_nvme_abort_work);
264 schedule_work(&priv->abort_work);
267 static int qla_nvme_ls_req(struct nvme_fc_local_port *lport,
268 struct nvme_fc_remote_port *rport, struct nvmefc_ls_req *fd)
270 struct qla_nvme_rport *qla_rport = rport->private;
271 fc_port_t *fcport = qla_rport->fcport;
272 struct srb_iocb *nvme;
273 struct nvme_private *priv = fd->private;
274 struct scsi_qla_host *vha;
275 int rval = QLA_FUNCTION_FAILED;
276 struct qla_hw_data *ha;
280 if (!fcport || (fcport && fcport->deleted))
286 if (!ha->flags.fw_started)
289 /* Alloc SRB structure */
290 sp = qla2x00_get_sp(vha, fcport, GFP_ATOMIC);
294 sp->type = SRB_NVME_LS;
295 sp->name = "nvme_ls";
296 sp->done = qla_nvme_sp_ls_done;
297 sp->put_fn = qla_nvme_release_ls_cmd_kref;
298 sp->priv = (void *)priv;
300 kref_init(&sp->cmd_kref);
301 spin_lock_init(&priv->cmd_lock);
302 nvme = &sp->u.iocb_cmd;
304 nvme->u.nvme.desc = fd;
305 nvme->u.nvme.dir = 0;
307 nvme->u.nvme.cmd_len = fd->rqstlen;
308 nvme->u.nvme.rsp_len = fd->rsplen;
309 nvme->u.nvme.rsp_dma = fd->rspdma;
310 nvme->u.nvme.timeout_sec = fd->timeout;
311 nvme->u.nvme.cmd_dma = dma_map_single(&ha->pdev->dev, fd->rqstaddr,
312 fd->rqstlen, DMA_TO_DEVICE);
313 dma_sync_single_for_device(&ha->pdev->dev, nvme->u.nvme.cmd_dma,
314 fd->rqstlen, DMA_TO_DEVICE);
316 rval = qla2x00_start_sp(sp);
317 if (rval != QLA_SUCCESS) {
318 ql_log(ql_log_warn, vha, 0x700e,
319 "qla2x00_start_sp failed = %d\n", rval);
320 wake_up(&sp->nvme_ls_waitq);
330 static void qla_nvme_fcp_abort(struct nvme_fc_local_port *lport,
331 struct nvme_fc_remote_port *rport, void *hw_queue_handle,
332 struct nvmefc_fcp_req *fd)
334 struct nvme_private *priv = fd->private;
337 spin_lock_irqsave(&priv->cmd_lock, flags);
339 spin_unlock_irqrestore(&priv->cmd_lock, flags);
342 if (!kref_get_unless_zero(&priv->sp->cmd_kref)) {
343 spin_unlock_irqrestore(&priv->cmd_lock, flags);
346 spin_unlock_irqrestore(&priv->cmd_lock, flags);
348 INIT_WORK(&priv->abort_work, qla_nvme_abort_work);
349 schedule_work(&priv->abort_work);
352 static inline int qla2x00_start_nvme_mq(srb_t *sp)
358 struct cmd_nvme *cmd_pkt;
363 struct dsd64 *cur_dsd;
364 struct req_que *req = NULL;
365 struct scsi_qla_host *vha = sp->fcport->vha;
366 struct qla_hw_data *ha = vha->hw;
367 struct qla_qpair *qpair = sp->qpair;
368 struct srb_iocb *nvme = &sp->u.iocb_cmd;
369 struct scatterlist *sgl, *sg;
370 struct nvmefc_fcp_req *fd = nvme->u.nvme.desc;
371 uint32_t rval = QLA_SUCCESS;
373 /* Setup qpair pointers */
375 tot_dsds = fd->sg_cnt;
377 /* Acquire qpair specific lock */
378 spin_lock_irqsave(&qpair->qp_lock, flags);
380 /* Check for room in outstanding command list. */
381 handle = req->current_outstanding_cmd;
382 for (index = 1; index < req->num_outstanding_cmds; index++) {
384 if (handle == req->num_outstanding_cmds)
386 if (!req->outstanding_cmds[handle])
390 if (index == req->num_outstanding_cmds) {
394 req_cnt = qla24xx_calc_iocbs(vha, tot_dsds);
395 if (req->cnt < (req_cnt + 2)) {
396 cnt = IS_SHADOW_REG_CAPABLE(ha) ? *req->out_ptr :
397 RD_REG_DWORD_RELAXED(req->req_q_out);
399 if (req->ring_index < cnt)
400 req->cnt = cnt - req->ring_index;
402 req->cnt = req->length - (req->ring_index - cnt);
404 if (req->cnt < (req_cnt + 2)){
410 if (unlikely(!fd->sqid)) {
411 struct nvme_fc_cmd_iu *cmd = fd->cmdaddr;
413 if (cmd->sqe.common.opcode == nvme_admin_async_event) {
414 nvme->u.nvme.aen_op = 1;
415 atomic_inc(&ha->nvme_active_aen_cnt);
419 /* Build command packet. */
420 req->current_outstanding_cmd = handle;
421 req->outstanding_cmds[handle] = sp;
425 cmd_pkt = (struct cmd_nvme *)req->ring_ptr;
426 cmd_pkt->handle = MAKE_HANDLE(req->id, handle);
428 /* Zero out remaining portion of packet. */
429 clr_ptr = (uint32_t *)cmd_pkt + 2;
430 memset(clr_ptr, 0, REQUEST_ENTRY_SIZE - 8);
432 cmd_pkt->entry_status = 0;
434 /* Update entry type to indicate Command NVME IOCB */
435 cmd_pkt->entry_type = COMMAND_NVME;
437 /* No data transfer how do we check buffer len == 0?? */
438 if (fd->io_dir == NVMEFC_FCP_READ) {
439 cmd_pkt->control_flags = CF_READ_DATA;
440 vha->qla_stats.input_bytes += fd->payload_length;
441 vha->qla_stats.input_requests++;
442 } else if (fd->io_dir == NVMEFC_FCP_WRITE) {
443 cmd_pkt->control_flags = CF_WRITE_DATA;
444 if ((vha->flags.nvme_first_burst) &&
445 (sp->fcport->nvme_prli_service_param &
446 NVME_PRLI_SP_FIRST_BURST)) {
447 if ((fd->payload_length <=
448 sp->fcport->nvme_first_burst_size) ||
449 (sp->fcport->nvme_first_burst_size == 0))
450 cmd_pkt->control_flags |=
451 CF_NVME_FIRST_BURST_ENABLE;
453 vha->qla_stats.output_bytes += fd->payload_length;
454 vha->qla_stats.output_requests++;
455 } else if (fd->io_dir == 0) {
456 cmd_pkt->control_flags = 0;
460 cmd_pkt->nport_handle = cpu_to_le16(sp->fcport->loop_id);
461 cmd_pkt->port_id[0] = sp->fcport->d_id.b.al_pa;
462 cmd_pkt->port_id[1] = sp->fcport->d_id.b.area;
463 cmd_pkt->port_id[2] = sp->fcport->d_id.b.domain;
464 cmd_pkt->vp_index = sp->fcport->vha->vp_idx;
467 cmd_pkt->nvme_rsp_dsd_len = cpu_to_le16(fd->rsplen);
468 put_unaligned_le64(fd->rspdma, &cmd_pkt->nvme_rsp_dseg_address);
471 cmd_pkt->nvme_cmnd_dseg_len = cpu_to_le16(fd->cmdlen);
472 cmd_pkt->nvme_cmnd_dseg_address = cpu_to_le64(fd->cmddma);
474 cmd_pkt->dseg_count = cpu_to_le16(tot_dsds);
475 cmd_pkt->byte_count = cpu_to_le32(fd->payload_length);
477 /* One DSD is available in the Command Type NVME IOCB */
479 cur_dsd = &cmd_pkt->nvme_dsd;
482 /* Load data segments */
483 for_each_sg(sgl, sg, tot_dsds, i) {
484 cont_a64_entry_t *cont_pkt;
486 /* Allocate additional continuation packets? */
487 if (avail_dsds == 0) {
489 * Five DSDs are available in the Continuation
493 /* Adjust ring index */
495 if (req->ring_index == req->length) {
497 req->ring_ptr = req->ring;
501 cont_pkt = (cont_a64_entry_t *)req->ring_ptr;
502 put_unaligned_le32(CONTINUE_A64_TYPE,
503 &cont_pkt->entry_type);
505 cur_dsd = cont_pkt->dsd;
506 avail_dsds = ARRAY_SIZE(cont_pkt->dsd);
509 append_dsd64(&cur_dsd, sg);
513 /* Set total entry count. */
514 cmd_pkt->entry_count = (uint8_t)req_cnt;
517 /* Adjust ring index. */
519 if (req->ring_index == req->length) {
521 req->ring_ptr = req->ring;
526 /* Set chip new ring index. */
527 WRT_REG_DWORD(req->req_q_in, req->ring_index);
530 spin_unlock_irqrestore(&qpair->qp_lock, flags);
535 static int qla_nvme_post_cmd(struct nvme_fc_local_port *lport,
536 struct nvme_fc_remote_port *rport, void *hw_queue_handle,
537 struct nvmefc_fcp_req *fd)
540 struct srb_iocb *nvme;
541 struct scsi_qla_host *vha;
544 struct qla_qpair *qpair = hw_queue_handle;
545 struct nvme_private *priv = fd->private;
546 struct qla_nvme_rport *qla_rport = rport->private;
548 fcport = qla_rport->fcport;
550 if (!qpair || !fcport || (qpair && !qpair->fw_started) ||
551 (fcport && fcport->deleted))
556 * If we know the dev is going away while the transport is still sending
557 * IO's return busy back to stall the IO Q. This happens when the
558 * link goes away and fw hasn't notified us yet, but IO's are being
559 * returned. If the dev comes back quickly we won't exhaust the IO
560 * retry count at the core.
562 if (fcport->nvme_flag & NVME_FLAG_RESETTING)
565 /* Alloc SRB structure */
566 sp = qla2xxx_get_qpair_sp(vha, qpair, fcport, GFP_ATOMIC);
570 init_waitqueue_head(&sp->nvme_ls_waitq);
571 kref_init(&sp->cmd_kref);
572 spin_lock_init(&priv->cmd_lock);
573 sp->priv = (void *)priv;
575 sp->type = SRB_NVME_CMD;
576 sp->name = "nvme_cmd";
577 sp->done = qla_nvme_sp_done;
578 sp->put_fn = qla_nvme_release_fcp_cmd_kref;
581 nvme = &sp->u.iocb_cmd;
582 nvme->u.nvme.desc = fd;
584 rval = qla2x00_start_nvme_mq(sp);
585 if (rval != QLA_SUCCESS) {
586 ql_log(ql_log_warn, vha, 0x212d,
587 "qla2x00_start_nvme_mq failed = %d\n", rval);
588 wake_up(&sp->nvme_ls_waitq);
591 qla2xxx_rel_qpair_sp(sp->qpair, sp);
597 static void qla_nvme_localport_delete(struct nvme_fc_local_port *lport)
599 struct scsi_qla_host *vha = lport->private;
601 ql_log(ql_log_info, vha, 0x210f,
602 "localport delete of %p completed.\n", vha->nvme_local_port);
603 vha->nvme_local_port = NULL;
604 complete(&vha->nvme_del_done);
607 static void qla_nvme_remoteport_delete(struct nvme_fc_remote_port *rport)
610 struct qla_nvme_rport *qla_rport = rport->private;
612 fcport = qla_rport->fcport;
613 fcport->nvme_remote_port = NULL;
614 fcport->nvme_flag &= ~NVME_FLAG_REGISTERED;
615 fcport->nvme_flag &= ~NVME_FLAG_DELETING;
616 ql_log(ql_log_info, fcport->vha, 0x2110,
617 "remoteport_delete of %p %8phN completed.\n",
618 fcport, fcport->port_name);
619 complete(&fcport->nvme_del_done);
622 static struct nvme_fc_port_template qla_nvme_fc_transport = {
623 .localport_delete = qla_nvme_localport_delete,
624 .remoteport_delete = qla_nvme_remoteport_delete,
625 .create_queue = qla_nvme_alloc_queue,
626 .delete_queue = NULL,
627 .ls_req = qla_nvme_ls_req,
628 .ls_abort = qla_nvme_ls_abort,
629 .fcp_io = qla_nvme_post_cmd,
630 .fcp_abort = qla_nvme_fcp_abort,
632 .max_sgl_segments = 1024,
633 .max_dif_sgl_segments = 64,
634 .dma_boundary = 0xFFFFFFFF,
636 .remote_priv_sz = sizeof(struct qla_nvme_rport),
637 .lsrqst_priv_sz = sizeof(struct nvme_private),
638 .fcprqst_priv_sz = sizeof(struct nvme_private),
641 void qla_nvme_unregister_remote_port(struct fc_port *fcport)
645 if (!IS_ENABLED(CONFIG_NVME_FC))
648 ql_log(ql_log_warn, NULL, 0x2112,
649 "%s: unregister remoteport on %p %8phN\n",
650 __func__, fcport, fcport->port_name);
652 if (test_bit(PFLG_DRIVER_REMOVING, &fcport->vha->pci_flags))
653 nvme_fc_set_remoteport_devloss(fcport->nvme_remote_port, 0);
655 init_completion(&fcport->nvme_del_done);
656 ret = nvme_fc_unregister_remoteport(fcport->nvme_remote_port);
658 ql_log(ql_log_info, fcport->vha, 0x2114,
659 "%s: Failed to unregister nvme_remote_port (%d)\n",
661 wait_for_completion(&fcport->nvme_del_done);
664 void qla_nvme_delete(struct scsi_qla_host *vha)
668 if (!IS_ENABLED(CONFIG_NVME_FC))
671 if (vha->nvme_local_port) {
672 init_completion(&vha->nvme_del_done);
673 ql_log(ql_log_info, vha, 0x2116,
674 "unregister localport=%p\n",
675 vha->nvme_local_port);
676 nv_ret = nvme_fc_unregister_localport(vha->nvme_local_port);
678 ql_log(ql_log_info, vha, 0x2115,
679 "Unregister of localport failed\n");
681 wait_for_completion(&vha->nvme_del_done);
685 int qla_nvme_register_hba(struct scsi_qla_host *vha)
687 struct nvme_fc_port_template *tmpl;
688 struct qla_hw_data *ha;
689 struct nvme_fc_port_info pinfo;
692 if (!IS_ENABLED(CONFIG_NVME_FC))
696 tmpl = &qla_nvme_fc_transport;
698 WARN_ON(vha->nvme_local_port);
699 WARN_ON(ha->max_req_queues < 3);
701 qla_nvme_fc_transport.max_hw_queues =
702 min((uint8_t)(qla_nvme_fc_transport.max_hw_queues),
703 (uint8_t)(ha->max_req_queues - 2));
705 pinfo.node_name = wwn_to_u64(vha->node_name);
706 pinfo.port_name = wwn_to_u64(vha->port_name);
707 pinfo.port_role = FC_PORT_ROLE_NVME_INITIATOR;
708 pinfo.port_id = vha->d_id.b24;
710 ql_log(ql_log_info, vha, 0xffff,
711 "register_localport: host-traddr=nn-0x%llx:pn-0x%llx on portID:%x\n",
712 pinfo.node_name, pinfo.port_name, pinfo.port_id);
713 qla_nvme_fc_transport.dma_boundary = vha->host->dma_boundary;
715 ret = nvme_fc_register_localport(&pinfo, tmpl,
716 get_device(&ha->pdev->dev), &vha->nvme_local_port);
718 ql_log(ql_log_warn, vha, 0xffff,
719 "register_localport failed: ret=%x\n", ret);
721 vha->nvme_local_port->private = vha;