blob: f946d31d6917e00aa0637df5d21cef35ebf82845 [file] [log] [blame]
Sam Bradshaw88523a62011-08-30 08:34:26 -06001/*
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>
Jens Axboe0e838c62011-09-28 07:35:40 -060031#include <linux/module.h>
Sam Bradshaw88523a62011-08-30 08:34:26 -060032#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>
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +010037#include <linux/kthread.h>
Sam Bradshaw88523a62011-08-30 08:34:26 -060038#include <../drivers/ata/ahci.h>
Asai Thambi S P45038362012-04-09 08:35:38 +020039#include <linux/export.h>
Asai Thambi S P7b421d22012-06-04 12:44:02 -070040#include <linux/debugfs.h>
Sam Bradshaw88523a62011-08-30 08:34:26 -060041#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
Asai Thambi S P45038362012-04-09 08:35:38 +020049#define HOST_CAP_NZDMA (1 << 19)
Sam Bradshaw88523a62011-08-30 08:34:26 -060050#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. */
82static int instance;
83
84/*
85 * Global variable used to hold the major block device number
86 * allocated in mtip_init().
87 */
Jens Axboe3ff147d2011-09-27 21:33:53 -060088static int mtip_major;
Asai Thambi S P7b421d22012-06-04 12:44:02 -070089static struct dentry *dfs_parent;
Sam Bradshaw88523a62011-08-30 08:34:26 -060090
91static DEFINE_SPINLOCK(rssd_index_lock);
92static DEFINE_IDA(rssd_index_ida);
93
Asai Thambi S P62ee8c12012-01-04 22:01:32 +010094static int mtip_block_initialize(struct driver_data *dd);
95
Jens Axboe16d02c02011-09-27 15:50:01 -060096#ifdef CONFIG_COMPAT
Sam Bradshaw88523a62011-08-30 08:34:26 -060097struct 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};
Jens Axboe16d02c02011-09-27 15:50:01 -0600107#endif
Sam Bradshaw88523a62011-08-30 08:34:26 -0600108
Sam Bradshaw88523a62011-08-30 08:34:26 -0600109/*
Jens Axboe63166682011-09-27 21:27:43 -0600110 * 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 */
119static 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 */
141static 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;
Asai Thambi S P45038362012-04-09 08:35:38 +0200146 static int in_progress;
147
148 if (in_progress)
149 return;
150
151 in_progress = 1;
Jens Axboe63166682011-09-27 21:27:43 -0600152
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
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200178 set_bit(MTIP_DDF_CLEANUP_BIT, &dd->dd_flag);
Asai Thambi S P45038362012-04-09 08:35:38 +0200179 in_progress = 0;
Jens Axboe63166682011-09-27 21:27:43 -0600180}
181
182/*
Sam Bradshaw88523a62011-08-30 08:34:26 -0600183 * 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 */
195static 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 */
234static 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/*
Jens Axboe63166682011-09-27 21:27:43 -0600242 * 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 */
253static 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
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200276 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))
Asai Thambi S P45038362012-04-09 08:35:38 +0200277 return -1;
278
Jens Axboe63166682011-09-27 21:27:43 -0600279 if (readl(dd->mmio + HOST_CTL) & HOST_RESET)
280 return -1;
281
282 return 0;
283}
284
285/*
Sam Bradshaw88523a62011-08-30 08:34:26 -0600286 * 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 */
297static inline void mtip_issue_ncq_command(struct mtip_port *port, int tag)
298{
Sam Bradshaw88523a62011-08-30 08:34:26 -0600299 atomic_set(&port->commands[tag].active, 1);
300
Asai Thambi S P0a07ab22012-05-29 18:43:16 -0700301 spin_lock(&port->cmd_issue_lock);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600302
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
Asai Thambi S P0a07ab22012-05-29 18:43:16 -0700308 spin_unlock(&port->cmd_issue_lock);
Asai Thambi S Pdad40f12012-04-09 08:35:38 +0200309
310 /* Set the command's timeout value.*/
311 port->commands[tag].comp_time = jiffies + msecs_to_jiffies(
312 MTIP_NCQ_COMMAND_TIMEOUT_MS);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600313}
314
315/*
Jens Axboe63166682011-09-27 21:27:43 -0600316 * 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 */
324static 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 */
350static 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 */
371static 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 */
389static 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 */
414static 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
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +0100427 writel(port->command_list_dma & 0xFFFFFFFF,
Jens Axboe63166682011-09-27 21:27:43 -0600428 port->mmio + PORT_LST_ADDR);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +0100429 writel(port->rxfis_dma & 0xFFFFFFFF, port->mmio + PORT_FIS_ADDR);
Jens Axboe63166682011-09-27 21:27:43 -0600430
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 */
Asai Thambi S P6bb688c2012-05-29 18:40:45 -0700439 writel(readl(port->mmio + PORT_IRQ_STAT), port->mmio + PORT_IRQ_STAT);
Jens Axboe63166682011-09-27 21:27:43 -0600440
Asai Thambi S P22be2e62012-03-23 12:33:03 +0100441 /* Clear any pending interrupts on the HBA. */
442 writel(readl(port->dd->mmio + HOST_IRQ_STAT),
443 port->dd->mmio + HOST_IRQ_STAT);
444
Jens Axboe63166682011-09-27 21:27:43 -0600445 /* 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 */
457static 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
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200470 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
Asai Thambi S P45038362012-04-09 08:35:38 +0200471 return;
472
Jens Axboe63166682011-09-27 21:27:43 -0600473 /*
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
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200501 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
Asai Thambi S P45038362012-04-09 08:35:38 +0200502 return;
503
Jens Axboe63166682011-09-27 21:27:43 -0600504 /* 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
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200515 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
Asai Thambi S P45038362012-04-09 08:35:38 +0200516 return;
517
Jens Axboe63166682011-09-27 21:27:43 -0600518 if ((readl(port->mmio + PORT_SCR_STAT) & 0x01) == 0)
519 dev_warn(&port->dd->pdev->dev,
520 "COM reset failed\n");
521
Asai Thambi S P22be2e62012-03-23 12:33:03 +0100522 mtip_init_port(port);
523 mtip_start_port(port);
Jens Axboe63166682011-09-27 21:27:43 -0600524
Jens Axboe63166682011-09-27 21:27:43 -0600525}
526
527/*
Asai Thambi S P95fea2f2012-04-09 08:35:39 +0200528 * Helper function for tag logging
529 */
530static 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/*
Sam Bradshaw88523a62011-08-30 08:34:26 -0600547 * 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 */
Jens Axboe63166682011-09-27 21:27:43 -0600555static void mtip_timeout_function(unsigned long int data)
Sam Bradshaw88523a62011-08-30 08:34:26 -0600556{
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;
Asai Thambi S P95fea2f2012-04-09 08:35:39 +0200563 unsigned long to, tagaccum[SLOTBITS_IN_LONGS];
Sam Bradshaw88523a62011-08-30 08:34:26 -0600564
565 if (unlikely(!port))
566 return;
567
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200568 if (test_bit(MTIP_DDF_RESUME_BIT, &port->dd->dd_flag)) {
Sam Bradshaw88523a62011-08-30 08:34:26 -0600569 mod_timer(&port->cmd_timer,
570 jiffies + msecs_to_jiffies(30000));
571 return;
572 }
Asai Thambi S P95fea2f2012-04-09 08:35:39 +0200573 /* clear the tag accumulator */
574 memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
Sam Bradshaw88523a62011-08-30 08:34:26 -0600575
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;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +0100587 bit = tag & 0x1F;
Sam Bradshaw88523a62011-08-30 08:34:26 -0600588
589 command = &port->commands[tag];
590 fis = (struct host_to_dev_fis *) command->command;
591
Asai Thambi S P95fea2f2012-04-09 08:35:39 +0200592 set_bit(tag, tagaccum);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600593 cmdto_cnt++;
594 if (cmdto_cnt == 1)
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200595 set_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600596
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
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +0200628 if (cmdto_cnt && !test_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags)) {
Asai Thambi S P95fea2f2012-04-09 08:35:39 +0200629 print_tags(port->dd, "timed out", tagaccum, cmdto_cnt);
630
Sam Bradshaw88523a62011-08-30 08:34:26 -0600631 mtip_restart_port(port);
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200632 clear_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +0100633 wake_up_interruptible(&port->svc_wait);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600634 }
635
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +0200636 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
Sam Bradshaw88523a62011-08-30 08:34:26 -0600651 /* 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 */
674static 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 */
728static 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
Asai Thambi S P8182b492012-04-09 08:35:38 +0200745static void mtip_null_completion(struct mtip_port *port,
746 int tag,
747 void *data,
748 int status)
749{
750 return;
751}
752
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200753static int mtip_read_log_page(struct mtip_port *port, u8 page, u16 *buffer,
754 dma_addr_t buffer_dma, unsigned int sectors);
755static int mtip_get_smart_attr(struct mtip_port *port, unsigned int id,
756 struct smart_attr *attrib);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600757/*
758 * Handle an error.
759 *
760 * @dd Pointer to the DRIVER_DATA structure.
761 *
762 * return value
763 * None
764 */
765static void mtip_handle_tfe(struct driver_data *dd)
766{
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200767 int group, tag, bit, reissue, rv;
Sam Bradshaw88523a62011-08-30 08:34:26 -0600768 struct mtip_port *port;
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200769 struct mtip_cmd *cmd;
Sam Bradshaw88523a62011-08-30 08:34:26 -0600770 u32 completed;
771 struct host_to_dev_fis *fis;
772 unsigned long tagaccum[SLOTBITS_IN_LONGS];
Asai Thambi S P95fea2f2012-04-09 08:35:39 +0200773 unsigned int cmd_cnt = 0;
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200774 unsigned char *buf;
775 char *fail_reason = NULL;
776 int fail_all_ncq_write = 0, fail_all_ncq_cmds = 0;
Sam Bradshaw88523a62011-08-30 08:34:26 -0600777
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);
Asai Thambi S Pd02e1f02012-05-29 18:42:27 -0700784 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 }
Sam Bradshaw88523a62011-08-30 08:34:26 -0600798
Asai Thambi S P95fea2f2012-04-09 08:35:39 +0200799 /* clear the tag accumulator */
800 memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
801
Sam Bradshaw88523a62011-08-30 08:34:26 -0600802 /* 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
Sam Bradshaw88523a62011-08-30 08:34:26 -0600809 /* 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
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200819 cmd = &port->commands[tag];
820 if (likely(cmd->comp_func)) {
Sam Bradshaw88523a62011-08-30 08:34:26 -0600821 set_bit(tag, tagaccum);
Asai Thambi S P95fea2f2012-04-09 08:35:39 +0200822 cmd_cnt++;
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200823 atomic_set(&cmd->active, 0);
824 cmd->comp_func(port,
Sam Bradshaw88523a62011-08-30 08:34:26 -0600825 tag,
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200826 cmd->comp_data,
Sam Bradshaw88523a62011-08-30 08:34:26 -0600827 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 }
Asai Thambi S P95fea2f2012-04-09 08:35:39 +0200840
841 print_tags(dd, "completed (TFE)", tagaccum, cmd_cnt);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600842
843 /* Restart the port */
844 mdelay(20);
845 mtip_restart_port(port);
846
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200847 /* 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");
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200860 set_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag);
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200861 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");
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200867 set_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag);
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200868 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
Sam Bradshaw88523a62011-08-30 08:34:26 -0600879 /* 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;
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200887 cmd = &port->commands[tag];
Sam Bradshaw88523a62011-08-30 08:34:26 -0600888
889 /* If the active bit is set re-issue the command */
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200890 if (atomic_read(&cmd->active) == 0)
Sam Bradshaw88523a62011-08-30 08:34:26 -0600891 continue;
892
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200893 fis = (struct host_to_dev_fis *)cmd->command;
Sam Bradshaw88523a62011-08-30 08:34:26 -0600894
895 /* Should re-issue? */
896 if (tag == MTIP_TAG_INTERNAL ||
897 fis->command == ATA_CMD_SET_FEATURES)
898 reissue = 0;
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200899 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 }
Sam Bradshaw88523a62011-08-30 08:34:26 -0600919
920 /*
921 * First check if this command has
922 * exceeded its retries.
923 */
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200924 if (reissue && (cmd->retries-- > 0)) {
Sam Bradshaw88523a62011-08-30 08:34:26 -0600925
926 set_bit(tag, tagaccum);
927
Sam Bradshaw88523a62011-08-30 08:34:26 -0600928 /* 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);
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200937 atomic_set(&cmd->active, 0);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600938
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200939 if (cmd->comp_func)
940 cmd->comp_func(
Sam Bradshaw88523a62011-08-30 08:34:26 -0600941 port,
942 tag,
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200943 cmd->comp_data,
Sam Bradshaw88523a62011-08-30 08:34:26 -0600944 PORT_IRQ_TF_ERR);
945 else
946 dev_warn(&port->dd->pdev->dev,
947 "Bad completion for tag %d\n",
948 tag);
949 }
950 }
Asai Thambi S P95fea2f2012-04-09 08:35:39 +0200951 print_tags(dd, "reissued (TFE)", tagaccum, cmd_cnt);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600952
Asai Thambi S Pd02e1f02012-05-29 18:42:27 -0700953handle_tfe_exit:
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +0100954 /* clear eh_active */
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200955 clear_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +0100956 wake_up_interruptible(&port->svc_wait);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600957
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 */
965static 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]);
Asai Thambi S P377b8fc62012-05-29 18:44:01 -0700975 if (!completed)
976 continue;
Sam Bradshaw88523a62011-08-30 08:34:26 -0600977
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];
Sam Bradshaw88523a62011-08-30 08:34:26 -0600993 /* 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 */
1020static 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
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001025 if (test_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags) &&
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001026 (cmd != NULL) && !(readl(port->cmd_issue[MTIP_TAG_INTERNAL])
Sam Bradshaw88523a62011-08-30 08:34:26 -06001027 & (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
Sam Bradshaw88523a62011-08-30 08:34:26 -06001037 return;
1038}
1039
1040/*
1041 * Demux and handle errors
1042 */
1043static 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
1067static 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 }
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001092 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
Asai Thambi S P45038362012-04-09 08:35:38 +02001093 &dd->dd_flag))
1094 return rv;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001095
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 */
1113static 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 */
1128static 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
1135static 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
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001142static 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
Asai Thambi S P12a166c2012-09-05 22:01:36 +05301151 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))
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001155 return false;
1156
1157 if (fis->command == ATA_CMD_SEC_ERASE_PREP) {
1158 set_bit(MTIP_PF_SE_ACTIVE_BIT, &port->flags);
Asai Thambi S P12a166c2012-09-05 22:01:36 +05301159 set_bit(MTIP_DDF_SEC_LOCK_BIT, &port->dd->dd_flag);
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001160 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
Sam Bradshaw88523a62011-08-30 08:34:26 -06001179/*
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 */
1189static int mtip_quiesce_io(struct mtip_port *port, unsigned long timeout)
1190{
1191 unsigned long to;
Dan Carpenter3e54a3d2011-11-24 12:59:00 +01001192 unsigned int n;
1193 unsigned int active = 1;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001194
1195 to = jiffies + msecs_to_jiffies(timeout);
1196 do {
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001197 if (test_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags) &&
1198 test_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags)) {
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001199 msleep(20);
1200 continue; /* svc thd is actively issuing commands */
1201 }
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001202 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
Asai Thambi S P45038362012-04-09 08:35:38 +02001203 return -EFAULT;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001204 /*
1205 * Ignore s_active bit 0 of array element 0.
1206 * This bit will always be set
1207 */
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001208 active = readl(port->s_active[0]) & 0xFFFFFFFE;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001209 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.
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001226 * @fis_len Length in WORDS of the FIS.
Sam Bradshaw88523a62011-08-30 08:34:26 -06001227 * @buffer DMA accessible for command data.
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001228 * @buf_len Length, in bytes, of the data buffer.
Sam Bradshaw88523a62011-08-30 08:34:26 -06001229 * @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 */
1239static int mtip_exec_internal_command(struct mtip_port *port,
Asai Thambi S P8182b492012-04-09 08:35:38 +02001240 struct host_to_dev_fis *fis,
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001241 int fis_len,
Sam Bradshaw88523a62011-08-30 08:34:26 -06001242 dma_addr_t buffer,
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001243 int buf_len,
Sam Bradshaw88523a62011-08-30 08:34:26 -06001244 u32 opts,
1245 gfp_t atomic,
1246 unsigned long timeout)
1247{
1248 struct mtip_cmd_sg *command_sg;
1249 DECLARE_COMPLETION_ONSTACK(wait);
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001250 int rv = 0, ready2go = 1;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001251 struct mtip_cmd *int_cmd = &port->commands[MTIP_TAG_INTERNAL];
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001252 unsigned long to;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001253
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
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001261 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) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06001270 dev_warn(&port->dd->pdev->dev,
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001271 "Internal cmd active. new cmd [%02X]\n", fis->command);
Sam Bradshaw88523a62011-08-30 08:34:26 -06001272 return -EBUSY;
1273 }
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001274 set_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001275 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);
Sam Bradshaw88523a62011-08-30 08:34:26 -06001281
1282 if (atomic == GFP_KERNEL) {
Asai Thambi S P8182b492012-04-09 08:35:38 +02001283 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);
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001289 clear_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
Asai Thambi S P8182b492012-04-09 08:35:38 +02001290 wake_up_interruptible(&port->svc_wait);
1291 return -EBUSY;
1292 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06001293 }
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;
Asai Thambi S P8182b492012-04-09 08:35:38 +02001302 int_cmd->comp_func = mtip_null_completion;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001303 }
1304
1305 /* Copy the command to the command table */
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001306 memcpy(int_cmd->command, fis, fis_len*4);
Sam Bradshaw88523a62011-08-30 08:34:26 -06001307
1308 /* Populate the SG list */
1309 int_cmd->command_header->opts =
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001310 __force_bit2int cpu_to_le32(opts | fis_len);
1311 if (buf_len) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06001312 command_sg = int_cmd->command + AHCI_CMD_TBL_HDR_SZ;
1313
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001314 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);
Sam Bradshaw88523a62011-08-30 08:34:26 -06001320
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001321 int_cmd->command_header->opts |=
1322 __force_bit2int cpu_to_le32((1 << 16));
Sam Bradshaw88523a62011-08-30 08:34:26 -06001323 }
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,
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001338 "Internal command did not complete [%d] "
1339 "within timeout of %lu ms\n",
1340 atomic, timeout);
Asai Thambi S P45038362012-04-09 08:35:38 +02001341 if (mtip_check_surprise_removal(port->dd->pdev) ||
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001342 test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
Asai Thambi S P45038362012-04-09 08:35:38 +02001343 &port->dd->dd_flag)) {
1344 rv = -ENXIO;
1345 goto exec_ic_exit;
1346 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06001347 rv = -EAGAIN;
1348 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06001349 } else {
1350 /* Spin for <timeout> checking if command still outstanding */
1351 timeout = jiffies + msecs_to_jiffies(timeout);
Asai Thambi S P8182b492012-04-09 08:35:38 +02001352 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) &&
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001360 test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
Asai Thambi S P45038362012-04-09 08:35:38 +02001361 &port->dd->dd_flag)) {
1362 rv = -ENXIO;
1363 goto exec_ic_exit;
1364 }
Asai Thambi S Pd02e1f02012-05-29 18:42:27 -07001365 if (readl(port->mmio + PORT_IRQ_STAT) & PORT_IRQ_ERR) {
1366 atomic_inc(&int_cmd->active); /* error */
1367 break;
Asai Thambi S P45038362012-04-09 08:35:38 +02001368 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06001369 }
1370 }
Asai Thambi S Pd02e1f02012-05-29 18:42:27 -07001371
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 }
Asai Thambi S P45038362012-04-09 08:35:38 +02001386exec_ic_exit:
Sam Bradshaw88523a62011-08-30 08:34:26 -06001387 /* Clear the allocated and active bits for the internal command. */
1388 atomic_set(&int_cmd->active, 0);
1389 release_slot(port, MTIP_TAG_INTERNAL);
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001390 if (rv >= 0 && mtip_pause_ncq(port, fis)) {
1391 /* NCQ paused */
1392 return rv;
1393 }
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001394 clear_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001395 wake_up_interruptible(&port->svc_wait);
Sam Bradshaw88523a62011-08-30 08:34:26 -06001396
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 */
1413static 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 */
1439static 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
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001444 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
Asai Thambi S P45038362012-04-09 08:35:38 +02001445 return -EFAULT;
1446
Sam Bradshaw88523a62011-08-30 08:34:26 -06001447 /* 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
1503out:
Sam Bradshaw88523a62011-08-30 08:34:26 -06001504 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 */
1516static int mtip_standby_immediate(struct mtip_port *port)
1517{
1518 int rv;
1519 struct host_to_dev_fis fis;
Asai Thambi S Pf6587212012-04-09 08:35:38 +02001520 unsigned long start;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001521
Sam Bradshaw88523a62011-08-30 08:34:26 -06001522 /* 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
Asai Thambi S Pf6587212012-04-09 08:35:38 +02001528 start = jiffies;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001529 rv = mtip_exec_internal_command(port,
1530 &fis,
1531 5,
1532 0,
1533 0,
1534 0,
Asai Thambi S Pf6587212012-04-09 08:35:38 +02001535 GFP_ATOMIC,
Sam Bradshaw88523a62011-08-30 08:34:26 -06001536 15000);
Asai Thambi S Pf6587212012-04-09 08:35:38 +02001537 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 */
1558static 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 */
1595static 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 */
1631static 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 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06001672
Sam Bradshaw88523a62011-08-30 08:34:26 -06001673 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 */
Jens Axboe63166682011-09-27 21:27:43 -06001686static bool mtip_hw_get_capacity(struct driver_data *dd, sector_t *sectors)
Sam Bradshaw88523a62011-08-30 08:34:26 -06001687{
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 */
1715static 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 */
1746static 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);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001773 switch (revid & 0xFF) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06001774 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 */
1797static 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");
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001813 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);
Sam Bradshaw88523a62011-08-30 08:34:26 -06001819 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 */
Jens Axboe63166682011-09-27 21:27:43 -06001830static int exec_drive_task(struct mtip_port *port, u8 *command)
Sam Bradshaw88523a62011-08-30 08:34:26 -06001831{
1832 struct host_to_dev_fis fis;
1833 struct host_to_dev_fis *reply = (port->rxfis + RX_FIS_D2H_REG);
1834
Sam Bradshaw88523a62011-08-30 08:34:26 -06001835 /* 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
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001847 dbg_printk(MTIP_DRV_NAME " %s: User Command: cmd %x, feat %x, nsect %x, sect %x, lcyl %x, hcyl %x, sel %x\n",
Sam Bradshaw88523a62011-08-30 08:34:26 -06001848 __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) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06001866 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
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001874 dbg_printk(MTIP_DRV_NAME " %s: Completion Status: stat %x, err %x , cyl_lo %x cyl_hi %x\n",
Sam Bradshaw88523a62011-08-30 08:34:26 -06001875 __func__,
1876 command[0],
1877 command[1],
1878 command[4],
1879 command[5]);
1880
Sam Bradshaw88523a62011-08-30 08:34:26 -06001881 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 */
Jens Axboe63166682011-09-27 21:27:43 -06001897static int exec_drive_command(struct mtip_port *port, u8 *command,
1898 void __user *user_buffer)
Sam Bradshaw88523a62011-08-30 08:34:26 -06001899{
1900 struct host_to_dev_fis fis;
Asai Thambi S Pe602878f2012-05-29 18:43:31 -07001901 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) {
David Milburn97651ea2012-09-12 14:06:12 -05001907 if (!user_buffer)
Asai Thambi S Pe602878f2012-05-29 18:43:31 -07001908 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 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06001922
Sam Bradshaw88523a62011-08-30 08:34:26 -06001923 /* Build the FIS. */
1924 memset(&fis, 0, sizeof(struct host_to_dev_fis));
Asai Thambi S Pe602878f2012-05-29 18:43:31 -07001925 fis.type = 0x27;
1926 fis.opts = 1 << 7;
1927 fis.command = command[0];
Sam Bradshaw88523a62011-08-30 08:34:26 -06001928 fis.features = command[2];
1929 fis.sect_count = command[3];
1930 if (fis.command == ATA_CMD_SMART) {
1931 fis.sector = command[1];
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001932 fis.cyl_low = 0x4F;
1933 fis.cyl_hi = 0xC2;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001934 }
1935
Asai Thambi S Pe602878f2012-05-29 18:43:31 -07001936 if (xfer_sz)
1937 reply = (port->rxfis + RX_FIS_PIO_SETUP);
1938 else
1939 reply = (port->rxfis + RX_FIS_D2H_REG);
1940
Sam Bradshaw88523a62011-08-30 08:34:26 -06001941 dbg_printk(MTIP_DRV_NAME
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001942 " %s: User Command: cmd %x, sect %x, "
Sam Bradshaw88523a62011-08-30 08:34:26 -06001943 "feat %x, sectcnt %x\n",
1944 __func__,
1945 command[0],
1946 command[1],
1947 command[2],
1948 command[3]);
1949
Sam Bradshaw88523a62011-08-30 08:34:26 -06001950 /* Execute the command. */
1951 if (mtip_exec_internal_command(port,
1952 &fis,
1953 5,
Asai Thambi S Pe602878f2012-05-29 18:43:31 -07001954 (xfer_sz ? dma_addr : 0),
1955 (xfer_sz ? ATA_SECT_SIZE * xfer_sz : 0),
Sam Bradshaw88523a62011-08-30 08:34:26 -06001956 0,
1957 GFP_KERNEL,
1958 MTIP_IOCTL_COMMAND_TIMEOUT_MS)
1959 < 0) {
Asai Thambi S Pe602878f2012-05-29 18:43:31 -07001960 rv = -EFAULT;
1961 goto exit_drive_command;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001962 }
1963
1964 /* Collect the completion status. */
1965 command[0] = reply->command; /* Status*/
1966 command[1] = reply->features; /* Error*/
Asai Thambi S Pe602878f2012-05-29 18:43:31 -07001967 command[2] = reply->sect_count;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001968
1969 dbg_printk(MTIP_DRV_NAME
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001970 " %s: Completion Status: stat %x, "
Asai Thambi S Pe602878f2012-05-29 18:43:31 -07001971 "err %x, nsect %x\n",
Sam Bradshaw88523a62011-08-30 08:34:26 -06001972 __func__,
1973 command[0],
1974 command[1],
1975 command[2]);
1976
Asai Thambi S Pe602878f2012-05-29 18:43:31 -07001977 if (xfer_sz) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06001978 if (copy_to_user(user_buffer,
Asai Thambi S Pe602878f2012-05-29 18:43:31 -07001979 buf,
Sam Bradshaw88523a62011-08-30 08:34:26 -06001980 ATA_SECT_SIZE * command[3])) {
Asai Thambi S Pe602878f2012-05-29 18:43:31 -07001981 rv = -EFAULT;
1982 goto exit_drive_command;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001983 }
1984 }
Asai Thambi S Pe602878f2012-05-29 18:43:31 -07001985exit_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;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001990}
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 */
2004static 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) {
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002011 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:
Sam Bradshaw88523a62011-08-30 08:34:26 -06002019 rv = 1;
2020 break;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002021 case ATA_CMD_SET_MAX:
2022 if (features == ATA_SET_MAX_UNLOCK)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002023 rv = 1;
2024 break;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002025 case ATA_CMD_SMART:
2026 if ((features == ATA_SMART_READ_VALUES) ||
2027 (features == ATA_SMART_READ_THRESHOLDS))
Sam Bradshaw88523a62011-08-30 08:34:26 -06002028 rv = 1;
2029 break;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002030 case ATA_CMD_CONF_OVERLAY:
2031 if ((features == ATA_DCO_IDENTIFY) ||
2032 (features == ATA_DCO_SET))
Sam Bradshaw88523a62011-08-30 08:34:26 -06002033 rv = 1;
2034 break;
2035 }
2036 return rv;
2037}
2038
Asai Thambi S P2df7aa92012-05-29 18:41:23 -07002039static void mtip_set_timeout(struct host_to_dev_fis *fis, unsigned int *timeout)
2040{
2041 switch (fis->command) {
2042 case ATA_CMD_DOWNLOAD_MICRO:
2043 *timeout = 120000; /* 2 minutes */
2044 break;
2045 case ATA_CMD_SEC_ERASE_UNIT:
2046 case 0xFC:
2047 *timeout = 240000; /* 4 minutes */
2048 break;
2049 case ATA_CMD_STANDBYNOW1:
Asai Thambi S Pd7c8b942012-09-05 22:02:16 +05302050 *timeout = 120000; /* 2 minutes */
Asai Thambi S P2df7aa92012-05-29 18:41:23 -07002051 break;
2052 case 0xF7:
2053 case 0xFA:
2054 *timeout = 60000; /* 60 seconds */
2055 break;
2056 case ATA_CMD_SMART:
2057 *timeout = 15000; /* 15 seconds */
2058 break;
2059 default:
2060 *timeout = MTIP_IOCTL_COMMAND_TIMEOUT_MS;
2061 break;
2062 }
2063}
2064
Sam Bradshaw88523a62011-08-30 08:34:26 -06002065/*
2066 * Executes a taskfile
2067 * See ide_taskfile_ioctl() for derivation
2068 */
2069static int exec_drive_taskfile(struct driver_data *dd,
Jens Axboeef0f1582011-09-27 21:19:53 -06002070 void __user *buf,
2071 ide_task_request_t *req_task,
2072 int outtotal)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002073{
2074 struct host_to_dev_fis fis;
2075 struct host_to_dev_fis *reply;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002076 u8 *outbuf = NULL;
2077 u8 *inbuf = NULL;
Jens Axboe16d02c02011-09-27 15:50:01 -06002078 dma_addr_t outbuf_dma = 0;
2079 dma_addr_t inbuf_dma = 0;
2080 dma_addr_t dma_buffer = 0;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002081 int err = 0;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002082 unsigned int taskin = 0;
2083 unsigned int taskout = 0;
2084 u8 nsect = 0;
Asai Thambi S P2df7aa92012-05-29 18:41:23 -07002085 unsigned int timeout;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002086 unsigned int force_single_sector;
2087 unsigned int transfer_size;
2088 unsigned long task_file_data;
Jens Axboeef0f1582011-09-27 21:19:53 -06002089 int intotal = outtotal + req_task->out_size;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002090
2091 taskout = req_task->out_size;
2092 taskin = req_task->in_size;
2093 /* 130560 = 512 * 0xFF*/
2094 if (taskin > 130560 || taskout > 130560) {
2095 err = -EINVAL;
2096 goto abort;
2097 }
2098
2099 if (taskout) {
2100 outbuf = kzalloc(taskout, GFP_KERNEL);
2101 if (outbuf == NULL) {
2102 err = -ENOMEM;
2103 goto abort;
2104 }
2105 if (copy_from_user(outbuf, buf + outtotal, taskout)) {
2106 err = -EFAULT;
2107 goto abort;
2108 }
2109 outbuf_dma = pci_map_single(dd->pdev,
2110 outbuf,
2111 taskout,
2112 DMA_TO_DEVICE);
Jens Axboe16d02c02011-09-27 15:50:01 -06002113 if (outbuf_dma == 0) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06002114 err = -ENOMEM;
2115 goto abort;
2116 }
2117 dma_buffer = outbuf_dma;
2118 }
2119
2120 if (taskin) {
2121 inbuf = kzalloc(taskin, GFP_KERNEL);
2122 if (inbuf == NULL) {
2123 err = -ENOMEM;
2124 goto abort;
2125 }
2126
2127 if (copy_from_user(inbuf, buf + intotal, taskin)) {
2128 err = -EFAULT;
2129 goto abort;
2130 }
2131 inbuf_dma = pci_map_single(dd->pdev,
2132 inbuf,
2133 taskin, DMA_FROM_DEVICE);
Jens Axboe16d02c02011-09-27 15:50:01 -06002134 if (inbuf_dma == 0) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06002135 err = -ENOMEM;
2136 goto abort;
2137 }
2138 dma_buffer = inbuf_dma;
2139 }
2140
2141 /* only supports PIO and non-data commands from this ioctl. */
2142 switch (req_task->data_phase) {
2143 case TASKFILE_OUT:
2144 nsect = taskout / ATA_SECT_SIZE;
2145 reply = (dd->port->rxfis + RX_FIS_PIO_SETUP);
2146 break;
2147 case TASKFILE_IN:
2148 reply = (dd->port->rxfis + RX_FIS_PIO_SETUP);
2149 break;
2150 case TASKFILE_NO_DATA:
2151 reply = (dd->port->rxfis + RX_FIS_D2H_REG);
2152 break;
2153 default:
2154 err = -EINVAL;
2155 goto abort;
2156 }
2157
Sam Bradshaw88523a62011-08-30 08:34:26 -06002158 /* Build the FIS. */
2159 memset(&fis, 0, sizeof(struct host_to_dev_fis));
2160
2161 fis.type = 0x27;
2162 fis.opts = 1 << 7;
2163 fis.command = req_task->io_ports[7];
2164 fis.features = req_task->io_ports[1];
2165 fis.sect_count = req_task->io_ports[2];
2166 fis.lba_low = req_task->io_ports[3];
2167 fis.lba_mid = req_task->io_ports[4];
2168 fis.lba_hi = req_task->io_ports[5];
2169 /* Clear the dev bit*/
2170 fis.device = req_task->io_ports[6] & ~0x10;
2171
2172 if ((req_task->in_flags.all == 0) && (req_task->out_flags.all & 1)) {
2173 req_task->in_flags.all =
2174 IDE_TASKFILE_STD_IN_FLAGS |
2175 (IDE_HOB_STD_IN_FLAGS << 8);
2176 fis.lba_low_ex = req_task->hob_ports[3];
2177 fis.lba_mid_ex = req_task->hob_ports[4];
2178 fis.lba_hi_ex = req_task->hob_ports[5];
2179 fis.features_ex = req_task->hob_ports[1];
2180 fis.sect_cnt_ex = req_task->hob_ports[2];
2181
2182 } else {
2183 req_task->in_flags.all = IDE_TASKFILE_STD_IN_FLAGS;
2184 }
2185
2186 force_single_sector = implicit_sector(fis.command, fis.features);
2187
2188 if ((taskin || taskout) && (!fis.sect_count)) {
2189 if (nsect)
2190 fis.sect_count = nsect;
2191 else {
2192 if (!force_single_sector) {
2193 dev_warn(&dd->pdev->dev,
2194 "data movement but "
2195 "sect_count is 0\n");
Sam Bradshaw88523a62011-08-30 08:34:26 -06002196 err = -EINVAL;
2197 goto abort;
2198 }
2199 }
2200 }
2201
2202 dbg_printk(MTIP_DRV_NAME
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02002203 " %s: cmd %x, feat %x, nsect %x,"
Sam Bradshaw88523a62011-08-30 08:34:26 -06002204 " sect/lbal %x, lcyl/lbam %x, hcyl/lbah %x,"
2205 " head/dev %x\n",
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02002206 __func__,
Sam Bradshaw88523a62011-08-30 08:34:26 -06002207 fis.command,
2208 fis.features,
2209 fis.sect_count,
2210 fis.lba_low,
2211 fis.lba_mid,
2212 fis.lba_hi,
2213 fis.device);
2214
Asai Thambi S P2df7aa92012-05-29 18:41:23 -07002215 mtip_set_timeout(&fis, &timeout);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002216
2217 /* Determine the correct transfer size.*/
2218 if (force_single_sector)
2219 transfer_size = ATA_SECT_SIZE;
2220 else
2221 transfer_size = ATA_SECT_SIZE * fis.sect_count;
2222
2223 /* Execute the command.*/
2224 if (mtip_exec_internal_command(dd->port,
2225 &fis,
2226 5,
2227 dma_buffer,
2228 transfer_size,
2229 0,
2230 GFP_KERNEL,
2231 timeout) < 0) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06002232 err = -EIO;
2233 goto abort;
2234 }
2235
2236 task_file_data = readl(dd->port->mmio+PORT_TFDATA);
2237
2238 if ((req_task->data_phase == TASKFILE_IN) && !(task_file_data & 1)) {
2239 reply = dd->port->rxfis + RX_FIS_PIO_SETUP;
2240 req_task->io_ports[7] = reply->control;
2241 } else {
2242 reply = dd->port->rxfis + RX_FIS_D2H_REG;
2243 req_task->io_ports[7] = reply->command;
2244 }
2245
2246 /* reclaim the DMA buffers.*/
2247 if (inbuf_dma)
2248 pci_unmap_single(dd->pdev, inbuf_dma,
2249 taskin, DMA_FROM_DEVICE);
2250 if (outbuf_dma)
2251 pci_unmap_single(dd->pdev, outbuf_dma,
2252 taskout, DMA_TO_DEVICE);
Jens Axboe16d02c02011-09-27 15:50:01 -06002253 inbuf_dma = 0;
2254 outbuf_dma = 0;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002255
2256 /* return the ATA registers to the caller.*/
2257 req_task->io_ports[1] = reply->features;
2258 req_task->io_ports[2] = reply->sect_count;
2259 req_task->io_ports[3] = reply->lba_low;
2260 req_task->io_ports[4] = reply->lba_mid;
2261 req_task->io_ports[5] = reply->lba_hi;
2262 req_task->io_ports[6] = reply->device;
2263
2264 if (req_task->out_flags.all & 1) {
2265
2266 req_task->hob_ports[3] = reply->lba_low_ex;
2267 req_task->hob_ports[4] = reply->lba_mid_ex;
2268 req_task->hob_ports[5] = reply->lba_hi_ex;
2269 req_task->hob_ports[1] = reply->features_ex;
2270 req_task->hob_ports[2] = reply->sect_cnt_ex;
2271 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06002272 dbg_printk(MTIP_DRV_NAME
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02002273 " %s: Completion: stat %x,"
Sam Bradshaw88523a62011-08-30 08:34:26 -06002274 "err %x, sect_cnt %x, lbalo %x,"
2275 "lbamid %x, lbahi %x, dev %x\n",
2276 __func__,
2277 req_task->io_ports[7],
2278 req_task->io_ports[1],
2279 req_task->io_ports[2],
2280 req_task->io_ports[3],
2281 req_task->io_ports[4],
2282 req_task->io_ports[5],
2283 req_task->io_ports[6]);
2284
Sam Bradshaw88523a62011-08-30 08:34:26 -06002285 if (taskout) {
2286 if (copy_to_user(buf + outtotal, outbuf, taskout)) {
2287 err = -EFAULT;
2288 goto abort;
2289 }
2290 }
2291 if (taskin) {
2292 if (copy_to_user(buf + intotal, inbuf, taskin)) {
2293 err = -EFAULT;
2294 goto abort;
2295 }
2296 }
2297abort:
2298 if (inbuf_dma)
2299 pci_unmap_single(dd->pdev, inbuf_dma,
2300 taskin, DMA_FROM_DEVICE);
2301 if (outbuf_dma)
2302 pci_unmap_single(dd->pdev, outbuf_dma,
2303 taskout, DMA_TO_DEVICE);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002304 kfree(outbuf);
2305 kfree(inbuf);
2306
2307 return err;
2308}
2309
2310/*
2311 * Handle IOCTL calls from the Block Layer.
2312 *
2313 * This function is called by the Block Layer when it receives an IOCTL
2314 * command that it does not understand. If the IOCTL command is not supported
2315 * this function returns -ENOTTY.
2316 *
2317 * @dd Pointer to the driver data structure.
2318 * @cmd IOCTL command passed from the Block Layer.
2319 * @arg IOCTL argument passed from the Block Layer.
2320 *
2321 * return value
2322 * 0 The IOCTL completed successfully.
2323 * -ENOTTY The specified command is not supported.
2324 * -EFAULT An error occurred copying data to a user space buffer.
2325 * -EIO An error occurred while executing the command.
2326 */
Jens Axboeef0f1582011-09-27 21:19:53 -06002327static int mtip_hw_ioctl(struct driver_data *dd, unsigned int cmd,
2328 unsigned long arg)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002329{
2330 switch (cmd) {
2331 case HDIO_GET_IDENTITY:
Asai Thambi S P971890f2012-05-29 18:41:47 -07002332 {
2333 if (copy_to_user((void __user *)arg, dd->port->identify,
2334 sizeof(u16) * ATA_ID_WORDS))
2335 return -EFAULT;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002336 break;
Asai Thambi S P971890f2012-05-29 18:41:47 -07002337 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06002338 case HDIO_DRIVE_CMD:
2339 {
2340 u8 drive_command[4];
2341
2342 /* Copy the user command info to our buffer. */
2343 if (copy_from_user(drive_command,
2344 (void __user *) arg,
2345 sizeof(drive_command)))
2346 return -EFAULT;
2347
2348 /* Execute the drive command. */
2349 if (exec_drive_command(dd->port,
2350 drive_command,
2351 (void __user *) (arg+4)))
2352 return -EIO;
2353
2354 /* Copy the status back to the users buffer. */
2355 if (copy_to_user((void __user *) arg,
2356 drive_command,
2357 sizeof(drive_command)))
2358 return -EFAULT;
2359
2360 break;
2361 }
2362 case HDIO_DRIVE_TASK:
2363 {
2364 u8 drive_command[7];
2365
2366 /* Copy the user command info to our buffer. */
2367 if (copy_from_user(drive_command,
2368 (void __user *) arg,
2369 sizeof(drive_command)))
2370 return -EFAULT;
2371
2372 /* Execute the drive command. */
2373 if (exec_drive_task(dd->port, drive_command))
2374 return -EIO;
2375
2376 /* Copy the status back to the users buffer. */
2377 if (copy_to_user((void __user *) arg,
2378 drive_command,
2379 sizeof(drive_command)))
2380 return -EFAULT;
2381
2382 break;
2383 }
Jens Axboeef0f1582011-09-27 21:19:53 -06002384 case HDIO_DRIVE_TASKFILE: {
2385 ide_task_request_t req_task;
2386 int ret, outtotal;
2387
2388 if (copy_from_user(&req_task, (void __user *) arg,
2389 sizeof(req_task)))
2390 return -EFAULT;
2391
2392 outtotal = sizeof(req_task);
2393
2394 ret = exec_drive_taskfile(dd, (void __user *) arg,
2395 &req_task, outtotal);
2396
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002397 if (copy_to_user((void __user *) arg, &req_task,
2398 sizeof(req_task)))
Jens Axboeef0f1582011-09-27 21:19:53 -06002399 return -EFAULT;
2400
2401 return ret;
2402 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06002403
2404 default:
2405 return -EINVAL;
2406 }
2407 return 0;
2408}
2409
2410/*
2411 * Submit an IO to the hw
2412 *
2413 * This function is called by the block layer to issue an io
2414 * to the device. Upon completion, the callback function will
2415 * be called with the data parameter passed as the callback data.
2416 *
2417 * @dd Pointer to the driver data structure.
2418 * @start First sector to read.
2419 * @nsect Number of sectors to read.
2420 * @nents Number of entries in scatter list for the read command.
2421 * @tag The tag of this read command.
2422 * @callback Pointer to the function that should be called
2423 * when the read completes.
2424 * @data Callback data passed to the callback function
2425 * when the read completes.
Sam Bradshaw88523a62011-08-30 08:34:26 -06002426 * @dir Direction (read or write)
2427 *
2428 * return value
2429 * None
2430 */
Jens Axboe63166682011-09-27 21:27:43 -06002431static void mtip_hw_submit_io(struct driver_data *dd, sector_t start,
2432 int nsect, int nents, int tag, void *callback,
Asai Thambi S P4e8670e2012-02-07 07:54:31 +01002433 void *data, int dir)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002434{
2435 struct host_to_dev_fis *fis;
2436 struct mtip_port *port = dd->port;
2437 struct mtip_cmd *command = &port->commands[tag];
Asai Thambi S P45038362012-04-09 08:35:38 +02002438 int dma_dir = (dir == READ) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002439
2440 /* Map the scatter list for DMA access */
Asai Thambi S P45038362012-04-09 08:35:38 +02002441 nents = dma_map_sg(&dd->pdev->dev, command->sg, nents, dma_dir);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002442
2443 command->scatter_ents = nents;
2444
2445 /*
2446 * The number of retries for this command before it is
2447 * reported as a failure to the upper layers.
2448 */
2449 command->retries = MTIP_MAX_RETRIES;
2450
2451 /* Fill out fis */
2452 fis = command->command;
2453 fis->type = 0x27;
2454 fis->opts = 1 << 7;
2455 fis->command =
2456 (dir == READ ? ATA_CMD_FPDMA_READ : ATA_CMD_FPDMA_WRITE);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002457 *((unsigned int *) &fis->lba_low) = (start & 0xFFFFFF);
2458 *((unsigned int *) &fis->lba_low_ex) = ((start >> 24) & 0xFFFFFF);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002459 fis->device = 1 << 6;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002460 fis->features = nsect & 0xFF;
2461 fis->features_ex = (nsect >> 8) & 0xFF;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002462 fis->sect_count = ((tag << 3) | (tag >> 5));
2463 fis->sect_cnt_ex = 0;
2464 fis->control = 0;
2465 fis->res2 = 0;
2466 fis->res3 = 0;
2467 fill_command_sg(dd, command, nents);
2468
2469 /* Populate the command header */
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002470 command->command_header->opts =
2471 __force_bit2int cpu_to_le32(
2472 (nents << 16) | 5 | AHCI_CMD_PREFETCH);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002473 command->command_header->byte_count = 0;
2474
2475 /*
2476 * Set the completion function and data for the command
2477 * within this layer.
2478 */
2479 command->comp_data = dd;
2480 command->comp_func = mtip_async_complete;
Asai Thambi S P45038362012-04-09 08:35:38 +02002481 command->direction = dma_dir;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002482
2483 /*
2484 * Set the completion function and data for the command passed
2485 * from the upper layer.
2486 */
2487 command->async_data = data;
2488 command->async_callback = callback;
2489
2490 /*
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002491 * To prevent this command from being issued
2492 * if an internal command is in progress or error handling is active.
Sam Bradshaw88523a62011-08-30 08:34:26 -06002493 */
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02002494 if (port->flags & MTIP_PF_PAUSE_IO) {
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002495 set_bit(tag, port->cmds_to_issue);
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002496 set_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002497 return;
2498 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06002499
2500 /* Issue the command to the hardware */
2501 mtip_issue_ncq_command(port, tag);
2502
Asai Thambi S Pdad40f12012-04-09 08:35:38 +02002503 return;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002504}
2505
2506/*
2507 * Release a command slot.
2508 *
2509 * @dd Pointer to the driver data structure.
2510 * @tag Slot tag
2511 *
2512 * return value
2513 * None
2514 */
Jens Axboe63166682011-09-27 21:27:43 -06002515static void mtip_hw_release_scatterlist(struct driver_data *dd, int tag)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002516{
2517 release_slot(dd->port, tag);
2518}
2519
2520/*
2521 * Obtain a command slot and return its associated scatter list.
2522 *
2523 * @dd Pointer to the driver data structure.
2524 * @tag Pointer to an int that will receive the allocated command
2525 * slot tag.
2526 *
2527 * return value
2528 * Pointer to the scatter list for the allocated command slot
2529 * or NULL if no command slots are available.
2530 */
Jens Axboe63166682011-09-27 21:27:43 -06002531static struct scatterlist *mtip_hw_get_scatterlist(struct driver_data *dd,
2532 int *tag)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002533{
2534 /*
2535 * It is possible that, even with this semaphore, a thread
2536 * may think that no command slots are available. Therefore, we
2537 * need to make an attempt to get_slot().
2538 */
2539 down(&dd->port->cmd_slot);
2540 *tag = get_slot(dd->port);
2541
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002542 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))) {
Asai Thambi S P45038362012-04-09 08:35:38 +02002543 up(&dd->port->cmd_slot);
2544 return NULL;
2545 }
Asai Thambi S Pa09ba132012-04-16 21:27:55 +02002546 if (unlikely(*tag < 0)) {
2547 up(&dd->port->cmd_slot);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002548 return NULL;
Asai Thambi S Pa09ba132012-04-16 21:27:55 +02002549 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06002550
2551 return dd->port->commands[*tag].sg;
2552}
2553
2554/*
Asai Thambi S P7412ff12012-06-04 12:43:03 -07002555 * Sysfs status dump.
Sam Bradshaw88523a62011-08-30 08:34:26 -06002556 *
2557 * @dev Pointer to the device structure, passed by the kernrel.
2558 * @attr Pointer to the device_attribute structure passed by the kernel.
2559 * @buf Pointer to the char buffer that will receive the stats info.
2560 *
2561 * return value
2562 * The size, in bytes, of the data copied into buf.
2563 */
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002564static ssize_t mtip_hw_show_status(struct device *dev,
2565 struct device_attribute *attr,
2566 char *buf)
2567{
2568 struct driver_data *dd = dev_to_disk(dev)->private_data;
2569 int size = 0;
2570
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002571 if (test_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag))
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002572 size += sprintf(buf, "%s", "thermal_shutdown\n");
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002573 else if (test_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag))
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002574 size += sprintf(buf, "%s", "write_protect\n");
2575 else
2576 size += sprintf(buf, "%s", "online\n");
2577
2578 return size;
2579}
2580
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002581static DEVICE_ATTR(status, S_IRUGO, mtip_hw_show_status, NULL);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002582
Asai Thambi S P7b421d22012-06-04 12:44:02 -07002583static ssize_t mtip_hw_read_registers(struct file *f, char __user *ubuf,
2584 size_t len, loff_t *offset)
2585{
2586 struct driver_data *dd = (struct driver_data *)f->private_data;
2587 char buf[MTIP_DFS_MAX_BUF_SIZE];
2588 u32 group_allocated;
2589 int size = *offset;
2590 int n;
2591
2592 if (!len || size)
2593 return 0;
2594
Asai Thambi S P7b421d22012-06-04 12:44:02 -07002595 size += sprintf(&buf[size], "H/ S ACTive : [ 0x");
2596
2597 for (n = dd->slot_groups-1; n >= 0; n--)
2598 size += sprintf(&buf[size], "%08X ",
2599 readl(dd->port->s_active[n]));
2600
2601 size += sprintf(&buf[size], "]\n");
2602 size += sprintf(&buf[size], "H/ Command Issue : [ 0x");
2603
2604 for (n = dd->slot_groups-1; n >= 0; n--)
2605 size += sprintf(&buf[size], "%08X ",
2606 readl(dd->port->cmd_issue[n]));
2607
2608 size += sprintf(&buf[size], "]\n");
2609 size += sprintf(&buf[size], "H/ Completed : [ 0x");
2610
2611 for (n = dd->slot_groups-1; n >= 0; n--)
2612 size += sprintf(&buf[size], "%08X ",
2613 readl(dd->port->completed[n]));
2614
2615 size += sprintf(&buf[size], "]\n");
2616 size += sprintf(&buf[size], "H/ PORT IRQ STAT : [ 0x%08X ]\n",
2617 readl(dd->port->mmio + PORT_IRQ_STAT));
2618 size += sprintf(&buf[size], "H/ HOST IRQ STAT : [ 0x%08X ]\n",
2619 readl(dd->mmio + HOST_IRQ_STAT));
2620 size += sprintf(&buf[size], "\n");
2621
2622 size += sprintf(&buf[size], "L/ Allocated : [ 0x");
2623
2624 for (n = dd->slot_groups-1; n >= 0; n--) {
2625 if (sizeof(long) > sizeof(u32))
2626 group_allocated =
2627 dd->port->allocated[n/2] >> (32*(n&1));
2628 else
2629 group_allocated = dd->port->allocated[n];
2630 size += sprintf(&buf[size], "%08X ", group_allocated);
2631 }
2632 size += sprintf(&buf[size], "]\n");
2633
2634 size += sprintf(&buf[size], "L/ Commands in Q : [ 0x");
2635
2636 for (n = dd->slot_groups-1; n >= 0; n--) {
2637 if (sizeof(long) > sizeof(u32))
2638 group_allocated =
2639 dd->port->cmds_to_issue[n/2] >> (32*(n&1));
2640 else
2641 group_allocated = dd->port->cmds_to_issue[n];
2642 size += sprintf(&buf[size], "%08X ", group_allocated);
2643 }
2644 size += sprintf(&buf[size], "]\n");
2645
2646 *offset = size <= len ? size : len;
2647 size = copy_to_user(ubuf, buf, *offset);
2648 if (size)
2649 return -EFAULT;
2650
2651 return *offset;
2652}
2653
2654static ssize_t mtip_hw_read_flags(struct file *f, char __user *ubuf,
2655 size_t len, loff_t *offset)
2656{
2657 struct driver_data *dd = (struct driver_data *)f->private_data;
2658 char buf[MTIP_DFS_MAX_BUF_SIZE];
2659 int size = *offset;
2660
2661 if (!len || size)
2662 return 0;
2663
Asai Thambi S P7b421d22012-06-04 12:44:02 -07002664 size += sprintf(&buf[size], "Flag-port : [ %08lX ]\n",
2665 dd->port->flags);
2666 size += sprintf(&buf[size], "Flag-dd : [ %08lX ]\n",
2667 dd->dd_flag);
2668
2669 *offset = size <= len ? size : len;
2670 size = copy_to_user(ubuf, buf, *offset);
2671 if (size)
2672 return -EFAULT;
2673
2674 return *offset;
2675}
2676
2677static const struct file_operations mtip_regs_fops = {
2678 .owner = THIS_MODULE,
2679 .open = simple_open,
2680 .read = mtip_hw_read_registers,
2681 .llseek = no_llseek,
2682};
2683
2684static const struct file_operations mtip_flags_fops = {
2685 .owner = THIS_MODULE,
2686 .open = simple_open,
2687 .read = mtip_hw_read_flags,
2688 .llseek = no_llseek,
2689};
2690
Sam Bradshaw88523a62011-08-30 08:34:26 -06002691/*
2692 * Create the sysfs related attributes.
2693 *
2694 * @dd Pointer to the driver data structure.
2695 * @kobj Pointer to the kobj for the block device.
2696 *
2697 * return value
2698 * 0 Operation completed successfully.
2699 * -EINVAL Invalid parameter.
2700 */
Jens Axboe63166682011-09-27 21:27:43 -06002701static int mtip_hw_sysfs_init(struct driver_data *dd, struct kobject *kobj)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002702{
2703 if (!kobj || !dd)
2704 return -EINVAL;
2705
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002706 if (sysfs_create_file(kobj, &dev_attr_status.attr))
2707 dev_warn(&dd->pdev->dev,
2708 "Error creating 'status' sysfs entry\n");
Sam Bradshaw88523a62011-08-30 08:34:26 -06002709 return 0;
2710}
2711
2712/*
2713 * Remove the sysfs related attributes.
2714 *
2715 * @dd Pointer to the driver data structure.
2716 * @kobj Pointer to the kobj for the block device.
2717 *
2718 * return value
2719 * 0 Operation completed successfully.
2720 * -EINVAL Invalid parameter.
2721 */
Jens Axboe63166682011-09-27 21:27:43 -06002722static int mtip_hw_sysfs_exit(struct driver_data *dd, struct kobject *kobj)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002723{
2724 if (!kobj || !dd)
2725 return -EINVAL;
2726
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002727 sysfs_remove_file(kobj, &dev_attr_status.attr);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002728
2729 return 0;
2730}
2731
Asai Thambi S P7b421d22012-06-04 12:44:02 -07002732static int mtip_hw_debugfs_init(struct driver_data *dd)
2733{
2734 if (!dfs_parent)
2735 return -1;
2736
2737 dd->dfs_node = debugfs_create_dir(dd->disk->disk_name, dfs_parent);
2738 if (IS_ERR_OR_NULL(dd->dfs_node)) {
2739 dev_warn(&dd->pdev->dev,
2740 "Error creating node %s under debugfs\n",
2741 dd->disk->disk_name);
2742 dd->dfs_node = NULL;
2743 return -1;
2744 }
2745
2746 debugfs_create_file("flags", S_IRUGO, dd->dfs_node, dd,
2747 &mtip_flags_fops);
2748 debugfs_create_file("registers", S_IRUGO, dd->dfs_node, dd,
2749 &mtip_regs_fops);
2750
2751 return 0;
2752}
2753
2754static void mtip_hw_debugfs_exit(struct driver_data *dd)
2755{
2756 debugfs_remove_recursive(dd->dfs_node);
2757}
2758
2759
Sam Bradshaw88523a62011-08-30 08:34:26 -06002760/*
2761 * Perform any init/resume time hardware setup
2762 *
2763 * @dd Pointer to the driver data structure.
2764 *
2765 * return value
2766 * None
2767 */
2768static inline void hba_setup(struct driver_data *dd)
2769{
2770 u32 hwdata;
2771 hwdata = readl(dd->mmio + HOST_HSORG);
2772
2773 /* interrupt bug workaround: use only 1 IS bit.*/
2774 writel(hwdata |
2775 HSORG_DISABLE_SLOTGRP_INTR |
2776 HSORG_DISABLE_SLOTGRP_PXIS,
2777 dd->mmio + HOST_HSORG);
2778}
2779
2780/*
2781 * Detect the details of the product, and store anything needed
2782 * into the driver data structure. This includes product type and
2783 * version and number of slot groups.
2784 *
2785 * @dd Pointer to the driver data structure.
2786 *
2787 * return value
2788 * None
2789 */
2790static void mtip_detect_product(struct driver_data *dd)
2791{
2792 u32 hwdata;
2793 unsigned int rev, slotgroups;
2794
2795 /*
2796 * HBA base + 0xFC [15:0] - vendor-specific hardware interface
2797 * info register:
2798 * [15:8] hardware/software interface rev#
2799 * [ 3] asic-style interface
2800 * [ 2:0] number of slot groups, minus 1 (only valid for asic-style).
2801 */
2802 hwdata = readl(dd->mmio + HOST_HSORG);
2803
2804 dd->product_type = MTIP_PRODUCT_UNKNOWN;
2805 dd->slot_groups = 1;
2806
2807 if (hwdata & 0x8) {
2808 dd->product_type = MTIP_PRODUCT_ASICFPGA;
2809 rev = (hwdata & HSORG_HWREV) >> 8;
2810 slotgroups = (hwdata & HSORG_SLOTGROUPS) + 1;
2811 dev_info(&dd->pdev->dev,
2812 "ASIC-FPGA design, HS rev 0x%x, "
2813 "%i slot groups [%i slots]\n",
2814 rev,
2815 slotgroups,
2816 slotgroups * 32);
2817
2818 if (slotgroups > MTIP_MAX_SLOT_GROUPS) {
2819 dev_warn(&dd->pdev->dev,
2820 "Warning: driver only supports "
2821 "%i slot groups.\n", MTIP_MAX_SLOT_GROUPS);
2822 slotgroups = MTIP_MAX_SLOT_GROUPS;
2823 }
2824 dd->slot_groups = slotgroups;
2825 return;
2826 }
2827
2828 dev_warn(&dd->pdev->dev, "Unrecognized product id\n");
2829}
2830
2831/*
2832 * Blocking wait for FTL rebuild to complete
2833 *
2834 * @dd Pointer to the DRIVER_DATA structure.
2835 *
2836 * return value
2837 * 0 FTL rebuild completed successfully
2838 * -EFAULT FTL rebuild error/timeout/interruption
2839 */
2840static int mtip_ftl_rebuild_poll(struct driver_data *dd)
2841{
2842 unsigned long timeout, cnt = 0, start;
2843
2844 dev_warn(&dd->pdev->dev,
2845 "FTL rebuild in progress. Polling for completion.\n");
2846
2847 start = jiffies;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002848 timeout = jiffies + msecs_to_jiffies(MTIP_FTL_REBUILD_TIMEOUT_MS);
2849
2850 do {
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002851 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
Asai Thambi S P45038362012-04-09 08:35:38 +02002852 &dd->dd_flag)))
2853 return -EFAULT;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002854 if (mtip_check_surprise_removal(dd->pdev))
2855 return -EFAULT;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002856
Sam Bradshaw88523a62011-08-30 08:34:26 -06002857 if (mtip_get_identify(dd->port, NULL) < 0)
2858 return -EFAULT;
2859
2860 if (*(dd->port->identify + MTIP_FTL_REBUILD_OFFSET) ==
2861 MTIP_FTL_REBUILD_MAGIC) {
2862 ssleep(1);
2863 /* Print message every 3 minutes */
2864 if (cnt++ >= 180) {
2865 dev_warn(&dd->pdev->dev,
2866 "FTL rebuild in progress (%d secs).\n",
2867 jiffies_to_msecs(jiffies - start) / 1000);
2868 cnt = 0;
2869 }
2870 } else {
2871 dev_warn(&dd->pdev->dev,
2872 "FTL rebuild complete (%d secs).\n",
2873 jiffies_to_msecs(jiffies - start) / 1000);
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01002874 mtip_block_initialize(dd);
Asai Thambi S P45038362012-04-09 08:35:38 +02002875 return 0;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002876 }
2877 ssleep(10);
2878 } while (time_before(jiffies, timeout));
2879
2880 /* Check for timeout */
Asai Thambi S P45038362012-04-09 08:35:38 +02002881 dev_err(&dd->pdev->dev,
Sam Bradshaw88523a62011-08-30 08:34:26 -06002882 "Timed out waiting for FTL rebuild to complete (%d secs).\n",
2883 jiffies_to_msecs(jiffies - start) / 1000);
Asai Thambi S P45038362012-04-09 08:35:38 +02002884 return -EFAULT;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002885}
2886
2887/*
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002888 * service thread to issue queued commands
2889 *
2890 * @data Pointer to the driver data structure.
2891 *
2892 * return value
2893 * 0
2894 */
2895
2896static int mtip_service_thread(void *data)
2897{
2898 struct driver_data *dd = (struct driver_data *)data;
2899 unsigned long slot, slot_start, slot_wrap;
2900 unsigned int num_cmd_slots = dd->slot_groups * 32;
2901 struct mtip_port *port = dd->port;
2902
2903 while (1) {
2904 /*
2905 * the condition is to check neither an internal command is
2906 * is in progress nor error handling is active
2907 */
2908 wait_event_interruptible(port->svc_wait, (port->flags) &&
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02002909 !(port->flags & MTIP_PF_PAUSE_IO));
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002910
2911 if (kthread_should_stop())
2912 break;
2913
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002914 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
Asai Thambi S P45038362012-04-09 08:35:38 +02002915 &dd->dd_flag)))
2916 break;
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02002917
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002918 set_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags);
2919 if (test_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags)) {
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002920 slot = 1;
2921 /* used to restrict the loop to one iteration */
2922 slot_start = num_cmd_slots;
2923 slot_wrap = 0;
2924 while (1) {
2925 slot = find_next_bit(port->cmds_to_issue,
2926 num_cmd_slots, slot);
2927 if (slot_wrap == 1) {
2928 if ((slot_start >= slot) ||
2929 (slot >= num_cmd_slots))
2930 break;
2931 }
2932 if (unlikely(slot_start == num_cmd_slots))
2933 slot_start = slot;
2934
2935 if (unlikely(slot == num_cmd_slots)) {
2936 slot = 1;
2937 slot_wrap = 1;
2938 continue;
2939 }
2940
2941 /* Issue the command to the hardware */
2942 mtip_issue_ncq_command(port, slot);
2943
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002944 clear_bit(slot, port->cmds_to_issue);
2945 }
2946
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002947 clear_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags);
2948 } else if (test_bit(MTIP_PF_REBUILD_BIT, &port->flags)) {
Asai Thambi S P8182b492012-04-09 08:35:38 +02002949 if (!mtip_ftl_rebuild_poll(dd))
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002950 set_bit(MTIP_DDF_REBUILD_FAILED_BIT,
Asai Thambi S P8182b492012-04-09 08:35:38 +02002951 &dd->dd_flag);
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002952 clear_bit(MTIP_PF_REBUILD_BIT, &port->flags);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002953 }
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002954 clear_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags);
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01002955
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02002956 if (test_bit(MTIP_PF_SVC_THD_STOP_BIT, &port->flags))
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01002957 break;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002958 }
2959 return 0;
2960}
2961
2962/*
Sam Bradshaw88523a62011-08-30 08:34:26 -06002963 * Called once for each card.
2964 *
2965 * @dd Pointer to the driver data structure.
2966 *
2967 * return value
2968 * 0 on success, else an error code.
2969 */
Jens Axboe63166682011-09-27 21:27:43 -06002970static int mtip_hw_init(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002971{
2972 int i;
2973 int rv;
2974 unsigned int num_command_slots;
Asai Thambi S P45038362012-04-09 08:35:38 +02002975 unsigned long timeout, timetaken;
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002976 unsigned char *buf;
2977 struct smart_attr attr242;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002978
2979 dd->mmio = pcim_iomap_table(dd->pdev)[MTIP_ABAR];
2980
2981 mtip_detect_product(dd);
2982 if (dd->product_type == MTIP_PRODUCT_UNKNOWN) {
2983 rv = -EIO;
2984 goto out1;
2985 }
2986 num_command_slots = dd->slot_groups * 32;
2987
2988 hba_setup(dd);
2989
Sam Bradshaw88523a62011-08-30 08:34:26 -06002990 tasklet_init(&dd->tasklet, mtip_tasklet, (unsigned long)dd);
2991
2992 dd->port = kzalloc(sizeof(struct mtip_port), GFP_KERNEL);
2993 if (!dd->port) {
2994 dev_err(&dd->pdev->dev,
2995 "Memory allocation: port structure\n");
2996 return -ENOMEM;
2997 }
2998
2999 /* Counting semaphore to track command slot usage */
3000 sema_init(&dd->port->cmd_slot, num_command_slots - 1);
3001
3002 /* Spinlock to prevent concurrent issue */
3003 spin_lock_init(&dd->port->cmd_issue_lock);
3004
3005 /* Set the port mmio base address. */
3006 dd->port->mmio = dd->mmio + PORT_OFFSET;
3007 dd->port->dd = dd;
3008
3009 /* Allocate memory for the command list. */
3010 dd->port->command_list =
3011 dmam_alloc_coherent(&dd->pdev->dev,
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003012 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
Sam Bradshaw88523a62011-08-30 08:34:26 -06003013 &dd->port->command_list_dma,
3014 GFP_KERNEL);
3015 if (!dd->port->command_list) {
3016 dev_err(&dd->pdev->dev,
3017 "Memory allocation: command list\n");
3018 rv = -ENOMEM;
3019 goto out1;
3020 }
3021
3022 /* Clear the memory we have allocated. */
3023 memset(dd->port->command_list,
3024 0,
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003025 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4));
Sam Bradshaw88523a62011-08-30 08:34:26 -06003026
3027 /* Setup the addresse of the RX FIS. */
3028 dd->port->rxfis = dd->port->command_list + HW_CMD_SLOT_SZ;
3029 dd->port->rxfis_dma = dd->port->command_list_dma + HW_CMD_SLOT_SZ;
3030
3031 /* Setup the address of the command tables. */
3032 dd->port->command_table = dd->port->rxfis + AHCI_RX_FIS_SZ;
3033 dd->port->command_tbl_dma = dd->port->rxfis_dma + AHCI_RX_FIS_SZ;
3034
3035 /* Setup the address of the identify data. */
3036 dd->port->identify = dd->port->command_table +
3037 HW_CMD_TBL_AR_SZ;
3038 dd->port->identify_dma = dd->port->command_tbl_dma +
3039 HW_CMD_TBL_AR_SZ;
3040
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003041 /* Setup the address of the sector buffer - for some non-ncq cmds */
Sam Bradshaw88523a62011-08-30 08:34:26 -06003042 dd->port->sector_buffer = (void *) dd->port->identify + ATA_SECT_SIZE;
3043 dd->port->sector_buffer_dma = dd->port->identify_dma + ATA_SECT_SIZE;
3044
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003045 /* Setup the address of the log buf - for read log command */
3046 dd->port->log_buf = (void *)dd->port->sector_buffer + ATA_SECT_SIZE;
3047 dd->port->log_buf_dma = dd->port->sector_buffer_dma + ATA_SECT_SIZE;
3048
3049 /* Setup the address of the smart buf - for smart read data command */
3050 dd->port->smart_buf = (void *)dd->port->log_buf + ATA_SECT_SIZE;
3051 dd->port->smart_buf_dma = dd->port->log_buf_dma + ATA_SECT_SIZE;
3052
3053
Sam Bradshaw88523a62011-08-30 08:34:26 -06003054 /* Point the command headers at the command tables. */
3055 for (i = 0; i < num_command_slots; i++) {
3056 dd->port->commands[i].command_header =
3057 dd->port->command_list +
3058 (sizeof(struct mtip_cmd_hdr) * i);
3059 dd->port->commands[i].command_header_dma =
3060 dd->port->command_list_dma +
3061 (sizeof(struct mtip_cmd_hdr) * i);
3062
3063 dd->port->commands[i].command =
3064 dd->port->command_table + (HW_CMD_TBL_SZ * i);
3065 dd->port->commands[i].command_dma =
3066 dd->port->command_tbl_dma + (HW_CMD_TBL_SZ * i);
3067
3068 if (readl(dd->mmio + HOST_CAP) & HOST_CAP_64)
3069 dd->port->commands[i].command_header->ctbau =
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003070 __force_bit2int cpu_to_le32(
Sam Bradshaw88523a62011-08-30 08:34:26 -06003071 (dd->port->commands[i].command_dma >> 16) >> 16);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003072 dd->port->commands[i].command_header->ctba =
3073 __force_bit2int cpu_to_le32(
3074 dd->port->commands[i].command_dma & 0xFFFFFFFF);
Sam Bradshaw88523a62011-08-30 08:34:26 -06003075
3076 /*
3077 * If this is not done, a bug is reported by the stock
3078 * FC11 i386. Due to the fact that it has lots of kernel
3079 * debugging enabled.
3080 */
3081 sg_init_table(dd->port->commands[i].sg, MTIP_MAX_SG);
3082
3083 /* Mark all commands as currently inactive.*/
3084 atomic_set(&dd->port->commands[i].active, 0);
3085 }
3086
3087 /* Setup the pointers to the extended s_active and CI registers. */
3088 for (i = 0; i < dd->slot_groups; i++) {
3089 dd->port->s_active[i] =
3090 dd->port->mmio + i*0x80 + PORT_SCR_ACT;
3091 dd->port->cmd_issue[i] =
3092 dd->port->mmio + i*0x80 + PORT_COMMAND_ISSUE;
3093 dd->port->completed[i] =
3094 dd->port->mmio + i*0x80 + PORT_SDBV;
3095 }
3096
Asai Thambi S P45038362012-04-09 08:35:38 +02003097 timetaken = jiffies;
3098 timeout = jiffies + msecs_to_jiffies(30000);
3099 while (((readl(dd->port->mmio + PORT_SCR_STAT) & 0x0F) != 0x03) &&
3100 time_before(jiffies, timeout)) {
3101 mdelay(100);
3102 }
3103 if (unlikely(mtip_check_surprise_removal(dd->pdev))) {
3104 timetaken = jiffies - timetaken;
3105 dev_warn(&dd->pdev->dev,
3106 "Surprise removal detected at %u ms\n",
3107 jiffies_to_msecs(timetaken));
3108 rv = -ENODEV;
3109 goto out2 ;
3110 }
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003111 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))) {
Asai Thambi S P45038362012-04-09 08:35:38 +02003112 timetaken = jiffies - timetaken;
3113 dev_warn(&dd->pdev->dev,
3114 "Removal detected at %u ms\n",
3115 jiffies_to_msecs(timetaken));
3116 rv = -EFAULT;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003117 goto out2;
3118 }
3119
Asai Thambi S P45038362012-04-09 08:35:38 +02003120 /* Conditionally reset the HBA. */
3121 if (!(readl(dd->mmio + HOST_CAP) & HOST_CAP_NZDMA)) {
3122 if (mtip_hba_reset(dd) < 0) {
3123 dev_err(&dd->pdev->dev,
3124 "Card did not reset within timeout\n");
3125 rv = -EIO;
3126 goto out2;
3127 }
3128 } else {
3129 /* Clear any pending interrupts on the HBA */
3130 writel(readl(dd->mmio + HOST_IRQ_STAT),
3131 dd->mmio + HOST_IRQ_STAT);
3132 }
3133
Sam Bradshaw88523a62011-08-30 08:34:26 -06003134 mtip_init_port(dd->port);
3135 mtip_start_port(dd->port);
3136
3137 /* Setup the ISR and enable interrupts. */
3138 rv = devm_request_irq(&dd->pdev->dev,
3139 dd->pdev->irq,
3140 mtip_irq_handler,
3141 IRQF_SHARED,
3142 dev_driver_string(&dd->pdev->dev),
3143 dd);
3144
3145 if (rv) {
3146 dev_err(&dd->pdev->dev,
3147 "Unable to allocate IRQ %d\n", dd->pdev->irq);
3148 goto out2;
3149 }
3150
3151 /* Enable interrupts on the HBA. */
3152 writel(readl(dd->mmio + HOST_CTL) | HOST_IRQ_EN,
3153 dd->mmio + HOST_CTL);
3154
3155 init_timer(&dd->port->cmd_timer);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003156 init_waitqueue_head(&dd->port->svc_wait);
3157
Sam Bradshaw88523a62011-08-30 08:34:26 -06003158 dd->port->cmd_timer.data = (unsigned long int) dd->port;
3159 dd->port->cmd_timer.function = mtip_timeout_function;
3160 mod_timer(&dd->port->cmd_timer,
3161 jiffies + msecs_to_jiffies(MTIP_TIMEOUT_CHECK_PERIOD));
3162
Asai Thambi S P45038362012-04-09 08:35:38 +02003163
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003164 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)) {
Asai Thambi S P45038362012-04-09 08:35:38 +02003165 rv = -EFAULT;
3166 goto out3;
3167 }
3168
Sam Bradshaw88523a62011-08-30 08:34:26 -06003169 if (mtip_get_identify(dd->port, NULL) < 0) {
3170 rv = -EFAULT;
3171 goto out3;
3172 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06003173
3174 if (*(dd->port->identify + MTIP_FTL_REBUILD_OFFSET) ==
3175 MTIP_FTL_REBUILD_MAGIC) {
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003176 set_bit(MTIP_PF_REBUILD_BIT, &dd->port->flags);
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003177 return MTIP_FTL_REBUILD_MAGIC;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003178 }
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003179 mtip_dump_identify(dd->port);
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003180
3181 /* check write protect, over temp and rebuild statuses */
3182 rv = mtip_read_log_page(dd->port, ATA_LOG_SATA_NCQ,
3183 dd->port->log_buf,
3184 dd->port->log_buf_dma, 1);
3185 if (rv) {
3186 dev_warn(&dd->pdev->dev,
3187 "Error in READ LOG EXT (10h) command\n");
3188 /* non-critical error, don't fail the load */
3189 } else {
3190 buf = (unsigned char *)dd->port->log_buf;
3191 if (buf[259] & 0x1) {
3192 dev_info(&dd->pdev->dev,
3193 "Write protect bit is set.\n");
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003194 set_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag);
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003195 }
3196 if (buf[288] == 0xF7) {
3197 dev_info(&dd->pdev->dev,
3198 "Exceeded Tmax, drive in thermal shutdown.\n");
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003199 set_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag);
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003200 }
3201 if (buf[288] == 0xBF) {
3202 dev_info(&dd->pdev->dev,
3203 "Drive indicates rebuild has failed.\n");
3204 /* TODO */
3205 }
3206 }
3207
3208 /* get write protect progess */
3209 memset(&attr242, 0, sizeof(struct smart_attr));
3210 if (mtip_get_smart_attr(dd->port, 242, &attr242))
3211 dev_warn(&dd->pdev->dev,
3212 "Unable to check write protect progress\n");
3213 else
3214 dev_info(&dd->pdev->dev,
Asai Thambi S Pb62868e2012-09-05 22:03:32 +05303215 "Write protect progress: %u%% (%u blocks)\n",
3216 attr242.cur, le32_to_cpu(attr242.data));
Sam Bradshaw88523a62011-08-30 08:34:26 -06003217 return rv;
3218
3219out3:
3220 del_timer_sync(&dd->port->cmd_timer);
3221
3222 /* Disable interrupts on the HBA. */
3223 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3224 dd->mmio + HOST_CTL);
3225
3226 /*Release the IRQ. */
3227 devm_free_irq(&dd->pdev->dev, dd->pdev->irq, dd);
3228
3229out2:
3230 mtip_deinit_port(dd->port);
3231
3232 /* Free the command/command header memory. */
3233 dmam_free_coherent(&dd->pdev->dev,
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003234 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
Sam Bradshaw88523a62011-08-30 08:34:26 -06003235 dd->port->command_list,
3236 dd->port->command_list_dma);
3237out1:
3238 /* Free the memory allocated for the for structure. */
3239 kfree(dd->port);
3240
3241 return rv;
3242}
3243
3244/*
3245 * Called to deinitialize an interface.
3246 *
3247 * @dd Pointer to the driver data structure.
3248 *
3249 * return value
3250 * 0
3251 */
Jens Axboe63166682011-09-27 21:27:43 -06003252static int mtip_hw_exit(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003253{
3254 /*
3255 * Send standby immediate (E0h) to the drive so that it
3256 * saves its state.
3257 */
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003258 if (!test_bit(MTIP_DDF_CLEANUP_BIT, &dd->dd_flag)) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06003259
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003260 if (!test_bit(MTIP_PF_REBUILD_BIT, &dd->port->flags))
Asai Thambi S P45038362012-04-09 08:35:38 +02003261 if (mtip_standby_immediate(dd->port))
3262 dev_warn(&dd->pdev->dev,
3263 "STANDBY IMMEDIATE failed\n");
Sam Bradshaw88523a62011-08-30 08:34:26 -06003264
3265 /* de-initialize the port. */
3266 mtip_deinit_port(dd->port);
3267
3268 /* Disable interrupts on the HBA. */
3269 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3270 dd->mmio + HOST_CTL);
3271 }
3272
3273 del_timer_sync(&dd->port->cmd_timer);
3274
Sam Bradshaw88523a62011-08-30 08:34:26 -06003275 /* Release the IRQ. */
3276 devm_free_irq(&dd->pdev->dev, dd->pdev->irq, dd);
3277
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003278 /* Stop the bottom half tasklet. */
3279 tasklet_kill(&dd->tasklet);
3280
Sam Bradshaw88523a62011-08-30 08:34:26 -06003281 /* Free the command/command header memory. */
3282 dmam_free_coherent(&dd->pdev->dev,
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003283 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
Sam Bradshaw88523a62011-08-30 08:34:26 -06003284 dd->port->command_list,
3285 dd->port->command_list_dma);
3286 /* Free the memory allocated for the for structure. */
3287 kfree(dd->port);
3288
3289 return 0;
3290}
3291
3292/*
3293 * Issue a Standby Immediate command to the device.
3294 *
3295 * This function is called by the Block Layer just before the
3296 * system powers off during a shutdown.
3297 *
3298 * @dd Pointer to the driver data structure.
3299 *
3300 * return value
3301 * 0
3302 */
Jens Axboe63166682011-09-27 21:27:43 -06003303static int mtip_hw_shutdown(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003304{
3305 /*
3306 * Send standby immediate (E0h) to the drive so that it
3307 * saves its state.
3308 */
3309 mtip_standby_immediate(dd->port);
3310
3311 return 0;
3312}
3313
3314/*
3315 * Suspend function
3316 *
3317 * This function is called by the Block Layer just before the
3318 * system hibernates.
3319 *
3320 * @dd Pointer to the driver data structure.
3321 *
3322 * return value
3323 * 0 Suspend was successful
3324 * -EFAULT Suspend was not successful
3325 */
Jens Axboe63166682011-09-27 21:27:43 -06003326static int mtip_hw_suspend(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003327{
3328 /*
3329 * Send standby immediate (E0h) to the drive
3330 * so that it saves its state.
3331 */
3332 if (mtip_standby_immediate(dd->port) != 0) {
3333 dev_err(&dd->pdev->dev,
3334 "Failed standby-immediate command\n");
3335 return -EFAULT;
3336 }
3337
3338 /* Disable interrupts on the HBA.*/
3339 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3340 dd->mmio + HOST_CTL);
3341 mtip_deinit_port(dd->port);
3342
3343 return 0;
3344}
3345
3346/*
3347 * Resume function
3348 *
3349 * This function is called by the Block Layer as the
3350 * system resumes.
3351 *
3352 * @dd Pointer to the driver data structure.
3353 *
3354 * return value
3355 * 0 Resume was successful
3356 * -EFAULT Resume was not successful
3357 */
Jens Axboe63166682011-09-27 21:27:43 -06003358static int mtip_hw_resume(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003359{
3360 /* Perform any needed hardware setup steps */
3361 hba_setup(dd);
3362
3363 /* Reset the HBA */
3364 if (mtip_hba_reset(dd) != 0) {
3365 dev_err(&dd->pdev->dev,
3366 "Unable to reset the HBA\n");
3367 return -EFAULT;
3368 }
3369
3370 /*
3371 * Enable the port, DMA engine, and FIS reception specific
3372 * h/w in controller.
3373 */
3374 mtip_init_port(dd->port);
3375 mtip_start_port(dd->port);
3376
3377 /* Enable interrupts on the HBA.*/
3378 writel(readl(dd->mmio + HOST_CTL) | HOST_IRQ_EN,
3379 dd->mmio + HOST_CTL);
3380
3381 return 0;
3382}
3383
3384/*
Sam Bradshaw88523a62011-08-30 08:34:26 -06003385 * Helper function for reusing disk name
3386 * upon hot insertion.
3387 */
3388static int rssd_disk_name_format(char *prefix,
3389 int index,
3390 char *buf,
3391 int buflen)
3392{
3393 const int base = 'z' - 'a' + 1;
3394 char *begin = buf + strlen(prefix);
3395 char *end = buf + buflen;
3396 char *p;
3397 int unit;
3398
3399 p = end - 1;
3400 *p = '\0';
3401 unit = base;
3402 do {
3403 if (p == begin)
3404 return -EINVAL;
3405 *--p = 'a' + (index % unit);
3406 index = (index / unit) - 1;
3407 } while (index >= 0);
3408
3409 memmove(begin, p, end - p);
3410 memcpy(buf, prefix, strlen(prefix));
3411
3412 return 0;
3413}
3414
3415/*
3416 * Block layer IOCTL handler.
3417 *
3418 * @dev Pointer to the block_device structure.
3419 * @mode ignored
3420 * @cmd IOCTL command passed from the user application.
3421 * @arg Argument passed from the user application.
3422 *
3423 * return value
3424 * 0 IOCTL completed successfully.
3425 * -ENOTTY IOCTL not supported or invalid driver data
3426 * structure pointer.
3427 */
3428static int mtip_block_ioctl(struct block_device *dev,
3429 fmode_t mode,
3430 unsigned cmd,
3431 unsigned long arg)
3432{
3433 struct driver_data *dd = dev->bd_disk->private_data;
3434
3435 if (!capable(CAP_SYS_ADMIN))
3436 return -EACCES;
3437
3438 if (!dd)
3439 return -ENOTTY;
3440
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003441 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)))
Asai Thambi S P45038362012-04-09 08:35:38 +02003442 return -ENOTTY;
3443
Sam Bradshaw88523a62011-08-30 08:34:26 -06003444 switch (cmd) {
3445 case BLKFLSBUF:
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003446 return -ENOTTY;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003447 default:
Jens Axboeef0f1582011-09-27 21:19:53 -06003448 return mtip_hw_ioctl(dd, cmd, arg);
Sam Bradshaw88523a62011-08-30 08:34:26 -06003449 }
3450}
3451
Jens Axboe16d02c02011-09-27 15:50:01 -06003452#ifdef CONFIG_COMPAT
Sam Bradshaw88523a62011-08-30 08:34:26 -06003453/*
3454 * Block layer compat IOCTL handler.
3455 *
3456 * @dev Pointer to the block_device structure.
3457 * @mode ignored
3458 * @cmd IOCTL command passed from the user application.
3459 * @arg Argument passed from the user application.
3460 *
3461 * return value
3462 * 0 IOCTL completed successfully.
3463 * -ENOTTY IOCTL not supported or invalid driver data
3464 * structure pointer.
3465 */
3466static int mtip_block_compat_ioctl(struct block_device *dev,
3467 fmode_t mode,
3468 unsigned cmd,
3469 unsigned long arg)
3470{
3471 struct driver_data *dd = dev->bd_disk->private_data;
3472
3473 if (!capable(CAP_SYS_ADMIN))
3474 return -EACCES;
3475
3476 if (!dd)
3477 return -ENOTTY;
3478
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003479 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)))
Asai Thambi S P45038362012-04-09 08:35:38 +02003480 return -ENOTTY;
3481
Sam Bradshaw88523a62011-08-30 08:34:26 -06003482 switch (cmd) {
3483 case BLKFLSBUF:
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003484 return -ENOTTY;
Jens Axboeef0f1582011-09-27 21:19:53 -06003485 case HDIO_DRIVE_TASKFILE: {
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003486 struct mtip_compat_ide_task_request_s __user *compat_req_task;
Jens Axboeef0f1582011-09-27 21:19:53 -06003487 ide_task_request_t req_task;
3488 int compat_tasksize, outtotal, ret;
3489
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003490 compat_tasksize =
3491 sizeof(struct mtip_compat_ide_task_request_s);
Jens Axboeef0f1582011-09-27 21:19:53 -06003492
3493 compat_req_task =
3494 (struct mtip_compat_ide_task_request_s __user *) arg;
3495
3496 if (copy_from_user(&req_task, (void __user *) arg,
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003497 compat_tasksize - (2 * sizeof(compat_long_t))))
Jens Axboeef0f1582011-09-27 21:19:53 -06003498 return -EFAULT;
3499
3500 if (get_user(req_task.out_size, &compat_req_task->out_size))
3501 return -EFAULT;
3502
3503 if (get_user(req_task.in_size, &compat_req_task->in_size))
3504 return -EFAULT;
3505
3506 outtotal = sizeof(struct mtip_compat_ide_task_request_s);
3507
3508 ret = exec_drive_taskfile(dd, (void __user *) arg,
3509 &req_task, outtotal);
3510
3511 if (copy_to_user((void __user *) arg, &req_task,
3512 compat_tasksize -
3513 (2 * sizeof(compat_long_t))))
3514 return -EFAULT;
3515
3516 if (put_user(req_task.out_size, &compat_req_task->out_size))
3517 return -EFAULT;
3518
3519 if (put_user(req_task.in_size, &compat_req_task->in_size))
3520 return -EFAULT;
3521
3522 return ret;
3523 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06003524 default:
Jens Axboeef0f1582011-09-27 21:19:53 -06003525 return mtip_hw_ioctl(dd, cmd, arg);
Sam Bradshaw88523a62011-08-30 08:34:26 -06003526 }
3527}
Jens Axboe16d02c02011-09-27 15:50:01 -06003528#endif
Sam Bradshaw88523a62011-08-30 08:34:26 -06003529
3530/*
3531 * Obtain the geometry of the device.
3532 *
3533 * You may think that this function is obsolete, but some applications,
3534 * fdisk for example still used CHS values. This function describes the
3535 * device as having 224 heads and 56 sectors per cylinder. These values are
3536 * chosen so that each cylinder is aligned on a 4KB boundary. Since a
3537 * partition is described in terms of a start and end cylinder this means
3538 * that each partition is also 4KB aligned. Non-aligned partitions adversely
3539 * affects performance.
3540 *
3541 * @dev Pointer to the block_device strucutre.
3542 * @geo Pointer to a hd_geometry structure.
3543 *
3544 * return value
3545 * 0 Operation completed successfully.
3546 * -ENOTTY An error occurred while reading the drive capacity.
3547 */
3548static int mtip_block_getgeo(struct block_device *dev,
3549 struct hd_geometry *geo)
3550{
3551 struct driver_data *dd = dev->bd_disk->private_data;
3552 sector_t capacity;
3553
3554 if (!dd)
3555 return -ENOTTY;
3556
3557 if (!(mtip_hw_get_capacity(dd, &capacity))) {
3558 dev_warn(&dd->pdev->dev,
3559 "Could not get drive capacity.\n");
3560 return -ENOTTY;
3561 }
3562
3563 geo->heads = 224;
3564 geo->sectors = 56;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003565 sector_div(capacity, (geo->heads * geo->sectors));
Sam Bradshaw88523a62011-08-30 08:34:26 -06003566 geo->cylinders = capacity;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003567 return 0;
3568}
3569
3570/*
3571 * Block device operation function.
3572 *
3573 * This structure contains pointers to the functions required by the block
3574 * layer.
3575 */
3576static const struct block_device_operations mtip_block_ops = {
3577 .ioctl = mtip_block_ioctl,
Jens Axboe16d02c02011-09-27 15:50:01 -06003578#ifdef CONFIG_COMPAT
Sam Bradshaw88523a62011-08-30 08:34:26 -06003579 .compat_ioctl = mtip_block_compat_ioctl,
Jens Axboe16d02c02011-09-27 15:50:01 -06003580#endif
Sam Bradshaw88523a62011-08-30 08:34:26 -06003581 .getgeo = mtip_block_getgeo,
3582 .owner = THIS_MODULE
3583};
3584
3585/*
3586 * Block layer make request function.
3587 *
3588 * This function is called by the kernel to process a BIO for
3589 * the P320 device.
3590 *
3591 * @queue Pointer to the request queue. Unused other than to obtain
3592 * the driver data structure.
3593 * @bio Pointer to the BIO.
3594 *
Sam Bradshaw88523a62011-08-30 08:34:26 -06003595 */
Jens Axboea71f4832011-11-05 08:36:21 +01003596static void mtip_make_request(struct request_queue *queue, struct bio *bio)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003597{
3598 struct driver_data *dd = queue->queuedata;
3599 struct scatterlist *sg;
3600 struct bio_vec *bvec;
3601 int nents = 0;
3602 int tag = 0;
3603
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02003604 if (unlikely(dd->dd_flag & MTIP_DDF_STOP_IO)) {
3605 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
3606 &dd->dd_flag))) {
3607 bio_endio(bio, -ENXIO);
3608 return;
3609 }
3610 if (unlikely(test_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag))) {
3611 bio_endio(bio, -ENODATA);
3612 return;
3613 }
3614 if (unlikely(test_bit(MTIP_DDF_WRITE_PROTECT_BIT,
3615 &dd->dd_flag) &&
3616 bio_data_dir(bio))) {
3617 bio_endio(bio, -ENODATA);
3618 return;
3619 }
Asai Thambi S P12a166c2012-09-05 22:01:36 +05303620 if (unlikely(test_bit(MTIP_DDF_SEC_LOCK_BIT, &dd->dd_flag))) {
3621 bio_endio(bio, -ENODATA);
3622 return;
3623 }
Asai Thambi S P45038362012-04-09 08:35:38 +02003624 }
3625
Sam Bradshaw88523a62011-08-30 08:34:26 -06003626 if (unlikely(!bio_has_data(bio))) {
3627 blk_queue_flush(queue, 0);
3628 bio_endio(bio, 0);
Jens Axboea71f4832011-11-05 08:36:21 +01003629 return;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003630 }
3631
Sam Bradshaw88523a62011-08-30 08:34:26 -06003632 sg = mtip_hw_get_scatterlist(dd, &tag);
3633 if (likely(sg != NULL)) {
3634 blk_queue_bounce(queue, &bio);
3635
3636 if (unlikely((bio)->bi_vcnt > MTIP_MAX_SG)) {
3637 dev_warn(&dd->pdev->dev,
Asai Thambi S P45038362012-04-09 08:35:38 +02003638 "Maximum number of SGL entries exceeded\n");
Sam Bradshaw88523a62011-08-30 08:34:26 -06003639 bio_io_error(bio);
3640 mtip_hw_release_scatterlist(dd, tag);
Jens Axboea71f4832011-11-05 08:36:21 +01003641 return;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003642 }
3643
3644 /* Create the scatter list for this bio. */
3645 bio_for_each_segment(bvec, bio, nents) {
3646 sg_set_page(&sg[nents],
3647 bvec->bv_page,
3648 bvec->bv_len,
3649 bvec->bv_offset);
3650 }
3651
3652 /* Issue the read/write. */
3653 mtip_hw_submit_io(dd,
3654 bio->bi_sector,
3655 bio_sectors(bio),
3656 nents,
3657 tag,
3658 bio_endio,
3659 bio,
Sam Bradshaw88523a62011-08-30 08:34:26 -06003660 bio_data_dir(bio));
Jens Axboea71f4832011-11-05 08:36:21 +01003661 } else
Sam Bradshaw88523a62011-08-30 08:34:26 -06003662 bio_io_error(bio);
Sam Bradshaw88523a62011-08-30 08:34:26 -06003663}
3664
3665/*
3666 * Block layer initialization function.
3667 *
3668 * This function is called once by the PCI layer for each P320
3669 * device that is connected to the system.
3670 *
3671 * @dd Pointer to the driver data structure.
3672 *
3673 * return value
3674 * 0 on success else an error code.
3675 */
Jens Axboe63166682011-09-27 21:27:43 -06003676static int mtip_block_initialize(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003677{
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003678 int rv = 0, wait_for_rebuild = 0;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003679 sector_t capacity;
3680 unsigned int index = 0;
3681 struct kobject *kobj;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003682 unsigned char thd_name[16];
Sam Bradshaw88523a62011-08-30 08:34:26 -06003683
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003684 if (dd->disk)
3685 goto skip_create_disk; /* hw init done, before rebuild */
3686
Sam Bradshaw88523a62011-08-30 08:34:26 -06003687 /* Initialize the protocol layer. */
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003688 wait_for_rebuild = mtip_hw_init(dd);
3689 if (wait_for_rebuild < 0) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06003690 dev_err(&dd->pdev->dev,
3691 "Protocol layer initialization failed\n");
3692 rv = -EINVAL;
3693 goto protocol_init_error;
3694 }
3695
Sam Bradshaw88523a62011-08-30 08:34:26 -06003696 dd->disk = alloc_disk(MTIP_MAX_MINORS);
3697 if (dd->disk == NULL) {
3698 dev_err(&dd->pdev->dev,
3699 "Unable to allocate gendisk structure\n");
3700 rv = -EINVAL;
3701 goto alloc_disk_error;
3702 }
3703
3704 /* Generate the disk name, implemented same as in sd.c */
3705 do {
3706 if (!ida_pre_get(&rssd_index_ida, GFP_KERNEL))
3707 goto ida_get_error;
3708
3709 spin_lock(&rssd_index_lock);
3710 rv = ida_get_new(&rssd_index_ida, &index);
3711 spin_unlock(&rssd_index_lock);
3712 } while (rv == -EAGAIN);
3713
3714 if (rv)
3715 goto ida_get_error;
3716
3717 rv = rssd_disk_name_format("rssd",
3718 index,
3719 dd->disk->disk_name,
3720 DISK_NAME_LEN);
3721 if (rv)
3722 goto disk_index_error;
3723
3724 dd->disk->driverfs_dev = &dd->pdev->dev;
3725 dd->disk->major = dd->major;
3726 dd->disk->first_minor = dd->instance * MTIP_MAX_MINORS;
3727 dd->disk->fops = &mtip_block_ops;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003728 dd->disk->private_data = dd;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003729 dd->index = index;
3730
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003731 /*
3732 * if rebuild pending, start the service thread, and delay the block
3733 * queue creation and add_disk()
3734 */
3735 if (wait_for_rebuild == MTIP_FTL_REBUILD_MAGIC)
3736 goto start_service_thread;
3737
3738skip_create_disk:
3739 /* Allocate the request queue. */
3740 dd->queue = blk_alloc_queue(GFP_KERNEL);
3741 if (dd->queue == NULL) {
3742 dev_err(&dd->pdev->dev,
3743 "Unable to allocate request queue\n");
3744 rv = -ENOMEM;
3745 goto block_queue_alloc_init_error;
3746 }
3747
3748 /* Attach our request function to the request queue. */
3749 blk_queue_make_request(dd->queue, mtip_make_request);
3750
3751 dd->disk->queue = dd->queue;
3752 dd->queue->queuedata = dd;
3753
3754 /* Set device limits. */
3755 set_bit(QUEUE_FLAG_NONROT, &dd->queue->queue_flags);
3756 blk_queue_max_segments(dd->queue, MTIP_MAX_SG);
3757 blk_queue_physical_block_size(dd->queue, 4096);
Asai Thambi S P6c8ab692012-05-29 18:42:51 -07003758 blk_queue_max_hw_sectors(dd->queue, 0xffff);
3759 blk_queue_max_segment_size(dd->queue, 0x400000);
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003760 blk_queue_io_min(dd->queue, 4096);
Asai Thambi S P6c8ab692012-05-29 18:42:51 -07003761
Asai Thambi S P4e8670e2012-02-07 07:54:31 +01003762 /*
3763 * write back cache is not supported in the device. FUA depends on
3764 * write back cache support, hence setting flush support to zero.
3765 */
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003766 blk_queue_flush(dd->queue, 0);
3767
Sam Bradshaw88523a62011-08-30 08:34:26 -06003768 /* Set the capacity of the device in 512 byte sectors. */
3769 if (!(mtip_hw_get_capacity(dd, &capacity))) {
3770 dev_warn(&dd->pdev->dev,
3771 "Could not read drive capacity\n");
3772 rv = -EIO;
3773 goto read_capacity_error;
3774 }
3775 set_capacity(dd->disk, capacity);
3776
3777 /* Enable the block device and add it to /dev */
3778 add_disk(dd->disk);
3779
3780 /*
3781 * Now that the disk is active, initialize any sysfs attributes
3782 * managed by the protocol layer.
3783 */
3784 kobj = kobject_get(&disk_to_dev(dd->disk)->kobj);
3785 if (kobj) {
3786 mtip_hw_sysfs_init(dd, kobj);
3787 kobject_put(kobj);
3788 }
Asai Thambi S P7b421d22012-06-04 12:44:02 -07003789 mtip_hw_debugfs_init(dd);
Sam Bradshaw88523a62011-08-30 08:34:26 -06003790
Asai Thambi S P45038362012-04-09 08:35:38 +02003791 if (dd->mtip_svc_handler) {
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003792 set_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag);
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003793 return rv; /* service thread created for handling rebuild */
Asai Thambi S P45038362012-04-09 08:35:38 +02003794 }
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003795
3796start_service_thread:
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003797 sprintf(thd_name, "mtip_svc_thd_%02d", index);
3798
3799 dd->mtip_svc_handler = kthread_run(mtip_service_thread,
3800 dd, thd_name);
3801
3802 if (IS_ERR(dd->mtip_svc_handler)) {
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02003803 dev_err(&dd->pdev->dev, "service thread failed to start\n");
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003804 dd->mtip_svc_handler = NULL;
3805 rv = -EFAULT;
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003806 goto kthread_run_error;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003807 }
3808
Asai Thambi S P45038362012-04-09 08:35:38 +02003809 if (wait_for_rebuild == MTIP_FTL_REBUILD_MAGIC)
3810 rv = wait_for_rebuild;
3811
Sam Bradshaw88523a62011-08-30 08:34:26 -06003812 return rv;
3813
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003814kthread_run_error:
Asai Thambi S P7b421d22012-06-04 12:44:02 -07003815 mtip_hw_debugfs_exit(dd);
3816
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003817 /* Delete our gendisk. This also removes the device from /dev */
Sam Bradshaw88523a62011-08-30 08:34:26 -06003818 del_gendisk(dd->disk);
3819
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003820read_capacity_error:
3821 blk_cleanup_queue(dd->queue);
3822
3823block_queue_alloc_init_error:
Sam Bradshaw88523a62011-08-30 08:34:26 -06003824disk_index_error:
3825 spin_lock(&rssd_index_lock);
3826 ida_remove(&rssd_index_ida, index);
3827 spin_unlock(&rssd_index_lock);
3828
3829ida_get_error:
3830 put_disk(dd->disk);
3831
3832alloc_disk_error:
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003833 mtip_hw_exit(dd); /* De-initialize the protocol layer. */
Sam Bradshaw88523a62011-08-30 08:34:26 -06003834
3835protocol_init_error:
3836 return rv;
3837}
3838
3839/*
3840 * Block layer deinitialization function.
3841 *
3842 * Called by the PCI layer as each P320 device is removed.
3843 *
3844 * @dd Pointer to the driver data structure.
3845 *
3846 * return value
3847 * 0
3848 */
Jens Axboe63166682011-09-27 21:27:43 -06003849static int mtip_block_remove(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003850{
3851 struct kobject *kobj;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003852
3853 if (dd->mtip_svc_handler) {
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02003854 set_bit(MTIP_PF_SVC_THD_STOP_BIT, &dd->port->flags);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003855 wake_up_interruptible(&dd->port->svc_wait);
3856 kthread_stop(dd->mtip_svc_handler);
3857 }
3858
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003859 /* Clean up the sysfs attributes, if created */
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003860 if (test_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag)) {
Asai Thambi S P45038362012-04-09 08:35:38 +02003861 kobj = kobject_get(&disk_to_dev(dd->disk)->kobj);
3862 if (kobj) {
3863 mtip_hw_sysfs_exit(dd, kobj);
3864 kobject_put(kobj);
3865 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06003866 }
Asai Thambi S P7b421d22012-06-04 12:44:02 -07003867 mtip_hw_debugfs_exit(dd);
Sam Bradshaw88523a62011-08-30 08:34:26 -06003868
3869 /*
3870 * Delete our gendisk structure. This also removes the device
3871 * from /dev
3872 */
3873 del_gendisk(dd->disk);
Asai Thambi S P8182b492012-04-09 08:35:38 +02003874
3875 spin_lock(&rssd_index_lock);
3876 ida_remove(&rssd_index_ida, dd->index);
3877 spin_unlock(&rssd_index_lock);
3878
Sam Bradshaw88523a62011-08-30 08:34:26 -06003879 blk_cleanup_queue(dd->queue);
3880 dd->disk = NULL;
3881 dd->queue = NULL;
3882
3883 /* De-initialize the protocol layer. */
3884 mtip_hw_exit(dd);
3885
3886 return 0;
3887}
3888
3889/*
3890 * Function called by the PCI layer when just before the
3891 * machine shuts down.
3892 *
3893 * If a protocol layer shutdown function is present it will be called
3894 * by this function.
3895 *
3896 * @dd Pointer to the driver data structure.
3897 *
3898 * return value
3899 * 0
3900 */
Jens Axboe63166682011-09-27 21:27:43 -06003901static int mtip_block_shutdown(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003902{
3903 dev_info(&dd->pdev->dev,
3904 "Shutting down %s ...\n", dd->disk->disk_name);
3905
3906 /* Delete our gendisk structure, and cleanup the blk queue. */
3907 del_gendisk(dd->disk);
Asai Thambi S P8182b492012-04-09 08:35:38 +02003908
3909 spin_lock(&rssd_index_lock);
3910 ida_remove(&rssd_index_ida, dd->index);
3911 spin_unlock(&rssd_index_lock);
3912
Sam Bradshaw88523a62011-08-30 08:34:26 -06003913 blk_cleanup_queue(dd->queue);
3914 dd->disk = NULL;
3915 dd->queue = NULL;
3916
3917 mtip_hw_shutdown(dd);
3918 return 0;
3919}
3920
Jens Axboe63166682011-09-27 21:27:43 -06003921static int mtip_block_suspend(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003922{
3923 dev_info(&dd->pdev->dev,
3924 "Suspending %s ...\n", dd->disk->disk_name);
3925 mtip_hw_suspend(dd);
3926 return 0;
3927}
3928
Jens Axboe63166682011-09-27 21:27:43 -06003929static int mtip_block_resume(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003930{
3931 dev_info(&dd->pdev->dev, "Resuming %s ...\n",
3932 dd->disk->disk_name);
3933 mtip_hw_resume(dd);
3934 return 0;
3935}
3936
3937/*
3938 * Called for each supported PCI device detected.
3939 *
3940 * This function allocates the private data structure, enables the
3941 * PCI device and then calls the block layer initialization function.
3942 *
3943 * return value
3944 * 0 on success else an error code.
3945 */
3946static int mtip_pci_probe(struct pci_dev *pdev,
3947 const struct pci_device_id *ent)
3948{
3949 int rv = 0;
3950 struct driver_data *dd = NULL;
3951
3952 /* Allocate memory for this devices private data. */
3953 dd = kzalloc(sizeof(struct driver_data), GFP_KERNEL);
3954 if (dd == NULL) {
3955 dev_err(&pdev->dev,
3956 "Unable to allocate memory for driver data\n");
3957 return -ENOMEM;
3958 }
3959
Sam Bradshaw88523a62011-08-30 08:34:26 -06003960 /* Attach the private data to this PCI device. */
3961 pci_set_drvdata(pdev, dd);
3962
3963 rv = pcim_enable_device(pdev);
3964 if (rv < 0) {
3965 dev_err(&pdev->dev, "Unable to enable device\n");
3966 goto iomap_err;
3967 }
3968
3969 /* Map BAR5 to memory. */
3970 rv = pcim_iomap_regions(pdev, 1 << MTIP_ABAR, MTIP_DRV_NAME);
3971 if (rv < 0) {
3972 dev_err(&pdev->dev, "Unable to map regions\n");
3973 goto iomap_err;
3974 }
3975
3976 if (!pci_set_dma_mask(pdev, DMA_BIT_MASK(64))) {
3977 rv = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
3978
3979 if (rv) {
3980 rv = pci_set_consistent_dma_mask(pdev,
3981 DMA_BIT_MASK(32));
3982 if (rv) {
3983 dev_warn(&pdev->dev,
3984 "64-bit DMA enable failed\n");
3985 goto setmask_err;
3986 }
3987 }
3988 }
3989
3990 pci_set_master(pdev);
3991
3992 if (pci_enable_msi(pdev)) {
3993 dev_warn(&pdev->dev,
3994 "Unable to enable MSI interrupt.\n");
3995 goto block_initialize_err;
3996 }
3997
3998 /* Copy the info we may need later into the private data structure. */
3999 dd->major = mtip_major;
Sam Bradshaw88523a62011-08-30 08:34:26 -06004000 dd->instance = instance;
4001 dd->pdev = pdev;
4002
4003 /* Initialize the block layer. */
4004 rv = mtip_block_initialize(dd);
4005 if (rv < 0) {
4006 dev_err(&pdev->dev,
4007 "Unable to initialize block layer\n");
4008 goto block_initialize_err;
4009 }
4010
4011 /*
4012 * Increment the instance count so that each device has a unique
4013 * instance number.
4014 */
4015 instance++;
Asai Thambi S P45038362012-04-09 08:35:38 +02004016 if (rv != MTIP_FTL_REBUILD_MAGIC)
Asai Thambi S P8a857a82012-04-09 08:35:38 +02004017 set_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag);
Sam Bradshaw88523a62011-08-30 08:34:26 -06004018 goto done;
4019
4020block_initialize_err:
4021 pci_disable_msi(pdev);
4022
4023setmask_err:
4024 pcim_iounmap_regions(pdev, 1 << MTIP_ABAR);
4025
4026iomap_err:
4027 kfree(dd);
4028 pci_set_drvdata(pdev, NULL);
4029 return rv;
4030done:
Sam Bradshaw88523a62011-08-30 08:34:26 -06004031 return rv;
4032}
4033
4034/*
4035 * Called for each probed device when the device is removed or the
4036 * driver is unloaded.
4037 *
4038 * return value
4039 * None
4040 */
4041static void mtip_pci_remove(struct pci_dev *pdev)
4042{
4043 struct driver_data *dd = pci_get_drvdata(pdev);
4044 int counter = 0;
4045
Asai Thambi S P8a857a82012-04-09 08:35:38 +02004046 set_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag);
Asai Thambi S P45038362012-04-09 08:35:38 +02004047
Sam Bradshaw88523a62011-08-30 08:34:26 -06004048 if (mtip_check_surprise_removal(pdev)) {
Asai Thambi S P8a857a82012-04-09 08:35:38 +02004049 while (!test_bit(MTIP_DDF_CLEANUP_BIT, &dd->dd_flag)) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06004050 counter++;
4051 msleep(20);
4052 if (counter == 10) {
4053 /* Cleanup the outstanding commands */
4054 mtip_command_cleanup(dd);
4055 break;
4056 }
4057 }
4058 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06004059
4060 /* Clean up the block layer. */
4061 mtip_block_remove(dd);
4062
4063 pci_disable_msi(pdev);
4064
4065 kfree(dd);
4066 pcim_iounmap_regions(pdev, 1 << MTIP_ABAR);
4067}
4068
4069/*
4070 * Called for each probed device when the device is suspended.
4071 *
4072 * return value
4073 * 0 Success
4074 * <0 Error
4075 */
4076static int mtip_pci_suspend(struct pci_dev *pdev, pm_message_t mesg)
4077{
4078 int rv = 0;
4079 struct driver_data *dd = pci_get_drvdata(pdev);
4080
4081 if (!dd) {
4082 dev_err(&pdev->dev,
4083 "Driver private datastructure is NULL\n");
4084 return -EFAULT;
4085 }
4086
Asai Thambi S P8a857a82012-04-09 08:35:38 +02004087 set_bit(MTIP_DDF_RESUME_BIT, &dd->dd_flag);
Sam Bradshaw88523a62011-08-30 08:34:26 -06004088
4089 /* Disable ports & interrupts then send standby immediate */
4090 rv = mtip_block_suspend(dd);
4091 if (rv < 0) {
4092 dev_err(&pdev->dev,
4093 "Failed to suspend controller\n");
4094 return rv;
4095 }
4096
4097 /*
4098 * Save the pci config space to pdev structure &
4099 * disable the device
4100 */
4101 pci_save_state(pdev);
4102 pci_disable_device(pdev);
4103
4104 /* Move to Low power state*/
4105 pci_set_power_state(pdev, PCI_D3hot);
4106
4107 return rv;
4108}
4109
4110/*
4111 * Called for each probed device when the device is resumed.
4112 *
4113 * return value
4114 * 0 Success
4115 * <0 Error
4116 */
4117static int mtip_pci_resume(struct pci_dev *pdev)
4118{
4119 int rv = 0;
4120 struct driver_data *dd;
4121
4122 dd = pci_get_drvdata(pdev);
4123 if (!dd) {
4124 dev_err(&pdev->dev,
4125 "Driver private datastructure is NULL\n");
4126 return -EFAULT;
4127 }
4128
4129 /* Move the device to active State */
4130 pci_set_power_state(pdev, PCI_D0);
4131
4132 /* Restore PCI configuration space */
4133 pci_restore_state(pdev);
4134
4135 /* Enable the PCI device*/
4136 rv = pcim_enable_device(pdev);
4137 if (rv < 0) {
4138 dev_err(&pdev->dev,
4139 "Failed to enable card during resume\n");
4140 goto err;
4141 }
4142 pci_set_master(pdev);
4143
4144 /*
4145 * Calls hbaReset, initPort, & startPort function
4146 * then enables interrupts
4147 */
4148 rv = mtip_block_resume(dd);
4149 if (rv < 0)
4150 dev_err(&pdev->dev, "Unable to resume\n");
4151
4152err:
Asai Thambi S P8a857a82012-04-09 08:35:38 +02004153 clear_bit(MTIP_DDF_RESUME_BIT, &dd->dd_flag);
Sam Bradshaw88523a62011-08-30 08:34:26 -06004154
4155 return rv;
4156}
4157
4158/*
4159 * Shutdown routine
4160 *
4161 * return value
4162 * None
4163 */
4164static void mtip_pci_shutdown(struct pci_dev *pdev)
4165{
4166 struct driver_data *dd = pci_get_drvdata(pdev);
4167 if (dd)
4168 mtip_block_shutdown(dd);
4169}
4170
Sam Bradshaw88523a62011-08-30 08:34:26 -06004171/* Table of device ids supported by this driver. */
4172static DEFINE_PCI_DEVICE_TABLE(mtip_pci_tbl) = {
Asai Thambi S P1a131452012-09-05 22:00:38 +05304173 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P320H_DEVICE_ID) },
4174 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P320M_DEVICE_ID) },
4175 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P320S_DEVICE_ID) },
4176 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P325M_DEVICE_ID) },
4177 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P420H_DEVICE_ID) },
4178 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P420M_DEVICE_ID) },
4179 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P425M_DEVICE_ID) },
Sam Bradshaw88523a62011-08-30 08:34:26 -06004180 { 0 }
4181};
4182
4183/* Structure that describes the PCI driver functions. */
Jens Axboe3ff147d2011-09-27 21:33:53 -06004184static struct pci_driver mtip_pci_driver = {
Sam Bradshaw88523a62011-08-30 08:34:26 -06004185 .name = MTIP_DRV_NAME,
4186 .id_table = mtip_pci_tbl,
4187 .probe = mtip_pci_probe,
4188 .remove = mtip_pci_remove,
4189 .suspend = mtip_pci_suspend,
4190 .resume = mtip_pci_resume,
4191 .shutdown = mtip_pci_shutdown,
4192};
4193
4194MODULE_DEVICE_TABLE(pci, mtip_pci_tbl);
4195
4196/*
4197 * Module initialization function.
4198 *
4199 * Called once when the module is loaded. This function allocates a major
4200 * block device number to the Cyclone devices and registers the PCI layer
4201 * of the driver.
4202 *
4203 * Return value
4204 * 0 on success else error code.
4205 */
4206static int __init mtip_init(void)
4207{
Ryosuke Saito6d27f092012-04-05 08:09:34 -06004208 int error;
4209
Asai Thambi S P45422e72012-09-05 22:03:56 +05304210 pr_info(MTIP_DRV_NAME " Version " MTIP_DRV_VERSION "\n");
Sam Bradshaw88523a62011-08-30 08:34:26 -06004211
4212 /* Allocate a major block device number to use with this driver. */
Ryosuke Saito6d27f092012-04-05 08:09:34 -06004213 error = register_blkdev(0, MTIP_DRV_NAME);
4214 if (error <= 0) {
Asai Thambi S P45422e72012-09-05 22:03:56 +05304215 pr_err("Unable to register block device (%d)\n",
Ryosuke Saito6d27f092012-04-05 08:09:34 -06004216 error);
Sam Bradshaw88523a62011-08-30 08:34:26 -06004217 return -EBUSY;
4218 }
Ryosuke Saito6d27f092012-04-05 08:09:34 -06004219 mtip_major = error;
Sam Bradshaw88523a62011-08-30 08:34:26 -06004220
Asai Thambi S P7b421d22012-06-04 12:44:02 -07004221 if (!dfs_parent) {
4222 dfs_parent = debugfs_create_dir("rssd", NULL);
4223 if (IS_ERR_OR_NULL(dfs_parent)) {
Asai Thambi S P45422e72012-09-05 22:03:56 +05304224 pr_warn("Error creating debugfs parent\n");
Asai Thambi S P7b421d22012-06-04 12:44:02 -07004225 dfs_parent = NULL;
4226 }
4227 }
4228
Sam Bradshaw88523a62011-08-30 08:34:26 -06004229 /* Register our PCI operations. */
Ryosuke Saito6d27f092012-04-05 08:09:34 -06004230 error = pci_register_driver(&mtip_pci_driver);
Asai Thambi S P7b421d22012-06-04 12:44:02 -07004231 if (error) {
4232 debugfs_remove(dfs_parent);
Ryosuke Saito6d27f092012-04-05 08:09:34 -06004233 unregister_blkdev(mtip_major, MTIP_DRV_NAME);
Asai Thambi S P7b421d22012-06-04 12:44:02 -07004234 }
Ryosuke Saito6d27f092012-04-05 08:09:34 -06004235
4236 return error;
Sam Bradshaw88523a62011-08-30 08:34:26 -06004237}
4238
4239/*
4240 * Module de-initialization function.
4241 *
4242 * Called once when the module is unloaded. This function deallocates
4243 * the major block device number allocated by mtip_init() and
4244 * unregisters the PCI layer of the driver.
4245 *
4246 * Return value
4247 * none
4248 */
4249static void __exit mtip_exit(void)
4250{
Asai Thambi S P7b421d22012-06-04 12:44:02 -07004251 debugfs_remove_recursive(dfs_parent);
4252
Sam Bradshaw88523a62011-08-30 08:34:26 -06004253 /* Release the allocated major block device number. */
4254 unregister_blkdev(mtip_major, MTIP_DRV_NAME);
4255
4256 /* Unregister the PCI driver. */
4257 pci_unregister_driver(&mtip_pci_driver);
4258}
4259
4260MODULE_AUTHOR("Micron Technology, Inc");
4261MODULE_DESCRIPTION("Micron RealSSD PCIe Block Driver");
4262MODULE_LICENSE("GPL");
4263MODULE_VERSION(MTIP_DRV_VERSION);
4264
4265module_init(mtip_init);
4266module_exit(mtip_exit);