Merge tag 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mst/vhost
[cris-mirror.git] / drivers / block / mtip32xx / mtip32xx.c
blobb8af7352a18f53ce0d928645d2678e0925352193
1 /*
2 * Driver for the Micron P320 SSD
3 * Copyright (C) 2011 Micron Technology, Inc.
5 * Portions of this code were derived from works subjected to the
6 * following copyright:
7 * Copyright (C) 2009 Integrated Device Technology, Inc.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
21 #include <linux/pci.h>
22 #include <linux/interrupt.h>
23 #include <linux/ata.h>
24 #include <linux/delay.h>
25 #include <linux/hdreg.h>
26 #include <linux/uaccess.h>
27 #include <linux/random.h>
28 #include <linux/smp.h>
29 #include <linux/compat.h>
30 #include <linux/fs.h>
31 #include <linux/module.h>
32 #include <linux/genhd.h>
33 #include <linux/blkdev.h>
34 #include <linux/blk-mq.h>
35 #include <linux/bio.h>
36 #include <linux/dma-mapping.h>
37 #include <linux/idr.h>
38 #include <linux/kthread.h>
39 #include <../drivers/ata/ahci.h>
40 #include <linux/export.h>
41 #include <linux/debugfs.h>
42 #include <linux/prefetch.h>
43 #include "mtip32xx.h"
45 #define HW_CMD_SLOT_SZ (MTIP_MAX_COMMAND_SLOTS * 32)
47 /* DMA region containing RX Fis, Identify, RLE10, and SMART buffers */
48 #define AHCI_RX_FIS_SZ 0x100
49 #define AHCI_RX_FIS_OFFSET 0x0
50 #define AHCI_IDFY_SZ ATA_SECT_SIZE
51 #define AHCI_IDFY_OFFSET 0x400
52 #define AHCI_SECTBUF_SZ ATA_SECT_SIZE
53 #define AHCI_SECTBUF_OFFSET 0x800
54 #define AHCI_SMARTBUF_SZ ATA_SECT_SIZE
55 #define AHCI_SMARTBUF_OFFSET 0xC00
56 /* 0x100 + 0x200 + 0x200 + 0x200 is smaller than 4k but we pad it out */
57 #define BLOCK_DMA_ALLOC_SZ 4096
59 /* DMA region containing command table (should be 8192 bytes) */
60 #define AHCI_CMD_SLOT_SZ sizeof(struct mtip_cmd_hdr)
61 #define AHCI_CMD_TBL_SZ (MTIP_MAX_COMMAND_SLOTS * AHCI_CMD_SLOT_SZ)
62 #define AHCI_CMD_TBL_OFFSET 0x0
64 /* DMA region per command (contains header and SGL) */
65 #define AHCI_CMD_TBL_HDR_SZ 0x80
66 #define AHCI_CMD_TBL_HDR_OFFSET 0x0
67 #define AHCI_CMD_TBL_SGL_SZ (MTIP_MAX_SG * sizeof(struct mtip_cmd_sg))
68 #define AHCI_CMD_TBL_SGL_OFFSET AHCI_CMD_TBL_HDR_SZ
69 #define CMD_DMA_ALLOC_SZ (AHCI_CMD_TBL_SGL_SZ + AHCI_CMD_TBL_HDR_SZ)
72 #define HOST_CAP_NZDMA (1 << 19)
73 #define HOST_HSORG 0xFC
74 #define HSORG_DISABLE_SLOTGRP_INTR (1<<24)
75 #define HSORG_DISABLE_SLOTGRP_PXIS (1<<16)
76 #define HSORG_HWREV 0xFF00
77 #define HSORG_STYLE 0x8
78 #define HSORG_SLOTGROUPS 0x7
80 #define PORT_COMMAND_ISSUE 0x38
81 #define PORT_SDBV 0x7C
83 #define PORT_OFFSET 0x100
84 #define PORT_MEM_SIZE 0x80
86 #define PORT_IRQ_ERR \
87 (PORT_IRQ_HBUS_ERR | PORT_IRQ_IF_ERR | PORT_IRQ_CONNECT | \
88 PORT_IRQ_PHYRDY | PORT_IRQ_UNK_FIS | PORT_IRQ_BAD_PMP | \
89 PORT_IRQ_TF_ERR | PORT_IRQ_HBUS_DATA_ERR | PORT_IRQ_IF_NONFATAL | \
90 PORT_IRQ_OVERFLOW)
91 #define PORT_IRQ_LEGACY \
92 (PORT_IRQ_PIOS_FIS | PORT_IRQ_D2H_REG_FIS)
93 #define PORT_IRQ_HANDLED \
94 (PORT_IRQ_SDB_FIS | PORT_IRQ_LEGACY | \
95 PORT_IRQ_TF_ERR | PORT_IRQ_IF_ERR | \
96 PORT_IRQ_CONNECT | PORT_IRQ_PHYRDY)
97 #define DEF_PORT_IRQ \
98 (PORT_IRQ_ERR | PORT_IRQ_LEGACY | PORT_IRQ_SDB_FIS)
100 /* product numbers */
101 #define MTIP_PRODUCT_UNKNOWN 0x00
102 #define MTIP_PRODUCT_ASICFPGA 0x11
104 /* Device instance number, incremented each time a device is probed. */
105 static int instance;
107 static struct list_head online_list;
108 static struct list_head removing_list;
109 static spinlock_t dev_lock;
112 * Global variable used to hold the major block device number
113 * allocated in mtip_init().
115 static int mtip_major;
116 static struct dentry *dfs_parent;
117 static struct dentry *dfs_device_status;
119 static u32 cpu_use[NR_CPUS];
121 static DEFINE_SPINLOCK(rssd_index_lock);
122 static DEFINE_IDA(rssd_index_ida);
124 static int mtip_block_initialize(struct driver_data *dd);
126 #ifdef CONFIG_COMPAT
127 struct mtip_compat_ide_task_request_s {
128 __u8 io_ports[8];
129 __u8 hob_ports[8];
130 ide_reg_valid_t out_flags;
131 ide_reg_valid_t in_flags;
132 int data_phase;
133 int req_cmd;
134 compat_ulong_t out_size;
135 compat_ulong_t in_size;
137 #endif
140 * This function check_for_surprise_removal is called
141 * while card is removed from the system and it will
142 * read the vendor id from the configration space
144 * @pdev Pointer to the pci_dev structure.
146 * return value
147 * true if device removed, else false
149 static bool mtip_check_surprise_removal(struct pci_dev *pdev)
151 u16 vendor_id = 0;
152 struct driver_data *dd = pci_get_drvdata(pdev);
154 if (dd->sr)
155 return true;
157 /* Read the vendorID from the configuration space */
158 pci_read_config_word(pdev, 0x00, &vendor_id);
159 if (vendor_id == 0xFFFF) {
160 dd->sr = true;
161 if (dd->queue)
162 set_bit(QUEUE_FLAG_DEAD, &dd->queue->queue_flags);
163 else
164 dev_warn(&dd->pdev->dev,
165 "%s: dd->queue is NULL\n", __func__);
166 return true; /* device removed */
169 return false; /* device present */
172 /* we have to use runtime tag to setup command header */
173 static void mtip_init_cmd_header(struct request *rq)
175 struct driver_data *dd = rq->q->queuedata;
176 struct mtip_cmd *cmd = blk_mq_rq_to_pdu(rq);
178 /* Point the command headers at the command tables. */
179 cmd->command_header = dd->port->command_list +
180 (sizeof(struct mtip_cmd_hdr) * rq->tag);
181 cmd->command_header_dma = dd->port->command_list_dma +
182 (sizeof(struct mtip_cmd_hdr) * rq->tag);
184 if (test_bit(MTIP_PF_HOST_CAP_64, &dd->port->flags))
185 cmd->command_header->ctbau = __force_bit2int cpu_to_le32((cmd->command_dma >> 16) >> 16);
187 cmd->command_header->ctba = __force_bit2int cpu_to_le32(cmd->command_dma & 0xFFFFFFFF);
190 static struct mtip_cmd *mtip_get_int_command(struct driver_data *dd)
192 struct request *rq;
194 if (mtip_check_surprise_removal(dd->pdev))
195 return NULL;
197 rq = blk_mq_alloc_request(dd->queue, REQ_OP_DRV_IN, BLK_MQ_REQ_RESERVED);
198 if (IS_ERR(rq))
199 return NULL;
201 /* Internal cmd isn't submitted via .queue_rq */
202 mtip_init_cmd_header(rq);
204 return blk_mq_rq_to_pdu(rq);
207 static struct mtip_cmd *mtip_cmd_from_tag(struct driver_data *dd,
208 unsigned int tag)
210 struct blk_mq_hw_ctx *hctx = dd->queue->queue_hw_ctx[0];
212 return blk_mq_rq_to_pdu(blk_mq_tag_to_rq(hctx->tags, tag));
216 * Reset the HBA (without sleeping)
218 * @dd Pointer to the driver data structure.
220 * return value
221 * 0 The reset was successful.
222 * -1 The HBA Reset bit did not clear.
224 static int mtip_hba_reset(struct driver_data *dd)
226 unsigned long timeout;
228 /* Set the reset bit */
229 writel(HOST_RESET, dd->mmio + HOST_CTL);
231 /* Flush */
232 readl(dd->mmio + HOST_CTL);
235 * Spin for up to 10 seconds waiting for reset acknowledgement. Spec
236 * is 1 sec but in LUN failure conditions, up to 10 secs are required
238 timeout = jiffies + msecs_to_jiffies(10000);
239 do {
240 mdelay(10);
241 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))
242 return -1;
244 } while ((readl(dd->mmio + HOST_CTL) & HOST_RESET)
245 && time_before(jiffies, timeout));
247 if (readl(dd->mmio + HOST_CTL) & HOST_RESET)
248 return -1;
250 return 0;
254 * Issue a command to the hardware.
256 * Set the appropriate bit in the s_active and Command Issue hardware
257 * registers, causing hardware command processing to begin.
259 * @port Pointer to the port structure.
260 * @tag The tag of the command to be issued.
262 * return value
263 * None
265 static inline void mtip_issue_ncq_command(struct mtip_port *port, int tag)
267 int group = tag >> 5;
269 /* guard SACT and CI registers */
270 spin_lock(&port->cmd_issue_lock[group]);
271 writel((1 << MTIP_TAG_BIT(tag)),
272 port->s_active[MTIP_TAG_INDEX(tag)]);
273 writel((1 << MTIP_TAG_BIT(tag)),
274 port->cmd_issue[MTIP_TAG_INDEX(tag)]);
275 spin_unlock(&port->cmd_issue_lock[group]);
279 * Enable/disable the reception of FIS
281 * @port Pointer to the port data structure
282 * @enable 1 to enable, 0 to disable
284 * return value
285 * Previous state: 1 enabled, 0 disabled
287 static int mtip_enable_fis(struct mtip_port *port, int enable)
289 u32 tmp;
291 /* enable FIS reception */
292 tmp = readl(port->mmio + PORT_CMD);
293 if (enable)
294 writel(tmp | PORT_CMD_FIS_RX, port->mmio + PORT_CMD);
295 else
296 writel(tmp & ~PORT_CMD_FIS_RX, port->mmio + PORT_CMD);
298 /* Flush */
299 readl(port->mmio + PORT_CMD);
301 return (((tmp & PORT_CMD_FIS_RX) == PORT_CMD_FIS_RX));
305 * Enable/disable the DMA engine
307 * @port Pointer to the port data structure
308 * @enable 1 to enable, 0 to disable
310 * return value
311 * Previous state: 1 enabled, 0 disabled.
313 static int mtip_enable_engine(struct mtip_port *port, int enable)
315 u32 tmp;
317 /* enable FIS reception */
318 tmp = readl(port->mmio + PORT_CMD);
319 if (enable)
320 writel(tmp | PORT_CMD_START, port->mmio + PORT_CMD);
321 else
322 writel(tmp & ~PORT_CMD_START, port->mmio + PORT_CMD);
324 readl(port->mmio + PORT_CMD);
325 return (((tmp & PORT_CMD_START) == PORT_CMD_START));
329 * Enables the port DMA engine and FIS reception.
331 * return value
332 * None
334 static inline void mtip_start_port(struct mtip_port *port)
336 /* Enable FIS reception */
337 mtip_enable_fis(port, 1);
339 /* Enable the DMA engine */
340 mtip_enable_engine(port, 1);
344 * Deinitialize a port by disabling port interrupts, the DMA engine,
345 * and FIS reception.
347 * @port Pointer to the port structure
349 * return value
350 * None
352 static inline void mtip_deinit_port(struct mtip_port *port)
354 /* Disable interrupts on this port */
355 writel(0, port->mmio + PORT_IRQ_MASK);
357 /* Disable the DMA engine */
358 mtip_enable_engine(port, 0);
360 /* Disable FIS reception */
361 mtip_enable_fis(port, 0);
365 * Initialize a port.
367 * This function deinitializes the port by calling mtip_deinit_port() and
368 * then initializes it by setting the command header and RX FIS addresses,
369 * clearing the SError register and any pending port interrupts before
370 * re-enabling the default set of port interrupts.
372 * @port Pointer to the port structure.
374 * return value
375 * None
377 static void mtip_init_port(struct mtip_port *port)
379 int i;
380 mtip_deinit_port(port);
382 /* Program the command list base and FIS base addresses */
383 if (readl(port->dd->mmio + HOST_CAP) & HOST_CAP_64) {
384 writel((port->command_list_dma >> 16) >> 16,
385 port->mmio + PORT_LST_ADDR_HI);
386 writel((port->rxfis_dma >> 16) >> 16,
387 port->mmio + PORT_FIS_ADDR_HI);
388 set_bit(MTIP_PF_HOST_CAP_64, &port->flags);
391 writel(port->command_list_dma & 0xFFFFFFFF,
392 port->mmio + PORT_LST_ADDR);
393 writel(port->rxfis_dma & 0xFFFFFFFF, port->mmio + PORT_FIS_ADDR);
395 /* Clear SError */
396 writel(readl(port->mmio + PORT_SCR_ERR), port->mmio + PORT_SCR_ERR);
398 /* reset the completed registers.*/
399 for (i = 0; i < port->dd->slot_groups; i++)
400 writel(0xFFFFFFFF, port->completed[i]);
402 /* Clear any pending interrupts for this port */
403 writel(readl(port->mmio + PORT_IRQ_STAT), port->mmio + PORT_IRQ_STAT);
405 /* Clear any pending interrupts on the HBA. */
406 writel(readl(port->dd->mmio + HOST_IRQ_STAT),
407 port->dd->mmio + HOST_IRQ_STAT);
409 /* Enable port interrupts */
410 writel(DEF_PORT_IRQ, port->mmio + PORT_IRQ_MASK);
414 * Restart a port
416 * @port Pointer to the port data structure.
418 * return value
419 * None
421 static void mtip_restart_port(struct mtip_port *port)
423 unsigned long timeout;
425 /* Disable the DMA engine */
426 mtip_enable_engine(port, 0);
428 /* Chip quirk: wait up to 500ms for PxCMD.CR == 0 */
429 timeout = jiffies + msecs_to_jiffies(500);
430 while ((readl(port->mmio + PORT_CMD) & PORT_CMD_LIST_ON)
431 && time_before(jiffies, timeout))
434 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
435 return;
438 * Chip quirk: escalate to hba reset if
439 * PxCMD.CR not clear after 500 ms
441 if (readl(port->mmio + PORT_CMD) & PORT_CMD_LIST_ON) {
442 dev_warn(&port->dd->pdev->dev,
443 "PxCMD.CR not clear, escalating reset\n");
445 if (mtip_hba_reset(port->dd))
446 dev_err(&port->dd->pdev->dev,
447 "HBA reset escalation failed.\n");
449 /* 30 ms delay before com reset to quiesce chip */
450 mdelay(30);
453 dev_warn(&port->dd->pdev->dev, "Issuing COM reset\n");
455 /* Set PxSCTL.DET */
456 writel(readl(port->mmio + PORT_SCR_CTL) |
457 1, port->mmio + PORT_SCR_CTL);
458 readl(port->mmio + PORT_SCR_CTL);
460 /* Wait 1 ms to quiesce chip function */
461 timeout = jiffies + msecs_to_jiffies(1);
462 while (time_before(jiffies, timeout))
465 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
466 return;
468 /* Clear PxSCTL.DET */
469 writel(readl(port->mmio + PORT_SCR_CTL) & ~1,
470 port->mmio + PORT_SCR_CTL);
471 readl(port->mmio + PORT_SCR_CTL);
473 /* Wait 500 ms for bit 0 of PORT_SCR_STS to be set */
474 timeout = jiffies + msecs_to_jiffies(500);
475 while (((readl(port->mmio + PORT_SCR_STAT) & 0x01) == 0)
476 && time_before(jiffies, timeout))
479 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
480 return;
482 if ((readl(port->mmio + PORT_SCR_STAT) & 0x01) == 0)
483 dev_warn(&port->dd->pdev->dev,
484 "COM reset failed\n");
486 mtip_init_port(port);
487 mtip_start_port(port);
491 static int mtip_device_reset(struct driver_data *dd)
493 int rv = 0;
495 if (mtip_check_surprise_removal(dd->pdev))
496 return 0;
498 if (mtip_hba_reset(dd) < 0)
499 rv = -EFAULT;
501 mdelay(1);
502 mtip_init_port(dd->port);
503 mtip_start_port(dd->port);
505 /* Enable interrupts on the HBA. */
506 writel(readl(dd->mmio + HOST_CTL) | HOST_IRQ_EN,
507 dd->mmio + HOST_CTL);
508 return rv;
512 * Helper function for tag logging
514 static void print_tags(struct driver_data *dd,
515 char *msg,
516 unsigned long *tagbits,
517 int cnt)
519 unsigned char tagmap[128];
520 int group, tagmap_len = 0;
522 memset(tagmap, 0, sizeof(tagmap));
523 for (group = SLOTBITS_IN_LONGS; group > 0; group--)
524 tagmap_len += sprintf(tagmap + tagmap_len, "%016lX ",
525 tagbits[group-1]);
526 dev_warn(&dd->pdev->dev,
527 "%d command(s) %s: tagmap [%s]", cnt, msg, tagmap);
530 static int mtip_read_log_page(struct mtip_port *port, u8 page, u16 *buffer,
531 dma_addr_t buffer_dma, unsigned int sectors);
532 static int mtip_get_smart_attr(struct mtip_port *port, unsigned int id,
533 struct smart_attr *attrib);
535 static void mtip_complete_command(struct mtip_cmd *cmd, blk_status_t status)
537 struct request *req = blk_mq_rq_from_pdu(cmd);
539 cmd->status = status;
540 blk_mq_complete_request(req);
544 * Handle an error.
546 * @dd Pointer to the DRIVER_DATA structure.
548 * return value
549 * None
551 static void mtip_handle_tfe(struct driver_data *dd)
553 int group, tag, bit, reissue, rv;
554 struct mtip_port *port;
555 struct mtip_cmd *cmd;
556 u32 completed;
557 struct host_to_dev_fis *fis;
558 unsigned long tagaccum[SLOTBITS_IN_LONGS];
559 unsigned int cmd_cnt = 0;
560 unsigned char *buf;
561 char *fail_reason = NULL;
562 int fail_all_ncq_write = 0, fail_all_ncq_cmds = 0;
564 dev_warn(&dd->pdev->dev, "Taskfile error\n");
566 port = dd->port;
568 if (test_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags)) {
569 cmd = mtip_cmd_from_tag(dd, MTIP_TAG_INTERNAL);
570 dbg_printk(MTIP_DRV_NAME " TFE for the internal command\n");
571 mtip_complete_command(cmd, BLK_STS_IOERR);
572 return;
575 /* clear the tag accumulator */
576 memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
578 /* Loop through all the groups */
579 for (group = 0; group < dd->slot_groups; group++) {
580 completed = readl(port->completed[group]);
582 dev_warn(&dd->pdev->dev, "g=%u, comp=%x\n", group, completed);
584 /* clear completed status register in the hardware.*/
585 writel(completed, port->completed[group]);
587 /* Process successfully completed commands */
588 for (bit = 0; bit < 32 && completed; bit++) {
589 if (!(completed & (1<<bit)))
590 continue;
591 tag = (group << 5) + bit;
593 /* Skip the internal command slot */
594 if (tag == MTIP_TAG_INTERNAL)
595 continue;
597 cmd = mtip_cmd_from_tag(dd, tag);
598 mtip_complete_command(cmd, 0);
599 set_bit(tag, tagaccum);
600 cmd_cnt++;
604 print_tags(dd, "completed (TFE)", tagaccum, cmd_cnt);
606 /* Restart the port */
607 mdelay(20);
608 mtip_restart_port(port);
610 /* Trying to determine the cause of the error */
611 rv = mtip_read_log_page(dd->port, ATA_LOG_SATA_NCQ,
612 dd->port->log_buf,
613 dd->port->log_buf_dma, 1);
614 if (rv) {
615 dev_warn(&dd->pdev->dev,
616 "Error in READ LOG EXT (10h) command\n");
617 /* non-critical error, don't fail the load */
618 } else {
619 buf = (unsigned char *)dd->port->log_buf;
620 if (buf[259] & 0x1) {
621 dev_info(&dd->pdev->dev,
622 "Write protect bit is set.\n");
623 set_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag);
624 fail_all_ncq_write = 1;
625 fail_reason = "write protect";
627 if (buf[288] == 0xF7) {
628 dev_info(&dd->pdev->dev,
629 "Exceeded Tmax, drive in thermal shutdown.\n");
630 set_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag);
631 fail_all_ncq_cmds = 1;
632 fail_reason = "thermal shutdown";
634 if (buf[288] == 0xBF) {
635 set_bit(MTIP_DDF_REBUILD_FAILED_BIT, &dd->dd_flag);
636 dev_info(&dd->pdev->dev,
637 "Drive indicates rebuild has failed. Secure erase required.\n");
638 fail_all_ncq_cmds = 1;
639 fail_reason = "rebuild failed";
643 /* clear the tag accumulator */
644 memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
646 /* Loop through all the groups */
647 for (group = 0; group < dd->slot_groups; group++) {
648 for (bit = 0; bit < 32; bit++) {
649 reissue = 1;
650 tag = (group << 5) + bit;
651 cmd = mtip_cmd_from_tag(dd, tag);
653 fis = (struct host_to_dev_fis *)cmd->command;
655 /* Should re-issue? */
656 if (tag == MTIP_TAG_INTERNAL ||
657 fis->command == ATA_CMD_SET_FEATURES)
658 reissue = 0;
659 else {
660 if (fail_all_ncq_cmds ||
661 (fail_all_ncq_write &&
662 fis->command == ATA_CMD_FPDMA_WRITE)) {
663 dev_warn(&dd->pdev->dev,
664 " Fail: %s w/tag %d [%s].\n",
665 fis->command == ATA_CMD_FPDMA_WRITE ?
666 "write" : "read",
667 tag,
668 fail_reason != NULL ?
669 fail_reason : "unknown");
670 mtip_complete_command(cmd, BLK_STS_MEDIUM);
671 continue;
676 * First check if this command has
677 * exceeded its retries.
679 if (reissue && (cmd->retries-- > 0)) {
681 set_bit(tag, tagaccum);
683 /* Re-issue the command. */
684 mtip_issue_ncq_command(port, tag);
686 continue;
689 /* Retire a command that will not be reissued */
690 dev_warn(&port->dd->pdev->dev,
691 "retiring tag %d\n", tag);
693 mtip_complete_command(cmd, BLK_STS_IOERR);
696 print_tags(dd, "reissued (TFE)", tagaccum, cmd_cnt);
700 * Handle a set device bits interrupt
702 static inline void mtip_workq_sdbfx(struct mtip_port *port, int group,
703 u32 completed)
705 struct driver_data *dd = port->dd;
706 int tag, bit;
707 struct mtip_cmd *command;
709 if (!completed) {
710 WARN_ON_ONCE(!completed);
711 return;
713 /* clear completed status register in the hardware.*/
714 writel(completed, port->completed[group]);
716 /* Process completed commands. */
717 for (bit = 0; (bit < 32) && completed; bit++) {
718 if (completed & 0x01) {
719 tag = (group << 5) | bit;
721 /* skip internal command slot. */
722 if (unlikely(tag == MTIP_TAG_INTERNAL))
723 continue;
725 command = mtip_cmd_from_tag(dd, tag);
726 mtip_complete_command(command, 0);
728 completed >>= 1;
731 /* If last, re-enable interrupts */
732 if (atomic_dec_return(&dd->irq_workers_active) == 0)
733 writel(0xffffffff, dd->mmio + HOST_IRQ_STAT);
737 * Process legacy pio and d2h interrupts
739 static inline void mtip_process_legacy(struct driver_data *dd, u32 port_stat)
741 struct mtip_port *port = dd->port;
742 struct mtip_cmd *cmd = mtip_cmd_from_tag(dd, MTIP_TAG_INTERNAL);
744 if (test_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags) && cmd) {
745 int group = MTIP_TAG_INDEX(MTIP_TAG_INTERNAL);
746 int status = readl(port->cmd_issue[group]);
748 if (!(status & (1 << MTIP_TAG_BIT(MTIP_TAG_INTERNAL))))
749 mtip_complete_command(cmd, 0);
754 * Demux and handle errors
756 static inline void mtip_process_errors(struct driver_data *dd, u32 port_stat)
758 if (unlikely(port_stat & PORT_IRQ_CONNECT)) {
759 dev_warn(&dd->pdev->dev,
760 "Clearing PxSERR.DIAG.x\n");
761 writel((1 << 26), dd->port->mmio + PORT_SCR_ERR);
764 if (unlikely(port_stat & PORT_IRQ_PHYRDY)) {
765 dev_warn(&dd->pdev->dev,
766 "Clearing PxSERR.DIAG.n\n");
767 writel((1 << 16), dd->port->mmio + PORT_SCR_ERR);
770 if (unlikely(port_stat & ~PORT_IRQ_HANDLED)) {
771 dev_warn(&dd->pdev->dev,
772 "Port stat errors %x unhandled\n",
773 (port_stat & ~PORT_IRQ_HANDLED));
774 if (mtip_check_surprise_removal(dd->pdev))
775 return;
777 if (likely(port_stat & (PORT_IRQ_TF_ERR | PORT_IRQ_IF_ERR))) {
778 set_bit(MTIP_PF_EH_ACTIVE_BIT, &dd->port->flags);
779 wake_up_interruptible(&dd->port->svc_wait);
783 static inline irqreturn_t mtip_handle_irq(struct driver_data *data)
785 struct driver_data *dd = (struct driver_data *) data;
786 struct mtip_port *port = dd->port;
787 u32 hba_stat, port_stat;
788 int rv = IRQ_NONE;
789 int do_irq_enable = 1, i, workers;
790 struct mtip_work *twork;
792 hba_stat = readl(dd->mmio + HOST_IRQ_STAT);
793 if (hba_stat) {
794 rv = IRQ_HANDLED;
796 /* Acknowledge the interrupt status on the port.*/
797 port_stat = readl(port->mmio + PORT_IRQ_STAT);
798 if (unlikely(port_stat == 0xFFFFFFFF)) {
799 mtip_check_surprise_removal(dd->pdev);
800 return IRQ_HANDLED;
802 writel(port_stat, port->mmio + PORT_IRQ_STAT);
804 /* Demux port status */
805 if (likely(port_stat & PORT_IRQ_SDB_FIS)) {
806 do_irq_enable = 0;
807 WARN_ON_ONCE(atomic_read(&dd->irq_workers_active) != 0);
809 /* Start at 1: group zero is always local? */
810 for (i = 0, workers = 0; i < MTIP_MAX_SLOT_GROUPS;
811 i++) {
812 twork = &dd->work[i];
813 twork->completed = readl(port->completed[i]);
814 if (twork->completed)
815 workers++;
818 atomic_set(&dd->irq_workers_active, workers);
819 if (workers) {
820 for (i = 1; i < MTIP_MAX_SLOT_GROUPS; i++) {
821 twork = &dd->work[i];
822 if (twork->completed)
823 queue_work_on(
824 twork->cpu_binding,
825 dd->isr_workq,
826 &twork->work);
829 if (likely(dd->work[0].completed))
830 mtip_workq_sdbfx(port, 0,
831 dd->work[0].completed);
833 } else {
835 * Chip quirk: SDB interrupt but nothing
836 * to complete
838 do_irq_enable = 1;
842 if (unlikely(port_stat & PORT_IRQ_ERR)) {
843 if (unlikely(mtip_check_surprise_removal(dd->pdev))) {
844 /* don't proceed further */
845 return IRQ_HANDLED;
847 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
848 &dd->dd_flag))
849 return rv;
851 mtip_process_errors(dd, port_stat & PORT_IRQ_ERR);
854 if (unlikely(port_stat & PORT_IRQ_LEGACY))
855 mtip_process_legacy(dd, port_stat & PORT_IRQ_LEGACY);
858 /* acknowledge interrupt */
859 if (unlikely(do_irq_enable))
860 writel(hba_stat, dd->mmio + HOST_IRQ_STAT);
862 return rv;
866 * HBA interrupt subroutine.
868 * @irq IRQ number.
869 * @instance Pointer to the driver data structure.
871 * return value
872 * IRQ_HANDLED A HBA interrupt was pending and handled.
873 * IRQ_NONE This interrupt was not for the HBA.
875 static irqreturn_t mtip_irq_handler(int irq, void *instance)
877 struct driver_data *dd = instance;
879 return mtip_handle_irq(dd);
882 static void mtip_issue_non_ncq_command(struct mtip_port *port, int tag)
884 writel(1 << MTIP_TAG_BIT(tag), port->cmd_issue[MTIP_TAG_INDEX(tag)]);
887 static bool mtip_pause_ncq(struct mtip_port *port,
888 struct host_to_dev_fis *fis)
890 unsigned long task_file_data;
892 task_file_data = readl(port->mmio+PORT_TFDATA);
893 if ((task_file_data & 1))
894 return false;
896 if (fis->command == ATA_CMD_SEC_ERASE_PREP) {
897 port->ic_pause_timer = jiffies;
898 return true;
899 } else if ((fis->command == ATA_CMD_DOWNLOAD_MICRO) &&
900 (fis->features == 0x03)) {
901 set_bit(MTIP_PF_DM_ACTIVE_BIT, &port->flags);
902 port->ic_pause_timer = jiffies;
903 return true;
904 } else if ((fis->command == ATA_CMD_SEC_ERASE_UNIT) ||
905 ((fis->command == 0xFC) &&
906 (fis->features == 0x27 || fis->features == 0x72 ||
907 fis->features == 0x62 || fis->features == 0x26))) {
908 clear_bit(MTIP_DDF_SEC_LOCK_BIT, &port->dd->dd_flag);
909 clear_bit(MTIP_DDF_REBUILD_FAILED_BIT, &port->dd->dd_flag);
910 /* Com reset after secure erase or lowlevel format */
911 mtip_restart_port(port);
912 clear_bit(MTIP_PF_SE_ACTIVE_BIT, &port->flags);
913 return false;
916 return false;
919 static bool mtip_commands_active(struct mtip_port *port)
921 unsigned int active;
922 unsigned int n;
925 * Ignore s_active bit 0 of array element 0.
926 * This bit will always be set
928 active = readl(port->s_active[0]) & 0xFFFFFFFE;
929 for (n = 1; n < port->dd->slot_groups; n++)
930 active |= readl(port->s_active[n]);
932 return active != 0;
936 * Wait for port to quiesce
938 * @port Pointer to port data structure
939 * @timeout Max duration to wait (ms)
941 * return value
942 * 0 Success
943 * -EBUSY Commands still active
945 static int mtip_quiesce_io(struct mtip_port *port, unsigned long timeout)
947 unsigned long to;
948 bool active = true;
950 blk_mq_quiesce_queue(port->dd->queue);
952 to = jiffies + msecs_to_jiffies(timeout);
953 do {
954 if (test_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags) &&
955 test_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags)) {
956 msleep(20);
957 continue; /* svc thd is actively issuing commands */
960 msleep(100);
962 if (mtip_check_surprise_removal(port->dd->pdev))
963 goto err_fault;
965 active = mtip_commands_active(port);
966 if (!active)
967 break;
968 } while (time_before(jiffies, to));
970 blk_mq_unquiesce_queue(port->dd->queue);
971 return active ? -EBUSY : 0;
972 err_fault:
973 blk_mq_unquiesce_queue(port->dd->queue);
974 return -EFAULT;
977 struct mtip_int_cmd {
978 int fis_len;
979 dma_addr_t buffer;
980 int buf_len;
981 u32 opts;
985 * Execute an internal command and wait for the completion.
987 * @port Pointer to the port data structure.
988 * @fis Pointer to the FIS that describes the command.
989 * @fis_len Length in WORDS of the FIS.
990 * @buffer DMA accessible for command data.
991 * @buf_len Length, in bytes, of the data buffer.
992 * @opts Command header options, excluding the FIS length
993 * and the number of PRD entries.
994 * @timeout Time in ms to wait for the command to complete.
996 * return value
997 * 0 Command completed successfully.
998 * -EFAULT The buffer address is not correctly aligned.
999 * -EBUSY Internal command or other IO in progress.
1000 * -EAGAIN Time out waiting for command to complete.
1002 static int mtip_exec_internal_command(struct mtip_port *port,
1003 struct host_to_dev_fis *fis,
1004 int fis_len,
1005 dma_addr_t buffer,
1006 int buf_len,
1007 u32 opts,
1008 unsigned long timeout)
1010 struct mtip_cmd *int_cmd;
1011 struct driver_data *dd = port->dd;
1012 struct request *rq;
1013 struct mtip_int_cmd icmd = {
1014 .fis_len = fis_len,
1015 .buffer = buffer,
1016 .buf_len = buf_len,
1017 .opts = opts
1019 int rv = 0;
1021 /* Make sure the buffer is 8 byte aligned. This is asic specific. */
1022 if (buffer & 0x00000007) {
1023 dev_err(&dd->pdev->dev, "SG buffer is not 8 byte aligned\n");
1024 return -EFAULT;
1027 int_cmd = mtip_get_int_command(dd);
1028 if (!int_cmd) {
1029 dbg_printk(MTIP_DRV_NAME "Unable to allocate tag for PIO cmd\n");
1030 return -EFAULT;
1032 rq = blk_mq_rq_from_pdu(int_cmd);
1033 rq->special = &icmd;
1035 set_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
1037 if (fis->command == ATA_CMD_SEC_ERASE_PREP)
1038 set_bit(MTIP_PF_SE_ACTIVE_BIT, &port->flags);
1040 clear_bit(MTIP_PF_DM_ACTIVE_BIT, &port->flags);
1042 if (fis->command != ATA_CMD_STANDBYNOW1) {
1043 /* wait for io to complete if non atomic */
1044 if (mtip_quiesce_io(port, MTIP_QUIESCE_IO_TIMEOUT_MS) < 0) {
1045 dev_warn(&dd->pdev->dev, "Failed to quiesce IO\n");
1046 blk_mq_free_request(rq);
1047 clear_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
1048 wake_up_interruptible(&port->svc_wait);
1049 return -EBUSY;
1053 /* Copy the command to the command table */
1054 memcpy(int_cmd->command, fis, fis_len*4);
1056 rq->timeout = timeout;
1058 /* insert request and run queue */
1059 blk_execute_rq(rq->q, NULL, rq, true);
1061 if (int_cmd->status) {
1062 dev_err(&dd->pdev->dev, "Internal command [%02X] failed %d\n",
1063 fis->command, int_cmd->status);
1064 rv = -EIO;
1066 if (mtip_check_surprise_removal(dd->pdev) ||
1067 test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
1068 &dd->dd_flag)) {
1069 dev_err(&dd->pdev->dev,
1070 "Internal command [%02X] wait returned due to SR\n",
1071 fis->command);
1072 rv = -ENXIO;
1073 goto exec_ic_exit;
1075 mtip_device_reset(dd); /* recover from timeout issue */
1076 rv = -EAGAIN;
1077 goto exec_ic_exit;
1080 if (readl(port->cmd_issue[MTIP_TAG_INDEX(MTIP_TAG_INTERNAL)])
1081 & (1 << MTIP_TAG_BIT(MTIP_TAG_INTERNAL))) {
1082 rv = -ENXIO;
1083 if (!test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)) {
1084 mtip_device_reset(dd);
1085 rv = -EAGAIN;
1088 exec_ic_exit:
1089 /* Clear the allocated and active bits for the internal command. */
1090 blk_mq_free_request(rq);
1091 clear_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
1092 if (rv >= 0 && mtip_pause_ncq(port, fis)) {
1093 /* NCQ paused */
1094 return rv;
1096 wake_up_interruptible(&port->svc_wait);
1098 return rv;
1102 * Byte-swap ATA ID strings.
1104 * ATA identify data contains strings in byte-swapped 16-bit words.
1105 * They must be swapped (on all architectures) to be usable as C strings.
1106 * This function swaps bytes in-place.
1108 * @buf The buffer location of the string
1109 * @len The number of bytes to swap
1111 * return value
1112 * None
1114 static inline void ata_swap_string(u16 *buf, unsigned int len)
1116 int i;
1117 for (i = 0; i < (len/2); i++)
1118 be16_to_cpus(&buf[i]);
1121 static void mtip_set_timeout(struct driver_data *dd,
1122 struct host_to_dev_fis *fis,
1123 unsigned int *timeout, u8 erasemode)
1125 switch (fis->command) {
1126 case ATA_CMD_DOWNLOAD_MICRO:
1127 *timeout = 120000; /* 2 minutes */
1128 break;
1129 case ATA_CMD_SEC_ERASE_UNIT:
1130 case 0xFC:
1131 if (erasemode)
1132 *timeout = ((*(dd->port->identify + 90) * 2) * 60000);
1133 else
1134 *timeout = ((*(dd->port->identify + 89) * 2) * 60000);
1135 break;
1136 case ATA_CMD_STANDBYNOW1:
1137 *timeout = 120000; /* 2 minutes */
1138 break;
1139 case 0xF7:
1140 case 0xFA:
1141 *timeout = 60000; /* 60 seconds */
1142 break;
1143 case ATA_CMD_SMART:
1144 *timeout = 15000; /* 15 seconds */
1145 break;
1146 default:
1147 *timeout = MTIP_IOCTL_CMD_TIMEOUT_MS;
1148 break;
1153 * Request the device identity information.
1155 * If a user space buffer is not specified, i.e. is NULL, the
1156 * identify information is still read from the drive and placed
1157 * into the identify data buffer (@e port->identify) in the
1158 * port data structure.
1159 * When the identify buffer contains valid identify information @e
1160 * port->identify_valid is non-zero.
1162 * @port Pointer to the port structure.
1163 * @user_buffer A user space buffer where the identify data should be
1164 * copied.
1166 * return value
1167 * 0 Command completed successfully.
1168 * -EFAULT An error occurred while coping data to the user buffer.
1169 * -1 Command failed.
1171 static int mtip_get_identify(struct mtip_port *port, void __user *user_buffer)
1173 int rv = 0;
1174 struct host_to_dev_fis fis;
1176 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
1177 return -EFAULT;
1179 /* Build the FIS. */
1180 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1181 fis.type = 0x27;
1182 fis.opts = 1 << 7;
1183 fis.command = ATA_CMD_ID_ATA;
1185 /* Set the identify information as invalid. */
1186 port->identify_valid = 0;
1188 /* Clear the identify information. */
1189 memset(port->identify, 0, sizeof(u16) * ATA_ID_WORDS);
1191 /* Execute the command. */
1192 if (mtip_exec_internal_command(port,
1193 &fis,
1195 port->identify_dma,
1196 sizeof(u16) * ATA_ID_WORDS,
1198 MTIP_INT_CMD_TIMEOUT_MS)
1199 < 0) {
1200 rv = -1;
1201 goto out;
1205 * Perform any necessary byte-swapping. Yes, the kernel does in fact
1206 * perform field-sensitive swapping on the string fields.
1207 * See the kernel use of ata_id_string() for proof of this.
1209 #ifdef __LITTLE_ENDIAN
1210 ata_swap_string(port->identify + 27, 40); /* model string*/
1211 ata_swap_string(port->identify + 23, 8); /* firmware string*/
1212 ata_swap_string(port->identify + 10, 20); /* serial# string*/
1213 #else
1215 int i;
1216 for (i = 0; i < ATA_ID_WORDS; i++)
1217 port->identify[i] = le16_to_cpu(port->identify[i]);
1219 #endif
1221 /* Check security locked state */
1222 if (port->identify[128] & 0x4)
1223 set_bit(MTIP_DDF_SEC_LOCK_BIT, &port->dd->dd_flag);
1224 else
1225 clear_bit(MTIP_DDF_SEC_LOCK_BIT, &port->dd->dd_flag);
1227 #ifdef MTIP_TRIM /* Disabling TRIM support temporarily */
1228 /* Demux ID.DRAT & ID.RZAT to determine trim support */
1229 if (port->identify[69] & (1 << 14) && port->identify[69] & (1 << 5))
1230 port->dd->trim_supp = true;
1231 else
1232 #endif
1233 port->dd->trim_supp = false;
1235 /* Set the identify buffer as valid. */
1236 port->identify_valid = 1;
1238 if (user_buffer) {
1239 if (copy_to_user(
1240 user_buffer,
1241 port->identify,
1242 ATA_ID_WORDS * sizeof(u16))) {
1243 rv = -EFAULT;
1244 goto out;
1248 out:
1249 return rv;
1253 * Issue a standby immediate command to the device.
1255 * @port Pointer to the port structure.
1257 * return value
1258 * 0 Command was executed successfully.
1259 * -1 An error occurred while executing the command.
1261 static int mtip_standby_immediate(struct mtip_port *port)
1263 int rv;
1264 struct host_to_dev_fis fis;
1265 unsigned long start;
1266 unsigned int timeout;
1268 /* Build the FIS. */
1269 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1270 fis.type = 0x27;
1271 fis.opts = 1 << 7;
1272 fis.command = ATA_CMD_STANDBYNOW1;
1274 mtip_set_timeout(port->dd, &fis, &timeout, 0);
1276 start = jiffies;
1277 rv = mtip_exec_internal_command(port,
1278 &fis,
1283 timeout);
1284 dbg_printk(MTIP_DRV_NAME "Time taken to complete standby cmd: %d ms\n",
1285 jiffies_to_msecs(jiffies - start));
1286 if (rv)
1287 dev_warn(&port->dd->pdev->dev,
1288 "STANDBY IMMEDIATE command failed.\n");
1290 return rv;
1294 * Issue a READ LOG EXT command to the device.
1296 * @port pointer to the port structure.
1297 * @page page number to fetch
1298 * @buffer pointer to buffer
1299 * @buffer_dma dma address corresponding to @buffer
1300 * @sectors page length to fetch, in sectors
1302 * return value
1303 * @rv return value from mtip_exec_internal_command()
1305 static int mtip_read_log_page(struct mtip_port *port, u8 page, u16 *buffer,
1306 dma_addr_t buffer_dma, unsigned int sectors)
1308 struct host_to_dev_fis fis;
1310 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1311 fis.type = 0x27;
1312 fis.opts = 1 << 7;
1313 fis.command = ATA_CMD_READ_LOG_EXT;
1314 fis.sect_count = sectors & 0xFF;
1315 fis.sect_cnt_ex = (sectors >> 8) & 0xFF;
1316 fis.lba_low = page;
1317 fis.lba_mid = 0;
1318 fis.device = ATA_DEVICE_OBS;
1320 memset(buffer, 0, sectors * ATA_SECT_SIZE);
1322 return mtip_exec_internal_command(port,
1323 &fis,
1325 buffer_dma,
1326 sectors * ATA_SECT_SIZE,
1328 MTIP_INT_CMD_TIMEOUT_MS);
1332 * Issue a SMART READ DATA command to the device.
1334 * @port pointer to the port structure.
1335 * @buffer pointer to buffer
1336 * @buffer_dma dma address corresponding to @buffer
1338 * return value
1339 * @rv return value from mtip_exec_internal_command()
1341 static int mtip_get_smart_data(struct mtip_port *port, u8 *buffer,
1342 dma_addr_t buffer_dma)
1344 struct host_to_dev_fis fis;
1346 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1347 fis.type = 0x27;
1348 fis.opts = 1 << 7;
1349 fis.command = ATA_CMD_SMART;
1350 fis.features = 0xD0;
1351 fis.sect_count = 1;
1352 fis.lba_mid = 0x4F;
1353 fis.lba_hi = 0xC2;
1354 fis.device = ATA_DEVICE_OBS;
1356 return mtip_exec_internal_command(port,
1357 &fis,
1359 buffer_dma,
1360 ATA_SECT_SIZE,
1362 15000);
1366 * Get the value of a smart attribute
1368 * @port pointer to the port structure
1369 * @id attribute number
1370 * @attrib pointer to return attrib information corresponding to @id
1372 * return value
1373 * -EINVAL NULL buffer passed or unsupported attribute @id.
1374 * -EPERM Identify data not valid, SMART not supported or not enabled
1376 static int mtip_get_smart_attr(struct mtip_port *port, unsigned int id,
1377 struct smart_attr *attrib)
1379 int rv, i;
1380 struct smart_attr *pattr;
1382 if (!attrib)
1383 return -EINVAL;
1385 if (!port->identify_valid) {
1386 dev_warn(&port->dd->pdev->dev, "IDENTIFY DATA not valid\n");
1387 return -EPERM;
1389 if (!(port->identify[82] & 0x1)) {
1390 dev_warn(&port->dd->pdev->dev, "SMART not supported\n");
1391 return -EPERM;
1393 if (!(port->identify[85] & 0x1)) {
1394 dev_warn(&port->dd->pdev->dev, "SMART not enabled\n");
1395 return -EPERM;
1398 memset(port->smart_buf, 0, ATA_SECT_SIZE);
1399 rv = mtip_get_smart_data(port, port->smart_buf, port->smart_buf_dma);
1400 if (rv) {
1401 dev_warn(&port->dd->pdev->dev, "Failed to ge SMART data\n");
1402 return rv;
1405 pattr = (struct smart_attr *)(port->smart_buf + 2);
1406 for (i = 0; i < 29; i++, pattr++)
1407 if (pattr->attr_id == id) {
1408 memcpy(attrib, pattr, sizeof(struct smart_attr));
1409 break;
1412 if (i == 29) {
1413 dev_warn(&port->dd->pdev->dev,
1414 "Query for invalid SMART attribute ID\n");
1415 rv = -EINVAL;
1418 return rv;
1422 * Trim unused sectors
1424 * @dd pointer to driver_data structure
1425 * @lba starting lba
1426 * @len # of 512b sectors to trim
1428 * return value
1429 * -ENOMEM Out of dma memory
1430 * -EINVAL Invalid parameters passed in, trim not supported
1431 * -EIO Error submitting trim request to hw
1433 static int mtip_send_trim(struct driver_data *dd, unsigned int lba,
1434 unsigned int len)
1436 int i, rv = 0;
1437 u64 tlba, tlen, sect_left;
1438 struct mtip_trim_entry *buf;
1439 dma_addr_t dma_addr;
1440 struct host_to_dev_fis fis;
1442 if (!len || dd->trim_supp == false)
1443 return -EINVAL;
1445 /* Trim request too big */
1446 WARN_ON(len > (MTIP_MAX_TRIM_ENTRY_LEN * MTIP_MAX_TRIM_ENTRIES));
1448 /* Trim request not aligned on 4k boundary */
1449 WARN_ON(len % 8 != 0);
1451 /* Warn if vu_trim structure is too big */
1452 WARN_ON(sizeof(struct mtip_trim) > ATA_SECT_SIZE);
1454 /* Allocate a DMA buffer for the trim structure */
1455 buf = dmam_alloc_coherent(&dd->pdev->dev, ATA_SECT_SIZE, &dma_addr,
1456 GFP_KERNEL);
1457 if (!buf)
1458 return -ENOMEM;
1459 memset(buf, 0, ATA_SECT_SIZE);
1461 for (i = 0, sect_left = len, tlba = lba;
1462 i < MTIP_MAX_TRIM_ENTRIES && sect_left;
1463 i++) {
1464 tlen = (sect_left >= MTIP_MAX_TRIM_ENTRY_LEN ?
1465 MTIP_MAX_TRIM_ENTRY_LEN :
1466 sect_left);
1467 buf[i].lba = __force_bit2int cpu_to_le32(tlba);
1468 buf[i].range = __force_bit2int cpu_to_le16(tlen);
1469 tlba += tlen;
1470 sect_left -= tlen;
1472 WARN_ON(sect_left != 0);
1474 /* Build the fis */
1475 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1476 fis.type = 0x27;
1477 fis.opts = 1 << 7;
1478 fis.command = 0xfb;
1479 fis.features = 0x60;
1480 fis.sect_count = 1;
1481 fis.device = ATA_DEVICE_OBS;
1483 if (mtip_exec_internal_command(dd->port,
1484 &fis,
1486 dma_addr,
1487 ATA_SECT_SIZE,
1489 MTIP_TRIM_TIMEOUT_MS) < 0)
1490 rv = -EIO;
1492 dmam_free_coherent(&dd->pdev->dev, ATA_SECT_SIZE, buf, dma_addr);
1493 return rv;
1497 * Get the drive capacity.
1499 * @dd Pointer to the device data structure.
1500 * @sectors Pointer to the variable that will receive the sector count.
1502 * return value
1503 * 1 Capacity was returned successfully.
1504 * 0 The identify information is invalid.
1506 static bool mtip_hw_get_capacity(struct driver_data *dd, sector_t *sectors)
1508 struct mtip_port *port = dd->port;
1509 u64 total, raw0, raw1, raw2, raw3;
1510 raw0 = port->identify[100];
1511 raw1 = port->identify[101];
1512 raw2 = port->identify[102];
1513 raw3 = port->identify[103];
1514 total = raw0 | raw1<<16 | raw2<<32 | raw3<<48;
1515 *sectors = total;
1516 return (bool) !!port->identify_valid;
1520 * Display the identify command data.
1522 * @port Pointer to the port data structure.
1524 * return value
1525 * None
1527 static void mtip_dump_identify(struct mtip_port *port)
1529 sector_t sectors;
1530 unsigned short revid;
1531 char cbuf[42];
1533 if (!port->identify_valid)
1534 return;
1536 strlcpy(cbuf, (char *)(port->identify+10), 21);
1537 dev_info(&port->dd->pdev->dev,
1538 "Serial No.: %s\n", cbuf);
1540 strlcpy(cbuf, (char *)(port->identify+23), 9);
1541 dev_info(&port->dd->pdev->dev,
1542 "Firmware Ver.: %s\n", cbuf);
1544 strlcpy(cbuf, (char *)(port->identify+27), 41);
1545 dev_info(&port->dd->pdev->dev, "Model: %s\n", cbuf);
1547 dev_info(&port->dd->pdev->dev, "Security: %04x %s\n",
1548 port->identify[128],
1549 port->identify[128] & 0x4 ? "(LOCKED)" : "");
1551 if (mtip_hw_get_capacity(port->dd, &sectors))
1552 dev_info(&port->dd->pdev->dev,
1553 "Capacity: %llu sectors (%llu MB)\n",
1554 (u64)sectors,
1555 ((u64)sectors) * ATA_SECT_SIZE >> 20);
1557 pci_read_config_word(port->dd->pdev, PCI_REVISION_ID, &revid);
1558 switch (revid & 0xFF) {
1559 case 0x1:
1560 strlcpy(cbuf, "A0", 3);
1561 break;
1562 case 0x3:
1563 strlcpy(cbuf, "A2", 3);
1564 break;
1565 default:
1566 strlcpy(cbuf, "?", 2);
1567 break;
1569 dev_info(&port->dd->pdev->dev,
1570 "Card Type: %s\n", cbuf);
1574 * Map the commands scatter list into the command table.
1576 * @command Pointer to the command.
1577 * @nents Number of scatter list entries.
1579 * return value
1580 * None
1582 static inline void fill_command_sg(struct driver_data *dd,
1583 struct mtip_cmd *command,
1584 int nents)
1586 int n;
1587 unsigned int dma_len;
1588 struct mtip_cmd_sg *command_sg;
1589 struct scatterlist *sg = command->sg;
1591 command_sg = command->command + AHCI_CMD_TBL_HDR_SZ;
1593 for (n = 0; n < nents; n++) {
1594 dma_len = sg_dma_len(sg);
1595 if (dma_len > 0x400000)
1596 dev_err(&dd->pdev->dev,
1597 "DMA segment length truncated\n");
1598 command_sg->info = __force_bit2int
1599 cpu_to_le32((dma_len-1) & 0x3FFFFF);
1600 command_sg->dba = __force_bit2int
1601 cpu_to_le32(sg_dma_address(sg));
1602 command_sg->dba_upper = __force_bit2int
1603 cpu_to_le32((sg_dma_address(sg) >> 16) >> 16);
1604 command_sg++;
1605 sg++;
1610 * @brief Execute a drive command.
1612 * return value 0 The command completed successfully.
1613 * return value -1 An error occurred while executing the command.
1615 static int exec_drive_task(struct mtip_port *port, u8 *command)
1617 struct host_to_dev_fis fis;
1618 struct host_to_dev_fis *reply = (port->rxfis + RX_FIS_D2H_REG);
1619 unsigned int to;
1621 /* Build the FIS. */
1622 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1623 fis.type = 0x27;
1624 fis.opts = 1 << 7;
1625 fis.command = command[0];
1626 fis.features = command[1];
1627 fis.sect_count = command[2];
1628 fis.sector = command[3];
1629 fis.cyl_low = command[4];
1630 fis.cyl_hi = command[5];
1631 fis.device = command[6] & ~0x10; /* Clear the dev bit*/
1633 mtip_set_timeout(port->dd, &fis, &to, 0);
1635 dbg_printk(MTIP_DRV_NAME " %s: User Command: cmd %x, feat %x, nsect %x, sect %x, lcyl %x, hcyl %x, sel %x\n",
1636 __func__,
1637 command[0],
1638 command[1],
1639 command[2],
1640 command[3],
1641 command[4],
1642 command[5],
1643 command[6]);
1645 /* Execute the command. */
1646 if (mtip_exec_internal_command(port,
1647 &fis,
1652 to) < 0) {
1653 return -1;
1656 command[0] = reply->command; /* Status*/
1657 command[1] = reply->features; /* Error*/
1658 command[4] = reply->cyl_low;
1659 command[5] = reply->cyl_hi;
1661 dbg_printk(MTIP_DRV_NAME " %s: Completion Status: stat %x, err %x , cyl_lo %x cyl_hi %x\n",
1662 __func__,
1663 command[0],
1664 command[1],
1665 command[4],
1666 command[5]);
1668 return 0;
1672 * @brief Execute a drive command.
1674 * @param port Pointer to the port data structure.
1675 * @param command Pointer to the user specified command parameters.
1676 * @param user_buffer Pointer to the user space buffer where read sector
1677 * data should be copied.
1679 * return value 0 The command completed successfully.
1680 * return value -EFAULT An error occurred while copying the completion
1681 * data to the user space buffer.
1682 * return value -1 An error occurred while executing the command.
1684 static int exec_drive_command(struct mtip_port *port, u8 *command,
1685 void __user *user_buffer)
1687 struct host_to_dev_fis fis;
1688 struct host_to_dev_fis *reply;
1689 u8 *buf = NULL;
1690 dma_addr_t dma_addr = 0;
1691 int rv = 0, xfer_sz = command[3];
1692 unsigned int to;
1694 if (xfer_sz) {
1695 if (!user_buffer)
1696 return -EFAULT;
1698 buf = dmam_alloc_coherent(&port->dd->pdev->dev,
1699 ATA_SECT_SIZE * xfer_sz,
1700 &dma_addr,
1701 GFP_KERNEL);
1702 if (!buf) {
1703 dev_err(&port->dd->pdev->dev,
1704 "Memory allocation failed (%d bytes)\n",
1705 ATA_SECT_SIZE * xfer_sz);
1706 return -ENOMEM;
1708 memset(buf, 0, ATA_SECT_SIZE * xfer_sz);
1711 /* Build the FIS. */
1712 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1713 fis.type = 0x27;
1714 fis.opts = 1 << 7;
1715 fis.command = command[0];
1716 fis.features = command[2];
1717 fis.sect_count = command[3];
1718 if (fis.command == ATA_CMD_SMART) {
1719 fis.sector = command[1];
1720 fis.cyl_low = 0x4F;
1721 fis.cyl_hi = 0xC2;
1724 mtip_set_timeout(port->dd, &fis, &to, 0);
1726 if (xfer_sz)
1727 reply = (port->rxfis + RX_FIS_PIO_SETUP);
1728 else
1729 reply = (port->rxfis + RX_FIS_D2H_REG);
1731 dbg_printk(MTIP_DRV_NAME
1732 " %s: User Command: cmd %x, sect %x, "
1733 "feat %x, sectcnt %x\n",
1734 __func__,
1735 command[0],
1736 command[1],
1737 command[2],
1738 command[3]);
1740 /* Execute the command. */
1741 if (mtip_exec_internal_command(port,
1742 &fis,
1744 (xfer_sz ? dma_addr : 0),
1745 (xfer_sz ? ATA_SECT_SIZE * xfer_sz : 0),
1748 < 0) {
1749 rv = -EFAULT;
1750 goto exit_drive_command;
1753 /* Collect the completion status. */
1754 command[0] = reply->command; /* Status*/
1755 command[1] = reply->features; /* Error*/
1756 command[2] = reply->sect_count;
1758 dbg_printk(MTIP_DRV_NAME
1759 " %s: Completion Status: stat %x, "
1760 "err %x, nsect %x\n",
1761 __func__,
1762 command[0],
1763 command[1],
1764 command[2]);
1766 if (xfer_sz) {
1767 if (copy_to_user(user_buffer,
1768 buf,
1769 ATA_SECT_SIZE * command[3])) {
1770 rv = -EFAULT;
1771 goto exit_drive_command;
1774 exit_drive_command:
1775 if (buf)
1776 dmam_free_coherent(&port->dd->pdev->dev,
1777 ATA_SECT_SIZE * xfer_sz, buf, dma_addr);
1778 return rv;
1782 * Indicates whether a command has a single sector payload.
1784 * @command passed to the device to perform the certain event.
1785 * @features passed to the device to perform the certain event.
1787 * return value
1788 * 1 command is one that always has a single sector payload,
1789 * regardless of the value in the Sector Count field.
1790 * 0 otherwise
1793 static unsigned int implicit_sector(unsigned char command,
1794 unsigned char features)
1796 unsigned int rv = 0;
1798 /* list of commands that have an implicit sector count of 1 */
1799 switch (command) {
1800 case ATA_CMD_SEC_SET_PASS:
1801 case ATA_CMD_SEC_UNLOCK:
1802 case ATA_CMD_SEC_ERASE_PREP:
1803 case ATA_CMD_SEC_ERASE_UNIT:
1804 case ATA_CMD_SEC_FREEZE_LOCK:
1805 case ATA_CMD_SEC_DISABLE_PASS:
1806 case ATA_CMD_PMP_READ:
1807 case ATA_CMD_PMP_WRITE:
1808 rv = 1;
1809 break;
1810 case ATA_CMD_SET_MAX:
1811 if (features == ATA_SET_MAX_UNLOCK)
1812 rv = 1;
1813 break;
1814 case ATA_CMD_SMART:
1815 if ((features == ATA_SMART_READ_VALUES) ||
1816 (features == ATA_SMART_READ_THRESHOLDS))
1817 rv = 1;
1818 break;
1819 case ATA_CMD_CONF_OVERLAY:
1820 if ((features == ATA_DCO_IDENTIFY) ||
1821 (features == ATA_DCO_SET))
1822 rv = 1;
1823 break;
1825 return rv;
1829 * Executes a taskfile
1830 * See ide_taskfile_ioctl() for derivation
1832 static int exec_drive_taskfile(struct driver_data *dd,
1833 void __user *buf,
1834 ide_task_request_t *req_task,
1835 int outtotal)
1837 struct host_to_dev_fis fis;
1838 struct host_to_dev_fis *reply;
1839 u8 *outbuf = NULL;
1840 u8 *inbuf = NULL;
1841 dma_addr_t outbuf_dma = 0;
1842 dma_addr_t inbuf_dma = 0;
1843 dma_addr_t dma_buffer = 0;
1844 int err = 0;
1845 unsigned int taskin = 0;
1846 unsigned int taskout = 0;
1847 u8 nsect = 0;
1848 unsigned int timeout;
1849 unsigned int force_single_sector;
1850 unsigned int transfer_size;
1851 unsigned long task_file_data;
1852 int intotal = outtotal + req_task->out_size;
1853 int erasemode = 0;
1855 taskout = req_task->out_size;
1856 taskin = req_task->in_size;
1857 /* 130560 = 512 * 0xFF*/
1858 if (taskin > 130560 || taskout > 130560)
1859 return -EINVAL;
1861 if (taskout) {
1862 outbuf = memdup_user(buf + outtotal, taskout);
1863 if (IS_ERR(outbuf))
1864 return PTR_ERR(outbuf);
1866 outbuf_dma = pci_map_single(dd->pdev,
1867 outbuf,
1868 taskout,
1869 DMA_TO_DEVICE);
1870 if (pci_dma_mapping_error(dd->pdev, outbuf_dma)) {
1871 err = -ENOMEM;
1872 goto abort;
1874 dma_buffer = outbuf_dma;
1877 if (taskin) {
1878 inbuf = memdup_user(buf + intotal, taskin);
1879 if (IS_ERR(inbuf)) {
1880 err = PTR_ERR(inbuf);
1881 inbuf = NULL;
1882 goto abort;
1884 inbuf_dma = pci_map_single(dd->pdev,
1885 inbuf,
1886 taskin, DMA_FROM_DEVICE);
1887 if (pci_dma_mapping_error(dd->pdev, inbuf_dma)) {
1888 err = -ENOMEM;
1889 goto abort;
1891 dma_buffer = inbuf_dma;
1894 /* only supports PIO and non-data commands from this ioctl. */
1895 switch (req_task->data_phase) {
1896 case TASKFILE_OUT:
1897 nsect = taskout / ATA_SECT_SIZE;
1898 reply = (dd->port->rxfis + RX_FIS_PIO_SETUP);
1899 break;
1900 case TASKFILE_IN:
1901 reply = (dd->port->rxfis + RX_FIS_PIO_SETUP);
1902 break;
1903 case TASKFILE_NO_DATA:
1904 reply = (dd->port->rxfis + RX_FIS_D2H_REG);
1905 break;
1906 default:
1907 err = -EINVAL;
1908 goto abort;
1911 /* Build the FIS. */
1912 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1914 fis.type = 0x27;
1915 fis.opts = 1 << 7;
1916 fis.command = req_task->io_ports[7];
1917 fis.features = req_task->io_ports[1];
1918 fis.sect_count = req_task->io_ports[2];
1919 fis.lba_low = req_task->io_ports[3];
1920 fis.lba_mid = req_task->io_ports[4];
1921 fis.lba_hi = req_task->io_ports[5];
1922 /* Clear the dev bit*/
1923 fis.device = req_task->io_ports[6] & ~0x10;
1925 if ((req_task->in_flags.all == 0) && (req_task->out_flags.all & 1)) {
1926 req_task->in_flags.all =
1927 IDE_TASKFILE_STD_IN_FLAGS |
1928 (IDE_HOB_STD_IN_FLAGS << 8);
1929 fis.lba_low_ex = req_task->hob_ports[3];
1930 fis.lba_mid_ex = req_task->hob_ports[4];
1931 fis.lba_hi_ex = req_task->hob_ports[5];
1932 fis.features_ex = req_task->hob_ports[1];
1933 fis.sect_cnt_ex = req_task->hob_ports[2];
1935 } else {
1936 req_task->in_flags.all = IDE_TASKFILE_STD_IN_FLAGS;
1939 force_single_sector = implicit_sector(fis.command, fis.features);
1941 if ((taskin || taskout) && (!fis.sect_count)) {
1942 if (nsect)
1943 fis.sect_count = nsect;
1944 else {
1945 if (!force_single_sector) {
1946 dev_warn(&dd->pdev->dev,
1947 "data movement but "
1948 "sect_count is 0\n");
1949 err = -EINVAL;
1950 goto abort;
1955 dbg_printk(MTIP_DRV_NAME
1956 " %s: cmd %x, feat %x, nsect %x,"
1957 " sect/lbal %x, lcyl/lbam %x, hcyl/lbah %x,"
1958 " head/dev %x\n",
1959 __func__,
1960 fis.command,
1961 fis.features,
1962 fis.sect_count,
1963 fis.lba_low,
1964 fis.lba_mid,
1965 fis.lba_hi,
1966 fis.device);
1968 /* check for erase mode support during secure erase.*/
1969 if ((fis.command == ATA_CMD_SEC_ERASE_UNIT) && outbuf &&
1970 (outbuf[0] & MTIP_SEC_ERASE_MODE)) {
1971 erasemode = 1;
1974 mtip_set_timeout(dd, &fis, &timeout, erasemode);
1976 /* Determine the correct transfer size.*/
1977 if (force_single_sector)
1978 transfer_size = ATA_SECT_SIZE;
1979 else
1980 transfer_size = ATA_SECT_SIZE * fis.sect_count;
1982 /* Execute the command.*/
1983 if (mtip_exec_internal_command(dd->port,
1984 &fis,
1986 dma_buffer,
1987 transfer_size,
1989 timeout) < 0) {
1990 err = -EIO;
1991 goto abort;
1994 task_file_data = readl(dd->port->mmio+PORT_TFDATA);
1996 if ((req_task->data_phase == TASKFILE_IN) && !(task_file_data & 1)) {
1997 reply = dd->port->rxfis + RX_FIS_PIO_SETUP;
1998 req_task->io_ports[7] = reply->control;
1999 } else {
2000 reply = dd->port->rxfis + RX_FIS_D2H_REG;
2001 req_task->io_ports[7] = reply->command;
2004 /* reclaim the DMA buffers.*/
2005 if (inbuf_dma)
2006 pci_unmap_single(dd->pdev, inbuf_dma,
2007 taskin, DMA_FROM_DEVICE);
2008 if (outbuf_dma)
2009 pci_unmap_single(dd->pdev, outbuf_dma,
2010 taskout, DMA_TO_DEVICE);
2011 inbuf_dma = 0;
2012 outbuf_dma = 0;
2014 /* return the ATA registers to the caller.*/
2015 req_task->io_ports[1] = reply->features;
2016 req_task->io_ports[2] = reply->sect_count;
2017 req_task->io_ports[3] = reply->lba_low;
2018 req_task->io_ports[4] = reply->lba_mid;
2019 req_task->io_ports[5] = reply->lba_hi;
2020 req_task->io_ports[6] = reply->device;
2022 if (req_task->out_flags.all & 1) {
2024 req_task->hob_ports[3] = reply->lba_low_ex;
2025 req_task->hob_ports[4] = reply->lba_mid_ex;
2026 req_task->hob_ports[5] = reply->lba_hi_ex;
2027 req_task->hob_ports[1] = reply->features_ex;
2028 req_task->hob_ports[2] = reply->sect_cnt_ex;
2030 dbg_printk(MTIP_DRV_NAME
2031 " %s: Completion: stat %x,"
2032 "err %x, sect_cnt %x, lbalo %x,"
2033 "lbamid %x, lbahi %x, dev %x\n",
2034 __func__,
2035 req_task->io_ports[7],
2036 req_task->io_ports[1],
2037 req_task->io_ports[2],
2038 req_task->io_ports[3],
2039 req_task->io_ports[4],
2040 req_task->io_ports[5],
2041 req_task->io_ports[6]);
2043 if (taskout) {
2044 if (copy_to_user(buf + outtotal, outbuf, taskout)) {
2045 err = -EFAULT;
2046 goto abort;
2049 if (taskin) {
2050 if (copy_to_user(buf + intotal, inbuf, taskin)) {
2051 err = -EFAULT;
2052 goto abort;
2055 abort:
2056 if (inbuf_dma)
2057 pci_unmap_single(dd->pdev, inbuf_dma,
2058 taskin, DMA_FROM_DEVICE);
2059 if (outbuf_dma)
2060 pci_unmap_single(dd->pdev, outbuf_dma,
2061 taskout, DMA_TO_DEVICE);
2062 kfree(outbuf);
2063 kfree(inbuf);
2065 return err;
2069 * Handle IOCTL calls from the Block Layer.
2071 * This function is called by the Block Layer when it receives an IOCTL
2072 * command that it does not understand. If the IOCTL command is not supported
2073 * this function returns -ENOTTY.
2075 * @dd Pointer to the driver data structure.
2076 * @cmd IOCTL command passed from the Block Layer.
2077 * @arg IOCTL argument passed from the Block Layer.
2079 * return value
2080 * 0 The IOCTL completed successfully.
2081 * -ENOTTY The specified command is not supported.
2082 * -EFAULT An error occurred copying data to a user space buffer.
2083 * -EIO An error occurred while executing the command.
2085 static int mtip_hw_ioctl(struct driver_data *dd, unsigned int cmd,
2086 unsigned long arg)
2088 switch (cmd) {
2089 case HDIO_GET_IDENTITY:
2091 if (copy_to_user((void __user *)arg, dd->port->identify,
2092 sizeof(u16) * ATA_ID_WORDS))
2093 return -EFAULT;
2094 break;
2096 case HDIO_DRIVE_CMD:
2098 u8 drive_command[4];
2100 /* Copy the user command info to our buffer. */
2101 if (copy_from_user(drive_command,
2102 (void __user *) arg,
2103 sizeof(drive_command)))
2104 return -EFAULT;
2106 /* Execute the drive command. */
2107 if (exec_drive_command(dd->port,
2108 drive_command,
2109 (void __user *) (arg+4)))
2110 return -EIO;
2112 /* Copy the status back to the users buffer. */
2113 if (copy_to_user((void __user *) arg,
2114 drive_command,
2115 sizeof(drive_command)))
2116 return -EFAULT;
2118 break;
2120 case HDIO_DRIVE_TASK:
2122 u8 drive_command[7];
2124 /* Copy the user command info to our buffer. */
2125 if (copy_from_user(drive_command,
2126 (void __user *) arg,
2127 sizeof(drive_command)))
2128 return -EFAULT;
2130 /* Execute the drive command. */
2131 if (exec_drive_task(dd->port, drive_command))
2132 return -EIO;
2134 /* Copy the status back to the users buffer. */
2135 if (copy_to_user((void __user *) arg,
2136 drive_command,
2137 sizeof(drive_command)))
2138 return -EFAULT;
2140 break;
2142 case HDIO_DRIVE_TASKFILE: {
2143 ide_task_request_t req_task;
2144 int ret, outtotal;
2146 if (copy_from_user(&req_task, (void __user *) arg,
2147 sizeof(req_task)))
2148 return -EFAULT;
2150 outtotal = sizeof(req_task);
2152 ret = exec_drive_taskfile(dd, (void __user *) arg,
2153 &req_task, outtotal);
2155 if (copy_to_user((void __user *) arg, &req_task,
2156 sizeof(req_task)))
2157 return -EFAULT;
2159 return ret;
2162 default:
2163 return -EINVAL;
2165 return 0;
2169 * Submit an IO to the hw
2171 * This function is called by the block layer to issue an io
2172 * to the device. Upon completion, the callback function will
2173 * be called with the data parameter passed as the callback data.
2175 * @dd Pointer to the driver data structure.
2176 * @start First sector to read.
2177 * @nsect Number of sectors to read.
2178 * @nents Number of entries in scatter list for the read command.
2179 * @tag The tag of this read command.
2180 * @callback Pointer to the function that should be called
2181 * when the read completes.
2182 * @data Callback data passed to the callback function
2183 * when the read completes.
2184 * @dir Direction (read or write)
2186 * return value
2187 * None
2189 static void mtip_hw_submit_io(struct driver_data *dd, struct request *rq,
2190 struct mtip_cmd *command, int nents,
2191 struct blk_mq_hw_ctx *hctx)
2193 struct host_to_dev_fis *fis;
2194 struct mtip_port *port = dd->port;
2195 int dma_dir = rq_data_dir(rq) == READ ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
2196 u64 start = blk_rq_pos(rq);
2197 unsigned int nsect = blk_rq_sectors(rq);
2199 /* Map the scatter list for DMA access */
2200 nents = dma_map_sg(&dd->pdev->dev, command->sg, nents, dma_dir);
2202 prefetch(&port->flags);
2204 command->scatter_ents = nents;
2207 * The number of retries for this command before it is
2208 * reported as a failure to the upper layers.
2210 command->retries = MTIP_MAX_RETRIES;
2212 /* Fill out fis */
2213 fis = command->command;
2214 fis->type = 0x27;
2215 fis->opts = 1 << 7;
2216 if (dma_dir == DMA_FROM_DEVICE)
2217 fis->command = ATA_CMD_FPDMA_READ;
2218 else
2219 fis->command = ATA_CMD_FPDMA_WRITE;
2220 fis->lba_low = start & 0xFF;
2221 fis->lba_mid = (start >> 8) & 0xFF;
2222 fis->lba_hi = (start >> 16) & 0xFF;
2223 fis->lba_low_ex = (start >> 24) & 0xFF;
2224 fis->lba_mid_ex = (start >> 32) & 0xFF;
2225 fis->lba_hi_ex = (start >> 40) & 0xFF;
2226 fis->device = 1 << 6;
2227 fis->features = nsect & 0xFF;
2228 fis->features_ex = (nsect >> 8) & 0xFF;
2229 fis->sect_count = ((rq->tag << 3) | (rq->tag >> 5));
2230 fis->sect_cnt_ex = 0;
2231 fis->control = 0;
2232 fis->res2 = 0;
2233 fis->res3 = 0;
2234 fill_command_sg(dd, command, nents);
2236 if (unlikely(command->unaligned))
2237 fis->device |= 1 << 7;
2239 /* Populate the command header */
2240 command->command_header->opts =
2241 __force_bit2int cpu_to_le32(
2242 (nents << 16) | 5 | AHCI_CMD_PREFETCH);
2243 command->command_header->byte_count = 0;
2245 command->direction = dma_dir;
2248 * To prevent this command from being issued
2249 * if an internal command is in progress or error handling is active.
2251 if (unlikely(port->flags & MTIP_PF_PAUSE_IO)) {
2252 set_bit(rq->tag, port->cmds_to_issue);
2253 set_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags);
2254 return;
2257 /* Issue the command to the hardware */
2258 mtip_issue_ncq_command(port, rq->tag);
2262 * Sysfs status dump.
2264 * @dev Pointer to the device structure, passed by the kernrel.
2265 * @attr Pointer to the device_attribute structure passed by the kernel.
2266 * @buf Pointer to the char buffer that will receive the stats info.
2268 * return value
2269 * The size, in bytes, of the data copied into buf.
2271 static ssize_t mtip_hw_show_status(struct device *dev,
2272 struct device_attribute *attr,
2273 char *buf)
2275 struct driver_data *dd = dev_to_disk(dev)->private_data;
2276 int size = 0;
2278 if (test_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag))
2279 size += sprintf(buf, "%s", "thermal_shutdown\n");
2280 else if (test_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag))
2281 size += sprintf(buf, "%s", "write_protect\n");
2282 else
2283 size += sprintf(buf, "%s", "online\n");
2285 return size;
2288 static DEVICE_ATTR(status, S_IRUGO, mtip_hw_show_status, NULL);
2290 /* debugsfs entries */
2292 static ssize_t show_device_status(struct device_driver *drv, char *buf)
2294 int size = 0;
2295 struct driver_data *dd, *tmp;
2296 unsigned long flags;
2297 char id_buf[42];
2298 u16 status = 0;
2300 spin_lock_irqsave(&dev_lock, flags);
2301 size += sprintf(&buf[size], "Devices Present:\n");
2302 list_for_each_entry_safe(dd, tmp, &online_list, online_list) {
2303 if (dd->pdev) {
2304 if (dd->port &&
2305 dd->port->identify &&
2306 dd->port->identify_valid) {
2307 strlcpy(id_buf,
2308 (char *) (dd->port->identify + 10), 21);
2309 status = *(dd->port->identify + 141);
2310 } else {
2311 memset(id_buf, 0, 42);
2312 status = 0;
2315 if (dd->port &&
2316 test_bit(MTIP_PF_REBUILD_BIT, &dd->port->flags)) {
2317 size += sprintf(&buf[size],
2318 " device %s %s (ftl rebuild %d %%)\n",
2319 dev_name(&dd->pdev->dev),
2320 id_buf,
2321 status);
2322 } else {
2323 size += sprintf(&buf[size],
2324 " device %s %s\n",
2325 dev_name(&dd->pdev->dev),
2326 id_buf);
2331 size += sprintf(&buf[size], "Devices Being Removed:\n");
2332 list_for_each_entry_safe(dd, tmp, &removing_list, remove_list) {
2333 if (dd->pdev) {
2334 if (dd->port &&
2335 dd->port->identify &&
2336 dd->port->identify_valid) {
2337 strlcpy(id_buf,
2338 (char *) (dd->port->identify+10), 21);
2339 status = *(dd->port->identify + 141);
2340 } else {
2341 memset(id_buf, 0, 42);
2342 status = 0;
2345 if (dd->port &&
2346 test_bit(MTIP_PF_REBUILD_BIT, &dd->port->flags)) {
2347 size += sprintf(&buf[size],
2348 " device %s %s (ftl rebuild %d %%)\n",
2349 dev_name(&dd->pdev->dev),
2350 id_buf,
2351 status);
2352 } else {
2353 size += sprintf(&buf[size],
2354 " device %s %s\n",
2355 dev_name(&dd->pdev->dev),
2356 id_buf);
2360 spin_unlock_irqrestore(&dev_lock, flags);
2362 return size;
2365 static ssize_t mtip_hw_read_device_status(struct file *f, char __user *ubuf,
2366 size_t len, loff_t *offset)
2368 struct driver_data *dd = (struct driver_data *)f->private_data;
2369 int size = *offset;
2370 char *buf;
2371 int rv = 0;
2373 if (!len || *offset)
2374 return 0;
2376 buf = kzalloc(MTIP_DFS_MAX_BUF_SIZE, GFP_KERNEL);
2377 if (!buf) {
2378 dev_err(&dd->pdev->dev,
2379 "Memory allocation: status buffer\n");
2380 return -ENOMEM;
2383 size += show_device_status(NULL, buf);
2385 *offset = size <= len ? size : len;
2386 size = copy_to_user(ubuf, buf, *offset);
2387 if (size)
2388 rv = -EFAULT;
2390 kfree(buf);
2391 return rv ? rv : *offset;
2394 static ssize_t mtip_hw_read_registers(struct file *f, char __user *ubuf,
2395 size_t len, loff_t *offset)
2397 struct driver_data *dd = (struct driver_data *)f->private_data;
2398 char *buf;
2399 u32 group_allocated;
2400 int size = *offset;
2401 int n, rv = 0;
2403 if (!len || size)
2404 return 0;
2406 buf = kzalloc(MTIP_DFS_MAX_BUF_SIZE, GFP_KERNEL);
2407 if (!buf) {
2408 dev_err(&dd->pdev->dev,
2409 "Memory allocation: register buffer\n");
2410 return -ENOMEM;
2413 size += sprintf(&buf[size], "H/ S ACTive : [ 0x");
2415 for (n = dd->slot_groups-1; n >= 0; n--)
2416 size += sprintf(&buf[size], "%08X ",
2417 readl(dd->port->s_active[n]));
2419 size += sprintf(&buf[size], "]\n");
2420 size += sprintf(&buf[size], "H/ Command Issue : [ 0x");
2422 for (n = dd->slot_groups-1; n >= 0; n--)
2423 size += sprintf(&buf[size], "%08X ",
2424 readl(dd->port->cmd_issue[n]));
2426 size += sprintf(&buf[size], "]\n");
2427 size += sprintf(&buf[size], "H/ Completed : [ 0x");
2429 for (n = dd->slot_groups-1; n >= 0; n--)
2430 size += sprintf(&buf[size], "%08X ",
2431 readl(dd->port->completed[n]));
2433 size += sprintf(&buf[size], "]\n");
2434 size += sprintf(&buf[size], "H/ PORT IRQ STAT : [ 0x%08X ]\n",
2435 readl(dd->port->mmio + PORT_IRQ_STAT));
2436 size += sprintf(&buf[size], "H/ HOST IRQ STAT : [ 0x%08X ]\n",
2437 readl(dd->mmio + HOST_IRQ_STAT));
2438 size += sprintf(&buf[size], "\n");
2440 size += sprintf(&buf[size], "L/ Commands in Q : [ 0x");
2442 for (n = dd->slot_groups-1; n >= 0; n--) {
2443 if (sizeof(long) > sizeof(u32))
2444 group_allocated =
2445 dd->port->cmds_to_issue[n/2] >> (32*(n&1));
2446 else
2447 group_allocated = dd->port->cmds_to_issue[n];
2448 size += sprintf(&buf[size], "%08X ", group_allocated);
2450 size += sprintf(&buf[size], "]\n");
2452 *offset = size <= len ? size : len;
2453 size = copy_to_user(ubuf, buf, *offset);
2454 if (size)
2455 rv = -EFAULT;
2457 kfree(buf);
2458 return rv ? rv : *offset;
2461 static ssize_t mtip_hw_read_flags(struct file *f, char __user *ubuf,
2462 size_t len, loff_t *offset)
2464 struct driver_data *dd = (struct driver_data *)f->private_data;
2465 char *buf;
2466 int size = *offset;
2467 int rv = 0;
2469 if (!len || size)
2470 return 0;
2472 buf = kzalloc(MTIP_DFS_MAX_BUF_SIZE, GFP_KERNEL);
2473 if (!buf) {
2474 dev_err(&dd->pdev->dev,
2475 "Memory allocation: flag buffer\n");
2476 return -ENOMEM;
2479 size += sprintf(&buf[size], "Flag-port : [ %08lX ]\n",
2480 dd->port->flags);
2481 size += sprintf(&buf[size], "Flag-dd : [ %08lX ]\n",
2482 dd->dd_flag);
2484 *offset = size <= len ? size : len;
2485 size = copy_to_user(ubuf, buf, *offset);
2486 if (size)
2487 rv = -EFAULT;
2489 kfree(buf);
2490 return rv ? rv : *offset;
2493 static const struct file_operations mtip_device_status_fops = {
2494 .owner = THIS_MODULE,
2495 .open = simple_open,
2496 .read = mtip_hw_read_device_status,
2497 .llseek = no_llseek,
2500 static const struct file_operations mtip_regs_fops = {
2501 .owner = THIS_MODULE,
2502 .open = simple_open,
2503 .read = mtip_hw_read_registers,
2504 .llseek = no_llseek,
2507 static const struct file_operations mtip_flags_fops = {
2508 .owner = THIS_MODULE,
2509 .open = simple_open,
2510 .read = mtip_hw_read_flags,
2511 .llseek = no_llseek,
2515 * Create the sysfs related attributes.
2517 * @dd Pointer to the driver data structure.
2518 * @kobj Pointer to the kobj for the block device.
2520 * return value
2521 * 0 Operation completed successfully.
2522 * -EINVAL Invalid parameter.
2524 static int mtip_hw_sysfs_init(struct driver_data *dd, struct kobject *kobj)
2526 if (!kobj || !dd)
2527 return -EINVAL;
2529 if (sysfs_create_file(kobj, &dev_attr_status.attr))
2530 dev_warn(&dd->pdev->dev,
2531 "Error creating 'status' sysfs entry\n");
2532 return 0;
2536 * Remove the sysfs related attributes.
2538 * @dd Pointer to the driver data structure.
2539 * @kobj Pointer to the kobj for the block device.
2541 * return value
2542 * 0 Operation completed successfully.
2543 * -EINVAL Invalid parameter.
2545 static int mtip_hw_sysfs_exit(struct driver_data *dd, struct kobject *kobj)
2547 if (!kobj || !dd)
2548 return -EINVAL;
2550 sysfs_remove_file(kobj, &dev_attr_status.attr);
2552 return 0;
2555 static int mtip_hw_debugfs_init(struct driver_data *dd)
2557 if (!dfs_parent)
2558 return -1;
2560 dd->dfs_node = debugfs_create_dir(dd->disk->disk_name, dfs_parent);
2561 if (IS_ERR_OR_NULL(dd->dfs_node)) {
2562 dev_warn(&dd->pdev->dev,
2563 "Error creating node %s under debugfs\n",
2564 dd->disk->disk_name);
2565 dd->dfs_node = NULL;
2566 return -1;
2569 debugfs_create_file("flags", S_IRUGO, dd->dfs_node, dd,
2570 &mtip_flags_fops);
2571 debugfs_create_file("registers", S_IRUGO, dd->dfs_node, dd,
2572 &mtip_regs_fops);
2574 return 0;
2577 static void mtip_hw_debugfs_exit(struct driver_data *dd)
2579 if (dd->dfs_node)
2580 debugfs_remove_recursive(dd->dfs_node);
2584 * Perform any init/resume time hardware setup
2586 * @dd Pointer to the driver data structure.
2588 * return value
2589 * None
2591 static inline void hba_setup(struct driver_data *dd)
2593 u32 hwdata;
2594 hwdata = readl(dd->mmio + HOST_HSORG);
2596 /* interrupt bug workaround: use only 1 IS bit.*/
2597 writel(hwdata |
2598 HSORG_DISABLE_SLOTGRP_INTR |
2599 HSORG_DISABLE_SLOTGRP_PXIS,
2600 dd->mmio + HOST_HSORG);
2603 static int mtip_device_unaligned_constrained(struct driver_data *dd)
2605 return (dd->pdev->device == P420M_DEVICE_ID ? 1 : 0);
2609 * Detect the details of the product, and store anything needed
2610 * into the driver data structure. This includes product type and
2611 * version and number of slot groups.
2613 * @dd Pointer to the driver data structure.
2615 * return value
2616 * None
2618 static void mtip_detect_product(struct driver_data *dd)
2620 u32 hwdata;
2621 unsigned int rev, slotgroups;
2624 * HBA base + 0xFC [15:0] - vendor-specific hardware interface
2625 * info register:
2626 * [15:8] hardware/software interface rev#
2627 * [ 3] asic-style interface
2628 * [ 2:0] number of slot groups, minus 1 (only valid for asic-style).
2630 hwdata = readl(dd->mmio + HOST_HSORG);
2632 dd->product_type = MTIP_PRODUCT_UNKNOWN;
2633 dd->slot_groups = 1;
2635 if (hwdata & 0x8) {
2636 dd->product_type = MTIP_PRODUCT_ASICFPGA;
2637 rev = (hwdata & HSORG_HWREV) >> 8;
2638 slotgroups = (hwdata & HSORG_SLOTGROUPS) + 1;
2639 dev_info(&dd->pdev->dev,
2640 "ASIC-FPGA design, HS rev 0x%x, "
2641 "%i slot groups [%i slots]\n",
2642 rev,
2643 slotgroups,
2644 slotgroups * 32);
2646 if (slotgroups > MTIP_MAX_SLOT_GROUPS) {
2647 dev_warn(&dd->pdev->dev,
2648 "Warning: driver only supports "
2649 "%i slot groups.\n", MTIP_MAX_SLOT_GROUPS);
2650 slotgroups = MTIP_MAX_SLOT_GROUPS;
2652 dd->slot_groups = slotgroups;
2653 return;
2656 dev_warn(&dd->pdev->dev, "Unrecognized product id\n");
2660 * Blocking wait for FTL rebuild to complete
2662 * @dd Pointer to the DRIVER_DATA structure.
2664 * return value
2665 * 0 FTL rebuild completed successfully
2666 * -EFAULT FTL rebuild error/timeout/interruption
2668 static int mtip_ftl_rebuild_poll(struct driver_data *dd)
2670 unsigned long timeout, cnt = 0, start;
2672 dev_warn(&dd->pdev->dev,
2673 "FTL rebuild in progress. Polling for completion.\n");
2675 start = jiffies;
2676 timeout = jiffies + msecs_to_jiffies(MTIP_FTL_REBUILD_TIMEOUT_MS);
2678 do {
2679 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
2680 &dd->dd_flag)))
2681 return -EFAULT;
2682 if (mtip_check_surprise_removal(dd->pdev))
2683 return -EFAULT;
2685 if (mtip_get_identify(dd->port, NULL) < 0)
2686 return -EFAULT;
2688 if (*(dd->port->identify + MTIP_FTL_REBUILD_OFFSET) ==
2689 MTIP_FTL_REBUILD_MAGIC) {
2690 ssleep(1);
2691 /* Print message every 3 minutes */
2692 if (cnt++ >= 180) {
2693 dev_warn(&dd->pdev->dev,
2694 "FTL rebuild in progress (%d secs).\n",
2695 jiffies_to_msecs(jiffies - start) / 1000);
2696 cnt = 0;
2698 } else {
2699 dev_warn(&dd->pdev->dev,
2700 "FTL rebuild complete (%d secs).\n",
2701 jiffies_to_msecs(jiffies - start) / 1000);
2702 mtip_block_initialize(dd);
2703 return 0;
2705 } while (time_before(jiffies, timeout));
2707 /* Check for timeout */
2708 dev_err(&dd->pdev->dev,
2709 "Timed out waiting for FTL rebuild to complete (%d secs).\n",
2710 jiffies_to_msecs(jiffies - start) / 1000);
2711 return -EFAULT;
2714 static void mtip_softirq_done_fn(struct request *rq)
2716 struct mtip_cmd *cmd = blk_mq_rq_to_pdu(rq);
2717 struct driver_data *dd = rq->q->queuedata;
2719 /* Unmap the DMA scatter list entries */
2720 dma_unmap_sg(&dd->pdev->dev, cmd->sg, cmd->scatter_ents,
2721 cmd->direction);
2723 if (unlikely(cmd->unaligned))
2724 up(&dd->port->cmd_slot_unal);
2726 blk_mq_end_request(rq, cmd->status);
2729 static void mtip_abort_cmd(struct request *req, void *data,
2730 bool reserved)
2732 struct mtip_cmd *cmd = blk_mq_rq_to_pdu(req);
2733 struct driver_data *dd = data;
2735 if (!blk_mq_request_started(req))
2736 return;
2738 dbg_printk(MTIP_DRV_NAME " Aborting request, tag = %d\n", req->tag);
2740 clear_bit(req->tag, dd->port->cmds_to_issue);
2741 cmd->status = BLK_STS_IOERR;
2742 mtip_softirq_done_fn(req);
2745 static void mtip_queue_cmd(struct request *req, void *data,
2746 bool reserved)
2748 struct driver_data *dd = data;
2750 if (!blk_mq_request_started(req))
2751 return;
2753 set_bit(req->tag, dd->port->cmds_to_issue);
2754 blk_abort_request(req);
2758 * service thread to issue queued commands
2760 * @data Pointer to the driver data structure.
2762 * return value
2766 static int mtip_service_thread(void *data)
2768 struct driver_data *dd = (struct driver_data *)data;
2769 unsigned long slot, slot_start, slot_wrap, to;
2770 unsigned int num_cmd_slots = dd->slot_groups * 32;
2771 struct mtip_port *port = dd->port;
2773 while (1) {
2774 if (kthread_should_stop() ||
2775 test_bit(MTIP_PF_SVC_THD_STOP_BIT, &port->flags))
2776 goto st_out;
2777 clear_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags);
2780 * the condition is to check neither an internal command is
2781 * is in progress nor error handling is active
2783 wait_event_interruptible(port->svc_wait, (port->flags) &&
2784 (port->flags & MTIP_PF_SVC_THD_WORK));
2786 if (kthread_should_stop() ||
2787 test_bit(MTIP_PF_SVC_THD_STOP_BIT, &port->flags))
2788 goto st_out;
2790 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
2791 &dd->dd_flag)))
2792 goto st_out;
2794 set_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags);
2796 restart_eh:
2797 /* Demux bits: start with error handling */
2798 if (test_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags)) {
2799 mtip_handle_tfe(dd);
2800 clear_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
2803 if (test_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags))
2804 goto restart_eh;
2806 if (test_bit(MTIP_PF_TO_ACTIVE_BIT, &port->flags)) {
2807 to = jiffies + msecs_to_jiffies(5000);
2809 do {
2810 mdelay(100);
2811 } while (atomic_read(&dd->irq_workers_active) != 0 &&
2812 time_before(jiffies, to));
2814 if (atomic_read(&dd->irq_workers_active) != 0)
2815 dev_warn(&dd->pdev->dev,
2816 "Completion workers still active!");
2818 blk_mq_quiesce_queue(dd->queue);
2820 spin_lock(dd->queue->queue_lock);
2821 blk_mq_tagset_busy_iter(&dd->tags,
2822 mtip_queue_cmd, dd);
2823 spin_unlock(dd->queue->queue_lock);
2825 set_bit(MTIP_PF_ISSUE_CMDS_BIT, &dd->port->flags);
2827 if (mtip_device_reset(dd))
2828 blk_mq_tagset_busy_iter(&dd->tags,
2829 mtip_abort_cmd, dd);
2831 clear_bit(MTIP_PF_TO_ACTIVE_BIT, &dd->port->flags);
2833 blk_mq_unquiesce_queue(dd->queue);
2836 if (test_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags)) {
2837 slot = 1;
2838 /* used to restrict the loop to one iteration */
2839 slot_start = num_cmd_slots;
2840 slot_wrap = 0;
2841 while (1) {
2842 slot = find_next_bit(port->cmds_to_issue,
2843 num_cmd_slots, slot);
2844 if (slot_wrap == 1) {
2845 if ((slot_start >= slot) ||
2846 (slot >= num_cmd_slots))
2847 break;
2849 if (unlikely(slot_start == num_cmd_slots))
2850 slot_start = slot;
2852 if (unlikely(slot == num_cmd_slots)) {
2853 slot = 1;
2854 slot_wrap = 1;
2855 continue;
2858 /* Issue the command to the hardware */
2859 mtip_issue_ncq_command(port, slot);
2861 clear_bit(slot, port->cmds_to_issue);
2864 clear_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags);
2867 if (test_bit(MTIP_PF_REBUILD_BIT, &port->flags)) {
2868 if (mtip_ftl_rebuild_poll(dd) == 0)
2869 clear_bit(MTIP_PF_REBUILD_BIT, &port->flags);
2873 st_out:
2874 return 0;
2878 * DMA region teardown
2880 * @dd Pointer to driver_data structure
2882 * return value
2883 * None
2885 static void mtip_dma_free(struct driver_data *dd)
2887 struct mtip_port *port = dd->port;
2889 if (port->block1)
2890 dmam_free_coherent(&dd->pdev->dev, BLOCK_DMA_ALLOC_SZ,
2891 port->block1, port->block1_dma);
2893 if (port->command_list) {
2894 dmam_free_coherent(&dd->pdev->dev, AHCI_CMD_TBL_SZ,
2895 port->command_list, port->command_list_dma);
2900 * DMA region setup
2902 * @dd Pointer to driver_data structure
2904 * return value
2905 * -ENOMEM Not enough free DMA region space to initialize driver
2907 static int mtip_dma_alloc(struct driver_data *dd)
2909 struct mtip_port *port = dd->port;
2911 /* Allocate dma memory for RX Fis, Identify, and Sector Bufffer */
2912 port->block1 =
2913 dmam_alloc_coherent(&dd->pdev->dev, BLOCK_DMA_ALLOC_SZ,
2914 &port->block1_dma, GFP_KERNEL);
2915 if (!port->block1)
2916 return -ENOMEM;
2917 memset(port->block1, 0, BLOCK_DMA_ALLOC_SZ);
2919 /* Allocate dma memory for command list */
2920 port->command_list =
2921 dmam_alloc_coherent(&dd->pdev->dev, AHCI_CMD_TBL_SZ,
2922 &port->command_list_dma, GFP_KERNEL);
2923 if (!port->command_list) {
2924 dmam_free_coherent(&dd->pdev->dev, BLOCK_DMA_ALLOC_SZ,
2925 port->block1, port->block1_dma);
2926 port->block1 = NULL;
2927 port->block1_dma = 0;
2928 return -ENOMEM;
2930 memset(port->command_list, 0, AHCI_CMD_TBL_SZ);
2932 /* Setup all pointers into first DMA region */
2933 port->rxfis = port->block1 + AHCI_RX_FIS_OFFSET;
2934 port->rxfis_dma = port->block1_dma + AHCI_RX_FIS_OFFSET;
2935 port->identify = port->block1 + AHCI_IDFY_OFFSET;
2936 port->identify_dma = port->block1_dma + AHCI_IDFY_OFFSET;
2937 port->log_buf = port->block1 + AHCI_SECTBUF_OFFSET;
2938 port->log_buf_dma = port->block1_dma + AHCI_SECTBUF_OFFSET;
2939 port->smart_buf = port->block1 + AHCI_SMARTBUF_OFFSET;
2940 port->smart_buf_dma = port->block1_dma + AHCI_SMARTBUF_OFFSET;
2942 return 0;
2945 static int mtip_hw_get_identify(struct driver_data *dd)
2947 struct smart_attr attr242;
2948 unsigned char *buf;
2949 int rv;
2951 if (mtip_get_identify(dd->port, NULL) < 0)
2952 return -EFAULT;
2954 if (*(dd->port->identify + MTIP_FTL_REBUILD_OFFSET) ==
2955 MTIP_FTL_REBUILD_MAGIC) {
2956 set_bit(MTIP_PF_REBUILD_BIT, &dd->port->flags);
2957 return MTIP_FTL_REBUILD_MAGIC;
2959 mtip_dump_identify(dd->port);
2961 /* check write protect, over temp and rebuild statuses */
2962 rv = mtip_read_log_page(dd->port, ATA_LOG_SATA_NCQ,
2963 dd->port->log_buf,
2964 dd->port->log_buf_dma, 1);
2965 if (rv) {
2966 dev_warn(&dd->pdev->dev,
2967 "Error in READ LOG EXT (10h) command\n");
2968 /* non-critical error, don't fail the load */
2969 } else {
2970 buf = (unsigned char *)dd->port->log_buf;
2971 if (buf[259] & 0x1) {
2972 dev_info(&dd->pdev->dev,
2973 "Write protect bit is set.\n");
2974 set_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag);
2976 if (buf[288] == 0xF7) {
2977 dev_info(&dd->pdev->dev,
2978 "Exceeded Tmax, drive in thermal shutdown.\n");
2979 set_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag);
2981 if (buf[288] == 0xBF) {
2982 dev_info(&dd->pdev->dev,
2983 "Drive indicates rebuild has failed.\n");
2984 set_bit(MTIP_DDF_REBUILD_FAILED_BIT, &dd->dd_flag);
2988 /* get write protect progess */
2989 memset(&attr242, 0, sizeof(struct smart_attr));
2990 if (mtip_get_smart_attr(dd->port, 242, &attr242))
2991 dev_warn(&dd->pdev->dev,
2992 "Unable to check write protect progress\n");
2993 else
2994 dev_info(&dd->pdev->dev,
2995 "Write protect progress: %u%% (%u blocks)\n",
2996 attr242.cur, le32_to_cpu(attr242.data));
2998 return rv;
3002 * Called once for each card.
3004 * @dd Pointer to the driver data structure.
3006 * return value
3007 * 0 on success, else an error code.
3009 static int mtip_hw_init(struct driver_data *dd)
3011 int i;
3012 int rv;
3013 unsigned long timeout, timetaken;
3015 dd->mmio = pcim_iomap_table(dd->pdev)[MTIP_ABAR];
3017 mtip_detect_product(dd);
3018 if (dd->product_type == MTIP_PRODUCT_UNKNOWN) {
3019 rv = -EIO;
3020 goto out1;
3023 hba_setup(dd);
3025 dd->port = kzalloc_node(sizeof(struct mtip_port), GFP_KERNEL,
3026 dd->numa_node);
3027 if (!dd->port) {
3028 dev_err(&dd->pdev->dev,
3029 "Memory allocation: port structure\n");
3030 return -ENOMEM;
3033 /* Continue workqueue setup */
3034 for (i = 0; i < MTIP_MAX_SLOT_GROUPS; i++)
3035 dd->work[i].port = dd->port;
3037 /* Enable unaligned IO constraints for some devices */
3038 if (mtip_device_unaligned_constrained(dd))
3039 dd->unal_qdepth = MTIP_MAX_UNALIGNED_SLOTS;
3040 else
3041 dd->unal_qdepth = 0;
3043 sema_init(&dd->port->cmd_slot_unal, dd->unal_qdepth);
3045 /* Spinlock to prevent concurrent issue */
3046 for (i = 0; i < MTIP_MAX_SLOT_GROUPS; i++)
3047 spin_lock_init(&dd->port->cmd_issue_lock[i]);
3049 /* Set the port mmio base address. */
3050 dd->port->mmio = dd->mmio + PORT_OFFSET;
3051 dd->port->dd = dd;
3053 /* DMA allocations */
3054 rv = mtip_dma_alloc(dd);
3055 if (rv < 0)
3056 goto out1;
3058 /* Setup the pointers to the extended s_active and CI registers. */
3059 for (i = 0; i < dd->slot_groups; i++) {
3060 dd->port->s_active[i] =
3061 dd->port->mmio + i*0x80 + PORT_SCR_ACT;
3062 dd->port->cmd_issue[i] =
3063 dd->port->mmio + i*0x80 + PORT_COMMAND_ISSUE;
3064 dd->port->completed[i] =
3065 dd->port->mmio + i*0x80 + PORT_SDBV;
3068 timetaken = jiffies;
3069 timeout = jiffies + msecs_to_jiffies(30000);
3070 while (((readl(dd->port->mmio + PORT_SCR_STAT) & 0x0F) != 0x03) &&
3071 time_before(jiffies, timeout)) {
3072 mdelay(100);
3074 if (unlikely(mtip_check_surprise_removal(dd->pdev))) {
3075 timetaken = jiffies - timetaken;
3076 dev_warn(&dd->pdev->dev,
3077 "Surprise removal detected at %u ms\n",
3078 jiffies_to_msecs(timetaken));
3079 rv = -ENODEV;
3080 goto out2 ;
3082 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))) {
3083 timetaken = jiffies - timetaken;
3084 dev_warn(&dd->pdev->dev,
3085 "Removal detected at %u ms\n",
3086 jiffies_to_msecs(timetaken));
3087 rv = -EFAULT;
3088 goto out2;
3091 /* Conditionally reset the HBA. */
3092 if (!(readl(dd->mmio + HOST_CAP) & HOST_CAP_NZDMA)) {
3093 if (mtip_hba_reset(dd) < 0) {
3094 dev_err(&dd->pdev->dev,
3095 "Card did not reset within timeout\n");
3096 rv = -EIO;
3097 goto out2;
3099 } else {
3100 /* Clear any pending interrupts on the HBA */
3101 writel(readl(dd->mmio + HOST_IRQ_STAT),
3102 dd->mmio + HOST_IRQ_STAT);
3105 mtip_init_port(dd->port);
3106 mtip_start_port(dd->port);
3108 /* Setup the ISR and enable interrupts. */
3109 rv = devm_request_irq(&dd->pdev->dev,
3110 dd->pdev->irq,
3111 mtip_irq_handler,
3112 IRQF_SHARED,
3113 dev_driver_string(&dd->pdev->dev),
3114 dd);
3116 if (rv) {
3117 dev_err(&dd->pdev->dev,
3118 "Unable to allocate IRQ %d\n", dd->pdev->irq);
3119 goto out2;
3121 irq_set_affinity_hint(dd->pdev->irq, get_cpu_mask(dd->isr_binding));
3123 /* Enable interrupts on the HBA. */
3124 writel(readl(dd->mmio + HOST_CTL) | HOST_IRQ_EN,
3125 dd->mmio + HOST_CTL);
3127 init_waitqueue_head(&dd->port->svc_wait);
3129 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)) {
3130 rv = -EFAULT;
3131 goto out3;
3134 return rv;
3136 out3:
3137 /* Disable interrupts on the HBA. */
3138 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3139 dd->mmio + HOST_CTL);
3141 /* Release the IRQ. */
3142 irq_set_affinity_hint(dd->pdev->irq, NULL);
3143 devm_free_irq(&dd->pdev->dev, dd->pdev->irq, dd);
3145 out2:
3146 mtip_deinit_port(dd->port);
3147 mtip_dma_free(dd);
3149 out1:
3150 /* Free the memory allocated for the for structure. */
3151 kfree(dd->port);
3153 return rv;
3156 static int mtip_standby_drive(struct driver_data *dd)
3158 int rv = 0;
3160 if (dd->sr || !dd->port)
3161 return -ENODEV;
3163 * Send standby immediate (E0h) to the drive so that it
3164 * saves its state.
3166 if (!test_bit(MTIP_PF_REBUILD_BIT, &dd->port->flags) &&
3167 !test_bit(MTIP_DDF_REBUILD_FAILED_BIT, &dd->dd_flag) &&
3168 !test_bit(MTIP_DDF_SEC_LOCK_BIT, &dd->dd_flag)) {
3169 rv = mtip_standby_immediate(dd->port);
3170 if (rv)
3171 dev_warn(&dd->pdev->dev,
3172 "STANDBY IMMEDIATE failed\n");
3174 return rv;
3178 * Called to deinitialize an interface.
3180 * @dd Pointer to the driver data structure.
3182 * return value
3185 static int mtip_hw_exit(struct driver_data *dd)
3187 if (!dd->sr) {
3188 /* de-initialize the port. */
3189 mtip_deinit_port(dd->port);
3191 /* Disable interrupts on the HBA. */
3192 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3193 dd->mmio + HOST_CTL);
3196 /* Release the IRQ. */
3197 irq_set_affinity_hint(dd->pdev->irq, NULL);
3198 devm_free_irq(&dd->pdev->dev, dd->pdev->irq, dd);
3199 msleep(1000);
3201 /* Free dma regions */
3202 mtip_dma_free(dd);
3204 /* Free the memory allocated for the for structure. */
3205 kfree(dd->port);
3206 dd->port = NULL;
3208 return 0;
3212 * Issue a Standby Immediate command to the device.
3214 * This function is called by the Block Layer just before the
3215 * system powers off during a shutdown.
3217 * @dd Pointer to the driver data structure.
3219 * return value
3222 static int mtip_hw_shutdown(struct driver_data *dd)
3225 * Send standby immediate (E0h) to the drive so that it
3226 * saves its state.
3228 mtip_standby_drive(dd);
3230 return 0;
3234 * Suspend function
3236 * This function is called by the Block Layer just before the
3237 * system hibernates.
3239 * @dd Pointer to the driver data structure.
3241 * return value
3242 * 0 Suspend was successful
3243 * -EFAULT Suspend was not successful
3245 static int mtip_hw_suspend(struct driver_data *dd)
3248 * Send standby immediate (E0h) to the drive
3249 * so that it saves its state.
3251 if (mtip_standby_drive(dd) != 0) {
3252 dev_err(&dd->pdev->dev,
3253 "Failed standby-immediate command\n");
3254 return -EFAULT;
3257 /* Disable interrupts on the HBA.*/
3258 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3259 dd->mmio + HOST_CTL);
3260 mtip_deinit_port(dd->port);
3262 return 0;
3266 * Resume function
3268 * This function is called by the Block Layer as the
3269 * system resumes.
3271 * @dd Pointer to the driver data structure.
3273 * return value
3274 * 0 Resume was successful
3275 * -EFAULT Resume was not successful
3277 static int mtip_hw_resume(struct driver_data *dd)
3279 /* Perform any needed hardware setup steps */
3280 hba_setup(dd);
3282 /* Reset the HBA */
3283 if (mtip_hba_reset(dd) != 0) {
3284 dev_err(&dd->pdev->dev,
3285 "Unable to reset the HBA\n");
3286 return -EFAULT;
3290 * Enable the port, DMA engine, and FIS reception specific
3291 * h/w in controller.
3293 mtip_init_port(dd->port);
3294 mtip_start_port(dd->port);
3296 /* Enable interrupts on the HBA.*/
3297 writel(readl(dd->mmio + HOST_CTL) | HOST_IRQ_EN,
3298 dd->mmio + HOST_CTL);
3300 return 0;
3304 * Helper function for reusing disk name
3305 * upon hot insertion.
3307 static int rssd_disk_name_format(char *prefix,
3308 int index,
3309 char *buf,
3310 int buflen)
3312 const int base = 'z' - 'a' + 1;
3313 char *begin = buf + strlen(prefix);
3314 char *end = buf + buflen;
3315 char *p;
3316 int unit;
3318 p = end - 1;
3319 *p = '\0';
3320 unit = base;
3321 do {
3322 if (p == begin)
3323 return -EINVAL;
3324 *--p = 'a' + (index % unit);
3325 index = (index / unit) - 1;
3326 } while (index >= 0);
3328 memmove(begin, p, end - p);
3329 memcpy(buf, prefix, strlen(prefix));
3331 return 0;
3335 * Block layer IOCTL handler.
3337 * @dev Pointer to the block_device structure.
3338 * @mode ignored
3339 * @cmd IOCTL command passed from the user application.
3340 * @arg Argument passed from the user application.
3342 * return value
3343 * 0 IOCTL completed successfully.
3344 * -ENOTTY IOCTL not supported or invalid driver data
3345 * structure pointer.
3347 static int mtip_block_ioctl(struct block_device *dev,
3348 fmode_t mode,
3349 unsigned cmd,
3350 unsigned long arg)
3352 struct driver_data *dd = dev->bd_disk->private_data;
3354 if (!capable(CAP_SYS_ADMIN))
3355 return -EACCES;
3357 if (!dd)
3358 return -ENOTTY;
3360 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)))
3361 return -ENOTTY;
3363 switch (cmd) {
3364 case BLKFLSBUF:
3365 return -ENOTTY;
3366 default:
3367 return mtip_hw_ioctl(dd, cmd, arg);
3371 #ifdef CONFIG_COMPAT
3373 * Block layer compat IOCTL handler.
3375 * @dev Pointer to the block_device structure.
3376 * @mode ignored
3377 * @cmd IOCTL command passed from the user application.
3378 * @arg Argument passed from the user application.
3380 * return value
3381 * 0 IOCTL completed successfully.
3382 * -ENOTTY IOCTL not supported or invalid driver data
3383 * structure pointer.
3385 static int mtip_block_compat_ioctl(struct block_device *dev,
3386 fmode_t mode,
3387 unsigned cmd,
3388 unsigned long arg)
3390 struct driver_data *dd = dev->bd_disk->private_data;
3392 if (!capable(CAP_SYS_ADMIN))
3393 return -EACCES;
3395 if (!dd)
3396 return -ENOTTY;
3398 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)))
3399 return -ENOTTY;
3401 switch (cmd) {
3402 case BLKFLSBUF:
3403 return -ENOTTY;
3404 case HDIO_DRIVE_TASKFILE: {
3405 struct mtip_compat_ide_task_request_s __user *compat_req_task;
3406 ide_task_request_t req_task;
3407 int compat_tasksize, outtotal, ret;
3409 compat_tasksize =
3410 sizeof(struct mtip_compat_ide_task_request_s);
3412 compat_req_task =
3413 (struct mtip_compat_ide_task_request_s __user *) arg;
3415 if (copy_from_user(&req_task, (void __user *) arg,
3416 compat_tasksize - (2 * sizeof(compat_long_t))))
3417 return -EFAULT;
3419 if (get_user(req_task.out_size, &compat_req_task->out_size))
3420 return -EFAULT;
3422 if (get_user(req_task.in_size, &compat_req_task->in_size))
3423 return -EFAULT;
3425 outtotal = sizeof(struct mtip_compat_ide_task_request_s);
3427 ret = exec_drive_taskfile(dd, (void __user *) arg,
3428 &req_task, outtotal);
3430 if (copy_to_user((void __user *) arg, &req_task,
3431 compat_tasksize -
3432 (2 * sizeof(compat_long_t))))
3433 return -EFAULT;
3435 if (put_user(req_task.out_size, &compat_req_task->out_size))
3436 return -EFAULT;
3438 if (put_user(req_task.in_size, &compat_req_task->in_size))
3439 return -EFAULT;
3441 return ret;
3443 default:
3444 return mtip_hw_ioctl(dd, cmd, arg);
3447 #endif
3450 * Obtain the geometry of the device.
3452 * You may think that this function is obsolete, but some applications,
3453 * fdisk for example still used CHS values. This function describes the
3454 * device as having 224 heads and 56 sectors per cylinder. These values are
3455 * chosen so that each cylinder is aligned on a 4KB boundary. Since a
3456 * partition is described in terms of a start and end cylinder this means
3457 * that each partition is also 4KB aligned. Non-aligned partitions adversely
3458 * affects performance.
3460 * @dev Pointer to the block_device strucutre.
3461 * @geo Pointer to a hd_geometry structure.
3463 * return value
3464 * 0 Operation completed successfully.
3465 * -ENOTTY An error occurred while reading the drive capacity.
3467 static int mtip_block_getgeo(struct block_device *dev,
3468 struct hd_geometry *geo)
3470 struct driver_data *dd = dev->bd_disk->private_data;
3471 sector_t capacity;
3473 if (!dd)
3474 return -ENOTTY;
3476 if (!(mtip_hw_get_capacity(dd, &capacity))) {
3477 dev_warn(&dd->pdev->dev,
3478 "Could not get drive capacity.\n");
3479 return -ENOTTY;
3482 geo->heads = 224;
3483 geo->sectors = 56;
3484 sector_div(capacity, (geo->heads * geo->sectors));
3485 geo->cylinders = capacity;
3486 return 0;
3489 static int mtip_block_open(struct block_device *dev, fmode_t mode)
3491 struct driver_data *dd;
3493 if (dev && dev->bd_disk) {
3494 dd = (struct driver_data *) dev->bd_disk->private_data;
3496 if (dd) {
3497 if (test_bit(MTIP_DDF_REMOVAL_BIT,
3498 &dd->dd_flag)) {
3499 return -ENODEV;
3501 return 0;
3504 return -ENODEV;
3507 static void mtip_block_release(struct gendisk *disk, fmode_t mode)
3512 * Block device operation function.
3514 * This structure contains pointers to the functions required by the block
3515 * layer.
3517 static const struct block_device_operations mtip_block_ops = {
3518 .open = mtip_block_open,
3519 .release = mtip_block_release,
3520 .ioctl = mtip_block_ioctl,
3521 #ifdef CONFIG_COMPAT
3522 .compat_ioctl = mtip_block_compat_ioctl,
3523 #endif
3524 .getgeo = mtip_block_getgeo,
3525 .owner = THIS_MODULE
3528 static inline bool is_se_active(struct driver_data *dd)
3530 if (unlikely(test_bit(MTIP_PF_SE_ACTIVE_BIT, &dd->port->flags))) {
3531 if (dd->port->ic_pause_timer) {
3532 unsigned long to = dd->port->ic_pause_timer +
3533 msecs_to_jiffies(1000);
3534 if (time_after(jiffies, to)) {
3535 clear_bit(MTIP_PF_SE_ACTIVE_BIT,
3536 &dd->port->flags);
3537 clear_bit(MTIP_DDF_SEC_LOCK_BIT, &dd->dd_flag);
3538 dd->port->ic_pause_timer = 0;
3539 wake_up_interruptible(&dd->port->svc_wait);
3540 return false;
3543 return true;
3545 return false;
3549 * Block layer make request function.
3551 * This function is called by the kernel to process a BIO for
3552 * the P320 device.
3554 * @queue Pointer to the request queue. Unused other than to obtain
3555 * the driver data structure.
3556 * @rq Pointer to the request.
3559 static int mtip_submit_request(struct blk_mq_hw_ctx *hctx, struct request *rq)
3561 struct driver_data *dd = hctx->queue->queuedata;
3562 struct mtip_cmd *cmd = blk_mq_rq_to_pdu(rq);
3563 unsigned int nents;
3565 if (is_se_active(dd))
3566 return -ENODATA;
3568 if (unlikely(dd->dd_flag & MTIP_DDF_STOP_IO)) {
3569 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
3570 &dd->dd_flag))) {
3571 return -ENXIO;
3573 if (unlikely(test_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag))) {
3574 return -ENODATA;
3576 if (unlikely(test_bit(MTIP_DDF_WRITE_PROTECT_BIT,
3577 &dd->dd_flag) &&
3578 rq_data_dir(rq))) {
3579 return -ENODATA;
3581 if (unlikely(test_bit(MTIP_DDF_SEC_LOCK_BIT, &dd->dd_flag) ||
3582 test_bit(MTIP_DDF_REBUILD_FAILED_BIT, &dd->dd_flag)))
3583 return -ENODATA;
3586 if (req_op(rq) == REQ_OP_DISCARD) {
3587 int err;
3589 err = mtip_send_trim(dd, blk_rq_pos(rq), blk_rq_sectors(rq));
3590 blk_mq_end_request(rq, err ? BLK_STS_IOERR : BLK_STS_OK);
3591 return 0;
3594 /* Create the scatter list for this request. */
3595 nents = blk_rq_map_sg(hctx->queue, rq, cmd->sg);
3597 /* Issue the read/write. */
3598 mtip_hw_submit_io(dd, rq, cmd, nents, hctx);
3599 return 0;
3602 static bool mtip_check_unal_depth(struct blk_mq_hw_ctx *hctx,
3603 struct request *rq)
3605 struct driver_data *dd = hctx->queue->queuedata;
3606 struct mtip_cmd *cmd = blk_mq_rq_to_pdu(rq);
3608 if (rq_data_dir(rq) == READ || !dd->unal_qdepth)
3609 return false;
3612 * If unaligned depth must be limited on this controller, mark it
3613 * as unaligned if the IO isn't on a 4k boundary (start of length).
3615 if (blk_rq_sectors(rq) <= 64) {
3616 if ((blk_rq_pos(rq) & 7) || (blk_rq_sectors(rq) & 7))
3617 cmd->unaligned = 1;
3620 if (cmd->unaligned && down_trylock(&dd->port->cmd_slot_unal))
3621 return true;
3623 return false;
3626 static blk_status_t mtip_issue_reserved_cmd(struct blk_mq_hw_ctx *hctx,
3627 struct request *rq)
3629 struct driver_data *dd = hctx->queue->queuedata;
3630 struct mtip_int_cmd *icmd = rq->special;
3631 struct mtip_cmd *cmd = blk_mq_rq_to_pdu(rq);
3632 struct mtip_cmd_sg *command_sg;
3634 if (mtip_commands_active(dd->port))
3635 return BLK_STS_RESOURCE;
3637 /* Populate the SG list */
3638 cmd->command_header->opts =
3639 __force_bit2int cpu_to_le32(icmd->opts | icmd->fis_len);
3640 if (icmd->buf_len) {
3641 command_sg = cmd->command + AHCI_CMD_TBL_HDR_SZ;
3643 command_sg->info =
3644 __force_bit2int cpu_to_le32((icmd->buf_len-1) & 0x3FFFFF);
3645 command_sg->dba =
3646 __force_bit2int cpu_to_le32(icmd->buffer & 0xFFFFFFFF);
3647 command_sg->dba_upper =
3648 __force_bit2int cpu_to_le32((icmd->buffer >> 16) >> 16);
3650 cmd->command_header->opts |=
3651 __force_bit2int cpu_to_le32((1 << 16));
3654 /* Populate the command header */
3655 cmd->command_header->byte_count = 0;
3657 blk_mq_start_request(rq);
3658 mtip_issue_non_ncq_command(dd->port, rq->tag);
3659 return 0;
3662 static blk_status_t mtip_queue_rq(struct blk_mq_hw_ctx *hctx,
3663 const struct blk_mq_queue_data *bd)
3665 struct request *rq = bd->rq;
3666 int ret;
3668 mtip_init_cmd_header(rq);
3670 if (blk_rq_is_passthrough(rq))
3671 return mtip_issue_reserved_cmd(hctx, rq);
3673 if (unlikely(mtip_check_unal_depth(hctx, rq)))
3674 return BLK_STS_RESOURCE;
3676 blk_mq_start_request(rq);
3678 ret = mtip_submit_request(hctx, rq);
3679 if (likely(!ret))
3680 return BLK_STS_OK;
3681 return BLK_STS_IOERR;
3684 static void mtip_free_cmd(struct blk_mq_tag_set *set, struct request *rq,
3685 unsigned int hctx_idx)
3687 struct driver_data *dd = set->driver_data;
3688 struct mtip_cmd *cmd = blk_mq_rq_to_pdu(rq);
3690 if (!cmd->command)
3691 return;
3693 dmam_free_coherent(&dd->pdev->dev, CMD_DMA_ALLOC_SZ,
3694 cmd->command, cmd->command_dma);
3697 static int mtip_init_cmd(struct blk_mq_tag_set *set, struct request *rq,
3698 unsigned int hctx_idx, unsigned int numa_node)
3700 struct driver_data *dd = set->driver_data;
3701 struct mtip_cmd *cmd = blk_mq_rq_to_pdu(rq);
3703 cmd->command = dmam_alloc_coherent(&dd->pdev->dev, CMD_DMA_ALLOC_SZ,
3704 &cmd->command_dma, GFP_KERNEL);
3705 if (!cmd->command)
3706 return -ENOMEM;
3708 memset(cmd->command, 0, CMD_DMA_ALLOC_SZ);
3710 sg_init_table(cmd->sg, MTIP_MAX_SG);
3711 return 0;
3714 static enum blk_eh_timer_return mtip_cmd_timeout(struct request *req,
3715 bool reserved)
3717 struct driver_data *dd = req->q->queuedata;
3719 if (reserved) {
3720 struct mtip_cmd *cmd = blk_mq_rq_to_pdu(req);
3722 cmd->status = BLK_STS_TIMEOUT;
3723 return BLK_EH_HANDLED;
3726 if (test_bit(req->tag, dd->port->cmds_to_issue))
3727 goto exit_handler;
3729 if (test_and_set_bit(MTIP_PF_TO_ACTIVE_BIT, &dd->port->flags))
3730 goto exit_handler;
3732 wake_up_interruptible(&dd->port->svc_wait);
3733 exit_handler:
3734 return BLK_EH_RESET_TIMER;
3737 static const struct blk_mq_ops mtip_mq_ops = {
3738 .queue_rq = mtip_queue_rq,
3739 .init_request = mtip_init_cmd,
3740 .exit_request = mtip_free_cmd,
3741 .complete = mtip_softirq_done_fn,
3742 .timeout = mtip_cmd_timeout,
3746 * Block layer initialization function.
3748 * This function is called once by the PCI layer for each P320
3749 * device that is connected to the system.
3751 * @dd Pointer to the driver data structure.
3753 * return value
3754 * 0 on success else an error code.
3756 static int mtip_block_initialize(struct driver_data *dd)
3758 int rv = 0, wait_for_rebuild = 0;
3759 sector_t capacity;
3760 unsigned int index = 0;
3761 struct kobject *kobj;
3763 if (dd->disk)
3764 goto skip_create_disk; /* hw init done, before rebuild */
3766 if (mtip_hw_init(dd)) {
3767 rv = -EINVAL;
3768 goto protocol_init_error;
3771 dd->disk = alloc_disk_node(MTIP_MAX_MINORS, dd->numa_node);
3772 if (dd->disk == NULL) {
3773 dev_err(&dd->pdev->dev,
3774 "Unable to allocate gendisk structure\n");
3775 rv = -EINVAL;
3776 goto alloc_disk_error;
3779 /* Generate the disk name, implemented same as in sd.c */
3780 do {
3781 if (!ida_pre_get(&rssd_index_ida, GFP_KERNEL)) {
3782 rv = -ENOMEM;
3783 goto ida_get_error;
3786 spin_lock(&rssd_index_lock);
3787 rv = ida_get_new(&rssd_index_ida, &index);
3788 spin_unlock(&rssd_index_lock);
3789 } while (rv == -EAGAIN);
3791 if (rv)
3792 goto ida_get_error;
3794 rv = rssd_disk_name_format("rssd",
3795 index,
3796 dd->disk->disk_name,
3797 DISK_NAME_LEN);
3798 if (rv)
3799 goto disk_index_error;
3801 dd->disk->major = dd->major;
3802 dd->disk->first_minor = index * MTIP_MAX_MINORS;
3803 dd->disk->minors = MTIP_MAX_MINORS;
3804 dd->disk->fops = &mtip_block_ops;
3805 dd->disk->private_data = dd;
3806 dd->index = index;
3808 mtip_hw_debugfs_init(dd);
3810 memset(&dd->tags, 0, sizeof(dd->tags));
3811 dd->tags.ops = &mtip_mq_ops;
3812 dd->tags.nr_hw_queues = 1;
3813 dd->tags.queue_depth = MTIP_MAX_COMMAND_SLOTS;
3814 dd->tags.reserved_tags = 1;
3815 dd->tags.cmd_size = sizeof(struct mtip_cmd);
3816 dd->tags.numa_node = dd->numa_node;
3817 dd->tags.flags = BLK_MQ_F_SHOULD_MERGE;
3818 dd->tags.driver_data = dd;
3819 dd->tags.timeout = MTIP_NCQ_CMD_TIMEOUT_MS;
3821 rv = blk_mq_alloc_tag_set(&dd->tags);
3822 if (rv) {
3823 dev_err(&dd->pdev->dev,
3824 "Unable to allocate request queue\n");
3825 goto block_queue_alloc_tag_error;
3828 /* Allocate the request queue. */
3829 dd->queue = blk_mq_init_queue(&dd->tags);
3830 if (IS_ERR(dd->queue)) {
3831 dev_err(&dd->pdev->dev,
3832 "Unable to allocate request queue\n");
3833 rv = -ENOMEM;
3834 goto block_queue_alloc_init_error;
3837 dd->disk->queue = dd->queue;
3838 dd->queue->queuedata = dd;
3840 skip_create_disk:
3841 /* Initialize the protocol layer. */
3842 wait_for_rebuild = mtip_hw_get_identify(dd);
3843 if (wait_for_rebuild < 0) {
3844 dev_err(&dd->pdev->dev,
3845 "Protocol layer initialization failed\n");
3846 rv = -EINVAL;
3847 goto init_hw_cmds_error;
3851 * if rebuild pending, start the service thread, and delay the block
3852 * queue creation and device_add_disk()
3854 if (wait_for_rebuild == MTIP_FTL_REBUILD_MAGIC)
3855 goto start_service_thread;
3857 /* Set device limits. */
3858 set_bit(QUEUE_FLAG_NONROT, &dd->queue->queue_flags);
3859 clear_bit(QUEUE_FLAG_ADD_RANDOM, &dd->queue->queue_flags);
3860 blk_queue_max_segments(dd->queue, MTIP_MAX_SG);
3861 blk_queue_physical_block_size(dd->queue, 4096);
3862 blk_queue_max_hw_sectors(dd->queue, 0xffff);
3863 blk_queue_max_segment_size(dd->queue, 0x400000);
3864 blk_queue_io_min(dd->queue, 4096);
3865 blk_queue_bounce_limit(dd->queue, dd->pdev->dma_mask);
3867 /* Signal trim support */
3868 if (dd->trim_supp == true) {
3869 set_bit(QUEUE_FLAG_DISCARD, &dd->queue->queue_flags);
3870 dd->queue->limits.discard_granularity = 4096;
3871 blk_queue_max_discard_sectors(dd->queue,
3872 MTIP_MAX_TRIM_ENTRY_LEN * MTIP_MAX_TRIM_ENTRIES);
3875 /* Set the capacity of the device in 512 byte sectors. */
3876 if (!(mtip_hw_get_capacity(dd, &capacity))) {
3877 dev_warn(&dd->pdev->dev,
3878 "Could not read drive capacity\n");
3879 rv = -EIO;
3880 goto read_capacity_error;
3882 set_capacity(dd->disk, capacity);
3884 /* Enable the block device and add it to /dev */
3885 device_add_disk(&dd->pdev->dev, dd->disk);
3887 dd->bdev = bdget_disk(dd->disk, 0);
3889 * Now that the disk is active, initialize any sysfs attributes
3890 * managed by the protocol layer.
3892 kobj = kobject_get(&disk_to_dev(dd->disk)->kobj);
3893 if (kobj) {
3894 mtip_hw_sysfs_init(dd, kobj);
3895 kobject_put(kobj);
3898 if (dd->mtip_svc_handler) {
3899 set_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag);
3900 return rv; /* service thread created for handling rebuild */
3903 start_service_thread:
3904 dd->mtip_svc_handler = kthread_create_on_node(mtip_service_thread,
3905 dd, dd->numa_node,
3906 "mtip_svc_thd_%02d", index);
3908 if (IS_ERR(dd->mtip_svc_handler)) {
3909 dev_err(&dd->pdev->dev, "service thread failed to start\n");
3910 dd->mtip_svc_handler = NULL;
3911 rv = -EFAULT;
3912 goto kthread_run_error;
3914 wake_up_process(dd->mtip_svc_handler);
3915 if (wait_for_rebuild == MTIP_FTL_REBUILD_MAGIC)
3916 rv = wait_for_rebuild;
3918 return rv;
3920 kthread_run_error:
3921 bdput(dd->bdev);
3922 dd->bdev = NULL;
3924 /* Delete our gendisk. This also removes the device from /dev */
3925 del_gendisk(dd->disk);
3927 read_capacity_error:
3928 init_hw_cmds_error:
3929 blk_cleanup_queue(dd->queue);
3930 block_queue_alloc_init_error:
3931 blk_mq_free_tag_set(&dd->tags);
3932 block_queue_alloc_tag_error:
3933 mtip_hw_debugfs_exit(dd);
3934 disk_index_error:
3935 spin_lock(&rssd_index_lock);
3936 ida_remove(&rssd_index_ida, index);
3937 spin_unlock(&rssd_index_lock);
3939 ida_get_error:
3940 put_disk(dd->disk);
3942 alloc_disk_error:
3943 mtip_hw_exit(dd); /* De-initialize the protocol layer. */
3945 protocol_init_error:
3946 return rv;
3949 static void mtip_no_dev_cleanup(struct request *rq, void *data, bool reserv)
3951 struct mtip_cmd *cmd = blk_mq_rq_to_pdu(rq);
3953 cmd->status = BLK_STS_IOERR;
3954 blk_mq_complete_request(rq);
3958 * Block layer deinitialization function.
3960 * Called by the PCI layer as each P320 device is removed.
3962 * @dd Pointer to the driver data structure.
3964 * return value
3967 static int mtip_block_remove(struct driver_data *dd)
3969 struct kobject *kobj;
3971 mtip_hw_debugfs_exit(dd);
3973 if (dd->mtip_svc_handler) {
3974 set_bit(MTIP_PF_SVC_THD_STOP_BIT, &dd->port->flags);
3975 wake_up_interruptible(&dd->port->svc_wait);
3976 kthread_stop(dd->mtip_svc_handler);
3979 /* Clean up the sysfs attributes, if created */
3980 if (test_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag)) {
3981 kobj = kobject_get(&disk_to_dev(dd->disk)->kobj);
3982 if (kobj) {
3983 mtip_hw_sysfs_exit(dd, kobj);
3984 kobject_put(kobj);
3988 if (!dd->sr) {
3990 * Explicitly wait here for IOs to quiesce,
3991 * as mtip_standby_drive usually won't wait for IOs.
3993 if (!mtip_quiesce_io(dd->port, MTIP_QUIESCE_IO_TIMEOUT_MS))
3994 mtip_standby_drive(dd);
3996 else
3997 dev_info(&dd->pdev->dev, "device %s surprise removal\n",
3998 dd->disk->disk_name);
4000 blk_freeze_queue_start(dd->queue);
4001 blk_mq_quiesce_queue(dd->queue);
4002 blk_mq_tagset_busy_iter(&dd->tags, mtip_no_dev_cleanup, dd);
4003 blk_mq_unquiesce_queue(dd->queue);
4006 * Delete our gendisk structure. This also removes the device
4007 * from /dev
4009 if (dd->bdev) {
4010 bdput(dd->bdev);
4011 dd->bdev = NULL;
4013 if (dd->disk) {
4014 if (test_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag))
4015 del_gendisk(dd->disk);
4016 if (dd->disk->queue) {
4017 blk_cleanup_queue(dd->queue);
4018 blk_mq_free_tag_set(&dd->tags);
4019 dd->queue = NULL;
4021 put_disk(dd->disk);
4023 dd->disk = NULL;
4025 spin_lock(&rssd_index_lock);
4026 ida_remove(&rssd_index_ida, dd->index);
4027 spin_unlock(&rssd_index_lock);
4029 /* De-initialize the protocol layer. */
4030 mtip_hw_exit(dd);
4032 return 0;
4036 * Function called by the PCI layer when just before the
4037 * machine shuts down.
4039 * If a protocol layer shutdown function is present it will be called
4040 * by this function.
4042 * @dd Pointer to the driver data structure.
4044 * return value
4047 static int mtip_block_shutdown(struct driver_data *dd)
4049 mtip_hw_shutdown(dd);
4051 /* Delete our gendisk structure, and cleanup the blk queue. */
4052 if (dd->disk) {
4053 dev_info(&dd->pdev->dev,
4054 "Shutting down %s ...\n", dd->disk->disk_name);
4056 if (test_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag))
4057 del_gendisk(dd->disk);
4058 if (dd->disk->queue) {
4059 blk_cleanup_queue(dd->queue);
4060 blk_mq_free_tag_set(&dd->tags);
4062 put_disk(dd->disk);
4063 dd->disk = NULL;
4064 dd->queue = NULL;
4067 spin_lock(&rssd_index_lock);
4068 ida_remove(&rssd_index_ida, dd->index);
4069 spin_unlock(&rssd_index_lock);
4070 return 0;
4073 static int mtip_block_suspend(struct driver_data *dd)
4075 dev_info(&dd->pdev->dev,
4076 "Suspending %s ...\n", dd->disk->disk_name);
4077 mtip_hw_suspend(dd);
4078 return 0;
4081 static int mtip_block_resume(struct driver_data *dd)
4083 dev_info(&dd->pdev->dev, "Resuming %s ...\n",
4084 dd->disk->disk_name);
4085 mtip_hw_resume(dd);
4086 return 0;
4089 static void drop_cpu(int cpu)
4091 cpu_use[cpu]--;
4094 static int get_least_used_cpu_on_node(int node)
4096 int cpu, least_used_cpu, least_cnt;
4097 const struct cpumask *node_mask;
4099 node_mask = cpumask_of_node(node);
4100 least_used_cpu = cpumask_first(node_mask);
4101 least_cnt = cpu_use[least_used_cpu];
4102 cpu = least_used_cpu;
4104 for_each_cpu(cpu, node_mask) {
4105 if (cpu_use[cpu] < least_cnt) {
4106 least_used_cpu = cpu;
4107 least_cnt = cpu_use[cpu];
4110 cpu_use[least_used_cpu]++;
4111 return least_used_cpu;
4114 /* Helper for selecting a node in round robin mode */
4115 static inline int mtip_get_next_rr_node(void)
4117 static int next_node = -1;
4119 if (next_node == -1) {
4120 next_node = first_online_node;
4121 return next_node;
4124 next_node = next_online_node(next_node);
4125 if (next_node == MAX_NUMNODES)
4126 next_node = first_online_node;
4127 return next_node;
4130 static DEFINE_HANDLER(0);
4131 static DEFINE_HANDLER(1);
4132 static DEFINE_HANDLER(2);
4133 static DEFINE_HANDLER(3);
4134 static DEFINE_HANDLER(4);
4135 static DEFINE_HANDLER(5);
4136 static DEFINE_HANDLER(6);
4137 static DEFINE_HANDLER(7);
4139 static void mtip_disable_link_opts(struct driver_data *dd, struct pci_dev *pdev)
4141 int pos;
4142 unsigned short pcie_dev_ctrl;
4144 pos = pci_find_capability(pdev, PCI_CAP_ID_EXP);
4145 if (pos) {
4146 pci_read_config_word(pdev,
4147 pos + PCI_EXP_DEVCTL,
4148 &pcie_dev_ctrl);
4149 if (pcie_dev_ctrl & (1 << 11) ||
4150 pcie_dev_ctrl & (1 << 4)) {
4151 dev_info(&dd->pdev->dev,
4152 "Disabling ERO/No-Snoop on bridge device %04x:%04x\n",
4153 pdev->vendor, pdev->device);
4154 pcie_dev_ctrl &= ~(PCI_EXP_DEVCTL_NOSNOOP_EN |
4155 PCI_EXP_DEVCTL_RELAX_EN);
4156 pci_write_config_word(pdev,
4157 pos + PCI_EXP_DEVCTL,
4158 pcie_dev_ctrl);
4163 static void mtip_fix_ero_nosnoop(struct driver_data *dd, struct pci_dev *pdev)
4166 * This workaround is specific to AMD/ATI chipset with a PCI upstream
4167 * device with device id 0x5aXX
4169 if (pdev->bus && pdev->bus->self) {
4170 if (pdev->bus->self->vendor == PCI_VENDOR_ID_ATI &&
4171 ((pdev->bus->self->device & 0xff00) == 0x5a00)) {
4172 mtip_disable_link_opts(dd, pdev->bus->self);
4173 } else {
4174 /* Check further up the topology */
4175 struct pci_dev *parent_dev = pdev->bus->self;
4176 if (parent_dev->bus &&
4177 parent_dev->bus->parent &&
4178 parent_dev->bus->parent->self &&
4179 parent_dev->bus->parent->self->vendor ==
4180 PCI_VENDOR_ID_ATI &&
4181 (parent_dev->bus->parent->self->device &
4182 0xff00) == 0x5a00) {
4183 mtip_disable_link_opts(dd,
4184 parent_dev->bus->parent->self);
4191 * Called for each supported PCI device detected.
4193 * This function allocates the private data structure, enables the
4194 * PCI device and then calls the block layer initialization function.
4196 * return value
4197 * 0 on success else an error code.
4199 static int mtip_pci_probe(struct pci_dev *pdev,
4200 const struct pci_device_id *ent)
4202 int rv = 0;
4203 struct driver_data *dd = NULL;
4204 char cpu_list[256];
4205 const struct cpumask *node_mask;
4206 int cpu, i = 0, j = 0;
4207 int my_node = NUMA_NO_NODE;
4208 unsigned long flags;
4210 /* Allocate memory for this devices private data. */
4211 my_node = pcibus_to_node(pdev->bus);
4212 if (my_node != NUMA_NO_NODE) {
4213 if (!node_online(my_node))
4214 my_node = mtip_get_next_rr_node();
4215 } else {
4216 dev_info(&pdev->dev, "Kernel not reporting proximity, choosing a node\n");
4217 my_node = mtip_get_next_rr_node();
4219 dev_info(&pdev->dev, "NUMA node %d (closest: %d,%d, probe on %d:%d)\n",
4220 my_node, pcibus_to_node(pdev->bus), dev_to_node(&pdev->dev),
4221 cpu_to_node(raw_smp_processor_id()), raw_smp_processor_id());
4223 dd = kzalloc_node(sizeof(struct driver_data), GFP_KERNEL, my_node);
4224 if (dd == NULL) {
4225 dev_err(&pdev->dev,
4226 "Unable to allocate memory for driver data\n");
4227 return -ENOMEM;
4230 /* Attach the private data to this PCI device. */
4231 pci_set_drvdata(pdev, dd);
4233 rv = pcim_enable_device(pdev);
4234 if (rv < 0) {
4235 dev_err(&pdev->dev, "Unable to enable device\n");
4236 goto iomap_err;
4239 /* Map BAR5 to memory. */
4240 rv = pcim_iomap_regions(pdev, 1 << MTIP_ABAR, MTIP_DRV_NAME);
4241 if (rv < 0) {
4242 dev_err(&pdev->dev, "Unable to map regions\n");
4243 goto iomap_err;
4246 if (!pci_set_dma_mask(pdev, DMA_BIT_MASK(64))) {
4247 rv = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
4249 if (rv) {
4250 rv = pci_set_consistent_dma_mask(pdev,
4251 DMA_BIT_MASK(32));
4252 if (rv) {
4253 dev_warn(&pdev->dev,
4254 "64-bit DMA enable failed\n");
4255 goto setmask_err;
4260 /* Copy the info we may need later into the private data structure. */
4261 dd->major = mtip_major;
4262 dd->instance = instance;
4263 dd->pdev = pdev;
4264 dd->numa_node = my_node;
4266 INIT_LIST_HEAD(&dd->online_list);
4267 INIT_LIST_HEAD(&dd->remove_list);
4269 memset(dd->workq_name, 0, 32);
4270 snprintf(dd->workq_name, 31, "mtipq%d", dd->instance);
4272 dd->isr_workq = create_workqueue(dd->workq_name);
4273 if (!dd->isr_workq) {
4274 dev_warn(&pdev->dev, "Can't create wq %d\n", dd->instance);
4275 rv = -ENOMEM;
4276 goto block_initialize_err;
4279 memset(cpu_list, 0, sizeof(cpu_list));
4281 node_mask = cpumask_of_node(dd->numa_node);
4282 if (!cpumask_empty(node_mask)) {
4283 for_each_cpu(cpu, node_mask)
4285 snprintf(&cpu_list[j], 256 - j, "%d ", cpu);
4286 j = strlen(cpu_list);
4289 dev_info(&pdev->dev, "Node %d on package %d has %d cpu(s): %s\n",
4290 dd->numa_node,
4291 topology_physical_package_id(cpumask_first(node_mask)),
4292 nr_cpus_node(dd->numa_node),
4293 cpu_list);
4294 } else
4295 dev_dbg(&pdev->dev, "mtip32xx: node_mask empty\n");
4297 dd->isr_binding = get_least_used_cpu_on_node(dd->numa_node);
4298 dev_info(&pdev->dev, "Initial IRQ binding node:cpu %d:%d\n",
4299 cpu_to_node(dd->isr_binding), dd->isr_binding);
4301 /* first worker context always runs in ISR */
4302 dd->work[0].cpu_binding = dd->isr_binding;
4303 dd->work[1].cpu_binding = get_least_used_cpu_on_node(dd->numa_node);
4304 dd->work[2].cpu_binding = get_least_used_cpu_on_node(dd->numa_node);
4305 dd->work[3].cpu_binding = dd->work[0].cpu_binding;
4306 dd->work[4].cpu_binding = dd->work[1].cpu_binding;
4307 dd->work[5].cpu_binding = dd->work[2].cpu_binding;
4308 dd->work[6].cpu_binding = dd->work[2].cpu_binding;
4309 dd->work[7].cpu_binding = dd->work[1].cpu_binding;
4311 /* Log the bindings */
4312 for_each_present_cpu(cpu) {
4313 memset(cpu_list, 0, sizeof(cpu_list));
4314 for (i = 0, j = 0; i < MTIP_MAX_SLOT_GROUPS; i++) {
4315 if (dd->work[i].cpu_binding == cpu) {
4316 snprintf(&cpu_list[j], 256 - j, "%d ", i);
4317 j = strlen(cpu_list);
4320 if (j)
4321 dev_info(&pdev->dev, "CPU %d: WQs %s\n", cpu, cpu_list);
4324 INIT_WORK(&dd->work[0].work, mtip_workq_sdbf0);
4325 INIT_WORK(&dd->work[1].work, mtip_workq_sdbf1);
4326 INIT_WORK(&dd->work[2].work, mtip_workq_sdbf2);
4327 INIT_WORK(&dd->work[3].work, mtip_workq_sdbf3);
4328 INIT_WORK(&dd->work[4].work, mtip_workq_sdbf4);
4329 INIT_WORK(&dd->work[5].work, mtip_workq_sdbf5);
4330 INIT_WORK(&dd->work[6].work, mtip_workq_sdbf6);
4331 INIT_WORK(&dd->work[7].work, mtip_workq_sdbf7);
4333 pci_set_master(pdev);
4334 rv = pci_enable_msi(pdev);
4335 if (rv) {
4336 dev_warn(&pdev->dev,
4337 "Unable to enable MSI interrupt.\n");
4338 goto msi_initialize_err;
4341 mtip_fix_ero_nosnoop(dd, pdev);
4343 /* Initialize the block layer. */
4344 rv = mtip_block_initialize(dd);
4345 if (rv < 0) {
4346 dev_err(&pdev->dev,
4347 "Unable to initialize block layer\n");
4348 goto block_initialize_err;
4352 * Increment the instance count so that each device has a unique
4353 * instance number.
4355 instance++;
4356 if (rv != MTIP_FTL_REBUILD_MAGIC)
4357 set_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag);
4358 else
4359 rv = 0; /* device in rebuild state, return 0 from probe */
4361 /* Add to online list even if in ftl rebuild */
4362 spin_lock_irqsave(&dev_lock, flags);
4363 list_add(&dd->online_list, &online_list);
4364 spin_unlock_irqrestore(&dev_lock, flags);
4366 goto done;
4368 block_initialize_err:
4369 pci_disable_msi(pdev);
4371 msi_initialize_err:
4372 if (dd->isr_workq) {
4373 flush_workqueue(dd->isr_workq);
4374 destroy_workqueue(dd->isr_workq);
4375 drop_cpu(dd->work[0].cpu_binding);
4376 drop_cpu(dd->work[1].cpu_binding);
4377 drop_cpu(dd->work[2].cpu_binding);
4379 setmask_err:
4380 pcim_iounmap_regions(pdev, 1 << MTIP_ABAR);
4382 iomap_err:
4383 kfree(dd);
4384 pci_set_drvdata(pdev, NULL);
4385 return rv;
4386 done:
4387 return rv;
4391 * Called for each probed device when the device is removed or the
4392 * driver is unloaded.
4394 * return value
4395 * None
4397 static void mtip_pci_remove(struct pci_dev *pdev)
4399 struct driver_data *dd = pci_get_drvdata(pdev);
4400 unsigned long flags, to;
4402 set_bit(MTIP_DDF_REMOVAL_BIT, &dd->dd_flag);
4404 spin_lock_irqsave(&dev_lock, flags);
4405 list_del_init(&dd->online_list);
4406 list_add(&dd->remove_list, &removing_list);
4407 spin_unlock_irqrestore(&dev_lock, flags);
4409 mtip_check_surprise_removal(pdev);
4410 synchronize_irq(dd->pdev->irq);
4412 /* Spin until workers are done */
4413 to = jiffies + msecs_to_jiffies(4000);
4414 do {
4415 msleep(20);
4416 } while (atomic_read(&dd->irq_workers_active) != 0 &&
4417 time_before(jiffies, to));
4419 if (!dd->sr)
4420 fsync_bdev(dd->bdev);
4422 if (atomic_read(&dd->irq_workers_active) != 0) {
4423 dev_warn(&dd->pdev->dev,
4424 "Completion workers still active!\n");
4427 blk_set_queue_dying(dd->queue);
4428 set_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag);
4430 /* Clean up the block layer. */
4431 mtip_block_remove(dd);
4433 if (dd->isr_workq) {
4434 flush_workqueue(dd->isr_workq);
4435 destroy_workqueue(dd->isr_workq);
4436 drop_cpu(dd->work[0].cpu_binding);
4437 drop_cpu(dd->work[1].cpu_binding);
4438 drop_cpu(dd->work[2].cpu_binding);
4441 pci_disable_msi(pdev);
4443 spin_lock_irqsave(&dev_lock, flags);
4444 list_del_init(&dd->remove_list);
4445 spin_unlock_irqrestore(&dev_lock, flags);
4447 kfree(dd);
4449 pcim_iounmap_regions(pdev, 1 << MTIP_ABAR);
4450 pci_set_drvdata(pdev, NULL);
4454 * Called for each probed device when the device is suspended.
4456 * return value
4457 * 0 Success
4458 * <0 Error
4460 static int mtip_pci_suspend(struct pci_dev *pdev, pm_message_t mesg)
4462 int rv = 0;
4463 struct driver_data *dd = pci_get_drvdata(pdev);
4465 if (!dd) {
4466 dev_err(&pdev->dev,
4467 "Driver private datastructure is NULL\n");
4468 return -EFAULT;
4471 set_bit(MTIP_DDF_RESUME_BIT, &dd->dd_flag);
4473 /* Disable ports & interrupts then send standby immediate */
4474 rv = mtip_block_suspend(dd);
4475 if (rv < 0) {
4476 dev_err(&pdev->dev,
4477 "Failed to suspend controller\n");
4478 return rv;
4482 * Save the pci config space to pdev structure &
4483 * disable the device
4485 pci_save_state(pdev);
4486 pci_disable_device(pdev);
4488 /* Move to Low power state*/
4489 pci_set_power_state(pdev, PCI_D3hot);
4491 return rv;
4495 * Called for each probed device when the device is resumed.
4497 * return value
4498 * 0 Success
4499 * <0 Error
4501 static int mtip_pci_resume(struct pci_dev *pdev)
4503 int rv = 0;
4504 struct driver_data *dd;
4506 dd = pci_get_drvdata(pdev);
4507 if (!dd) {
4508 dev_err(&pdev->dev,
4509 "Driver private datastructure is NULL\n");
4510 return -EFAULT;
4513 /* Move the device to active State */
4514 pci_set_power_state(pdev, PCI_D0);
4516 /* Restore PCI configuration space */
4517 pci_restore_state(pdev);
4519 /* Enable the PCI device*/
4520 rv = pcim_enable_device(pdev);
4521 if (rv < 0) {
4522 dev_err(&pdev->dev,
4523 "Failed to enable card during resume\n");
4524 goto err;
4526 pci_set_master(pdev);
4529 * Calls hbaReset, initPort, & startPort function
4530 * then enables interrupts
4532 rv = mtip_block_resume(dd);
4533 if (rv < 0)
4534 dev_err(&pdev->dev, "Unable to resume\n");
4536 err:
4537 clear_bit(MTIP_DDF_RESUME_BIT, &dd->dd_flag);
4539 return rv;
4543 * Shutdown routine
4545 * return value
4546 * None
4548 static void mtip_pci_shutdown(struct pci_dev *pdev)
4550 struct driver_data *dd = pci_get_drvdata(pdev);
4551 if (dd)
4552 mtip_block_shutdown(dd);
4555 /* Table of device ids supported by this driver. */
4556 static const struct pci_device_id mtip_pci_tbl[] = {
4557 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P320H_DEVICE_ID) },
4558 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P320M_DEVICE_ID) },
4559 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P320S_DEVICE_ID) },
4560 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P325M_DEVICE_ID) },
4561 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P420H_DEVICE_ID) },
4562 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P420M_DEVICE_ID) },
4563 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P425M_DEVICE_ID) },
4564 { 0 }
4567 /* Structure that describes the PCI driver functions. */
4568 static struct pci_driver mtip_pci_driver = {
4569 .name = MTIP_DRV_NAME,
4570 .id_table = mtip_pci_tbl,
4571 .probe = mtip_pci_probe,
4572 .remove = mtip_pci_remove,
4573 .suspend = mtip_pci_suspend,
4574 .resume = mtip_pci_resume,
4575 .shutdown = mtip_pci_shutdown,
4578 MODULE_DEVICE_TABLE(pci, mtip_pci_tbl);
4581 * Module initialization function.
4583 * Called once when the module is loaded. This function allocates a major
4584 * block device number to the Cyclone devices and registers the PCI layer
4585 * of the driver.
4587 * Return value
4588 * 0 on success else error code.
4590 static int __init mtip_init(void)
4592 int error;
4594 pr_info(MTIP_DRV_NAME " Version " MTIP_DRV_VERSION "\n");
4596 spin_lock_init(&dev_lock);
4598 INIT_LIST_HEAD(&online_list);
4599 INIT_LIST_HEAD(&removing_list);
4601 /* Allocate a major block device number to use with this driver. */
4602 error = register_blkdev(0, MTIP_DRV_NAME);
4603 if (error <= 0) {
4604 pr_err("Unable to register block device (%d)\n",
4605 error);
4606 return -EBUSY;
4608 mtip_major = error;
4610 dfs_parent = debugfs_create_dir("rssd", NULL);
4611 if (IS_ERR_OR_NULL(dfs_parent)) {
4612 pr_warn("Error creating debugfs parent\n");
4613 dfs_parent = NULL;
4615 if (dfs_parent) {
4616 dfs_device_status = debugfs_create_file("device_status",
4617 S_IRUGO, dfs_parent, NULL,
4618 &mtip_device_status_fops);
4619 if (IS_ERR_OR_NULL(dfs_device_status)) {
4620 pr_err("Error creating device_status node\n");
4621 dfs_device_status = NULL;
4625 /* Register our PCI operations. */
4626 error = pci_register_driver(&mtip_pci_driver);
4627 if (error) {
4628 debugfs_remove(dfs_parent);
4629 unregister_blkdev(mtip_major, MTIP_DRV_NAME);
4632 return error;
4636 * Module de-initialization function.
4638 * Called once when the module is unloaded. This function deallocates
4639 * the major block device number allocated by mtip_init() and
4640 * unregisters the PCI layer of the driver.
4642 * Return value
4643 * none
4645 static void __exit mtip_exit(void)
4647 /* Release the allocated major block device number. */
4648 unregister_blkdev(mtip_major, MTIP_DRV_NAME);
4650 /* Unregister the PCI driver. */
4651 pci_unregister_driver(&mtip_pci_driver);
4653 debugfs_remove_recursive(dfs_parent);
4656 MODULE_AUTHOR("Micron Technology, Inc");
4657 MODULE_DESCRIPTION("Micron RealSSD PCIe Block Driver");
4658 MODULE_LICENSE("GPL");
4659 MODULE_VERSION(MTIP_DRV_VERSION);
4661 module_init(mtip_init);
4662 module_exit(mtip_exit);