]> git.openfabrics.org - ~shefty/rdma-dev.git/blob - drivers/block/mtip32xx/mtip32xx.c
df46b5a3f56fdc59507911c60b918d2609c24b8a
[~shefty/rdma-dev.git] / drivers / block / mtip32xx / mtip32xx.c
1 /*
2  * Driver for the Micron P320 SSD
3  *   Copyright (C) 2011 Micron Technology, Inc.
4  *
5  * Portions of this code were derived from works subjected to the
6  * following copyright:
7  *    Copyright (C) 2009 Integrated Device Technology, Inc.
8  *
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.
13  *
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.
18  *
19  */
20
21 #include <linux/pci.h>
22 #include <linux/interrupt.h>
23 #include <linux/ata.h>
24 #include <linux/delay.h>
25 #include <linux/hdreg.h>
26 #include <linux/uaccess.h>
27 #include <linux/random.h>
28 #include <linux/smp.h>
29 #include <linux/compat.h>
30 #include <linux/fs.h>
31 #include <linux/module.h>
32 #include <linux/genhd.h>
33 #include <linux/blkdev.h>
34 #include <linux/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>
40 #include <linux/debugfs.h>
41 #include "mtip32xx.h"
42
43 #define HW_CMD_SLOT_SZ          (MTIP_MAX_COMMAND_SLOTS * 32)
44 #define HW_CMD_TBL_SZ           (AHCI_CMD_TBL_HDR_SZ + (MTIP_MAX_SG * 16))
45 #define HW_CMD_TBL_AR_SZ        (HW_CMD_TBL_SZ * MTIP_MAX_COMMAND_SLOTS)
46 #define HW_PORT_PRIV_DMA_SZ \
47                 (HW_CMD_SLOT_SZ + HW_CMD_TBL_AR_SZ + AHCI_RX_FIS_SZ)
48
49 #define HOST_CAP_NZDMA          (1 << 19)
50 #define HOST_HSORG              0xFC
51 #define HSORG_DISABLE_SLOTGRP_INTR (1<<24)
52 #define HSORG_DISABLE_SLOTGRP_PXIS (1<<16)
53 #define HSORG_HWREV             0xFF00
54 #define HSORG_STYLE             0x8
55 #define HSORG_SLOTGROUPS        0x7
56
57 #define PORT_COMMAND_ISSUE      0x38
58 #define PORT_SDBV               0x7C
59
60 #define PORT_OFFSET             0x100
61 #define PORT_MEM_SIZE           0x80
62
63 #define PORT_IRQ_ERR \
64         (PORT_IRQ_HBUS_ERR | PORT_IRQ_IF_ERR | PORT_IRQ_CONNECT | \
65          PORT_IRQ_PHYRDY | PORT_IRQ_UNK_FIS | PORT_IRQ_BAD_PMP | \
66          PORT_IRQ_TF_ERR | PORT_IRQ_HBUS_DATA_ERR | PORT_IRQ_IF_NONFATAL | \
67          PORT_IRQ_OVERFLOW)
68 #define PORT_IRQ_LEGACY \
69         (PORT_IRQ_PIOS_FIS | PORT_IRQ_D2H_REG_FIS)
70 #define PORT_IRQ_HANDLED \
71         (PORT_IRQ_SDB_FIS | PORT_IRQ_LEGACY | \
72          PORT_IRQ_TF_ERR | PORT_IRQ_IF_ERR | \
73          PORT_IRQ_CONNECT | PORT_IRQ_PHYRDY)
74 #define DEF_PORT_IRQ \
75         (PORT_IRQ_ERR | PORT_IRQ_LEGACY | PORT_IRQ_SDB_FIS)
76
77 /* product numbers */
78 #define MTIP_PRODUCT_UNKNOWN    0x00
79 #define MTIP_PRODUCT_ASICFPGA   0x11
80
81 /* Device instance number, incremented each time a device is probed. */
82 static int instance;
83
84 /*
85  * Global variable used to hold the major block device number
86  * allocated in mtip_init().
87  */
88 static int mtip_major;
89 static struct dentry *dfs_parent;
90
91 static DEFINE_SPINLOCK(rssd_index_lock);
92 static DEFINE_IDA(rssd_index_ida);
93
94 static int mtip_block_initialize(struct driver_data *dd);
95
96 #ifdef CONFIG_COMPAT
97 struct mtip_compat_ide_task_request_s {
98         __u8            io_ports[8];
99         __u8            hob_ports[8];
100         ide_reg_valid_t out_flags;
101         ide_reg_valid_t in_flags;
102         int             data_phase;
103         int             req_cmd;
104         compat_ulong_t  out_size;
105         compat_ulong_t  in_size;
106 };
107 #endif
108
109 /*
110  * This function check_for_surprise_removal is called
111  * while card is removed from the system and it will
112  * read the vendor id from the configration space
113  *
114  * @pdev Pointer to the pci_dev structure.
115  *
116  * return value
117  *       true if device removed, else false
118  */
119 static bool mtip_check_surprise_removal(struct pci_dev *pdev)
120 {
121         u16 vendor_id = 0;
122
123        /* Read the vendorID from the configuration space */
124         pci_read_config_word(pdev, 0x00, &vendor_id);
125         if (vendor_id == 0xFFFF)
126                 return true; /* device removed */
127
128         return false; /* device present */
129 }
130
131 /*
132  * This function is called for clean the pending command in the
133  * command slot during the surprise removal of device and return
134  * error to the upper layer.
135  *
136  * @dd Pointer to the DRIVER_DATA structure.
137  *
138  * return value
139  *      None
140  */
141 static void mtip_command_cleanup(struct driver_data *dd)
142 {
143         int group = 0, commandslot = 0, commandindex = 0;
144         struct mtip_cmd *command;
145         struct mtip_port *port = dd->port;
146         static int in_progress;
147
148         if (in_progress)
149                 return;
150
151         in_progress = 1;
152
153         for (group = 0; group < 4; group++) {
154                 for (commandslot = 0; commandslot < 32; commandslot++) {
155                         if (!(port->allocated[group] & (1 << commandslot)))
156                                 continue;
157
158                         commandindex = group << 5 | commandslot;
159                         command = &port->commands[commandindex];
160
161                         if (atomic_read(&command->active)
162                             && (command->async_callback)) {
163                                 command->async_callback(command->async_data,
164                                         -ENODEV);
165                                 command->async_callback = NULL;
166                                 command->async_data = NULL;
167                         }
168
169                         dma_unmap_sg(&port->dd->pdev->dev,
170                                 command->sg,
171                                 command->scatter_ents,
172                                 command->direction);
173                 }
174         }
175
176         up(&port->cmd_slot);
177
178         set_bit(MTIP_DDF_CLEANUP_BIT, &dd->dd_flag);
179         in_progress = 0;
180 }
181
182 /*
183  * Obtain an empty command slot.
184  *
185  * This function needs to be reentrant since it could be called
186  * at the same time on multiple CPUs. The allocation of the
187  * command slot must be atomic.
188  *
189  * @port Pointer to the port data structure.
190  *
191  * return value
192  *      >= 0    Index of command slot obtained.
193  *      -1      No command slots available.
194  */
195 static int get_slot(struct mtip_port *port)
196 {
197         int slot, i;
198         unsigned int num_command_slots = port->dd->slot_groups * 32;
199
200         /*
201          * Try 10 times, because there is a small race here.
202          *  that's ok, because it's still cheaper than a lock.
203          *
204          * Race: Since this section is not protected by lock, same bit
205          * could be chosen by different process contexts running in
206          * different processor. So instead of costly lock, we are going
207          * with loop.
208          */
209         for (i = 0; i < 10; i++) {
210                 slot = find_next_zero_bit(port->allocated,
211                                          num_command_slots, 1);
212                 if ((slot < num_command_slots) &&
213                     (!test_and_set_bit(slot, port->allocated)))
214                         return slot;
215         }
216         dev_warn(&port->dd->pdev->dev, "Failed to get a tag.\n");
217
218         if (mtip_check_surprise_removal(port->dd->pdev)) {
219                 /* Device not present, clean outstanding commands */
220                 mtip_command_cleanup(port->dd);
221         }
222         return -1;
223 }
224
225 /*
226  * Release a command slot.
227  *
228  * @port Pointer to the port data structure.
229  * @tag  Tag of command to release
230  *
231  * return value
232  *      None
233  */
234 static inline void release_slot(struct mtip_port *port, int tag)
235 {
236         smp_mb__before_clear_bit();
237         clear_bit(tag, port->allocated);
238         smp_mb__after_clear_bit();
239 }
240
241 /*
242  * Reset the HBA (without sleeping)
243  *
244  * Just like hba_reset, except does not call sleep, so can be
245  * run from interrupt/tasklet context.
246  *
247  * @dd Pointer to the driver data structure.
248  *
249  * return value
250  *      0       The reset was successful.
251  *      -1      The HBA Reset bit did not clear.
252  */
253 static int hba_reset_nosleep(struct driver_data *dd)
254 {
255         unsigned long timeout;
256
257         /* Chip quirk: quiesce any chip function */
258         mdelay(10);
259
260         /* Set the reset bit */
261         writel(HOST_RESET, dd->mmio + HOST_CTL);
262
263         /* Flush */
264         readl(dd->mmio + HOST_CTL);
265
266         /*
267          * Wait 10ms then spin for up to 1 second
268          * waiting for reset acknowledgement
269          */
270         timeout = jiffies + msecs_to_jiffies(1000);
271         mdelay(10);
272         while ((readl(dd->mmio + HOST_CTL) & HOST_RESET)
273                  && time_before(jiffies, timeout))
274                 mdelay(1);
275
276         if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))
277                 return -1;
278
279         if (readl(dd->mmio + HOST_CTL) & HOST_RESET)
280                 return -1;
281
282         return 0;
283 }
284
285 /*
286  * Issue a command to the hardware.
287  *
288  * Set the appropriate bit in the s_active and Command Issue hardware
289  * registers, causing hardware command processing to begin.
290  *
291  * @port Pointer to the port structure.
292  * @tag  The tag of the command to be issued.
293  *
294  * return value
295  *      None
296  */
297 static inline void mtip_issue_ncq_command(struct mtip_port *port, int tag)
298 {
299         atomic_set(&port->commands[tag].active, 1);
300
301         spin_lock(&port->cmd_issue_lock);
302
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)]);
307
308         spin_unlock(&port->cmd_issue_lock);
309
310         /* Set the command's timeout value.*/
311         port->commands[tag].comp_time = jiffies + msecs_to_jiffies(
312                                         MTIP_NCQ_COMMAND_TIMEOUT_MS);
313 }
314
315 /*
316  * Enable/disable the reception of FIS
317  *
318  * @port   Pointer to the port data structure
319  * @enable 1 to enable, 0 to disable
320  *
321  * return value
322  *      Previous state: 1 enabled, 0 disabled
323  */
324 static int mtip_enable_fis(struct mtip_port *port, int enable)
325 {
326         u32 tmp;
327
328         /* enable FIS reception */
329         tmp = readl(port->mmio + PORT_CMD);
330         if (enable)
331                 writel(tmp | PORT_CMD_FIS_RX, port->mmio + PORT_CMD);
332         else
333                 writel(tmp & ~PORT_CMD_FIS_RX, port->mmio + PORT_CMD);
334
335         /* Flush */
336         readl(port->mmio + PORT_CMD);
337
338         return (((tmp & PORT_CMD_FIS_RX) == PORT_CMD_FIS_RX));
339 }
340
341 /*
342  * Enable/disable the DMA engine
343  *
344  * @port   Pointer to the port data structure
345  * @enable 1 to enable, 0 to disable
346  *
347  * return value
348  *      Previous state: 1 enabled, 0 disabled.
349  */
350 static int mtip_enable_engine(struct mtip_port *port, int enable)
351 {
352         u32 tmp;
353
354         /* enable FIS reception */
355         tmp = readl(port->mmio + PORT_CMD);
356         if (enable)
357                 writel(tmp | PORT_CMD_START, port->mmio + PORT_CMD);
358         else
359                 writel(tmp & ~PORT_CMD_START, port->mmio + PORT_CMD);
360
361         readl(port->mmio + PORT_CMD);
362         return (((tmp & PORT_CMD_START) == PORT_CMD_START));
363 }
364
365 /*
366  * Enables the port DMA engine and FIS reception.
367  *
368  * return value
369  *      None
370  */
371 static inline void mtip_start_port(struct mtip_port *port)
372 {
373         /* Enable FIS reception */
374         mtip_enable_fis(port, 1);
375
376         /* Enable the DMA engine */
377         mtip_enable_engine(port, 1);
378 }
379
380 /*
381  * Deinitialize a port by disabling port interrupts, the DMA engine,
382  * and FIS reception.
383  *
384  * @port Pointer to the port structure
385  *
386  * return value
387  *      None
388  */
389 static inline void mtip_deinit_port(struct mtip_port *port)
390 {
391         /* Disable interrupts on this port */
392         writel(0, port->mmio + PORT_IRQ_MASK);
393
394         /* Disable the DMA engine */
395         mtip_enable_engine(port, 0);
396
397         /* Disable FIS reception */
398         mtip_enable_fis(port, 0);
399 }
400
401 /*
402  * Initialize a port.
403  *
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.
408  *
409  * @port Pointer to the port structure.
410  *
411  * return value
412  *      None
413  */
414 static void mtip_init_port(struct mtip_port *port)
415 {
416         int i;
417         mtip_deinit_port(port);
418
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);
425         }
426
427         writel(port->command_list_dma & 0xFFFFFFFF,
428                         port->mmio + PORT_LST_ADDR);
429         writel(port->rxfis_dma & 0xFFFFFFFF, port->mmio + PORT_FIS_ADDR);
430
431         /* Clear SError */
432         writel(readl(port->mmio + PORT_SCR_ERR), port->mmio + PORT_SCR_ERR);
433
434         /* reset the completed registers.*/
435         for (i = 0; i < port->dd->slot_groups; i++)
436                 writel(0xFFFFFFFF, port->completed[i]);
437
438         /* Clear any pending interrupts for this port */
439         writel(readl(port->mmio + PORT_IRQ_STAT), port->mmio + PORT_IRQ_STAT);
440
441         /* Clear any pending interrupts on the HBA. */
442         writel(readl(port->dd->mmio + HOST_IRQ_STAT),
443                                         port->dd->mmio + HOST_IRQ_STAT);
444
445         /* Enable port interrupts */
446         writel(DEF_PORT_IRQ, port->mmio + PORT_IRQ_MASK);
447 }
448
449 /*
450  * Restart a port
451  *
452  * @port Pointer to the port data structure.
453  *
454  * return value
455  *      None
456  */
457 static void mtip_restart_port(struct mtip_port *port)
458 {
459         unsigned long timeout;
460
461         /* Disable the DMA engine */
462         mtip_enable_engine(port, 0);
463
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))
468                 ;
469
470         if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
471                 return;
472
473         /*
474          * Chip quirk: escalate to hba reset if
475          * PxCMD.CR not clear after 500 ms
476          */
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");
480
481                 if (hba_reset_nosleep(port->dd))
482                         dev_err(&port->dd->pdev->dev,
483                                 "HBA reset escalation failed.\n");
484
485                 /* 30 ms delay before com reset to quiesce chip */
486                 mdelay(30);
487         }
488
489         dev_warn(&port->dd->pdev->dev, "Issuing COM reset\n");
490
491         /* Set PxSCTL.DET */
492         writel(readl(port->mmio + PORT_SCR_CTL) |
493                          1, port->mmio + PORT_SCR_CTL);
494         readl(port->mmio + PORT_SCR_CTL);
495
496         /* Wait 1 ms to quiesce chip function */
497         timeout = jiffies + msecs_to_jiffies(1);
498         while (time_before(jiffies, timeout))
499                 ;
500
501         if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
502                 return;
503
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);
508
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))
513                 ;
514
515         if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
516                 return;
517
518         if ((readl(port->mmio + PORT_SCR_STAT) & 0x01) == 0)
519                 dev_warn(&port->dd->pdev->dev,
520                         "COM reset failed\n");
521
522         mtip_init_port(port);
523         mtip_start_port(port);
524
525 }
526
527 /*
528  * Helper function for tag logging
529  */
530 static void print_tags(struct driver_data *dd,
531                         char *msg,
532                         unsigned long *tagbits,
533                         int cnt)
534 {
535         unsigned char tagmap[128];
536         int group, tagmap_len = 0;
537
538         memset(tagmap, 0, sizeof(tagmap));
539         for (group = SLOTBITS_IN_LONGS; group > 0; group--)
540                 tagmap_len = sprintf(tagmap + tagmap_len, "%016lX ",
541                                                 tagbits[group-1]);
542         dev_warn(&dd->pdev->dev,
543                         "%d command(s) %s: tagmap [%s]", cnt, msg, tagmap);
544 }
545
546 /*
547  * Called periodically to see if any read/write commands are
548  * taking too long to complete.
549  *
550  * @data Pointer to the PORT data structure.
551  *
552  * return value
553  *      None
554  */
555 static void mtip_timeout_function(unsigned long int data)
556 {
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];
564
565         if (unlikely(!port))
566                 return;
567
568         if (test_bit(MTIP_DDF_RESUME_BIT, &port->dd->dd_flag)) {
569                 mod_timer(&port->cmd_timer,
570                         jiffies + msecs_to_jiffies(30000));
571                 return;
572         }
573         /* clear the tag accumulator */
574         memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
575
576         for (tag = 0; tag < num_command_slots; tag++) {
577                 /*
578                  * Skip internal command slot as it has
579                  * its own timeout mechanism
580                  */
581                 if (tag == MTIP_TAG_INTERNAL)
582                         continue;
583
584                 if (atomic_read(&port->commands[tag].active) &&
585                    (time_after(jiffies, port->commands[tag].comp_time))) {
586                         group = tag >> 5;
587                         bit = tag & 0x1F;
588
589                         command = &port->commands[tag];
590                         fis = (struct host_to_dev_fis *) command->command;
591
592                         set_bit(tag, tagaccum);
593                         cmdto_cnt++;
594                         if (cmdto_cnt == 1)
595                                 set_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
596
597                         /*
598                          * Clear the completed bit. This should prevent
599                          *  any interrupt handlers from trying to retire
600                          *  the command.
601                          */
602                         writel(1 << bit, port->completed[group]);
603
604                         /* Call the async completion callback. */
605                         if (likely(command->async_callback))
606                                 command->async_callback(command->async_data,
607                                                          -EIO);
608                         command->async_callback = NULL;
609                         command->comp_func = NULL;
610
611                         /* Unmap the DMA scatter list entries */
612                         dma_unmap_sg(&port->dd->pdev->dev,
613                                         command->sg,
614                                         command->scatter_ents,
615                                         command->direction);
616
617                         /*
618                          * Clear the allocated bit and active tag for the
619                          * command.
620                          */
621                         atomic_set(&port->commands[tag].active, 0);
622                         release_slot(port, tag);
623
624                         up(&port->cmd_slot);
625                 }
626         }
627
628         if (cmdto_cnt && !test_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags)) {
629                 print_tags(port->dd, "timed out", tagaccum, cmdto_cnt);
630
631                 mtip_restart_port(port);
632                 clear_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
633                 wake_up_interruptible(&port->svc_wait);
634         }
635
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);
645                         }
646
647
648                 }
649         }
650
651         /* Restart the timer */
652         mod_timer(&port->cmd_timer,
653                 jiffies + msecs_to_jiffies(MTIP_TIMEOUT_CHECK_PERIOD));
654 }
655
656 /*
657  * IO completion function.
658  *
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.
665  *
666  * @port   Pointer to the port data structure.
667  * @tag    Tag of the command.
668  * @data   Pointer to driver_data.
669  * @status Completion status.
670  *
671  * return value
672  *      None
673  */
674 static void mtip_async_complete(struct mtip_port *port,
675                                 int tag,
676                                 void *data,
677                                 int status)
678 {
679         struct mtip_cmd *command;
680         struct driver_data *dd = data;
681         int cb_status = status ? -EIO : 0;
682
683         if (unlikely(!dd) || unlikely(!port))
684                 return;
685
686         command = &port->commands[tag];
687
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);
691         }
692
693         /* Upper layer callback */
694         if (likely(command->async_callback))
695                 command->async_callback(command->async_data, cb_status);
696
697         command->async_callback = NULL;
698         command->comp_func = NULL;
699
700         /* Unmap the DMA scatter list entries */
701         dma_unmap_sg(&dd->pdev->dev,
702                 command->sg,
703                 command->scatter_ents,
704                 command->direction);
705
706         /* Clear the allocated and active bits for the command */
707         atomic_set(&port->commands[tag].active, 0);
708         release_slot(port, tag);
709
710         up(&port->cmd_slot);
711 }
712
713 /*
714  * Internal command completion callback function.
715  *
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().
719  *
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.
724  *
725  * return value
726  *      None
727  */
728 static void mtip_completion(struct mtip_port *port,
729                             int tag,
730                             void *data,
731                             int status)
732 {
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);
738
739         command->async_callback = NULL;
740         command->comp_func = NULL;
741
742         complete(waiting);
743 }
744
745 static void mtip_null_completion(struct mtip_port *port,
746                             int tag,
747                             void *data,
748                             int status)
749 {
750         return;
751 }
752
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);
757 /*
758  * Handle an error.
759  *
760  * @dd Pointer to the DRIVER_DATA structure.
761  *
762  * return value
763  *      None
764  */
765 static void mtip_handle_tfe(struct driver_data *dd)
766 {
767         int group, tag, bit, reissue, rv;
768         struct mtip_port *port;
769         struct mtip_cmd  *cmd;
770         u32 completed;
771         struct host_to_dev_fis *fis;
772         unsigned long tagaccum[SLOTBITS_IN_LONGS];
773         unsigned int cmd_cnt = 0;
774         unsigned char *buf;
775         char *fail_reason = NULL;
776         int fail_all_ncq_write = 0, fail_all_ncq_cmds = 0;
777
778         dev_warn(&dd->pdev->dev, "Taskfile error\n");
779
780         port = dd->port;
781
782         /* Stop the timer to prevent command timeouts. */
783         del_timer(&port->cmd_timer);
784         set_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
785
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");
790
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);
795                 }
796                 goto handle_tfe_exit;
797         }
798
799         /* clear the tag accumulator */
800         memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
801
802         /* Loop through all the groups */
803         for (group = 0; group < dd->slot_groups; group++) {
804                 completed = readl(port->completed[group]);
805
806                 /* clear completed status register in the hardware.*/
807                 writel(completed, port->completed[group]);
808
809                 /* Process successfully completed commands */
810                 for (bit = 0; bit < 32 && completed; bit++) {
811                         if (!(completed & (1<<bit)))
812                                 continue;
813                         tag = (group << 5) + bit;
814
815                         /* Skip the internal command slot */
816                         if (tag == MTIP_TAG_INTERNAL)
817                                 continue;
818
819                         cmd = &port->commands[tag];
820                         if (likely(cmd->comp_func)) {
821                                 set_bit(tag, tagaccum);
822                                 cmd_cnt++;
823                                 atomic_set(&cmd->active, 0);
824                                 cmd->comp_func(port,
825                                          tag,
826                                          cmd->comp_data,
827                                          0);
828                         } else {
829                                 dev_err(&port->dd->pdev->dev,
830                                         "Missing completion func for tag %d",
831                                         tag);
832                                 if (mtip_check_surprise_removal(dd->pdev)) {
833                                         mtip_command_cleanup(dd);
834                                         /* don't proceed further */
835                                         return;
836                                 }
837                         }
838                 }
839         }
840
841         print_tags(dd, "completed (TFE)", tagaccum, cmd_cnt);
842
843         /* Restart the port */
844         mdelay(20);
845         mtip_restart_port(port);
846
847         /* Trying to determine the cause of the error */
848         rv = mtip_read_log_page(dd->port, ATA_LOG_SATA_NCQ,
849                                 dd->port->log_buf,
850                                 dd->port->log_buf_dma, 1);
851         if (rv) {
852                 dev_warn(&dd->pdev->dev,
853                         "Error in READ LOG EXT (10h) command\n");
854                 /* non-critical error, don't fail the load */
855         } else {
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";
863                 }
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";
870                 }
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";
876                 }
877         }
878
879         /* clear the tag accumulator */
880         memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
881
882         /* Loop through all the groups */
883         for (group = 0; group < dd->slot_groups; group++) {
884                 for (bit = 0; bit < 32; bit++) {
885                         reissue = 1;
886                         tag = (group << 5) + bit;
887                         cmd = &port->commands[tag];
888
889                         /* If the active bit is set re-issue the command */
890                         if (atomic_read(&cmd->active) == 0)
891                                 continue;
892
893                         fis = (struct host_to_dev_fis *)cmd->command;
894
895                         /* Should re-issue? */
896                         if (tag == MTIP_TAG_INTERNAL ||
897                             fis->command == ATA_CMD_SET_FEATURES)
898                                 reissue = 0;
899                         else {
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 ?
906                                                 "write" : "read",
907                                         tag,
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,
913                                                         cmd->comp_data,
914                                                         -ENODATA);
915                                         }
916                                         continue;
917                                 }
918                         }
919
920                         /*
921                          * First check if this command has
922                          *  exceeded its retries.
923                          */
924                         if (reissue && (cmd->retries-- > 0)) {
925
926                                 set_bit(tag, tagaccum);
927
928                                 /* Re-issue the command. */
929                                 mtip_issue_ncq_command(port, tag);
930
931                                 continue;
932                         }
933
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);
938
939                         if (cmd->comp_func)
940                                 cmd->comp_func(
941                                         port,
942                                         tag,
943                                         cmd->comp_data,
944                                         PORT_IRQ_TF_ERR);
945                         else
946                                 dev_warn(&port->dd->pdev->dev,
947                                         "Bad completion for tag %d\n",
948                                         tag);
949                 }
950         }
951         print_tags(dd, "reissued (TFE)", tagaccum, cmd_cnt);
952
953 handle_tfe_exit:
954         /* clear eh_active */
955         clear_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
956         wake_up_interruptible(&port->svc_wait);
957
958         mod_timer(&port->cmd_timer,
959                  jiffies + msecs_to_jiffies(MTIP_TIMEOUT_CHECK_PERIOD));
960 }
961
962 /*
963  * Handle a set device bits interrupt
964  */
965 static inline void mtip_process_sdbf(struct driver_data *dd)
966 {
967         struct mtip_port  *port = dd->port;
968         int group, tag, bit;
969         u32 completed;
970         struct mtip_cmd *command;
971
972         /* walk all bits in all slot groups */
973         for (group = 0; group < dd->slot_groups; group++) {
974                 completed = readl(port->completed[group]);
975                 if (!completed)
976                         continue;
977
978                 /* clear completed status register in the hardware.*/
979                 writel(completed, port->completed[group]);
980
981                 /* Process completed commands. */
982                 for (bit = 0;
983                      (bit < 32) && completed;
984                      bit++, completed >>= 1) {
985                         if (completed & 0x01) {
986                                 tag = (group << 5) | bit;
987
988                                 /* skip internal command slot. */
989                                 if (unlikely(tag == MTIP_TAG_INTERNAL))
990                                         continue;
991
992                                 command = &port->commands[tag];
993                                 /* make internal callback */
994                                 if (likely(command->comp_func)) {
995                                         command->comp_func(
996                                                 port,
997                                                 tag,
998                                                 command->comp_data,
999                                                 0);
1000                                 } else {
1001                                         dev_warn(&dd->pdev->dev,
1002                                                 "Null completion "
1003                                                 "for tag %d",
1004                                                 tag);
1005
1006                                         if (mtip_check_surprise_removal(
1007                                                 dd->pdev)) {
1008                                                 mtip_command_cleanup(dd);
1009                                                 return;
1010                                         }
1011                                 }
1012                         }
1013                 }
1014         }
1015 }
1016
1017 /*
1018  * Process legacy pio and d2h interrupts
1019  */
1020 static inline void mtip_process_legacy(struct driver_data *dd, u32 port_stat)
1021 {
1022         struct mtip_port *port = dd->port;
1023         struct mtip_cmd *cmd = &port->commands[MTIP_TAG_INTERNAL];
1024
1025         if (test_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags) &&
1026             (cmd != NULL) && !(readl(port->cmd_issue[MTIP_TAG_INTERNAL])
1027                 & (1 << MTIP_TAG_INTERNAL))) {
1028                 if (cmd->comp_func) {
1029                         cmd->comp_func(port,
1030                                 MTIP_TAG_INTERNAL,
1031                                 cmd->comp_data,
1032                                 0);
1033                         return;
1034                 }
1035         }
1036
1037         return;
1038 }
1039
1040 /*
1041  * Demux and handle errors
1042  */
1043 static inline void mtip_process_errors(struct driver_data *dd, u32 port_stat)
1044 {
1045         if (likely(port_stat & (PORT_IRQ_TF_ERR | PORT_IRQ_IF_ERR)))
1046                 mtip_handle_tfe(dd);
1047
1048         if (unlikely(port_stat & PORT_IRQ_CONNECT)) {
1049                 dev_warn(&dd->pdev->dev,
1050                         "Clearing PxSERR.DIAG.x\n");
1051                 writel((1 << 26), dd->port->mmio + PORT_SCR_ERR);
1052         }
1053
1054         if (unlikely(port_stat & PORT_IRQ_PHYRDY)) {
1055                 dev_warn(&dd->pdev->dev,
1056                         "Clearing PxSERR.DIAG.n\n");
1057                 writel((1 << 16), dd->port->mmio + PORT_SCR_ERR);
1058         }
1059
1060         if (unlikely(port_stat & ~PORT_IRQ_HANDLED)) {
1061                 dev_warn(&dd->pdev->dev,
1062                         "Port stat errors %x unhandled\n",
1063                         (port_stat & ~PORT_IRQ_HANDLED));
1064         }
1065 }
1066
1067 static inline irqreturn_t mtip_handle_irq(struct driver_data *data)
1068 {
1069         struct driver_data *dd = (struct driver_data *) data;
1070         struct mtip_port *port = dd->port;
1071         u32 hba_stat, port_stat;
1072         int rv = IRQ_NONE;
1073
1074         hba_stat = readl(dd->mmio + HOST_IRQ_STAT);
1075         if (hba_stat) {
1076                 rv = IRQ_HANDLED;
1077
1078                 /* Acknowledge the interrupt status on the port.*/
1079                 port_stat = readl(port->mmio + PORT_IRQ_STAT);
1080                 writel(port_stat, port->mmio + PORT_IRQ_STAT);
1081
1082                 /* Demux port status */
1083                 if (likely(port_stat & PORT_IRQ_SDB_FIS))
1084                         mtip_process_sdbf(dd);
1085
1086                 if (unlikely(port_stat & PORT_IRQ_ERR)) {
1087                         if (unlikely(mtip_check_surprise_removal(dd->pdev))) {
1088                                 mtip_command_cleanup(dd);
1089                                 /* don't proceed further */
1090                                 return IRQ_HANDLED;
1091                         }
1092                         if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
1093                                                         &dd->dd_flag))
1094                                 return rv;
1095
1096                         mtip_process_errors(dd, port_stat & PORT_IRQ_ERR);
1097                 }
1098
1099                 if (unlikely(port_stat & PORT_IRQ_LEGACY))
1100                         mtip_process_legacy(dd, port_stat & PORT_IRQ_LEGACY);
1101         }
1102
1103         /* acknowledge interrupt */
1104         writel(hba_stat, dd->mmio + HOST_IRQ_STAT);
1105
1106         return rv;
1107 }
1108
1109 /*
1110  * Wrapper for mtip_handle_irq
1111  * (ignores return code)
1112  */
1113 static void mtip_tasklet(unsigned long data)
1114 {
1115         mtip_handle_irq((struct driver_data *) data);
1116 }
1117
1118 /*
1119  * HBA interrupt subroutine.
1120  *
1121  * @irq         IRQ number.
1122  * @instance    Pointer to the driver data structure.
1123  *
1124  * return value
1125  *      IRQ_HANDLED     A HBA interrupt was pending and handled.
1126  *      IRQ_NONE        This interrupt was not for the HBA.
1127  */
1128 static irqreturn_t mtip_irq_handler(int irq, void *instance)
1129 {
1130         struct driver_data *dd = instance;
1131         tasklet_schedule(&dd->tasklet);
1132         return IRQ_HANDLED;
1133 }
1134
1135 static void mtip_issue_non_ncq_command(struct mtip_port *port, int tag)
1136 {
1137         atomic_set(&port->commands[tag].active, 1);
1138         writel(1 << MTIP_TAG_BIT(tag),
1139                 port->cmd_issue[MTIP_TAG_INDEX(tag)]);
1140 }
1141
1142 static bool mtip_pause_ncq(struct mtip_port *port,
1143                                 struct host_to_dev_fis *fis)
1144 {
1145         struct host_to_dev_fis *reply;
1146         unsigned long task_file_data;
1147
1148         reply = port->rxfis + RX_FIS_D2H_REG;
1149         task_file_data = readl(port->mmio+PORT_TFDATA);
1150
1151         if (fis->command == ATA_CMD_SEC_ERASE_UNIT)
1152                 clear_bit(MTIP_DDF_SEC_LOCK_BIT, &port->dd->dd_flag);
1153
1154         if ((task_file_data & 1))
1155                 return false;
1156
1157         if (fis->command == ATA_CMD_SEC_ERASE_PREP) {
1158                 set_bit(MTIP_PF_SE_ACTIVE_BIT, &port->flags);
1159                 set_bit(MTIP_DDF_SEC_LOCK_BIT, &port->dd->dd_flag);
1160                 port->ic_pause_timer = jiffies;
1161                 return true;
1162         } else if ((fis->command == ATA_CMD_DOWNLOAD_MICRO) &&
1163                                         (fis->features == 0x03)) {
1164                 set_bit(MTIP_PF_DM_ACTIVE_BIT, &port->flags);
1165                 port->ic_pause_timer = jiffies;
1166                 return true;
1167         } else if ((fis->command == ATA_CMD_SEC_ERASE_UNIT) ||
1168                 ((fis->command == 0xFC) &&
1169                         (fis->features == 0x27 || fis->features == 0x72 ||
1170                          fis->features == 0x62 || fis->features == 0x26))) {
1171                 /* Com reset after secure erase or lowlevel format */
1172                 mtip_restart_port(port);
1173                 return false;
1174         }
1175
1176         return false;
1177 }
1178
1179 /*
1180  * Wait for port to quiesce
1181  *
1182  * @port    Pointer to port data structure
1183  * @timeout Max duration to wait (ms)
1184  *
1185  * return value
1186  *      0       Success
1187  *      -EBUSY  Commands still active
1188  */
1189 static int mtip_quiesce_io(struct mtip_port *port, unsigned long timeout)
1190 {
1191         unsigned long to;
1192         unsigned int n;
1193         unsigned int active = 1;
1194
1195         to = jiffies + msecs_to_jiffies(timeout);
1196         do {
1197                 if (test_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags) &&
1198                         test_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags)) {
1199                         msleep(20);
1200                         continue; /* svc thd is actively issuing commands */
1201                 }
1202                 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
1203                         return -EFAULT;
1204                 /*
1205                  * Ignore s_active bit 0 of array element 0.
1206                  * This bit will always be set
1207                  */
1208                 active = readl(port->s_active[0]) & 0xFFFFFFFE;
1209                 for (n = 1; n < port->dd->slot_groups; n++)
1210                         active |= readl(port->s_active[n]);
1211
1212                 if (!active)
1213                         break;
1214
1215                 msleep(20);
1216         } while (time_before(jiffies, to));
1217
1218         return active ? -EBUSY : 0;
1219 }
1220
1221 /*
1222  * Execute an internal command and wait for the completion.
1223  *
1224  * @port    Pointer to the port data structure.
1225  * @fis     Pointer to the FIS that describes the command.
1226  * @fis_len  Length in WORDS of the FIS.
1227  * @buffer  DMA accessible for command data.
1228  * @buf_len  Length, in bytes, of the data buffer.
1229  * @opts    Command header options, excluding the FIS length
1230  *             and the number of PRD entries.
1231  * @timeout Time in ms to wait for the command to complete.
1232  *
1233  * return value
1234  *      0        Command completed successfully.
1235  *      -EFAULT  The buffer address is not correctly aligned.
1236  *      -EBUSY   Internal command or other IO in progress.
1237  *      -EAGAIN  Time out waiting for command to complete.
1238  */
1239 static int mtip_exec_internal_command(struct mtip_port *port,
1240                                         struct host_to_dev_fis *fis,
1241                                         int fis_len,
1242                                         dma_addr_t buffer,
1243                                         int buf_len,
1244                                         u32 opts,
1245                                         gfp_t atomic,
1246                                         unsigned long timeout)
1247 {
1248         struct mtip_cmd_sg *command_sg;
1249         DECLARE_COMPLETION_ONSTACK(wait);
1250         int rv = 0, ready2go = 1;
1251         struct mtip_cmd *int_cmd = &port->commands[MTIP_TAG_INTERNAL];
1252         unsigned long to;
1253
1254         /* Make sure the buffer is 8 byte aligned. This is asic specific. */
1255         if (buffer & 0x00000007) {
1256                 dev_err(&port->dd->pdev->dev,
1257                         "SG buffer is not 8 byte aligned\n");
1258                 return -EFAULT;
1259         }
1260
1261         to = jiffies + msecs_to_jiffies(timeout);
1262         do {
1263                 ready2go = !test_and_set_bit(MTIP_TAG_INTERNAL,
1264                                                 port->allocated);
1265                 if (ready2go)
1266                         break;
1267                 mdelay(100);
1268         } while (time_before(jiffies, to));
1269         if (!ready2go) {
1270                 dev_warn(&port->dd->pdev->dev,
1271                         "Internal cmd active. new cmd [%02X]\n", fis->command);
1272                 return -EBUSY;
1273         }
1274         set_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
1275         port->ic_pause_timer = 0;
1276
1277         if (fis->command == ATA_CMD_SEC_ERASE_UNIT)
1278                 clear_bit(MTIP_PF_SE_ACTIVE_BIT, &port->flags);
1279         else if (fis->command == ATA_CMD_DOWNLOAD_MICRO)
1280                 clear_bit(MTIP_PF_DM_ACTIVE_BIT, &port->flags);
1281
1282         if (atomic == GFP_KERNEL) {
1283                 if (fis->command != ATA_CMD_STANDBYNOW1) {
1284                         /* wait for io to complete if non atomic */
1285                         if (mtip_quiesce_io(port, 5000) < 0) {
1286                                 dev_warn(&port->dd->pdev->dev,
1287                                         "Failed to quiesce IO\n");
1288                                 release_slot(port, MTIP_TAG_INTERNAL);
1289                                 clear_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
1290                                 wake_up_interruptible(&port->svc_wait);
1291                                 return -EBUSY;
1292                         }
1293                 }
1294
1295                 /* Set the completion function and data for the command. */
1296                 int_cmd->comp_data = &wait;
1297                 int_cmd->comp_func = mtip_completion;
1298
1299         } else {
1300                 /* Clear completion - we're going to poll */
1301                 int_cmd->comp_data = NULL;
1302                 int_cmd->comp_func = mtip_null_completion;
1303         }
1304
1305         /* Copy the command to the command table */
1306         memcpy(int_cmd->command, fis, fis_len*4);
1307
1308         /* Populate the SG list */
1309         int_cmd->command_header->opts =
1310                  __force_bit2int cpu_to_le32(opts | fis_len);
1311         if (buf_len) {
1312                 command_sg = int_cmd->command + AHCI_CMD_TBL_HDR_SZ;
1313
1314                 command_sg->info =
1315                         __force_bit2int cpu_to_le32((buf_len-1) & 0x3FFFFF);
1316                 command_sg->dba =
1317                         __force_bit2int cpu_to_le32(buffer & 0xFFFFFFFF);
1318                 command_sg->dba_upper =
1319                         __force_bit2int cpu_to_le32((buffer >> 16) >> 16);
1320
1321                 int_cmd->command_header->opts |=
1322                         __force_bit2int cpu_to_le32((1 << 16));
1323         }
1324
1325         /* Populate the command header */
1326         int_cmd->command_header->byte_count = 0;
1327
1328         /* Issue the command to the hardware */
1329         mtip_issue_non_ncq_command(port, MTIP_TAG_INTERNAL);
1330
1331         /* Poll if atomic, wait_for_completion otherwise */
1332         if (atomic == GFP_KERNEL) {
1333                 /* Wait for the command to complete or timeout. */
1334                 if (wait_for_completion_timeout(
1335                                 &wait,
1336                                 msecs_to_jiffies(timeout)) == 0) {
1337                         dev_err(&port->dd->pdev->dev,
1338                                 "Internal command did not complete [%d] "
1339                                 "within timeout of  %lu ms\n",
1340                                 atomic, timeout);
1341                         if (mtip_check_surprise_removal(port->dd->pdev) ||
1342                                 test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
1343                                                 &port->dd->dd_flag)) {
1344                                 rv = -ENXIO;
1345                                 goto exec_ic_exit;
1346                         }
1347                         rv = -EAGAIN;
1348                 }
1349         } else {
1350                 /* Spin for <timeout> checking if command still outstanding */
1351                 timeout = jiffies + msecs_to_jiffies(timeout);
1352                 while ((readl(port->cmd_issue[MTIP_TAG_INTERNAL])
1353                                 & (1 << MTIP_TAG_INTERNAL))
1354                                 && time_before(jiffies, timeout)) {
1355                         if (mtip_check_surprise_removal(port->dd->pdev)) {
1356                                 rv = -ENXIO;
1357                                 goto exec_ic_exit;
1358                         }
1359                         if ((fis->command != ATA_CMD_STANDBYNOW1) &&
1360                                 test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
1361                                                 &port->dd->dd_flag)) {
1362                                 rv = -ENXIO;
1363                                 goto exec_ic_exit;
1364                         }
1365                         if (readl(port->mmio + PORT_IRQ_STAT) & PORT_IRQ_ERR) {
1366                                 atomic_inc(&int_cmd->active); /* error */
1367                                 break;
1368                         }
1369                 }
1370         }
1371
1372         if (atomic_read(&int_cmd->active) > 1) {
1373                 dev_err(&port->dd->pdev->dev,
1374                         "Internal command [%02X] failed\n", fis->command);
1375                 rv = -EIO;
1376         }
1377         if (readl(port->cmd_issue[MTIP_TAG_INTERNAL])
1378                         & (1 << MTIP_TAG_INTERNAL)) {
1379                 rv = -ENXIO;
1380                 if (!test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
1381                                         &port->dd->dd_flag)) {
1382                         mtip_restart_port(port);
1383                         rv = -EAGAIN;
1384                 }
1385         }
1386 exec_ic_exit:
1387         /* Clear the allocated and active bits for the internal command. */
1388         atomic_set(&int_cmd->active, 0);
1389         release_slot(port, MTIP_TAG_INTERNAL);
1390         if (rv >= 0 && mtip_pause_ncq(port, fis)) {
1391                 /* NCQ paused */
1392                 return rv;
1393         }
1394         clear_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
1395         wake_up_interruptible(&port->svc_wait);
1396
1397         return rv;
1398 }
1399
1400 /*
1401  * Byte-swap ATA ID strings.
1402  *
1403  * ATA identify data contains strings in byte-swapped 16-bit words.
1404  * They must be swapped (on all architectures) to be usable as C strings.
1405  * This function swaps bytes in-place.
1406  *
1407  * @buf The buffer location of the string
1408  * @len The number of bytes to swap
1409  *
1410  * return value
1411  *      None
1412  */
1413 static inline void ata_swap_string(u16 *buf, unsigned int len)
1414 {
1415         int i;
1416         for (i = 0; i < (len/2); i++)
1417                 be16_to_cpus(&buf[i]);
1418 }
1419
1420 /*
1421  * Request the device identity information.
1422  *
1423  * If a user space buffer is not specified, i.e. is NULL, the
1424  * identify information is still read from the drive and placed
1425  * into the identify data buffer (@e port->identify) in the
1426  * port data structure.
1427  * When the identify buffer contains valid identify information @e
1428  * port->identify_valid is non-zero.
1429  *
1430  * @port         Pointer to the port structure.
1431  * @user_buffer  A user space buffer where the identify data should be
1432  *                    copied.
1433  *
1434  * return value
1435  *      0       Command completed successfully.
1436  *      -EFAULT An error occurred while coping data to the user buffer.
1437  *      -1      Command failed.
1438  */
1439 static int mtip_get_identify(struct mtip_port *port, void __user *user_buffer)
1440 {
1441         int rv = 0;
1442         struct host_to_dev_fis fis;
1443
1444         if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
1445                 return -EFAULT;
1446
1447         /* Build the FIS. */
1448         memset(&fis, 0, sizeof(struct host_to_dev_fis));
1449         fis.type        = 0x27;
1450         fis.opts        = 1 << 7;
1451         fis.command     = ATA_CMD_ID_ATA;
1452
1453         /* Set the identify information as invalid. */
1454         port->identify_valid = 0;
1455
1456         /* Clear the identify information. */
1457         memset(port->identify, 0, sizeof(u16) * ATA_ID_WORDS);
1458
1459         /* Execute the command. */
1460         if (mtip_exec_internal_command(port,
1461                                 &fis,
1462                                 5,
1463                                 port->identify_dma,
1464                                 sizeof(u16) * ATA_ID_WORDS,
1465                                 0,
1466                                 GFP_KERNEL,
1467                                 MTIP_INTERNAL_COMMAND_TIMEOUT_MS)
1468                                 < 0) {
1469                 rv = -1;
1470                 goto out;
1471         }
1472
1473         /*
1474          * Perform any necessary byte-swapping.  Yes, the kernel does in fact
1475          * perform field-sensitive swapping on the string fields.
1476          * See the kernel use of ata_id_string() for proof of this.
1477          */
1478 #ifdef __LITTLE_ENDIAN
1479         ata_swap_string(port->identify + 27, 40);  /* model string*/
1480         ata_swap_string(port->identify + 23, 8);   /* firmware string*/
1481         ata_swap_string(port->identify + 10, 20);  /* serial# string*/
1482 #else
1483         {
1484                 int i;
1485                 for (i = 0; i < ATA_ID_WORDS; i++)
1486                         port->identify[i] = le16_to_cpu(port->identify[i]);
1487         }
1488 #endif
1489
1490         /* Set the identify buffer as valid. */
1491         port->identify_valid = 1;
1492
1493         if (user_buffer) {
1494                 if (copy_to_user(
1495                         user_buffer,
1496                         port->identify,
1497                         ATA_ID_WORDS * sizeof(u16))) {
1498                         rv = -EFAULT;
1499                         goto out;
1500                 }
1501         }
1502
1503 out:
1504         return rv;
1505 }
1506
1507 /*
1508  * Issue a standby immediate command to the device.
1509  *
1510  * @port Pointer to the port structure.
1511  *
1512  * return value
1513  *      0       Command was executed successfully.
1514  *      -1      An error occurred while executing the command.
1515  */
1516 static int mtip_standby_immediate(struct mtip_port *port)
1517 {
1518         int rv;
1519         struct host_to_dev_fis  fis;
1520         unsigned long start;
1521
1522         /* Build the FIS. */
1523         memset(&fis, 0, sizeof(struct host_to_dev_fis));
1524         fis.type        = 0x27;
1525         fis.opts        = 1 << 7;
1526         fis.command     = ATA_CMD_STANDBYNOW1;
1527
1528         start = jiffies;
1529         rv = mtip_exec_internal_command(port,
1530                                         &fis,
1531                                         5,
1532                                         0,
1533                                         0,
1534                                         0,
1535                                         GFP_ATOMIC,
1536                                         15000);
1537         dbg_printk(MTIP_DRV_NAME "Time taken to complete standby cmd: %d ms\n",
1538                         jiffies_to_msecs(jiffies - start));
1539         if (rv)
1540                 dev_warn(&port->dd->pdev->dev,
1541                         "STANDBY IMMEDIATE command failed.\n");
1542
1543         return rv;
1544 }
1545
1546 /*
1547  * Issue a READ LOG EXT command to the device.
1548  *
1549  * @port        pointer to the port structure.
1550  * @page        page number to fetch
1551  * @buffer      pointer to buffer
1552  * @buffer_dma  dma address corresponding to @buffer
1553  * @sectors     page length to fetch, in sectors
1554  *
1555  * return value
1556  *      @rv     return value from mtip_exec_internal_command()
1557  */
1558 static int mtip_read_log_page(struct mtip_port *port, u8 page, u16 *buffer,
1559                                 dma_addr_t buffer_dma, unsigned int sectors)
1560 {
1561         struct host_to_dev_fis fis;
1562
1563         memset(&fis, 0, sizeof(struct host_to_dev_fis));
1564         fis.type        = 0x27;
1565         fis.opts        = 1 << 7;
1566         fis.command     = ATA_CMD_READ_LOG_EXT;
1567         fis.sect_count  = sectors & 0xFF;
1568         fis.sect_cnt_ex = (sectors >> 8) & 0xFF;
1569         fis.lba_low     = page;
1570         fis.lba_mid     = 0;
1571         fis.device      = ATA_DEVICE_OBS;
1572
1573         memset(buffer, 0, sectors * ATA_SECT_SIZE);
1574
1575         return mtip_exec_internal_command(port,
1576                                         &fis,
1577                                         5,
1578                                         buffer_dma,
1579                                         sectors * ATA_SECT_SIZE,
1580                                         0,
1581                                         GFP_ATOMIC,
1582                                         MTIP_INTERNAL_COMMAND_TIMEOUT_MS);
1583 }
1584
1585 /*
1586  * Issue a SMART READ DATA command to the device.
1587  *
1588  * @port        pointer to the port structure.
1589  * @buffer      pointer to buffer
1590  * @buffer_dma  dma address corresponding to @buffer
1591  *
1592  * return value
1593  *      @rv     return value from mtip_exec_internal_command()
1594  */
1595 static int mtip_get_smart_data(struct mtip_port *port, u8 *buffer,
1596                                         dma_addr_t buffer_dma)
1597 {
1598         struct host_to_dev_fis fis;
1599
1600         memset(&fis, 0, sizeof(struct host_to_dev_fis));
1601         fis.type        = 0x27;
1602         fis.opts        = 1 << 7;
1603         fis.command     = ATA_CMD_SMART;
1604         fis.features    = 0xD0;
1605         fis.sect_count  = 1;
1606         fis.lba_mid     = 0x4F;
1607         fis.lba_hi      = 0xC2;
1608         fis.device      = ATA_DEVICE_OBS;
1609
1610         return mtip_exec_internal_command(port,
1611                                         &fis,
1612                                         5,
1613                                         buffer_dma,
1614                                         ATA_SECT_SIZE,
1615                                         0,
1616                                         GFP_ATOMIC,
1617                                         15000);
1618 }
1619
1620 /*
1621  * Get the value of a smart attribute
1622  *
1623  * @port        pointer to the port structure
1624  * @id          attribute number
1625  * @attrib      pointer to return attrib information corresponding to @id
1626  *
1627  * return value
1628  *      -EINVAL NULL buffer passed or unsupported attribute @id.
1629  *      -EPERM  Identify data not valid, SMART not supported or not enabled
1630  */
1631 static int mtip_get_smart_attr(struct mtip_port *port, unsigned int id,
1632                                                 struct smart_attr *attrib)
1633 {
1634         int rv, i;
1635         struct smart_attr *pattr;
1636
1637         if (!attrib)
1638                 return -EINVAL;
1639
1640         if (!port->identify_valid) {
1641                 dev_warn(&port->dd->pdev->dev, "IDENTIFY DATA not valid\n");
1642                 return -EPERM;
1643         }
1644         if (!(port->identify[82] & 0x1)) {
1645                 dev_warn(&port->dd->pdev->dev, "SMART not supported\n");
1646                 return -EPERM;
1647         }
1648         if (!(port->identify[85] & 0x1)) {
1649                 dev_warn(&port->dd->pdev->dev, "SMART not enabled\n");
1650                 return -EPERM;
1651         }
1652
1653         memset(port->smart_buf, 0, ATA_SECT_SIZE);
1654         rv = mtip_get_smart_data(port, port->smart_buf, port->smart_buf_dma);
1655         if (rv) {
1656                 dev_warn(&port->dd->pdev->dev, "Failed to ge SMART data\n");
1657                 return rv;
1658         }
1659
1660         pattr = (struct smart_attr *)(port->smart_buf + 2);
1661         for (i = 0; i < 29; i++, pattr++)
1662                 if (pattr->attr_id == id) {
1663                         memcpy(attrib, pattr, sizeof(struct smart_attr));
1664                         break;
1665                 }
1666
1667         if (i == 29) {
1668                 dev_warn(&port->dd->pdev->dev,
1669                         "Query for invalid SMART attribute ID\n");
1670                 rv = -EINVAL;
1671         }
1672
1673         return rv;
1674 }
1675
1676 /*
1677  * Get the drive capacity.
1678  *
1679  * @dd      Pointer to the device data structure.
1680  * @sectors Pointer to the variable that will receive the sector count.
1681  *
1682  * return value
1683  *      1 Capacity was returned successfully.
1684  *      0 The identify information is invalid.
1685  */
1686 static bool mtip_hw_get_capacity(struct driver_data *dd, sector_t *sectors)
1687 {
1688         struct mtip_port *port = dd->port;
1689         u64 total, raw0, raw1, raw2, raw3;
1690         raw0 = port->identify[100];
1691         raw1 = port->identify[101];
1692         raw2 = port->identify[102];
1693         raw3 = port->identify[103];
1694         total = raw0 | raw1<<16 | raw2<<32 | raw3<<48;
1695         *sectors = total;
1696         return (bool) !!port->identify_valid;
1697 }
1698
1699 /*
1700  * Reset the HBA.
1701  *
1702  * Resets the HBA by setting the HBA Reset bit in the Global
1703  * HBA Control register. After setting the HBA Reset bit the
1704  * function waits for 1 second before reading the HBA Reset
1705  * bit to make sure it has cleared. If HBA Reset is not clear
1706  * an error is returned. Cannot be used in non-blockable
1707  * context.
1708  *
1709  * @dd Pointer to the driver data structure.
1710  *
1711  * return value
1712  *      0  The reset was successful.
1713  *      -1 The HBA Reset bit did not clear.
1714  */
1715 static int mtip_hba_reset(struct driver_data *dd)
1716 {
1717         mtip_deinit_port(dd->port);
1718
1719         /* Set the reset bit */
1720         writel(HOST_RESET, dd->mmio + HOST_CTL);
1721
1722         /* Flush */
1723         readl(dd->mmio + HOST_CTL);
1724
1725         /* Wait for reset to clear */
1726         ssleep(1);
1727
1728         /* Check the bit has cleared */
1729         if (readl(dd->mmio + HOST_CTL) & HOST_RESET) {
1730                 dev_err(&dd->pdev->dev,
1731                         "Reset bit did not clear.\n");
1732                 return -1;
1733         }
1734
1735         return 0;
1736 }
1737
1738 /*
1739  * Display the identify command data.
1740  *
1741  * @port Pointer to the port data structure.
1742  *
1743  * return value
1744  *      None
1745  */
1746 static void mtip_dump_identify(struct mtip_port *port)
1747 {
1748         sector_t sectors;
1749         unsigned short revid;
1750         char cbuf[42];
1751
1752         if (!port->identify_valid)
1753                 return;
1754
1755         strlcpy(cbuf, (char *)(port->identify+10), 21);
1756         dev_info(&port->dd->pdev->dev,
1757                 "Serial No.: %s\n", cbuf);
1758
1759         strlcpy(cbuf, (char *)(port->identify+23), 9);
1760         dev_info(&port->dd->pdev->dev,
1761                 "Firmware Ver.: %s\n", cbuf);
1762
1763         strlcpy(cbuf, (char *)(port->identify+27), 41);
1764         dev_info(&port->dd->pdev->dev, "Model: %s\n", cbuf);
1765
1766         if (mtip_hw_get_capacity(port->dd, &sectors))
1767                 dev_info(&port->dd->pdev->dev,
1768                         "Capacity: %llu sectors (%llu MB)\n",
1769                          (u64)sectors,
1770                          ((u64)sectors) * ATA_SECT_SIZE >> 20);
1771
1772         pci_read_config_word(port->dd->pdev, PCI_REVISION_ID, &revid);
1773         switch (revid & 0xFF) {
1774         case 0x1:
1775                 strlcpy(cbuf, "A0", 3);
1776                 break;
1777         case 0x3:
1778                 strlcpy(cbuf, "A2", 3);
1779                 break;
1780         default:
1781                 strlcpy(cbuf, "?", 2);
1782                 break;
1783         }
1784         dev_info(&port->dd->pdev->dev,
1785                 "Card Type: %s\n", cbuf);
1786 }
1787
1788 /*
1789  * Map the commands scatter list into the command table.
1790  *
1791  * @command Pointer to the command.
1792  * @nents Number of scatter list entries.
1793  *
1794  * return value
1795  *      None
1796  */
1797 static inline void fill_command_sg(struct driver_data *dd,
1798                                 struct mtip_cmd *command,
1799                                 int nents)
1800 {
1801         int n;
1802         unsigned int dma_len;
1803         struct mtip_cmd_sg *command_sg;
1804         struct scatterlist *sg = command->sg;
1805
1806         command_sg = command->command + AHCI_CMD_TBL_HDR_SZ;
1807
1808         for (n = 0; n < nents; n++) {
1809                 dma_len = sg_dma_len(sg);
1810                 if (dma_len > 0x400000)
1811                         dev_err(&dd->pdev->dev,
1812                                 "DMA segment length truncated\n");
1813                 command_sg->info = __force_bit2int
1814                         cpu_to_le32((dma_len-1) & 0x3FFFFF);
1815                 command_sg->dba = __force_bit2int
1816                         cpu_to_le32(sg_dma_address(sg));
1817                 command_sg->dba_upper = __force_bit2int
1818                         cpu_to_le32((sg_dma_address(sg) >> 16) >> 16);
1819                 command_sg++;
1820                 sg++;
1821         }
1822 }
1823
1824 /*
1825  * @brief Execute a drive command.
1826  *
1827  * return value 0 The command completed successfully.
1828  * return value -1 An error occurred while executing the command.
1829  */
1830 static int exec_drive_task(struct mtip_port *port, u8 *command)
1831 {
1832         struct host_to_dev_fis  fis;
1833         struct host_to_dev_fis *reply = (port->rxfis + RX_FIS_D2H_REG);
1834
1835         /* Build the FIS. */
1836         memset(&fis, 0, sizeof(struct host_to_dev_fis));
1837         fis.type        = 0x27;
1838         fis.opts        = 1 << 7;
1839         fis.command     = command[0];
1840         fis.features    = command[1];
1841         fis.sect_count  = command[2];
1842         fis.sector      = command[3];
1843         fis.cyl_low     = command[4];
1844         fis.cyl_hi      = command[5];
1845         fis.device      = command[6] & ~0x10; /* Clear the dev bit*/
1846
1847         dbg_printk(MTIP_DRV_NAME " %s: User Command: cmd %x, feat %x, nsect %x, sect %x, lcyl %x, hcyl %x, sel %x\n",
1848                 __func__,
1849                 command[0],
1850                 command[1],
1851                 command[2],
1852                 command[3],
1853                 command[4],
1854                 command[5],
1855                 command[6]);
1856
1857         /* Execute the command. */
1858         if (mtip_exec_internal_command(port,
1859                                  &fis,
1860                                  5,
1861                                  0,
1862                                  0,
1863                                  0,
1864                                  GFP_KERNEL,
1865                                  MTIP_IOCTL_COMMAND_TIMEOUT_MS) < 0) {
1866                 return -1;
1867         }
1868
1869         command[0] = reply->command; /* Status*/
1870         command[1] = reply->features; /* Error*/
1871         command[4] = reply->cyl_low;
1872         command[5] = reply->cyl_hi;
1873
1874         dbg_printk(MTIP_DRV_NAME " %s: Completion Status: stat %x, err %x , cyl_lo %x cyl_hi %x\n",
1875                 __func__,
1876                 command[0],
1877                 command[1],
1878                 command[4],
1879                 command[5]);
1880
1881         return 0;
1882 }
1883
1884 /*
1885  * @brief Execute a drive command.
1886  *
1887  * @param port Pointer to the port data structure.
1888  * @param command Pointer to the user specified command parameters.
1889  * @param user_buffer Pointer to the user space buffer where read sector
1890  *                   data should be copied.
1891  *
1892  * return value 0 The command completed successfully.
1893  * return value -EFAULT An error occurred while copying the completion
1894  *                 data to the user space buffer.
1895  * return value -1 An error occurred while executing the command.
1896  */
1897 static int exec_drive_command(struct mtip_port *port, u8 *command,
1898                                 void __user *user_buffer)
1899 {
1900         struct host_to_dev_fis  fis;
1901         struct host_to_dev_fis *reply;
1902         u8 *buf = NULL;
1903         dma_addr_t dma_addr = 0;
1904         int rv = 0, xfer_sz = command[3];
1905
1906         if (xfer_sz) {
1907                 if (!user_buffer)
1908                         return -EFAULT;
1909
1910                 buf = dmam_alloc_coherent(&port->dd->pdev->dev,
1911                                 ATA_SECT_SIZE * xfer_sz,
1912                                 &dma_addr,
1913                                 GFP_KERNEL);
1914                 if (!buf) {
1915                         dev_err(&port->dd->pdev->dev,
1916                                 "Memory allocation failed (%d bytes)\n",
1917                                 ATA_SECT_SIZE * xfer_sz);
1918                         return -ENOMEM;
1919                 }
1920                 memset(buf, 0, ATA_SECT_SIZE * xfer_sz);
1921         }
1922
1923         /* Build the FIS. */
1924         memset(&fis, 0, sizeof(struct host_to_dev_fis));
1925         fis.type        = 0x27;
1926         fis.opts        = 1 << 7;
1927         fis.command     = command[0];
1928         fis.features    = command[2];
1929         fis.sect_count  = command[3];
1930         if (fis.command == ATA_CMD_SMART) {
1931                 fis.sector      = command[1];
1932                 fis.cyl_low     = 0x4F;
1933                 fis.cyl_hi      = 0xC2;
1934         }
1935
1936         if (xfer_sz)
1937                 reply = (port->rxfis + RX_FIS_PIO_SETUP);
1938         else
1939                 reply = (port->rxfis + RX_FIS_D2H_REG);
1940
1941         dbg_printk(MTIP_DRV_NAME
1942                 " %s: User Command: cmd %x, sect %x, "
1943                 "feat %x, sectcnt %x\n",
1944                 __func__,
1945                 command[0],
1946                 command[1],
1947                 command[2],
1948                 command[3]);
1949
1950         /* Execute the command. */
1951         if (mtip_exec_internal_command(port,
1952                                 &fis,
1953                                  5,
1954                                  (xfer_sz ? dma_addr : 0),
1955                                  (xfer_sz ? ATA_SECT_SIZE * xfer_sz : 0),
1956                                  0,
1957                                  GFP_KERNEL,
1958                                  MTIP_IOCTL_COMMAND_TIMEOUT_MS)
1959                                  < 0) {
1960                 rv = -EFAULT;
1961                 goto exit_drive_command;
1962         }
1963
1964         /* Collect the completion status. */
1965         command[0] = reply->command; /* Status*/
1966         command[1] = reply->features; /* Error*/
1967         command[2] = reply->sect_count;
1968
1969         dbg_printk(MTIP_DRV_NAME
1970                 " %s: Completion Status: stat %x, "
1971                 "err %x, nsect %x\n",
1972                 __func__,
1973                 command[0],
1974                 command[1],
1975                 command[2]);
1976
1977         if (xfer_sz) {
1978                 if (copy_to_user(user_buffer,
1979                                  buf,
1980                                  ATA_SECT_SIZE * command[3])) {
1981                         rv = -EFAULT;
1982                         goto exit_drive_command;
1983                 }
1984         }
1985 exit_drive_command:
1986         if (buf)
1987                 dmam_free_coherent(&port->dd->pdev->dev,
1988                                 ATA_SECT_SIZE * xfer_sz, buf, dma_addr);
1989         return rv;
1990 }
1991
1992 /*
1993  *  Indicates whether a command has a single sector payload.
1994  *
1995  *  @command passed to the device to perform the certain event.
1996  *  @features passed to the device to perform the certain event.
1997  *
1998  *  return value
1999  *      1       command is one that always has a single sector payload,
2000  *              regardless of the value in the Sector Count field.
2001  *      0       otherwise
2002  *
2003  */
2004 static unsigned int implicit_sector(unsigned char command,
2005                                     unsigned char features)
2006 {
2007         unsigned int rv = 0;
2008
2009         /* list of commands that have an implicit sector count of 1 */
2010         switch (command) {
2011         case ATA_CMD_SEC_SET_PASS:
2012         case ATA_CMD_SEC_UNLOCK:
2013         case ATA_CMD_SEC_ERASE_PREP:
2014         case ATA_CMD_SEC_ERASE_UNIT:
2015         case ATA_CMD_SEC_FREEZE_LOCK:
2016         case ATA_CMD_SEC_DISABLE_PASS:
2017         case ATA_CMD_PMP_READ:
2018         case ATA_CMD_PMP_WRITE:
2019                 rv = 1;
2020                 break;
2021         case ATA_CMD_SET_MAX:
2022                 if (features == ATA_SET_MAX_UNLOCK)
2023                         rv = 1;
2024                 break;
2025         case ATA_CMD_SMART:
2026                 if ((features == ATA_SMART_READ_VALUES) ||
2027                                 (features == ATA_SMART_READ_THRESHOLDS))
2028                         rv = 1;
2029                 break;
2030         case ATA_CMD_CONF_OVERLAY:
2031                 if ((features == ATA_DCO_IDENTIFY) ||
2032                                 (features == ATA_DCO_SET))
2033                         rv = 1;
2034                 break;
2035         }
2036         return rv;
2037 }
2038 static void mtip_set_timeout(struct driver_data *dd,
2039                                         struct host_to_dev_fis *fis,
2040                                         unsigned int *timeout, u8 erasemode)
2041 {
2042         switch (fis->command) {
2043         case ATA_CMD_DOWNLOAD_MICRO:
2044                 *timeout = 120000; /* 2 minutes */
2045                 break;
2046         case ATA_CMD_SEC_ERASE_UNIT:
2047         case 0xFC:
2048                 if (erasemode)
2049                         *timeout = ((*(dd->port->identify + 90) * 2) * 60000);
2050                 else
2051                         *timeout = ((*(dd->port->identify + 89) * 2) * 60000);
2052                 break;
2053         case ATA_CMD_STANDBYNOW1:
2054                 *timeout = 120000;  /* 2 minutes */
2055                 break;
2056         case 0xF7:
2057         case 0xFA:
2058                 *timeout = 60000;  /* 60 seconds */
2059                 break;
2060         case ATA_CMD_SMART:
2061                 *timeout = 15000;  /* 15 seconds */
2062                 break;
2063         default:
2064                 *timeout = MTIP_IOCTL_COMMAND_TIMEOUT_MS;
2065                 break;
2066         }
2067 }
2068
2069 /*
2070  * Executes a taskfile
2071  * See ide_taskfile_ioctl() for derivation
2072  */
2073 static int exec_drive_taskfile(struct driver_data *dd,
2074                                void __user *buf,
2075                                ide_task_request_t *req_task,
2076                                int outtotal)
2077 {
2078         struct host_to_dev_fis  fis;
2079         struct host_to_dev_fis *reply;
2080         u8 *outbuf = NULL;
2081         u8 *inbuf = NULL;
2082         dma_addr_t outbuf_dma = 0;
2083         dma_addr_t inbuf_dma = 0;
2084         dma_addr_t dma_buffer = 0;
2085         int err = 0;
2086         unsigned int taskin = 0;
2087         unsigned int taskout = 0;
2088         u8 nsect = 0;
2089         unsigned int timeout;
2090         unsigned int force_single_sector;
2091         unsigned int transfer_size;
2092         unsigned long task_file_data;
2093         int intotal = outtotal + req_task->out_size;
2094         int erasemode = 0;
2095
2096         taskout = req_task->out_size;
2097         taskin = req_task->in_size;
2098         /* 130560 = 512 * 0xFF*/
2099         if (taskin > 130560 || taskout > 130560) {
2100                 err = -EINVAL;
2101                 goto abort;
2102         }
2103
2104         if (taskout) {
2105                 outbuf = kzalloc(taskout, GFP_KERNEL);
2106                 if (outbuf == NULL) {
2107                         err = -ENOMEM;
2108                         goto abort;
2109                 }
2110                 if (copy_from_user(outbuf, buf + outtotal, taskout)) {
2111                         err = -EFAULT;
2112                         goto abort;
2113                 }
2114                 outbuf_dma = pci_map_single(dd->pdev,
2115                                          outbuf,
2116                                          taskout,
2117                                          DMA_TO_DEVICE);
2118                 if (outbuf_dma == 0) {
2119                         err = -ENOMEM;
2120                         goto abort;
2121                 }
2122                 dma_buffer = outbuf_dma;
2123         }
2124
2125         if (taskin) {
2126                 inbuf = kzalloc(taskin, GFP_KERNEL);
2127                 if (inbuf == NULL) {
2128                         err = -ENOMEM;
2129                         goto abort;
2130                 }
2131
2132                 if (copy_from_user(inbuf, buf + intotal, taskin)) {
2133                         err = -EFAULT;
2134                         goto abort;
2135                 }
2136                 inbuf_dma = pci_map_single(dd->pdev,
2137                                          inbuf,
2138                                          taskin, DMA_FROM_DEVICE);
2139                 if (inbuf_dma == 0) {
2140                         err = -ENOMEM;
2141                         goto abort;
2142                 }
2143                 dma_buffer = inbuf_dma;
2144         }
2145
2146         /* only supports PIO and non-data commands from this ioctl. */
2147         switch (req_task->data_phase) {
2148         case TASKFILE_OUT:
2149                 nsect = taskout / ATA_SECT_SIZE;
2150                 reply = (dd->port->rxfis + RX_FIS_PIO_SETUP);
2151                 break;
2152         case TASKFILE_IN:
2153                 reply = (dd->port->rxfis + RX_FIS_PIO_SETUP);
2154                 break;
2155         case TASKFILE_NO_DATA:
2156                 reply = (dd->port->rxfis + RX_FIS_D2H_REG);
2157                 break;
2158         default:
2159                 err = -EINVAL;
2160                 goto abort;
2161         }
2162
2163         /* Build the FIS. */
2164         memset(&fis, 0, sizeof(struct host_to_dev_fis));
2165
2166         fis.type        = 0x27;
2167         fis.opts        = 1 << 7;
2168         fis.command     = req_task->io_ports[7];
2169         fis.features    = req_task->io_ports[1];
2170         fis.sect_count  = req_task->io_ports[2];
2171         fis.lba_low     = req_task->io_ports[3];
2172         fis.lba_mid     = req_task->io_ports[4];
2173         fis.lba_hi      = req_task->io_ports[5];
2174          /* Clear the dev bit*/
2175         fis.device      = req_task->io_ports[6] & ~0x10;
2176
2177         if ((req_task->in_flags.all == 0) && (req_task->out_flags.all & 1)) {
2178                 req_task->in_flags.all  =
2179                         IDE_TASKFILE_STD_IN_FLAGS |
2180                         (IDE_HOB_STD_IN_FLAGS << 8);
2181                 fis.lba_low_ex          = req_task->hob_ports[3];
2182                 fis.lba_mid_ex          = req_task->hob_ports[4];
2183                 fis.lba_hi_ex           = req_task->hob_ports[5];
2184                 fis.features_ex         = req_task->hob_ports[1];
2185                 fis.sect_cnt_ex         = req_task->hob_ports[2];
2186
2187         } else {
2188                 req_task->in_flags.all = IDE_TASKFILE_STD_IN_FLAGS;
2189         }
2190
2191         force_single_sector = implicit_sector(fis.command, fis.features);
2192
2193         if ((taskin || taskout) && (!fis.sect_count)) {
2194                 if (nsect)
2195                         fis.sect_count = nsect;
2196                 else {
2197                         if (!force_single_sector) {
2198                                 dev_warn(&dd->pdev->dev,
2199                                         "data movement but "
2200                                         "sect_count is 0\n");
2201                                         err = -EINVAL;
2202                                         goto abort;
2203                         }
2204                 }
2205         }
2206
2207         dbg_printk(MTIP_DRV_NAME
2208                 " %s: cmd %x, feat %x, nsect %x,"
2209                 " sect/lbal %x, lcyl/lbam %x, hcyl/lbah %x,"
2210                 " head/dev %x\n",
2211                 __func__,
2212                 fis.command,
2213                 fis.features,
2214                 fis.sect_count,
2215                 fis.lba_low,
2216                 fis.lba_mid,
2217                 fis.lba_hi,
2218                 fis.device);
2219
2220         /* check for erase mode support during secure erase.*/
2221         if ((fis.command == ATA_CMD_SEC_ERASE_UNIT) && outbuf &&
2222                                         (outbuf[0] & MTIP_SEC_ERASE_MODE)) {
2223                 erasemode = 1;
2224         }
2225
2226         mtip_set_timeout(dd, &fis, &timeout, erasemode);
2227
2228         /* Determine the correct transfer size.*/
2229         if (force_single_sector)
2230                 transfer_size = ATA_SECT_SIZE;
2231         else
2232                 transfer_size = ATA_SECT_SIZE * fis.sect_count;
2233
2234         /* Execute the command.*/
2235         if (mtip_exec_internal_command(dd->port,
2236                                  &fis,
2237                                  5,
2238                                  dma_buffer,
2239                                  transfer_size,
2240                                  0,
2241                                  GFP_KERNEL,
2242                                  timeout) < 0) {
2243                 err = -EIO;
2244                 goto abort;
2245         }
2246
2247         task_file_data = readl(dd->port->mmio+PORT_TFDATA);
2248
2249         if ((req_task->data_phase == TASKFILE_IN) && !(task_file_data & 1)) {
2250                 reply = dd->port->rxfis + RX_FIS_PIO_SETUP;
2251                 req_task->io_ports[7] = reply->control;
2252         } else {
2253                 reply = dd->port->rxfis + RX_FIS_D2H_REG;
2254                 req_task->io_ports[7] = reply->command;
2255         }
2256
2257         /* reclaim the DMA buffers.*/
2258         if (inbuf_dma)
2259                 pci_unmap_single(dd->pdev, inbuf_dma,
2260                         taskin, DMA_FROM_DEVICE);
2261         if (outbuf_dma)
2262                 pci_unmap_single(dd->pdev, outbuf_dma,
2263                         taskout, DMA_TO_DEVICE);
2264         inbuf_dma  = 0;
2265         outbuf_dma = 0;
2266
2267         /* return the ATA registers to the caller.*/
2268         req_task->io_ports[1] = reply->features;
2269         req_task->io_ports[2] = reply->sect_count;
2270         req_task->io_ports[3] = reply->lba_low;
2271         req_task->io_ports[4] = reply->lba_mid;
2272         req_task->io_ports[5] = reply->lba_hi;
2273         req_task->io_ports[6] = reply->device;
2274
2275         if (req_task->out_flags.all & 1)  {
2276
2277                 req_task->hob_ports[3] = reply->lba_low_ex;
2278                 req_task->hob_ports[4] = reply->lba_mid_ex;
2279                 req_task->hob_ports[5] = reply->lba_hi_ex;
2280                 req_task->hob_ports[1] = reply->features_ex;
2281                 req_task->hob_ports[2] = reply->sect_cnt_ex;
2282         }
2283         dbg_printk(MTIP_DRV_NAME
2284                 " %s: Completion: stat %x,"
2285                 "err %x, sect_cnt %x, lbalo %x,"
2286                 "lbamid %x, lbahi %x, dev %x\n",
2287                 __func__,
2288                 req_task->io_ports[7],
2289                 req_task->io_ports[1],
2290                 req_task->io_ports[2],
2291                 req_task->io_ports[3],
2292                 req_task->io_ports[4],
2293                 req_task->io_ports[5],
2294                 req_task->io_ports[6]);
2295
2296         if (taskout) {
2297                 if (copy_to_user(buf + outtotal, outbuf, taskout)) {
2298                         err = -EFAULT;
2299                         goto abort;
2300                 }
2301         }
2302         if (taskin) {
2303                 if (copy_to_user(buf + intotal, inbuf, taskin)) {
2304                         err = -EFAULT;
2305                         goto abort;
2306                 }
2307         }
2308 abort:
2309         if (inbuf_dma)
2310                 pci_unmap_single(dd->pdev, inbuf_dma,
2311                                         taskin, DMA_FROM_DEVICE);
2312         if (outbuf_dma)
2313                 pci_unmap_single(dd->pdev, outbuf_dma,
2314                                         taskout, DMA_TO_DEVICE);
2315         kfree(outbuf);
2316         kfree(inbuf);
2317
2318         return err;
2319 }
2320
2321 /*
2322  * Handle IOCTL calls from the Block Layer.
2323  *
2324  * This function is called by the Block Layer when it receives an IOCTL
2325  * command that it does not understand. If the IOCTL command is not supported
2326  * this function returns -ENOTTY.
2327  *
2328  * @dd  Pointer to the driver data structure.
2329  * @cmd IOCTL command passed from the Block Layer.
2330  * @arg IOCTL argument passed from the Block Layer.
2331  *
2332  * return value
2333  *      0       The IOCTL completed successfully.
2334  *      -ENOTTY The specified command is not supported.
2335  *      -EFAULT An error occurred copying data to a user space buffer.
2336  *      -EIO    An error occurred while executing the command.
2337  */
2338 static int mtip_hw_ioctl(struct driver_data *dd, unsigned int cmd,
2339                          unsigned long arg)
2340 {
2341         switch (cmd) {
2342         case HDIO_GET_IDENTITY:
2343         {
2344                 if (copy_to_user((void __user *)arg, dd->port->identify,
2345                                                 sizeof(u16) * ATA_ID_WORDS))
2346                         return -EFAULT;
2347                 break;
2348         }
2349         case HDIO_DRIVE_CMD:
2350         {
2351                 u8 drive_command[4];
2352
2353                 /* Copy the user command info to our buffer. */
2354                 if (copy_from_user(drive_command,
2355                                          (void __user *) arg,
2356                                          sizeof(drive_command)))
2357                         return -EFAULT;
2358
2359                 /* Execute the drive command. */
2360                 if (exec_drive_command(dd->port,
2361                                          drive_command,
2362                                          (void __user *) (arg+4)))
2363                         return -EIO;
2364
2365                 /* Copy the status back to the users buffer. */
2366                 if (copy_to_user((void __user *) arg,
2367                                          drive_command,
2368                                          sizeof(drive_command)))
2369                         return -EFAULT;
2370
2371                 break;
2372         }
2373         case HDIO_DRIVE_TASK:
2374         {
2375                 u8 drive_command[7];
2376
2377                 /* Copy the user command info to our buffer. */
2378                 if (copy_from_user(drive_command,
2379                                          (void __user *) arg,
2380                                          sizeof(drive_command)))
2381                         return -EFAULT;
2382
2383                 /* Execute the drive command. */
2384                 if (exec_drive_task(dd->port, drive_command))
2385                         return -EIO;
2386
2387                 /* Copy the status back to the users buffer. */
2388                 if (copy_to_user((void __user *) arg,
2389                                          drive_command,
2390                                          sizeof(drive_command)))
2391                         return -EFAULT;
2392
2393                 break;
2394         }
2395         case HDIO_DRIVE_TASKFILE: {
2396                 ide_task_request_t req_task;
2397                 int ret, outtotal;
2398
2399                 if (copy_from_user(&req_task, (void __user *) arg,
2400                                         sizeof(req_task)))
2401                         return -EFAULT;
2402
2403                 outtotal = sizeof(req_task);
2404
2405                 ret = exec_drive_taskfile(dd, (void __user *) arg,
2406                                                 &req_task, outtotal);
2407
2408                 if (copy_to_user((void __user *) arg, &req_task,
2409                                                         sizeof(req_task)))
2410                         return -EFAULT;
2411
2412                 return ret;
2413         }
2414
2415         default:
2416                 return -EINVAL;
2417         }
2418         return 0;
2419 }
2420
2421 /*
2422  * Submit an IO to the hw
2423  *
2424  * This function is called by the block layer to issue an io
2425  * to the device. Upon completion, the callback function will
2426  * be called with the data parameter passed as the callback data.
2427  *
2428  * @dd       Pointer to the driver data structure.
2429  * @start    First sector to read.
2430  * @nsect    Number of sectors to read.
2431  * @nents    Number of entries in scatter list for the read command.
2432  * @tag      The tag of this read command.
2433  * @callback Pointer to the function that should be called
2434  *           when the read completes.
2435  * @data     Callback data passed to the callback function
2436  *           when the read completes.
2437  * @dir      Direction (read or write)
2438  *
2439  * return value
2440  *      None
2441  */
2442 static void mtip_hw_submit_io(struct driver_data *dd, sector_t start,
2443                               int nsect, int nents, int tag, void *callback,
2444                               void *data, int dir)
2445 {
2446         struct host_to_dev_fis  *fis;
2447         struct mtip_port *port = dd->port;
2448         struct mtip_cmd *command = &port->commands[tag];
2449         int dma_dir = (dir == READ) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
2450
2451         /* Map the scatter list for DMA access */
2452         nents = dma_map_sg(&dd->pdev->dev, command->sg, nents, dma_dir);
2453
2454         command->scatter_ents = nents;
2455
2456         /*
2457          * The number of retries for this command before it is
2458          * reported as a failure to the upper layers.
2459          */
2460         command->retries = MTIP_MAX_RETRIES;
2461
2462         /* Fill out fis */
2463         fis = command->command;
2464         fis->type        = 0x27;
2465         fis->opts        = 1 << 7;
2466         fis->command     =
2467                 (dir == READ ? ATA_CMD_FPDMA_READ : ATA_CMD_FPDMA_WRITE);
2468         fis->lba_low     = start & 0xFF;
2469         fis->lba_mid     = (start >> 8) & 0xFF;
2470         fis->lba_hi      = (start >> 16) & 0xFF;
2471         fis->lba_low_ex  = (start >> 24) & 0xFF;
2472         fis->lba_mid_ex  = (start >> 32) & 0xFF;
2473         fis->lba_hi_ex   = (start >> 40) & 0xFF;
2474         fis->device      = 1 << 6;
2475         fis->features    = nsect & 0xFF;
2476         fis->features_ex = (nsect >> 8) & 0xFF;
2477         fis->sect_count  = ((tag << 3) | (tag >> 5));
2478         fis->sect_cnt_ex = 0;
2479         fis->control     = 0;
2480         fis->res2        = 0;
2481         fis->res3        = 0;
2482         fill_command_sg(dd, command, nents);
2483
2484         /* Populate the command header */
2485         command->command_header->opts =
2486                         __force_bit2int cpu_to_le32(
2487                                 (nents << 16) | 5 | AHCI_CMD_PREFETCH);
2488         command->command_header->byte_count = 0;
2489
2490         /*
2491          * Set the completion function and data for the command
2492          * within this layer.
2493          */
2494         command->comp_data = dd;
2495         command->comp_func = mtip_async_complete;
2496         command->direction = dma_dir;
2497
2498         /*
2499          * Set the completion function and data for the command passed
2500          * from the upper layer.
2501          */
2502         command->async_data = data;
2503         command->async_callback = callback;
2504
2505         /*
2506          * To prevent this command from being issued
2507          * if an internal command is in progress or error handling is active.
2508          */
2509         if (port->flags & MTIP_PF_PAUSE_IO) {
2510                 set_bit(tag, port->cmds_to_issue);
2511                 set_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags);
2512                 return;
2513         }
2514
2515         /* Issue the command to the hardware */
2516         mtip_issue_ncq_command(port, tag);
2517
2518         return;
2519 }
2520
2521 /*
2522  * Release a command slot.
2523  *
2524  * @dd  Pointer to the driver data structure.
2525  * @tag Slot tag
2526  *
2527  * return value
2528  *      None
2529  */
2530 static void mtip_hw_release_scatterlist(struct driver_data *dd, int tag)
2531 {
2532         release_slot(dd->port, tag);
2533 }
2534
2535 /*
2536  * Obtain a command slot and return its associated scatter list.
2537  *
2538  * @dd  Pointer to the driver data structure.
2539  * @tag Pointer to an int that will receive the allocated command
2540  *            slot tag.
2541  *
2542  * return value
2543  *      Pointer to the scatter list for the allocated command slot
2544  *      or NULL if no command slots are available.
2545  */
2546 static struct scatterlist *mtip_hw_get_scatterlist(struct driver_data *dd,
2547                                                    int *tag)
2548 {
2549         /*
2550          * It is possible that, even with this semaphore, a thread
2551          * may think that no command slots are available. Therefore, we
2552          * need to make an attempt to get_slot().
2553          */
2554         down(&dd->port->cmd_slot);
2555         *tag = get_slot(dd->port);
2556
2557         if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))) {
2558                 up(&dd->port->cmd_slot);
2559                 return NULL;
2560         }
2561         if (unlikely(*tag < 0)) {
2562                 up(&dd->port->cmd_slot);
2563                 return NULL;
2564         }
2565
2566         return dd->port->commands[*tag].sg;
2567 }
2568
2569 /*
2570  * Sysfs status dump.
2571  *
2572  * @dev  Pointer to the device structure, passed by the kernrel.
2573  * @attr Pointer to the device_attribute structure passed by the kernel.
2574  * @buf  Pointer to the char buffer that will receive the stats info.
2575  *
2576  * return value
2577  *      The size, in bytes, of the data copied into buf.
2578  */
2579 static ssize_t mtip_hw_show_status(struct device *dev,
2580                                 struct device_attribute *attr,
2581                                 char *buf)
2582 {
2583         struct driver_data *dd = dev_to_disk(dev)->private_data;
2584         int size = 0;
2585
2586         if (test_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag))
2587                 size += sprintf(buf, "%s", "thermal_shutdown\n");
2588         else if (test_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag))
2589                 size += sprintf(buf, "%s", "write_protect\n");
2590         else
2591                 size += sprintf(buf, "%s", "online\n");
2592
2593         return size;
2594 }
2595
2596 static DEVICE_ATTR(status, S_IRUGO, mtip_hw_show_status, NULL);
2597
2598 static ssize_t mtip_hw_read_registers(struct file *f, char __user *ubuf,
2599                                   size_t len, loff_t *offset)
2600 {
2601         struct driver_data *dd =  (struct driver_data *)f->private_data;
2602         char buf[MTIP_DFS_MAX_BUF_SIZE];
2603         u32 group_allocated;
2604         int size = *offset;
2605         int n;
2606
2607         if (!len || size)
2608                 return 0;
2609
2610         size += sprintf(&buf[size], "H/ S ACTive      : [ 0x");
2611
2612         for (n = dd->slot_groups-1; n >= 0; n--)
2613                 size += sprintf(&buf[size], "%08X ",
2614                                          readl(dd->port->s_active[n]));
2615
2616         size += sprintf(&buf[size], "]\n");
2617         size += sprintf(&buf[size], "H/ Command Issue : [ 0x");
2618
2619         for (n = dd->slot_groups-1; n >= 0; n--)
2620                 size += sprintf(&buf[size], "%08X ",
2621                                         readl(dd->port->cmd_issue[n]));
2622
2623         size += sprintf(&buf[size], "]\n");
2624         size += sprintf(&buf[size], "H/ Completed     : [ 0x");
2625
2626         for (n = dd->slot_groups-1; n >= 0; n--)
2627                 size += sprintf(&buf[size], "%08X ",
2628                                 readl(dd->port->completed[n]));
2629
2630         size += sprintf(&buf[size], "]\n");
2631         size += sprintf(&buf[size], "H/ PORT IRQ STAT : [ 0x%08X ]\n",
2632                                 readl(dd->port->mmio + PORT_IRQ_STAT));
2633         size += sprintf(&buf[size], "H/ HOST IRQ STAT : [ 0x%08X ]\n",
2634                                 readl(dd->mmio + HOST_IRQ_STAT));
2635         size += sprintf(&buf[size], "\n");
2636
2637         size += sprintf(&buf[size], "L/ Allocated     : [ 0x");
2638
2639         for (n = dd->slot_groups-1; n >= 0; n--) {
2640                 if (sizeof(long) > sizeof(u32))
2641                         group_allocated =
2642                                 dd->port->allocated[n/2] >> (32*(n&1));
2643                 else
2644                         group_allocated = dd->port->allocated[n];
2645                 size += sprintf(&buf[size], "%08X ", group_allocated);
2646         }
2647         size += sprintf(&buf[size], "]\n");
2648
2649         size += sprintf(&buf[size], "L/ Commands in Q : [ 0x");
2650
2651         for (n = dd->slot_groups-1; n >= 0; n--) {
2652                 if (sizeof(long) > sizeof(u32))
2653                         group_allocated =
2654                                 dd->port->cmds_to_issue[n/2] >> (32*(n&1));
2655                 else
2656                         group_allocated = dd->port->cmds_to_issue[n];
2657                 size += sprintf(&buf[size], "%08X ", group_allocated);
2658         }
2659         size += sprintf(&buf[size], "]\n");
2660
2661         *offset = size <= len ? size : len;
2662         size = copy_to_user(ubuf, buf, *offset);
2663         if (size)
2664                 return -EFAULT;
2665
2666         return *offset;
2667 }
2668
2669 static ssize_t mtip_hw_read_flags(struct file *f, char __user *ubuf,
2670                                   size_t len, loff_t *offset)
2671 {
2672         struct driver_data *dd =  (struct driver_data *)f->private_data;
2673         char buf[MTIP_DFS_MAX_BUF_SIZE];
2674         int size = *offset;
2675
2676         if (!len || size)
2677                 return 0;
2678
2679         size += sprintf(&buf[size], "Flag-port : [ %08lX ]\n",
2680                                                         dd->port->flags);
2681         size += sprintf(&buf[size], "Flag-dd   : [ %08lX ]\n",
2682                                                         dd->dd_flag);
2683
2684         *offset = size <= len ? size : len;
2685         size = copy_to_user(ubuf, buf, *offset);
2686         if (size)
2687                 return -EFAULT;
2688
2689         return *offset;
2690 }
2691
2692 static const struct file_operations mtip_regs_fops = {
2693         .owner  = THIS_MODULE,
2694         .open   = simple_open,
2695         .read   = mtip_hw_read_registers,
2696         .llseek = no_llseek,
2697 };
2698
2699 static const struct file_operations mtip_flags_fops = {
2700         .owner  = THIS_MODULE,
2701         .open   = simple_open,
2702         .read   = mtip_hw_read_flags,
2703         .llseek = no_llseek,
2704 };
2705
2706 /*
2707  * Create the sysfs related attributes.
2708  *
2709  * @dd   Pointer to the driver data structure.
2710  * @kobj Pointer to the kobj for the block device.
2711  *
2712  * return value
2713  *      0       Operation completed successfully.
2714  *      -EINVAL Invalid parameter.
2715  */
2716 static int mtip_hw_sysfs_init(struct driver_data *dd, struct kobject *kobj)
2717 {
2718         if (!kobj || !dd)
2719                 return -EINVAL;
2720
2721         if (sysfs_create_file(kobj, &dev_attr_status.attr))
2722                 dev_warn(&dd->pdev->dev,
2723                         "Error creating 'status' sysfs entry\n");
2724         return 0;
2725 }
2726
2727 /*
2728  * Remove the sysfs related attributes.
2729  *
2730  * @dd   Pointer to the driver data structure.
2731  * @kobj Pointer to the kobj for the block device.
2732  *
2733  * return value
2734  *      0       Operation completed successfully.
2735  *      -EINVAL Invalid parameter.
2736  */
2737 static int mtip_hw_sysfs_exit(struct driver_data *dd, struct kobject *kobj)
2738 {
2739         if (!kobj || !dd)
2740                 return -EINVAL;
2741
2742         sysfs_remove_file(kobj, &dev_attr_status.attr);
2743
2744         return 0;
2745 }
2746
2747 static int mtip_hw_debugfs_init(struct driver_data *dd)
2748 {
2749         if (!dfs_parent)
2750                 return -1;
2751
2752         dd->dfs_node = debugfs_create_dir(dd->disk->disk_name, dfs_parent);
2753         if (IS_ERR_OR_NULL(dd->dfs_node)) {
2754                 dev_warn(&dd->pdev->dev,
2755                         "Error creating node %s under debugfs\n",
2756                                                 dd->disk->disk_name);
2757                 dd->dfs_node = NULL;
2758                 return -1;
2759         }
2760
2761         debugfs_create_file("flags", S_IRUGO, dd->dfs_node, dd,
2762                                                         &mtip_flags_fops);
2763         debugfs_create_file("registers", S_IRUGO, dd->dfs_node, dd,
2764                                                         &mtip_regs_fops);
2765
2766         return 0;
2767 }
2768
2769 static void mtip_hw_debugfs_exit(struct driver_data *dd)
2770 {
2771         debugfs_remove_recursive(dd->dfs_node);
2772 }
2773
2774
2775 /*
2776  * Perform any init/resume time hardware setup
2777  *
2778  * @dd Pointer to the driver data structure.
2779  *
2780  * return value
2781  *      None
2782  */
2783 static inline void hba_setup(struct driver_data *dd)
2784 {
2785         u32 hwdata;
2786         hwdata = readl(dd->mmio + HOST_HSORG);
2787
2788         /* interrupt bug workaround: use only 1 IS bit.*/
2789         writel(hwdata |
2790                 HSORG_DISABLE_SLOTGRP_INTR |
2791                 HSORG_DISABLE_SLOTGRP_PXIS,
2792                 dd->mmio + HOST_HSORG);
2793 }
2794
2795 /*
2796  * Detect the details of the product, and store anything needed
2797  * into the driver data structure.  This includes product type and
2798  * version and number of slot groups.
2799  *
2800  * @dd Pointer to the driver data structure.
2801  *
2802  * return value
2803  *      None
2804  */
2805 static void mtip_detect_product(struct driver_data *dd)
2806 {
2807         u32 hwdata;
2808         unsigned int rev, slotgroups;
2809
2810         /*
2811          * HBA base + 0xFC [15:0] - vendor-specific hardware interface
2812          * info register:
2813          * [15:8] hardware/software interface rev#
2814          * [   3] asic-style interface
2815          * [ 2:0] number of slot groups, minus 1 (only valid for asic-style).
2816          */
2817         hwdata = readl(dd->mmio + HOST_HSORG);
2818
2819         dd->product_type = MTIP_PRODUCT_UNKNOWN;
2820         dd->slot_groups = 1;
2821
2822         if (hwdata & 0x8) {
2823                 dd->product_type = MTIP_PRODUCT_ASICFPGA;
2824                 rev = (hwdata & HSORG_HWREV) >> 8;
2825                 slotgroups = (hwdata & HSORG_SLOTGROUPS) + 1;
2826                 dev_info(&dd->pdev->dev,
2827                         "ASIC-FPGA design, HS rev 0x%x, "
2828                         "%i slot groups [%i slots]\n",
2829                          rev,
2830                          slotgroups,
2831                          slotgroups * 32);
2832
2833                 if (slotgroups > MTIP_MAX_SLOT_GROUPS) {
2834                         dev_warn(&dd->pdev->dev,
2835                                 "Warning: driver only supports "
2836                                 "%i slot groups.\n", MTIP_MAX_SLOT_GROUPS);
2837                         slotgroups = MTIP_MAX_SLOT_GROUPS;
2838                 }
2839                 dd->slot_groups = slotgroups;
2840                 return;
2841         }
2842
2843         dev_warn(&dd->pdev->dev, "Unrecognized product id\n");
2844 }
2845
2846 /*
2847  * Blocking wait for FTL rebuild to complete
2848  *
2849  * @dd Pointer to the DRIVER_DATA structure.
2850  *
2851  * return value
2852  *      0       FTL rebuild completed successfully
2853  *      -EFAULT FTL rebuild error/timeout/interruption
2854  */
2855 static int mtip_ftl_rebuild_poll(struct driver_data *dd)
2856 {
2857         unsigned long timeout, cnt = 0, start;
2858
2859         dev_warn(&dd->pdev->dev,
2860                 "FTL rebuild in progress. Polling for completion.\n");
2861
2862         start = jiffies;
2863         timeout = jiffies + msecs_to_jiffies(MTIP_FTL_REBUILD_TIMEOUT_MS);
2864
2865         do {
2866                 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
2867                                 &dd->dd_flag)))
2868                         return -EFAULT;
2869                 if (mtip_check_surprise_removal(dd->pdev))
2870                         return -EFAULT;
2871
2872                 if (mtip_get_identify(dd->port, NULL) < 0)
2873                         return -EFAULT;
2874
2875                 if (*(dd->port->identify + MTIP_FTL_REBUILD_OFFSET) ==
2876                         MTIP_FTL_REBUILD_MAGIC) {
2877                         ssleep(1);
2878                         /* Print message every 3 minutes */
2879                         if (cnt++ >= 180) {
2880                                 dev_warn(&dd->pdev->dev,
2881                                 "FTL rebuild in progress (%d secs).\n",
2882                                 jiffies_to_msecs(jiffies - start) / 1000);
2883                                 cnt = 0;
2884                         }
2885                 } else {
2886                         dev_warn(&dd->pdev->dev,
2887                                 "FTL rebuild complete (%d secs).\n",
2888                         jiffies_to_msecs(jiffies - start) / 1000);
2889                         mtip_block_initialize(dd);
2890                         return 0;
2891                 }
2892                 ssleep(10);
2893         } while (time_before(jiffies, timeout));
2894
2895         /* Check for timeout */
2896         dev_err(&dd->pdev->dev,
2897                 "Timed out waiting for FTL rebuild to complete (%d secs).\n",
2898                 jiffies_to_msecs(jiffies - start) / 1000);
2899         return -EFAULT;
2900 }
2901
2902 /*
2903  * service thread to issue queued commands
2904  *
2905  * @data Pointer to the driver data structure.
2906  *
2907  * return value
2908  *      0
2909  */
2910
2911 static int mtip_service_thread(void *data)
2912 {
2913         struct driver_data *dd = (struct driver_data *)data;
2914         unsigned long slot, slot_start, slot_wrap;
2915         unsigned int num_cmd_slots = dd->slot_groups * 32;
2916         struct mtip_port *port = dd->port;
2917
2918         while (1) {
2919                 /*
2920                  * the condition is to check neither an internal command is
2921                  * is in progress nor error handling is active
2922                  */
2923                 wait_event_interruptible(port->svc_wait, (port->flags) &&
2924                         !(port->flags & MTIP_PF_PAUSE_IO));
2925
2926                 if (kthread_should_stop())
2927                         break;
2928
2929                 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
2930                                 &dd->dd_flag)))
2931                         break;
2932
2933                 set_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags);
2934                 if (test_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags)) {
2935                         slot = 1;
2936                         /* used to restrict the loop to one iteration */
2937                         slot_start = num_cmd_slots;
2938                         slot_wrap = 0;
2939                         while (1) {
2940                                 slot = find_next_bit(port->cmds_to_issue,
2941                                                 num_cmd_slots, slot);
2942                                 if (slot_wrap == 1) {
2943                                         if ((slot_start >= slot) ||
2944                                                 (slot >= num_cmd_slots))
2945                                                 break;
2946                                 }
2947                                 if (unlikely(slot_start == num_cmd_slots))
2948                                         slot_start = slot;
2949
2950                                 if (unlikely(slot == num_cmd_slots)) {
2951                                         slot = 1;
2952                                         slot_wrap = 1;
2953                                         continue;
2954                                 }
2955
2956                                 /* Issue the command to the hardware */
2957                                 mtip_issue_ncq_command(port, slot);
2958
2959                                 clear_bit(slot, port->cmds_to_issue);
2960                         }
2961
2962                         clear_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags);
2963                 } else if (test_bit(MTIP_PF_REBUILD_BIT, &port->flags)) {
2964                         if (!mtip_ftl_rebuild_poll(dd))
2965                                 set_bit(MTIP_DDF_REBUILD_FAILED_BIT,
2966                                                         &dd->dd_flag);
2967                         clear_bit(MTIP_PF_REBUILD_BIT, &port->flags);
2968                 }
2969                 clear_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags);
2970
2971                 if (test_bit(MTIP_PF_SVC_THD_STOP_BIT, &port->flags))
2972                         break;
2973         }
2974         return 0;
2975 }
2976
2977 /*
2978  * Called once for each card.
2979  *
2980  * @dd Pointer to the driver data structure.
2981  *
2982  * return value
2983  *      0 on success, else an error code.
2984  */
2985 static int mtip_hw_init(struct driver_data *dd)
2986 {
2987         int i;
2988         int rv;
2989         unsigned int num_command_slots;
2990         unsigned long timeout, timetaken;
2991         unsigned char *buf;
2992         struct smart_attr attr242;
2993
2994         dd->mmio = pcim_iomap_table(dd->pdev)[MTIP_ABAR];
2995
2996         mtip_detect_product(dd);
2997         if (dd->product_type == MTIP_PRODUCT_UNKNOWN) {
2998                 rv = -EIO;
2999                 goto out1;
3000         }
3001         num_command_slots = dd->slot_groups * 32;
3002
3003         hba_setup(dd);
3004
3005         tasklet_init(&dd->tasklet, mtip_tasklet, (unsigned long)dd);
3006
3007         dd->port = kzalloc(sizeof(struct mtip_port), GFP_KERNEL);
3008         if (!dd->port) {
3009                 dev_err(&dd->pdev->dev,
3010                         "Memory allocation: port structure\n");
3011                 return -ENOMEM;
3012         }
3013
3014         /* Counting semaphore to track command slot usage */
3015         sema_init(&dd->port->cmd_slot, num_command_slots - 1);
3016
3017         /* Spinlock to prevent concurrent issue */
3018         spin_lock_init(&dd->port->cmd_issue_lock);
3019
3020         /* Set the port mmio base address. */
3021         dd->port->mmio  = dd->mmio + PORT_OFFSET;
3022         dd->port->dd    = dd;
3023
3024         /* Allocate memory for the command list. */
3025         dd->port->command_list =
3026                 dmam_alloc_coherent(&dd->pdev->dev,
3027                         HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
3028                         &dd->port->command_list_dma,
3029                         GFP_KERNEL);
3030         if (!dd->port->command_list) {
3031                 dev_err(&dd->pdev->dev,
3032                         "Memory allocation: command list\n");
3033                 rv = -ENOMEM;
3034                 goto out1;
3035         }
3036
3037         /* Clear the memory we have allocated. */
3038         memset(dd->port->command_list,
3039                 0,
3040                 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4));
3041
3042         /* Setup the addresse of the RX FIS. */
3043         dd->port->rxfis     = dd->port->command_list + HW_CMD_SLOT_SZ;
3044         dd->port->rxfis_dma = dd->port->command_list_dma + HW_CMD_SLOT_SZ;
3045
3046         /* Setup the address of the command tables. */
3047         dd->port->command_table   = dd->port->rxfis + AHCI_RX_FIS_SZ;
3048         dd->port->command_tbl_dma = dd->port->rxfis_dma + AHCI_RX_FIS_SZ;
3049
3050         /* Setup the address of the identify data. */
3051         dd->port->identify     = dd->port->command_table +
3052                                         HW_CMD_TBL_AR_SZ;
3053         dd->port->identify_dma = dd->port->command_tbl_dma +
3054                                         HW_CMD_TBL_AR_SZ;
3055
3056         /* Setup the address of the sector buffer - for some non-ncq cmds */
3057         dd->port->sector_buffer = (void *) dd->port->identify + ATA_SECT_SIZE;
3058         dd->port->sector_buffer_dma = dd->port->identify_dma + ATA_SECT_SIZE;
3059
3060         /* Setup the address of the log buf - for read log command */
3061         dd->port->log_buf = (void *)dd->port->sector_buffer  + ATA_SECT_SIZE;
3062         dd->port->log_buf_dma = dd->port->sector_buffer_dma + ATA_SECT_SIZE;
3063
3064         /* Setup the address of the smart buf - for smart read data command */
3065         dd->port->smart_buf = (void *)dd->port->log_buf  + ATA_SECT_SIZE;
3066         dd->port->smart_buf_dma = dd->port->log_buf_dma + ATA_SECT_SIZE;
3067
3068
3069         /* Point the command headers at the command tables. */
3070         for (i = 0; i < num_command_slots; i++) {
3071                 dd->port->commands[i].command_header =
3072                                         dd->port->command_list +
3073                                         (sizeof(struct mtip_cmd_hdr) * i);
3074                 dd->port->commands[i].command_header_dma =
3075                                         dd->port->command_list_dma +
3076                                         (sizeof(struct mtip_cmd_hdr) * i);
3077
3078                 dd->port->commands[i].command =
3079                         dd->port->command_table + (HW_CMD_TBL_SZ * i);
3080                 dd->port->commands[i].command_dma =
3081                         dd->port->command_tbl_dma + (HW_CMD_TBL_SZ * i);
3082
3083                 if (readl(dd->mmio + HOST_CAP) & HOST_CAP_64)
3084                         dd->port->commands[i].command_header->ctbau =
3085                         __force_bit2int cpu_to_le32(
3086                         (dd->port->commands[i].command_dma >> 16) >> 16);
3087                 dd->port->commands[i].command_header->ctba =
3088                         __force_bit2int cpu_to_le32(
3089                         dd->port->commands[i].command_dma & 0xFFFFFFFF);
3090
3091                 /*
3092                  * If this is not done, a bug is reported by the stock
3093                  * FC11 i386. Due to the fact that it has lots of kernel
3094                  * debugging enabled.
3095                  */
3096                 sg_init_table(dd->port->commands[i].sg, MTIP_MAX_SG);
3097
3098                 /* Mark all commands as currently inactive.*/
3099                 atomic_set(&dd->port->commands[i].active, 0);
3100         }
3101
3102         /* Setup the pointers to the extended s_active and CI registers. */
3103         for (i = 0; i < dd->slot_groups; i++) {
3104                 dd->port->s_active[i] =
3105                         dd->port->mmio + i*0x80 + PORT_SCR_ACT;
3106                 dd->port->cmd_issue[i] =
3107                         dd->port->mmio + i*0x80 + PORT_COMMAND_ISSUE;
3108                 dd->port->completed[i] =
3109                         dd->port->mmio + i*0x80 + PORT_SDBV;
3110         }
3111
3112         timetaken = jiffies;
3113         timeout = jiffies + msecs_to_jiffies(30000);
3114         while (((readl(dd->port->mmio + PORT_SCR_STAT) & 0x0F) != 0x03) &&
3115                  time_before(jiffies, timeout)) {
3116                 mdelay(100);
3117         }
3118         if (unlikely(mtip_check_surprise_removal(dd->pdev))) {
3119                 timetaken = jiffies - timetaken;
3120                 dev_warn(&dd->pdev->dev,
3121                         "Surprise removal detected at %u ms\n",
3122                         jiffies_to_msecs(timetaken));
3123                 rv = -ENODEV;
3124                 goto out2 ;
3125         }
3126         if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))) {
3127                 timetaken = jiffies - timetaken;
3128                 dev_warn(&dd->pdev->dev,
3129                         "Removal detected at %u ms\n",
3130                         jiffies_to_msecs(timetaken));
3131                 rv = -EFAULT;
3132                 goto out2;
3133         }
3134
3135         /* Conditionally reset the HBA. */
3136         if (!(readl(dd->mmio + HOST_CAP) & HOST_CAP_NZDMA)) {
3137                 if (mtip_hba_reset(dd) < 0) {
3138                         dev_err(&dd->pdev->dev,
3139                                 "Card did not reset within timeout\n");
3140                         rv = -EIO;
3141                         goto out2;
3142                 }
3143         } else {
3144                 /* Clear any pending interrupts on the HBA */
3145                 writel(readl(dd->mmio + HOST_IRQ_STAT),
3146                         dd->mmio + HOST_IRQ_STAT);
3147         }
3148
3149         mtip_init_port(dd->port);
3150         mtip_start_port(dd->port);
3151
3152         /* Setup the ISR and enable interrupts. */
3153         rv = devm_request_irq(&dd->pdev->dev,
3154                                 dd->pdev->irq,
3155                                 mtip_irq_handler,
3156                                 IRQF_SHARED,
3157                                 dev_driver_string(&dd->pdev->dev),
3158                                 dd);
3159
3160         if (rv) {
3161                 dev_err(&dd->pdev->dev,
3162                         "Unable to allocate IRQ %d\n", dd->pdev->irq);
3163                 goto out2;
3164         }
3165
3166         /* Enable interrupts on the HBA. */
3167         writel(readl(dd->mmio + HOST_CTL) | HOST_IRQ_EN,
3168                                         dd->mmio + HOST_CTL);
3169
3170         init_timer(&dd->port->cmd_timer);
3171         init_waitqueue_head(&dd->port->svc_wait);
3172
3173         dd->port->cmd_timer.data = (unsigned long int) dd->port;
3174         dd->port->cmd_timer.function = mtip_timeout_function;
3175         mod_timer(&dd->port->cmd_timer,
3176                 jiffies + msecs_to_jiffies(MTIP_TIMEOUT_CHECK_PERIOD));
3177
3178
3179         if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)) {
3180                 rv = -EFAULT;
3181                 goto out3;
3182         }
3183
3184         if (mtip_get_identify(dd->port, NULL) < 0) {
3185                 rv = -EFAULT;
3186                 goto out3;
3187         }
3188
3189         if (*(dd->port->identify + MTIP_FTL_REBUILD_OFFSET) ==
3190                 MTIP_FTL_REBUILD_MAGIC) {
3191                 set_bit(MTIP_PF_REBUILD_BIT, &dd->port->flags);
3192                 return MTIP_FTL_REBUILD_MAGIC;
3193         }
3194         mtip_dump_identify(dd->port);
3195
3196         /* check write protect, over temp and rebuild statuses */
3197         rv = mtip_read_log_page(dd->port, ATA_LOG_SATA_NCQ,
3198                                 dd->port->log_buf,
3199                                 dd->port->log_buf_dma, 1);
3200         if (rv) {
3201                 dev_warn(&dd->pdev->dev,
3202                         "Error in READ LOG EXT (10h) command\n");
3203                 /* non-critical error, don't fail the load */
3204         } else {
3205                 buf = (unsigned char *)dd->port->log_buf;
3206                 if (buf[259] & 0x1) {
3207                         dev_info(&dd->pdev->dev,
3208                                 "Write protect bit is set.\n");
3209                         set_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag);
3210                 }
3211                 if (buf[288] == 0xF7) {
3212                         dev_info(&dd->pdev->dev,
3213                                 "Exceeded Tmax, drive in thermal shutdown.\n");
3214                         set_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag);
3215                 }
3216                 if (buf[288] == 0xBF) {
3217                         dev_info(&dd->pdev->dev,
3218                                 "Drive indicates rebuild has failed.\n");
3219                         /* TODO */
3220                 }
3221         }
3222
3223         /* get write protect progess */
3224         memset(&attr242, 0, sizeof(struct smart_attr));
3225         if (mtip_get_smart_attr(dd->port, 242, &attr242))
3226                 dev_warn(&dd->pdev->dev,
3227                                 "Unable to check write protect progress\n");
3228         else
3229                 dev_info(&dd->pdev->dev,
3230                                 "Write protect progress: %u%% (%u blocks)\n",
3231                                 attr242.cur, le32_to_cpu(attr242.data));
3232         return rv;
3233
3234 out3:
3235         del_timer_sync(&dd->port->cmd_timer);
3236
3237         /* Disable interrupts on the HBA. */
3238         writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3239                         dd->mmio + HOST_CTL);
3240
3241         /*Release the IRQ. */
3242         devm_free_irq(&dd->pdev->dev, dd->pdev->irq, dd);
3243
3244 out2:
3245         mtip_deinit_port(dd->port);
3246
3247         /* Free the command/command header memory. */
3248         dmam_free_coherent(&dd->pdev->dev,
3249                                 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
3250                                 dd->port->command_list,
3251                                 dd->port->command_list_dma);
3252 out1:
3253         /* Free the memory allocated for the for structure. */
3254         kfree(dd->port);
3255
3256         return rv;
3257 }
3258
3259 /*
3260  * Called to deinitialize an interface.
3261  *
3262  * @dd Pointer to the driver data structure.
3263  *
3264  * return value
3265  *      0
3266  */
3267 static int mtip_hw_exit(struct driver_data *dd)
3268 {
3269         /*
3270          * Send standby immediate (E0h) to the drive so that it
3271          * saves its state.
3272          */
3273         if (!test_bit(MTIP_DDF_CLEANUP_BIT, &dd->dd_flag)) {
3274
3275                 if (!test_bit(MTIP_PF_REBUILD_BIT, &dd->port->flags))
3276                         if (mtip_standby_immediate(dd->port))
3277                                 dev_warn(&dd->pdev->dev,
3278                                         "STANDBY IMMEDIATE failed\n");
3279
3280                 /* de-initialize the port. */
3281                 mtip_deinit_port(dd->port);
3282
3283                 /* Disable interrupts on the HBA. */
3284                 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3285                                 dd->mmio + HOST_CTL);
3286         }
3287
3288         del_timer_sync(&dd->port->cmd_timer);
3289
3290         /* Release the IRQ. */
3291         devm_free_irq(&dd->pdev->dev, dd->pdev->irq, dd);
3292
3293         /* Stop the bottom half tasklet. */
3294         tasklet_kill(&dd->tasklet);
3295
3296         /* Free the command/command header memory. */
3297         dmam_free_coherent(&dd->pdev->dev,
3298                         HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
3299                         dd->port->command_list,
3300                         dd->port->command_list_dma);
3301         /* Free the memory allocated for the for structure. */
3302         kfree(dd->port);
3303
3304         return 0;
3305 }
3306
3307 /*
3308  * Issue a Standby Immediate command to the device.
3309  *
3310  * This function is called by the Block Layer just before the
3311  * system powers off during a shutdown.
3312  *
3313  * @dd Pointer to the driver data structure.
3314  *
3315  * return value
3316  *      0
3317  */
3318 static int mtip_hw_shutdown(struct driver_data *dd)
3319 {
3320         /*
3321          * Send standby immediate (E0h) to the drive so that it
3322          * saves its state.
3323          */
3324         mtip_standby_immediate(dd->port);
3325
3326         return 0;
3327 }
3328
3329 /*
3330  * Suspend function
3331  *
3332  * This function is called by the Block Layer just before the
3333  * system hibernates.
3334  *
3335  * @dd Pointer to the driver data structure.
3336  *
3337  * return value
3338  *      0       Suspend was successful
3339  *      -EFAULT Suspend was not successful
3340  */
3341 static int mtip_hw_suspend(struct driver_data *dd)
3342 {
3343         /*
3344          * Send standby immediate (E0h) to the drive
3345          * so that it saves its state.
3346          */
3347         if (mtip_standby_immediate(dd->port) != 0) {
3348                 dev_err(&dd->pdev->dev,
3349                         "Failed standby-immediate command\n");
3350                 return -EFAULT;
3351         }
3352
3353         /* Disable interrupts on the HBA.*/
3354         writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3355                         dd->mmio + HOST_CTL);
3356         mtip_deinit_port(dd->port);
3357
3358         return 0;
3359 }
3360
3361 /*
3362  * Resume function
3363  *
3364  * This function is called by the Block Layer as the
3365  * system resumes.
3366  *
3367  * @dd Pointer to the driver data structure.
3368  *
3369  * return value
3370  *      0       Resume was successful
3371  *      -EFAULT Resume was not successful
3372  */
3373 static int mtip_hw_resume(struct driver_data *dd)
3374 {
3375         /* Perform any needed hardware setup steps */
3376         hba_setup(dd);
3377
3378         /* Reset the HBA */
3379         if (mtip_hba_reset(dd) != 0) {
3380                 dev_err(&dd->pdev->dev,
3381                         "Unable to reset the HBA\n");
3382                 return -EFAULT;
3383         }
3384
3385         /*
3386          * Enable the port, DMA engine, and FIS reception specific
3387          * h/w in controller.
3388          */
3389         mtip_init_port(dd->port);
3390         mtip_start_port(dd->port);
3391
3392         /* Enable interrupts on the HBA.*/
3393         writel(readl(dd->mmio + HOST_CTL) | HOST_IRQ_EN,
3394                         dd->mmio + HOST_CTL);
3395
3396         return 0;
3397 }
3398
3399 /*
3400  * Helper function for reusing disk name
3401  * upon hot insertion.
3402  */
3403 static int rssd_disk_name_format(char *prefix,
3404                                  int index,
3405                                  char *buf,
3406                                  int buflen)
3407 {
3408         const int base = 'z' - 'a' + 1;
3409         char *begin = buf + strlen(prefix);
3410         char *end = buf + buflen;
3411         char *p;
3412         int unit;
3413
3414         p = end - 1;
3415         *p = '\0';
3416         unit = base;
3417         do {
3418                 if (p == begin)
3419                         return -EINVAL;
3420                 *--p = 'a' + (index % unit);
3421                 index = (index / unit) - 1;
3422         } while (index >= 0);
3423
3424         memmove(begin, p, end - p);
3425         memcpy(buf, prefix, strlen(prefix));
3426
3427         return 0;
3428 }
3429
3430 /*
3431  * Block layer IOCTL handler.
3432  *
3433  * @dev Pointer to the block_device structure.
3434  * @mode ignored
3435  * @cmd IOCTL command passed from the user application.
3436  * @arg Argument passed from the user application.
3437  *
3438  * return value
3439  *      0        IOCTL completed successfully.
3440  *      -ENOTTY  IOCTL not supported or invalid driver data
3441  *                 structure pointer.
3442  */
3443 static int mtip_block_ioctl(struct block_device *dev,
3444                             fmode_t mode,
3445                             unsigned cmd,
3446                             unsigned long arg)
3447 {
3448         struct driver_data *dd = dev->bd_disk->private_data;
3449
3450         if (!capable(CAP_SYS_ADMIN))
3451                 return -EACCES;
3452
3453         if (!dd)
3454                 return -ENOTTY;
3455
3456         if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)))
3457                 return -ENOTTY;
3458
3459         switch (cmd) {
3460         case BLKFLSBUF:
3461                 return -ENOTTY;
3462         default:
3463                 return mtip_hw_ioctl(dd, cmd, arg);
3464         }
3465 }
3466
3467 #ifdef CONFIG_COMPAT
3468 /*
3469  * Block layer compat IOCTL handler.
3470  *
3471  * @dev Pointer to the block_device structure.
3472  * @mode ignored
3473  * @cmd IOCTL command passed from the user application.
3474  * @arg Argument passed from the user application.
3475  *
3476  * return value
3477  *      0        IOCTL completed successfully.
3478  *      -ENOTTY  IOCTL not supported or invalid driver data
3479  *                 structure pointer.
3480  */
3481 static int mtip_block_compat_ioctl(struct block_device *dev,
3482                             fmode_t mode,
3483                             unsigned cmd,
3484                             unsigned long arg)
3485 {
3486         struct driver_data *dd = dev->bd_disk->private_data;
3487
3488         if (!capable(CAP_SYS_ADMIN))
3489                 return -EACCES;
3490
3491         if (!dd)
3492                 return -ENOTTY;
3493
3494         if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)))
3495                 return -ENOTTY;
3496
3497         switch (cmd) {
3498         case BLKFLSBUF:
3499                 return -ENOTTY;
3500         case HDIO_DRIVE_TASKFILE: {
3501                 struct mtip_compat_ide_task_request_s __user *compat_req_task;
3502                 ide_task_request_t req_task;
3503                 int compat_tasksize, outtotal, ret;
3504
3505                 compat_tasksize =
3506                         sizeof(struct mtip_compat_ide_task_request_s);
3507
3508                 compat_req_task =
3509                         (struct mtip_compat_ide_task_request_s __user *) arg;
3510
3511                 if (copy_from_user(&req_task, (void __user *) arg,
3512                         compat_tasksize - (2 * sizeof(compat_long_t))))
3513                         return -EFAULT;
3514
3515                 if (get_user(req_task.out_size, &compat_req_task->out_size))
3516                         return -EFAULT;
3517
3518                 if (get_user(req_task.in_size, &compat_req_task->in_size))
3519                         return -EFAULT;
3520
3521                 outtotal = sizeof(struct mtip_compat_ide_task_request_s);
3522
3523                 ret = exec_drive_taskfile(dd, (void __user *) arg,
3524                                                 &req_task, outtotal);
3525
3526                 if (copy_to_user((void __user *) arg, &req_task,
3527                                 compat_tasksize -
3528                                 (2 * sizeof(compat_long_t))))
3529                         return -EFAULT;
3530
3531                 if (put_user(req_task.out_size, &compat_req_task->out_size))
3532                         return -EFAULT;
3533
3534                 if (put_user(req_task.in_size, &compat_req_task->in_size))
3535                         return -EFAULT;
3536
3537                 return ret;
3538         }
3539         default:
3540                 return mtip_hw_ioctl(dd, cmd, arg);
3541         }
3542 }
3543 #endif
3544
3545 /*
3546  * Obtain the geometry of the device.
3547  *
3548  * You may think that this function is obsolete, but some applications,
3549  * fdisk for example still used CHS values. This function describes the
3550  * device as having 224 heads and 56 sectors per cylinder. These values are
3551  * chosen so that each cylinder is aligned on a 4KB boundary. Since a
3552  * partition is described in terms of a start and end cylinder this means
3553  * that each partition is also 4KB aligned. Non-aligned partitions adversely
3554  * affects performance.
3555  *
3556  * @dev Pointer to the block_device strucutre.
3557  * @geo Pointer to a hd_geometry structure.
3558  *
3559  * return value
3560  *      0       Operation completed successfully.
3561  *      -ENOTTY An error occurred while reading the drive capacity.
3562  */
3563 static int mtip_block_getgeo(struct block_device *dev,
3564                                 struct hd_geometry *geo)
3565 {
3566         struct driver_data *dd = dev->bd_disk->private_data;
3567         sector_t capacity;
3568
3569         if (!dd)
3570                 return -ENOTTY;
3571
3572         if (!(mtip_hw_get_capacity(dd, &capacity))) {
3573                 dev_warn(&dd->pdev->dev,
3574                         "Could not get drive capacity.\n");
3575                 return -ENOTTY;
3576         }
3577
3578         geo->heads = 224;
3579         geo->sectors = 56;
3580         sector_div(capacity, (geo->heads * geo->sectors));
3581         geo->cylinders = capacity;
3582         return 0;
3583 }
3584
3585 /*
3586  * Block device operation function.
3587  *
3588  * This structure contains pointers to the functions required by the block
3589  * layer.
3590  */
3591 static const struct block_device_operations mtip_block_ops = {
3592         .ioctl          = mtip_block_ioctl,
3593 #ifdef CONFIG_COMPAT
3594         .compat_ioctl   = mtip_block_compat_ioctl,
3595 #endif
3596         .getgeo         = mtip_block_getgeo,
3597         .owner          = THIS_MODULE
3598 };
3599
3600 /*
3601  * Block layer make request function.
3602  *
3603  * This function is called by the kernel to process a BIO for
3604  * the P320 device.
3605  *
3606  * @queue Pointer to the request queue. Unused other than to obtain
3607  *              the driver data structure.
3608  * @bio   Pointer to the BIO.
3609  *
3610  */
3611 static void mtip_make_request(struct request_queue *queue, struct bio *bio)
3612 {
3613         struct driver_data *dd = queue->queuedata;
3614         struct scatterlist *sg;
3615         struct bio_vec *bvec;
3616         int nents = 0;
3617         int tag = 0;
3618
3619         if (unlikely(dd->dd_flag & MTIP_DDF_STOP_IO)) {
3620                 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
3621                                                         &dd->dd_flag))) {
3622                         bio_endio(bio, -ENXIO);
3623                         return;
3624                 }
3625                 if (unlikely(test_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag))) {
3626                         bio_endio(bio, -ENODATA);
3627                         return;
3628                 }
3629                 if (unlikely(test_bit(MTIP_DDF_WRITE_PROTECT_BIT,
3630                                                         &dd->dd_flag) &&
3631                                 bio_data_dir(bio))) {
3632                         bio_endio(bio, -ENODATA);
3633                         return;
3634                 }
3635                 if (unlikely(test_bit(MTIP_DDF_SEC_LOCK_BIT, &dd->dd_flag))) {
3636                         bio_endio(bio, -ENODATA);
3637                         return;
3638                 }
3639         }
3640
3641         if (unlikely(!bio_has_data(bio))) {
3642                 blk_queue_flush(queue, 0);
3643                 bio_endio(bio, 0);
3644                 return;
3645         }
3646
3647         sg = mtip_hw_get_scatterlist(dd, &tag);
3648         if (likely(sg != NULL)) {
3649                 blk_queue_bounce(queue, &bio);
3650
3651                 if (unlikely((bio)->bi_vcnt > MTIP_MAX_SG)) {
3652                         dev_warn(&dd->pdev->dev,
3653                                 "Maximum number of SGL entries exceeded\n");
3654                         bio_io_error(bio);
3655                         mtip_hw_release_scatterlist(dd, tag);
3656                         return;