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->mmio + PORT_IRQ_STAT), port->mmio + PORT_IRQ_STAT);
441 /* Clear any pending interrupts on the HBA. */
442 writel(readl(port->dd->mmio + HOST_IRQ_STAT),
443 port->dd->mmio + HOST_IRQ_STAT);
445 /* Enable port interrupts */
446 writel(DEF_PORT_IRQ, port->mmio + PORT_IRQ_MASK);
452 * @port Pointer to the port data structure.
457 static void mtip_restart_port(struct mtip_port *port)
459 unsigned long timeout;
461 /* Disable the DMA engine */
462 mtip_enable_engine(port, 0);
464 /* Chip quirk: wait up to 500ms for PxCMD.CR == 0 */
465 timeout = jiffies + msecs_to_jiffies(500);
466 while ((readl(port->mmio + PORT_CMD) & PORT_CMD_LIST_ON)
467 && time_before(jiffies, timeout))
470 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
474 * Chip quirk: escalate to hba reset if
475 * PxCMD.CR not clear after 500 ms
477 if (readl(port->mmio + PORT_CMD) & PORT_CMD_LIST_ON) {
478 dev_warn(&port->dd->pdev->dev,
479 "PxCMD.CR not clear, escalating reset\n");
481 if (hba_reset_nosleep(port->dd))
482 dev_err(&port->dd->pdev->dev,
483 "HBA reset escalation failed.\n");
485 /* 30 ms delay before com reset to quiesce chip */
489 dev_warn(&port->dd->pdev->dev, "Issuing COM reset\n");
492 writel(readl(port->mmio + PORT_SCR_CTL) |
493 1, port->mmio + PORT_SCR_CTL);
494 readl(port->mmio + PORT_SCR_CTL);
496 /* Wait 1 ms to quiesce chip function */
497 timeout = jiffies + msecs_to_jiffies(1);
498 while (time_before(jiffies, timeout))
501 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
504 /* Clear PxSCTL.DET */
505 writel(readl(port->mmio + PORT_SCR_CTL) & ~1,
506 port->mmio + PORT_SCR_CTL);
507 readl(port->mmio + PORT_SCR_CTL);
509 /* Wait 500 ms for bit 0 of PORT_SCR_STS to be set */
510 timeout = jiffies + msecs_to_jiffies(500);
511 while (((readl(port->mmio + PORT_SCR_STAT) & 0x01) == 0)
512 && time_before(jiffies, timeout))
515 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
518 if ((readl(port->mmio + PORT_SCR_STAT) & 0x01) == 0)
519 dev_warn(&port->dd->pdev->dev,
520 "COM reset failed\n");
522 mtip_init_port(port);
523 mtip_start_port(port);
528 * Helper function for tag logging
530 static void print_tags(struct driver_data *dd,
532 unsigned long *tagbits,
535 unsigned char tagmap[128];
536 int group, tagmap_len = 0;
538 memset(tagmap, 0, sizeof(tagmap));
539 for (group = SLOTBITS_IN_LONGS; group > 0; group--)
540 tagmap_len = sprintf(tagmap + tagmap_len, "%016lX ",
542 dev_warn(&dd->pdev->dev,
543 "%d command(s) %s: tagmap [%s]", cnt, msg, tagmap);
547 * Called periodically to see if any read/write commands are
548 * taking too long to complete.
550 * @data Pointer to the PORT data structure.
555 static void mtip_timeout_function(unsigned long int data)
557 struct mtip_port *port = (struct mtip_port *) data;
558 struct host_to_dev_fis *fis;
559 struct mtip_cmd *command;
560 int tag, cmdto_cnt = 0;
561 unsigned int bit, group;
562 unsigned int num_command_slots = port->dd->slot_groups * 32;
563 unsigned long to, tagaccum[SLOTBITS_IN_LONGS];
568 if (test_bit(MTIP_DDF_RESUME_BIT, &port->dd->dd_flag)) {
569 mod_timer(&port->cmd_timer,
570 jiffies + msecs_to_jiffies(30000));
573 /* clear the tag accumulator */
574 memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
576 for (tag = 0; tag < num_command_slots; tag++) {
578 * Skip internal command slot as it has
579 * its own timeout mechanism
581 if (tag == MTIP_TAG_INTERNAL)
584 if (atomic_read(&port->commands[tag].active) &&
585 (time_after(jiffies, port->commands[tag].comp_time))) {
589 command = &port->commands[tag];
590 fis = (struct host_to_dev_fis *) command->command;
592 set_bit(tag, tagaccum);
595 set_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
598 * Clear the completed bit. This should prevent
599 * any interrupt handlers from trying to retire
602 writel(1 << bit, port->completed[group]);
604 /* Call the async completion callback. */
605 if (likely(command->async_callback))
606 command->async_callback(command->async_data,
608 command->async_callback = NULL;
609 command->comp_func = NULL;
611 /* Unmap the DMA scatter list entries */
612 dma_unmap_sg(&port->dd->pdev->dev,
614 command->scatter_ents,
618 * Clear the allocated bit and active tag for the
621 atomic_set(&port->commands[tag].active, 0);
622 release_slot(port, tag);
628 if (cmdto_cnt && !test_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags)) {
629 print_tags(port->dd, "timed out", tagaccum, cmdto_cnt);
631 mtip_restart_port(port);
632 clear_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
633 wake_up_interruptible(&port->svc_wait);
636 if (port->ic_pause_timer) {
637 to = port->ic_pause_timer + msecs_to_jiffies(1000);
638 if (time_after(jiffies, to)) {
639 if (!test_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags)) {
640 port->ic_pause_timer = 0;
641 clear_bit(MTIP_PF_SE_ACTIVE_BIT, &port->flags);
642 clear_bit(MTIP_PF_DM_ACTIVE_BIT, &port->flags);
643 clear_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
644 wake_up_interruptible(&port->svc_wait);
651 /* Restart the timer */
652 mod_timer(&port->cmd_timer,
653 jiffies + msecs_to_jiffies(MTIP_TIMEOUT_CHECK_PERIOD));
657 * IO completion function.
659 * This completion function is called by the driver ISR when a
660 * command that was issued by the kernel completes. It first calls the
661 * asynchronous completion function which normally calls back into the block
662 * layer passing the asynchronous callback data, then unmaps the
663 * scatter list associated with the completed command, and finally
664 * clears the allocated bit associated with the completed command.
666 * @port Pointer to the port data structure.
667 * @tag Tag of the command.
668 * @data Pointer to driver_data.
669 * @status Completion status.
674 static void mtip_async_complete(struct mtip_port *port,
679 struct mtip_cmd *command;
680 struct driver_data *dd = data;
681 int cb_status = status ? -EIO : 0;
683 if (unlikely(!dd) || unlikely(!port))
686 command = &port->commands[tag];
688 if (unlikely(status == PORT_IRQ_TF_ERR)) {
689 dev_warn(&port->dd->pdev->dev,
690 "Command tag %d failed due to TFE\n", tag);
693 /* Upper layer callback */
694 if (likely(command->async_callback))
695 command->async_callback(command->async_data, cb_status);
697 command->async_callback = NULL;
698 command->comp_func = NULL;
700 /* Unmap the DMA scatter list entries */
701 dma_unmap_sg(&dd->pdev->dev,
703 command->scatter_ents,
706 /* Clear the allocated and active bits for the command */
707 atomic_set(&port->commands[tag].active, 0);
708 release_slot(port, tag);
714 * Internal command completion callback function.
716 * This function is normally called by the driver ISR when an internal
717 * command completed. This function signals the command completion by
718 * calling complete().
720 * @port Pointer to the port data structure.
721 * @tag Tag of the command that has completed.
722 * @data Pointer to a completion structure.
723 * @status Completion status.
728 static void mtip_completion(struct mtip_port *port,
733 struct mtip_cmd *command = &port->commands[tag];
734 struct completion *waiting = data;
735 if (unlikely(status == PORT_IRQ_TF_ERR))
736 dev_warn(&port->dd->pdev->dev,
737 "Internal command %d completed with TFE\n", tag);
739 command->async_callback = NULL;
740 command->comp_func = NULL;
745 static void mtip_null_completion(struct mtip_port *port,
753 static int mtip_read_log_page(struct mtip_port *port, u8 page, u16 *buffer,
754 dma_addr_t buffer_dma, unsigned int sectors);
755 static int mtip_get_smart_attr(struct mtip_port *port, unsigned int id,
756 struct smart_attr *attrib);
760 * @dd Pointer to the DRIVER_DATA structure.
765 static void mtip_handle_tfe(struct driver_data *dd)
767 int group, tag, bit, reissue, rv;
768 struct mtip_port *port;
769 struct mtip_cmd *cmd;
771 struct host_to_dev_fis *fis;
772 unsigned long tagaccum[SLOTBITS_IN_LONGS];
773 unsigned int cmd_cnt = 0;
775 char *fail_reason = NULL;
776 int fail_all_ncq_write = 0, fail_all_ncq_cmds = 0;
778 dev_warn(&dd->pdev->dev, "Taskfile error\n");
782 /* Stop the timer to prevent command timeouts. */
783 del_timer(&port->cmd_timer);
784 set_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
786 if (test_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags) &&
787 test_bit(MTIP_TAG_INTERNAL, port->allocated)) {
788 cmd = &port->commands[MTIP_TAG_INTERNAL];
789 dbg_printk(MTIP_DRV_NAME " TFE for the internal command\n");
791 atomic_inc(&cmd->active); /* active > 1 indicates error */
792 if (cmd->comp_data && cmd->comp_func) {
793 cmd->comp_func(port, MTIP_TAG_INTERNAL,
794 cmd->comp_data, PORT_IRQ_TF_ERR);
796 goto handle_tfe_exit;
799 /* clear the tag accumulator */
800 memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
802 /* Loop through all the groups */
803 for (group = 0; group < dd->slot_groups; group++) {
804 completed = readl(port->completed[group]);
806 /* clear completed status register in the hardware.*/
807 writel(completed, port->completed[group]);
809 /* Process successfully completed commands */
810 for (bit = 0; bit < 32 && completed; bit++) {
811 if (!(completed & (1<<bit)))
813 tag = (group << 5) + bit;
815 /* Skip the internal command slot */
816 if (tag == MTIP_TAG_INTERNAL)
819 cmd = &port->commands[tag];
820 if (likely(cmd->comp_func)) {
821 set_bit(tag, tagaccum);
823 atomic_set(&cmd->active, 0);
829 dev_err(&port->dd->pdev->dev,
830 "Missing completion func for tag %d",
832 if (mtip_check_surprise_removal(dd->pdev)) {
833 mtip_command_cleanup(dd);
834 /* don't proceed further */
841 print_tags(dd, "completed (TFE)", tagaccum, cmd_cnt);
843 /* Restart the port */
845 mtip_restart_port(port);
847 /* Trying to determine the cause of the error */
848 rv = mtip_read_log_page(dd->port, ATA_LOG_SATA_NCQ,
850 dd->port->log_buf_dma, 1);
852 dev_warn(&dd->pdev->dev,
853 "Error in READ LOG EXT (10h) command\n");
854 /* non-critical error, don't fail the load */
856 buf = (unsigned char *)dd->port->log_buf;
857 if (buf[259] & 0x1) {
858 dev_info(&dd->pdev->dev,
859 "Write protect bit is set.\n");
860 set_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag);
861 fail_all_ncq_write = 1;
862 fail_reason = "write protect";
864 if (buf[288] == 0xF7) {
865 dev_info(&dd->pdev->dev,
866 "Exceeded Tmax, drive in thermal shutdown.\n");
867 set_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag);
868 fail_all_ncq_cmds = 1;
869 fail_reason = "thermal shutdown";
871 if (buf[288] == 0xBF) {
872 dev_info(&dd->pdev->dev,
873 "Drive indicates rebuild has failed.\n");
874 fail_all_ncq_cmds = 1;
875 fail_reason = "rebuild failed";
879 /* clear the tag accumulator */
880 memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
882 /* Loop through all the groups */
883 for (group = 0; group < dd->slot_groups; group++) {
884 for (bit = 0; bit < 32; bit++) {
886 tag = (group << 5) + bit;
887 cmd = &port->commands[tag];
889 /* If the active bit is set re-issue the command */
890 if (atomic_read(&cmd->active) == 0)
893 fis = (struct host_to_dev_fis *)cmd->command;
895 /* Should re-issue? */
896 if (tag == MTIP_TAG_INTERNAL ||
897 fis->command == ATA_CMD_SET_FEATURES)
900 if (fail_all_ncq_cmds ||
901 (fail_all_ncq_write &&
902 fis->command == ATA_CMD_FPDMA_WRITE)) {
903 dev_warn(&dd->pdev->dev,
904 " Fail: %s w/tag %d [%s].\n",
905 fis->command == ATA_CMD_FPDMA_WRITE ?
908 fail_reason != NULL ?
909 fail_reason : "unknown");
910 atomic_set(&cmd->active, 0);
911 if (cmd->comp_func) {
912 cmd->comp_func(port, tag,
921 * First check if this command has
922 * exceeded its retries.
924 if (reissue && (cmd->retries-- > 0)) {
926 set_bit(tag, tagaccum);
928 /* Re-issue the command. */
929 mtip_issue_ncq_command(port, tag);
934 /* Retire a command that will not be reissued */
935 dev_warn(&port->dd->pdev->dev,
936 "retiring tag %d\n", tag);
937 atomic_set(&cmd->active, 0);
946 dev_warn(&port->dd->pdev->dev,
947 "Bad completion for tag %d\n",
951 print_tags(dd, "reissued (TFE)", tagaccum, cmd_cnt);
954 /* clear eh_active */
955 clear_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
956 wake_up_interruptible(&port->svc_wait);
958 mod_timer(&port->cmd_timer,
959 jiffies + msecs_to_jiffies(MTIP_TIMEOUT_CHECK_PERIOD));
963 * Handle a set device bits interrupt
965 static inline void mtip_process_sdbf(struct driver_data *dd)
967 struct mtip_port *port = dd->port;
970 struct mtip_cmd *command;
972 /* walk all bits in all slot groups */
973 for (group = 0; group < dd->slot_groups; group++) {
974 completed = readl(port->completed[group]);
976 /* clear completed status register in the hardware.*/
977 writel(completed, port->completed[group]);
979 /* Process completed commands. */
981 (bit < 32) && completed;
982 bit++, completed >>= 1) {
983 if (completed & 0x01) {
984 tag = (group << 5) | bit;
986 /* skip internal command slot. */
987 if (unlikely(tag == MTIP_TAG_INTERNAL))
990 command = &port->commands[tag];
991 /* make internal callback */
992 if (likely(command->comp_func)) {
999 dev_warn(&dd->pdev->dev,
1004 if (mtip_check_surprise_removal(
1006 mtip_command_cleanup(dd);
1016 * Process legacy pio and d2h interrupts
1018 static inline void mtip_process_legacy(struct driver_data *dd, u32 port_stat)
1020 struct mtip_port *port = dd->port;
1021 struct mtip_cmd *cmd = &port->commands[MTIP_TAG_INTERNAL];
1023 if (test_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags) &&
1024 (cmd != NULL) && !(readl(port->cmd_issue[MTIP_TAG_INTERNAL])
1025 & (1 << MTIP_TAG_INTERNAL))) {
1026 if (cmd->comp_func) {
1027 cmd->comp_func(port,
1039 * Demux and handle errors
1041 static inline void mtip_process_errors(struct driver_data *dd, u32 port_stat)
1043 if (likely(port_stat & (PORT_IRQ_TF_ERR | PORT_IRQ_IF_ERR)))
1044 mtip_handle_tfe(dd);
1046 if (unlikely(port_stat & PORT_IRQ_CONNECT)) {
1047 dev_warn(&dd->pdev->dev,
1048 "Clearing PxSERR.DIAG.x\n");
1049 writel((1 << 26), dd->port->mmio + PORT_SCR_ERR);
1052 if (unlikely(port_stat & PORT_IRQ_PHYRDY)) {
1053 dev_warn(&dd->pdev->dev,
1054 "Clearing PxSERR.DIAG.n\n");
1055 writel((1 << 16), dd->port->mmio + PORT_SCR_ERR);
1058 if (unlikely(port_stat & ~PORT_IRQ_HANDLED)) {
1059 dev_warn(&dd->pdev->dev,
1060 "Port stat errors %x unhandled\n",
1061 (port_stat & ~PORT_IRQ_HANDLED));
1065 static inline irqreturn_t mtip_handle_irq(struct driver_data *data)
1067 struct driver_data *dd = (struct driver_data *) data;
1068 struct mtip_port *port = dd->port;
1069 u32 hba_stat, port_stat;
1072 hba_stat = readl(dd->mmio + HOST_IRQ_STAT);
1076 /* Acknowledge the interrupt status on the port.*/
1077 port_stat = readl(port->mmio + PORT_IRQ_STAT);
1078 writel(port_stat, port->mmio + PORT_IRQ_STAT);
1080 /* Demux port status */
1081 if (likely(port_stat & PORT_IRQ_SDB_FIS))
1082 mtip_process_sdbf(dd);
1084 if (unlikely(port_stat & PORT_IRQ_ERR)) {
1085 if (unlikely(mtip_check_surprise_removal(dd->pdev))) {
1086 mtip_command_cleanup(dd);
1087 /* don't proceed further */
1090 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
1094 mtip_process_errors(dd, port_stat & PORT_IRQ_ERR);
1097 if (unlikely(port_stat & PORT_IRQ_LEGACY))
1098 mtip_process_legacy(dd, port_stat & PORT_IRQ_LEGACY);
1101 /* acknowledge interrupt */
1102 writel(hba_stat, dd->mmio + HOST_IRQ_STAT);
1108 * Wrapper for mtip_handle_irq
1109 * (ignores return code)
1111 static void mtip_tasklet(unsigned long data)
1113 mtip_handle_irq((struct driver_data *) data);
1117 * HBA interrupt subroutine.
1120 * @instance Pointer to the driver data structure.
1123 * IRQ_HANDLED A HBA interrupt was pending and handled.
1124 * IRQ_NONE This interrupt was not for the HBA.
1126 static irqreturn_t mtip_irq_handler(int irq, void *instance)
1128 struct driver_data *dd = instance;
1129 tasklet_schedule(&dd->tasklet);
1133 static void mtip_issue_non_ncq_command(struct mtip_port *port, int tag)
1135 atomic_set(&port->commands[tag].active, 1);
1136 writel(1 << MTIP_TAG_BIT(tag),
1137 port->cmd_issue[MTIP_TAG_INDEX(tag)]);
1140 static bool mtip_pause_ncq(struct mtip_port *port,
1141 struct host_to_dev_fis *fis)
1143 struct host_to_dev_fis *reply;
1144 unsigned long task_file_data;
1146 reply = port->rxfis + RX_FIS_D2H_REG;
1147 task_file_data = readl(port->mmio+PORT_TFDATA);
1149 if ((task_file_data & 1) || (fis->command == ATA_CMD_SEC_ERASE_UNIT))
1152 if (fis->command == ATA_CMD_SEC_ERASE_PREP) {
1153 set_bit(MTIP_PF_SE_ACTIVE_BIT, &port->flags);
1154 port->ic_pause_timer = jiffies;
1156 } else if ((fis->command == ATA_CMD_DOWNLOAD_MICRO) &&
1157 (fis->features == 0x03)) {
1158 set_bit(MTIP_PF_DM_ACTIVE_BIT, &port->flags);
1159 port->ic_pause_timer = jiffies;
1161 } else if ((fis->command == ATA_CMD_SEC_ERASE_UNIT) ||
1162 ((fis->command == 0xFC) &&
1163 (fis->features == 0x27 || fis->features == 0x72 ||
1164 fis->features == 0x62 || fis->features == 0x26))) {
1165 /* Com reset after secure erase or lowlevel format */
1166 mtip_restart_port(port);
1174 * Wait for port to quiesce
1176 * @port Pointer to port data structure
1177 * @timeout Max duration to wait (ms)
1181 * -EBUSY Commands still active
1183 static int mtip_quiesce_io(struct mtip_port *port, unsigned long timeout)
1187 unsigned int active = 1;
1189 to = jiffies + msecs_to_jiffies(timeout);
1191 if (test_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags) &&
1192 test_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags)) {
1194 continue; /* svc thd is actively issuing commands */
1196 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
1199 * Ignore s_active bit 0 of array element 0.
1200 * This bit will always be set
1202 active = readl(port->s_active[0]) & 0xFFFFFFFE;
1203 for (n = 1; n < port->dd->slot_groups; n++)
1204 active |= readl(port->s_active[n]);
1210 } while (time_before(jiffies, to));
1212 return active ? -EBUSY : 0;
1216 * Execute an internal command and wait for the completion.
1218 * @port Pointer to the port data structure.
1219 * @fis Pointer to the FIS that describes the command.
1220 * @fis_len Length in WORDS of the FIS.
1221 * @buffer DMA accessible for command data.
1222 * @buf_len Length, in bytes, of the data buffer.
1223 * @opts Command header options, excluding the FIS length
1224 * and the number of PRD entries.
1225 * @timeout Time in ms to wait for the command to complete.
1228 * 0 Command completed successfully.
1229 * -EFAULT The buffer address is not correctly aligned.
1230 * -EBUSY Internal command or other IO in progress.
1231 * -EAGAIN Time out waiting for command to complete.
1233 static int mtip_exec_internal_command(struct mtip_port *port,
1234 struct host_to_dev_fis *fis,
1240 unsigned long timeout)
1242 struct mtip_cmd_sg *command_sg;
1243 DECLARE_COMPLETION_ONSTACK(wait);
1244 int rv = 0, ready2go = 1;
1245 struct mtip_cmd *int_cmd = &port->commands[MTIP_TAG_INTERNAL];
1248 /* Make sure the buffer is 8 byte aligned. This is asic specific. */
1249 if (buffer & 0x00000007) {
1250 dev_err(&port->dd->pdev->dev,
1251 "SG buffer is not 8 byte aligned\n");
1255 to = jiffies + msecs_to_jiffies(timeout);
1257 ready2go = !test_and_set_bit(MTIP_TAG_INTERNAL,
1262 } while (time_before(jiffies, to));
1264 dev_warn(&port->dd->pdev->dev,
1265 "Internal cmd active. new cmd [%02X]\n", fis->command);
1268 set_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
1269 port->ic_pause_timer = 0;
1271 if (fis->command == ATA_CMD_SEC_ERASE_UNIT)
1272 clear_bit(MTIP_PF_SE_ACTIVE_BIT, &port->flags);
1273 else if (fis->command == ATA_CMD_DOWNLOAD_MICRO)
1274 clear_bit(MTIP_PF_DM_ACTIVE_BIT, &port->flags);
1276 if (atomic == GFP_KERNEL) {
1277 if (fis->command != ATA_CMD_STANDBYNOW1) {
1278 /* wait for io to complete if non atomic */
1279 if (mtip_quiesce_io(port, 5000) < 0) {
1280 dev_warn(&port->dd->pdev->dev,
1281 "Failed to quiesce IO\n");
1282 release_slot(port, MTIP_TAG_INTERNAL);
1283 clear_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
1284 wake_up_interruptible(&port->svc_wait);
1289 /* Set the completion function and data for the command. */
1290 int_cmd->comp_data = &wait;
1291 int_cmd->comp_func = mtip_completion;
1294 /* Clear completion - we're going to poll */
1295 int_cmd->comp_data = NULL;
1296 int_cmd->comp_func = mtip_null_completion;
1299 /* Copy the command to the command table */
1300 memcpy(int_cmd->command, fis, fis_len*4);
1302 /* Populate the SG list */
1303 int_cmd->command_header->opts =
1304 __force_bit2int cpu_to_le32(opts | fis_len);
1306 command_sg = int_cmd->command + AHCI_CMD_TBL_HDR_SZ;
1309 __force_bit2int cpu_to_le32((buf_len-1) & 0x3FFFFF);
1311 __force_bit2int cpu_to_le32(buffer & 0xFFFFFFFF);
1312 command_sg->dba_upper =
1313 __force_bit2int cpu_to_le32((buffer >> 16) >> 16);
1315 int_cmd->command_header->opts |=
1316 __force_bit2int cpu_to_le32((1 << 16));
1319 /* Populate the command header */
1320 int_cmd->command_header->byte_count = 0;
1322 /* Issue the command to the hardware */
1323 mtip_issue_non_ncq_command(port, MTIP_TAG_INTERNAL);
1325 /* Poll if atomic, wait_for_completion otherwise */
1326 if (atomic == GFP_KERNEL) {
1327 /* Wait for the command to complete or timeout. */
1328 if (wait_for_completion_timeout(
1330 msecs_to_jiffies(timeout)) == 0) {
1331 dev_err(&port->dd->pdev->dev,
1332 "Internal command did not complete [%d] "
1333 "within timeout of %lu ms\n",
1335 if (mtip_check_surprise_removal(port->dd->pdev) ||
1336 test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
1337 &port->dd->dd_flag)) {
1344 /* Spin for <timeout> checking if command still outstanding */
1345 timeout = jiffies + msecs_to_jiffies(timeout);
1346 while ((readl(port->cmd_issue[MTIP_TAG_INTERNAL])
1347 & (1 << MTIP_TAG_INTERNAL))
1348 && time_before(jiffies, timeout)) {
1349 if (mtip_check_surprise_removal(port->dd->pdev)) {
1353 if ((fis->command != ATA_CMD_STANDBYNOW1) &&
1354 test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
1355 &port->dd->dd_flag)) {
1359 if (readl(port->mmio + PORT_IRQ_STAT) & PORT_IRQ_ERR) {
1360 atomic_inc(&int_cmd->active); /* error */
1366 if (atomic_read(&int_cmd->active) > 1) {
1367 dev_err(&port->dd->pdev->dev,
1368 "Internal command [%02X] failed\n", fis->command);
1371 if (readl(port->cmd_issue[MTIP_TAG_INTERNAL])
1372 & (1 << MTIP_TAG_INTERNAL)) {
1374 if (!test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
1375 &port->dd->dd_flag)) {
1376 mtip_restart_port(port);
1381 /* Clear the allocated and active bits for the internal command. */
1382 atomic_set(&int_cmd->active, 0);
1383 release_slot(port, MTIP_TAG_INTERNAL);
1384 if (rv >= 0 && mtip_pause_ncq(port, fis)) {
1388 clear_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
1389 wake_up_interruptible(&port->svc_wait);
1395 * Byte-swap ATA ID strings.
1397 * ATA identify data contains strings in byte-swapped 16-bit words.
1398 * They must be swapped (on all architectures) to be usable as C strings.
1399 * This function swaps bytes in-place.
1401 * @buf The buffer location of the string
1402 * @len The number of bytes to swap
1407 static inline void ata_swap_string(u16 *buf, unsigned int len)
1410 for (i = 0; i < (len/2); i++)
1411 be16_to_cpus(&buf[i]);
1415 * Request the device identity information.
1417 * If a user space buffer is not specified, i.e. is NULL, the
1418 * identify information is still read from the drive and placed
1419 * into the identify data buffer (@e port->identify) in the
1420 * port data structure.
1421 * When the identify buffer contains valid identify information @e
1422 * port->identify_valid is non-zero.
1424 * @port Pointer to the port structure.
1425 * @user_buffer A user space buffer where the identify data should be
1429 * 0 Command completed successfully.
1430 * -EFAULT An error occurred while coping data to the user buffer.
1431 * -1 Command failed.
1433 static int mtip_get_identify(struct mtip_port *port, void __user *user_buffer)
1436 struct host_to_dev_fis fis;
1438 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
1441 /* Build the FIS. */
1442 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1445 fis.command = ATA_CMD_ID_ATA;
1447 /* Set the identify information as invalid. */
1448 port->identify_valid = 0;
1450 /* Clear the identify information. */
1451 memset(port->identify, 0, sizeof(u16) * ATA_ID_WORDS);
1453 /* Execute the command. */
1454 if (mtip_exec_internal_command(port,
1458 sizeof(u16) * ATA_ID_WORDS,
1461 MTIP_INTERNAL_COMMAND_TIMEOUT_MS)
1468 * Perform any necessary byte-swapping. Yes, the kernel does in fact
1469 * perform field-sensitive swapping on the string fields.
1470 * See the kernel use of ata_id_string() for proof of this.
1472 #ifdef __LITTLE_ENDIAN
1473 ata_swap_string(port->identify + 27, 40); /* model string*/
1474 ata_swap_string(port->identify + 23, 8); /* firmware string*/
1475 ata_swap_string(port->identify + 10, 20); /* serial# string*/
1479 for (i = 0; i < ATA_ID_WORDS; i++)
1480 port->identify[i] = le16_to_cpu(port->identify[i]);
1484 /* Set the identify buffer as valid. */
1485 port->identify_valid = 1;
1491 ATA_ID_WORDS * sizeof(u16))) {
1502 * Issue a standby immediate command to the device.
1504 * @port Pointer to the port structure.
1507 * 0 Command was executed successfully.
1508 * -1 An error occurred while executing the command.
1510 static int mtip_standby_immediate(struct mtip_port *port)
1513 struct host_to_dev_fis fis;
1514 unsigned long start;
1516 /* Build the FIS. */
1517 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1520 fis.command = ATA_CMD_STANDBYNOW1;
1523 rv = mtip_exec_internal_command(port,
1531 dbg_printk(MTIP_DRV_NAME "Time taken to complete standby cmd: %d ms\n",
1532 jiffies_to_msecs(jiffies - start));
1534 dev_warn(&port->dd->pdev->dev,
1535 "STANDBY IMMEDIATE command failed.\n");
1541 * Issue a READ LOG EXT command to the device.
1543 * @port pointer to the port structure.
1544 * @page page number to fetch
1545 * @buffer pointer to buffer
1546 * @buffer_dma dma address corresponding to @buffer
1547 * @sectors page length to fetch, in sectors
1550 * @rv return value from mtip_exec_internal_command()
1552 static int mtip_read_log_page(struct mtip_port *port, u8 page, u16 *buffer,
1553 dma_addr_t buffer_dma, unsigned int sectors)
1555 struct host_to_dev_fis fis;
1557 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1560 fis.command = ATA_CMD_READ_LOG_EXT;
1561 fis.sect_count = sectors & 0xFF;
1562 fis.sect_cnt_ex = (sectors >> 8) & 0xFF;
1565 fis.device = ATA_DEVICE_OBS;
1567 memset(buffer, 0, sectors * ATA_SECT_SIZE);
1569 return mtip_exec_internal_command(port,
1573 sectors * ATA_SECT_SIZE,
1576 MTIP_INTERNAL_COMMAND_TIMEOUT_MS);
1580 * Issue a SMART READ DATA command to the device.
1582 * @port pointer to the port structure.
1583 * @buffer pointer to buffer
1584 * @buffer_dma dma address corresponding to @buffer
1587 * @rv return value from mtip_exec_internal_command()
1589 static int mtip_get_smart_data(struct mtip_port *port, u8 *buffer,
1590 dma_addr_t buffer_dma)
1592 struct host_to_dev_fis fis;
1594 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1597 fis.command = ATA_CMD_SMART;
1598 fis.features = 0xD0;
1602 fis.device = ATA_DEVICE_OBS;
1604 return mtip_exec_internal_command(port,
1615 * Get the value of a smart attribute
1617 * @port pointer to the port structure
1618 * @id attribute number
1619 * @attrib pointer to return attrib information corresponding to @id
1622 * -EINVAL NULL buffer passed or unsupported attribute @id.
1623 * -EPERM Identify data not valid, SMART not supported or not enabled
1625 static int mtip_get_smart_attr(struct mtip_port *port, unsigned int id,
1626 struct smart_attr *attrib)
1629 struct smart_attr *pattr;
1634 if (!port->identify_valid) {
1635 dev_warn(&port->dd->pdev->dev, "IDENTIFY DATA not valid\n");
1638 if (!(port->identify[82] & 0x1)) {
1639 dev_warn(&port->dd->pdev->dev, "SMART not supported\n");
1642 if (!(port->identify[85] & 0x1)) {
1643 dev_warn(&port->dd->pdev->dev, "SMART not enabled\n");
1647 memset(port->smart_buf, 0, ATA_SECT_SIZE);
1648 rv = mtip_get_smart_data(port, port->smart_buf, port->smart_buf_dma);
1650 dev_warn(&port->dd->pdev->dev, "Failed to ge SMART data\n");
1654 pattr = (struct smart_attr *)(port->smart_buf + 2);
1655 for (i = 0; i < 29; i++, pattr++)
1656 if (pattr->attr_id == id) {
1657 memcpy(attrib, pattr, sizeof(struct smart_attr));
1662 dev_warn(&port->dd->pdev->dev,
1663 "Query for invalid SMART attribute ID\n");
1671 * Get the drive capacity.
1673 * @dd Pointer to the device data structure.
1674 * @sectors Pointer to the variable that will receive the sector count.
1677 * 1 Capacity was returned successfully.
1678 * 0 The identify information is invalid.
1680 static bool mtip_hw_get_capacity(struct driver_data *dd, sector_t *sectors)
1682 struct mtip_port *port = dd->port;
1683 u64 total, raw0, raw1, raw2, raw3;
1684 raw0 = port->identify[100];
1685 raw1 = port->identify[101];
1686 raw2 = port->identify[102];
1687 raw3 = port->identify[103];
1688 total = raw0 | raw1<<16 | raw2<<32 | raw3<<48;
1690 return (bool) !!port->identify_valid;
1696 * Resets the HBA by setting the HBA Reset bit in the Global
1697 * HBA Control register. After setting the HBA Reset bit the
1698 * function waits for 1 second before reading the HBA Reset
1699 * bit to make sure it has cleared. If HBA Reset is not clear
1700 * an error is returned. Cannot be used in non-blockable
1703 * @dd Pointer to the driver data structure.
1706 * 0 The reset was successful.
1707 * -1 The HBA Reset bit did not clear.
1709 static int mtip_hba_reset(struct driver_data *dd)
1711 mtip_deinit_port(dd->port);
1713 /* Set the reset bit */
1714 writel(HOST_RESET, dd->mmio + HOST_CTL);
1717 readl(dd->mmio + HOST_CTL);
1719 /* Wait for reset to clear */
1722 /* Check the bit has cleared */
1723 if (readl(dd->mmio + HOST_CTL) & HOST_RESET) {
1724 dev_err(&dd->pdev->dev,
1725 "Reset bit did not clear.\n");
1733 * Display the identify command data.
1735 * @port Pointer to the port data structure.
1740 static void mtip_dump_identify(struct mtip_port *port)
1743 unsigned short revid;
1746 if (!port->identify_valid)
1749 strlcpy(cbuf, (char *)(port->identify+10), 21);
1750 dev_info(&port->dd->pdev->dev,
1751 "Serial No.: %s\n", cbuf);
1753 strlcpy(cbuf, (char *)(port->identify+23), 9);
1754 dev_info(&port->dd->pdev->dev,
1755 "Firmware Ver.: %s\n", cbuf);
1757 strlcpy(cbuf, (char *)(port->identify+27), 41);
1758 dev_info(&port->dd->pdev->dev, "Model: %s\n", cbuf);
1760 if (mtip_hw_get_capacity(port->dd, §ors))
1761 dev_info(&port->dd->pdev->dev,
1762 "Capacity: %llu sectors (%llu MB)\n",
1764 ((u64)sectors) * ATA_SECT_SIZE >> 20);
1766 pci_read_config_word(port->dd->pdev, PCI_REVISION_ID, &revid);
1767 switch (revid & 0xFF) {
1769 strlcpy(cbuf, "A0", 3);
1772 strlcpy(cbuf, "A2", 3);
1775 strlcpy(cbuf, "?", 2);
1778 dev_info(&port->dd->pdev->dev,
1779 "Card Type: %s\n", cbuf);
1783 * Map the commands scatter list into the command table.
1785 * @command Pointer to the command.
1786 * @nents Number of scatter list entries.
1791 static inline void fill_command_sg(struct driver_data *dd,
1792 struct mtip_cmd *command,
1796 unsigned int dma_len;
1797 struct mtip_cmd_sg *command_sg;
1798 struct scatterlist *sg = command->sg;
1800 command_sg = command->command + AHCI_CMD_TBL_HDR_SZ;
1802 for (n = 0; n < nents; n++) {
1803 dma_len = sg_dma_len(sg);
1804 if (dma_len > 0x400000)
1805 dev_err(&dd->pdev->dev,
1806 "DMA segment length truncated\n");
1807 command_sg->info = __force_bit2int
1808 cpu_to_le32((dma_len-1) & 0x3FFFFF);
1809 command_sg->dba = __force_bit2int
1810 cpu_to_le32(sg_dma_address(sg));
1811 command_sg->dba_upper = __force_bit2int
1812 cpu_to_le32((sg_dma_address(sg) >> 16) >> 16);
1819 * @brief Execute a drive command.
1821 * return value 0 The command completed successfully.
1822 * return value -1 An error occurred while executing the command.
1824 static int exec_drive_task(struct mtip_port *port, u8 *command)
1826 struct host_to_dev_fis fis;
1827 struct host_to_dev_fis *reply = (port->rxfis + RX_FIS_D2H_REG);
1829 /* Build the FIS. */
1830 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1833 fis.command = command[0];
1834 fis.features = command[1];
1835 fis.sect_count = command[2];
1836 fis.sector = command[3];
1837 fis.cyl_low = command[4];
1838 fis.cyl_hi = command[5];
1839 fis.device = command[6] & ~0x10; /* Clear the dev bit*/
1841 dbg_printk(MTIP_DRV_NAME " %s: User Command: cmd %x, feat %x, nsect %x, sect %x, lcyl %x, hcyl %x, sel %x\n",
1851 /* Execute the command. */
1852 if (mtip_exec_internal_command(port,
1859 MTIP_IOCTL_COMMAND_TIMEOUT_MS) < 0) {
1863 command[0] = reply->command; /* Status*/
1864 command[1] = reply->features; /* Error*/
1865 command[4] = reply->cyl_low;
1866 command[5] = reply->cyl_hi;
1868 dbg_printk(MTIP_DRV_NAME " %s: Completion Status: stat %x, err %x , cyl_lo %x cyl_hi %x\n",
1879 * @brief Execute a drive command.
1881 * @param port Pointer to the port data structure.
1882 * @param command Pointer to the user specified command parameters.
1883 * @param user_buffer Pointer to the user space buffer where read sector
1884 * data should be copied.
1886 * return value 0 The command completed successfully.
1887 * return value -EFAULT An error occurred while copying the completion
1888 * data to the user space buffer.
1889 * return value -1 An error occurred while executing the command.
1891 static int exec_drive_command(struct mtip_port *port, u8 *command,
1892 void __user *user_buffer)
1894 struct host_to_dev_fis fis;
1895 struct host_to_dev_fis *reply = (port->rxfis + RX_FIS_D2H_REG);
1897 /* Build the FIS. */
1898 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1901 fis.command = command[0];
1902 fis.features = command[2];
1903 fis.sect_count = command[3];
1904 if (fis.command == ATA_CMD_SMART) {
1905 fis.sector = command[1];
1910 dbg_printk(MTIP_DRV_NAME
1911 " %s: User Command: cmd %x, sect %x, "
1912 "feat %x, sectcnt %x\n",
1919 memset(port->sector_buffer, 0x00, ATA_SECT_SIZE);
1921 /* Execute the command. */
1922 if (mtip_exec_internal_command(port,
1925 port->sector_buffer_dma,
1926 (command[3] != 0) ? ATA_SECT_SIZE : 0,
1929 MTIP_IOCTL_COMMAND_TIMEOUT_MS)
1934 /* Collect the completion status. */
1935 command[0] = reply->command; /* Status*/
1936 command[1] = reply->features; /* Error*/
1937 command[2] = command[3];
1939 dbg_printk(MTIP_DRV_NAME
1940 " %s: Completion Status: stat %x, "
1947 if (user_buffer && command[3]) {
1948 if (copy_to_user(user_buffer,
1949 port->sector_buffer,
1950 ATA_SECT_SIZE * command[3])) {
1959 * Indicates whether a command has a single sector payload.
1961 * @command passed to the device to perform the certain event.
1962 * @features passed to the device to perform the certain event.
1965 * 1 command is one that always has a single sector payload,
1966 * regardless of the value in the Sector Count field.
1970 static unsigned int implicit_sector(unsigned char command,
1971 unsigned char features)
1973 unsigned int rv = 0;
1975 /* list of commands that have an implicit sector count of 1 */
1977 case ATA_CMD_SEC_SET_PASS:
1978 case ATA_CMD_SEC_UNLOCK:
1979 case ATA_CMD_SEC_ERASE_PREP:
1980 case ATA_CMD_SEC_ERASE_UNIT:
1981 case ATA_CMD_SEC_FREEZE_LOCK:
1982 case ATA_CMD_SEC_DISABLE_PASS:
1983 case ATA_CMD_PMP_READ:
1984 case ATA_CMD_PMP_WRITE:
1987 case ATA_CMD_SET_MAX:
1988 if (features == ATA_SET_MAX_UNLOCK)
1992 if ((features == ATA_SMART_READ_VALUES) ||
1993 (features == ATA_SMART_READ_THRESHOLDS))
1996 case ATA_CMD_CONF_OVERLAY:
1997 if ((features == ATA_DCO_IDENTIFY) ||
1998 (features == ATA_DCO_SET))
2005 static void mtip_set_timeout(struct host_to_dev_fis *fis, unsigned int *timeout)
2007 switch (fis->command) {
2008 case ATA_CMD_DOWNLOAD_MICRO:
2009 *timeout = 120000; /* 2 minutes */
2011 case ATA_CMD_SEC_ERASE_UNIT:
2013 *timeout = 240000; /* 4 minutes */
2015 case ATA_CMD_STANDBYNOW1:
2016 *timeout = 10000; /* 10 seconds */
2020 *timeout = 60000; /* 60 seconds */
2023 *timeout = 15000; /* 15 seconds */
2026 *timeout = MTIP_IOCTL_COMMAND_TIMEOUT_MS;
2032 * Executes a taskfile
2033 * See ide_taskfile_ioctl() for derivation
2035 static int exec_drive_taskfile(struct driver_data *dd,
2037 ide_task_request_t *req_task,
2040 struct host_to_dev_fis fis;
2041 struct host_to_dev_fis *reply;
2044 dma_addr_t outbuf_dma = 0;
2045 dma_addr_t inbuf_dma = 0;
2046 dma_addr_t dma_buffer = 0;
2048 unsigned int taskin = 0;
2049 unsigned int taskout = 0;
2051 unsigned int timeout;
2052 unsigned int force_single_sector;
2053 unsigned int transfer_size;
2054 unsigned long task_file_data;
2055 int intotal = outtotal + req_task->out_size;
2057 taskout = req_task->out_size;
2058 taskin = req_task->in_size;
2059 /* 130560 = 512 * 0xFF*/
2060 if (taskin > 130560 || taskout > 130560) {
2066 outbuf = kzalloc(taskout, GFP_KERNEL);
2067 if (outbuf == NULL) {
2071 if (copy_from_user(outbuf, buf + outtotal, taskout)) {
2075 outbuf_dma = pci_map_single(dd->pdev,
2079 if (outbuf_dma == 0) {
2083 dma_buffer = outbuf_dma;
2087 inbuf = kzalloc(taskin, GFP_KERNEL);
2088 if (inbuf == NULL) {
2093 if (copy_from_user(inbuf, buf + intotal, taskin)) {
2097 inbuf_dma = pci_map_single(dd->pdev,
2099 taskin, DMA_FROM_DEVICE);
2100 if (inbuf_dma == 0) {
2104 dma_buffer = inbuf_dma;
2107 /* only supports PIO and non-data commands from this ioctl. */
2108 switch (req_task->data_phase) {
2110 nsect = taskout / ATA_SECT_SIZE;
2111 reply = (dd->port->rxfis + RX_FIS_PIO_SETUP);
2114 reply = (dd->port->rxfis + RX_FIS_PIO_SETUP);
2116 case TASKFILE_NO_DATA:
2117 reply = (dd->port->rxfis + RX_FIS_D2H_REG);
2124 /* Build the FIS. */
2125 memset(&fis, 0, sizeof(struct host_to_dev_fis));
2129 fis.command = req_task->io_ports[7];
2130 fis.features = req_task->io_ports[1];
2131 fis.sect_count = req_task->io_ports[2];
2132 fis.lba_low = req_task->io_ports[3];
2133 fis.lba_mid = req_task->io_ports[4];
2134 fis.lba_hi = req_task->io_ports[5];
2135 /* Clear the dev bit*/
2136 fis.device = req_task->io_ports[6] & ~0x10;
2138 if ((req_task->in_flags.all == 0) && (req_task->out_flags.all & 1)) {
2139 req_task->in_flags.all =
2140 IDE_TASKFILE_STD_IN_FLAGS |
2141 (IDE_HOB_STD_IN_FLAGS << 8);
2142 fis.lba_low_ex = req_task->hob_ports[3];
2143 fis.lba_mid_ex = req_task->hob_ports[4];
2144 fis.lba_hi_ex = req_task->hob_ports[5];
2145 fis.features_ex = req_task->hob_ports[1];
2146 fis.sect_cnt_ex = req_task->hob_ports[2];
2149 req_task->in_flags.all = IDE_TASKFILE_STD_IN_FLAGS;
2152 force_single_sector = implicit_sector(fis.command, fis.features);
2154 if ((taskin || taskout) && (!fis.sect_count)) {
2156 fis.sect_count = nsect;
2158 if (!force_single_sector) {
2159 dev_warn(&dd->pdev->dev,
2160 "data movement but "
2161 "sect_count is 0\n");
2168 dbg_printk(MTIP_DRV_NAME
2169 " %s: cmd %x, feat %x, nsect %x,"
2170 " sect/lbal %x, lcyl/lbam %x, hcyl/lbah %x,"
2181 mtip_set_timeout(&fis, &timeout);
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:
2299 if (copy_to_user((void __user *)arg, dd->port->identify,
2300 sizeof(u16) * ATA_ID_WORDS))
2304 case HDIO_DRIVE_CMD:
2306 u8 drive_command[4];
2308 /* Copy the user command info to our buffer. */
2309 if (copy_from_user(drive_command,
2310 (void __user *) arg,
2311 sizeof(drive_command)))
2314 /* Execute the drive command. */
2315 if (exec_drive_command(dd->port,
2317 (void __user *) (arg+4)))
2320 /* Copy the status back to the users buffer. */
2321 if (copy_to_user((void __user *) arg,
2323 sizeof(drive_command)))
2328 case HDIO_DRIVE_TASK:
2330 u8 drive_command[7];
2332 /* Copy the user command info to our buffer. */
2333 if (copy_from_user(drive_command,
2334 (void __user *) arg,
2335 sizeof(drive_command)))
2338 /* Execute the drive command. */
2339 if (exec_drive_task(dd->port, drive_command))
2342 /* Copy the status back to the users buffer. */
2343 if (copy_to_user((void __user *) arg,
2345 sizeof(drive_command)))
2350 case HDIO_DRIVE_TASKFILE: {
2351 ide_task_request_t req_task;
2354 if (copy_from_user(&req_task, (void __user *) arg,
2358 outtotal = sizeof(req_task);
2360 ret = exec_drive_taskfile(dd, (void __user *) arg,
2361 &req_task, outtotal);
2363 if (copy_to_user((void __user *) arg, &req_task,
2377 * Submit an IO to the hw
2379 * This function is called by the block layer to issue an io
2380 * to the device. Upon completion, the callback function will
2381 * be called with the data parameter passed as the callback data.
2383 * @dd Pointer to the driver data structure.
2384 * @start First sector to read.
2385 * @nsect Number of sectors to read.
2386 * @nents Number of entries in scatter list for the read command.
2387 * @tag The tag of this read command.
2388 * @callback Pointer to the function that should be called
2389 * when the read completes.
2390 * @data Callback data passed to the callback function
2391 * when the read completes.
2392 * @dir Direction (read or write)
2397 static void mtip_hw_submit_io(struct driver_data *dd, sector_t start,
2398 int nsect, int nents, int tag, void *callback,
2399 void *data, int dir)
2401 struct host_to_dev_fis *fis;
2402 struct mtip_port *port = dd->port;
2403 struct mtip_cmd *command = &port->commands[tag];
2404 int dma_dir = (dir == READ) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
2406 /* Map the scatter list for DMA access */
2407 nents = dma_map_sg(&dd->pdev->dev, command->sg, nents, dma_dir);
2409 command->scatter_ents = nents;
2412 * The number of retries for this command before it is
2413 * reported as a failure to the upper layers.
2415 command->retries = MTIP_MAX_RETRIES;
2418 fis = command->command;
2422 (dir == READ ? ATA_CMD_FPDMA_READ : ATA_CMD_FPDMA_WRITE);
2423 *((unsigned int *) &fis->lba_low) = (start & 0xFFFFFF);
2424 *((unsigned int *) &fis->lba_low_ex) = ((start >> 24) & 0xFFFFFF);
2425 fis->device = 1 << 6;
2426 fis->features = nsect & 0xFF;
2427 fis->features_ex = (nsect >> 8) & 0xFF;
2428 fis->sect_count = ((tag << 3) | (tag >> 5));
2429 fis->sect_cnt_ex = 0;
2433 fill_command_sg(dd, command, nents);
2435 /* Populate the command header */
2436 command->command_header->opts =
2437 __force_bit2int cpu_to_le32(
2438 (nents << 16) | 5 | AHCI_CMD_PREFETCH);
2439 command->command_header->byte_count = 0;
2442 * Set the completion function and data for the command
2443 * within this layer.
2445 command->comp_data = dd;
2446 command->comp_func = mtip_async_complete;
2447 command->direction = dma_dir;
2450 * Set the completion function and data for the command passed
2451 * from the upper layer.
2453 command->async_data = data;
2454 command->async_callback = callback;
2457 * To prevent this command from being issued
2458 * if an internal command is in progress or error handling is active.
2460 if (port->flags & MTIP_PF_PAUSE_IO) {
2461 set_bit(tag, port->cmds_to_issue);
2462 set_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags);
2466 /* Issue the command to the hardware */
2467 mtip_issue_ncq_command(port, tag);
2473 * Release a command slot.
2475 * @dd Pointer to the driver data structure.
2481 static void mtip_hw_release_scatterlist(struct driver_data *dd, int tag)
2483 release_slot(dd->port, tag);
2487 * Obtain a command slot and return its associated scatter list.
2489 * @dd Pointer to the driver data structure.
2490 * @tag Pointer to an int that will receive the allocated command
2494 * Pointer to the scatter list for the allocated command slot
2495 * or NULL if no command slots are available.
2497 static struct scatterlist *mtip_hw_get_scatterlist(struct driver_data *dd,
2501 * It is possible that, even with this semaphore, a thread
2502 * may think that no command slots are available. Therefore, we
2503 * need to make an attempt to get_slot().
2505 down(&dd->port->cmd_slot);
2506 *tag = get_slot(dd->port);
2508 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))) {
2509 up(&dd->port->cmd_slot);
2512 if (unlikely(*tag < 0)) {
2513 up(&dd->port->cmd_slot);
2517 return dd->port->commands[*tag].sg;
2521 * Sysfs register/status dump.
2523 * @dev Pointer to the device structure, passed by the kernrel.
2524 * @attr Pointer to the device_attribute structure passed by the kernel.
2525 * @buf Pointer to the char buffer that will receive the stats info.
2528 * The size, in bytes, of the data copied into buf.
2530 static ssize_t mtip_hw_show_registers(struct device *dev,
2531 struct device_attribute *attr,
2534 u32 group_allocated;
2535 struct driver_data *dd = dev_to_disk(dev)->private_data;
2539 size += sprintf(&buf[size], "S ACTive:\n");
2541 for (n = 0; n < dd->slot_groups; n++)
2542 size += sprintf(&buf[size], "0x%08x\n",
2543 readl(dd->port->s_active[n]));
2545 size += sprintf(&buf[size], "Command Issue:\n");
2547 for (n = 0; n < dd->slot_groups; n++)
2548 size += sprintf(&buf[size], "0x%08x\n",
2549 readl(dd->port->cmd_issue[n]));
2551 size += sprintf(&buf[size], "Allocated:\n");
2553 for (n = 0; n < dd->slot_groups; n++) {
2554 if (sizeof(long) > sizeof(u32))
2556 dd->port->allocated[n/2] >> (32*(n&1));
2558 group_allocated = dd->port->allocated[n];
2559 size += sprintf(&buf[size], "0x%08x\n",
2563 size += sprintf(&buf[size], "Completed:\n");
2565 for (n = 0; n < dd->slot_groups; n++)
2566 size += sprintf(&buf[size], "0x%08x\n",
2567 readl(dd->port->completed[n]));
2569 size += sprintf(&buf[size], "PORT IRQ STAT : 0x%08x\n",
2570 readl(dd->port->mmio + PORT_IRQ_STAT));
2571 size += sprintf(&buf[size], "HOST IRQ STAT : 0x%08x\n",
2572 readl(dd->mmio + HOST_IRQ_STAT));
2577 static ssize_t mtip_hw_show_status(struct device *dev,
2578 struct device_attribute *attr,
2581 struct driver_data *dd = dev_to_disk(dev)->private_data;
2584 if (test_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag))
2585 size += sprintf(buf, "%s", "thermal_shutdown\n");
2586 else if (test_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag))
2587 size += sprintf(buf, "%s", "write_protect\n");
2589 size += sprintf(buf, "%s", "online\n");
2594 static DEVICE_ATTR(registers, S_IRUGO, mtip_hw_show_registers, NULL);
2595 static DEVICE_ATTR(status, S_IRUGO, mtip_hw_show_status, NULL);
2598 * Create the sysfs related attributes.
2600 * @dd Pointer to the driver data structure.
2601 * @kobj Pointer to the kobj for the block device.
2604 * 0 Operation completed successfully.
2605 * -EINVAL Invalid parameter.
2607 static int mtip_hw_sysfs_init(struct driver_data *dd, struct kobject *kobj)
2612 if (sysfs_create_file(kobj, &dev_attr_registers.attr))
2613 dev_warn(&dd->pdev->dev,
2614 "Error creating 'registers' sysfs entry\n");
2615 if (sysfs_create_file(kobj, &dev_attr_status.attr))
2616 dev_warn(&dd->pdev->dev,
2617 "Error creating 'status' sysfs entry\n");
2622 * Remove the sysfs related attributes.
2624 * @dd Pointer to the driver data structure.
2625 * @kobj Pointer to the kobj for the block device.
2628 * 0 Operation completed successfully.
2629 * -EINVAL Invalid parameter.
2631 static int mtip_hw_sysfs_exit(struct driver_data *dd, struct kobject *kobj)
2636 sysfs_remove_file(kobj, &dev_attr_registers.attr);
2637 sysfs_remove_file(kobj, &dev_attr_status.attr);
2643 * Perform any init/resume time hardware setup
2645 * @dd Pointer to the driver data structure.
2650 static inline void hba_setup(struct driver_data *dd)
2653 hwdata = readl(dd->mmio + HOST_HSORG);
2655 /* interrupt bug workaround: use only 1 IS bit.*/
2657 HSORG_DISABLE_SLOTGRP_INTR |
2658 HSORG_DISABLE_SLOTGRP_PXIS,
2659 dd->mmio + HOST_HSORG);
2663 * Detect the details of the product, and store anything needed
2664 * into the driver data structure. This includes product type and
2665 * version and number of slot groups.
2667 * @dd Pointer to the driver data structure.
2672 static void mtip_detect_product(struct driver_data *dd)
2675 unsigned int rev, slotgroups;
2678 * HBA base + 0xFC [15:0] - vendor-specific hardware interface
2680 * [15:8] hardware/software interface rev#
2681 * [ 3] asic-style interface
2682 * [ 2:0] number of slot groups, minus 1 (only valid for asic-style).
2684 hwdata = readl(dd->mmio + HOST_HSORG);
2686 dd->product_type = MTIP_PRODUCT_UNKNOWN;
2687 dd->slot_groups = 1;
2690 dd->product_type = MTIP_PRODUCT_ASICFPGA;
2691 rev = (hwdata & HSORG_HWREV) >> 8;
2692 slotgroups = (hwdata & HSORG_SLOTGROUPS) + 1;
2693 dev_info(&dd->pdev->dev,
2694 "ASIC-FPGA design, HS rev 0x%x, "
2695 "%i slot groups [%i slots]\n",
2700 if (slotgroups > MTIP_MAX_SLOT_GROUPS) {
2701 dev_warn(&dd->pdev->dev,
2702 "Warning: driver only supports "
2703 "%i slot groups.\n", MTIP_MAX_SLOT_GROUPS);
2704 slotgroups = MTIP_MAX_SLOT_GROUPS;
2706 dd->slot_groups = slotgroups;
2710 dev_warn(&dd->pdev->dev, "Unrecognized product id\n");
2714 * Blocking wait for FTL rebuild to complete
2716 * @dd Pointer to the DRIVER_DATA structure.
2719 * 0 FTL rebuild completed successfully
2720 * -EFAULT FTL rebuild error/timeout/interruption
2722 static int mtip_ftl_rebuild_poll(struct driver_data *dd)
2724 unsigned long timeout, cnt = 0, start;
2726 dev_warn(&dd->pdev->dev,
2727 "FTL rebuild in progress. Polling for completion.\n");
2730 timeout = jiffies + msecs_to_jiffies(MTIP_FTL_REBUILD_TIMEOUT_MS);
2733 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
2736 if (mtip_check_surprise_removal(dd->pdev))
2739 if (mtip_get_identify(dd->port, NULL) < 0)
2742 if (*(dd->port->identify + MTIP_FTL_REBUILD_OFFSET) ==
2743 MTIP_FTL_REBUILD_MAGIC) {
2745 /* Print message every 3 minutes */
2747 dev_warn(&dd->pdev->dev,
2748 "FTL rebuild in progress (%d secs).\n",
2749 jiffies_to_msecs(jiffies - start) / 1000);
2753 dev_warn(&dd->pdev->dev,
2754 "FTL rebuild complete (%d secs).\n",
2755 jiffies_to_msecs(jiffies - start) / 1000);
2756 mtip_block_initialize(dd);
2760 } while (time_before(jiffies, timeout));
2762 /* Check for timeout */
2763 dev_err(&dd->pdev->dev,
2764 "Timed out waiting for FTL rebuild to complete (%d secs).\n",
2765 jiffies_to_msecs(jiffies - start) / 1000);
2770 * service thread to issue queued commands
2772 * @data Pointer to the driver data structure.
2778 static int mtip_service_thread(void *data)
2780 struct driver_data *dd = (struct driver_data *)data;
2781 unsigned long slot, slot_start, slot_wrap;
2782 unsigned int num_cmd_slots = dd->slot_groups * 32;
2783 struct mtip_port *port = dd->port;
2787 * the condition is to check neither an internal command is
2788 * is in progress nor error handling is active
2790 wait_event_interruptible(port->svc_wait, (port->flags) &&
2791 !(port->flags & MTIP_PF_PAUSE_IO));
2793 if (kthread_should_stop())
2796 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
2800 set_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags);
2801 if (test_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags)) {
2803 /* used to restrict the loop to one iteration */
2804 slot_start = num_cmd_slots;
2807 slot = find_next_bit(port->cmds_to_issue,
2808 num_cmd_slots, slot);
2809 if (slot_wrap == 1) {
2810 if ((slot_start >= slot) ||
2811 (slot >= num_cmd_slots))
2814 if (unlikely(slot_start == num_cmd_slots))
2817 if (unlikely(slot == num_cmd_slots)) {
2823 /* Issue the command to the hardware */
2824 mtip_issue_ncq_command(port, slot);
2826 clear_bit(slot, port->cmds_to_issue);
2829 clear_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags);
2830 } else if (test_bit(MTIP_PF_REBUILD_BIT, &port->flags)) {
2831 if (!mtip_ftl_rebuild_poll(dd))
2832 set_bit(MTIP_DDF_REBUILD_FAILED_BIT,
2834 clear_bit(MTIP_PF_REBUILD_BIT, &port->flags);
2836 clear_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags);
2838 if (test_bit(MTIP_PF_SVC_THD_STOP_BIT, &port->flags))
2845 * Called once for each card.
2847 * @dd Pointer to the driver data structure.
2850 * 0 on success, else an error code.
2852 static int mtip_hw_init(struct driver_data *dd)
2856 unsigned int num_command_slots;
2857 unsigned long timeout, timetaken;
2859 struct smart_attr attr242;
2861 dd->mmio = pcim_iomap_table(dd->pdev)[MTIP_ABAR];
2863 mtip_detect_product(dd);
2864 if (dd->product_type == MTIP_PRODUCT_UNKNOWN) {
2868 num_command_slots = dd->slot_groups * 32;
2872 tasklet_init(&dd->tasklet, mtip_tasklet, (unsigned long)dd);
2874 dd->port = kzalloc(sizeof(struct mtip_port), GFP_KERNEL);
2876 dev_err(&dd->pdev->dev,
2877 "Memory allocation: port structure\n");
2881 /* Counting semaphore to track command slot usage */
2882 sema_init(&dd->port->cmd_slot, num_command_slots - 1);
2884 /* Spinlock to prevent concurrent issue */
2885 spin_lock_init(&dd->port->cmd_issue_lock);
2887 /* Set the port mmio base address. */
2888 dd->port->mmio = dd->mmio + PORT_OFFSET;
2891 /* Allocate memory for the command list. */
2892 dd->port->command_list =
2893 dmam_alloc_coherent(&dd->pdev->dev,
2894 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
2895 &dd->port->command_list_dma,
2897 if (!dd->port->command_list) {
2898 dev_err(&dd->pdev->dev,
2899 "Memory allocation: command list\n");
2904 /* Clear the memory we have allocated. */
2905 memset(dd->port->command_list,
2907 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4));
2909 /* Setup the addresse of the RX FIS. */
2910 dd->port->rxfis = dd->port->command_list + HW_CMD_SLOT_SZ;
2911 dd->port->rxfis_dma = dd->port->command_list_dma + HW_CMD_SLOT_SZ;
2913 /* Setup the address of the command tables. */
2914 dd->port->command_table = dd->port->rxfis + AHCI_RX_FIS_SZ;
2915 dd->port->command_tbl_dma = dd->port->rxfis_dma + AHCI_RX_FIS_SZ;
2917 /* Setup the address of the identify data. */
2918 dd->port->identify = dd->port->command_table +
2920 dd->port->identify_dma = dd->port->command_tbl_dma +
2923 /* Setup the address of the sector buffer - for some non-ncq cmds */
2924 dd->port->sector_buffer = (void *) dd->port->identify + ATA_SECT_SIZE;
2925 dd->port->sector_buffer_dma = dd->port->identify_dma + ATA_SECT_SIZE;
2927 /* Setup the address of the log buf - for read log command */
2928 dd->port->log_buf = (void *)dd->port->sector_buffer + ATA_SECT_SIZE;
2929 dd->port->log_buf_dma = dd->port->sector_buffer_dma + ATA_SECT_SIZE;
2931 /* Setup the address of the smart buf - for smart read data command */
2932 dd->port->smart_buf = (void *)dd->port->log_buf + ATA_SECT_SIZE;
2933 dd->port->smart_buf_dma = dd->port->log_buf_dma + ATA_SECT_SIZE;
2936 /* Point the command headers at the command tables. */
2937 for (i = 0; i < num_command_slots; i++) {
2938 dd->port->commands[i].command_header =
2939 dd->port->command_list +
2940 (sizeof(struct mtip_cmd_hdr) * i);
2941 dd->port->commands[i].command_header_dma =
2942 dd->port->command_list_dma +
2943 (sizeof(struct mtip_cmd_hdr) * i);
2945 dd->port->commands[i].command =
2946 dd->port->command_table + (HW_CMD_TBL_SZ * i);
2947 dd->port->commands[i].command_dma =
2948 dd->port->command_tbl_dma + (HW_CMD_TBL_SZ * i);
2950 if (readl(dd->mmio + HOST_CAP) & HOST_CAP_64)
2951 dd->port->commands[i].command_header->ctbau =
2952 __force_bit2int cpu_to_le32(
2953 (dd->port->commands[i].command_dma >> 16) >> 16);
2954 dd->port->commands[i].command_header->ctba =
2955 __force_bit2int cpu_to_le32(
2956 dd->port->commands[i].command_dma & 0xFFFFFFFF);
2959 * If this is not done, a bug is reported by the stock
2960 * FC11 i386. Due to the fact that it has lots of kernel
2961 * debugging enabled.
2963 sg_init_table(dd->port->commands[i].sg, MTIP_MAX_SG);
2965 /* Mark all commands as currently inactive.*/
2966 atomic_set(&dd->port->commands[i].active, 0);
2969 /* Setup the pointers to the extended s_active and CI registers. */
2970 for (i = 0; i < dd->slot_groups; i++) {
2971 dd->port->s_active[i] =
2972 dd->port->mmio + i*0x80 + PORT_SCR_ACT;
2973 dd->port->cmd_issue[i] =
2974 dd->port->mmio + i*0x80 + PORT_COMMAND_ISSUE;
2975 dd->port->completed[i] =
2976 dd->port->mmio + i*0x80 + PORT_SDBV;
2979 timetaken = jiffies;
2980 timeout = jiffies + msecs_to_jiffies(30000);
2981 while (((readl(dd->port->mmio + PORT_SCR_STAT) & 0x0F) != 0x03) &&
2982 time_before(jiffies, timeout)) {
2985 if (unlikely(mtip_check_surprise_removal(dd->pdev))) {
2986 timetaken = jiffies - timetaken;
2987 dev_warn(&dd->pdev->dev,
2988 "Surprise removal detected at %u ms\n",
2989 jiffies_to_msecs(timetaken));
2993 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))) {
2994 timetaken = jiffies - timetaken;
2995 dev_warn(&dd->pdev->dev,
2996 "Removal detected at %u ms\n",
2997 jiffies_to_msecs(timetaken));
3002 /* Conditionally reset the HBA. */
3003 if (!(readl(dd->mmio + HOST_CAP) & HOST_CAP_NZDMA)) {
3004 if (mtip_hba_reset(dd) < 0) {
3005 dev_err(&dd->pdev->dev,
3006 "Card did not reset within timeout\n");
3011 /* Clear any pending interrupts on the HBA */
3012 writel(readl(dd->mmio + HOST_IRQ_STAT),
3013 dd->mmio + HOST_IRQ_STAT);
3016 mtip_init_port(dd->port);
3017 mtip_start_port(dd->port);
3019 /* Setup the ISR and enable interrupts. */
3020 rv = devm_request_irq(&dd->pdev->dev,
3024 dev_driver_string(&dd->pdev->dev),
3028 dev_err(&dd->pdev->dev,
3029 "Unable to allocate IRQ %d\n", dd->pdev->irq);
3033 /* Enable interrupts on the HBA. */
3034 writel(readl(dd->mmio + HOST_CTL) | HOST_IRQ_EN,
3035 dd->mmio + HOST_CTL);
3037 init_timer(&dd->port->cmd_timer);
3038 init_waitqueue_head(&dd->port->svc_wait);
3040 dd->port->cmd_timer.data = (unsigned long int) dd->port;
3041 dd->port->cmd_timer.function = mtip_timeout_function;
3042 mod_timer(&dd->port->cmd_timer,
3043 jiffies + msecs_to_jiffies(MTIP_TIMEOUT_CHECK_PERIOD));
3046 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)) {
3051 if (mtip_get_identify(dd->port, NULL) < 0) {
3056 if (*(dd->port->identify + MTIP_FTL_REBUILD_OFFSET) ==
3057 MTIP_FTL_REBUILD_MAGIC) {
3058 set_bit(MTIP_PF_REBUILD_BIT, &dd->port->flags);
3059 return MTIP_FTL_REBUILD_MAGIC;
3061 mtip_dump_identify(dd->port);
3063 /* check write protect, over temp and rebuild statuses */
3064 rv = mtip_read_log_page(dd->port, ATA_LOG_SATA_NCQ,
3066 dd->port->log_buf_dma, 1);
3068 dev_warn(&dd->pdev->dev,
3069 "Error in READ LOG EXT (10h) command\n");
3070 /* non-critical error, don't fail the load */
3072 buf = (unsigned char *)dd->port->log_buf;
3073 if (buf[259] & 0x1) {
3074 dev_info(&dd->pdev->dev,
3075 "Write protect bit is set.\n");
3076 set_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag);
3078 if (buf[288] == 0xF7) {
3079 dev_info(&dd->pdev->dev,
3080 "Exceeded Tmax, drive in thermal shutdown.\n");
3081 set_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag);
3083 if (buf[288] == 0xBF) {
3084 dev_info(&dd->pdev->dev,
3085 "Drive indicates rebuild has failed.\n");
3090 /* get write protect progess */
3091 memset(&attr242, 0, sizeof(struct smart_attr));
3092 if (mtip_get_smart_attr(dd->port, 242, &attr242))
3093 dev_warn(&dd->pdev->dev,
3094 "Unable to check write protect progress\n");
3096 dev_info(&dd->pdev->dev,
3097 "Write protect progress: %d%% (%d blocks)\n",
3098 attr242.cur, attr242.data);
3102 del_timer_sync(&dd->port->cmd_timer);
3104 /* Disable interrupts on the HBA. */
3105 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3106 dd->mmio + HOST_CTL);
3108 /*Release the IRQ. */
3109 devm_free_irq(&dd->pdev->dev, dd->pdev->irq, dd);
3112 mtip_deinit_port(dd->port);
3114 /* Free the command/command header memory. */
3115 dmam_free_coherent(&dd->pdev->dev,
3116 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
3117 dd->port->command_list,
3118 dd->port->command_list_dma);
3120 /* Free the memory allocated for the for structure. */
3127 * Called to deinitialize an interface.
3129 * @dd Pointer to the driver data structure.
3134 static int mtip_hw_exit(struct driver_data *dd)
3137 * Send standby immediate (E0h) to the drive so that it
3140 if (!test_bit(MTIP_DDF_CLEANUP_BIT, &dd->dd_flag)) {
3142 if (!test_bit(MTIP_PF_REBUILD_BIT, &dd->port->flags))
3143 if (mtip_standby_immediate(dd->port))
3144 dev_warn(&dd->pdev->dev,
3145 "STANDBY IMMEDIATE failed\n");
3147 /* de-initialize the port. */
3148 mtip_deinit_port(dd->port);
3150 /* Disable interrupts on the HBA. */
3151 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3152 dd->mmio + HOST_CTL);
3155 del_timer_sync(&dd->port->cmd_timer);
3157 /* Release the IRQ. */
3158 devm_free_irq(&dd->pdev->dev, dd->pdev->irq, dd);
3160 /* Stop the bottom half tasklet. */
3161 tasklet_kill(&dd->tasklet);
3163 /* Free the command/command header memory. */
3164 dmam_free_coherent(&dd->pdev->dev,
3165 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
3166 dd->port->command_list,
3167 dd->port->command_list_dma);
3168 /* Free the memory allocated for the for structure. */
3175 * Issue a Standby Immediate command to the device.
3177 * This function is called by the Block Layer just before the
3178 * system powers off during a shutdown.
3180 * @dd Pointer to the driver data structure.
3185 static int mtip_hw_shutdown(struct driver_data *dd)
3188 * Send standby immediate (E0h) to the drive so that it
3191 mtip_standby_immediate(dd->port);
3199 * This function is called by the Block Layer just before the
3200 * system hibernates.
3202 * @dd Pointer to the driver data structure.
3205 * 0 Suspend was successful
3206 * -EFAULT Suspend was not successful
3208 static int mtip_hw_suspend(struct driver_data *dd)
3211 * Send standby immediate (E0h) to the drive
3212 * so that it saves its state.
3214 if (mtip_standby_immediate(dd->port) != 0) {
3215 dev_err(&dd->pdev->dev,
3216 "Failed standby-immediate command\n");
3220 /* Disable interrupts on the HBA.*/
3221 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3222 dd->mmio + HOST_CTL);
3223 mtip_deinit_port(dd->port);
3231 * This function is called by the Block Layer as the
3234 * @dd Pointer to the driver data structure.
3237 * 0 Resume was successful
3238 * -EFAULT Resume was not successful
3240 static int mtip_hw_resume(struct driver_data *dd)
3242 /* Perform any needed hardware setup steps */
3246 if (mtip_hba_reset(dd) != 0) {
3247 dev_err(&dd->pdev->dev,
3248 "Unable to reset the HBA\n");
3253 * Enable the port, DMA engine, and FIS reception specific
3254 * h/w in controller.
3256 mtip_init_port(dd->port);
3257 mtip_start_port(dd->port);
3259 /* Enable interrupts on the HBA.*/
3260 writel(readl(dd->mmio + HOST_CTL) | HOST_IRQ_EN,
3261 dd->mmio + HOST_CTL);
3267 * Helper function for reusing disk name
3268 * upon hot insertion.
3270 static int rssd_disk_name_format(char *prefix,
3275 const int base = 'z' - 'a' + 1;
3276 char *begin = buf + strlen(prefix);
3277 char *end = buf + buflen;
3287 *--p = 'a' + (index % unit);
3288 index = (index / unit) - 1;
3289 } while (index >= 0);
3291 memmove(begin, p, end - p);
3292 memcpy(buf, prefix, strlen(prefix));
3298 * Block layer IOCTL handler.
3300 * @dev Pointer to the block_device structure.
3302 * @cmd IOCTL command passed from the user application.
3303 * @arg Argument passed from the user application.
3306 * 0 IOCTL completed successfully.
3307 * -ENOTTY IOCTL not supported or invalid driver data
3308 * structure pointer.
3310 static int mtip_block_ioctl(struct block_device *dev,
3315 struct driver_data *dd = dev->bd_disk->private_data;
3317 if (!capable(CAP_SYS_ADMIN))
3323 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)))
3330 return mtip_hw_ioctl(dd, cmd, arg);
3334 #ifdef CONFIG_COMPAT
3336 * Block layer compat IOCTL handler.
3338 * @dev Pointer to the block_device structure.
3340 * @cmd IOCTL command passed from the user application.
3341 * @arg Argument passed from the user application.
3344 * 0 IOCTL completed successfully.
3345 * -ENOTTY IOCTL not supported or invalid driver data
3346 * structure pointer.
3348 static int mtip_block_compat_ioctl(struct block_device *dev,
3353 struct driver_data *dd = dev->bd_disk->private_data;
3355 if (!capable(CAP_SYS_ADMIN))
3361 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)))
3367 case HDIO_DRIVE_TASKFILE: {
3368 struct mtip_compat_ide_task_request_s __user *compat_req_task;
3369 ide_task_request_t req_task;
3370 int compat_tasksize, outtotal, ret;
3373 sizeof(struct mtip_compat_ide_task_request_s);
3376 (struct mtip_compat_ide_task_request_s __user *) arg;
3378 if (copy_from_user(&req_task, (void __user *) arg,
3379 compat_tasksize - (2 * sizeof(compat_long_t))))
3382 if (get_user(req_task.out_size, &compat_req_task->out_size))
3385 if (get_user(req_task.in_size, &compat_req_task->in_size))
3388 outtotal = sizeof(struct mtip_compat_ide_task_request_s);
3390 ret = exec_drive_taskfile(dd, (void __user *) arg,
3391 &req_task, outtotal);
3393 if (copy_to_user((void __user *) arg, &req_task,
3395 (2 * sizeof(compat_long_t))))
3398 if (put_user(req_task.out_size, &compat_req_task->out_size))
3401 if (put_user(req_task.in_size, &compat_req_task->in_size))
3407 return mtip_hw_ioctl(dd, cmd, arg);
3413 * Obtain the geometry of the device.
3415 * You may think that this function is obsolete, but some applications,
3416 * fdisk for example still used CHS values. This function describes the
3417 * device as having 224 heads and 56 sectors per cylinder. These values are
3418 * chosen so that each cylinder is aligned on a 4KB boundary. Since a
3419 * partition is described in terms of a start and end cylinder this means
3420 * that each partition is also 4KB aligned. Non-aligned partitions adversely
3421 * affects performance.
3423 * @dev Pointer to the block_device strucutre.
3424 * @geo Pointer to a hd_geometry structure.
3427 * 0 Operation completed successfully.
3428 * -ENOTTY An error occurred while reading the drive capacity.
3430 static int mtip_block_getgeo(struct block_device *dev,
3431 struct hd_geometry *geo)
3433 struct driver_data *dd = dev->bd_disk->private_data;
3439 if (!(mtip_hw_get_capacity(dd, &capacity))) {
3440 dev_warn(&dd->pdev->dev,
3441 "Could not get drive capacity.\n");
3447 sector_div(capacity, (geo->heads * geo->sectors));
3448 geo->cylinders = capacity;
3453 * Block device operation function.
3455 * This structure contains pointers to the functions required by the block
3458 static const struct block_device_operations mtip_block_ops = {
3459 .ioctl = mtip_block_ioctl,
3460 #ifdef CONFIG_COMPAT
3461 .compat_ioctl = mtip_block_compat_ioctl,
3463 .getgeo = mtip_block_getgeo,
3464 .owner = THIS_MODULE
3468 * Block layer make request function.
3470 * This function is called by the kernel to process a BIO for
3473 * @queue Pointer to the request queue. Unused other than to obtain
3474 * the driver data structure.
3475 * @bio Pointer to the BIO.
3478 static void mtip_make_request(struct request_queue *queue, struct bio *bio)
3480 struct driver_data *dd = queue->queuedata;
3481 struct scatterlist *sg;
3482 struct bio_vec *bvec;
3486 if (unlikely(dd->dd_flag & MTIP_DDF_STOP_IO)) {
3487 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
3489 bio_endio(bio, -ENXIO);
3492 if (unlikely(test_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag))) {
3493 bio_endio(bio, -ENODATA);
3496 if (unlikely(test_bit(MTIP_DDF_WRITE_PROTECT_BIT,
3498 bio_data_dir(bio))) {
3499 bio_endio(bio, -ENODATA);
3504 if (unlikely(!bio_has_data(bio))) {
3505 blk_queue_flush(queue, 0);
3510 sg = mtip_hw_get_scatterlist(dd, &tag);
3511 if (likely(sg != NULL)) {
3512 blk_queue_bounce(queue, &bio);
3514 if (unlikely((bio)->bi_vcnt > MTIP_MAX_SG)) {
3515 dev_warn(&dd->pdev->dev,
3516 "Maximum number of SGL entries exceeded\n");
3518 mtip_hw_release_scatterlist(dd, tag);
3522 /* Create the scatter list for this bio. */
3523 bio_for_each_segment(bvec, bio, nents) {
3524 sg_set_page(&sg[nents],
3530 /* Issue the read/write. */
3531 mtip_hw_submit_io(dd,
3544 * Block layer initialization function.
3546 * This function is called once by the PCI layer for each P320
3547 * device that is connected to the system.
3549 * @dd Pointer to the driver data structure.
3552 * 0 on success else an error code.
3554 static int mtip_block_initialize(struct driver_data *dd)
3556 int rv = 0, wait_for_rebuild = 0;
3558 unsigned int index = 0;
3559 struct kobject *kobj;
3560 unsigned char thd_name[16];
3563 goto skip_create_disk; /* hw init done, before rebuild */
3565 /* Initialize the protocol layer. */
3566 wait_for_rebuild = mtip_hw_init(dd);
3567 if (wait_for_rebuild < 0) {
3568 dev_err(&dd->pdev->dev,
3569 "Protocol layer initialization failed\n");
3571 goto protocol_init_error;
3574 dd->disk = alloc_disk(MTIP_MAX_MINORS);
3575 if (dd->disk == NULL) {
3576 dev_err(&dd->pdev->dev,
3577 "Unable to allocate gendisk structure\n");
3579 goto alloc_disk_error;
3582 /* Generate the disk name, implemented same as in sd.c */
3584 if (!ida_pre_get(&rssd_index_ida, GFP_KERNEL))
3587 spin_lock(&rssd_index_lock);
3588 rv = ida_get_new(&rssd_index_ida, &index);
3589 spin_unlock(&rssd_index_lock);
3590 } while (rv == -EAGAIN);
3595 rv = rssd_disk_name_format("rssd",
3597 dd->disk->disk_name,
3600 goto disk_index_error;
3602 dd->disk->driverfs_dev = &dd->pdev->dev;
3603 dd->disk->major = dd->major;
3604 dd->disk->first_minor = dd->instance * MTIP_MAX_MINORS;
3605 dd->disk->fops = &mtip_block_ops;
3606 dd->disk->private_data = dd;
3610 * if rebuild pending, start the service thread, and delay the block
3611 * queue creation and add_disk()
3613 if (wait_for_rebuild == MTIP_FTL_REBUILD_MAGIC)
3614 goto start_service_thread;
3617 /* Allocate the request queue. */
3618 dd->queue = blk_alloc_queue(GFP_KERNEL);
3619 if (dd->queue == NULL) {
3620 dev_err(&dd->pdev->dev,
3621 "Unable to allocate request queue\n");
3623 goto block_queue_alloc_init_error;
3626 /* Attach our request function to the request queue. */
3627 blk_queue_make_request(dd->queue, mtip_make_request);
3629 dd->disk->queue = dd->queue;
3630 dd->queue->queuedata = dd;
3632 /* Set device limits. */
3633 set_bit(QUEUE_FLAG_NONROT, &dd->queue->queue_flags);
3634 blk_queue_max_segments(dd->queue, MTIP_MAX_SG);
3635 blk_queue_physical_block_size(dd->queue, 4096);
3636 blk_queue_max_hw_sectors(dd->queue, 0xffff);
3637 blk_queue_max_segment_size(dd->queue, 0x400000);
3638 blk_queue_io_min(dd->queue, 4096);
3641 * write back cache is not supported in the device. FUA depends on
3642 * write back cache support, hence setting flush support to zero.
3644 blk_queue_flush(dd->queue, 0);
3646 /* Set the capacity of the device in 512 byte sectors. */
3647 if (!(mtip_hw_get_capacity(dd, &capacity))) {
3648 dev_warn(&dd->pdev->dev,
3649 "Could not read drive capacity\n");
3651 goto read_capacity_error;
3653 set_capacity(dd->disk, capacity);
3655 /* Enable the block device and add it to /dev */
3659 * Now that the disk is active, initialize any sysfs attributes
3660 * managed by the protocol layer.
3662 kobj = kobject_get(&disk_to_dev(dd->disk)->kobj);
3664 mtip_hw_sysfs_init(dd, kobj);
3668 if (dd->mtip_svc_handler) {
3669 set_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag);
3670 return rv; /* service thread created for handling rebuild */
3673 start_service_thread:
3674 sprintf(thd_name, "mtip_svc_thd_%02d", index);
3676 dd->mtip_svc_handler = kthread_run(mtip_service_thread,
3679 if (IS_ERR(dd->mtip_svc_handler)) {
3680 dev_err(&dd->pdev->dev, "service thread failed to start\n");
3681 dd->mtip_svc_handler = NULL;
3683 goto kthread_run_error;
3686 if (wait_for_rebuild == MTIP_FTL_REBUILD_MAGIC)
3687 rv = wait_for_rebuild;
3692 /* Delete our gendisk. This also removes the device from /dev */
3693 del_gendisk(dd->disk);
3695 read_capacity_error:
3696 blk_cleanup_queue(dd->queue);
3698 block_queue_alloc_init_error:
3700 spin_lock(&rssd_index_lock);
3701 ida_remove(&rssd_index_ida, index);
3702 spin_unlock(&rssd_index_lock);
3708 mtip_hw_exit(dd); /* De-initialize the protocol layer. */
3710 protocol_init_error:
3715 * Block layer deinitialization function.
3717 * Called by the PCI layer as each P320 device is removed.
3719 * @dd Pointer to the driver data structure.
3724 static int mtip_block_remove(struct driver_data *dd)
3726 struct kobject *kobj;
3728 if (dd->mtip_svc_handler) {
3729 set_bit(MTIP_PF_SVC_THD_STOP_BIT, &dd->port->flags);
3730 wake_up_interruptible(&dd->port->svc_wait);
3731 kthread_stop(dd->mtip_svc_handler);
3734 /* Clean up the sysfs attributes, if created */
3735 if (test_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag)) {
3736 kobj = kobject_get(&disk_to_dev(dd->disk)->kobj);
3738 mtip_hw_sysfs_exit(dd, kobj);
3744 * Delete our gendisk structure. This also removes the device
3747 del_gendisk(dd->disk);
3749 spin_lock(&rssd_index_lock);
3750 ida_remove(&rssd_index_ida, dd->index);
3751 spin_unlock(&rssd_index_lock);
3753 blk_cleanup_queue(dd->queue);
3757 /* De-initialize the protocol layer. */
3764 * Function called by the PCI layer when just before the
3765 * machine shuts down.
3767 * If a protocol layer shutdown function is present it will be called
3770 * @dd Pointer to the driver data structure.
3775 static int mtip_block_shutdown(struct driver_data *dd)
3777 dev_info(&dd->pdev->dev,
3778 "Shutting down %s ...\n", dd->disk->disk_name);
3780 /* Delete our gendisk structure, and cleanup the blk queue. */
3781 del_gendisk(dd->disk);
3783 spin_lock(&rssd_index_lock);
3784 ida_remove(&rssd_index_ida, dd->index);
3785 spin_unlock(&rssd_index_lock);
3787 blk_cleanup_queue(dd->queue);
3791 mtip_hw_shutdown(dd);
3795 static int mtip_block_suspend(struct driver_data *dd)
3797 dev_info(&dd->pdev->dev,
3798 "Suspending %s ...\n", dd->disk->disk_name);
3799 mtip_hw_suspend(dd);
3803 static int mtip_block_resume(struct driver_data *dd)
3805 dev_info(&dd->pdev->dev, "Resuming %s ...\n",
3806 dd->disk->disk_name);
3812 * Called for each supported PCI device detected.
3814 * This function allocates the private data structure, enables the
3815 * PCI device and then calls the block layer initialization function.
3818 * 0 on success else an error code.
3820 static int mtip_pci_probe(struct pci_dev *pdev,
3821 const struct pci_device_id *ent)
3824 struct driver_data *dd = NULL;
3826 /* Allocate memory for this devices private data. */
3827 dd = kzalloc(sizeof(struct driver_data), GFP_KERNEL);
3830 "Unable to allocate memory for driver data\n");
3834 /* Attach the private data to this PCI device. */
3835 pci_set_drvdata(pdev, dd);
3837 rv = pcim_enable_device(pdev);
3839 dev_err(&pdev->dev, "Unable to enable device\n");
3843 /* Map BAR5 to memory. */
3844 rv = pcim_iomap_regions(pdev, 1 << MTIP_ABAR, MTIP_DRV_NAME);
3846 dev_err(&pdev->dev, "Unable to map regions\n");
3850 if (!pci_set_dma_mask(pdev, DMA_BIT_MASK(64))) {
3851 rv = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
3854 rv = pci_set_consistent_dma_mask(pdev,
3857 dev_warn(&pdev->dev,
3858 "64-bit DMA enable failed\n");
3864 pci_set_master(pdev);
3866 if (pci_enable_msi(pdev)) {
3867 dev_warn(&pdev->dev,
3868 "Unable to enable MSI interrupt.\n");
3869 goto block_initialize_err;
3872 /* Copy the info we may need later into the private data structure. */
3873 dd->major = mtip_major;
3874 dd->instance = instance;
3877 /* Initialize the block layer. */
3878 rv = mtip_block_initialize(dd);
3881 "Unable to initialize block layer\n");
3882 goto block_initialize_err;
3886 * Increment the instance count so that each device has a unique
3890 if (rv != MTIP_FTL_REBUILD_MAGIC)
3891 set_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag);
3894 block_initialize_err:
3895 pci_disable_msi(pdev);
3898 pcim_iounmap_regions(pdev, 1 << MTIP_ABAR);
3902 pci_set_drvdata(pdev, NULL);
3909 * Called for each probed device when the device is removed or the
3910 * driver is unloaded.
3915 static void mtip_pci_remove(struct pci_dev *pdev)
3917 struct driver_data *dd = pci_get_drvdata(pdev);
3920 set_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag);
3922 if (mtip_check_surprise_removal(pdev)) {
3923 while (!test_bit(MTIP_DDF_CLEANUP_BIT, &dd->dd_flag)) {
3926 if (counter == 10) {
3927 /* Cleanup the outstanding commands */
3928 mtip_command_cleanup(dd);
3934 /* Clean up the block layer. */
3935 mtip_block_remove(dd);
3937 pci_disable_msi(pdev);
3940 pcim_iounmap_regions(pdev, 1 << MTIP_ABAR);
3944 * Called for each probed device when the device is suspended.
3950 static int mtip_pci_suspend(struct pci_dev *pdev, pm_message_t mesg)
3953 struct driver_data *dd = pci_get_drvdata(pdev);
3957 "Driver private datastructure is NULL\n");
3961 set_bit(MTIP_DDF_RESUME_BIT, &dd->dd_flag);
3963 /* Disable ports & interrupts then send standby immediate */
3964 rv = mtip_block_suspend(dd);
3967 "Failed to suspend controller\n");
3972 * Save the pci config space to pdev structure &
3973 * disable the device
3975 pci_save_state(pdev);
3976 pci_disable_device(pdev);
3978 /* Move to Low power state*/
3979 pci_set_power_state(pdev, PCI_D3hot);
3985 * Called for each probed device when the device is resumed.
3991 static int mtip_pci_resume(struct pci_dev *pdev)
3994 struct driver_data *dd;
3996 dd = pci_get_drvdata(pdev);
3999 "Driver private datastructure is NULL\n");
4003 /* Move the device to active State */
4004 pci_set_power_state(pdev, PCI_D0);
4006 /* Restore PCI configuration space */
4007 pci_restore_state(pdev);
4009 /* Enable the PCI device*/
4010 rv = pcim_enable_device(pdev);
4013 "Failed to enable card during resume\n");
4016 pci_set_master(pdev);
4019 * Calls hbaReset, initPort, & startPort function
4020 * then enables interrupts
4022 rv = mtip_block_resume(dd);
4024 dev_err(&pdev->dev, "Unable to resume\n");
4027 clear_bit(MTIP_DDF_RESUME_BIT, &dd->dd_flag);
4038 static void mtip_pci_shutdown(struct pci_dev *pdev)
4040 struct driver_data *dd = pci_get_drvdata(pdev);
4042 mtip_block_shutdown(dd);
4045 /* Table of device ids supported by this driver. */
4046 static DEFINE_PCI_DEVICE_TABLE(mtip_pci_tbl) = {
4047 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P320_DEVICE_ID) },
4051 /* Structure that describes the PCI driver functions. */
4052 static struct pci_driver mtip_pci_driver = {
4053 .name = MTIP_DRV_NAME,
4054 .id_table = mtip_pci_tbl,
4055 .probe = mtip_pci_probe,
4056 .remove = mtip_pci_remove,
4057 .suspend = mtip_pci_suspend,
4058 .resume = mtip_pci_resume,
4059 .shutdown = mtip_pci_shutdown,
4062 MODULE_DEVICE_TABLE(pci, mtip_pci_tbl);
4065 * Module initialization function.
4067 * Called once when the module is loaded. This function allocates a major
4068 * block device number to the Cyclone devices and registers the PCI layer
4072 * 0 on success else error code.
4074 static int __init mtip_init(void)
4078 printk(KERN_INFO MTIP_DRV_NAME " Version " MTIP_DRV_VERSION "\n");
4080 /* Allocate a major block device number to use with this driver. */
4081 error = register_blkdev(0, MTIP_DRV_NAME);
4083 printk(KERN_ERR "Unable to register block device (%d)\n",
4089 /* Register our PCI operations. */
4090 error = pci_register_driver(&mtip_pci_driver);
4092 unregister_blkdev(mtip_major, MTIP_DRV_NAME);
4098 * Module de-initialization function.
4100 * Called once when the module is unloaded. This function deallocates
4101 * the major block device number allocated by mtip_init() and
4102 * unregisters the PCI layer of the driver.
4107 static void __exit mtip_exit(void)
4109 /* Release the allocated major block device number. */
4110 unregister_blkdev(mtip_major, MTIP_DRV_NAME);
4112 /* Unregister the PCI driver. */
4113 pci_unregister_driver(&mtip_pci_driver);
4116 MODULE_AUTHOR("Micron Technology, Inc");
4117 MODULE_DESCRIPTION("Micron RealSSD PCIe Block Driver");
4118 MODULE_LICENSE("GPL");
4119 MODULE_VERSION(MTIP_DRV_VERSION);
4121 module_init(mtip_init);
4122 module_exit(mtip_exit);