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
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>
31 #include <linux/module.h>
32 #include <linux/genhd.h>
33 #include <linux/blkdev.h>
34 #include <linux/bio.h>
35 #include <linux/dma-mapping.h>
36 #include <linux/idr.h>
37 #include <linux/kthread.h>
38 #include <../drivers/ata/ahci.h>
39 #include <linux/export.h>
42 #define HW_CMD_SLOT_SZ (MTIP_MAX_COMMAND_SLOTS * 32)
43 #define HW_CMD_TBL_SZ (AHCI_CMD_TBL_HDR_SZ + (MTIP_MAX_SG * 16))
44 #define HW_CMD_TBL_AR_SZ (HW_CMD_TBL_SZ * MTIP_MAX_COMMAND_SLOTS)
45 #define HW_PORT_PRIV_DMA_SZ \
46 (HW_CMD_SLOT_SZ + HW_CMD_TBL_AR_SZ + AHCI_RX_FIS_SZ)
48 #define HOST_CAP_NZDMA (1 << 19)
49 #define HOST_HSORG 0xFC
50 #define HSORG_DISABLE_SLOTGRP_INTR (1<<24)
51 #define HSORG_DISABLE_SLOTGRP_PXIS (1<<16)
52 #define HSORG_HWREV 0xFF00
53 #define HSORG_STYLE 0x8
54 #define HSORG_SLOTGROUPS 0x7
56 #define PORT_COMMAND_ISSUE 0x38
57 #define PORT_SDBV 0x7C
59 #define PORT_OFFSET 0x100
60 #define PORT_MEM_SIZE 0x80
62 #define PORT_IRQ_ERR \
63 (PORT_IRQ_HBUS_ERR | PORT_IRQ_IF_ERR | PORT_IRQ_CONNECT | \
64 PORT_IRQ_PHYRDY | PORT_IRQ_UNK_FIS | PORT_IRQ_BAD_PMP | \
65 PORT_IRQ_TF_ERR | PORT_IRQ_HBUS_DATA_ERR | PORT_IRQ_IF_NONFATAL | \
67 #define PORT_IRQ_LEGACY \
68 (PORT_IRQ_PIOS_FIS | PORT_IRQ_D2H_REG_FIS)
69 #define PORT_IRQ_HANDLED \
70 (PORT_IRQ_SDB_FIS | PORT_IRQ_LEGACY | \
71 PORT_IRQ_TF_ERR | PORT_IRQ_IF_ERR | \
72 PORT_IRQ_CONNECT | PORT_IRQ_PHYRDY)
73 #define DEF_PORT_IRQ \
74 (PORT_IRQ_ERR | PORT_IRQ_LEGACY | PORT_IRQ_SDB_FIS)
77 #define MTIP_PRODUCT_UNKNOWN 0x00
78 #define MTIP_PRODUCT_ASICFPGA 0x11
80 /* Device instance number, incremented each time a device is probed. */
84 * Global variable used to hold the major block device number
85 * allocated in mtip_init().
87 static int mtip_major;
89 static DEFINE_SPINLOCK(rssd_index_lock);
90 static DEFINE_IDA(rssd_index_ida);
92 static int mtip_block_initialize(struct driver_data *dd);
95 struct mtip_compat_ide_task_request_s {
98 ide_reg_valid_t out_flags;
99 ide_reg_valid_t in_flags;
102 compat_ulong_t out_size;
103 compat_ulong_t in_size;
108 * This function check_for_surprise_removal is called
109 * while card is removed from the system and it will
110 * read the vendor id from the configration space
112 * @pdev Pointer to the pci_dev structure.
115 * true if device removed, else false
117 static bool mtip_check_surprise_removal(struct pci_dev *pdev)
121 /* Read the vendorID from the configuration space */
122 pci_read_config_word(pdev, 0x00, &vendor_id);
123 if (vendor_id == 0xFFFF)
124 return true; /* device removed */
126 return false; /* device present */
130 * This function is called for clean the pending command in the
131 * command slot during the surprise removal of device and return
132 * error to the upper layer.
134 * @dd Pointer to the DRIVER_DATA structure.
139 static void mtip_command_cleanup(struct driver_data *dd)
141 int group = 0, commandslot = 0, commandindex = 0;
142 struct mtip_cmd *command;
143 struct mtip_port *port = dd->port;
144 static int in_progress;
151 for (group = 0; group < 4; group++) {
152 for (commandslot = 0; commandslot < 32; commandslot++) {
153 if (!(port->allocated[group] & (1 << commandslot)))
156 commandindex = group << 5 | commandslot;
157 command = &port->commands[commandindex];
159 if (atomic_read(&command->active)
160 && (command->async_callback)) {
161 command->async_callback(command->async_data,
163 command->async_callback = NULL;
164 command->async_data = NULL;
167 dma_unmap_sg(&port->dd->pdev->dev,
169 command->scatter_ents,
176 set_bit(MTIP_DDF_CLEANUP_BIT, &dd->dd_flag);
181 * Obtain an empty command slot.
183 * This function needs to be reentrant since it could be called
184 * at the same time on multiple CPUs. The allocation of the
185 * command slot must be atomic.
187 * @port Pointer to the port data structure.
190 * >= 0 Index of command slot obtained.
191 * -1 No command slots available.
193 static int get_slot(struct mtip_port *port)
196 unsigned int num_command_slots = port->dd->slot_groups * 32;
199 * Try 10 times, because there is a small race here.
200 * that's ok, because it's still cheaper than a lock.
202 * Race: Since this section is not protected by lock, same bit
203 * could be chosen by different process contexts running in
204 * different processor. So instead of costly lock, we are going
207 for (i = 0; i < 10; i++) {
208 slot = find_next_zero_bit(port->allocated,
209 num_command_slots, 1);
210 if ((slot < num_command_slots) &&
211 (!test_and_set_bit(slot, port->allocated)))
214 dev_warn(&port->dd->pdev->dev, "Failed to get a tag.\n");
216 if (mtip_check_surprise_removal(port->dd->pdev)) {
217 /* Device not present, clean outstanding commands */
218 mtip_command_cleanup(port->dd);
224 * Release a command slot.
226 * @port Pointer to the port data structure.
227 * @tag Tag of command to release
232 static inline void release_slot(struct mtip_port *port, int tag)
234 smp_mb__before_clear_bit();
235 clear_bit(tag, port->allocated);
236 smp_mb__after_clear_bit();
240 * Reset the HBA (without sleeping)
242 * Just like hba_reset, except does not call sleep, so can be
243 * run from interrupt/tasklet context.
245 * @dd Pointer to the driver data structure.
248 * 0 The reset was successful.
249 * -1 The HBA Reset bit did not clear.
251 static int hba_reset_nosleep(struct driver_data *dd)
253 unsigned long timeout;
255 /* Chip quirk: quiesce any chip function */
258 /* Set the reset bit */
259 writel(HOST_RESET, dd->mmio + HOST_CTL);
262 readl(dd->mmio + HOST_CTL);
265 * Wait 10ms then spin for up to 1 second
266 * waiting for reset acknowledgement
268 timeout = jiffies + msecs_to_jiffies(1000);
270 while ((readl(dd->mmio + HOST_CTL) & HOST_RESET)
271 && time_before(jiffies, timeout))
274 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))
277 if (readl(dd->mmio + HOST_CTL) & HOST_RESET)
284 * Issue a command to the hardware.
286 * Set the appropriate bit in the s_active and Command Issue hardware
287 * registers, causing hardware command processing to begin.
289 * @port Pointer to the port structure.
290 * @tag The tag of the command to be issued.
295 static inline void mtip_issue_ncq_command(struct mtip_port *port, int tag)
297 unsigned long flags = 0;
299 atomic_set(&port->commands[tag].active, 1);
301 spin_lock_irqsave(&port->cmd_issue_lock, flags);
303 writel((1 << MTIP_TAG_BIT(tag)),
304 port->s_active[MTIP_TAG_INDEX(tag)]);
305 writel((1 << MTIP_TAG_BIT(tag)),
306 port->cmd_issue[MTIP_TAG_INDEX(tag)]);
308 spin_unlock_irqrestore(&port->cmd_issue_lock, flags);
310 /* Set the command's timeout value.*/
311 port->commands[tag].comp_time = jiffies + msecs_to_jiffies(
312 MTIP_NCQ_COMMAND_TIMEOUT_MS);
316 * Enable/disable the reception of FIS
318 * @port Pointer to the port data structure
319 * @enable 1 to enable, 0 to disable
322 * Previous state: 1 enabled, 0 disabled
324 static int mtip_enable_fis(struct mtip_port *port, int enable)
328 /* enable FIS reception */
329 tmp = readl(port->mmio + PORT_CMD);
331 writel(tmp | PORT_CMD_FIS_RX, port->mmio + PORT_CMD);
333 writel(tmp & ~PORT_CMD_FIS_RX, port->mmio + PORT_CMD);
336 readl(port->mmio + PORT_CMD);
338 return (((tmp & PORT_CMD_FIS_RX) == PORT_CMD_FIS_RX));
342 * Enable/disable the DMA engine
344 * @port Pointer to the port data structure
345 * @enable 1 to enable, 0 to disable
348 * Previous state: 1 enabled, 0 disabled.
350 static int mtip_enable_engine(struct mtip_port *port, int enable)
354 /* enable FIS reception */
355 tmp = readl(port->mmio + PORT_CMD);
357 writel(tmp | PORT_CMD_START, port->mmio + PORT_CMD);
359 writel(tmp & ~PORT_CMD_START, port->mmio + PORT_CMD);
361 readl(port->mmio + PORT_CMD);
362 return (((tmp & PORT_CMD_START) == PORT_CMD_START));
366 * Enables the port DMA engine and FIS reception.
371 static inline void mtip_start_port(struct mtip_port *port)
373 /* Enable FIS reception */
374 mtip_enable_fis(port, 1);
376 /* Enable the DMA engine */
377 mtip_enable_engine(port, 1);
381 * Deinitialize a port by disabling port interrupts, the DMA engine,
384 * @port Pointer to the port structure
389 static inline void mtip_deinit_port(struct mtip_port *port)
391 /* Disable interrupts on this port */
392 writel(0, port->mmio + PORT_IRQ_MASK);
394 /* Disable the DMA engine */
395 mtip_enable_engine(port, 0);
397 /* Disable FIS reception */
398 mtip_enable_fis(port, 0);
404 * This function deinitializes the port by calling mtip_deinit_port() and
405 * then initializes it by setting the command header and RX FIS addresses,
406 * clearing the SError register and any pending port interrupts before
407 * re-enabling the default set of port interrupts.
409 * @port Pointer to the port structure.
414 static void mtip_init_port(struct mtip_port *port)
417 mtip_deinit_port(port);
419 /* Program the command list base and FIS base addresses */
420 if (readl(port->dd->mmio + HOST_CAP) & HOST_CAP_64) {
421 writel((port->command_list_dma >> 16) >> 16,
422 port->mmio + PORT_LST_ADDR_HI);
423 writel((port->rxfis_dma >> 16) >> 16,
424 port->mmio + PORT_FIS_ADDR_HI);
427 writel(port->command_list_dma & 0xFFFFFFFF,
428 port->mmio + PORT_LST_ADDR);
429 writel(port->rxfis_dma & 0xFFFFFFFF, port->mmio + PORT_FIS_ADDR);
432 writel(readl(port->mmio + PORT_SCR_ERR), port->mmio + PORT_SCR_ERR);
434 /* reset the completed registers.*/
435 for (i = 0; i < port->dd->slot_groups; i++)
436 writel(0xFFFFFFFF, port->completed[i]);
438 /* Clear any pending interrupts for this port */
439 writel(readl(port->dd->mmio + PORT_IRQ_STAT),
440 port->dd->mmio + PORT_IRQ_STAT);
442 /* Clear any pending interrupts on the HBA. */
443 writel(readl(port->dd->mmio + HOST_IRQ_STAT),
444 port->dd->mmio + HOST_IRQ_STAT);
446 /* Enable port interrupts */
447 writel(DEF_PORT_IRQ, port->mmio + PORT_IRQ_MASK);
453 * @port Pointer to the port data structure.
458 static void mtip_restart_port(struct mtip_port *port)
460 unsigned long timeout;
462 /* Disable the DMA engine */
463 mtip_enable_engine(port, 0);
465 /* Chip quirk: wait up to 500ms for PxCMD.CR == 0 */
466 timeout = jiffies + msecs_to_jiffies(500);
467 while ((readl(port->mmio + PORT_CMD) & PORT_CMD_LIST_ON)
468 && time_before(jiffies, timeout))
471 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
475 * Chip quirk: escalate to hba reset if
476 * PxCMD.CR not clear after 500 ms
478 if (readl(port->mmio + PORT_CMD) & PORT_CMD_LIST_ON) {
479 dev_warn(&port->dd->pdev->dev,
480 "PxCMD.CR not clear, escalating reset\n");
482 if (hba_reset_nosleep(port->dd))
483 dev_err(&port->dd->pdev->dev,
484 "HBA reset escalation failed.\n");
486 /* 30 ms delay before com reset to quiesce chip */
490 dev_warn(&port->dd->pdev->dev, "Issuing COM reset\n");
493 writel(readl(port->mmio + PORT_SCR_CTL) |
494 1, port->mmio + PORT_SCR_CTL);
495 readl(port->mmio + PORT_SCR_CTL);
497 /* Wait 1 ms to quiesce chip function */
498 timeout = jiffies + msecs_to_jiffies(1);
499 while (time_before(jiffies, timeout))
502 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
505 /* Clear PxSCTL.DET */
506 writel(readl(port->mmio + PORT_SCR_CTL) & ~1,
507 port->mmio + PORT_SCR_CTL);
508 readl(port->mmio + PORT_SCR_CTL);
510 /* Wait 500 ms for bit 0 of PORT_SCR_STS to be set */
511 timeout = jiffies + msecs_to_jiffies(500);
512 while (((readl(port->mmio + PORT_SCR_STAT) & 0x01) == 0)
513 && time_before(jiffies, timeout))
516 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
519 if ((readl(port->mmio + PORT_SCR_STAT) & 0x01) == 0)
520 dev_warn(&port->dd->pdev->dev,
521 "COM reset failed\n");
523 mtip_init_port(port);
524 mtip_start_port(port);
529 * Helper function for tag logging
531 static void print_tags(struct driver_data *dd,
533 unsigned long *tagbits,
536 unsigned char tagmap[128];
537 int group, tagmap_len = 0;
539 memset(tagmap, 0, sizeof(tagmap));
540 for (group = SLOTBITS_IN_LONGS; group > 0; group--)
541 tagmap_len = sprintf(tagmap + tagmap_len, "%016lX ",
543 dev_warn(&dd->pdev->dev,
544 "%d command(s) %s: tagmap [%s]", cnt, msg, tagmap);
548 * Called periodically to see if any read/write commands are
549 * taking too long to complete.
551 * @data Pointer to the PORT data structure.
556 static void mtip_timeout_function(unsigned long int data)
558 struct mtip_port *port = (struct mtip_port *) data;
559 struct host_to_dev_fis *fis;
560 struct mtip_cmd *command;
561 int tag, cmdto_cnt = 0;
562 unsigned int bit, group;
563 unsigned int num_command_slots = port->dd->slot_groups * 32;
564 unsigned long to, tagaccum[SLOTBITS_IN_LONGS];
569 if (test_bit(MTIP_DDF_RESUME_BIT, &port->dd->dd_flag)) {
570 mod_timer(&port->cmd_timer,
571 jiffies + msecs_to_jiffies(30000));
574 /* clear the tag accumulator */
575 memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
577 for (tag = 0; tag < num_command_slots; tag++) {
579 * Skip internal command slot as it has
580 * its own timeout mechanism
582 if (tag == MTIP_TAG_INTERNAL)
585 if (atomic_read(&port->commands[tag].active) &&
586 (time_after(jiffies, port->commands[tag].comp_time))) {
590 command = &port->commands[tag];
591 fis = (struct host_to_dev_fis *) command->command;
593 set_bit(tag, tagaccum);
596 set_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
599 * Clear the completed bit. This should prevent
600 * any interrupt handlers from trying to retire
603 writel(1 << bit, port->completed[group]);
605 /* Call the async completion callback. */
606 if (likely(command->async_callback))
607 command->async_callback(command->async_data,
609 command->async_callback = NULL;
610 command->comp_func = NULL;
612 /* Unmap the DMA scatter list entries */
613 dma_unmap_sg(&port->dd->pdev->dev,
615 command->scatter_ents,
619 * Clear the allocated bit and active tag for the
622 atomic_set(&port->commands[tag].active, 0);
623 release_slot(port, tag);
629 if (cmdto_cnt && !test_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags)) {
630 print_tags(port->dd, "timed out", tagaccum, cmdto_cnt);
632 mtip_restart_port(port);
633 clear_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
634 wake_up_interruptible(&port->svc_wait);
637 if (port->ic_pause_timer) {
638 to = port->ic_pause_timer + msecs_to_jiffies(1000);
639 if (time_after(jiffies, to)) {
640 if (!test_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags)) {
641 port->ic_pause_timer = 0;
642 clear_bit(MTIP_PF_SE_ACTIVE_BIT, &port->flags);
643 clear_bit(MTIP_PF_DM_ACTIVE_BIT, &port->flags);
644 clear_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
645 wake_up_interruptible(&port->svc_wait);
652 /* Restart the timer */
653 mod_timer(&port->cmd_timer,
654 jiffies + msecs_to_jiffies(MTIP_TIMEOUT_CHECK_PERIOD));
658 * IO completion function.
660 * This completion function is called by the driver ISR when a
661 * command that was issued by the kernel completes. It first calls the
662 * asynchronous completion function which normally calls back into the block
663 * layer passing the asynchronous callback data, then unmaps the
664 * scatter list associated with the completed command, and finally
665 * clears the allocated bit associated with the completed command.
667 * @port Pointer to the port data structure.
668 * @tag Tag of the command.
669 * @data Pointer to driver_data.
670 * @status Completion status.
675 static void mtip_async_complete(struct mtip_port *port,
680 struct mtip_cmd *command;
681 struct driver_data *dd = data;
682 int cb_status = status ? -EIO : 0;
684 if (unlikely(!dd) || unlikely(!port))
687 command = &port->commands[tag];
689 if (unlikely(status == PORT_IRQ_TF_ERR)) {
690 dev_warn(&port->dd->pdev->dev,
691 "Command tag %d failed due to TFE\n", tag);
694 /* Upper layer callback */
695 if (likely(command->async_callback))
696 command->async_callback(command->async_data, cb_status);
698 command->async_callback = NULL;
699 command->comp_func = NULL;
701 /* Unmap the DMA scatter list entries */
702 dma_unmap_sg(&dd->pdev->dev,
704 command->scatter_ents,
707 /* Clear the allocated and active bits for the command */
708 atomic_set(&port->commands[tag].active, 0);
709 release_slot(port, tag);
715 * Internal command completion callback function.
717 * This function is normally called by the driver ISR when an internal
718 * command completed. This function signals the command completion by
719 * calling complete().
721 * @port Pointer to the port data structure.
722 * @tag Tag of the command that has completed.
723 * @data Pointer to a completion structure.
724 * @status Completion status.
729 static void mtip_completion(struct mtip_port *port,
734 struct mtip_cmd *command = &port->commands[tag];
735 struct completion *waiting = data;
736 if (unlikely(status == PORT_IRQ_TF_ERR))
737 dev_warn(&port->dd->pdev->dev,
738 "Internal command %d completed with TFE\n", tag);
740 command->async_callback = NULL;
741 command->comp_func = NULL;
746 static void mtip_null_completion(struct mtip_port *port,
754 static int mtip_read_log_page(struct mtip_port *port, u8 page, u16 *buffer,
755 dma_addr_t buffer_dma, unsigned int sectors);
756 static int mtip_get_smart_attr(struct mtip_port *port, unsigned int id,
757 struct smart_attr *attrib);
761 * @dd Pointer to the DRIVER_DATA structure.
766 static void mtip_handle_tfe(struct driver_data *dd)
768 int group, tag, bit, reissue, rv;
769 struct mtip_port *port;
770 struct mtip_cmd *cmd;
772 struct host_to_dev_fis *fis;
773 unsigned long tagaccum[SLOTBITS_IN_LONGS];
774 unsigned int cmd_cnt = 0;
776 char *fail_reason = NULL;
777 int fail_all_ncq_write = 0, fail_all_ncq_cmds = 0;
779 dev_warn(&dd->pdev->dev, "Taskfile error\n");
783 /* Stop the timer to prevent command timeouts. */
784 del_timer(&port->cmd_timer);
786 /* clear the tag accumulator */
787 memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
790 set_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
792 /* Loop through all the groups */
793 for (group = 0; group < dd->slot_groups; group++) {
794 completed = readl(port->completed[group]);
796 /* clear completed status register in the hardware.*/
797 writel(completed, port->completed[group]);
799 /* Process successfully completed commands */
800 for (bit = 0; bit < 32 && completed; bit++) {
801 if (!(completed & (1<<bit)))
803 tag = (group << 5) + bit;
805 /* Skip the internal command slot */
806 if (tag == MTIP_TAG_INTERNAL)
809 cmd = &port->commands[tag];
810 if (likely(cmd->comp_func)) {
811 set_bit(tag, tagaccum);
813 atomic_set(&cmd->active, 0);
819 dev_err(&port->dd->pdev->dev,
820 "Missing completion func for tag %d",
822 if (mtip_check_surprise_removal(dd->pdev)) {
823 mtip_command_cleanup(dd);
824 /* don't proceed further */
831 print_tags(dd, "completed (TFE)", tagaccum, cmd_cnt);
833 /* Restart the port */
835 mtip_restart_port(port);
837 /* Trying to determine the cause of the error */
838 rv = mtip_read_log_page(dd->port, ATA_LOG_SATA_NCQ,
840 dd->port->log_buf_dma, 1);
842 dev_warn(&dd->pdev->dev,
843 "Error in READ LOG EXT (10h) command\n");
844 /* non-critical error, don't fail the load */
846 buf = (unsigned char *)dd->port->log_buf;
847 if (buf[259] & 0x1) {
848 dev_info(&dd->pdev->dev,
849 "Write protect bit is set.\n");
850 set_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag);
851 fail_all_ncq_write = 1;
852 fail_reason = "write protect";
854 if (buf[288] == 0xF7) {
855 dev_info(&dd->pdev->dev,
856 "Exceeded Tmax, drive in thermal shutdown.\n");
857 set_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag);
858 fail_all_ncq_cmds = 1;
859 fail_reason = "thermal shutdown";
861 if (buf[288] == 0xBF) {
862 dev_info(&dd->pdev->dev,
863 "Drive indicates rebuild has failed.\n");
864 fail_all_ncq_cmds = 1;
865 fail_reason = "rebuild failed";
869 /* clear the tag accumulator */
870 memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
872 /* Loop through all the groups */
873 for (group = 0; group < dd->slot_groups; group++) {
874 for (bit = 0; bit < 32; bit++) {
876 tag = (group << 5) + bit;
877 cmd = &port->commands[tag];
879 /* If the active bit is set re-issue the command */
880 if (atomic_read(&cmd->active) == 0)
883 fis = (struct host_to_dev_fis *)cmd->command;
885 /* Should re-issue? */
886 if (tag == MTIP_TAG_INTERNAL ||
887 fis->command == ATA_CMD_SET_FEATURES)
890 if (fail_all_ncq_cmds ||
891 (fail_all_ncq_write &&
892 fis->command == ATA_CMD_FPDMA_WRITE)) {
893 dev_warn(&dd->pdev->dev,
894 " Fail: %s w/tag %d [%s].\n",
895 fis->command == ATA_CMD_FPDMA_WRITE ?
898 fail_reason != NULL ?
899 fail_reason : "unknown");
900 atomic_set(&cmd->active, 0);
901 if (cmd->comp_func) {
902 cmd->comp_func(port, tag,
911 * First check if this command has
912 * exceeded its retries.
914 if (reissue && (cmd->retries-- > 0)) {
916 set_bit(tag, tagaccum);
918 /* Re-issue the command. */
919 mtip_issue_ncq_command(port, tag);
924 /* Retire a command that will not be reissued */
925 dev_warn(&port->dd->pdev->dev,
926 "retiring tag %d\n", tag);
927 atomic_set(&cmd->active, 0);
936 dev_warn(&port->dd->pdev->dev,
937 "Bad completion for tag %d\n",
941 print_tags(dd, "reissued (TFE)", tagaccum, cmd_cnt);
943 /* clear eh_active */
944 clear_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
945 wake_up_interruptible(&port->svc_wait);
947 mod_timer(&port->cmd_timer,
948 jiffies + msecs_to_jiffies(MTIP_TIMEOUT_CHECK_PERIOD));
952 * Handle a set device bits interrupt
954 static inline void mtip_process_sdbf(struct driver_data *dd)
956 struct mtip_port *port = dd->port;
959 struct mtip_cmd *command;
961 /* walk all bits in all slot groups */
962 for (group = 0; group < dd->slot_groups; group++) {
963 completed = readl(port->completed[group]);
965 /* clear completed status register in the hardware.*/
966 writel(completed, port->completed[group]);
968 /* Process completed commands. */
970 (bit < 32) && completed;
971 bit++, completed >>= 1) {
972 if (completed & 0x01) {
973 tag = (group << 5) | bit;
975 /* skip internal command slot. */
976 if (unlikely(tag == MTIP_TAG_INTERNAL))
979 command = &port->commands[tag];
980 /* make internal callback */
981 if (likely(command->comp_func)) {
988 dev_warn(&dd->pdev->dev,
993 if (mtip_check_surprise_removal(
995 mtip_command_cleanup(dd);
1005 * Process legacy pio and d2h interrupts
1007 static inline void mtip_process_legacy(struct driver_data *dd, u32 port_stat)
1009 struct mtip_port *port = dd->port;
1010 struct mtip_cmd *cmd = &port->commands[MTIP_TAG_INTERNAL];
1012 if (test_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags) &&
1013 (cmd != NULL) && !(readl(port->cmd_issue[MTIP_TAG_INTERNAL])
1014 & (1 << MTIP_TAG_INTERNAL))) {
1015 if (cmd->comp_func) {
1016 cmd->comp_func(port,
1028 * Demux and handle errors
1030 static inline void mtip_process_errors(struct driver_data *dd, u32 port_stat)
1032 if (likely(port_stat & (PORT_IRQ_TF_ERR | PORT_IRQ_IF_ERR)))
1033 mtip_handle_tfe(dd);
1035 if (unlikely(port_stat & PORT_IRQ_CONNECT)) {
1036 dev_warn(&dd->pdev->dev,
1037 "Clearing PxSERR.DIAG.x\n");
1038 writel((1 << 26), dd->port->mmio + PORT_SCR_ERR);
1041 if (unlikely(port_stat & PORT_IRQ_PHYRDY)) {
1042 dev_warn(&dd->pdev->dev,
1043 "Clearing PxSERR.DIAG.n\n");
1044 writel((1 << 16), dd->port->mmio + PORT_SCR_ERR);
1047 if (unlikely(port_stat & ~PORT_IRQ_HANDLED)) {
1048 dev_warn(&dd->pdev->dev,
1049 "Port stat errors %x unhandled\n",
1050 (port_stat & ~PORT_IRQ_HANDLED));
1054 static inline irqreturn_t mtip_handle_irq(struct driver_data *data)
1056 struct driver_data *dd = (struct driver_data *) data;
1057 struct mtip_port *port = dd->port;
1058 u32 hba_stat, port_stat;
1061 hba_stat = readl(dd->mmio + HOST_IRQ_STAT);
1065 /* Acknowledge the interrupt status on the port.*/
1066 port_stat = readl(port->mmio + PORT_IRQ_STAT);
1067 writel(port_stat, port->mmio + PORT_IRQ_STAT);
1069 /* Demux port status */
1070 if (likely(port_stat & PORT_IRQ_SDB_FIS))
1071 mtip_process_sdbf(dd);
1073 if (unlikely(port_stat & PORT_IRQ_ERR)) {
1074 if (unlikely(mtip_check_surprise_removal(dd->pdev))) {
1075 mtip_command_cleanup(dd);
1076 /* don't proceed further */
1079 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
1083 mtip_process_errors(dd, port_stat & PORT_IRQ_ERR);
1086 if (unlikely(port_stat & PORT_IRQ_LEGACY))
1087 mtip_process_legacy(dd, port_stat & PORT_IRQ_LEGACY);
1090 /* acknowledge interrupt */
1091 writel(hba_stat, dd->mmio + HOST_IRQ_STAT);
1097 * Wrapper for mtip_handle_irq
1098 * (ignores return code)
1100 static void mtip_tasklet(unsigned long data)
1102 mtip_handle_irq((struct driver_data *) data);
1106 * HBA interrupt subroutine.
1109 * @instance Pointer to the driver data structure.
1112 * IRQ_HANDLED A HBA interrupt was pending and handled.
1113 * IRQ_NONE This interrupt was not for the HBA.
1115 static irqreturn_t mtip_irq_handler(int irq, void *instance)
1117 struct driver_data *dd = instance;
1118 tasklet_schedule(&dd->tasklet);
1122 static void mtip_issue_non_ncq_command(struct mtip_port *port, int tag)
1124 atomic_set(&port->commands[tag].active, 1);
1125 writel(1 << MTIP_TAG_BIT(tag),
1126 port->cmd_issue[MTIP_TAG_INDEX(tag)]);
1129 static bool mtip_pause_ncq(struct mtip_port *port,
1130 struct host_to_dev_fis *fis)
1132 struct host_to_dev_fis *reply;
1133 unsigned long task_file_data;
1135 reply = port->rxfis + RX_FIS_D2H_REG;
1136 task_file_data = readl(port->mmio+PORT_TFDATA);
1138 if ((task_file_data & 1) || (fis->command == ATA_CMD_SEC_ERASE_UNIT))
1141 if (fis->command == ATA_CMD_SEC_ERASE_PREP) {
1142 set_bit(MTIP_PF_SE_ACTIVE_BIT, &port->flags);
1143 port->ic_pause_timer = jiffies;
1145 } else if ((fis->command == ATA_CMD_DOWNLOAD_MICRO) &&
1146 (fis->features == 0x03)) {
1147 set_bit(MTIP_PF_DM_ACTIVE_BIT, &port->flags);
1148 port->ic_pause_timer = jiffies;
1150 } else if ((fis->command == ATA_CMD_SEC_ERASE_UNIT) ||
1151 ((fis->command == 0xFC) &&
1152 (fis->features == 0x27 || fis->features == 0x72 ||
1153 fis->features == 0x62 || fis->features == 0x26))) {
1154 /* Com reset after secure erase or lowlevel format */
1155 mtip_restart_port(port);
1163 * Wait for port to quiesce
1165 * @port Pointer to port data structure
1166 * @timeout Max duration to wait (ms)
1170 * -EBUSY Commands still active
1172 static int mtip_quiesce_io(struct mtip_port *port, unsigned long timeout)
1176 unsigned int active = 1;
1178 to = jiffies + msecs_to_jiffies(timeout);
1180 if (test_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags) &&
1181 test_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags)) {
1183 continue; /* svc thd is actively issuing commands */
1185 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
1188 * Ignore s_active bit 0 of array element 0.
1189 * This bit will always be set
1191 active = readl(port->s_active[0]) & 0xFFFFFFFE;
1192 for (n = 1; n < port->dd->slot_groups; n++)
1193 active |= readl(port->s_active[n]);
1199 } while (time_before(jiffies, to));
1201 return active ? -EBUSY : 0;
1205 * Execute an internal command and wait for the completion.
1207 * @port Pointer to the port data structure.
1208 * @fis Pointer to the FIS that describes the command.
1209 * @fis_len Length in WORDS of the FIS.
1210 * @buffer DMA accessible for command data.
1211 * @buf_len Length, in bytes, of the data buffer.
1212 * @opts Command header options, excluding the FIS length
1213 * and the number of PRD entries.
1214 * @timeout Time in ms to wait for the command to complete.
1217 * 0 Command completed successfully.
1218 * -EFAULT The buffer address is not correctly aligned.
1219 * -EBUSY Internal command or other IO in progress.
1220 * -EAGAIN Time out waiting for command to complete.
1222 static int mtip_exec_internal_command(struct mtip_port *port,
1223 struct host_to_dev_fis *fis,
1229 unsigned long timeout)
1231 struct mtip_cmd_sg *command_sg;
1232 DECLARE_COMPLETION_ONSTACK(wait);
1233 int rv = 0, ready2go = 1;
1234 struct mtip_cmd *int_cmd = &port->commands[MTIP_TAG_INTERNAL];
1237 /* Make sure the buffer is 8 byte aligned. This is asic specific. */
1238 if (buffer & 0x00000007) {
1239 dev_err(&port->dd->pdev->dev,
1240 "SG buffer is not 8 byte aligned\n");
1244 to = jiffies + msecs_to_jiffies(timeout);
1246 ready2go = !test_and_set_bit(MTIP_TAG_INTERNAL,
1251 } while (time_before(jiffies, to));
1253 dev_warn(&port->dd->pdev->dev,
1254 "Internal cmd active. new cmd [%02X]\n", fis->command);
1257 set_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
1258 port->ic_pause_timer = 0;
1260 if (fis->command == ATA_CMD_SEC_ERASE_UNIT)
1261 clear_bit(MTIP_PF_SE_ACTIVE_BIT, &port->flags);
1262 else if (fis->command == ATA_CMD_DOWNLOAD_MICRO)
1263 clear_bit(MTIP_PF_DM_ACTIVE_BIT, &port->flags);
1265 if (atomic == GFP_KERNEL) {
1266 if (fis->command != ATA_CMD_STANDBYNOW1) {
1267 /* wait for io to complete if non atomic */
1268 if (mtip_quiesce_io(port, 5000) < 0) {
1269 dev_warn(&port->dd->pdev->dev,
1270 "Failed to quiesce IO\n");
1271 release_slot(port, MTIP_TAG_INTERNAL);
1272 clear_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
1273 wake_up_interruptible(&port->svc_wait);
1278 /* Set the completion function and data for the command. */
1279 int_cmd->comp_data = &wait;
1280 int_cmd->comp_func = mtip_completion;
1283 /* Clear completion - we're going to poll */
1284 int_cmd->comp_data = NULL;
1285 int_cmd->comp_func = mtip_null_completion;
1288 /* Copy the command to the command table */
1289 memcpy(int_cmd->command, fis, fis_len*4);
1291 /* Populate the SG list */
1292 int_cmd->command_header->opts =
1293 __force_bit2int cpu_to_le32(opts | fis_len);
1295 command_sg = int_cmd->command + AHCI_CMD_TBL_HDR_SZ;
1298 __force_bit2int cpu_to_le32((buf_len-1) & 0x3FFFFF);
1300 __force_bit2int cpu_to_le32(buffer & 0xFFFFFFFF);
1301 command_sg->dba_upper =
1302 __force_bit2int cpu_to_le32((buffer >> 16) >> 16);
1304 int_cmd->command_header->opts |=
1305 __force_bit2int cpu_to_le32((1 << 16));
1308 /* Populate the command header */
1309 int_cmd->command_header->byte_count = 0;
1311 /* Issue the command to the hardware */
1312 mtip_issue_non_ncq_command(port, MTIP_TAG_INTERNAL);
1314 /* Poll if atomic, wait_for_completion otherwise */
1315 if (atomic == GFP_KERNEL) {
1316 /* Wait for the command to complete or timeout. */
1317 if (wait_for_completion_timeout(
1319 msecs_to_jiffies(timeout)) == 0) {
1320 dev_err(&port->dd->pdev->dev,
1321 "Internal command did not complete [%d] "
1322 "within timeout of %lu ms\n",
1324 if (mtip_check_surprise_removal(port->dd->pdev) ||
1325 test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
1326 &port->dd->dd_flag)) {
1333 if (readl(port->cmd_issue[MTIP_TAG_INTERNAL])
1334 & (1 << MTIP_TAG_INTERNAL)) {
1335 dev_warn(&port->dd->pdev->dev,
1336 "Retiring internal command but CI is 1.\n");
1337 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
1338 &port->dd->dd_flag)) {
1339 hba_reset_nosleep(port->dd);
1342 mtip_restart_port(port);
1349 /* Spin for <timeout> checking if command still outstanding */
1350 timeout = jiffies + msecs_to_jiffies(timeout);
1351 while ((readl(port->cmd_issue[MTIP_TAG_INTERNAL])
1352 & (1 << MTIP_TAG_INTERNAL))
1353 && time_before(jiffies, timeout)) {
1354 if (mtip_check_surprise_removal(port->dd->pdev)) {
1358 if ((fis->command != ATA_CMD_STANDBYNOW1) &&
1359 test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
1360 &port->dd->dd_flag)) {
1366 if (readl(port->cmd_issue[MTIP_TAG_INTERNAL])
1367 & (1 << MTIP_TAG_INTERNAL)) {
1368 dev_err(&port->dd->pdev->dev,
1369 "Internal command did not complete [atomic]\n");
1371 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
1372 &port->dd->dd_flag)) {
1373 hba_reset_nosleep(port->dd);
1376 mtip_restart_port(port);
1382 /* Clear the allocated and active bits for the internal command. */
1383 atomic_set(&int_cmd->active, 0);
1384 release_slot(port, MTIP_TAG_INTERNAL);
1385 if (rv >= 0 && mtip_pause_ncq(port, fis)) {
1389 clear_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
1390 wake_up_interruptible(&port->svc_wait);
1396 * Byte-swap ATA ID strings.
1398 * ATA identify data contains strings in byte-swapped 16-bit words.
1399 * They must be swapped (on all architectures) to be usable as C strings.
1400 * This function swaps bytes in-place.
1402 * @buf The buffer location of the string
1403 * @len The number of bytes to swap
1408 static inline void ata_swap_string(u16 *buf, unsigned int len)
1411 for (i = 0; i < (len/2); i++)
1412 be16_to_cpus(&buf[i]);
1416 * Request the device identity information.
1418 * If a user space buffer is not specified, i.e. is NULL, the
1419 * identify information is still read from the drive and placed
1420 * into the identify data buffer (@e port->identify) in the
1421 * port data structure.
1422 * When the identify buffer contains valid identify information @e
1423 * port->identify_valid is non-zero.
1425 * @port Pointer to the port structure.
1426 * @user_buffer A user space buffer where the identify data should be
1430 * 0 Command completed successfully.
1431 * -EFAULT An error occurred while coping data to the user buffer.
1432 * -1 Command failed.
1434 static int mtip_get_identify(struct mtip_port *port, void __user *user_buffer)
1437 struct host_to_dev_fis fis;
1439 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
1442 /* Build the FIS. */
1443 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1446 fis.command = ATA_CMD_ID_ATA;
1448 /* Set the identify information as invalid. */
1449 port->identify_valid = 0;
1451 /* Clear the identify information. */
1452 memset(port->identify, 0, sizeof(u16) * ATA_ID_WORDS);
1454 /* Execute the command. */
1455 if (mtip_exec_internal_command(port,
1459 sizeof(u16) * ATA_ID_WORDS,
1462 MTIP_INTERNAL_COMMAND_TIMEOUT_MS)
1469 * Perform any necessary byte-swapping. Yes, the kernel does in fact
1470 * perform field-sensitive swapping on the string fields.
1471 * See the kernel use of ata_id_string() for proof of this.
1473 #ifdef __LITTLE_ENDIAN
1474 ata_swap_string(port->identify + 27, 40); /* model string*/
1475 ata_swap_string(port->identify + 23, 8); /* firmware string*/
1476 ata_swap_string(port->identify + 10, 20); /* serial# string*/
1480 for (i = 0; i < ATA_ID_WORDS; i++)
1481 port->identify[i] = le16_to_cpu(port->identify[i]);
1485 /* Set the identify buffer as valid. */
1486 port->identify_valid = 1;
1492 ATA_ID_WORDS * sizeof(u16))) {
1503 * Issue a standby immediate command to the device.
1505 * @port Pointer to the port structure.
1508 * 0 Command was executed successfully.
1509 * -1 An error occurred while executing the command.
1511 static int mtip_standby_immediate(struct mtip_port *port)
1514 struct host_to_dev_fis fis;
1515 unsigned long start;
1517 /* Build the FIS. */
1518 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1521 fis.command = ATA_CMD_STANDBYNOW1;
1524 rv = mtip_exec_internal_command(port,
1532 dbg_printk(MTIP_DRV_NAME "Time taken to complete standby cmd: %d ms\n",
1533 jiffies_to_msecs(jiffies - start));
1535 dev_warn(&port->dd->pdev->dev,
1536 "STANDBY IMMEDIATE command failed.\n");
1542 * Issue a READ LOG EXT command to the device.
1544 * @port pointer to the port structure.
1545 * @page page number to fetch
1546 * @buffer pointer to buffer
1547 * @buffer_dma dma address corresponding to @buffer
1548 * @sectors page length to fetch, in sectors
1551 * @rv return value from mtip_exec_internal_command()
1553 static int mtip_read_log_page(struct mtip_port *port, u8 page, u16 *buffer,
1554 dma_addr_t buffer_dma, unsigned int sectors)
1556 struct host_to_dev_fis fis;
1558 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1561 fis.command = ATA_CMD_READ_LOG_EXT;
1562 fis.sect_count = sectors & 0xFF;
1563 fis.sect_cnt_ex = (sectors >> 8) & 0xFF;
1566 fis.device = ATA_DEVICE_OBS;
1568 memset(buffer, 0, sectors * ATA_SECT_SIZE);
1570 return mtip_exec_internal_command(port,
1574 sectors * ATA_SECT_SIZE,
1577 MTIP_INTERNAL_COMMAND_TIMEOUT_MS);
1581 * Issue a SMART READ DATA command to the device.
1583 * @port pointer to the port structure.
1584 * @buffer pointer to buffer
1585 * @buffer_dma dma address corresponding to @buffer
1588 * @rv return value from mtip_exec_internal_command()
1590 static int mtip_get_smart_data(struct mtip_port *port, u8 *buffer,
1591 dma_addr_t buffer_dma)
1593 struct host_to_dev_fis fis;
1595 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1598 fis.command = ATA_CMD_SMART;
1599 fis.features = 0xD0;
1603 fis.device = ATA_DEVICE_OBS;
1605 return mtip_exec_internal_command(port,
1616 * Get the value of a smart attribute
1618 * @port pointer to the port structure
1619 * @id attribute number
1620 * @attrib pointer to return attrib information corresponding to @id
1623 * -EINVAL NULL buffer passed or unsupported attribute @id.
1624 * -EPERM Identify data not valid, SMART not supported or not enabled
1626 static int mtip_get_smart_attr(struct mtip_port *port, unsigned int id,
1627 struct smart_attr *attrib)
1630 struct smart_attr *pattr;
1635 if (!port->identify_valid) {
1636 dev_warn(&port->dd->pdev->dev, "IDENTIFY DATA not valid\n");
1639 if (!(port->identify[82] & 0x1)) {
1640 dev_warn(&port->dd->pdev->dev, "SMART not supported\n");
1643 if (!(port->identify[85] & 0x1)) {
1644 dev_warn(&port->dd->pdev->dev, "SMART not enabled\n");
1648 memset(port->smart_buf, 0, ATA_SECT_SIZE);
1649 rv = mtip_get_smart_data(port, port->smart_buf, port->smart_buf_dma);
1651 dev_warn(&port->dd->pdev->dev, "Failed to ge SMART data\n");
1655 pattr = (struct smart_attr *)(port->smart_buf + 2);
1656 for (i = 0; i < 29; i++, pattr++)
1657 if (pattr->attr_id == id) {
1658 memcpy(attrib, pattr, sizeof(struct smart_attr));
1663 dev_warn(&port->dd->pdev->dev,
1664 "Query for invalid SMART attribute ID\n");
1672 * Get the drive capacity.
1674 * @dd Pointer to the device data structure.
1675 * @sectors Pointer to the variable that will receive the sector count.
1678 * 1 Capacity was returned successfully.
1679 * 0 The identify information is invalid.
1681 static bool mtip_hw_get_capacity(struct driver_data *dd, sector_t *sectors)
1683 struct mtip_port *port = dd->port;
1684 u64 total, raw0, raw1, raw2, raw3;
1685 raw0 = port->identify[100];
1686 raw1 = port->identify[101];
1687 raw2 = port->identify[102];
1688 raw3 = port->identify[103];
1689 total = raw0 | raw1<<16 | raw2<<32 | raw3<<48;
1691 return (bool) !!port->identify_valid;
1697 * Resets the HBA by setting the HBA Reset bit in the Global
1698 * HBA Control register. After setting the HBA Reset bit the
1699 * function waits for 1 second before reading the HBA Reset
1700 * bit to make sure it has cleared. If HBA Reset is not clear
1701 * an error is returned. Cannot be used in non-blockable
1704 * @dd Pointer to the driver data structure.
1707 * 0 The reset was successful.
1708 * -1 The HBA Reset bit did not clear.
1710 static int mtip_hba_reset(struct driver_data *dd)
1712 mtip_deinit_port(dd->port);
1714 /* Set the reset bit */
1715 writel(HOST_RESET, dd->mmio + HOST_CTL);
1718 readl(dd->mmio + HOST_CTL);
1720 /* Wait for reset to clear */
1723 /* Check the bit has cleared */
1724 if (readl(dd->mmio + HOST_CTL) & HOST_RESET) {
1725 dev_err(&dd->pdev->dev,
1726 "Reset bit did not clear.\n");
1734 * Display the identify command data.
1736 * @port Pointer to the port data structure.
1741 static void mtip_dump_identify(struct mtip_port *port)
1744 unsigned short revid;
1747 if (!port->identify_valid)
1750 strlcpy(cbuf, (char *)(port->identify+10), 21);
1751 dev_info(&port->dd->pdev->dev,
1752 "Serial No.: %s\n", cbuf);
1754 strlcpy(cbuf, (char *)(port->identify+23), 9);
1755 dev_info(&port->dd->pdev->dev,
1756 "Firmware Ver.: %s\n", cbuf);
1758 strlcpy(cbuf, (char *)(port->identify+27), 41);
1759 dev_info(&port->dd->pdev->dev, "Model: %s\n", cbuf);
1761 if (mtip_hw_get_capacity(port->dd, §ors))
1762 dev_info(&port->dd->pdev->dev,
1763 "Capacity: %llu sectors (%llu MB)\n",
1765 ((u64)sectors) * ATA_SECT_SIZE >> 20);
1767 pci_read_config_word(port->dd->pdev, PCI_REVISION_ID, &revid);
1768 switch (revid & 0xFF) {
1770 strlcpy(cbuf, "A0", 3);
1773 strlcpy(cbuf, "A2", 3);
1776 strlcpy(cbuf, "?", 2);
1779 dev_info(&port->dd->pdev->dev,
1780 "Card Type: %s\n", cbuf);
1784 * Map the commands scatter list into the command table.
1786 * @command Pointer to the command.
1787 * @nents Number of scatter list entries.
1792 static inline void fill_command_sg(struct driver_data *dd,
1793 struct mtip_cmd *command,
1797 unsigned int dma_len;
1798 struct mtip_cmd_sg *command_sg;
1799 struct scatterlist *sg = command->sg;
1801 command_sg = command->command + AHCI_CMD_TBL_HDR_SZ;
1803 for (n = 0; n < nents; n++) {
1804 dma_len = sg_dma_len(sg);
1805 if (dma_len > 0x400000)
1806 dev_err(&dd->pdev->dev,
1807 "DMA segment length truncated\n");
1808 command_sg->info = __force_bit2int
1809 cpu_to_le32((dma_len-1) & 0x3FFFFF);
1810 command_sg->dba = __force_bit2int
1811 cpu_to_le32(sg_dma_address(sg));
1812 command_sg->dba_upper = __force_bit2int
1813 cpu_to_le32((sg_dma_address(sg) >> 16) >> 16);
1820 * @brief Execute a drive command.
1822 * return value 0 The command completed successfully.
1823 * return value -1 An error occurred while executing the command.
1825 static int exec_drive_task(struct mtip_port *port, u8 *command)
1827 struct host_to_dev_fis fis;
1828 struct host_to_dev_fis *reply = (port->rxfis + RX_FIS_D2H_REG);
1830 /* Build the FIS. */
1831 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1834 fis.command = command[0];
1835 fis.features = command[1];
1836 fis.sect_count = command[2];
1837 fis.sector = command[3];
1838 fis.cyl_low = command[4];
1839 fis.cyl_hi = command[5];
1840 fis.device = command[6] & ~0x10; /* Clear the dev bit*/
1842 dbg_printk(MTIP_DRV_NAME " %s: User Command: cmd %x, feat %x, nsect %x, sect %x, lcyl %x, hcyl %x, sel %x\n",
1852 /* Execute the command. */
1853 if (mtip_exec_internal_command(port,
1860 MTIP_IOCTL_COMMAND_TIMEOUT_MS) < 0) {
1864 command[0] = reply->command; /* Status*/
1865 command[1] = reply->features; /* Error*/
1866 command[4] = reply->cyl_low;
1867 command[5] = reply->cyl_hi;
1869 dbg_printk(MTIP_DRV_NAME " %s: Completion Status: stat %x, err %x , cyl_lo %x cyl_hi %x\n",
1880 * @brief Execute a drive command.
1882 * @param port Pointer to the port data structure.
1883 * @param command Pointer to the user specified command parameters.
1884 * @param user_buffer Pointer to the user space buffer where read sector
1885 * data should be copied.
1887 * return value 0 The command completed successfully.
1888 * return value -EFAULT An error occurred while copying the completion
1889 * data to the user space buffer.
1890 * return value -1 An error occurred while executing the command.
1892 static int exec_drive_command(struct mtip_port *port, u8 *command,
1893 void __user *user_buffer)
1895 struct host_to_dev_fis fis;
1896 struct host_to_dev_fis *reply = (port->rxfis + RX_FIS_D2H_REG);
1898 /* Build the FIS. */
1899 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1902 fis.command = command[0];
1903 fis.features = command[2];
1904 fis.sect_count = command[3];
1905 if (fis.command == ATA_CMD_SMART) {
1906 fis.sector = command[1];
1911 dbg_printk(MTIP_DRV_NAME
1912 " %s: User Command: cmd %x, sect %x, "
1913 "feat %x, sectcnt %x\n",
1920 memset(port->sector_buffer, 0x00, ATA_SECT_SIZE);
1922 /* Execute the command. */
1923 if (mtip_exec_internal_command(port,
1926 port->sector_buffer_dma,
1927 (command[3] != 0) ? ATA_SECT_SIZE : 0,
1930 MTIP_IOCTL_COMMAND_TIMEOUT_MS)
1935 /* Collect the completion status. */
1936 command[0] = reply->command; /* Status*/
1937 command[1] = reply->features; /* Error*/
1938 command[2] = command[3];
1940 dbg_printk(MTIP_DRV_NAME
1941 " %s: Completion Status: stat %x, "
1948 if (user_buffer && command[3]) {
1949 if (copy_to_user(user_buffer,
1950 port->sector_buffer,
1951 ATA_SECT_SIZE * command[3])) {
1960 * Indicates whether a command has a single sector payload.
1962 * @command passed to the device to perform the certain event.
1963 * @features passed to the device to perform the certain event.
1966 * 1 command is one that always has a single sector payload,
1967 * regardless of the value in the Sector Count field.
1971 static unsigned int implicit_sector(unsigned char command,
1972 unsigned char features)
1974 unsigned int rv = 0;
1976 /* list of commands that have an implicit sector count of 1 */
1978 case ATA_CMD_SEC_SET_PASS:
1979 case ATA_CMD_SEC_UNLOCK:
1980 case ATA_CMD_SEC_ERASE_PREP:
1981 case ATA_CMD_SEC_ERASE_UNIT:
1982 case ATA_CMD_SEC_FREEZE_LOCK:
1983 case ATA_CMD_SEC_DISABLE_PASS:
1984 case ATA_CMD_PMP_READ:
1985 case ATA_CMD_PMP_WRITE:
1988 case ATA_CMD_SET_MAX:
1989 if (features == ATA_SET_MAX_UNLOCK)
1993 if ((features == ATA_SMART_READ_VALUES) ||
1994 (features == ATA_SMART_READ_THRESHOLDS))
1997 case ATA_CMD_CONF_OVERLAY:
1998 if ((features == ATA_DCO_IDENTIFY) ||
1999 (features == ATA_DCO_SET))
2007 * Executes a taskfile
2008 * See ide_taskfile_ioctl() for derivation
2010 static int exec_drive_taskfile(struct driver_data *dd,
2012 ide_task_request_t *req_task,
2015 struct host_to_dev_fis fis;
2016 struct host_to_dev_fis *reply;
2019 dma_addr_t outbuf_dma = 0;
2020 dma_addr_t inbuf_dma = 0;
2021 dma_addr_t dma_buffer = 0;
2023 unsigned int taskin = 0;
2024 unsigned int taskout = 0;
2026 unsigned int timeout = MTIP_IOCTL_COMMAND_TIMEOUT_MS;
2027 unsigned int force_single_sector;
2028 unsigned int transfer_size;
2029 unsigned long task_file_data;
2030 int intotal = outtotal + req_task->out_size;
2032 taskout = req_task->out_size;
2033 taskin = req_task->in_size;
2034 /* 130560 = 512 * 0xFF*/
2035 if (taskin > 130560 || taskout > 130560) {
2041 outbuf = kzalloc(taskout, GFP_KERNEL);
2042 if (outbuf == NULL) {
2046 if (copy_from_user(outbuf, buf + outtotal, taskout)) {
2050 outbuf_dma = pci_map_single(dd->pdev,
2054 if (outbuf_dma == 0) {
2058 dma_buffer = outbuf_dma;
2062 inbuf = kzalloc(taskin, GFP_KERNEL);
2063 if (inbuf == NULL) {
2068 if (copy_from_user(inbuf, buf + intotal, taskin)) {
2072 inbuf_dma = pci_map_single(dd->pdev,
2074 taskin, DMA_FROM_DEVICE);
2075 if (inbuf_dma == 0) {
2079 dma_buffer = inbuf_dma;
2082 /* only supports PIO and non-data commands from this ioctl. */
2083 switch (req_task->data_phase) {
2085 nsect = taskout / ATA_SECT_SIZE;
2086 reply = (dd->port->rxfis + RX_FIS_PIO_SETUP);
2089 reply = (dd->port->rxfis + RX_FIS_PIO_SETUP);
2091 case TASKFILE_NO_DATA:
2092 reply = (dd->port->rxfis + RX_FIS_D2H_REG);
2099 /* Build the FIS. */
2100 memset(&fis, 0, sizeof(struct host_to_dev_fis));
2104 fis.command = req_task->io_ports[7];
2105 fis.features = req_task->io_ports[1];
2106 fis.sect_count = req_task->io_ports[2];
2107 fis.lba_low = req_task->io_ports[3];
2108 fis.lba_mid = req_task->io_ports[4];
2109 fis.lba_hi = req_task->io_ports[5];
2110 /* Clear the dev bit*/
2111 fis.device = req_task->io_ports[6] & ~0x10;
2113 if ((req_task->in_flags.all == 0) && (req_task->out_flags.all & 1)) {
2114 req_task->in_flags.all =
2115 IDE_TASKFILE_STD_IN_FLAGS |
2116 (IDE_HOB_STD_IN_FLAGS << 8);
2117 fis.lba_low_ex = req_task->hob_ports[3];
2118 fis.lba_mid_ex = req_task->hob_ports[4];
2119 fis.lba_hi_ex = req_task->hob_ports[5];
2120 fis.features_ex = req_task->hob_ports[1];
2121 fis.sect_cnt_ex = req_task->hob_ports[2];
2124 req_task->in_flags.all = IDE_TASKFILE_STD_IN_FLAGS;
2127 force_single_sector = implicit_sector(fis.command, fis.features);
2129 if ((taskin || taskout) && (!fis.sect_count)) {
2131 fis.sect_count = nsect;
2133 if (!force_single_sector) {
2134 dev_warn(&dd->pdev->dev,
2135 "data movement but "
2136 "sect_count is 0\n");
2143 dbg_printk(MTIP_DRV_NAME
2144 " %s: cmd %x, feat %x, nsect %x,"
2145 " sect/lbal %x, lcyl/lbam %x, hcyl/lbah %x,"
2156 switch (fis.command) {
2157 case ATA_CMD_DOWNLOAD_MICRO:
2158 /* Change timeout for Download Microcode to 2 minutes */
2161 case ATA_CMD_SEC_ERASE_UNIT:
2162 /* Change timeout for Security Erase Unit to 4 minutes.*/
2165 case ATA_CMD_STANDBYNOW1:
2166 /* Change timeout for standby immediate to 10 seconds.*/
2171 /* Change timeout for vendor unique command to 10 secs */
2175 /* Change timeout for vendor unique command to 15 secs */
2179 timeout = MTIP_IOCTL_COMMAND_TIMEOUT_MS;
2183 /* Determine the correct transfer size.*/
2184 if (force_single_sector)
2185 transfer_size = ATA_SECT_SIZE;
2187 transfer_size = ATA_SECT_SIZE * fis.sect_count;
2189 /* Execute the command.*/
2190 if (mtip_exec_internal_command(dd->port,
2202 task_file_data = readl(dd->port->mmio+PORT_TFDATA);
2204 if ((req_task->data_phase == TASKFILE_IN) && !(task_file_data & 1)) {
2205 reply = dd->port->rxfis + RX_FIS_PIO_SETUP;
2206 req_task->io_ports[7] = reply->control;
2208 reply = dd->port->rxfis + RX_FIS_D2H_REG;
2209 req_task->io_ports[7] = reply->command;
2212 /* reclaim the DMA buffers.*/
2214 pci_unmap_single(dd->pdev, inbuf_dma,
2215 taskin, DMA_FROM_DEVICE);
2217 pci_unmap_single(dd->pdev, outbuf_dma,
2218 taskout, DMA_TO_DEVICE);
2222 /* return the ATA registers to the caller.*/
2223 req_task->io_ports[1] = reply->features;
2224 req_task->io_ports[2] = reply->sect_count;
2225 req_task->io_ports[3] = reply->lba_low;
2226 req_task->io_ports[4] = reply->lba_mid;
2227 req_task->io_ports[5] = reply->lba_hi;
2228 req_task->io_ports[6] = reply->device;
2230 if (req_task->out_flags.all & 1) {
2232 req_task->hob_ports[3] = reply->lba_low_ex;
2233 req_task->hob_ports[4] = reply->lba_mid_ex;
2234 req_task->hob_ports[5] = reply->lba_hi_ex;
2235 req_task->hob_ports[1] = reply->features_ex;
2236 req_task->hob_ports[2] = reply->sect_cnt_ex;
2238 dbg_printk(MTIP_DRV_NAME
2239 " %s: Completion: stat %x,"
2240 "err %x, sect_cnt %x, lbalo %x,"
2241 "lbamid %x, lbahi %x, dev %x\n",
2243 req_task->io_ports[7],
2244 req_task->io_ports[1],
2245 req_task->io_ports[2],
2246 req_task->io_ports[3],
2247 req_task->io_ports[4],
2248 req_task->io_ports[5],
2249 req_task->io_ports[6]);
2252 if (copy_to_user(buf + outtotal, outbuf, taskout)) {
2258 if (copy_to_user(buf + intotal, inbuf, taskin)) {
2265 pci_unmap_single(dd->pdev, inbuf_dma,
2266 taskin, DMA_FROM_DEVICE);
2268 pci_unmap_single(dd->pdev, outbuf_dma,
2269 taskout, DMA_TO_DEVICE);
2277 * Handle IOCTL calls from the Block Layer.
2279 * This function is called by the Block Layer when it receives an IOCTL
2280 * command that it does not understand. If the IOCTL command is not supported
2281 * this function returns -ENOTTY.
2283 * @dd Pointer to the driver data structure.
2284 * @cmd IOCTL command passed from the Block Layer.
2285 * @arg IOCTL argument passed from the Block Layer.
2288 * 0 The IOCTL completed successfully.
2289 * -ENOTTY The specified command is not supported.
2290 * -EFAULT An error occurred copying data to a user space buffer.
2291 * -EIO An error occurred while executing the command.
2293 static int mtip_hw_ioctl(struct driver_data *dd, unsigned int cmd,
2297 case HDIO_GET_IDENTITY:
2298 if (mtip_get_identify(dd->port, (void __user *) arg) < 0) {
2299 dev_warn(&dd->pdev->dev,
2300 "Unable to read identity\n");
2305 case HDIO_DRIVE_CMD:
2307 u8 drive_command[4];
2309 /* Copy the user command info to our buffer. */
2310 if (copy_from_user(drive_command,
2311 (void __user *) arg,
2312 sizeof(drive_command)))
2315 /* Execute the drive command. */
2316 if (exec_drive_command(dd->port,
2318 (void __user *) (arg+4)))
2321 /* Copy the status back to the users buffer. */
2322 if (copy_to_user((void __user *) arg,
2324 sizeof(drive_command)))
2329 case HDIO_DRIVE_TASK:
2331 u8 drive_command[7];
2333 /* Copy the user command info to our buffer. */
2334 if (copy_from_user(drive_command,
2335 (void __user *) arg,
2336 sizeof(drive_command)))
2339 /* Execute the drive command. */
2340 if (exec_drive_task(dd->port, drive_command))
2343 /* Copy the status back to the users buffer. */
2344 if (copy_to_user((void __user *) arg,
2346 sizeof(drive_command)))
2351 case HDIO_DRIVE_TASKFILE: {
2352 ide_task_request_t req_task;
2355 if (copy_from_user(&req_task, (void __user *) arg,
2359 outtotal = sizeof(req_task);
2361 ret = exec_drive_taskfile(dd, (void __user *) arg,
2362 &req_task, outtotal);
2364 if (copy_to_user((void __user *) arg, &req_task,
2378 * Submit an IO to the hw
2380 * This function is called by the block layer to issue an io
2381 * to the device. Upon completion, the callback function will
2382 * be called with the data parameter passed as the callback data.
2384 * @dd Pointer to the driver data structure.
2385 * @start First sector to read.
2386 * @nsect Number of sectors to read.
2387 * @nents Number of entries in scatter list for the read command.
2388 * @tag The tag of this read command.
2389 * @callback Pointer to the function that should be called
2390 * when the read completes.
2391 * @data Callback data passed to the callback function
2392 * when the read completes.
2393 * @dir Direction (read or write)
2398 static void mtip_hw_submit_io(struct driver_data *dd, sector_t start,
2399 int nsect, int nents, int tag, void *callback,
2400 void *data, int dir)
2402 struct host_to_dev_fis *fis;
2403 struct mtip_port *port = dd->port;
2404 struct mtip_cmd *command = &port->commands[tag];
2405 int dma_dir = (dir == READ) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
2407 /* Map the scatter list for DMA access */
2408 nents = dma_map_sg(&dd->pdev->dev, command->sg, nents, dma_dir);
2410 command->scatter_ents = nents;
2413 * The number of retries for this command before it is
2414 * reported as a failure to the upper layers.
2416 command->retries = MTIP_MAX_RETRIES;
2419 fis = command->command;
2423 (dir == READ ? ATA_CMD_FPDMA_READ : ATA_CMD_FPDMA_WRITE);
2424 *((unsigned int *) &fis->lba_low) = (start & 0xFFFFFF);
2425 *((unsigned int *) &fis->lba_low_ex) = ((start >> 24) & 0xFFFFFF);
2426 fis->device = 1 << 6;
2427 fis->features = nsect & 0xFF;
2428 fis->features_ex = (nsect >> 8) & 0xFF;
2429 fis->sect_count = ((tag << 3) | (tag >> 5));
2430 fis->sect_cnt_ex = 0;
2434 fill_command_sg(dd, command, nents);
2436 /* Populate the command header */
2437 command->command_header->opts =
2438 __force_bit2int cpu_to_le32(
2439 (nents << 16) | 5 | AHCI_CMD_PREFETCH);
2440 command->command_header->byte_count = 0;
2443 * Set the completion function and data for the command
2444 * within this layer.
2446 command->comp_data = dd;
2447 command->comp_func = mtip_async_complete;
2448 command->direction = dma_dir;
2451 * Set the completion function and data for the command passed
2452 * from the upper layer.
2454 command->async_data = data;
2455 command->async_callback = callback;
2458 * To prevent this command from being issued
2459 * if an internal command is in progress or error handling is active.
2461 if (port->flags & MTIP_PF_PAUSE_IO) {
2462 set_bit(tag, port->cmds_to_issue);
2463 set_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags);
2467 /* Issue the command to the hardware */
2468 mtip_issue_ncq_command(port, tag);
2474 * Release a command slot.
2476 * @dd Pointer to the driver data structure.
2482 static void mtip_hw_release_scatterlist(struct driver_data *dd, int tag)
2484 release_slot(dd->port, tag);
2488 * Obtain a command slot and return its associated scatter list.
2490 * @dd Pointer to the driver data structure.
2491 * @tag Pointer to an int that will receive the allocated command
2495 * Pointer to the scatter list for the allocated command slot
2496 * or NULL if no command slots are available.
2498 static struct scatterlist *mtip_hw_get_scatterlist(struct driver_data *dd,
2502 * It is possible that, even with this semaphore, a thread
2503 * may think that no command slots are available. Therefore, we
2504 * need to make an attempt to get_slot().
2506 down(&dd->port->cmd_slot);
2507 *tag = get_slot(dd->port);
2509 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))) {
2510 up(&dd->port->cmd_slot);
2513 if (unlikely(*tag < 0))
2516 return dd->port->commands[*tag].sg;
2520 * Sysfs register/status dump.
2522 * @dev Pointer to the device structure, passed by the kernrel.
2523 * @attr Pointer to the device_attribute structure passed by the kernel.
2524 * @buf Pointer to the char buffer that will receive the stats info.
2527 * The size, in bytes, of the data copied into buf.
2529 static ssize_t mtip_hw_show_registers(struct device *dev,
2530 struct device_attribute *attr,
2533 u32 group_allocated;
2534 struct driver_data *dd = dev_to_disk(dev)->private_data;
2538 size += sprintf(&buf[size], "S ACTive:\n");
2540 for (n = 0; n < dd->slot_groups; n++)
2541 size += sprintf(&buf[size], "0x%08x\n",
2542 readl(dd->port->s_active[n]));
2544 size += sprintf(&buf[size], "Command Issue:\n");
2546 for (n = 0; n < dd->slot_groups; n++)
2547 size += sprintf(&buf[size], "0x%08x\n",
2548 readl(dd->port->cmd_issue[n]));
2550 size += sprintf(&buf[size], "Allocated:\n");
2552 for (n = 0; n < dd->slot_groups; n++) {
2553 if (sizeof(long) > sizeof(u32))
2555 dd->port->allocated[n/2] >> (32*(n&1));
2557 group_allocated = dd->port->allocated[n];
2558 size += sprintf(&buf[size], "0x%08x\n",
2562 size += sprintf(&buf[size], "Completed:\n");
2564 for (n = 0; n < dd->slot_groups; n++)
2565 size += sprintf(&buf[size], "0x%08x\n",
2566 readl(dd->port->completed[n]));
2568 size += sprintf(&buf[size], "PORT IRQ STAT : 0x%08x\n",
2569 readl(dd->port->mmio + PORT_IRQ_STAT));
2570 size += sprintf(&buf[size], "HOST IRQ STAT : 0x%08x\n",
2571 readl(dd->mmio + HOST_IRQ_STAT));
2576 static ssize_t mtip_hw_show_status(struct device *dev,
2577 struct device_attribute *attr,
2580 struct driver_data *dd = dev_to_disk(dev)->private_data;
2583 if (test_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag))
2584 size += sprintf(buf, "%s", "thermal_shutdown\n");
2585 else if (test_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag))
2586 size += sprintf(buf, "%s", "write_protect\n");
2588 size += sprintf(buf, "%s", "online\n");
2593 static DEVICE_ATTR(registers, S_IRUGO, mtip_hw_show_registers, NULL);
2594 static DEVICE_ATTR(status, S_IRUGO, mtip_hw_show_status, NULL);
2597 * Create the sysfs related attributes.
2599 * @dd Pointer to the driver data structure.
2600 * @kobj Pointer to the kobj for the block device.
2603 * 0 Operation completed successfully.
2604 * -EINVAL Invalid parameter.
2606 static int mtip_hw_sysfs_init(struct driver_data *dd, struct kobject *kobj)
2611 if (sysfs_create_file(kobj, &dev_attr_registers.attr))
2612 dev_warn(&dd->pdev->dev,
2613 "Error creating 'registers' sysfs entry\n");
2614 if (sysfs_create_file(kobj, &dev_attr_status.attr))
2615 dev_warn(&dd->pdev->dev,
2616 "Error creating 'status' sysfs entry\n");
2621 * Remove the sysfs related attributes.
2623 * @dd Pointer to the driver data structure.
2624 * @kobj Pointer to the kobj for the block device.
2627 * 0 Operation completed successfully.
2628 * -EINVAL Invalid parameter.
2630 static int mtip_hw_sysfs_exit(struct driver_data *dd, struct kobject *kobj)
2635 sysfs_remove_file(kobj, &dev_attr_registers.attr);
2636 sysfs_remove_file(kobj, &dev_attr_status.attr);
2642 * Perform any init/resume time hardware setup
2644 * @dd Pointer to the driver data structure.
2649 static inline void hba_setup(struct driver_data *dd)
2652 hwdata = readl(dd->mmio + HOST_HSORG);
2654 /* interrupt bug workaround: use only 1 IS bit.*/
2656 HSORG_DISABLE_SLOTGRP_INTR |
2657 HSORG_DISABLE_SLOTGRP_PXIS,
2658 dd->mmio + HOST_HSORG);
2662 * Detect the details of the product, and store anything needed
2663 * into the driver data structure. This includes product type and
2664 * version and number of slot groups.
2666 * @dd Pointer to the driver data structure.
2671 static void mtip_detect_product(struct driver_data *dd)
2674 unsigned int rev, slotgroups;
2677 * HBA base + 0xFC [15:0] - vendor-specific hardware interface
2679 * [15:8] hardware/software interface rev#
2680 * [ 3] asic-style interface
2681 * [ 2:0] number of slot groups, minus 1 (only valid for asic-style).
2683 hwdata = readl(dd->mmio + HOST_HSORG);
2685 dd->product_type = MTIP_PRODUCT_UNKNOWN;
2686 dd->slot_groups = 1;
2689 dd->product_type = MTIP_PRODUCT_ASICFPGA;
2690 rev = (hwdata & HSORG_HWREV) >> 8;
2691 slotgroups = (hwdata & HSORG_SLOTGROUPS) + 1;
2692 dev_info(&dd->pdev->dev,
2693 "ASIC-FPGA design, HS rev 0x%x, "
2694 "%i slot groups [%i slots]\n",
2699 if (slotgroups > MTIP_MAX_SLOT_GROUPS) {
2700 dev_warn(&dd->pdev->dev,
2701 "Warning: driver only supports "
2702 "%i slot groups.\n", MTIP_MAX_SLOT_GROUPS);
2703 slotgroups = MTIP_MAX_SLOT_GROUPS;
2705 dd->slot_groups = slotgroups;
2709 dev_warn(&dd->pdev->dev, "Unrecognized product id\n");
2713 * Blocking wait for FTL rebuild to complete
2715 * @dd Pointer to the DRIVER_DATA structure.
2718 * 0 FTL rebuild completed successfully
2719 * -EFAULT FTL rebuild error/timeout/interruption
2721 static int mtip_ftl_rebuild_poll(struct driver_data *dd)
2723 unsigned long timeout, cnt = 0, start;
2725 dev_warn(&dd->pdev->dev,
2726 "FTL rebuild in progress. Polling for completion.\n");
2729 timeout = jiffies + msecs_to_jiffies(MTIP_FTL_REBUILD_TIMEOUT_MS);
2732 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
2735 if (mtip_check_surprise_removal(dd->pdev))
2738 if (mtip_get_identify(dd->port, NULL) < 0)
2741 if (*(dd->port->identify + MTIP_FTL_REBUILD_OFFSET) ==
2742 MTIP_FTL_REBUILD_MAGIC) {
2744 /* Print message every 3 minutes */
2746 dev_warn(&dd->pdev->dev,
2747 "FTL rebuild in progress (%d secs).\n",
2748 jiffies_to_msecs(jiffies - start) / 1000);
2752 dev_warn(&dd->pdev->dev,
2753 "FTL rebuild complete (%d secs).\n",
2754 jiffies_to_msecs(jiffies - start) / 1000);
2755 mtip_block_initialize(dd);
2759 } while (time_before(jiffies, timeout));
2761 /* Check for timeout */
2762 dev_err(&dd->pdev->dev,
2763 "Timed out waiting for FTL rebuild to complete (%d secs).\n",
2764 jiffies_to_msecs(jiffies - start) / 1000);
2769 * service thread to issue queued commands
2771 * @data Pointer to the driver data structure.
2777 static int mtip_service_thread(void *data)
2779 struct driver_data *dd = (struct driver_data *)data;
2780 unsigned long slot, slot_start, slot_wrap;
2781 unsigned int num_cmd_slots = dd->slot_groups * 32;
2782 struct mtip_port *port = dd->port;
2786 * the condition is to check neither an internal command is
2787 * is in progress nor error handling is active
2789 wait_event_interruptible(port->svc_wait, (port->flags) &&
2790 !(port->flags & MTIP_PF_PAUSE_IO));
2792 if (kthread_should_stop())
2795 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
2799 set_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags);
2800 if (test_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags)) {
2802 /* used to restrict the loop to one iteration */
2803 slot_start = num_cmd_slots;
2806 slot = find_next_bit(port->cmds_to_issue,
2807 num_cmd_slots, slot);
2808 if (slot_wrap == 1) {
2809 if ((slot_start >= slot) ||
2810 (slot >= num_cmd_slots))
2813 if (unlikely(slot_start == num_cmd_slots))
2816 if (unlikely(slot == num_cmd_slots)) {
2822 /* Issue the command to the hardware */
2823 mtip_issue_ncq_command(port, slot);
2825 clear_bit(slot, port->cmds_to_issue);
2828 clear_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags);
2829 } else if (test_bit(MTIP_PF_REBUILD_BIT, &port->flags)) {
2830 if (!mtip_ftl_rebuild_poll(dd))
2831 set_bit(MTIP_DDF_REBUILD_FAILED_BIT,
2833 clear_bit(MTIP_PF_REBUILD_BIT, &port->flags);
2835 clear_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags);
2837 if (test_bit(MTIP_PF_SVC_THD_STOP_BIT, &port->flags))
2844 * Called once for each card.
2846 * @dd Pointer to the driver data structure.
2849 * 0 on success, else an error code.
2851 static int mtip_hw_init(struct driver_data *dd)
2855 unsigned int num_command_slots;
2856 unsigned long timeout, timetaken;
2858 struct smart_attr attr242;
2860 dd->mmio = pcim_iomap_table(dd->pdev)[MTIP_ABAR];
2862 mtip_detect_product(dd);
2863 if (dd->product_type == MTIP_PRODUCT_UNKNOWN) {
2867 num_command_slots = dd->slot_groups * 32;
2871 tasklet_init(&dd->tasklet, mtip_tasklet, (unsigned long)dd);
2873 dd->port = kzalloc(sizeof(struct mtip_port), GFP_KERNEL);
2875 dev_err(&dd->pdev->dev,
2876 "Memory allocation: port structure\n");
2880 /* Counting semaphore to track command slot usage */
2881 sema_init(&dd->port->cmd_slot, num_command_slots - 1);
2883 /* Spinlock to prevent concurrent issue */
2884 spin_lock_init(&dd->port->cmd_issue_lock);
2886 /* Set the port mmio base address. */
2887 dd->port->mmio = dd->mmio + PORT_OFFSET;
2890 /* Allocate memory for the command list. */
2891 dd->port->command_list =
2892 dmam_alloc_coherent(&dd->pdev->dev,
2893 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
2894 &dd->port->command_list_dma,
2896 if (!dd->port->command_list) {
2897 dev_err(&dd->pdev->dev,
2898 "Memory allocation: command list\n");
2903 /* Clear the memory we have allocated. */
2904 memset(dd->port->command_list,
2906 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4));
2908 /* Setup the addresse of the RX FIS. */
2909 dd->port->rxfis = dd->port->command_list + HW_CMD_SLOT_SZ;
2910 dd->port->rxfis_dma = dd->port->command_list_dma + HW_CMD_SLOT_SZ;
2912 /* Setup the address of the command tables. */
2913 dd->port->command_table = dd->port->rxfis + AHCI_RX_FIS_SZ;
2914 dd->port->command_tbl_dma = dd->port->rxfis_dma + AHCI_RX_FIS_SZ;
2916 /* Setup the address of the identify data. */
2917 dd->port->identify = dd->port->command_table +
2919 dd->port->identify_dma = dd->port->command_tbl_dma +
2922 /* Setup the address of the sector buffer - for some non-ncq cmds */
2923 dd->port->sector_buffer = (void *) dd->port->identify + ATA_SECT_SIZE;
2924 dd->port->sector_buffer_dma = dd->port->identify_dma + ATA_SECT_SIZE;
2926 /* Setup the address of the log buf - for read log command */
2927 dd->port->log_buf = (void *)dd->port->sector_buffer + ATA_SECT_SIZE;
2928 dd->port->log_buf_dma = dd->port->sector_buffer_dma + ATA_SECT_SIZE;
2930 /* Setup the address of the smart buf - for smart read data command */
2931 dd->port->smart_buf = (void *)dd->port->log_buf + ATA_SECT_SIZE;
2932 dd->port->smart_buf_dma = dd->port->log_buf_dma + ATA_SECT_SIZE;
2935 /* Point the command headers at the command tables. */
2936 for (i = 0; i < num_command_slots; i++) {
2937 dd->port->commands[i].command_header =
2938 dd->port->command_list +
2939 (sizeof(struct mtip_cmd_hdr) * i);
2940 dd->port->commands[i].command_header_dma =
2941 dd->port->command_list_dma +
2942 (sizeof(struct mtip_cmd_hdr) * i);
2944 dd->port->commands[i].command =
2945 dd->port->command_table + (HW_CMD_TBL_SZ * i);
2946 dd->port->commands[i].command_dma =
2947 dd->port->command_tbl_dma + (HW_CMD_TBL_SZ * i);
2949 if (readl(dd->mmio + HOST_CAP) & HOST_CAP_64)
2950 dd->port->commands[i].command_header->ctbau =
2951 __force_bit2int cpu_to_le32(
2952 (dd->port->commands[i].command_dma >> 16) >> 16);
2953 dd->port->commands[i].command_header->ctba =
2954 __force_bit2int cpu_to_le32(
2955 dd->port->commands[i].command_dma & 0xFFFFFFFF);
2958 * If this is not done, a bug is reported by the stock
2959 * FC11 i386. Due to the fact that it has lots of kernel
2960 * debugging enabled.
2962 sg_init_table(dd->port->commands[i].sg, MTIP_MAX_SG);
2964 /* Mark all commands as currently inactive.*/
2965 atomic_set(&dd->port->commands[i].active, 0);
2968 /* Setup the pointers to the extended s_active and CI registers. */
2969 for (i = 0; i < dd->slot_groups; i++) {
2970 dd->port->s_active[i] =
2971 dd->port->mmio + i*0x80 + PORT_SCR_ACT;
2972 dd->port->cmd_issue[i] =
2973 dd->port->mmio + i*0x80 + PORT_COMMAND_ISSUE;
2974 dd->port->completed[i] =
2975 dd->port->mmio + i*0x80 + PORT_SDBV;
2978 timetaken = jiffies;
2979 timeout = jiffies + msecs_to_jiffies(30000);
2980 while (((readl(dd->port->mmio + PORT_SCR_STAT) & 0x0F) != 0x03) &&
2981 time_before(jiffies, timeout)) {
2984 if (unlikely(mtip_check_surprise_removal(dd->pdev))) {
2985 timetaken = jiffies - timetaken;
2986 dev_warn(&dd->pdev->dev,
2987 "Surprise removal detected at %u ms\n",
2988 jiffies_to_msecs(timetaken));
2992 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))) {
2993 timetaken = jiffies - timetaken;
2994 dev_warn(&dd->pdev->dev,
2995 "Removal detected at %u ms\n",
2996 jiffies_to_msecs(timetaken));
3001 /* Conditionally reset the HBA. */
3002 if (!(readl(dd->mmio + HOST_CAP) & HOST_CAP_NZDMA)) {
3003 if (mtip_hba_reset(dd) < 0) {
3004 dev_err(&dd->pdev->dev,
3005 "Card did not reset within timeout\n");
3010 /* Clear any pending interrupts on the HBA */
3011 writel(readl(dd->mmio + HOST_IRQ_STAT),
3012 dd->mmio + HOST_IRQ_STAT);
3015 mtip_init_port(dd->port);
3016 mtip_start_port(dd->port);
3018 /* Setup the ISR and enable interrupts. */
3019 rv = devm_request_irq(&dd->pdev->dev,
3023 dev_driver_string(&dd->pdev->dev),
3027 dev_err(&dd->pdev->dev,
3028 "Unable to allocate IRQ %d\n", dd->pdev->irq);
3032 /* Enable interrupts on the HBA. */
3033 writel(readl(dd->mmio + HOST_CTL) | HOST_IRQ_EN,
3034 dd->mmio + HOST_CTL);
3036 init_timer(&dd->port->cmd_timer);
3037 init_waitqueue_head(&dd->port->svc_wait);
3039 dd->port->cmd_timer.data = (unsigned long int) dd->port;
3040 dd->port->cmd_timer.function = mtip_timeout_function;
3041 mod_timer(&dd->port->cmd_timer,
3042 jiffies + msecs_to_jiffies(MTIP_TIMEOUT_CHECK_PERIOD));
3045 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)) {
3050 if (mtip_get_identify(dd->port, NULL) < 0) {
3055 if (*(dd->port->identify + MTIP_FTL_REBUILD_OFFSET) ==
3056 MTIP_FTL_REBUILD_MAGIC) {
3057 set_bit(MTIP_PF_REBUILD_BIT, &dd->port->flags);
3058 return MTIP_FTL_REBUILD_MAGIC;
3060 mtip_dump_identify(dd->port);
3062 /* check write protect, over temp and rebuild statuses */
3063 rv = mtip_read_log_page(dd->port, ATA_LOG_SATA_NCQ,
3065 dd->port->log_buf_dma, 1);
3067 dev_warn(&dd->pdev->dev,
3068 "Error in READ LOG EXT (10h) command\n");
3069 /* non-critical error, don't fail the load */
3071 buf = (unsigned char *)dd->port->log_buf;
3072 if (buf[259] & 0x1) {
3073 dev_info(&dd->pdev->dev,
3074 "Write protect bit is set.\n");
3075 set_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag);
3077 if (buf[288] == 0xF7) {
3078 dev_info(&dd->pdev->dev,
3079 "Exceeded Tmax, drive in thermal shutdown.\n");
3080 set_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag);
3082 if (buf[288] == 0xBF) {
3083 dev_info(&dd->pdev->dev,
3084 "Drive indicates rebuild has failed.\n");
3089 /* get write protect progess */
3090 memset(&attr242, 0, sizeof(struct smart_attr));
3091 if (mtip_get_smart_attr(dd->port, 242, &attr242))
3092 dev_warn(&dd->pdev->dev,
3093 "Unable to check write protect progress\n");
3095 dev_info(&dd->pdev->dev,
3096 "Write protect progress: %d%% (%d blocks)\n",
3097 attr242.cur, attr242.data);
3101 del_timer_sync(&dd->port->cmd_timer);
3103 /* Disable interrupts on the HBA. */
3104 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3105 dd->mmio + HOST_CTL);
3107 /*Release the IRQ. */
3108 devm_free_irq(&dd->pdev->dev, dd->pdev->irq, dd);
3111 mtip_deinit_port(dd->port);
3113 /* Free the command/command header memory. */
3114 dmam_free_coherent(&dd->pdev->dev,
3115 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
3116 dd->port->command_list,
3117 dd->port->command_list_dma);
3119 /* Free the memory allocated for the for structure. */
3126 * Called to deinitialize an interface.
3128 * @dd Pointer to the driver data structure.
3133 static int mtip_hw_exit(struct driver_data *dd)
3136 * Send standby immediate (E0h) to the drive so that it
3139 if (!test_bit(MTIP_DDF_CLEANUP_BIT, &dd->dd_flag)) {
3141 if (!test_bit(MTIP_PF_REBUILD_BIT, &dd->port->flags))
3142 if (mtip_standby_immediate(dd->port))
3143 dev_warn(&dd->pdev->dev,
3144 "STANDBY IMMEDIATE failed\n");
3146 /* de-initialize the port. */
3147 mtip_deinit_port(dd->port);
3149 /* Disable interrupts on the HBA. */
3150 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3151 dd->mmio + HOST_CTL);
3154 del_timer_sync(&dd->port->cmd_timer);
3156 /* Release the IRQ. */
3157 devm_free_irq(&dd->pdev->dev, dd->pdev->irq, dd);
3159 /* Stop the bottom half tasklet. */
3160 tasklet_kill(&dd->tasklet);
3162 /* Free the command/command header memory. */
3163 dmam_free_coherent(&dd->pdev->dev,
3164 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
3165 dd->port->command_list,
3166 dd->port->command_list_dma);
3167 /* Free the memory allocated for the for structure. */
3174 * Issue a Standby Immediate command to the device.
3176 * This function is called by the Block Layer just before the
3177 * system powers off during a shutdown.
3179 * @dd Pointer to the driver data structure.
3184 static int mtip_hw_shutdown(struct driver_data *dd)
3187 * Send standby immediate (E0h) to the drive so that it
3190 mtip_standby_immediate(dd->port);
3198 * This function is called by the Block Layer just before the
3199 * system hibernates.
3201 * @dd Pointer to the driver data structure.
3204 * 0 Suspend was successful
3205 * -EFAULT Suspend was not successful
3207 static int mtip_hw_suspend(struct driver_data *dd)
3210 * Send standby immediate (E0h) to the drive
3211 * so that it saves its state.
3213 if (mtip_standby_immediate(dd->port) != 0) {
3214 dev_err(&dd->pdev->dev,
3215 "Failed standby-immediate command\n");
3219 /* Disable interrupts on the HBA.*/
3220 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3221 dd->mmio + HOST_CTL);
3222 mtip_deinit_port(dd->port);
3230 * This function is called by the Block Layer as the
3233 * @dd Pointer to the driver data structure.
3236 * 0 Resume was successful
3237 * -EFAULT Resume was not successful
3239 static int mtip_hw_resume(struct driver_data *dd)
3241 /* Perform any needed hardware setup steps */
3245 if (mtip_hba_reset(dd) != 0) {
3246 dev_err(&dd->pdev->dev,
3247 "Unable to reset the HBA\n");
3252 * Enable the port, DMA engine, and FIS reception specific
3253 * h/w in controller.
3255 mtip_init_port(dd->port);
3256 mtip_start_port(dd->port);
3258 /* Enable interrupts on the HBA.*/
3259 writel(readl(dd->mmio + HOST_CTL) | HOST_IRQ_EN,
3260 dd->mmio + HOST_CTL);
3266 * Helper function for reusing disk name
3267 * upon hot insertion.
3269 static int rssd_disk_name_format(char *prefix,
3274 const int base = 'z' - 'a' + 1;
3275 char *begin = buf + strlen(prefix);
3276 char *end = buf + buflen;
3286 *--p = 'a' + (index % unit);
3287 index = (index / unit) - 1;
3288 } while (index >= 0);
3290 memmove(begin, p, end - p);
3291 memcpy(buf, prefix, strlen(prefix));
3297 * Block layer IOCTL handler.
3299 * @dev Pointer to the block_device structure.
3301 * @cmd IOCTL command passed from the user application.
3302 * @arg Argument passed from the user application.
3305 * 0 IOCTL completed successfully.
3306 * -ENOTTY IOCTL not supported or invalid driver data
3307 * structure pointer.
3309 static int mtip_block_ioctl(struct block_device *dev,
3314 struct driver_data *dd = dev->bd_disk->private_data;
3316 if (!capable(CAP_SYS_ADMIN))
3322 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)))
3329 return mtip_hw_ioctl(dd, cmd, arg);
3333 #ifdef CONFIG_COMPAT
3335 * Block layer compat IOCTL handler.
3337 * @dev Pointer to the block_device structure.
3339 * @cmd IOCTL command passed from the user application.
3340 * @arg Argument passed from the user application.
3343 * 0 IOCTL completed successfully.
3344 * -ENOTTY IOCTL not supported or invalid driver data
3345 * structure pointer.
3347 static int mtip_block_compat_ioctl(struct block_device *dev,
3352 struct driver_data *dd = dev->bd_disk->private_data;
3354 if (!capable(CAP_SYS_ADMIN))
3360 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)))
3366 case HDIO_DRIVE_TASKFILE: {
3367 struct mtip_compat_ide_task_request_s __user *compat_req_task;
3368 ide_task_request_t req_task;
3369 int compat_tasksize, outtotal, ret;
3372 sizeof(struct mtip_compat_ide_task_request_s);
3375 (struct mtip_compat_ide_task_request_s __user *) arg;
3377 if (copy_from_user(&req_task, (void __user *) arg,
3378 compat_tasksize - (2 * sizeof(compat_long_t))))
3381 if (get_user(req_task.out_size, &compat_req_task->out_size))
3384 if (get_user(req_task.in_size, &compat_req_task->in_size))
3387 outtotal = sizeof(struct mtip_compat_ide_task_request_s);
3389 ret = exec_drive_taskfile(dd, (void __user *) arg,
3390 &req_task, outtotal);
3392 if (copy_to_user((void __user *) arg, &req_task,
3394 (2 * sizeof(compat_long_t))))
3397 if (put_user(req_task.out_size, &compat_req_task->out_size))
3400 if (put_user(req_task.in_size, &compat_req_task->in_size))
3406 return mtip_hw_ioctl(dd, cmd, arg);
3412 * Obtain the geometry of the device.
3414 * You may think that this function is obsolete, but some applications,
3415 * fdisk for example still used CHS values. This function describes the
3416 * device as having 224 heads and 56 sectors per cylinder. These values are
3417 * chosen so that each cylinder is aligned on a 4KB boundary. Since a
3418 * partition is described in terms of a start and end cylinder this means
3419 * that each partition is also 4KB aligned. Non-aligned partitions adversely
3420 * affects performance.
3422 * @dev Pointer to the block_device strucutre.
3423 * @geo Pointer to a hd_geometry structure.
3426 * 0 Operation completed successfully.
3427 * -ENOTTY An error occurred while reading the drive capacity.
3429 static int mtip_block_getgeo(struct block_device *dev,
3430 struct hd_geometry *geo)
3432 struct driver_data *dd = dev->bd_disk->private_data;
3438 if (!(mtip_hw_get_capacity(dd, &capacity))) {
3439 dev_warn(&dd->pdev->dev,
3440 "Could not get drive capacity.\n");
3446 sector_div(capacity, (geo->heads * geo->sectors));
3447 geo->cylinders = capacity;
3452 * Block device operation function.
3454 * This structure contains pointers to the functions required by the block
3457 static const struct block_device_operations mtip_block_ops = {
3458 .ioctl = mtip_block_ioctl,
3459 #ifdef CONFIG_COMPAT
3460 .compat_ioctl = mtip_block_compat_ioctl,
3462 .getgeo = mtip_block_getgeo,
3463 .owner = THIS_MODULE
3467 * Block layer make request function.
3469 * This function is called by the kernel to process a BIO for
3472 * @queue Pointer to the request queue. Unused other than to obtain
3473 * the driver data structure.
3474 * @bio Pointer to the BIO.
3477 static void mtip_make_request(struct request_queue *queue, struct bio *bio)
3479 struct driver_data *dd = queue->queuedata;
3480 struct scatterlist *sg;
3481 struct bio_vec *bvec;
3485 if (unlikely(dd->dd_flag & MTIP_DDF_STOP_IO)) {
3486 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
3488 bio_endio(bio, -ENXIO);
3491 if (unlikely(test_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag))) {
3492 bio_endio(bio, -ENODATA);
3495 if (unlikely(test_bit(MTIP_DDF_WRITE_PROTECT_BIT,
3497 bio_data_dir(bio))) {
3498 bio_endio(bio, -ENODATA);
3503 if (unlikely(!bio_has_data(bio))) {
3504 blk_queue_flush(queue, 0);
3509 sg = mtip_hw_get_scatterlist(dd, &tag);
3510 if (likely(sg != NULL)) {
3511 blk_queue_bounce(queue, &bio);
3513 if (unlikely((bio)->bi_vcnt > MTIP_MAX_SG)) {
3514 dev_warn(&dd->pdev->dev,
3515 "Maximum number of SGL entries exceeded\n");
3517 mtip_hw_release_scatterlist(dd, tag);
3521 /* Create the scatter list for this bio. */
3522 bio_for_each_segment(bvec, bio, nents) {
3523 sg_set_page(&sg[nents],
3529 /* Issue the read/write. */
3530 mtip_hw_submit_io(dd,
3543 * Block layer initialization function.
3545 * This function is called once by the PCI layer for each P320
3546 * device that is connected to the system.
3548 * @dd Pointer to the driver data structure.
3551 * 0 on success else an error code.
3553 static int mtip_block_initialize(struct driver_data *dd)
3555 int rv = 0, wait_for_rebuild = 0;
3557 unsigned int index = 0;
3558 struct kobject *kobj;
3559 unsigned char thd_name[16];
3562 goto skip_create_disk; /* hw init done, before rebuild */
3564 /* Initialize the protocol layer. */
3565 wait_for_rebuild = mtip_hw_init(dd);
3566 if (wait_for_rebuild < 0) {
3567 dev_err(&dd->pdev->dev,
3568 "Protocol layer initialization failed\n");
3570 goto protocol_init_error;
3573 dd->disk = alloc_disk(MTIP_MAX_MINORS);
3574 if (dd->disk == NULL) {
3575 dev_err(&dd->pdev->dev,
3576 "Unable to allocate gendisk structure\n");
3578 goto alloc_disk_error;
3581 /* Generate the disk name, implemented same as in sd.c */
3583 if (!ida_pre_get(&rssd_index_ida, GFP_KERNEL))
3586 spin_lock(&rssd_index_lock);
3587 rv = ida_get_new(&rssd_index_ida, &index);
3588 spin_unlock(&rssd_index_lock);
3589 } while (rv == -EAGAIN);
3594 rv = rssd_disk_name_format("rssd",
3596 dd->disk->disk_name,
3599 goto disk_index_error;
3601 dd->disk->driverfs_dev = &dd->pdev->dev;
3602 dd->disk->major = dd->major;
3603 dd->disk->first_minor = dd->instance * MTIP_MAX_MINORS;
3604 dd->disk->fops = &mtip_block_ops;
3605 dd->disk->private_data = dd;
3609 * if rebuild pending, start the service thread, and delay the block
3610 * queue creation and add_disk()
3612 if (wait_for_rebuild == MTIP_FTL_REBUILD_MAGIC)
3613 goto start_service_thread;
3616 /* Allocate the request queue. */
3617 dd->queue = blk_alloc_queue(GFP_KERNEL);
3618 if (dd->queue == NULL) {
3619 dev_err(&dd->pdev->dev,
3620 "Unable to allocate request queue\n");
3622 goto block_queue_alloc_init_error;
3625 /* Attach our request function to the request queue. */
3626 blk_queue_make_request(dd->queue, mtip_make_request);
3628 dd->disk->queue = dd->queue;
3629 dd->queue->queuedata = dd;
3631 /* Set device limits. */
3632 set_bit(QUEUE_FLAG_NONROT, &dd->queue->queue_flags);
3633 blk_queue_max_segments(dd->queue, MTIP_MAX_SG);
3634 blk_queue_physical_block_size(dd->queue, 4096);
3635 blk_queue_io_min(dd->queue, 4096);
3637 * write back cache is not supported in the device. FUA depends on
3638 * write back cache support, hence setting flush support to zero.
3640 blk_queue_flush(dd->queue, 0);
3642 /* Set the capacity of the device in 512 byte sectors. */
3643 if (!(mtip_hw_get_capacity(dd, &capacity))) {
3644 dev_warn(&dd->pdev->dev,
3645 "Could not read drive capacity\n");
3647 goto read_capacity_error;
3649 set_capacity(dd->disk, capacity);
3651 /* Enable the block device and add it to /dev */
3655 * Now that the disk is active, initialize any sysfs attributes
3656 * managed by the protocol layer.
3658 kobj = kobject_get(&disk_to_dev(dd->disk)->kobj);
3660 mtip_hw_sysfs_init(dd, kobj);
3664 if (dd->mtip_svc_handler) {
3665 set_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag);
3666 return rv; /* service thread created for handling rebuild */
3669 start_service_thread:
3670 sprintf(thd_name, "mtip_svc_thd_%02d", index);
3672 dd->mtip_svc_handler = kthread_run(mtip_service_thread,
3675 if (IS_ERR(dd->mtip_svc_handler)) {
3676 dev_err(&dd->pdev->dev, "service thread failed to start\n");
3677 dd->mtip_svc_handler = NULL;
3679 goto kthread_run_error;
3682 if (wait_for_rebuild == MTIP_FTL_REBUILD_MAGIC)
3683 rv = wait_for_rebuild;
3688 /* Delete our gendisk. This also removes the device from /dev */
3689 del_gendisk(dd->disk);
3691 read_capacity_error:
3692 blk_cleanup_queue(dd->queue);
3694 block_queue_alloc_init_error:
3696 spin_lock(&rssd_index_lock);
3697 ida_remove(&rssd_index_ida, index);
3698 spin_unlock(&rssd_index_lock);
3704 mtip_hw_exit(dd); /* De-initialize the protocol layer. */
3706 protocol_init_error:
3711 * Block layer deinitialization function.
3713 * Called by the PCI layer as each P320 device is removed.
3715 * @dd Pointer to the driver data structure.
3720 static int mtip_block_remove(struct driver_data *dd)
3722 struct kobject *kobj;
3724 if (dd->mtip_svc_handler) {
3725 set_bit(MTIP_PF_SVC_THD_STOP_BIT, &dd->port->flags);
3726 wake_up_interruptible(&dd->port->svc_wait);
3727 kthread_stop(dd->mtip_svc_handler);
3730 /* Clean up the sysfs attributes, if created */
3731 if (test_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag)) {
3732 kobj = kobject_get(&disk_to_dev(dd->disk)->kobj);
3734 mtip_hw_sysfs_exit(dd, kobj);
3740 * Delete our gendisk structure. This also removes the device
3743 del_gendisk(dd->disk);
3745 spin_lock(&rssd_index_lock);
3746 ida_remove(&rssd_index_ida, dd->index);
3747 spin_unlock(&rssd_index_lock);
3749 blk_cleanup_queue(dd->queue);
3753 /* De-initialize the protocol layer. */
3760 * Function called by the PCI layer when just before the
3761 * machine shuts down.
3763 * If a protocol layer shutdown function is present it will be called
3766 * @dd Pointer to the driver data structure.
3771 static int mtip_block_shutdown(struct driver_data *dd)
3773 dev_info(&dd->pdev->dev,
3774 "Shutting down %s ...\n", dd->disk->disk_name);
3776 /* Delete our gendisk structure, and cleanup the blk queue. */
3777 del_gendisk(dd->disk);
3779 spin_lock(&rssd_index_lock);
3780 ida_remove(&rssd_index_ida, dd->index);
3781 spin_unlock(&rssd_index_lock);
3783 blk_cleanup_queue(dd->queue);
3787 mtip_hw_shutdown(dd);
3791 static int mtip_block_suspend(struct driver_data *dd)
3793 dev_info(&dd->pdev->dev,
3794 "Suspending %s ...\n", dd->disk->disk_name);
3795 mtip_hw_suspend(dd);
3799 static int mtip_block_resume(struct driver_data *dd)
3801 dev_info(&dd->pdev->dev, "Resuming %s ...\n",
3802 dd->disk->disk_name);
3808 * Called for each supported PCI device detected.
3810 * This function allocates the private data structure, enables the
3811 * PCI device and then calls the block layer initialization function.
3814 * 0 on success else an error code.
3816 static int mtip_pci_probe(struct pci_dev *pdev,
3817 const struct pci_device_id *ent)
3820 struct driver_data *dd = NULL;
3822 /* Allocate memory for this devices private data. */
3823 dd = kzalloc(sizeof(struct driver_data), GFP_KERNEL);
3826 "Unable to allocate memory for driver data\n");
3830 /* Attach the private data to this PCI device. */
3831 pci_set_drvdata(pdev, dd);
3833 rv = pcim_enable_device(pdev);
3835 dev_err(&pdev->dev, "Unable to enable device\n");
3839 /* Map BAR5 to memory. */
3840 rv = pcim_iomap_regions(pdev, 1 << MTIP_ABAR, MTIP_DRV_NAME);
3842 dev_err(&pdev->dev, "Unable to map regions\n");
3846 if (!pci_set_dma_mask(pdev, DMA_BIT_MASK(64))) {
3847 rv = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
3850 rv = pci_set_consistent_dma_mask(pdev,
3853 dev_warn(&pdev->dev,
3854 "64-bit DMA enable failed\n");
3860 pci_set_master(pdev);
3862 if (pci_enable_msi(pdev)) {
3863 dev_warn(&pdev->dev,
3864 "Unable to enable MSI interrupt.\n");
3865 goto block_initialize_err;
3868 /* Copy the info we may need later into the private data structure. */
3869 dd->major = mtip_major;
3870 dd->instance = instance;
3873 /* Initialize the block layer. */
3874 rv = mtip_block_initialize(dd);
3877 "Unable to initialize block layer\n");
3878 goto block_initialize_err;
3882 * Increment the instance count so that each device has a unique
3886 if (rv != MTIP_FTL_REBUILD_MAGIC)
3887 set_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag);
3890 block_initialize_err:
3891 pci_disable_msi(pdev);
3894 pcim_iounmap_regions(pdev, 1 << MTIP_ABAR);
3898 pci_set_drvdata(pdev, NULL);
3905 * Called for each probed device when the device is removed or the
3906 * driver is unloaded.
3911 static void mtip_pci_remove(struct pci_dev *pdev)
3913 struct driver_data *dd = pci_get_drvdata(pdev);
3916 set_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag);
3918 if (mtip_check_surprise_removal(pdev)) {
3919 while (!test_bit(MTIP_DDF_CLEANUP_BIT, &dd->dd_flag)) {
3922 if (counter == 10) {
3923 /* Cleanup the outstanding commands */
3924 mtip_command_cleanup(dd);
3930 /* Clean up the block layer. */
3931 mtip_block_remove(dd);
3933 pci_disable_msi(pdev);
3936 pcim_iounmap_regions(pdev, 1 << MTIP_ABAR);
3940 * Called for each probed device when the device is suspended.
3946 static int mtip_pci_suspend(struct pci_dev *pdev, pm_message_t mesg)
3949 struct driver_data *dd = pci_get_drvdata(pdev);
3953 "Driver private datastructure is NULL\n");
3957 set_bit(MTIP_DDF_RESUME_BIT, &dd->dd_flag);
3959 /* Disable ports & interrupts then send standby immediate */
3960 rv = mtip_block_suspend(dd);
3963 "Failed to suspend controller\n");
3968 * Save the pci config space to pdev structure &
3969 * disable the device
3971 pci_save_state(pdev);
3972 pci_disable_device(pdev);
3974 /* Move to Low power state*/
3975 pci_set_power_state(pdev, PCI_D3hot);
3981 * Called for each probed device when the device is resumed.
3987 static int mtip_pci_resume(struct pci_dev *pdev)
3990 struct driver_data *dd;
3992 dd = pci_get_drvdata(pdev);
3995 "Driver private datastructure is NULL\n");
3999 /* Move the device to active State */
4000 pci_set_power_state(pdev, PCI_D0);
4002 /* Restore PCI configuration space */
4003 pci_restore_state(pdev);
4005 /* Enable the PCI device*/
4006 rv = pcim_enable_device(pdev);
4009 "Failed to enable card during resume\n");
4012 pci_set_master(pdev);
4015 * Calls hbaReset, initPort, & startPort function
4016 * then enables interrupts
4018 rv = mtip_block_resume(dd);
4020 dev_err(&pdev->dev, "Unable to resume\n");
4023 clear_bit(MTIP_DDF_RESUME_BIT, &dd->dd_flag);
4034 static void mtip_pci_shutdown(struct pci_dev *pdev)
4036 struct driver_data *dd = pci_get_drvdata(pdev);
4038 mtip_block_shutdown(dd);
4041 /* Table of device ids supported by this driver. */
4042 static DEFINE_PCI_DEVICE_TABLE(mtip_pci_tbl) = {
4043 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P320_DEVICE_ID) },
4047 /* Structure that describes the PCI driver functions. */
4048 static struct pci_driver mtip_pci_driver = {
4049 .name = MTIP_DRV_NAME,
4050 .id_table = mtip_pci_tbl,
4051 .probe = mtip_pci_probe,
4052 .remove = mtip_pci_remove,
4053 .suspend = mtip_pci_suspend,
4054 .resume = mtip_pci_resume,
4055 .shutdown = mtip_pci_shutdown,
4058 MODULE_DEVICE_TABLE(pci, mtip_pci_tbl);
4061 * Module initialization function.
4063 * Called once when the module is loaded. This function allocates a major
4064 * block device number to the Cyclone devices and registers the PCI layer
4068 * 0 on success else error code.
4070 static int __init mtip_init(void)
4074 printk(KERN_INFO MTIP_DRV_NAME " Version " MTIP_DRV_VERSION "\n");
4076 /* Allocate a major block device number to use with this driver. */
4077 error = register_blkdev(0, MTIP_DRV_NAME);
4079 printk(KERN_ERR "Unable to register block device (%d)\n",
4085 /* Register our PCI operations. */
4086 error = pci_register_driver(&mtip_pci_driver);
4088 unregister_blkdev(mtip_major, MTIP_DRV_NAME);
4094 * Module de-initialization function.
4096 * Called once when the module is unloaded. This function deallocates
4097 * the major block device number allocated by mtip_init() and
4098 * unregisters the PCI layer of the driver.
4103 static void __exit mtip_exit(void)
4105 /* Release the allocated major block device number. */
4106 unregister_blkdev(mtip_major, MTIP_DRV_NAME);
4108 /* Unregister the PCI driver. */
4109 pci_unregister_driver(&mtip_pci_driver);
4112 MODULE_AUTHOR("Micron Technology, Inc");
4113 MODULE_DESCRIPTION("Micron RealSSD PCIe Block Driver");
4114 MODULE_LICENSE("GPL");
4115 MODULE_VERSION(MTIP_DRV_VERSION);
4117 module_init(mtip_init);
4118 module_exit(mtip_exit);