2 * CXL Flash Device Driver
4 * Written by: Manoj N. Kumar <manoj@linux.vnet.ibm.com>, IBM Corporation
5 * Matthew R. Ochs <mrochs@linux.vnet.ibm.com>, IBM Corporation
7 * Copyright (C) 2015 IBM Corporation
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version
12 * 2 of the License, or (at your option) any later version.
15 #include <linux/delay.h>
16 #include <linux/list.h>
17 #include <linux/module.h>
18 #include <linux/pci.h>
20 #include <asm/unaligned.h>
24 #include <scsi/scsi_cmnd.h>
25 #include <scsi/scsi_host.h>
26 #include <uapi/scsi/cxlflash_ioctl.h>
32 MODULE_DESCRIPTION(CXLFLASH_ADAPTER_NAME);
33 MODULE_AUTHOR("Manoj N. Kumar <manoj@linux.vnet.ibm.com>");
34 MODULE_AUTHOR("Matthew R. Ochs <mrochs@linux.vnet.ibm.com>");
35 MODULE_LICENSE("GPL");
39 * cmd_checkout() - checks out an AFU command
40 * @afu: AFU to checkout from.
42 * Commands are checked out in a round-robin fashion. Note that since
43 * the command pool is larger than the hardware queue, the majority of
44 * times we will only loop once or twice before getting a command. The
45 * buffer and CDB within the command are initialized (zeroed) prior to
48 * Return: The checked out command or NULL when command pool is empty.
50 static struct afu_cmd *cmd_checkout(struct afu *afu)
52 int k, dec = CXLFLASH_NUM_CMDS;
56 k = (afu->cmd_couts++ & (CXLFLASH_NUM_CMDS - 1));
60 if (!atomic_dec_if_positive(&cmd->free)) {
61 pr_devel("%s: returning found index=%d cmd=%p\n",
62 __func__, cmd->slot, cmd);
63 memset(cmd->buf, 0, CMD_BUFSIZE);
64 memset(cmd->rcb.cdb, 0, sizeof(cmd->rcb.cdb));
73 * cmd_checkin() - checks in an AFU command
74 * @cmd: AFU command to checkin.
76 * Safe to pass commands that have already been checked in. Several
77 * internal tracking fields are reset as part of the checkin. Note
78 * that these are intentionally reset prior to toggling the free bit
79 * to avoid clobbering values in the event that the command is checked
82 static void cmd_checkin(struct afu_cmd *cmd)
88 cmd->sa.host_use[0] = 0; /* clears both completion and retry bytes */
90 if (unlikely(atomic_inc_return(&cmd->free) != 1)) {
91 pr_err("%s: Freeing cmd (%d) that is not in use!\n",
96 pr_devel("%s: released cmd %p index=%d\n", __func__, cmd, cmd->slot);
100 * process_cmd_err() - command error handler
101 * @cmd: AFU command that experienced the error.
102 * @scp: SCSI command associated with the AFU command in error.
104 * Translates error bits from AFU command to SCSI command results.
106 static void process_cmd_err(struct afu_cmd *cmd, struct scsi_cmnd *scp)
108 struct sisl_ioarcb *ioarcb;
109 struct sisl_ioasa *ioasa;
115 ioarcb = &(cmd->rcb);
118 if (ioasa->rc.flags & SISL_RC_FLAGS_UNDERRUN) {
119 resid = ioasa->resid;
120 scsi_set_resid(scp, resid);
121 pr_debug("%s: cmd underrun cmd = %p scp = %p, resid = %d\n",
122 __func__, cmd, scp, resid);
125 if (ioasa->rc.flags & SISL_RC_FLAGS_OVERRUN) {
126 pr_debug("%s: cmd underrun cmd = %p scp = %p\n",
128 scp->result = (DID_ERROR << 16);
131 pr_debug("%s: cmd failed afu_rc=%d scsi_rc=%d fc_rc=%d "
132 "afu_extra=0x%X, scsi_extra=0x%X, fc_extra=0x%X\n",
133 __func__, ioasa->rc.afu_rc, ioasa->rc.scsi_rc,
134 ioasa->rc.fc_rc, ioasa->afu_extra, ioasa->scsi_extra,
137 if (ioasa->rc.scsi_rc) {
138 /* We have a SCSI status */
139 if (ioasa->rc.flags & SISL_RC_FLAGS_SENSE_VALID) {
140 memcpy(scp->sense_buffer, ioasa->sense_data,
141 SISL_SENSE_DATA_LEN);
142 scp->result = ioasa->rc.scsi_rc;
144 scp->result = ioasa->rc.scsi_rc | (DID_ERROR << 16);
148 * We encountered an error. Set scp->result based on nature
151 if (ioasa->rc.fc_rc) {
152 /* We have an FC status */
153 switch (ioasa->rc.fc_rc) {
154 case SISL_FC_RC_LINKDOWN:
155 scp->result = (DID_REQUEUE << 16);
157 case SISL_FC_RC_RESID:
158 /* This indicates an FCP resid underrun */
159 if (!(ioasa->rc.flags & SISL_RC_FLAGS_OVERRUN)) {
160 /* If the SISL_RC_FLAGS_OVERRUN flag was set,
161 * then we will handle this error else where.
162 * If not then we must handle it here.
163 * This is probably an AFU bug.
165 scp->result = (DID_ERROR << 16);
168 case SISL_FC_RC_RESIDERR:
169 /* Resid mismatch between adapter and device */
170 case SISL_FC_RC_TGTABORT:
171 case SISL_FC_RC_ABORTOK:
172 case SISL_FC_RC_ABORTFAIL:
173 case SISL_FC_RC_NOLOGI:
174 case SISL_FC_RC_ABORTPEND:
175 case SISL_FC_RC_WRABORTPEND:
176 case SISL_FC_RC_NOEXP:
177 case SISL_FC_RC_INUSE:
178 scp->result = (DID_ERROR << 16);
183 if (ioasa->rc.afu_rc) {
184 /* We have an AFU error */
185 switch (ioasa->rc.afu_rc) {
186 case SISL_AFU_RC_NO_CHANNELS:
187 scp->result = (DID_NO_CONNECT << 16);
189 case SISL_AFU_RC_DATA_DMA_ERR:
190 switch (ioasa->afu_extra) {
191 case SISL_AFU_DMA_ERR_PAGE_IN:
193 scp->result = (DID_IMM_RETRY << 16);
195 case SISL_AFU_DMA_ERR_INVALID_EA:
197 scp->result = (DID_ERROR << 16);
200 case SISL_AFU_RC_OUT_OF_DATA_BUFS:
202 scp->result = (DID_ALLOC_FAILURE << 16);
205 scp->result = (DID_ERROR << 16);
211 * cmd_complete() - command completion handler
212 * @cmd: AFU command that has completed.
214 * Prepares and submits command that has either completed or timed out to
215 * the SCSI stack. Checks AFU command back into command pool for non-internal
216 * (rcb.scp populated) commands.
218 static void cmd_complete(struct afu_cmd *cmd)
220 struct scsi_cmnd *scp;
222 struct afu *afu = cmd->parent;
223 struct cxlflash_cfg *cfg = afu->parent;
226 spin_lock_irqsave(&cmd->slock, lock_flags);
227 cmd->sa.host_use_b[0] |= B_DONE;
228 spin_unlock_irqrestore(&cmd->slock, lock_flags);
232 if (unlikely(cmd->sa.ioasc))
233 process_cmd_err(cmd, scp);
235 scp->result = (DID_OK << 16);
237 cmd_is_tmf = cmd->cmd_tmf;
238 cmd_checkin(cmd); /* Don't use cmd after here */
240 pr_debug_ratelimited("%s: calling scsi_done scp=%p result=%X "
241 "ioasc=%d\n", __func__, scp, scp->result,
248 spin_lock_irqsave(&cfg->tmf_slock, lock_flags);
249 cfg->tmf_active = false;
250 wake_up_all_locked(&cfg->tmf_waitq);
251 spin_unlock_irqrestore(&cfg->tmf_slock, lock_flags);
254 complete(&cmd->cevent);
258 * context_reset() - timeout handler for AFU commands
259 * @cmd: AFU command that timed out.
261 * Sends a reset to the AFU.
263 static void context_reset(struct afu_cmd *cmd)
268 struct afu *afu = cmd->parent;
271 pr_debug("%s: cmd=%p\n", __func__, cmd);
273 spin_lock_irqsave(&cmd->slock, lock_flags);
275 /* Already completed? */
276 if (cmd->sa.host_use_b[0] & B_DONE) {
277 spin_unlock_irqrestore(&cmd->slock, lock_flags);
281 cmd->sa.host_use_b[0] |= (B_DONE | B_ERROR | B_TIMEOUT);
282 spin_unlock_irqrestore(&cmd->slock, lock_flags);
285 * We really want to send this reset at all costs, so spread
286 * out wait time on successive retries for available room.
289 room = readq_be(&afu->host_map->cmd_room);
290 atomic64_set(&afu->room, room);
294 } while (nretry++ < MC_ROOM_RETRY_CNT);
296 pr_err("%s: no cmd_room to send reset\n", __func__);
301 writeq_be(rrin, &afu->host_map->ioarrin);
303 rrin = readq_be(&afu->host_map->ioarrin);
306 /* Double delay each time */
308 } while (nretry++ < MC_ROOM_RETRY_CNT);
312 * send_cmd() - sends an AFU command
313 * @afu: AFU associated with the host.
314 * @cmd: AFU command to send.
317 * 0 on success or SCSI_MLQUEUE_HOST_BUSY
319 static int send_cmd(struct afu *afu, struct afu_cmd *cmd)
321 struct cxlflash_cfg *cfg = afu->parent;
322 struct device *dev = &cfg->dev->dev;
329 * This routine is used by critical users such an AFU sync and to
330 * send a task management function (TMF). Thus we want to retry a
331 * bit before returning an error. To avoid the performance penalty
332 * of MMIO, we spread the update of 'room' over multiple commands.
335 newval = atomic64_dec_if_positive(&afu->room);
338 room = readq_be(&afu->host_map->cmd_room);
339 atomic64_set(&afu->room, room);
343 } while (nretry++ < MC_ROOM_RETRY_CNT);
345 dev_err(dev, "%s: no cmd_room to send 0x%X\n",
346 __func__, cmd->rcb.cdb[0]);
349 } else if (unlikely(newval < 0)) {
350 /* This should be rare. i.e. Only if two threads race and
351 * decrement before the MMIO read is done. In this case
352 * just benefit from the other thread having updated
355 if (nretry++ < MC_ROOM_RETRY_CNT) {
364 writeq_be((u64)&cmd->rcb, &afu->host_map->ioarrin);
366 pr_devel("%s: cmd=%p len=%d ea=%p rc=%d\n", __func__, cmd,
367 cmd->rcb.data_len, (void *)cmd->rcb.data_ea, rc);
371 afu->read_room = true;
372 schedule_work(&cfg->work_q);
373 rc = SCSI_MLQUEUE_HOST_BUSY;
378 * wait_resp() - polls for a response or timeout to a sent AFU command
379 * @afu: AFU associated with the host.
380 * @cmd: AFU command that was sent.
382 static void wait_resp(struct afu *afu, struct afu_cmd *cmd)
384 ulong timeout = msecs_to_jiffies(cmd->rcb.timeout * 2 * 1000);
386 timeout = wait_for_completion_timeout(&cmd->cevent, timeout);
390 if (unlikely(cmd->sa.ioasc != 0))
391 pr_err("%s: CMD 0x%X failed, IOASC: flags 0x%X, afu_rc 0x%X, "
392 "scsi_rc 0x%X, fc_rc 0x%X\n", __func__, cmd->rcb.cdb[0],
393 cmd->sa.rc.flags, cmd->sa.rc.afu_rc, cmd->sa.rc.scsi_rc,
398 * send_tmf() - sends a Task Management Function (TMF)
399 * @afu: AFU to checkout from.
400 * @scp: SCSI command from stack.
401 * @tmfcmd: TMF command to send.
405 * SCSI_MLQUEUE_HOST_BUSY when host is busy
407 static int send_tmf(struct afu *afu, struct scsi_cmnd *scp, u64 tmfcmd)
411 u32 port_sel = scp->device->channel + 1;
413 struct Scsi_Host *host = scp->device->host;
414 struct cxlflash_cfg *cfg = (struct cxlflash_cfg *)host->hostdata;
415 struct device *dev = &cfg->dev->dev;
420 cmd = cmd_checkout(afu);
421 if (unlikely(!cmd)) {
422 dev_err(dev, "%s: could not get a free command\n", __func__);
423 rc = SCSI_MLQUEUE_HOST_BUSY;
427 /* When Task Management Function is active do not send another */
428 spin_lock_irqsave(&cfg->tmf_slock, lock_flags);
430 wait_event_interruptible_lock_irq(cfg->tmf_waitq,
433 cfg->tmf_active = true;
435 spin_unlock_irqrestore(&cfg->tmf_slock, lock_flags);
437 cmd->rcb.ctx_id = afu->ctx_hndl;
438 cmd->rcb.port_sel = port_sel;
439 cmd->rcb.lun_id = lun_to_lunid(scp->device->lun);
441 lflag = SISL_REQ_FLAGS_TMF_CMD;
443 cmd->rcb.req_flags = (SISL_REQ_FLAGS_PORT_LUN_ID |
444 SISL_REQ_FLAGS_SUP_UNDERRUN | lflag);
446 /* Stash the scp in the reserved field, for reuse during interrupt */
449 /* Copy the CDB from the cmd passed in */
450 memcpy(cmd->rcb.cdb, &tmfcmd, sizeof(tmfcmd));
452 /* Send the command */
453 rc = send_cmd(afu, cmd);
456 spin_lock_irqsave(&cfg->tmf_slock, lock_flags);
457 cfg->tmf_active = false;
458 spin_unlock_irqrestore(&cfg->tmf_slock, lock_flags);
462 spin_lock_irqsave(&cfg->tmf_slock, lock_flags);
463 to = msecs_to_jiffies(5000);
464 to = wait_event_interruptible_lock_irq_timeout(cfg->tmf_waitq,
469 cfg->tmf_active = false;
470 dev_err(dev, "%s: TMF timed out!\n", __func__);
473 spin_unlock_irqrestore(&cfg->tmf_slock, lock_flags);
479 * cxlflash_driver_info() - information handler for this host driver
480 * @host: SCSI host associated with device.
482 * Return: A string describing the device.
484 static const char *cxlflash_driver_info(struct Scsi_Host *host)
486 return CXLFLASH_ADAPTER_NAME;
490 * cxlflash_queuecommand() - sends a mid-layer request
491 * @host: SCSI host associated with device.
492 * @scp: SCSI command to send.
496 * SCSI_MLQUEUE_HOST_BUSY when host is busy
498 static int cxlflash_queuecommand(struct Scsi_Host *host, struct scsi_cmnd *scp)
500 struct cxlflash_cfg *cfg = (struct cxlflash_cfg *)host->hostdata;
501 struct afu *afu = cfg->afu;
502 struct device *dev = &cfg->dev->dev;
504 u32 port_sel = scp->device->channel + 1;
506 struct scatterlist *sg;
511 dev_dbg_ratelimited(dev, "%s: (scp=%p) %d/%d/%d/%llu "
512 "cdb=(%08X-%08X-%08X-%08X)\n",
513 __func__, scp, host->host_no, scp->device->channel,
514 scp->device->id, scp->device->lun,
515 get_unaligned_be32(&((u32 *)scp->cmnd)[0]),
516 get_unaligned_be32(&((u32 *)scp->cmnd)[1]),
517 get_unaligned_be32(&((u32 *)scp->cmnd)[2]),
518 get_unaligned_be32(&((u32 *)scp->cmnd)[3]));
521 * If a Task Management Function is active, wait for it to complete
522 * before continuing with regular commands.
524 spin_lock_irqsave(&cfg->tmf_slock, lock_flags);
525 if (cfg->tmf_active) {
526 spin_unlock_irqrestore(&cfg->tmf_slock, lock_flags);
527 rc = SCSI_MLQUEUE_HOST_BUSY;
530 spin_unlock_irqrestore(&cfg->tmf_slock, lock_flags);
532 switch (cfg->state) {
534 dev_dbg_ratelimited(dev, "%s: device is in reset!\n", __func__);
535 rc = SCSI_MLQUEUE_HOST_BUSY;
538 dev_dbg_ratelimited(dev, "%s: device has failed!\n", __func__);
539 scp->result = (DID_NO_CONNECT << 16);
547 cmd = cmd_checkout(afu);
548 if (unlikely(!cmd)) {
549 dev_err(dev, "%s: could not get a free command\n", __func__);
550 rc = SCSI_MLQUEUE_HOST_BUSY;
554 cmd->rcb.ctx_id = afu->ctx_hndl;
555 cmd->rcb.port_sel = port_sel;
556 cmd->rcb.lun_id = lun_to_lunid(scp->device->lun);
558 if (scp->sc_data_direction == DMA_TO_DEVICE)
559 lflag = SISL_REQ_FLAGS_HOST_WRITE;
561 lflag = SISL_REQ_FLAGS_HOST_READ;
563 cmd->rcb.req_flags = (SISL_REQ_FLAGS_PORT_LUN_ID |
564 SISL_REQ_FLAGS_SUP_UNDERRUN | lflag);
566 /* Stash the scp in the reserved field, for reuse during interrupt */
569 nseg = scsi_dma_map(scp);
570 if (unlikely(nseg < 0)) {
571 dev_err(dev, "%s: Fail DMA map! nseg=%d\n",
573 rc = SCSI_MLQUEUE_HOST_BUSY;
577 ncount = scsi_sg_count(scp);
578 scsi_for_each_sg(scp, sg, ncount, i) {
579 cmd->rcb.data_len = sg_dma_len(sg);
580 cmd->rcb.data_ea = sg_dma_address(sg);
583 /* Copy the CDB from the scsi_cmnd passed in */
584 memcpy(cmd->rcb.cdb, scp->cmnd, sizeof(cmd->rcb.cdb));
586 /* Send the command */
587 rc = send_cmd(afu, cmd);
594 pr_devel("%s: returning rc=%d\n", __func__, rc);
599 * cxlflash_wait_for_pci_err_recovery() - wait for error recovery during probe
600 * @cxlflash: Internal structure associated with the host.
602 static void cxlflash_wait_for_pci_err_recovery(struct cxlflash_cfg *cfg)
604 struct pci_dev *pdev = cfg->dev;
606 if (pci_channel_offline(pdev))
607 wait_event_timeout(cfg->reset_waitq,
608 !pci_channel_offline(pdev),
609 CXLFLASH_PCI_ERROR_RECOVERY_TIMEOUT);
613 * free_mem() - free memory associated with the AFU
614 * @cxlflash: Internal structure associated with the host.
616 static void free_mem(struct cxlflash_cfg *cfg)
620 struct afu *afu = cfg->afu;
623 for (i = 0; i < CXLFLASH_NUM_CMDS; i++) {
624 buf = afu->cmd[i].buf;
625 if (!((u64)buf & (PAGE_SIZE - 1)))
626 free_page((ulong)buf);
629 free_pages((ulong)afu, get_order(sizeof(struct afu)));
635 * stop_afu() - stops the AFU command timers and unmaps the MMIO space
636 * @cxlflash: Internal structure associated with the host.
638 * Safe to call with AFU in a partially allocated/initialized state.
640 static void stop_afu(struct cxlflash_cfg *cfg)
643 struct afu *afu = cfg->afu;
646 for (i = 0; i < CXLFLASH_NUM_CMDS; i++)
647 complete(&afu->cmd[i].cevent);
649 if (likely(afu->afu_map)) {
650 cxl_psa_unmap((void *)afu->afu_map);
657 * term_mc() - terminates the master context
658 * @cxlflash: Internal structure associated with the host.
659 * @level: Depth of allocation, where to begin waterfall tear down.
661 * Safe to call with AFU/MC in partially allocated/initialized state.
663 static void term_mc(struct cxlflash_cfg *cfg, enum undo_level level)
666 struct afu *afu = cfg->afu;
667 struct device *dev = &cfg->dev->dev;
669 if (!afu || !cfg->mcctx) {
670 dev_err(dev, "%s: returning from term_mc with NULL afu or MC\n",
677 rc = cxl_stop_context(cfg->mcctx);
680 cxl_unmap_afu_irq(cfg->mcctx, 3, afu);
682 cxl_unmap_afu_irq(cfg->mcctx, 2, afu);
684 cxl_unmap_afu_irq(cfg->mcctx, 1, afu);
686 cxl_free_afu_irqs(cfg->mcctx);
687 case RELEASE_CONTEXT:
693 * term_afu() - terminates the AFU
694 * @cxlflash: Internal structure associated with the host.
696 * Safe to call with AFU/MC in partially allocated/initialized state.
698 static void term_afu(struct cxlflash_cfg *cfg)
700 term_mc(cfg, UNDO_START);
705 pr_debug("%s: returning\n", __func__);
709 * cxlflash_remove() - PCI entry point to tear down host
710 * @pdev: PCI device associated with the host.
712 * Safe to use as a cleanup in partially allocated/initialized state.
714 static void cxlflash_remove(struct pci_dev *pdev)
716 struct cxlflash_cfg *cfg = pci_get_drvdata(pdev);
719 /* If a Task Management Function is active, wait for it to complete
720 * before continuing with remove.
722 spin_lock_irqsave(&cfg->tmf_slock, lock_flags);
724 wait_event_interruptible_lock_irq(cfg->tmf_waitq,
727 spin_unlock_irqrestore(&cfg->tmf_slock, lock_flags);
729 cfg->state = STATE_FAILTERM;
730 cxlflash_stop_term_user_contexts(cfg);
732 switch (cfg->init_state) {
733 case INIT_STATE_SCSI:
734 cxlflash_term_local_luns(cfg);
735 scsi_remove_host(cfg->host);
739 cancel_work_sync(&cfg->work_q);
741 pci_release_regions(cfg->dev);
742 pci_disable_device(pdev);
743 case INIT_STATE_NONE:
745 scsi_host_put(cfg->host);
749 pr_debug("%s: returning\n", __func__);
753 * alloc_mem() - allocates the AFU and its command pool
754 * @cxlflash: Internal structure associated with the host.
756 * A partially allocated state remains on failure.
760 * -ENOMEM on failure to allocate memory
762 static int alloc_mem(struct cxlflash_cfg *cfg)
767 struct device *dev = &cfg->dev->dev;
769 /* This allocation is about 12K, i.e. only 1 64k page
770 * and upto 4 4k pages
772 cfg->afu = (void *)__get_free_pages(GFP_KERNEL | __GFP_ZERO,
773 get_order(sizeof(struct afu)));
774 if (unlikely(!cfg->afu)) {
775 dev_err(dev, "%s: cannot get %d free pages\n",
776 __func__, get_order(sizeof(struct afu)));
780 cfg->afu->parent = cfg;
781 cfg->afu->afu_map = NULL;
783 for (i = 0; i < CXLFLASH_NUM_CMDS; buf += CMD_BUFSIZE, i++) {
784 if (!((u64)buf & (PAGE_SIZE - 1))) {
785 buf = (void *)__get_free_page(GFP_KERNEL | __GFP_ZERO);
786 if (unlikely(!buf)) {
788 "%s: Allocate command buffers fail!\n",
796 cfg->afu->cmd[i].buf = buf;
797 atomic_set(&cfg->afu->cmd[i].free, 1);
798 cfg->afu->cmd[i].slot = i;
806 * init_pci() - initializes the host as a PCI device
807 * @cxlflash: Internal structure associated with the host.
811 * -EIO on unable to communicate with device
812 * A return code from the PCI sub-routines
814 static int init_pci(struct cxlflash_cfg *cfg)
816 struct pci_dev *pdev = cfg->dev;
819 cfg->cxlflash_regs_pci = pci_resource_start(pdev, 0);
820 rc = pci_request_regions(pdev, CXLFLASH_NAME);
823 "%s: Couldn't register memory range of registers\n",
828 rc = pci_enable_device(pdev);
829 if (rc || pci_channel_offline(pdev)) {
830 if (pci_channel_offline(pdev)) {
831 cxlflash_wait_for_pci_err_recovery(cfg);
832 rc = pci_enable_device(pdev);
836 dev_err(&pdev->dev, "%s: Cannot enable adapter\n",
838 cxlflash_wait_for_pci_err_recovery(cfg);
839 goto out_release_regions;
843 rc = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
845 dev_dbg(&pdev->dev, "%s: Failed to set 64 bit PCI DMA mask\n",
847 rc = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
851 dev_err(&pdev->dev, "%s: Failed to set PCI DMA mask\n",
856 pci_set_master(pdev);
858 if (pci_channel_offline(pdev)) {
859 cxlflash_wait_for_pci_err_recovery(cfg);
860 if (pci_channel_offline(pdev)) {
862 goto out_msi_disable;
866 rc = pci_save_state(pdev);
868 if (rc != PCIBIOS_SUCCESSFUL) {
869 dev_err(&pdev->dev, "%s: Failed to save PCI config space\n",
876 pr_debug("%s: returning rc=%d\n", __func__, rc);
881 cxlflash_wait_for_pci_err_recovery(cfg);
883 pci_disable_device(pdev);
885 pci_release_regions(pdev);
891 * init_scsi() - adds the host to the SCSI stack and kicks off host scan
892 * @cxlflash: Internal structure associated with the host.
896 * A return code from adding the host
898 static int init_scsi(struct cxlflash_cfg *cfg)
900 struct pci_dev *pdev = cfg->dev;
903 rc = scsi_add_host(cfg->host, &pdev->dev);
905 dev_err(&pdev->dev, "%s: scsi_add_host failed (rc=%d)\n",
910 scsi_scan_host(cfg->host);
913 pr_debug("%s: returning rc=%d\n", __func__, rc);
918 * set_port_online() - transitions the specified host FC port to online state
919 * @fc_regs: Top of MMIO region defined for specified port.
921 * The provided MMIO region must be mapped prior to call. Online state means
922 * that the FC link layer has synced, completed the handshaking process, and
923 * is ready for login to start.
925 static void set_port_online(u64 *fc_regs)
929 cmdcfg = readq_be(&fc_regs[FC_MTIP_CMDCONFIG / 8]);
930 cmdcfg &= (~FC_MTIP_CMDCONFIG_OFFLINE); /* clear OFF_LINE */
931 cmdcfg |= (FC_MTIP_CMDCONFIG_ONLINE); /* set ON_LINE */
932 writeq_be(cmdcfg, &fc_regs[FC_MTIP_CMDCONFIG / 8]);
936 * set_port_offline() - transitions the specified host FC port to offline state
937 * @fc_regs: Top of MMIO region defined for specified port.
939 * The provided MMIO region must be mapped prior to call.
941 static void set_port_offline(u64 *fc_regs)
945 cmdcfg = readq_be(&fc_regs[FC_MTIP_CMDCONFIG / 8]);
946 cmdcfg &= (~FC_MTIP_CMDCONFIG_ONLINE); /* clear ON_LINE */
947 cmdcfg |= (FC_MTIP_CMDCONFIG_OFFLINE); /* set OFF_LINE */
948 writeq_be(cmdcfg, &fc_regs[FC_MTIP_CMDCONFIG / 8]);
952 * wait_port_online() - waits for the specified host FC port come online
953 * @fc_regs: Top of MMIO region defined for specified port.
954 * @delay_us: Number of microseconds to delay between reading port status.
955 * @nretry: Number of cycles to retry reading port status.
957 * The provided MMIO region must be mapped prior to call. This will timeout
958 * when the cable is not plugged in.
961 * TRUE (1) when the specified port is online
962 * FALSE (0) when the specified port fails to come online after timeout
963 * -EINVAL when @delay_us is less than 1000
965 static int wait_port_online(u64 *fc_regs, u32 delay_us, u32 nretry)
969 if (delay_us < 1000) {
970 pr_err("%s: invalid delay specified %d\n", __func__, delay_us);
975 msleep(delay_us / 1000);
976 status = readq_be(&fc_regs[FC_MTIP_STATUS / 8]);
977 } while ((status & FC_MTIP_STATUS_MASK) != FC_MTIP_STATUS_ONLINE &&
980 return ((status & FC_MTIP_STATUS_MASK) == FC_MTIP_STATUS_ONLINE);
984 * wait_port_offline() - waits for the specified host FC port go offline
985 * @fc_regs: Top of MMIO region defined for specified port.
986 * @delay_us: Number of microseconds to delay between reading port status.
987 * @nretry: Number of cycles to retry reading port status.
989 * The provided MMIO region must be mapped prior to call.
992 * TRUE (1) when the specified port is offline
993 * FALSE (0) when the specified port fails to go offline after timeout
994 * -EINVAL when @delay_us is less than 1000
996 static int wait_port_offline(u64 *fc_regs, u32 delay_us, u32 nretry)
1000 if (delay_us < 1000) {
1001 pr_err("%s: invalid delay specified %d\n", __func__, delay_us);
1006 msleep(delay_us / 1000);
1007 status = readq_be(&fc_regs[FC_MTIP_STATUS / 8]);
1008 } while ((status & FC_MTIP_STATUS_MASK) != FC_MTIP_STATUS_OFFLINE &&
1011 return ((status & FC_MTIP_STATUS_MASK) == FC_MTIP_STATUS_OFFLINE);
1015 * afu_set_wwpn() - configures the WWPN for the specified host FC port
1016 * @afu: AFU associated with the host that owns the specified FC port.
1017 * @port: Port number being configured.
1018 * @fc_regs: Top of MMIO region defined for specified port.
1019 * @wwpn: The world-wide-port-number previously discovered for port.
1021 * The provided MMIO region must be mapped prior to call. As part of the
1022 * sequence to configure the WWPN, the port is toggled offline and then back
1023 * online. This toggling action can cause this routine to delay up to a few
1024 * seconds. When configured to use the internal LUN feature of the AFU, a
1025 * failure to come online is overridden.
1028 * 0 when the WWPN is successfully written and the port comes back online
1029 * -1 when the port fails to go offline or come back up online
1031 static int afu_set_wwpn(struct afu *afu, int port, u64 *fc_regs, u64 wwpn)
1035 set_port_offline(fc_regs);
1037 if (!wait_port_offline(fc_regs, FC_PORT_STATUS_RETRY_INTERVAL_US,
1038 FC_PORT_STATUS_RETRY_CNT)) {
1039 pr_debug("%s: wait on port %d to go offline timed out\n",
1041 rc = -1; /* but continue on to leave the port back online */
1045 writeq_be(wwpn, &fc_regs[FC_PNAME / 8]);
1047 /* Always return success after programming WWPN */
1050 set_port_online(fc_regs);
1052 if (!wait_port_online(fc_regs, FC_PORT_STATUS_RETRY_INTERVAL_US,
1053 FC_PORT_STATUS_RETRY_CNT)) {
1054 pr_err("%s: wait on port %d to go online timed out\n",
1058 pr_debug("%s: returning rc=%d\n", __func__, rc);
1064 * afu_link_reset() - resets the specified host FC port
1065 * @afu: AFU associated with the host that owns the specified FC port.
1066 * @port: Port number being configured.
1067 * @fc_regs: Top of MMIO region defined for specified port.
1069 * The provided MMIO region must be mapped prior to call. The sequence to
1070 * reset the port involves toggling it offline and then back online. This
1071 * action can cause this routine to delay up to a few seconds. An effort
1072 * is made to maintain link with the device by switching to host to use
1073 * the alternate port exclusively while the reset takes place.
1074 * failure to come online is overridden.
1076 static void afu_link_reset(struct afu *afu, int port, u64 *fc_regs)
1080 /* first switch the AFU to the other links, if any */
1081 port_sel = readq_be(&afu->afu_map->global.regs.afu_port_sel);
1082 port_sel &= ~(1ULL << port);
1083 writeq_be(port_sel, &afu->afu_map->global.regs.afu_port_sel);
1084 cxlflash_afu_sync(afu, 0, 0, AFU_GSYNC);
1086 set_port_offline(fc_regs);
1087 if (!wait_port_offline(fc_regs, FC_PORT_STATUS_RETRY_INTERVAL_US,
1088 FC_PORT_STATUS_RETRY_CNT))
1089 pr_err("%s: wait on port %d to go offline timed out\n",
1092 set_port_online(fc_regs);
1093 if (!wait_port_online(fc_regs, FC_PORT_STATUS_RETRY_INTERVAL_US,
1094 FC_PORT_STATUS_RETRY_CNT))
1095 pr_err("%s: wait on port %d to go online timed out\n",
1098 /* switch back to include this port */
1099 port_sel |= (1ULL << port);
1100 writeq_be(port_sel, &afu->afu_map->global.regs.afu_port_sel);
1101 cxlflash_afu_sync(afu, 0, 0, AFU_GSYNC);
1103 pr_debug("%s: returning port_sel=%lld\n", __func__, port_sel);
1107 * Asynchronous interrupt information table
1109 static const struct asyc_intr_info ainfo[] = {
1110 {SISL_ASTATUS_FC0_OTHER, "other error", 0, CLR_FC_ERROR | LINK_RESET},
1111 {SISL_ASTATUS_FC0_LOGO, "target initiated LOGO", 0, 0},
1112 {SISL_ASTATUS_FC0_CRC_T, "CRC threshold exceeded", 0, LINK_RESET},
1113 {SISL_ASTATUS_FC0_LOGI_R, "login timed out, retrying", 0, 0},
1114 {SISL_ASTATUS_FC0_LOGI_F, "login failed", 0, CLR_FC_ERROR},
1115 {SISL_ASTATUS_FC0_LOGI_S, "login succeeded", 0, SCAN_HOST},
1116 {SISL_ASTATUS_FC0_LINK_DN, "link down", 0, 0},
1117 {SISL_ASTATUS_FC0_LINK_UP, "link up", 0, SCAN_HOST},
1118 {SISL_ASTATUS_FC1_OTHER, "other error", 1, CLR_FC_ERROR | LINK_RESET},
1119 {SISL_ASTATUS_FC1_LOGO, "target initiated LOGO", 1, 0},
1120 {SISL_ASTATUS_FC1_CRC_T, "CRC threshold exceeded", 1, LINK_RESET},
1121 {SISL_ASTATUS_FC1_LOGI_R, "login timed out, retrying", 1, 0},
1122 {SISL_ASTATUS_FC1_LOGI_F, "login failed", 1, CLR_FC_ERROR},
1123 {SISL_ASTATUS_FC1_LOGI_S, "login succeeded", 1, SCAN_HOST},
1124 {SISL_ASTATUS_FC1_LINK_DN, "link down", 1, 0},
1125 {SISL_ASTATUS_FC1_LINK_UP, "link up", 1, SCAN_HOST},
1126 {0x0, "", 0, 0} /* terminator */
1130 * find_ainfo() - locates and returns asynchronous interrupt information
1131 * @status: Status code set by AFU on error.
1133 * Return: The located information or NULL when the status code is invalid.
1135 static const struct asyc_intr_info *find_ainfo(u64 status)
1137 const struct asyc_intr_info *info;
1139 for (info = &ainfo[0]; info->status; info++)
1140 if (info->status == status)
1147 * afu_err_intr_init() - clears and initializes the AFU for error interrupts
1148 * @afu: AFU associated with the host.
1150 static void afu_err_intr_init(struct afu *afu)
1155 /* global async interrupts: AFU clears afu_ctrl on context exit
1156 * if async interrupts were sent to that context. This prevents
1157 * the AFU form sending further async interrupts when
1159 * nobody to receive them.
1163 writeq_be(-1ULL, &afu->afu_map->global.regs.aintr_mask);
1164 /* set LISN# to send and point to master context */
1165 reg = ((u64) (((afu->ctx_hndl << 8) | SISL_MSI_ASYNC_ERROR)) << 40);
1167 if (afu->internal_lun)
1168 reg |= 1; /* Bit 63 indicates local lun */
1169 writeq_be(reg, &afu->afu_map->global.regs.afu_ctrl);
1171 writeq_be(-1ULL, &afu->afu_map->global.regs.aintr_clear);
1172 /* unmask bits that are of interest */
1173 /* note: afu can send an interrupt after this step */
1174 writeq_be(SISL_ASTATUS_MASK, &afu->afu_map->global.regs.aintr_mask);
1175 /* clear again in case a bit came on after previous clear but before */
1177 writeq_be(-1ULL, &afu->afu_map->global.regs.aintr_clear);
1179 /* Clear/Set internal lun bits */
1180 reg = readq_be(&afu->afu_map->global.fc_regs[0][FC_CONFIG2 / 8]);
1181 reg &= SISL_FC_INTERNAL_MASK;
1182 if (afu->internal_lun)
1183 reg |= ((u64)(afu->internal_lun - 1) << SISL_FC_INTERNAL_SHIFT);
1184 writeq_be(reg, &afu->afu_map->global.fc_regs[0][FC_CONFIG2 / 8]);
1186 /* now clear FC errors */
1187 for (i = 0; i < NUM_FC_PORTS; i++) {
1188 writeq_be(0xFFFFFFFFU,
1189 &afu->afu_map->global.fc_regs[i][FC_ERROR / 8]);
1190 writeq_be(0, &afu->afu_map->global.fc_regs[i][FC_ERRCAP / 8]);
1193 /* sync interrupts for master's IOARRIN write */
1194 /* note that unlike asyncs, there can be no pending sync interrupts */
1195 /* at this time (this is a fresh context and master has not written */
1196 /* IOARRIN yet), so there is nothing to clear. */
1198 /* set LISN#, it is always sent to the context that wrote IOARRIN */
1199 writeq_be(SISL_MSI_SYNC_ERROR, &afu->host_map->ctx_ctrl);
1200 writeq_be(SISL_ISTATUS_MASK, &afu->host_map->intr_mask);
1204 * cxlflash_sync_err_irq() - interrupt handler for synchronous errors
1205 * @irq: Interrupt number.
1206 * @data: Private data provided at interrupt registration, the AFU.
1208 * Return: Always return IRQ_HANDLED.
1210 static irqreturn_t cxlflash_sync_err_irq(int irq, void *data)
1212 struct afu *afu = (struct afu *)data;
1216 reg = readq_be(&afu->host_map->intr_status);
1217 reg_unmasked = (reg & SISL_ISTATUS_UNMASK);
1219 if (reg_unmasked == 0UL) {
1220 pr_err("%s: %llX: spurious interrupt, intr_status %016llX\n",
1221 __func__, (u64)afu, reg);
1222 goto cxlflash_sync_err_irq_exit;
1225 pr_err("%s: %llX: unexpected interrupt, intr_status %016llX\n",
1226 __func__, (u64)afu, reg);
1228 writeq_be(reg_unmasked, &afu->host_map->intr_clear);
1230 cxlflash_sync_err_irq_exit:
1231 pr_debug("%s: returning rc=%d\n", __func__, IRQ_HANDLED);
1236 * cxlflash_rrq_irq() - interrupt handler for read-response queue (normal path)
1237 * @irq: Interrupt number.
1238 * @data: Private data provided at interrupt registration, the AFU.
1240 * Return: Always return IRQ_HANDLED.
1242 static irqreturn_t cxlflash_rrq_irq(int irq, void *data)
1244 struct afu *afu = (struct afu *)data;
1245 struct afu_cmd *cmd;
1246 bool toggle = afu->toggle;
1248 *hrrq_start = afu->hrrq_start,
1249 *hrrq_end = afu->hrrq_end,
1250 *hrrq_curr = afu->hrrq_curr;
1252 /* Process however many RRQ entries that are ready */
1256 if ((entry & SISL_RESP_HANDLE_T_BIT) != toggle)
1259 cmd = (struct afu_cmd *)(entry & ~SISL_RESP_HANDLE_T_BIT);
1262 /* Advance to next entry or wrap and flip the toggle bit */
1263 if (hrrq_curr < hrrq_end)
1266 hrrq_curr = hrrq_start;
1267 toggle ^= SISL_RESP_HANDLE_T_BIT;
1271 afu->hrrq_curr = hrrq_curr;
1272 afu->toggle = toggle;
1278 * cxlflash_async_err_irq() - interrupt handler for asynchronous errors
1279 * @irq: Interrupt number.
1280 * @data: Private data provided at interrupt registration, the AFU.
1282 * Return: Always return IRQ_HANDLED.
1284 static irqreturn_t cxlflash_async_err_irq(int irq, void *data)
1286 struct afu *afu = (struct afu *)data;
1287 struct cxlflash_cfg *cfg = afu->parent;
1288 struct device *dev = &cfg->dev->dev;
1290 const struct asyc_intr_info *info;
1291 struct sisl_global_map *global = &afu->afu_map->global;
1296 reg = readq_be(&global->regs.aintr_status);
1297 reg_unmasked = (reg & SISL_ASTATUS_UNMASK);
1299 if (reg_unmasked == 0) {
1300 dev_err(dev, "%s: spurious interrupt, aintr_status 0x%016llX\n",
1305 /* it is OK to clear AFU status before FC_ERROR */
1306 writeq_be(reg_unmasked, &global->regs.aintr_clear);
1308 /* check each bit that is on */
1309 for (i = 0; reg_unmasked; i++, reg_unmasked = (reg_unmasked >> 1)) {
1310 info = find_ainfo(1ULL << i);
1311 if (((reg_unmasked & 0x1) == 0) || !info)
1316 dev_err(dev, "%s: FC Port %d -> %s, fc_status 0x%08llX\n",
1317 __func__, port, info->desc,
1318 readq_be(&global->fc_regs[port][FC_STATUS / 8]));
1321 * do link reset first, some OTHER errors will set FC_ERROR
1322 * again if cleared before or w/o a reset
1324 if (info->action & LINK_RESET) {
1325 dev_err(dev, "%s: FC Port %d: resetting link\n",
1327 cfg->lr_state = LINK_RESET_REQUIRED;
1328 cfg->lr_port = port;
1329 schedule_work(&cfg->work_q);
1332 if (info->action & CLR_FC_ERROR) {
1333 reg = readq_be(&global->fc_regs[port][FC_ERROR / 8]);
1336 * since all errors are unmasked, FC_ERROR and FC_ERRCAP
1337 * should be the same and tracing one is sufficient.
1340 dev_err(dev, "%s: fc %d: clearing fc_error 0x%08llX\n",
1341 __func__, port, reg);
1343 writeq_be(reg, &global->fc_regs[port][FC_ERROR / 8]);
1344 writeq_be(0, &global->fc_regs[port][FC_ERRCAP / 8]);
1347 if (info->action & SCAN_HOST) {
1348 atomic_inc(&cfg->scan_host_needed);
1349 schedule_work(&cfg->work_q);
1354 dev_dbg(dev, "%s: returning IRQ_HANDLED, afu=%p\n", __func__, afu);
1359 * start_context() - starts the master context
1360 * @cxlflash: Internal structure associated with the host.
1362 * Return: A success or failure value from CXL services.
1364 static int start_context(struct cxlflash_cfg *cfg)
1368 rc = cxl_start_context(cfg->mcctx,
1369 cfg->afu->work.work_element_descriptor,
1372 pr_debug("%s: returning rc=%d\n", __func__, rc);
1377 * read_vpd() - obtains the WWPNs from VPD
1378 * @cxlflash: Internal structure associated with the host.
1379 * @wwpn: Array of size NUM_FC_PORTS to pass back WWPNs
1383 * -ENODEV when VPD or WWPN keywords not found
1385 static int read_vpd(struct cxlflash_cfg *cfg, u64 wwpn[])
1387 struct pci_dev *dev = cfg->parent_dev;
1389 int ro_start, ro_size, i, j, k;
1391 char vpd_data[CXLFLASH_VPD_LEN];
1392 char tmp_buf[WWPN_BUF_LEN] = { 0 };
1393 char *wwpn_vpd_tags[NUM_FC_PORTS] = { "V5", "V6" };
1395 /* Get the VPD data from the device */
1396 vpd_size = pci_read_vpd(dev, 0, sizeof(vpd_data), vpd_data);
1397 if (unlikely(vpd_size <= 0)) {
1398 dev_err(&dev->dev, "%s: Unable to read VPD (size = %ld)\n",
1399 __func__, vpd_size);
1404 /* Get the read only section offset */
1405 ro_start = pci_vpd_find_tag(vpd_data, 0, vpd_size,
1406 PCI_VPD_LRDT_RO_DATA);
1407 if (unlikely(ro_start < 0)) {
1408 dev_err(&dev->dev, "%s: VPD Read-only data not found\n",
1414 /* Get the read only section size, cap when extends beyond read VPD */
1415 ro_size = pci_vpd_lrdt_size(&vpd_data[ro_start]);
1417 i = ro_start + PCI_VPD_LRDT_TAG_SIZE;
1418 if (unlikely((i + j) > vpd_size)) {
1419 pr_debug("%s: Might need to read more VPD (%d > %ld)\n",
1420 __func__, (i + j), vpd_size);
1421 ro_size = vpd_size - i;
1425 * Find the offset of the WWPN tag within the read only
1426 * VPD data and validate the found field (partials are
1427 * no good to us). Convert the ASCII data to an integer
1428 * value. Note that we must copy to a temporary buffer
1429 * because the conversion service requires that the ASCII
1430 * string be terminated.
1432 for (k = 0; k < NUM_FC_PORTS; k++) {
1434 i = ro_start + PCI_VPD_LRDT_TAG_SIZE;
1436 i = pci_vpd_find_info_keyword(vpd_data, i, j, wwpn_vpd_tags[k]);
1437 if (unlikely(i < 0)) {
1438 dev_err(&dev->dev, "%s: Port %d WWPN not found "
1439 "in VPD\n", __func__, k);
1444 j = pci_vpd_info_field_size(&vpd_data[i]);
1445 i += PCI_VPD_INFO_FLD_HDR_SIZE;
1446 if (unlikely((i + j > vpd_size) || (j != WWPN_LEN))) {
1447 dev_err(&dev->dev, "%s: Port %d WWPN incomplete or "
1454 memcpy(tmp_buf, &vpd_data[i], WWPN_LEN);
1455 rc = kstrtoul(tmp_buf, WWPN_LEN, (ulong *)&wwpn[k]);
1457 dev_err(&dev->dev, "%s: Fail to convert port %d WWPN "
1458 "to integer\n", __func__, k);
1465 pr_debug("%s: returning rc=%d\n", __func__, rc);
1470 * init_pcr() - initialize the provisioning and control registers
1471 * @cxlflash: Internal structure associated with the host.
1473 * Also sets up fast access to the mapped registers and initializes AFU
1474 * command fields that never change.
1476 static void init_pcr(struct cxlflash_cfg *cfg)
1478 struct afu *afu = cfg->afu;
1479 struct sisl_ctrl_map *ctrl_map;
1482 for (i = 0; i < MAX_CONTEXT; i++) {
1483 ctrl_map = &afu->afu_map->ctrls[i].ctrl;
1484 /* disrupt any clients that could be running */
1485 /* e. g. clients that survived a master restart */
1486 writeq_be(0, &ctrl_map->rht_start);
1487 writeq_be(0, &ctrl_map->rht_cnt_id);
1488 writeq_be(0, &ctrl_map->ctx_cap);
1491 /* copy frequently used fields into afu */
1492 afu->ctx_hndl = (u16) cxl_process_element(cfg->mcctx);
1493 /* ctx_hndl is 16 bits in CAIA */
1494 afu->host_map = &afu->afu_map->hosts[afu->ctx_hndl].host;
1495 afu->ctrl_map = &afu->afu_map->ctrls[afu->ctx_hndl].ctrl;
1497 /* Program the Endian Control for the master context */
1498 writeq_be(SISL_ENDIAN_CTRL, &afu->host_map->endian_ctrl);
1500 /* initialize cmd fields that never change */
1501 for (i = 0; i < CXLFLASH_NUM_CMDS; i++) {
1502 afu->cmd[i].rcb.ctx_id = afu->ctx_hndl;
1503 afu->cmd[i].rcb.msi = SISL_MSI_RRQ_UPDATED;
1504 afu->cmd[i].rcb.rrq = 0x0;
1509 * init_global() - initialize AFU global registers
1510 * @cxlflash: Internal structure associated with the host.
1512 static int init_global(struct cxlflash_cfg *cfg)
1514 struct afu *afu = cfg->afu;
1515 struct device *dev = &cfg->dev->dev;
1516 u64 wwpn[NUM_FC_PORTS]; /* wwpn of AFU ports */
1517 int i = 0, num_ports = 0;
1521 rc = read_vpd(cfg, &wwpn[0]);
1523 dev_err(dev, "%s: could not read vpd rc=%d\n", __func__, rc);
1527 pr_debug("%s: wwpn0=0x%llX wwpn1=0x%llX\n", __func__, wwpn[0], wwpn[1]);
1529 /* set up RRQ in AFU for master issued cmds */
1530 writeq_be((u64) afu->hrrq_start, &afu->host_map->rrq_start);
1531 writeq_be((u64) afu->hrrq_end, &afu->host_map->rrq_end);
1533 /* AFU configuration */
1534 reg = readq_be(&afu->afu_map->global.regs.afu_config);
1535 reg |= SISL_AFUCONF_AR_ALL|SISL_AFUCONF_ENDIAN;
1536 /* enable all auto retry options and control endianness */
1537 /* leave others at default: */
1538 /* CTX_CAP write protected, mbox_r does not clear on read and */
1539 /* checker on if dual afu */
1540 writeq_be(reg, &afu->afu_map->global.regs.afu_config);
1542 /* global port select: select either port */
1543 if (afu->internal_lun) {
1544 /* only use port 0 */
1545 writeq_be(PORT0, &afu->afu_map->global.regs.afu_port_sel);
1546 num_ports = NUM_FC_PORTS - 1;
1548 writeq_be(BOTH_PORTS, &afu->afu_map->global.regs.afu_port_sel);
1549 num_ports = NUM_FC_PORTS;
1552 for (i = 0; i < num_ports; i++) {
1553 /* unmask all errors (but they are still masked at AFU) */
1554 writeq_be(0, &afu->afu_map->global.fc_regs[i][FC_ERRMSK / 8]);
1555 /* clear CRC error cnt & set a threshold */
1556 (void)readq_be(&afu->afu_map->global.
1557 fc_regs[i][FC_CNT_CRCERR / 8]);
1558 writeq_be(MC_CRC_THRESH, &afu->afu_map->global.fc_regs[i]
1559 [FC_CRC_THRESH / 8]);
1561 /* set WWPNs. If already programmed, wwpn[i] is 0 */
1563 afu_set_wwpn(afu, i,
1564 &afu->afu_map->global.fc_regs[i][0],
1566 dev_err(dev, "%s: failed to set WWPN on port %d\n",
1571 /* Programming WWPN back to back causes additional
1572 * offline/online transitions and a PLOGI
1578 /* set up master's own CTX_CAP to allow real mode, host translation */
1579 /* tbls, afu cmds and read/write GSCSI cmds. */
1580 /* First, unlock ctx_cap write by reading mbox */
1581 (void)readq_be(&afu->ctrl_map->mbox_r); /* unlock ctx_cap */
1582 writeq_be((SISL_CTX_CAP_REAL_MODE | SISL_CTX_CAP_HOST_XLATE |
1583 SISL_CTX_CAP_READ_CMD | SISL_CTX_CAP_WRITE_CMD |
1584 SISL_CTX_CAP_AFU_CMD | SISL_CTX_CAP_GSCSI_CMD),
1585 &afu->ctrl_map->ctx_cap);
1586 /* init heartbeat */
1587 afu->hb = readq_be(&afu->afu_map->global.regs.afu_hb);
1594 * start_afu() - initializes and starts the AFU
1595 * @cxlflash: Internal structure associated with the host.
1597 static int start_afu(struct cxlflash_cfg *cfg)
1599 struct afu *afu = cfg->afu;
1600 struct afu_cmd *cmd;
1605 for (i = 0; i < CXLFLASH_NUM_CMDS; i++) {
1608 init_completion(&cmd->cevent);
1609 spin_lock_init(&cmd->slock);
1615 /* initialize RRQ pointers */
1616 afu->hrrq_start = &afu->rrq_entry[0];
1617 afu->hrrq_end = &afu->rrq_entry[NUM_RRQ_ENTRY - 1];
1618 afu->hrrq_curr = afu->hrrq_start;
1621 rc = init_global(cfg);
1623 pr_debug("%s: returning rc=%d\n", __func__, rc);
1628 * init_mc() - create and register as the master context
1629 * @cxlflash: Internal structure associated with the host.
1633 * -ENOMEM when unable to obtain a context from CXL services
1634 * A failure value from CXL services.
1636 static int init_mc(struct cxlflash_cfg *cfg)
1638 struct cxl_context *ctx;
1639 struct device *dev = &cfg->dev->dev;
1640 struct afu *afu = cfg->afu;
1642 enum undo_level level;
1644 ctx = cxl_get_context(cfg->dev);
1649 /* Set it up as a master with the CXL */
1650 cxl_set_master(ctx);
1652 /* During initialization reset the AFU to start from a clean slate */
1653 rc = cxl_afu_reset(cfg->mcctx);
1655 dev_err(dev, "%s: initial AFU reset failed rc=%d\n",
1657 level = RELEASE_CONTEXT;
1661 rc = cxl_allocate_afu_irqs(ctx, 3);
1663 dev_err(dev, "%s: call to allocate_afu_irqs failed rc=%d!\n",
1665 level = RELEASE_CONTEXT;
1669 rc = cxl_map_afu_irq(ctx, 1, cxlflash_sync_err_irq, afu,
1670 "SISL_MSI_SYNC_ERROR");
1671 if (unlikely(rc <= 0)) {
1672 dev_err(dev, "%s: IRQ 1 (SISL_MSI_SYNC_ERROR) map failed!\n",
1678 rc = cxl_map_afu_irq(ctx, 2, cxlflash_rrq_irq, afu,
1679 "SISL_MSI_RRQ_UPDATED");
1680 if (unlikely(rc <= 0)) {
1681 dev_err(dev, "%s: IRQ 2 (SISL_MSI_RRQ_UPDATED) map failed!\n",
1687 rc = cxl_map_afu_irq(ctx, 3, cxlflash_async_err_irq, afu,
1688 "SISL_MSI_ASYNC_ERROR");
1689 if (unlikely(rc <= 0)) {
1690 dev_err(dev, "%s: IRQ 3 (SISL_MSI_ASYNC_ERROR) map failed!\n",
1698 /* This performs the equivalent of the CXL_IOCTL_START_WORK.
1699 * The CXL_IOCTL_GET_PROCESS_ELEMENT is implicit in the process
1700 * element (pe) that is embedded in the context (ctx)
1702 rc = start_context(cfg);
1704 dev_err(dev, "%s: start context failed rc=%d\n", __func__, rc);
1705 level = UNMAP_THREE;
1709 pr_debug("%s: returning rc=%d\n", __func__, rc);
1712 term_mc(cfg, level);
1717 * init_afu() - setup as master context and start AFU
1718 * @cxlflash: Internal structure associated with the host.
1720 * This routine is a higher level of control for configuring the
1721 * AFU on probe and reset paths.
1725 * -ENOMEM when unable to map the AFU MMIO space
1726 * A failure value from internal services.
1728 static int init_afu(struct cxlflash_cfg *cfg)
1732 struct afu *afu = cfg->afu;
1733 struct device *dev = &cfg->dev->dev;
1735 cxl_perst_reloads_same_image(cfg->cxl_afu, true);
1739 dev_err(dev, "%s: call to init_mc failed, rc=%d!\n",
1744 /* Map the entire MMIO space of the AFU.
1746 afu->afu_map = cxl_psa_map(cfg->mcctx);
1747 if (!afu->afu_map) {
1749 term_mc(cfg, UNDO_START);
1750 dev_err(dev, "%s: call to cxl_psa_map failed!\n", __func__);
1754 /* No byte reverse on reading afu_version or string will be backwards */
1755 reg = readq(&afu->afu_map->global.regs.afu_version);
1756 memcpy(afu->version, ®, sizeof(reg));
1757 afu->interface_version =
1758 readq_be(&afu->afu_map->global.regs.interface_version);
1759 if ((afu->interface_version + 1) == 0) {
1760 pr_err("Back level AFU, please upgrade. AFU version %s "
1761 "interface version 0x%llx\n", afu->version,
1762 afu->interface_version);
1766 pr_debug("%s: afu version %s, interface version 0x%llX\n",
1767 __func__, afu->version, afu->interface_version);
1769 rc = start_afu(cfg);
1771 dev_err(dev, "%s: call to start_afu failed, rc=%d!\n",
1773 term_mc(cfg, UNDO_START);
1774 cxl_psa_unmap((void *)afu->afu_map);
1775 afu->afu_map = NULL;
1779 afu_err_intr_init(cfg->afu);
1780 atomic64_set(&afu->room, readq_be(&afu->host_map->cmd_room));
1782 /* Restore the LUN mappings */
1783 cxlflash_restore_luntable(cfg);
1785 pr_debug("%s: returning rc=%d\n", __func__, rc);
1790 * cxlflash_afu_sync() - builds and sends an AFU sync command
1791 * @afu: AFU associated with the host.
1792 * @ctx_hndl_u: Identifies context requesting sync.
1793 * @res_hndl_u: Identifies resource requesting sync.
1794 * @mode: Type of sync to issue (lightweight, heavyweight, global).
1796 * The AFU can only take 1 sync command at a time. This routine enforces this
1797 * limitation by using a mutex to provide exlusive access to the AFU during
1798 * the sync. This design point requires calling threads to not be on interrupt
1799 * context due to the possibility of sleeping during concurrent sync operations.
1801 * AFU sync operations are only necessary and allowed when the device is
1802 * operating normally. When not operating normally, sync requests can occur as
1803 * part of cleaning up resources associated with an adapter prior to removal.
1804 * In this scenario, these requests are simply ignored (safe due to the AFU
1811 int cxlflash_afu_sync(struct afu *afu, ctx_hndl_t ctx_hndl_u,
1812 res_hndl_t res_hndl_u, u8 mode)
1814 struct cxlflash_cfg *cfg = afu->parent;
1815 struct device *dev = &cfg->dev->dev;
1816 struct afu_cmd *cmd = NULL;
1819 static DEFINE_MUTEX(sync_active);
1821 if (cfg->state != STATE_NORMAL) {
1822 pr_debug("%s: Sync not required! (%u)\n", __func__, cfg->state);
1826 mutex_lock(&sync_active);
1828 cmd = cmd_checkout(afu);
1829 if (unlikely(!cmd)) {
1831 udelay(1000 * retry_cnt);
1832 if (retry_cnt < MC_RETRY_CNT)
1834 dev_err(dev, "%s: could not get a free command\n", __func__);
1839 pr_debug("%s: afu=%p cmd=%p %d\n", __func__, afu, cmd, ctx_hndl_u);
1841 memset(cmd->rcb.cdb, 0, sizeof(cmd->rcb.cdb));
1843 cmd->rcb.req_flags = SISL_REQ_FLAGS_AFU_CMD;
1844 cmd->rcb.port_sel = 0x0; /* NA */
1845 cmd->rcb.lun_id = 0x0; /* NA */
1846 cmd->rcb.data_len = 0x0;
1847 cmd->rcb.data_ea = 0x0;
1848 cmd->rcb.timeout = MC_AFU_SYNC_TIMEOUT;
1850 cmd->rcb.cdb[0] = 0xC0; /* AFU Sync */
1851 cmd->rcb.cdb[1] = mode;
1853 /* The cdb is aligned, no unaligned accessors required */
1854 *((u16 *)&cmd->rcb.cdb[2]) = swab16(ctx_hndl_u);
1855 *((u32 *)&cmd->rcb.cdb[4]) = swab32(res_hndl_u);
1857 rc = send_cmd(afu, cmd);
1861 wait_resp(afu, cmd);
1863 /* set on timeout */
1864 if (unlikely((cmd->sa.ioasc != 0) ||
1865 (cmd->sa.host_use_b[0] & B_ERROR)))
1868 mutex_unlock(&sync_active);
1871 pr_debug("%s: returning rc=%d\n", __func__, rc);
1876 * afu_reset() - resets the AFU
1877 * @cfg: Internal structure associated with the host.
1881 * A failure value from internal services.
1883 static int afu_reset(struct cxlflash_cfg *cfg)
1886 /* Stop the context before the reset. Since the context is
1887 * no longer available restart it after the reset is complete
1894 pr_debug("%s: returning rc=%d\n", __func__, rc);
1899 * cxlflash_eh_device_reset_handler() - reset a single LUN
1900 * @scp: SCSI command to send.
1903 * SUCCESS as defined in scsi/scsi.h
1904 * FAILED as defined in scsi/scsi.h
1906 static int cxlflash_eh_device_reset_handler(struct scsi_cmnd *scp)
1909 struct Scsi_Host *host = scp->device->host;
1910 struct cxlflash_cfg *cfg = (struct cxlflash_cfg *)host->hostdata;
1911 struct afu *afu = cfg->afu;
1914 pr_debug("%s: (scp=%p) %d/%d/%d/%llu "
1915 "cdb=(%08X-%08X-%08X-%08X)\n", __func__, scp,
1916 host->host_no, scp->device->channel,
1917 scp->device->id, scp->device->lun,
1918 get_unaligned_be32(&((u32 *)scp->cmnd)[0]),
1919 get_unaligned_be32(&((u32 *)scp->cmnd)[1]),
1920 get_unaligned_be32(&((u32 *)scp->cmnd)[2]),
1921 get_unaligned_be32(&((u32 *)scp->cmnd)[3]));
1924 switch (cfg->state) {
1926 rcr = send_tmf(afu, scp, TMF_LUN_RESET);
1931 wait_event(cfg->reset_waitq, cfg->state != STATE_RESET);
1938 pr_debug("%s: returning rc=%d\n", __func__, rc);
1943 * cxlflash_eh_host_reset_handler() - reset the host adapter
1944 * @scp: SCSI command from stack identifying host.
1947 * SUCCESS as defined in scsi/scsi.h
1948 * FAILED as defined in scsi/scsi.h
1950 static int cxlflash_eh_host_reset_handler(struct scsi_cmnd *scp)
1954 struct Scsi_Host *host = scp->device->host;
1955 struct cxlflash_cfg *cfg = (struct cxlflash_cfg *)host->hostdata;
1957 pr_debug("%s: (scp=%p) %d/%d/%d/%llu "
1958 "cdb=(%08X-%08X-%08X-%08X)\n", __func__, scp,
1959 host->host_no, scp->device->channel,
1960 scp->device->id, scp->device->lun,
1961 get_unaligned_be32(&((u32 *)scp->cmnd)[0]),
1962 get_unaligned_be32(&((u32 *)scp->cmnd)[1]),
1963 get_unaligned_be32(&((u32 *)scp->cmnd)[2]),
1964 get_unaligned_be32(&((u32 *)scp->cmnd)[3]));
1966 switch (cfg->state) {
1968 cfg->state = STATE_RESET;
1969 cxlflash_mark_contexts_error(cfg);
1970 rcr = afu_reset(cfg);
1973 cfg->state = STATE_FAILTERM;
1975 cfg->state = STATE_NORMAL;
1976 wake_up_all(&cfg->reset_waitq);
1979 wait_event(cfg->reset_waitq, cfg->state != STATE_RESET);
1980 if (cfg->state == STATE_NORMAL)
1988 pr_debug("%s: returning rc=%d\n", __func__, rc);
1993 * cxlflash_change_queue_depth() - change the queue depth for the device
1994 * @sdev: SCSI device destined for queue depth change.
1995 * @qdepth: Requested queue depth value to set.
1997 * The requested queue depth is capped to the maximum supported value.
1999 * Return: The actual queue depth set.
2001 static int cxlflash_change_queue_depth(struct scsi_device *sdev, int qdepth)
2004 if (qdepth > CXLFLASH_MAX_CMDS_PER_LUN)
2005 qdepth = CXLFLASH_MAX_CMDS_PER_LUN;
2007 scsi_change_queue_depth(sdev, qdepth);
2008 return sdev->queue_depth;
2012 * cxlflash_show_port_status() - queries and presents the current port status
2013 * @port: Desired port for status reporting.
2014 * @afu: AFU owning the specified port.
2015 * @buf: Buffer of length PAGE_SIZE to report back port status in ASCII.
2017 * Return: The size of the ASCII string returned in @buf.
2019 static ssize_t cxlflash_show_port_status(u32 port, struct afu *afu, char *buf)
2023 __be64 __iomem *fc_regs;
2025 if (port >= NUM_FC_PORTS)
2028 fc_regs = &afu->afu_map->global.fc_regs[port][0];
2029 status = readq_be(&fc_regs[FC_MTIP_STATUS / 8]);
2030 status &= FC_MTIP_STATUS_MASK;
2032 if (status == FC_MTIP_STATUS_ONLINE)
2033 disp_status = "online";
2034 else if (status == FC_MTIP_STATUS_OFFLINE)
2035 disp_status = "offline";
2037 disp_status = "unknown";
2039 return scnprintf(buf, PAGE_SIZE, "%s\n", disp_status);
2043 * port0_show() - queries and presents the current status of port 0
2044 * @dev: Generic device associated with the host owning the port.
2045 * @attr: Device attribute representing the port.
2046 * @buf: Buffer of length PAGE_SIZE to report back port status in ASCII.
2048 * Return: The size of the ASCII string returned in @buf.
2050 static ssize_t port0_show(struct device *dev,
2051 struct device_attribute *attr,
2054 struct Scsi_Host *shost = class_to_shost(dev);
2055 struct cxlflash_cfg *cfg = (struct cxlflash_cfg *)shost->hostdata;
2056 struct afu *afu = cfg->afu;
2058 return cxlflash_show_port_status(0, afu, buf);
2062 * port1_show() - queries and presents the current status of port 1
2063 * @dev: Generic device associated with the host owning the port.
2064 * @attr: Device attribute representing the port.
2065 * @buf: Buffer of length PAGE_SIZE to report back port status in ASCII.
2067 * Return: The size of the ASCII string returned in @buf.
2069 static ssize_t port1_show(struct device *dev,
2070 struct device_attribute *attr,
2073 struct Scsi_Host *shost = class_to_shost(dev);
2074 struct cxlflash_cfg *cfg = (struct cxlflash_cfg *)shost->hostdata;
2075 struct afu *afu = cfg->afu;
2077 return cxlflash_show_port_status(1, afu, buf);
2081 * lun_mode_show() - presents the current LUN mode of the host
2082 * @dev: Generic device associated with the host.
2083 * @attr: Device attribute representing the LUN mode.
2084 * @buf: Buffer of length PAGE_SIZE to report back the LUN mode in ASCII.
2086 * Return: The size of the ASCII string returned in @buf.
2088 static ssize_t lun_mode_show(struct device *dev,
2089 struct device_attribute *attr, char *buf)
2091 struct Scsi_Host *shost = class_to_shost(dev);
2092 struct cxlflash_cfg *cfg = (struct cxlflash_cfg *)shost->hostdata;
2093 struct afu *afu = cfg->afu;
2095 return scnprintf(buf, PAGE_SIZE, "%u\n", afu->internal_lun);
2099 * lun_mode_store() - sets the LUN mode of the host
2100 * @dev: Generic device associated with the host.
2101 * @attr: Device attribute representing the LUN mode.
2102 * @buf: Buffer of length PAGE_SIZE containing the LUN mode in ASCII.
2103 * @count: Length of data resizing in @buf.
2105 * The CXL Flash AFU supports a dummy LUN mode where the external
2106 * links and storage are not required. Space on the FPGA is used
2107 * to create 1 or 2 small LUNs which are presented to the system
2108 * as if they were a normal storage device. This feature is useful
2109 * during development and also provides manufacturing with a way
2110 * to test the AFU without an actual device.
2112 * 0 = external LUN[s] (default)
2113 * 1 = internal LUN (1 x 64K, 512B blocks, id 0)
2114 * 2 = internal LUN (1 x 64K, 4K blocks, id 0)
2115 * 3 = internal LUN (2 x 32K, 512B blocks, ids 0,1)
2116 * 4 = internal LUN (2 x 32K, 4K blocks, ids 0,1)
2118 * Return: The size of the ASCII string returned in @buf.
2120 static ssize_t lun_mode_store(struct device *dev,
2121 struct device_attribute *attr,
2122 const char *buf, size_t count)
2124 struct Scsi_Host *shost = class_to_shost(dev);
2125 struct cxlflash_cfg *cfg = (struct cxlflash_cfg *)shost->hostdata;
2126 struct afu *afu = cfg->afu;
2130 rc = kstrtouint(buf, 10, &lun_mode);
2131 if (!rc && (lun_mode < 5) && (lun_mode != afu->internal_lun)) {
2132 afu->internal_lun = lun_mode;
2134 scsi_scan_host(cfg->host);
2141 * ioctl_version_show() - presents the current ioctl version of the host
2142 * @dev: Generic device associated with the host.
2143 * @attr: Device attribute representing the ioctl version.
2144 * @buf: Buffer of length PAGE_SIZE to report back the ioctl version.
2146 * Return: The size of the ASCII string returned in @buf.
2148 static ssize_t ioctl_version_show(struct device *dev,
2149 struct device_attribute *attr, char *buf)
2151 return scnprintf(buf, PAGE_SIZE, "%u\n", DK_CXLFLASH_VERSION_0);
2155 * cxlflash_show_port_lun_table() - queries and presents the port LUN table
2156 * @port: Desired port for status reporting.
2157 * @afu: AFU owning the specified port.
2158 * @buf: Buffer of length PAGE_SIZE to report back port status in ASCII.
2160 * Return: The size of the ASCII string returned in @buf.
2162 static ssize_t cxlflash_show_port_lun_table(u32 port,
2168 __be64 __iomem *fc_port;
2170 if (port >= NUM_FC_PORTS)
2173 fc_port = &afu->afu_map->global.fc_port[port][0];
2175 for (i = 0; i < CXLFLASH_NUM_VLUNS; i++)
2176 bytes += scnprintf(buf + bytes, PAGE_SIZE - bytes,
2177 "%03d: %016llX\n", i, readq_be(&fc_port[i]));
2182 * port0_lun_table_show() - presents the current LUN table of port 0
2183 * @dev: Generic device associated with the host owning the port.
2184 * @attr: Device attribute representing the port.
2185 * @buf: Buffer of length PAGE_SIZE to report back port status in ASCII.
2187 * Return: The size of the ASCII string returned in @buf.
2189 static ssize_t port0_lun_table_show(struct device *dev,
2190 struct device_attribute *attr,
2193 struct Scsi_Host *shost = class_to_shost(dev);
2194 struct cxlflash_cfg *cfg = (struct cxlflash_cfg *)shost->hostdata;
2195 struct afu *afu = cfg->afu;
2197 return cxlflash_show_port_lun_table(0, afu, buf);
2201 * port1_lun_table_show() - presents the current LUN table of port 1
2202 * @dev: Generic device associated with the host owning the port.
2203 * @attr: Device attribute representing the port.
2204 * @buf: Buffer of length PAGE_SIZE to report back port status in ASCII.
2206 * Return: The size of the ASCII string returned in @buf.
2208 static ssize_t port1_lun_table_show(struct device *dev,
2209 struct device_attribute *attr,
2212 struct Scsi_Host *shost = class_to_shost(dev);
2213 struct cxlflash_cfg *cfg = (struct cxlflash_cfg *)shost->hostdata;
2214 struct afu *afu = cfg->afu;
2216 return cxlflash_show_port_lun_table(1, afu, buf);
2220 * mode_show() - presents the current mode of the device
2221 * @dev: Generic device associated with the device.
2222 * @attr: Device attribute representing the device mode.
2223 * @buf: Buffer of length PAGE_SIZE to report back the dev mode in ASCII.
2225 * Return: The size of the ASCII string returned in @buf.
2227 static ssize_t mode_show(struct device *dev,
2228 struct device_attribute *attr, char *buf)
2230 struct scsi_device *sdev = to_scsi_device(dev);
2232 return scnprintf(buf, PAGE_SIZE, "%s\n",
2233 sdev->hostdata ? "superpipe" : "legacy");
2239 static DEVICE_ATTR_RO(port0);
2240 static DEVICE_ATTR_RO(port1);
2241 static DEVICE_ATTR_RW(lun_mode);
2242 static DEVICE_ATTR_RO(ioctl_version);
2243 static DEVICE_ATTR_RO(port0_lun_table);
2244 static DEVICE_ATTR_RO(port1_lun_table);
2246 static struct device_attribute *cxlflash_host_attrs[] = {
2250 &dev_attr_ioctl_version,
2251 &dev_attr_port0_lun_table,
2252 &dev_attr_port1_lun_table,
2259 static DEVICE_ATTR_RO(mode);
2261 static struct device_attribute *cxlflash_dev_attrs[] = {
2269 static struct scsi_host_template driver_template = {
2270 .module = THIS_MODULE,
2271 .name = CXLFLASH_ADAPTER_NAME,
2272 .info = cxlflash_driver_info,
2273 .ioctl = cxlflash_ioctl,
2274 .proc_name = CXLFLASH_NAME,
2275 .queuecommand = cxlflash_queuecommand,
2276 .eh_device_reset_handler = cxlflash_eh_device_reset_handler,
2277 .eh_host_reset_handler = cxlflash_eh_host_reset_handler,
2278 .change_queue_depth = cxlflash_change_queue_depth,
2280 .can_queue = CXLFLASH_MAX_CMDS,
2282 .sg_tablesize = SG_NONE, /* No scatter gather support. */
2283 .max_sectors = CXLFLASH_MAX_SECTORS,
2284 .use_clustering = ENABLE_CLUSTERING,
2285 .shost_attrs = cxlflash_host_attrs,
2286 .sdev_attrs = cxlflash_dev_attrs,
2290 * Device dependent values
2292 static struct dev_dependent_vals dev_corsa_vals = { CXLFLASH_MAX_SECTORS };
2295 * PCI device binding table
2297 static struct pci_device_id cxlflash_pci_table[] = {
2298 {PCI_VENDOR_ID_IBM, PCI_DEVICE_ID_IBM_CORSA,
2299 PCI_ANY_ID, PCI_ANY_ID, 0, 0, (kernel_ulong_t)&dev_corsa_vals},
2303 MODULE_DEVICE_TABLE(pci, cxlflash_pci_table);
2306 * cxlflash_worker_thread() - work thread handler for the AFU
2307 * @work: Work structure contained within cxlflash associated with host.
2309 * Handles the following events:
2310 * - Link reset which cannot be performed on interrupt context due to
2311 * blocking up to a few seconds
2312 * - Read AFU command room
2315 static void cxlflash_worker_thread(struct work_struct *work)
2317 struct cxlflash_cfg *cfg = container_of(work, struct cxlflash_cfg,
2319 struct afu *afu = cfg->afu;
2320 struct device *dev = &cfg->dev->dev;
2324 /* Avoid MMIO if the device has failed */
2326 if (cfg->state != STATE_NORMAL)
2329 spin_lock_irqsave(cfg->host->host_lock, lock_flags);
2331 if (cfg->lr_state == LINK_RESET_REQUIRED) {
2332 port = cfg->lr_port;
2334 dev_err(dev, "%s: invalid port index %d\n",
2337 spin_unlock_irqrestore(cfg->host->host_lock,
2340 /* The reset can block... */
2341 afu_link_reset(afu, port,
2343 global.fc_regs[port][0]);
2344 spin_lock_irqsave(cfg->host->host_lock, lock_flags);
2347 cfg->lr_state = LINK_RESET_COMPLETE;
2350 if (afu->read_room) {
2351 atomic64_set(&afu->room, readq_be(&afu->host_map->cmd_room));
2352 afu->read_room = false;
2355 spin_unlock_irqrestore(cfg->host->host_lock, lock_flags);
2357 if (atomic_dec_if_positive(&cfg->scan_host_needed) >= 0)
2358 scsi_scan_host(cfg->host);
2362 * cxlflash_probe() - PCI entry point to add host
2363 * @pdev: PCI device associated with the host.
2364 * @dev_id: PCI device id associated with device.
2366 * Return: 0 on success / non-zero on failure
2368 static int cxlflash_probe(struct pci_dev *pdev,
2369 const struct pci_device_id *dev_id)
2371 struct Scsi_Host *host;
2372 struct cxlflash_cfg *cfg = NULL;
2373 struct device *phys_dev;
2374 struct dev_dependent_vals *ddv;
2377 dev_dbg(&pdev->dev, "%s: Found CXLFLASH with IRQ: %d\n",
2378 __func__, pdev->irq);
2380 ddv = (struct dev_dependent_vals *)dev_id->driver_data;
2381 driver_template.max_sectors = ddv->max_sectors;
2383 host = scsi_host_alloc(&driver_template, sizeof(struct cxlflash_cfg));
2385 dev_err(&pdev->dev, "%s: call to scsi_host_alloc failed!\n",
2391 host->max_id = CXLFLASH_MAX_NUM_TARGETS_PER_BUS;
2392 host->max_lun = CXLFLASH_MAX_NUM_LUNS_PER_TARGET;
2393 host->max_channel = NUM_FC_PORTS - 1;
2394 host->unique_id = host->host_no;
2395 host->max_cmd_len = CXLFLASH_MAX_CDB_LEN;
2397 cfg = (struct cxlflash_cfg *)host->hostdata;
2399 rc = alloc_mem(cfg);
2401 dev_err(&pdev->dev, "%s: call to scsi_host_alloc failed!\n",
2404 scsi_host_put(cfg->host);
2408 cfg->init_state = INIT_STATE_NONE;
2412 * The promoted LUNs move to the top of the LUN table. The rest stay
2413 * on the bottom half. The bottom half grows from the end
2414 * (index = 255), whereas the top half grows from the beginning
2417 cfg->promote_lun_index = 0;
2418 cfg->last_lun_index[0] = CXLFLASH_NUM_VLUNS/2 - 1;
2419 cfg->last_lun_index[1] = CXLFLASH_NUM_VLUNS/2 - 1;
2421 cfg->dev_id = (struct pci_device_id *)dev_id;
2424 init_waitqueue_head(&cfg->tmf_waitq);
2425 init_waitqueue_head(&cfg->reset_waitq);
2427 INIT_WORK(&cfg->work_q, cxlflash_worker_thread);
2428 cfg->lr_state = LINK_RESET_INVALID;
2430 mutex_init(&cfg->ctx_tbl_list_mutex);
2431 mutex_init(&cfg->ctx_recovery_mutex);
2432 init_rwsem(&cfg->ioctl_rwsem);
2433 INIT_LIST_HEAD(&cfg->ctx_err_recovery);
2434 INIT_LIST_HEAD(&cfg->lluns);
2436 pci_set_drvdata(pdev, cfg);
2438 /* Use the special service provided to look up the physical
2439 * PCI device, since we are called on the probe of the virtual
2440 * PCI host bus (vphb)
2442 phys_dev = cxl_get_phys_dev(pdev);
2443 if (!dev_is_pci(phys_dev)) {
2444 dev_err(&pdev->dev, "%s: not a pci dev\n", __func__);
2448 cfg->parent_dev = to_pci_dev(phys_dev);
2450 cfg->cxl_afu = cxl_pci_to_afu(pdev);
2454 dev_err(&pdev->dev, "%s: call to init_pci "
2455 "failed rc=%d!\n", __func__, rc);
2458 cfg->init_state = INIT_STATE_PCI;
2462 dev_err(&pdev->dev, "%s: call to init_afu "
2463 "failed rc=%d!\n", __func__, rc);
2466 cfg->init_state = INIT_STATE_AFU;
2469 rc = init_scsi(cfg);
2471 dev_err(&pdev->dev, "%s: call to init_scsi "
2472 "failed rc=%d!\n", __func__, rc);
2475 cfg->init_state = INIT_STATE_SCSI;
2478 pr_debug("%s: returning rc=%d\n", __func__, rc);
2482 cxlflash_remove(pdev);
2487 * drain_ioctls() - wait until all currently executing ioctls have completed
2488 * @cfg: Internal structure associated with the host.
2490 * Obtain write access to read/write semaphore that wraps ioctl
2491 * handling to 'drain' ioctls currently executing.
2493 static void drain_ioctls(struct cxlflash_cfg *cfg)
2495 down_write(&cfg->ioctl_rwsem);
2496 up_write(&cfg->ioctl_rwsem);
2500 * cxlflash_pci_error_detected() - called when a PCI error is detected
2501 * @pdev: PCI device struct.
2502 * @state: PCI channel state.
2504 * Return: PCI_ERS_RESULT_NEED_RESET or PCI_ERS_RESULT_DISCONNECT
2506 static pci_ers_result_t cxlflash_pci_error_detected(struct pci_dev *pdev,
2507 pci_channel_state_t state)
2510 struct cxlflash_cfg *cfg = pci_get_drvdata(pdev);
2511 struct device *dev = &cfg->dev->dev;
2513 dev_dbg(dev, "%s: pdev=%p state=%u\n", __func__, pdev, state);
2516 case pci_channel_io_frozen:
2517 cfg->state = STATE_RESET;
2518 scsi_block_requests(cfg->host);
2520 rc = cxlflash_mark_contexts_error(cfg);
2522 dev_err(dev, "%s: Failed to mark user contexts!(%d)\n",
2524 term_mc(cfg, UNDO_START);
2526 return PCI_ERS_RESULT_NEED_RESET;
2527 case pci_channel_io_perm_failure:
2528 cfg->state = STATE_FAILTERM;
2529 wake_up_all(&cfg->reset_waitq);
2530 scsi_unblock_requests(cfg->host);
2531 return PCI_ERS_RESULT_DISCONNECT;
2535 return PCI_ERS_RESULT_NEED_RESET;
2539 * cxlflash_pci_slot_reset() - called when PCI slot has been reset
2540 * @pdev: PCI device struct.
2542 * This routine is called by the pci error recovery code after the PCI
2543 * slot has been reset, just before we should resume normal operations.
2545 * Return: PCI_ERS_RESULT_RECOVERED or PCI_ERS_RESULT_DISCONNECT
2547 static pci_ers_result_t cxlflash_pci_slot_reset(struct pci_dev *pdev)
2550 struct cxlflash_cfg *cfg = pci_get_drvdata(pdev);
2551 struct device *dev = &cfg->dev->dev;
2553 dev_dbg(dev, "%s: pdev=%p\n", __func__, pdev);
2557 dev_err(dev, "%s: EEH recovery failed! (%d)\n", __func__, rc);
2558 return PCI_ERS_RESULT_DISCONNECT;
2561 return PCI_ERS_RESULT_RECOVERED;
2565 * cxlflash_pci_resume() - called when normal operation can resume
2566 * @pdev: PCI device struct
2568 static void cxlflash_pci_resume(struct pci_dev *pdev)
2570 struct cxlflash_cfg *cfg = pci_get_drvdata(pdev);
2571 struct device *dev = &cfg->dev->dev;
2573 dev_dbg(dev, "%s: pdev=%p\n", __func__, pdev);
2575 cfg->state = STATE_NORMAL;
2576 wake_up_all(&cfg->reset_waitq);
2577 scsi_unblock_requests(cfg->host);
2580 static const struct pci_error_handlers cxlflash_err_handler = {
2581 .error_detected = cxlflash_pci_error_detected,
2582 .slot_reset = cxlflash_pci_slot_reset,
2583 .resume = cxlflash_pci_resume,
2587 * PCI device structure
2589 static struct pci_driver cxlflash_driver = {
2590 .name = CXLFLASH_NAME,
2591 .id_table = cxlflash_pci_table,
2592 .probe = cxlflash_probe,
2593 .remove = cxlflash_remove,
2594 .err_handler = &cxlflash_err_handler,
2598 * init_cxlflash() - module entry point
2600 * Return: 0 on success / non-zero on failure
2602 static int __init init_cxlflash(void)
2604 pr_info("%s: IBM Power CXL Flash Adapter: %s\n",
2605 __func__, CXLFLASH_DRIVER_DATE);
2607 cxlflash_list_init();
2609 return pci_register_driver(&cxlflash_driver);
2613 * exit_cxlflash() - module exit point
2615 static void __exit exit_cxlflash(void)
2617 cxlflash_term_global_luns();
2618 cxlflash_free_errpage();
2620 pci_unregister_driver(&cxlflash_driver);
2623 module_init(init_cxlflash);
2624 module_exit(exit_cxlflash);