blob: 4b057a7312d7f5be62c13dd123c64dcf0061dacb [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>
Sam Bradshaw88523a62011-08-30 08:34:26 -060040#include "mtip32xx.h"
41
42#define HW_CMD_SLOT_SZ (MTIP_MAX_COMMAND_SLOTS * 32)
43#define HW_CMD_TBL_SZ (AHCI_CMD_TBL_HDR_SZ + (MTIP_MAX_SG * 16))
44#define HW_CMD_TBL_AR_SZ (HW_CMD_TBL_SZ * MTIP_MAX_COMMAND_SLOTS)
45#define HW_PORT_PRIV_DMA_SZ \
46 (HW_CMD_SLOT_SZ + HW_CMD_TBL_AR_SZ + AHCI_RX_FIS_SZ)
47
Asai Thambi S P45038362012-04-09 08:35:38 +020048#define HOST_CAP_NZDMA (1 << 19)
Sam Bradshaw88523a62011-08-30 08:34:26 -060049#define HOST_HSORG 0xFC
50#define HSORG_DISABLE_SLOTGRP_INTR (1<<24)
51#define HSORG_DISABLE_SLOTGRP_PXIS (1<<16)
52#define HSORG_HWREV 0xFF00
53#define HSORG_STYLE 0x8
54#define HSORG_SLOTGROUPS 0x7
55
56#define PORT_COMMAND_ISSUE 0x38
57#define PORT_SDBV 0x7C
58
59#define PORT_OFFSET 0x100
60#define PORT_MEM_SIZE 0x80
61
62#define PORT_IRQ_ERR \
63 (PORT_IRQ_HBUS_ERR | PORT_IRQ_IF_ERR | PORT_IRQ_CONNECT | \
64 PORT_IRQ_PHYRDY | PORT_IRQ_UNK_FIS | PORT_IRQ_BAD_PMP | \
65 PORT_IRQ_TF_ERR | PORT_IRQ_HBUS_DATA_ERR | PORT_IRQ_IF_NONFATAL | \
66 PORT_IRQ_OVERFLOW)
67#define PORT_IRQ_LEGACY \
68 (PORT_IRQ_PIOS_FIS | PORT_IRQ_D2H_REG_FIS)
69#define PORT_IRQ_HANDLED \
70 (PORT_IRQ_SDB_FIS | PORT_IRQ_LEGACY | \
71 PORT_IRQ_TF_ERR | PORT_IRQ_IF_ERR | \
72 PORT_IRQ_CONNECT | PORT_IRQ_PHYRDY)
73#define DEF_PORT_IRQ \
74 (PORT_IRQ_ERR | PORT_IRQ_LEGACY | PORT_IRQ_SDB_FIS)
75
76/* product numbers */
77#define MTIP_PRODUCT_UNKNOWN 0x00
78#define MTIP_PRODUCT_ASICFPGA 0x11
79
80/* Device instance number, incremented each time a device is probed. */
81static int instance;
82
83/*
84 * Global variable used to hold the major block device number
85 * allocated in mtip_init().
86 */
Jens Axboe3ff147d2011-09-27 21:33:53 -060087static int mtip_major;
Sam Bradshaw88523a62011-08-30 08:34:26 -060088
89static DEFINE_SPINLOCK(rssd_index_lock);
90static DEFINE_IDA(rssd_index_ida);
91
Asai Thambi S P62ee8c12012-01-04 22:01:32 +010092static int mtip_block_initialize(struct driver_data *dd);
93
Jens Axboe16d02c02011-09-27 15:50:01 -060094#ifdef CONFIG_COMPAT
Sam Bradshaw88523a62011-08-30 08:34:26 -060095struct mtip_compat_ide_task_request_s {
96 __u8 io_ports[8];
97 __u8 hob_ports[8];
98 ide_reg_valid_t out_flags;
99 ide_reg_valid_t in_flags;
100 int data_phase;
101 int req_cmd;
102 compat_ulong_t out_size;
103 compat_ulong_t in_size;
104};
Jens Axboe16d02c02011-09-27 15:50:01 -0600105#endif
Sam Bradshaw88523a62011-08-30 08:34:26 -0600106
Sam Bradshaw88523a62011-08-30 08:34:26 -0600107/*
Jens Axboe63166682011-09-27 21:27:43 -0600108 * This function check_for_surprise_removal is called
109 * while card is removed from the system and it will
110 * read the vendor id from the configration space
111 *
112 * @pdev Pointer to the pci_dev structure.
113 *
114 * return value
115 * true if device removed, else false
116 */
117static bool mtip_check_surprise_removal(struct pci_dev *pdev)
118{
119 u16 vendor_id = 0;
120
121 /* Read the vendorID from the configuration space */
122 pci_read_config_word(pdev, 0x00, &vendor_id);
123 if (vendor_id == 0xFFFF)
124 return true; /* device removed */
125
126 return false; /* device present */
127}
128
129/*
130 * This function is called for clean the pending command in the
131 * command slot during the surprise removal of device and return
132 * error to the upper layer.
133 *
134 * @dd Pointer to the DRIVER_DATA structure.
135 *
136 * return value
137 * None
138 */
139static void mtip_command_cleanup(struct driver_data *dd)
140{
141 int group = 0, commandslot = 0, commandindex = 0;
142 struct mtip_cmd *command;
143 struct mtip_port *port = dd->port;
Asai Thambi S P45038362012-04-09 08:35:38 +0200144 static int in_progress;
145
146 if (in_progress)
147 return;
148
149 in_progress = 1;
Jens Axboe63166682011-09-27 21:27:43 -0600150
151 for (group = 0; group < 4; group++) {
152 for (commandslot = 0; commandslot < 32; commandslot++) {
153 if (!(port->allocated[group] & (1 << commandslot)))
154 continue;
155
156 commandindex = group << 5 | commandslot;
157 command = &port->commands[commandindex];
158
159 if (atomic_read(&command->active)
160 && (command->async_callback)) {
161 command->async_callback(command->async_data,
162 -ENODEV);
163 command->async_callback = NULL;
164 command->async_data = NULL;
165 }
166
167 dma_unmap_sg(&port->dd->pdev->dev,
168 command->sg,
169 command->scatter_ents,
170 command->direction);
171 }
172 }
173
174 up(&port->cmd_slot);
175
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200176 set_bit(MTIP_DDF_CLEANUP_BIT, &dd->dd_flag);
Asai Thambi S P45038362012-04-09 08:35:38 +0200177 in_progress = 0;
Jens Axboe63166682011-09-27 21:27:43 -0600178}
179
180/*
Sam Bradshaw88523a62011-08-30 08:34:26 -0600181 * Obtain an empty command slot.
182 *
183 * This function needs to be reentrant since it could be called
184 * at the same time on multiple CPUs. The allocation of the
185 * command slot must be atomic.
186 *
187 * @port Pointer to the port data structure.
188 *
189 * return value
190 * >= 0 Index of command slot obtained.
191 * -1 No command slots available.
192 */
193static int get_slot(struct mtip_port *port)
194{
195 int slot, i;
196 unsigned int num_command_slots = port->dd->slot_groups * 32;
197
198 /*
199 * Try 10 times, because there is a small race here.
200 * that's ok, because it's still cheaper than a lock.
201 *
202 * Race: Since this section is not protected by lock, same bit
203 * could be chosen by different process contexts running in
204 * different processor. So instead of costly lock, we are going
205 * with loop.
206 */
207 for (i = 0; i < 10; i++) {
208 slot = find_next_zero_bit(port->allocated,
209 num_command_slots, 1);
210 if ((slot < num_command_slots) &&
211 (!test_and_set_bit(slot, port->allocated)))
212 return slot;
213 }
214 dev_warn(&port->dd->pdev->dev, "Failed to get a tag.\n");
215
216 if (mtip_check_surprise_removal(port->dd->pdev)) {
217 /* Device not present, clean outstanding commands */
218 mtip_command_cleanup(port->dd);
219 }
220 return -1;
221}
222
223/*
224 * Release a command slot.
225 *
226 * @port Pointer to the port data structure.
227 * @tag Tag of command to release
228 *
229 * return value
230 * None
231 */
232static inline void release_slot(struct mtip_port *port, int tag)
233{
234 smp_mb__before_clear_bit();
235 clear_bit(tag, port->allocated);
236 smp_mb__after_clear_bit();
237}
238
239/*
Jens Axboe63166682011-09-27 21:27:43 -0600240 * Reset the HBA (without sleeping)
241 *
242 * Just like hba_reset, except does not call sleep, so can be
243 * run from interrupt/tasklet context.
244 *
245 * @dd Pointer to the driver data structure.
246 *
247 * return value
248 * 0 The reset was successful.
249 * -1 The HBA Reset bit did not clear.
250 */
251static int hba_reset_nosleep(struct driver_data *dd)
252{
253 unsigned long timeout;
254
255 /* Chip quirk: quiesce any chip function */
256 mdelay(10);
257
258 /* Set the reset bit */
259 writel(HOST_RESET, dd->mmio + HOST_CTL);
260
261 /* Flush */
262 readl(dd->mmio + HOST_CTL);
263
264 /*
265 * Wait 10ms then spin for up to 1 second
266 * waiting for reset acknowledgement
267 */
268 timeout = jiffies + msecs_to_jiffies(1000);
269 mdelay(10);
270 while ((readl(dd->mmio + HOST_CTL) & HOST_RESET)
271 && time_before(jiffies, timeout))
272 mdelay(1);
273
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200274 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))
Asai Thambi S P45038362012-04-09 08:35:38 +0200275 return -1;
276
Jens Axboe63166682011-09-27 21:27:43 -0600277 if (readl(dd->mmio + HOST_CTL) & HOST_RESET)
278 return -1;
279
280 return 0;
281}
282
283/*
Sam Bradshaw88523a62011-08-30 08:34:26 -0600284 * Issue a command to the hardware.
285 *
286 * Set the appropriate bit in the s_active and Command Issue hardware
287 * registers, causing hardware command processing to begin.
288 *
289 * @port Pointer to the port structure.
290 * @tag The tag of the command to be issued.
291 *
292 * return value
293 * None
294 */
295static inline void mtip_issue_ncq_command(struct mtip_port *port, int tag)
296{
297 unsigned long flags = 0;
298
299 atomic_set(&port->commands[tag].active, 1);
300
301 spin_lock_irqsave(&port->cmd_issue_lock, flags);
302
303 writel((1 << MTIP_TAG_BIT(tag)),
304 port->s_active[MTIP_TAG_INDEX(tag)]);
305 writel((1 << MTIP_TAG_BIT(tag)),
306 port->cmd_issue[MTIP_TAG_INDEX(tag)]);
307
308 spin_unlock_irqrestore(&port->cmd_issue_lock, flags);
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);
784
Asai Thambi S P95fea2f2012-04-09 08:35:39 +0200785 /* clear the tag accumulator */
786 memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
787
Sam Bradshaw88523a62011-08-30 08:34:26 -0600788 /* Set eh_active */
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200789 set_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600790
791 /* Loop through all the groups */
792 for (group = 0; group < dd->slot_groups; group++) {
793 completed = readl(port->completed[group]);
794
795 /* clear completed status register in the hardware.*/
796 writel(completed, port->completed[group]);
797
Sam Bradshaw88523a62011-08-30 08:34:26 -0600798 /* Process successfully completed commands */
799 for (bit = 0; bit < 32 && completed; bit++) {
800 if (!(completed & (1<<bit)))
801 continue;
802 tag = (group << 5) + bit;
803
804 /* Skip the internal command slot */
805 if (tag == MTIP_TAG_INTERNAL)
806 continue;
807
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200808 cmd = &port->commands[tag];
809 if (likely(cmd->comp_func)) {
Sam Bradshaw88523a62011-08-30 08:34:26 -0600810 set_bit(tag, tagaccum);
Asai Thambi S P95fea2f2012-04-09 08:35:39 +0200811 cmd_cnt++;
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200812 atomic_set(&cmd->active, 0);
813 cmd->comp_func(port,
Sam Bradshaw88523a62011-08-30 08:34:26 -0600814 tag,
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200815 cmd->comp_data,
Sam Bradshaw88523a62011-08-30 08:34:26 -0600816 0);
817 } else {
818 dev_err(&port->dd->pdev->dev,
819 "Missing completion func for tag %d",
820 tag);
821 if (mtip_check_surprise_removal(dd->pdev)) {
822 mtip_command_cleanup(dd);
823 /* don't proceed further */
824 return;
825 }
826 }
827 }
828 }
Asai Thambi S P95fea2f2012-04-09 08:35:39 +0200829
830 print_tags(dd, "completed (TFE)", tagaccum, cmd_cnt);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600831
832 /* Restart the port */
833 mdelay(20);
834 mtip_restart_port(port);
835
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200836 /* Trying to determine the cause of the error */
837 rv = mtip_read_log_page(dd->port, ATA_LOG_SATA_NCQ,
838 dd->port->log_buf,
839 dd->port->log_buf_dma, 1);
840 if (rv) {
841 dev_warn(&dd->pdev->dev,
842 "Error in READ LOG EXT (10h) command\n");
843 /* non-critical error, don't fail the load */
844 } else {
845 buf = (unsigned char *)dd->port->log_buf;
846 if (buf[259] & 0x1) {
847 dev_info(&dd->pdev->dev,
848 "Write protect bit is set.\n");
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200849 set_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag);
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200850 fail_all_ncq_write = 1;
851 fail_reason = "write protect";
852 }
853 if (buf[288] == 0xF7) {
854 dev_info(&dd->pdev->dev,
855 "Exceeded Tmax, drive in thermal shutdown.\n");
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200856 set_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag);
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200857 fail_all_ncq_cmds = 1;
858 fail_reason = "thermal shutdown";
859 }
860 if (buf[288] == 0xBF) {
861 dev_info(&dd->pdev->dev,
862 "Drive indicates rebuild has failed.\n");
863 fail_all_ncq_cmds = 1;
864 fail_reason = "rebuild failed";
865 }
866 }
867
Sam Bradshaw88523a62011-08-30 08:34:26 -0600868 /* clear the tag accumulator */
869 memset(tagaccum, 0, SLOTBITS_IN_LONGS * sizeof(long));
870
871 /* Loop through all the groups */
872 for (group = 0; group < dd->slot_groups; group++) {
873 for (bit = 0; bit < 32; bit++) {
874 reissue = 1;
875 tag = (group << 5) + bit;
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200876 cmd = &port->commands[tag];
Sam Bradshaw88523a62011-08-30 08:34:26 -0600877
878 /* If the active bit is set re-issue the command */
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200879 if (atomic_read(&cmd->active) == 0)
Sam Bradshaw88523a62011-08-30 08:34:26 -0600880 continue;
881
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200882 fis = (struct host_to_dev_fis *)cmd->command;
Sam Bradshaw88523a62011-08-30 08:34:26 -0600883
884 /* Should re-issue? */
885 if (tag == MTIP_TAG_INTERNAL ||
886 fis->command == ATA_CMD_SET_FEATURES)
887 reissue = 0;
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200888 else {
889 if (fail_all_ncq_cmds ||
890 (fail_all_ncq_write &&
891 fis->command == ATA_CMD_FPDMA_WRITE)) {
892 dev_warn(&dd->pdev->dev,
893 " Fail: %s w/tag %d [%s].\n",
894 fis->command == ATA_CMD_FPDMA_WRITE ?
895 "write" : "read",
896 tag,
897 fail_reason != NULL ?
898 fail_reason : "unknown");
899 atomic_set(&cmd->active, 0);
900 if (cmd->comp_func) {
901 cmd->comp_func(port, tag,
902 cmd->comp_data,
903 -ENODATA);
904 }
905 continue;
906 }
907 }
Sam Bradshaw88523a62011-08-30 08:34:26 -0600908
909 /*
910 * First check if this command has
911 * exceeded its retries.
912 */
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200913 if (reissue && (cmd->retries-- > 0)) {
Sam Bradshaw88523a62011-08-30 08:34:26 -0600914
915 set_bit(tag, tagaccum);
916
Sam Bradshaw88523a62011-08-30 08:34:26 -0600917 /* Re-issue the command. */
918 mtip_issue_ncq_command(port, tag);
919
920 continue;
921 }
922
923 /* Retire a command that will not be reissued */
924 dev_warn(&port->dd->pdev->dev,
925 "retiring tag %d\n", tag);
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200926 atomic_set(&cmd->active, 0);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600927
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200928 if (cmd->comp_func)
929 cmd->comp_func(
Sam Bradshaw88523a62011-08-30 08:34:26 -0600930 port,
931 tag,
Asai Thambi S Pf6587212012-04-09 08:35:38 +0200932 cmd->comp_data,
Sam Bradshaw88523a62011-08-30 08:34:26 -0600933 PORT_IRQ_TF_ERR);
934 else
935 dev_warn(&port->dd->pdev->dev,
936 "Bad completion for tag %d\n",
937 tag);
938 }
939 }
Asai Thambi S P95fea2f2012-04-09 08:35:39 +0200940 print_tags(dd, "reissued (TFE)", tagaccum, cmd_cnt);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600941
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +0100942 /* clear eh_active */
Asai Thambi S P8a857a82012-04-09 08:35:38 +0200943 clear_bit(MTIP_PF_EH_ACTIVE_BIT, &port->flags);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +0100944 wake_up_interruptible(&port->svc_wait);
Sam Bradshaw88523a62011-08-30 08:34:26 -0600945
946 mod_timer(&port->cmd_timer,
947 jiffies + msecs_to_jiffies(MTIP_TIMEOUT_CHECK_PERIOD));
948}
949
950/*
951 * Handle a set device bits interrupt
952 */
953static inline void mtip_process_sdbf(struct driver_data *dd)
954{
955 struct mtip_port *port = dd->port;
956 int group, tag, bit;
957 u32 completed;
958 struct mtip_cmd *command;
959
960 /* walk all bits in all slot groups */
961 for (group = 0; group < dd->slot_groups; group++) {
962 completed = readl(port->completed[group]);
963
964 /* clear completed status register in the hardware.*/
965 writel(completed, port->completed[group]);
966
967 /* Process completed commands. */
968 for (bit = 0;
969 (bit < 32) && completed;
970 bit++, completed >>= 1) {
971 if (completed & 0x01) {
972 tag = (group << 5) | bit;
973
974 /* skip internal command slot. */
975 if (unlikely(tag == MTIP_TAG_INTERNAL))
976 continue;
977
978 command = &port->commands[tag];
Sam Bradshaw88523a62011-08-30 08:34:26 -0600979 /* make internal callback */
980 if (likely(command->comp_func)) {
981 command->comp_func(
982 port,
983 tag,
984 command->comp_data,
985 0);
986 } else {
987 dev_warn(&dd->pdev->dev,
988 "Null completion "
989 "for tag %d",
990 tag);
991
992 if (mtip_check_surprise_removal(
993 dd->pdev)) {
994 mtip_command_cleanup(dd);
995 return;
996 }
997 }
998 }
999 }
1000 }
1001}
1002
1003/*
1004 * Process legacy pio and d2h interrupts
1005 */
1006static inline void mtip_process_legacy(struct driver_data *dd, u32 port_stat)
1007{
1008 struct mtip_port *port = dd->port;
1009 struct mtip_cmd *cmd = &port->commands[MTIP_TAG_INTERNAL];
1010
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001011 if (test_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags) &&
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001012 (cmd != NULL) && !(readl(port->cmd_issue[MTIP_TAG_INTERNAL])
Sam Bradshaw88523a62011-08-30 08:34:26 -06001013 & (1 << MTIP_TAG_INTERNAL))) {
1014 if (cmd->comp_func) {
1015 cmd->comp_func(port,
1016 MTIP_TAG_INTERNAL,
1017 cmd->comp_data,
1018 0);
1019 return;
1020 }
1021 }
1022
Sam Bradshaw88523a62011-08-30 08:34:26 -06001023 return;
1024}
1025
1026/*
1027 * Demux and handle errors
1028 */
1029static inline void mtip_process_errors(struct driver_data *dd, u32 port_stat)
1030{
1031 if (likely(port_stat & (PORT_IRQ_TF_ERR | PORT_IRQ_IF_ERR)))
1032 mtip_handle_tfe(dd);
1033
1034 if (unlikely(port_stat & PORT_IRQ_CONNECT)) {
1035 dev_warn(&dd->pdev->dev,
1036 "Clearing PxSERR.DIAG.x\n");
1037 writel((1 << 26), dd->port->mmio + PORT_SCR_ERR);
1038 }
1039
1040 if (unlikely(port_stat & PORT_IRQ_PHYRDY)) {
1041 dev_warn(&dd->pdev->dev,
1042 "Clearing PxSERR.DIAG.n\n");
1043 writel((1 << 16), dd->port->mmio + PORT_SCR_ERR);
1044 }
1045
1046 if (unlikely(port_stat & ~PORT_IRQ_HANDLED)) {
1047 dev_warn(&dd->pdev->dev,
1048 "Port stat errors %x unhandled\n",
1049 (port_stat & ~PORT_IRQ_HANDLED));
1050 }
1051}
1052
1053static inline irqreturn_t mtip_handle_irq(struct driver_data *data)
1054{
1055 struct driver_data *dd = (struct driver_data *) data;
1056 struct mtip_port *port = dd->port;
1057 u32 hba_stat, port_stat;
1058 int rv = IRQ_NONE;
1059
1060 hba_stat = readl(dd->mmio + HOST_IRQ_STAT);
1061 if (hba_stat) {
1062 rv = IRQ_HANDLED;
1063
1064 /* Acknowledge the interrupt status on the port.*/
1065 port_stat = readl(port->mmio + PORT_IRQ_STAT);
1066 writel(port_stat, port->mmio + PORT_IRQ_STAT);
1067
1068 /* Demux port status */
1069 if (likely(port_stat & PORT_IRQ_SDB_FIS))
1070 mtip_process_sdbf(dd);
1071
1072 if (unlikely(port_stat & PORT_IRQ_ERR)) {
1073 if (unlikely(mtip_check_surprise_removal(dd->pdev))) {
1074 mtip_command_cleanup(dd);
1075 /* don't proceed further */
1076 return IRQ_HANDLED;
1077 }
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001078 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
Asai Thambi S P45038362012-04-09 08:35:38 +02001079 &dd->dd_flag))
1080 return rv;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001081
1082 mtip_process_errors(dd, port_stat & PORT_IRQ_ERR);
1083 }
1084
1085 if (unlikely(port_stat & PORT_IRQ_LEGACY))
1086 mtip_process_legacy(dd, port_stat & PORT_IRQ_LEGACY);
1087 }
1088
1089 /* acknowledge interrupt */
1090 writel(hba_stat, dd->mmio + HOST_IRQ_STAT);
1091
1092 return rv;
1093}
1094
1095/*
1096 * Wrapper for mtip_handle_irq
1097 * (ignores return code)
1098 */
1099static void mtip_tasklet(unsigned long data)
1100{
1101 mtip_handle_irq((struct driver_data *) data);
1102}
1103
1104/*
1105 * HBA interrupt subroutine.
1106 *
1107 * @irq IRQ number.
1108 * @instance Pointer to the driver data structure.
1109 *
1110 * return value
1111 * IRQ_HANDLED A HBA interrupt was pending and handled.
1112 * IRQ_NONE This interrupt was not for the HBA.
1113 */
1114static irqreturn_t mtip_irq_handler(int irq, void *instance)
1115{
1116 struct driver_data *dd = instance;
1117 tasklet_schedule(&dd->tasklet);
1118 return IRQ_HANDLED;
1119}
1120
1121static void mtip_issue_non_ncq_command(struct mtip_port *port, int tag)
1122{
1123 atomic_set(&port->commands[tag].active, 1);
1124 writel(1 << MTIP_TAG_BIT(tag),
1125 port->cmd_issue[MTIP_TAG_INDEX(tag)]);
1126}
1127
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001128static bool mtip_pause_ncq(struct mtip_port *port,
1129 struct host_to_dev_fis *fis)
1130{
1131 struct host_to_dev_fis *reply;
1132 unsigned long task_file_data;
1133
1134 reply = port->rxfis + RX_FIS_D2H_REG;
1135 task_file_data = readl(port->mmio+PORT_TFDATA);
1136
1137 if ((task_file_data & 1) || (fis->command == ATA_CMD_SEC_ERASE_UNIT))
1138 return false;
1139
1140 if (fis->command == ATA_CMD_SEC_ERASE_PREP) {
1141 set_bit(MTIP_PF_SE_ACTIVE_BIT, &port->flags);
1142 port->ic_pause_timer = jiffies;
1143 return true;
1144 } else if ((fis->command == ATA_CMD_DOWNLOAD_MICRO) &&
1145 (fis->features == 0x03)) {
1146 set_bit(MTIP_PF_DM_ACTIVE_BIT, &port->flags);
1147 port->ic_pause_timer = jiffies;
1148 return true;
1149 } else if ((fis->command == ATA_CMD_SEC_ERASE_UNIT) ||
1150 ((fis->command == 0xFC) &&
1151 (fis->features == 0x27 || fis->features == 0x72 ||
1152 fis->features == 0x62 || fis->features == 0x26))) {
1153 /* Com reset after secure erase or lowlevel format */
1154 mtip_restart_port(port);
1155 return false;
1156 }
1157
1158 return false;
1159}
1160
Sam Bradshaw88523a62011-08-30 08:34:26 -06001161/*
1162 * Wait for port to quiesce
1163 *
1164 * @port Pointer to port data structure
1165 * @timeout Max duration to wait (ms)
1166 *
1167 * return value
1168 * 0 Success
1169 * -EBUSY Commands still active
1170 */
1171static int mtip_quiesce_io(struct mtip_port *port, unsigned long timeout)
1172{
1173 unsigned long to;
Dan Carpenter3e54a3d2011-11-24 12:59:00 +01001174 unsigned int n;
1175 unsigned int active = 1;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001176
1177 to = jiffies + msecs_to_jiffies(timeout);
1178 do {
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001179 if (test_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags) &&
1180 test_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags)) {
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001181 msleep(20);
1182 continue; /* svc thd is actively issuing commands */
1183 }
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001184 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
Asai Thambi S P45038362012-04-09 08:35:38 +02001185 return -EFAULT;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001186 /*
1187 * Ignore s_active bit 0 of array element 0.
1188 * This bit will always be set
1189 */
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001190 active = readl(port->s_active[0]) & 0xFFFFFFFE;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001191 for (n = 1; n < port->dd->slot_groups; n++)
1192 active |= readl(port->s_active[n]);
1193
1194 if (!active)
1195 break;
1196
1197 msleep(20);
1198 } while (time_before(jiffies, to));
1199
1200 return active ? -EBUSY : 0;
1201}
1202
1203/*
1204 * Execute an internal command and wait for the completion.
1205 *
1206 * @port Pointer to the port data structure.
1207 * @fis Pointer to the FIS that describes the command.
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001208 * @fis_len Length in WORDS of the FIS.
Sam Bradshaw88523a62011-08-30 08:34:26 -06001209 * @buffer DMA accessible for command data.
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001210 * @buf_len Length, in bytes, of the data buffer.
Sam Bradshaw88523a62011-08-30 08:34:26 -06001211 * @opts Command header options, excluding the FIS length
1212 * and the number of PRD entries.
1213 * @timeout Time in ms to wait for the command to complete.
1214 *
1215 * return value
1216 * 0 Command completed successfully.
1217 * -EFAULT The buffer address is not correctly aligned.
1218 * -EBUSY Internal command or other IO in progress.
1219 * -EAGAIN Time out waiting for command to complete.
1220 */
1221static int mtip_exec_internal_command(struct mtip_port *port,
Asai Thambi S P8182b492012-04-09 08:35:38 +02001222 struct host_to_dev_fis *fis,
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001223 int fis_len,
Sam Bradshaw88523a62011-08-30 08:34:26 -06001224 dma_addr_t buffer,
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001225 int buf_len,
Sam Bradshaw88523a62011-08-30 08:34:26 -06001226 u32 opts,
1227 gfp_t atomic,
1228 unsigned long timeout)
1229{
1230 struct mtip_cmd_sg *command_sg;
1231 DECLARE_COMPLETION_ONSTACK(wait);
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001232 int rv = 0, ready2go = 1;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001233 struct mtip_cmd *int_cmd = &port->commands[MTIP_TAG_INTERNAL];
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001234 unsigned long to;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001235
1236 /* Make sure the buffer is 8 byte aligned. This is asic specific. */
1237 if (buffer & 0x00000007) {
1238 dev_err(&port->dd->pdev->dev,
1239 "SG buffer is not 8 byte aligned\n");
1240 return -EFAULT;
1241 }
1242
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001243 to = jiffies + msecs_to_jiffies(timeout);
1244 do {
1245 ready2go = !test_and_set_bit(MTIP_TAG_INTERNAL,
1246 port->allocated);
1247 if (ready2go)
1248 break;
1249 mdelay(100);
1250 } while (time_before(jiffies, to));
1251 if (!ready2go) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06001252 dev_warn(&port->dd->pdev->dev,
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001253 "Internal cmd active. new cmd [%02X]\n", fis->command);
Sam Bradshaw88523a62011-08-30 08:34:26 -06001254 return -EBUSY;
1255 }
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001256 set_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001257 port->ic_pause_timer = 0;
1258
1259 if (fis->command == ATA_CMD_SEC_ERASE_UNIT)
1260 clear_bit(MTIP_PF_SE_ACTIVE_BIT, &port->flags);
1261 else if (fis->command == ATA_CMD_DOWNLOAD_MICRO)
1262 clear_bit(MTIP_PF_DM_ACTIVE_BIT, &port->flags);
Sam Bradshaw88523a62011-08-30 08:34:26 -06001263
1264 if (atomic == GFP_KERNEL) {
Asai Thambi S P8182b492012-04-09 08:35:38 +02001265 if (fis->command != ATA_CMD_STANDBYNOW1) {
1266 /* wait for io to complete if non atomic */
1267 if (mtip_quiesce_io(port, 5000) < 0) {
1268 dev_warn(&port->dd->pdev->dev,
1269 "Failed to quiesce IO\n");
1270 release_slot(port, MTIP_TAG_INTERNAL);
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001271 clear_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
Asai Thambi S P8182b492012-04-09 08:35:38 +02001272 wake_up_interruptible(&port->svc_wait);
1273 return -EBUSY;
1274 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06001275 }
1276
1277 /* Set the completion function and data for the command. */
1278 int_cmd->comp_data = &wait;
1279 int_cmd->comp_func = mtip_completion;
1280
1281 } else {
1282 /* Clear completion - we're going to poll */
1283 int_cmd->comp_data = NULL;
Asai Thambi S P8182b492012-04-09 08:35:38 +02001284 int_cmd->comp_func = mtip_null_completion;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001285 }
1286
1287 /* Copy the command to the command table */
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001288 memcpy(int_cmd->command, fis, fis_len*4);
Sam Bradshaw88523a62011-08-30 08:34:26 -06001289
1290 /* Populate the SG list */
1291 int_cmd->command_header->opts =
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001292 __force_bit2int cpu_to_le32(opts | fis_len);
1293 if (buf_len) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06001294 command_sg = int_cmd->command + AHCI_CMD_TBL_HDR_SZ;
1295
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001296 command_sg->info =
1297 __force_bit2int cpu_to_le32((buf_len-1) & 0x3FFFFF);
1298 command_sg->dba =
1299 __force_bit2int cpu_to_le32(buffer & 0xFFFFFFFF);
1300 command_sg->dba_upper =
1301 __force_bit2int cpu_to_le32((buffer >> 16) >> 16);
Sam Bradshaw88523a62011-08-30 08:34:26 -06001302
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001303 int_cmd->command_header->opts |=
1304 __force_bit2int cpu_to_le32((1 << 16));
Sam Bradshaw88523a62011-08-30 08:34:26 -06001305 }
1306
1307 /* Populate the command header */
1308 int_cmd->command_header->byte_count = 0;
1309
1310 /* Issue the command to the hardware */
1311 mtip_issue_non_ncq_command(port, MTIP_TAG_INTERNAL);
1312
1313 /* Poll if atomic, wait_for_completion otherwise */
1314 if (atomic == GFP_KERNEL) {
1315 /* Wait for the command to complete or timeout. */
1316 if (wait_for_completion_timeout(
1317 &wait,
1318 msecs_to_jiffies(timeout)) == 0) {
1319 dev_err(&port->dd->pdev->dev,
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001320 "Internal command did not complete [%d] "
1321 "within timeout of %lu ms\n",
1322 atomic, timeout);
Asai Thambi S P45038362012-04-09 08:35:38 +02001323 if (mtip_check_surprise_removal(port->dd->pdev) ||
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001324 test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
Asai Thambi S P45038362012-04-09 08:35:38 +02001325 &port->dd->dd_flag)) {
1326 rv = -ENXIO;
1327 goto exec_ic_exit;
1328 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06001329 rv = -EAGAIN;
1330 }
1331
1332 if (readl(port->cmd_issue[MTIP_TAG_INTERNAL])
1333 & (1 << MTIP_TAG_INTERNAL)) {
1334 dev_warn(&port->dd->pdev->dev,
1335 "Retiring internal command but CI is 1.\n");
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001336 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
Asai Thambi S P45038362012-04-09 08:35:38 +02001337 &port->dd->dd_flag)) {
1338 hba_reset_nosleep(port->dd);
1339 rv = -ENXIO;
1340 } else {
1341 mtip_restart_port(port);
1342 rv = -EAGAIN;
1343 }
1344 goto exec_ic_exit;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001345 }
1346
1347 } else {
1348 /* Spin for <timeout> checking if command still outstanding */
1349 timeout = jiffies + msecs_to_jiffies(timeout);
Asai Thambi S P8182b492012-04-09 08:35:38 +02001350 while ((readl(port->cmd_issue[MTIP_TAG_INTERNAL])
1351 & (1 << MTIP_TAG_INTERNAL))
1352 && time_before(jiffies, timeout)) {
1353 if (mtip_check_surprise_removal(port->dd->pdev)) {
1354 rv = -ENXIO;
1355 goto exec_ic_exit;
1356 }
1357 if ((fis->command != ATA_CMD_STANDBYNOW1) &&
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001358 test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
Asai Thambi S P45038362012-04-09 08:35:38 +02001359 &port->dd->dd_flag)) {
1360 rv = -ENXIO;
1361 goto exec_ic_exit;
1362 }
1363 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06001364
1365 if (readl(port->cmd_issue[MTIP_TAG_INTERNAL])
1366 & (1 << MTIP_TAG_INTERNAL)) {
1367 dev_err(&port->dd->pdev->dev,
Asai Thambi S P8182b492012-04-09 08:35:38 +02001368 "Internal command did not complete [atomic]\n");
Sam Bradshaw88523a62011-08-30 08:34:26 -06001369 rv = -EAGAIN;
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001370 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
Asai Thambi S P45038362012-04-09 08:35:38 +02001371 &port->dd->dd_flag)) {
1372 hba_reset_nosleep(port->dd);
1373 rv = -ENXIO;
1374 } else {
1375 mtip_restart_port(port);
1376 rv = -EAGAIN;
1377 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06001378 }
1379 }
Asai Thambi S P45038362012-04-09 08:35:38 +02001380exec_ic_exit:
Sam Bradshaw88523a62011-08-30 08:34:26 -06001381 /* Clear the allocated and active bits for the internal command. */
1382 atomic_set(&int_cmd->active, 0);
1383 release_slot(port, MTIP_TAG_INTERNAL);
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001384 if (rv >= 0 && mtip_pause_ncq(port, fis)) {
1385 /* NCQ paused */
1386 return rv;
1387 }
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001388 clear_bit(MTIP_PF_IC_ACTIVE_BIT, &port->flags);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001389 wake_up_interruptible(&port->svc_wait);
Sam Bradshaw88523a62011-08-30 08:34:26 -06001390
1391 return rv;
1392}
1393
1394/*
1395 * Byte-swap ATA ID strings.
1396 *
1397 * ATA identify data contains strings in byte-swapped 16-bit words.
1398 * They must be swapped (on all architectures) to be usable as C strings.
1399 * This function swaps bytes in-place.
1400 *
1401 * @buf The buffer location of the string
1402 * @len The number of bytes to swap
1403 *
1404 * return value
1405 * None
1406 */
1407static inline void ata_swap_string(u16 *buf, unsigned int len)
1408{
1409 int i;
1410 for (i = 0; i < (len/2); i++)
1411 be16_to_cpus(&buf[i]);
1412}
1413
1414/*
1415 * Request the device identity information.
1416 *
1417 * If a user space buffer is not specified, i.e. is NULL, the
1418 * identify information is still read from the drive and placed
1419 * into the identify data buffer (@e port->identify) in the
1420 * port data structure.
1421 * When the identify buffer contains valid identify information @e
1422 * port->identify_valid is non-zero.
1423 *
1424 * @port Pointer to the port structure.
1425 * @user_buffer A user space buffer where the identify data should be
1426 * copied.
1427 *
1428 * return value
1429 * 0 Command completed successfully.
1430 * -EFAULT An error occurred while coping data to the user buffer.
1431 * -1 Command failed.
1432 */
1433static int mtip_get_identify(struct mtip_port *port, void __user *user_buffer)
1434{
1435 int rv = 0;
1436 struct host_to_dev_fis fis;
1437
Asai Thambi S P8a857a82012-04-09 08:35:38 +02001438 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &port->dd->dd_flag))
Asai Thambi S P45038362012-04-09 08:35:38 +02001439 return -EFAULT;
1440
Sam Bradshaw88523a62011-08-30 08:34:26 -06001441 /* Build the FIS. */
1442 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1443 fis.type = 0x27;
1444 fis.opts = 1 << 7;
1445 fis.command = ATA_CMD_ID_ATA;
1446
1447 /* Set the identify information as invalid. */
1448 port->identify_valid = 0;
1449
1450 /* Clear the identify information. */
1451 memset(port->identify, 0, sizeof(u16) * ATA_ID_WORDS);
1452
1453 /* Execute the command. */
1454 if (mtip_exec_internal_command(port,
1455 &fis,
1456 5,
1457 port->identify_dma,
1458 sizeof(u16) * ATA_ID_WORDS,
1459 0,
1460 GFP_KERNEL,
1461 MTIP_INTERNAL_COMMAND_TIMEOUT_MS)
1462 < 0) {
1463 rv = -1;
1464 goto out;
1465 }
1466
1467 /*
1468 * Perform any necessary byte-swapping. Yes, the kernel does in fact
1469 * perform field-sensitive swapping on the string fields.
1470 * See the kernel use of ata_id_string() for proof of this.
1471 */
1472#ifdef __LITTLE_ENDIAN
1473 ata_swap_string(port->identify + 27, 40); /* model string*/
1474 ata_swap_string(port->identify + 23, 8); /* firmware string*/
1475 ata_swap_string(port->identify + 10, 20); /* serial# string*/
1476#else
1477 {
1478 int i;
1479 for (i = 0; i < ATA_ID_WORDS; i++)
1480 port->identify[i] = le16_to_cpu(port->identify[i]);
1481 }
1482#endif
1483
1484 /* Set the identify buffer as valid. */
1485 port->identify_valid = 1;
1486
1487 if (user_buffer) {
1488 if (copy_to_user(
1489 user_buffer,
1490 port->identify,
1491 ATA_ID_WORDS * sizeof(u16))) {
1492 rv = -EFAULT;
1493 goto out;
1494 }
1495 }
1496
1497out:
Sam Bradshaw88523a62011-08-30 08:34:26 -06001498 return rv;
1499}
1500
1501/*
1502 * Issue a standby immediate command to the device.
1503 *
1504 * @port Pointer to the port structure.
1505 *
1506 * return value
1507 * 0 Command was executed successfully.
1508 * -1 An error occurred while executing the command.
1509 */
1510static int mtip_standby_immediate(struct mtip_port *port)
1511{
1512 int rv;
1513 struct host_to_dev_fis fis;
Asai Thambi S Pf6587212012-04-09 08:35:38 +02001514 unsigned long start;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001515
Sam Bradshaw88523a62011-08-30 08:34:26 -06001516 /* Build the FIS. */
1517 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1518 fis.type = 0x27;
1519 fis.opts = 1 << 7;
1520 fis.command = ATA_CMD_STANDBYNOW1;
1521
Asai Thambi S Pf6587212012-04-09 08:35:38 +02001522 start = jiffies;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001523 rv = mtip_exec_internal_command(port,
1524 &fis,
1525 5,
1526 0,
1527 0,
1528 0,
Asai Thambi S Pf6587212012-04-09 08:35:38 +02001529 GFP_ATOMIC,
Sam Bradshaw88523a62011-08-30 08:34:26 -06001530 15000);
Asai Thambi S Pf6587212012-04-09 08:35:38 +02001531 dbg_printk(MTIP_DRV_NAME "Time taken to complete standby cmd: %d ms\n",
1532 jiffies_to_msecs(jiffies - start));
1533 if (rv)
1534 dev_warn(&port->dd->pdev->dev,
1535 "STANDBY IMMEDIATE command failed.\n");
1536
1537 return rv;
1538}
1539
1540/*
1541 * Issue a READ LOG EXT command to the device.
1542 *
1543 * @port pointer to the port structure.
1544 * @page page number to fetch
1545 * @buffer pointer to buffer
1546 * @buffer_dma dma address corresponding to @buffer
1547 * @sectors page length to fetch, in sectors
1548 *
1549 * return value
1550 * @rv return value from mtip_exec_internal_command()
1551 */
1552static int mtip_read_log_page(struct mtip_port *port, u8 page, u16 *buffer,
1553 dma_addr_t buffer_dma, unsigned int sectors)
1554{
1555 struct host_to_dev_fis fis;
1556
1557 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1558 fis.type = 0x27;
1559 fis.opts = 1 << 7;
1560 fis.command = ATA_CMD_READ_LOG_EXT;
1561 fis.sect_count = sectors & 0xFF;
1562 fis.sect_cnt_ex = (sectors >> 8) & 0xFF;
1563 fis.lba_low = page;
1564 fis.lba_mid = 0;
1565 fis.device = ATA_DEVICE_OBS;
1566
1567 memset(buffer, 0, sectors * ATA_SECT_SIZE);
1568
1569 return mtip_exec_internal_command(port,
1570 &fis,
1571 5,
1572 buffer_dma,
1573 sectors * ATA_SECT_SIZE,
1574 0,
1575 GFP_ATOMIC,
1576 MTIP_INTERNAL_COMMAND_TIMEOUT_MS);
1577}
1578
1579/*
1580 * Issue a SMART READ DATA command to the device.
1581 *
1582 * @port pointer to the port structure.
1583 * @buffer pointer to buffer
1584 * @buffer_dma dma address corresponding to @buffer
1585 *
1586 * return value
1587 * @rv return value from mtip_exec_internal_command()
1588 */
1589static int mtip_get_smart_data(struct mtip_port *port, u8 *buffer,
1590 dma_addr_t buffer_dma)
1591{
1592 struct host_to_dev_fis fis;
1593
1594 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1595 fis.type = 0x27;
1596 fis.opts = 1 << 7;
1597 fis.command = ATA_CMD_SMART;
1598 fis.features = 0xD0;
1599 fis.sect_count = 1;
1600 fis.lba_mid = 0x4F;
1601 fis.lba_hi = 0xC2;
1602 fis.device = ATA_DEVICE_OBS;
1603
1604 return mtip_exec_internal_command(port,
1605 &fis,
1606 5,
1607 buffer_dma,
1608 ATA_SECT_SIZE,
1609 0,
1610 GFP_ATOMIC,
1611 15000);
1612}
1613
1614/*
1615 * Get the value of a smart attribute
1616 *
1617 * @port pointer to the port structure
1618 * @id attribute number
1619 * @attrib pointer to return attrib information corresponding to @id
1620 *
1621 * return value
1622 * -EINVAL NULL buffer passed or unsupported attribute @id.
1623 * -EPERM Identify data not valid, SMART not supported or not enabled
1624 */
1625static int mtip_get_smart_attr(struct mtip_port *port, unsigned int id,
1626 struct smart_attr *attrib)
1627{
1628 int rv, i;
1629 struct smart_attr *pattr;
1630
1631 if (!attrib)
1632 return -EINVAL;
1633
1634 if (!port->identify_valid) {
1635 dev_warn(&port->dd->pdev->dev, "IDENTIFY DATA not valid\n");
1636 return -EPERM;
1637 }
1638 if (!(port->identify[82] & 0x1)) {
1639 dev_warn(&port->dd->pdev->dev, "SMART not supported\n");
1640 return -EPERM;
1641 }
1642 if (!(port->identify[85] & 0x1)) {
1643 dev_warn(&port->dd->pdev->dev, "SMART not enabled\n");
1644 return -EPERM;
1645 }
1646
1647 memset(port->smart_buf, 0, ATA_SECT_SIZE);
1648 rv = mtip_get_smart_data(port, port->smart_buf, port->smart_buf_dma);
1649 if (rv) {
1650 dev_warn(&port->dd->pdev->dev, "Failed to ge SMART data\n");
1651 return rv;
1652 }
1653
1654 pattr = (struct smart_attr *)(port->smart_buf + 2);
1655 for (i = 0; i < 29; i++, pattr++)
1656 if (pattr->attr_id == id) {
1657 memcpy(attrib, pattr, sizeof(struct smart_attr));
1658 break;
1659 }
1660
1661 if (i == 29) {
1662 dev_warn(&port->dd->pdev->dev,
1663 "Query for invalid SMART attribute ID\n");
1664 rv = -EINVAL;
1665 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06001666
Sam Bradshaw88523a62011-08-30 08:34:26 -06001667 return rv;
1668}
1669
1670/*
1671 * Get the drive capacity.
1672 *
1673 * @dd Pointer to the device data structure.
1674 * @sectors Pointer to the variable that will receive the sector count.
1675 *
1676 * return value
1677 * 1 Capacity was returned successfully.
1678 * 0 The identify information is invalid.
1679 */
Jens Axboe63166682011-09-27 21:27:43 -06001680static bool mtip_hw_get_capacity(struct driver_data *dd, sector_t *sectors)
Sam Bradshaw88523a62011-08-30 08:34:26 -06001681{
1682 struct mtip_port *port = dd->port;
1683 u64 total, raw0, raw1, raw2, raw3;
1684 raw0 = port->identify[100];
1685 raw1 = port->identify[101];
1686 raw2 = port->identify[102];
1687 raw3 = port->identify[103];
1688 total = raw0 | raw1<<16 | raw2<<32 | raw3<<48;
1689 *sectors = total;
1690 return (bool) !!port->identify_valid;
1691}
1692
1693/*
1694 * Reset the HBA.
1695 *
1696 * Resets the HBA by setting the HBA Reset bit in the Global
1697 * HBA Control register. After setting the HBA Reset bit the
1698 * function waits for 1 second before reading the HBA Reset
1699 * bit to make sure it has cleared. If HBA Reset is not clear
1700 * an error is returned. Cannot be used in non-blockable
1701 * context.
1702 *
1703 * @dd Pointer to the driver data structure.
1704 *
1705 * return value
1706 * 0 The reset was successful.
1707 * -1 The HBA Reset bit did not clear.
1708 */
1709static int mtip_hba_reset(struct driver_data *dd)
1710{
1711 mtip_deinit_port(dd->port);
1712
1713 /* Set the reset bit */
1714 writel(HOST_RESET, dd->mmio + HOST_CTL);
1715
1716 /* Flush */
1717 readl(dd->mmio + HOST_CTL);
1718
1719 /* Wait for reset to clear */
1720 ssleep(1);
1721
1722 /* Check the bit has cleared */
1723 if (readl(dd->mmio + HOST_CTL) & HOST_RESET) {
1724 dev_err(&dd->pdev->dev,
1725 "Reset bit did not clear.\n");
1726 return -1;
1727 }
1728
1729 return 0;
1730}
1731
1732/*
1733 * Display the identify command data.
1734 *
1735 * @port Pointer to the port data structure.
1736 *
1737 * return value
1738 * None
1739 */
1740static void mtip_dump_identify(struct mtip_port *port)
1741{
1742 sector_t sectors;
1743 unsigned short revid;
1744 char cbuf[42];
1745
1746 if (!port->identify_valid)
1747 return;
1748
1749 strlcpy(cbuf, (char *)(port->identify+10), 21);
1750 dev_info(&port->dd->pdev->dev,
1751 "Serial No.: %s\n", cbuf);
1752
1753 strlcpy(cbuf, (char *)(port->identify+23), 9);
1754 dev_info(&port->dd->pdev->dev,
1755 "Firmware Ver.: %s\n", cbuf);
1756
1757 strlcpy(cbuf, (char *)(port->identify+27), 41);
1758 dev_info(&port->dd->pdev->dev, "Model: %s\n", cbuf);
1759
1760 if (mtip_hw_get_capacity(port->dd, &sectors))
1761 dev_info(&port->dd->pdev->dev,
1762 "Capacity: %llu sectors (%llu MB)\n",
1763 (u64)sectors,
1764 ((u64)sectors) * ATA_SECT_SIZE >> 20);
1765
1766 pci_read_config_word(port->dd->pdev, PCI_REVISION_ID, &revid);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001767 switch (revid & 0xFF) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06001768 case 0x1:
1769 strlcpy(cbuf, "A0", 3);
1770 break;
1771 case 0x3:
1772 strlcpy(cbuf, "A2", 3);
1773 break;
1774 default:
1775 strlcpy(cbuf, "?", 2);
1776 break;
1777 }
1778 dev_info(&port->dd->pdev->dev,
1779 "Card Type: %s\n", cbuf);
1780}
1781
1782/*
1783 * Map the commands scatter list into the command table.
1784 *
1785 * @command Pointer to the command.
1786 * @nents Number of scatter list entries.
1787 *
1788 * return value
1789 * None
1790 */
1791static inline void fill_command_sg(struct driver_data *dd,
1792 struct mtip_cmd *command,
1793 int nents)
1794{
1795 int n;
1796 unsigned int dma_len;
1797 struct mtip_cmd_sg *command_sg;
1798 struct scatterlist *sg = command->sg;
1799
1800 command_sg = command->command + AHCI_CMD_TBL_HDR_SZ;
1801
1802 for (n = 0; n < nents; n++) {
1803 dma_len = sg_dma_len(sg);
1804 if (dma_len > 0x400000)
1805 dev_err(&dd->pdev->dev,
1806 "DMA segment length truncated\n");
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001807 command_sg->info = __force_bit2int
1808 cpu_to_le32((dma_len-1) & 0x3FFFFF);
1809 command_sg->dba = __force_bit2int
1810 cpu_to_le32(sg_dma_address(sg));
1811 command_sg->dba_upper = __force_bit2int
1812 cpu_to_le32((sg_dma_address(sg) >> 16) >> 16);
Sam Bradshaw88523a62011-08-30 08:34:26 -06001813 command_sg++;
1814 sg++;
1815 }
1816}
1817
1818/*
1819 * @brief Execute a drive command.
1820 *
1821 * return value 0 The command completed successfully.
1822 * return value -1 An error occurred while executing the command.
1823 */
Jens Axboe63166682011-09-27 21:27:43 -06001824static int exec_drive_task(struct mtip_port *port, u8 *command)
Sam Bradshaw88523a62011-08-30 08:34:26 -06001825{
1826 struct host_to_dev_fis fis;
1827 struct host_to_dev_fis *reply = (port->rxfis + RX_FIS_D2H_REG);
1828
Sam Bradshaw88523a62011-08-30 08:34:26 -06001829 /* Build the FIS. */
1830 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1831 fis.type = 0x27;
1832 fis.opts = 1 << 7;
1833 fis.command = command[0];
1834 fis.features = command[1];
1835 fis.sect_count = command[2];
1836 fis.sector = command[3];
1837 fis.cyl_low = command[4];
1838 fis.cyl_hi = command[5];
1839 fis.device = command[6] & ~0x10; /* Clear the dev bit*/
1840
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001841 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 -06001842 __func__,
1843 command[0],
1844 command[1],
1845 command[2],
1846 command[3],
1847 command[4],
1848 command[5],
1849 command[6]);
1850
1851 /* Execute the command. */
1852 if (mtip_exec_internal_command(port,
1853 &fis,
1854 5,
1855 0,
1856 0,
1857 0,
1858 GFP_KERNEL,
1859 MTIP_IOCTL_COMMAND_TIMEOUT_MS) < 0) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06001860 return -1;
1861 }
1862
1863 command[0] = reply->command; /* Status*/
1864 command[1] = reply->features; /* Error*/
1865 command[4] = reply->cyl_low;
1866 command[5] = reply->cyl_hi;
1867
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001868 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 -06001869 __func__,
1870 command[0],
1871 command[1],
1872 command[4],
1873 command[5]);
1874
Sam Bradshaw88523a62011-08-30 08:34:26 -06001875 return 0;
1876}
1877
1878/*
1879 * @brief Execute a drive command.
1880 *
1881 * @param port Pointer to the port data structure.
1882 * @param command Pointer to the user specified command parameters.
1883 * @param user_buffer Pointer to the user space buffer where read sector
1884 * data should be copied.
1885 *
1886 * return value 0 The command completed successfully.
1887 * return value -EFAULT An error occurred while copying the completion
1888 * data to the user space buffer.
1889 * return value -1 An error occurred while executing the command.
1890 */
Jens Axboe63166682011-09-27 21:27:43 -06001891static int exec_drive_command(struct mtip_port *port, u8 *command,
1892 void __user *user_buffer)
Sam Bradshaw88523a62011-08-30 08:34:26 -06001893{
1894 struct host_to_dev_fis fis;
1895 struct host_to_dev_fis *reply = (port->rxfis + RX_FIS_D2H_REG);
1896
Sam Bradshaw88523a62011-08-30 08:34:26 -06001897 /* Build the FIS. */
1898 memset(&fis, 0, sizeof(struct host_to_dev_fis));
1899 fis.type = 0x27;
1900 fis.opts = 1 << 7;
1901 fis.command = command[0];
1902 fis.features = command[2];
1903 fis.sect_count = command[3];
1904 if (fis.command == ATA_CMD_SMART) {
1905 fis.sector = command[1];
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001906 fis.cyl_low = 0x4F;
1907 fis.cyl_hi = 0xC2;
Sam Bradshaw88523a62011-08-30 08:34:26 -06001908 }
1909
1910 dbg_printk(MTIP_DRV_NAME
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001911 " %s: User Command: cmd %x, sect %x, "
Sam Bradshaw88523a62011-08-30 08:34:26 -06001912 "feat %x, sectcnt %x\n",
1913 __func__,
1914 command[0],
1915 command[1],
1916 command[2],
1917 command[3]);
1918
1919 memset(port->sector_buffer, 0x00, ATA_SECT_SIZE);
1920
1921 /* Execute the command. */
1922 if (mtip_exec_internal_command(port,
1923 &fis,
1924 5,
1925 port->sector_buffer_dma,
1926 (command[3] != 0) ? ATA_SECT_SIZE : 0,
1927 0,
1928 GFP_KERNEL,
1929 MTIP_IOCTL_COMMAND_TIMEOUT_MS)
1930 < 0) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06001931 return -1;
1932 }
1933
1934 /* Collect the completion status. */
1935 command[0] = reply->command; /* Status*/
1936 command[1] = reply->features; /* Error*/
1937 command[2] = command[3];
1938
1939 dbg_printk(MTIP_DRV_NAME
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02001940 " %s: Completion Status: stat %x, "
Sam Bradshaw88523a62011-08-30 08:34:26 -06001941 "err %x, cmd %x\n",
1942 __func__,
1943 command[0],
1944 command[1],
1945 command[2]);
1946
1947 if (user_buffer && command[3]) {
1948 if (copy_to_user(user_buffer,
1949 port->sector_buffer,
1950 ATA_SECT_SIZE * command[3])) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06001951 return -EFAULT;
1952 }
1953 }
1954
Sam Bradshaw88523a62011-08-30 08:34:26 -06001955 return 0;
1956}
1957
1958/*
1959 * Indicates whether a command has a single sector payload.
1960 *
1961 * @command passed to the device to perform the certain event.
1962 * @features passed to the device to perform the certain event.
1963 *
1964 * return value
1965 * 1 command is one that always has a single sector payload,
1966 * regardless of the value in the Sector Count field.
1967 * 0 otherwise
1968 *
1969 */
1970static unsigned int implicit_sector(unsigned char command,
1971 unsigned char features)
1972{
1973 unsigned int rv = 0;
1974
1975 /* list of commands that have an implicit sector count of 1 */
1976 switch (command) {
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001977 case ATA_CMD_SEC_SET_PASS:
1978 case ATA_CMD_SEC_UNLOCK:
1979 case ATA_CMD_SEC_ERASE_PREP:
1980 case ATA_CMD_SEC_ERASE_UNIT:
1981 case ATA_CMD_SEC_FREEZE_LOCK:
1982 case ATA_CMD_SEC_DISABLE_PASS:
1983 case ATA_CMD_PMP_READ:
1984 case ATA_CMD_PMP_WRITE:
Sam Bradshaw88523a62011-08-30 08:34:26 -06001985 rv = 1;
1986 break;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001987 case ATA_CMD_SET_MAX:
1988 if (features == ATA_SET_MAX_UNLOCK)
Sam Bradshaw88523a62011-08-30 08:34:26 -06001989 rv = 1;
1990 break;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001991 case ATA_CMD_SMART:
1992 if ((features == ATA_SMART_READ_VALUES) ||
1993 (features == ATA_SMART_READ_THRESHOLDS))
Sam Bradshaw88523a62011-08-30 08:34:26 -06001994 rv = 1;
1995 break;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01001996 case ATA_CMD_CONF_OVERLAY:
1997 if ((features == ATA_DCO_IDENTIFY) ||
1998 (features == ATA_DCO_SET))
Sam Bradshaw88523a62011-08-30 08:34:26 -06001999 rv = 1;
2000 break;
2001 }
2002 return rv;
2003}
2004
Asai Thambi S P2df7aa92012-05-29 18:41:23 -07002005static void mtip_set_timeout(struct host_to_dev_fis *fis, unsigned int *timeout)
2006{
2007 switch (fis->command) {
2008 case ATA_CMD_DOWNLOAD_MICRO:
2009 *timeout = 120000; /* 2 minutes */
2010 break;
2011 case ATA_CMD_SEC_ERASE_UNIT:
2012 case 0xFC:
2013 *timeout = 240000; /* 4 minutes */
2014 break;
2015 case ATA_CMD_STANDBYNOW1:
2016 *timeout = 10000; /* 10 seconds */
2017 break;
2018 case 0xF7:
2019 case 0xFA:
2020 *timeout = 60000; /* 60 seconds */
2021 break;
2022 case ATA_CMD_SMART:
2023 *timeout = 15000; /* 15 seconds */
2024 break;
2025 default:
2026 *timeout = MTIP_IOCTL_COMMAND_TIMEOUT_MS;
2027 break;
2028 }
2029}
2030
Sam Bradshaw88523a62011-08-30 08:34:26 -06002031/*
2032 * Executes a taskfile
2033 * See ide_taskfile_ioctl() for derivation
2034 */
2035static int exec_drive_taskfile(struct driver_data *dd,
Jens Axboeef0f1582011-09-27 21:19:53 -06002036 void __user *buf,
2037 ide_task_request_t *req_task,
2038 int outtotal)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002039{
2040 struct host_to_dev_fis fis;
2041 struct host_to_dev_fis *reply;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002042 u8 *outbuf = NULL;
2043 u8 *inbuf = NULL;
Jens Axboe16d02c02011-09-27 15:50:01 -06002044 dma_addr_t outbuf_dma = 0;
2045 dma_addr_t inbuf_dma = 0;
2046 dma_addr_t dma_buffer = 0;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002047 int err = 0;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002048 unsigned int taskin = 0;
2049 unsigned int taskout = 0;
2050 u8 nsect = 0;
Asai Thambi S P2df7aa92012-05-29 18:41:23 -07002051 unsigned int timeout;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002052 unsigned int force_single_sector;
2053 unsigned int transfer_size;
2054 unsigned long task_file_data;
Jens Axboeef0f1582011-09-27 21:19:53 -06002055 int intotal = outtotal + req_task->out_size;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002056
2057 taskout = req_task->out_size;
2058 taskin = req_task->in_size;
2059 /* 130560 = 512 * 0xFF*/
2060 if (taskin > 130560 || taskout > 130560) {
2061 err = -EINVAL;
2062 goto abort;
2063 }
2064
2065 if (taskout) {
2066 outbuf = kzalloc(taskout, GFP_KERNEL);
2067 if (outbuf == NULL) {
2068 err = -ENOMEM;
2069 goto abort;
2070 }
2071 if (copy_from_user(outbuf, buf + outtotal, taskout)) {
2072 err = -EFAULT;
2073 goto abort;
2074 }
2075 outbuf_dma = pci_map_single(dd->pdev,
2076 outbuf,
2077 taskout,
2078 DMA_TO_DEVICE);
Jens Axboe16d02c02011-09-27 15:50:01 -06002079 if (outbuf_dma == 0) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06002080 err = -ENOMEM;
2081 goto abort;
2082 }
2083 dma_buffer = outbuf_dma;
2084 }
2085
2086 if (taskin) {
2087 inbuf = kzalloc(taskin, GFP_KERNEL);
2088 if (inbuf == NULL) {
2089 err = -ENOMEM;
2090 goto abort;
2091 }
2092
2093 if (copy_from_user(inbuf, buf + intotal, taskin)) {
2094 err = -EFAULT;
2095 goto abort;
2096 }
2097 inbuf_dma = pci_map_single(dd->pdev,
2098 inbuf,
2099 taskin, DMA_FROM_DEVICE);
Jens Axboe16d02c02011-09-27 15:50:01 -06002100 if (inbuf_dma == 0) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06002101 err = -ENOMEM;
2102 goto abort;
2103 }
2104 dma_buffer = inbuf_dma;
2105 }
2106
2107 /* only supports PIO and non-data commands from this ioctl. */
2108 switch (req_task->data_phase) {
2109 case TASKFILE_OUT:
2110 nsect = taskout / ATA_SECT_SIZE;
2111 reply = (dd->port->rxfis + RX_FIS_PIO_SETUP);
2112 break;
2113 case TASKFILE_IN:
2114 reply = (dd->port->rxfis + RX_FIS_PIO_SETUP);
2115 break;
2116 case TASKFILE_NO_DATA:
2117 reply = (dd->port->rxfis + RX_FIS_D2H_REG);
2118 break;
2119 default:
2120 err = -EINVAL;
2121 goto abort;
2122 }
2123
Sam Bradshaw88523a62011-08-30 08:34:26 -06002124 /* Build the FIS. */
2125 memset(&fis, 0, sizeof(struct host_to_dev_fis));
2126
2127 fis.type = 0x27;
2128 fis.opts = 1 << 7;
2129 fis.command = req_task->io_ports[7];
2130 fis.features = req_task->io_ports[1];
2131 fis.sect_count = req_task->io_ports[2];
2132 fis.lba_low = req_task->io_ports[3];
2133 fis.lba_mid = req_task->io_ports[4];
2134 fis.lba_hi = req_task->io_ports[5];
2135 /* Clear the dev bit*/
2136 fis.device = req_task->io_ports[6] & ~0x10;
2137
2138 if ((req_task->in_flags.all == 0) && (req_task->out_flags.all & 1)) {
2139 req_task->in_flags.all =
2140 IDE_TASKFILE_STD_IN_FLAGS |
2141 (IDE_HOB_STD_IN_FLAGS << 8);
2142 fis.lba_low_ex = req_task->hob_ports[3];
2143 fis.lba_mid_ex = req_task->hob_ports[4];
2144 fis.lba_hi_ex = req_task->hob_ports[5];
2145 fis.features_ex = req_task->hob_ports[1];
2146 fis.sect_cnt_ex = req_task->hob_ports[2];
2147
2148 } else {
2149 req_task->in_flags.all = IDE_TASKFILE_STD_IN_FLAGS;
2150 }
2151
2152 force_single_sector = implicit_sector(fis.command, fis.features);
2153
2154 if ((taskin || taskout) && (!fis.sect_count)) {
2155 if (nsect)
2156 fis.sect_count = nsect;
2157 else {
2158 if (!force_single_sector) {
2159 dev_warn(&dd->pdev->dev,
2160 "data movement but "
2161 "sect_count is 0\n");
Sam Bradshaw88523a62011-08-30 08:34:26 -06002162 err = -EINVAL;
2163 goto abort;
2164 }
2165 }
2166 }
2167
2168 dbg_printk(MTIP_DRV_NAME
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02002169 " %s: cmd %x, feat %x, nsect %x,"
Sam Bradshaw88523a62011-08-30 08:34:26 -06002170 " sect/lbal %x, lcyl/lbam %x, hcyl/lbah %x,"
2171 " head/dev %x\n",
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02002172 __func__,
Sam Bradshaw88523a62011-08-30 08:34:26 -06002173 fis.command,
2174 fis.features,
2175 fis.sect_count,
2176 fis.lba_low,
2177 fis.lba_mid,
2178 fis.lba_hi,
2179 fis.device);
2180
Asai Thambi S P2df7aa92012-05-29 18:41:23 -07002181 mtip_set_timeout(&fis, &timeout);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002182
2183 /* Determine the correct transfer size.*/
2184 if (force_single_sector)
2185 transfer_size = ATA_SECT_SIZE;
2186 else
2187 transfer_size = ATA_SECT_SIZE * fis.sect_count;
2188
2189 /* Execute the command.*/
2190 if (mtip_exec_internal_command(dd->port,
2191 &fis,
2192 5,
2193 dma_buffer,
2194 transfer_size,
2195 0,
2196 GFP_KERNEL,
2197 timeout) < 0) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06002198 err = -EIO;
2199 goto abort;
2200 }
2201
2202 task_file_data = readl(dd->port->mmio+PORT_TFDATA);
2203
2204 if ((req_task->data_phase == TASKFILE_IN) && !(task_file_data & 1)) {
2205 reply = dd->port->rxfis + RX_FIS_PIO_SETUP;
2206 req_task->io_ports[7] = reply->control;
2207 } else {
2208 reply = dd->port->rxfis + RX_FIS_D2H_REG;
2209 req_task->io_ports[7] = reply->command;
2210 }
2211
2212 /* reclaim the DMA buffers.*/
2213 if (inbuf_dma)
2214 pci_unmap_single(dd->pdev, inbuf_dma,
2215 taskin, DMA_FROM_DEVICE);
2216 if (outbuf_dma)
2217 pci_unmap_single(dd->pdev, outbuf_dma,
2218 taskout, DMA_TO_DEVICE);
Jens Axboe16d02c02011-09-27 15:50:01 -06002219 inbuf_dma = 0;
2220 outbuf_dma = 0;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002221
2222 /* return the ATA registers to the caller.*/
2223 req_task->io_ports[1] = reply->features;
2224 req_task->io_ports[2] = reply->sect_count;
2225 req_task->io_ports[3] = reply->lba_low;
2226 req_task->io_ports[4] = reply->lba_mid;
2227 req_task->io_ports[5] = reply->lba_hi;
2228 req_task->io_ports[6] = reply->device;
2229
2230 if (req_task->out_flags.all & 1) {
2231
2232 req_task->hob_ports[3] = reply->lba_low_ex;
2233 req_task->hob_ports[4] = reply->lba_mid_ex;
2234 req_task->hob_ports[5] = reply->lba_hi_ex;
2235 req_task->hob_ports[1] = reply->features_ex;
2236 req_task->hob_ports[2] = reply->sect_cnt_ex;
2237 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06002238 dbg_printk(MTIP_DRV_NAME
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02002239 " %s: Completion: stat %x,"
Sam Bradshaw88523a62011-08-30 08:34:26 -06002240 "err %x, sect_cnt %x, lbalo %x,"
2241 "lbamid %x, lbahi %x, dev %x\n",
2242 __func__,
2243 req_task->io_ports[7],
2244 req_task->io_ports[1],
2245 req_task->io_ports[2],
2246 req_task->io_ports[3],
2247 req_task->io_ports[4],
2248 req_task->io_ports[5],
2249 req_task->io_ports[6]);
2250
Sam Bradshaw88523a62011-08-30 08:34:26 -06002251 if (taskout) {
2252 if (copy_to_user(buf + outtotal, outbuf, taskout)) {
2253 err = -EFAULT;
2254 goto abort;
2255 }
2256 }
2257 if (taskin) {
2258 if (copy_to_user(buf + intotal, inbuf, taskin)) {
2259 err = -EFAULT;
2260 goto abort;
2261 }
2262 }
2263abort:
2264 if (inbuf_dma)
2265 pci_unmap_single(dd->pdev, inbuf_dma,
2266 taskin, DMA_FROM_DEVICE);
2267 if (outbuf_dma)
2268 pci_unmap_single(dd->pdev, outbuf_dma,
2269 taskout, DMA_TO_DEVICE);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002270 kfree(outbuf);
2271 kfree(inbuf);
2272
2273 return err;
2274}
2275
2276/*
2277 * Handle IOCTL calls from the Block Layer.
2278 *
2279 * This function is called by the Block Layer when it receives an IOCTL
2280 * command that it does not understand. If the IOCTL command is not supported
2281 * this function returns -ENOTTY.
2282 *
2283 * @dd Pointer to the driver data structure.
2284 * @cmd IOCTL command passed from the Block Layer.
2285 * @arg IOCTL argument passed from the Block Layer.
2286 *
2287 * return value
2288 * 0 The IOCTL completed successfully.
2289 * -ENOTTY The specified command is not supported.
2290 * -EFAULT An error occurred copying data to a user space buffer.
2291 * -EIO An error occurred while executing the command.
2292 */
Jens Axboeef0f1582011-09-27 21:19:53 -06002293static int mtip_hw_ioctl(struct driver_data *dd, unsigned int cmd,
2294 unsigned long arg)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002295{
2296 switch (cmd) {
2297 case HDIO_GET_IDENTITY:
2298 if (mtip_get_identify(dd->port, (void __user *) arg) < 0) {
2299 dev_warn(&dd->pdev->dev,
2300 "Unable to read identity\n");
2301 return -EIO;
2302 }
2303
2304 break;
2305 case HDIO_DRIVE_CMD:
2306 {
2307 u8 drive_command[4];
2308
2309 /* Copy the user command info to our buffer. */
2310 if (copy_from_user(drive_command,
2311 (void __user *) arg,
2312 sizeof(drive_command)))
2313 return -EFAULT;
2314
2315 /* Execute the drive command. */
2316 if (exec_drive_command(dd->port,
2317 drive_command,
2318 (void __user *) (arg+4)))
2319 return -EIO;
2320
2321 /* Copy the status back to the users buffer. */
2322 if (copy_to_user((void __user *) arg,
2323 drive_command,
2324 sizeof(drive_command)))
2325 return -EFAULT;
2326
2327 break;
2328 }
2329 case HDIO_DRIVE_TASK:
2330 {
2331 u8 drive_command[7];
2332
2333 /* Copy the user command info to our buffer. */
2334 if (copy_from_user(drive_command,
2335 (void __user *) arg,
2336 sizeof(drive_command)))
2337 return -EFAULT;
2338
2339 /* Execute the drive command. */
2340 if (exec_drive_task(dd->port, drive_command))
2341 return -EIO;
2342
2343 /* Copy the status back to the users buffer. */
2344 if (copy_to_user((void __user *) arg,
2345 drive_command,
2346 sizeof(drive_command)))
2347 return -EFAULT;
2348
2349 break;
2350 }
Jens Axboeef0f1582011-09-27 21:19:53 -06002351 case HDIO_DRIVE_TASKFILE: {
2352 ide_task_request_t req_task;
2353 int ret, outtotal;
2354
2355 if (copy_from_user(&req_task, (void __user *) arg,
2356 sizeof(req_task)))
2357 return -EFAULT;
2358
2359 outtotal = sizeof(req_task);
2360
2361 ret = exec_drive_taskfile(dd, (void __user *) arg,
2362 &req_task, outtotal);
2363
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002364 if (copy_to_user((void __user *) arg, &req_task,
2365 sizeof(req_task)))
Jens Axboeef0f1582011-09-27 21:19:53 -06002366 return -EFAULT;
2367
2368 return ret;
2369 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06002370
2371 default:
2372 return -EINVAL;
2373 }
2374 return 0;
2375}
2376
2377/*
2378 * Submit an IO to the hw
2379 *
2380 * This function is called by the block layer to issue an io
2381 * to the device. Upon completion, the callback function will
2382 * be called with the data parameter passed as the callback data.
2383 *
2384 * @dd Pointer to the driver data structure.
2385 * @start First sector to read.
2386 * @nsect Number of sectors to read.
2387 * @nents Number of entries in scatter list for the read command.
2388 * @tag The tag of this read command.
2389 * @callback Pointer to the function that should be called
2390 * when the read completes.
2391 * @data Callback data passed to the callback function
2392 * when the read completes.
Sam Bradshaw88523a62011-08-30 08:34:26 -06002393 * @dir Direction (read or write)
2394 *
2395 * return value
2396 * None
2397 */
Jens Axboe63166682011-09-27 21:27:43 -06002398static void mtip_hw_submit_io(struct driver_data *dd, sector_t start,
2399 int nsect, int nents, int tag, void *callback,
Asai Thambi S P4e8670e2012-02-07 07:54:31 +01002400 void *data, int dir)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002401{
2402 struct host_to_dev_fis *fis;
2403 struct mtip_port *port = dd->port;
2404 struct mtip_cmd *command = &port->commands[tag];
Asai Thambi S P45038362012-04-09 08:35:38 +02002405 int dma_dir = (dir == READ) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002406
2407 /* Map the scatter list for DMA access */
Asai Thambi S P45038362012-04-09 08:35:38 +02002408 nents = dma_map_sg(&dd->pdev->dev, command->sg, nents, dma_dir);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002409
2410 command->scatter_ents = nents;
2411
2412 /*
2413 * The number of retries for this command before it is
2414 * reported as a failure to the upper layers.
2415 */
2416 command->retries = MTIP_MAX_RETRIES;
2417
2418 /* Fill out fis */
2419 fis = command->command;
2420 fis->type = 0x27;
2421 fis->opts = 1 << 7;
2422 fis->command =
2423 (dir == READ ? ATA_CMD_FPDMA_READ : ATA_CMD_FPDMA_WRITE);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002424 *((unsigned int *) &fis->lba_low) = (start & 0xFFFFFF);
2425 *((unsigned int *) &fis->lba_low_ex) = ((start >> 24) & 0xFFFFFF);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002426 fis->device = 1 << 6;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002427 fis->features = nsect & 0xFF;
2428 fis->features_ex = (nsect >> 8) & 0xFF;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002429 fis->sect_count = ((tag << 3) | (tag >> 5));
2430 fis->sect_cnt_ex = 0;
2431 fis->control = 0;
2432 fis->res2 = 0;
2433 fis->res3 = 0;
2434 fill_command_sg(dd, command, nents);
2435
2436 /* Populate the command header */
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002437 command->command_header->opts =
2438 __force_bit2int cpu_to_le32(
2439 (nents << 16) | 5 | AHCI_CMD_PREFETCH);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002440 command->command_header->byte_count = 0;
2441
2442 /*
2443 * Set the completion function and data for the command
2444 * within this layer.
2445 */
2446 command->comp_data = dd;
2447 command->comp_func = mtip_async_complete;
Asai Thambi S P45038362012-04-09 08:35:38 +02002448 command->direction = dma_dir;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002449
2450 /*
2451 * Set the completion function and data for the command passed
2452 * from the upper layer.
2453 */
2454 command->async_data = data;
2455 command->async_callback = callback;
2456
2457 /*
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002458 * To prevent this command from being issued
2459 * if an internal command is in progress or error handling is active.
Sam Bradshaw88523a62011-08-30 08:34:26 -06002460 */
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02002461 if (port->flags & MTIP_PF_PAUSE_IO) {
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002462 set_bit(tag, port->cmds_to_issue);
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002463 set_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002464 return;
2465 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06002466
2467 /* Issue the command to the hardware */
2468 mtip_issue_ncq_command(port, tag);
2469
Asai Thambi S Pdad40f12012-04-09 08:35:38 +02002470 return;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002471}
2472
2473/*
2474 * Release a command slot.
2475 *
2476 * @dd Pointer to the driver data structure.
2477 * @tag Slot tag
2478 *
2479 * return value
2480 * None
2481 */
Jens Axboe63166682011-09-27 21:27:43 -06002482static void mtip_hw_release_scatterlist(struct driver_data *dd, int tag)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002483{
2484 release_slot(dd->port, tag);
2485}
2486
2487/*
2488 * Obtain a command slot and return its associated scatter list.
2489 *
2490 * @dd Pointer to the driver data structure.
2491 * @tag Pointer to an int that will receive the allocated command
2492 * slot tag.
2493 *
2494 * return value
2495 * Pointer to the scatter list for the allocated command slot
2496 * or NULL if no command slots are available.
2497 */
Jens Axboe63166682011-09-27 21:27:43 -06002498static struct scatterlist *mtip_hw_get_scatterlist(struct driver_data *dd,
2499 int *tag)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002500{
2501 /*
2502 * It is possible that, even with this semaphore, a thread
2503 * may think that no command slots are available. Therefore, we
2504 * need to make an attempt to get_slot().
2505 */
2506 down(&dd->port->cmd_slot);
2507 *tag = get_slot(dd->port);
2508
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002509 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))) {
Asai Thambi S P45038362012-04-09 08:35:38 +02002510 up(&dd->port->cmd_slot);
2511 return NULL;
2512 }
Asai Thambi S Pa09ba132012-04-16 21:27:55 +02002513 if (unlikely(*tag < 0)) {
2514 up(&dd->port->cmd_slot);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002515 return NULL;
Asai Thambi S Pa09ba132012-04-16 21:27:55 +02002516 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06002517
2518 return dd->port->commands[*tag].sg;
2519}
2520
2521/*
2522 * Sysfs register/status dump.
2523 *
2524 * @dev Pointer to the device structure, passed by the kernrel.
2525 * @attr Pointer to the device_attribute structure passed by the kernel.
2526 * @buf Pointer to the char buffer that will receive the stats info.
2527 *
2528 * return value
2529 * The size, in bytes, of the data copied into buf.
2530 */
Asai Thambi S P45038362012-04-09 08:35:38 +02002531static ssize_t mtip_hw_show_registers(struct device *dev,
Sam Bradshaw88523a62011-08-30 08:34:26 -06002532 struct device_attribute *attr,
2533 char *buf)
2534{
2535 u32 group_allocated;
2536 struct driver_data *dd = dev_to_disk(dev)->private_data;
2537 int size = 0;
2538 int n;
2539
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002540 size += sprintf(&buf[size], "S ACTive:\n");
Sam Bradshaw88523a62011-08-30 08:34:26 -06002541
2542 for (n = 0; n < dd->slot_groups; n++)
2543 size += sprintf(&buf[size], "0x%08x\n",
2544 readl(dd->port->s_active[n]));
2545
2546 size += sprintf(&buf[size], "Command Issue:\n");
2547
2548 for (n = 0; n < dd->slot_groups; n++)
2549 size += sprintf(&buf[size], "0x%08x\n",
2550 readl(dd->port->cmd_issue[n]));
2551
2552 size += sprintf(&buf[size], "Allocated:\n");
2553
2554 for (n = 0; n < dd->slot_groups; n++) {
2555 if (sizeof(long) > sizeof(u32))
2556 group_allocated =
2557 dd->port->allocated[n/2] >> (32*(n&1));
2558 else
2559 group_allocated = dd->port->allocated[n];
2560 size += sprintf(&buf[size], "0x%08x\n",
2561 group_allocated);
2562 }
2563
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002564 size += sprintf(&buf[size], "Completed:\n");
Sam Bradshaw88523a62011-08-30 08:34:26 -06002565
2566 for (n = 0; n < dd->slot_groups; n++)
2567 size += sprintf(&buf[size], "0x%08x\n",
2568 readl(dd->port->completed[n]));
2569
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002570 size += sprintf(&buf[size], "PORT IRQ STAT : 0x%08x\n",
Sam Bradshaw88523a62011-08-30 08:34:26 -06002571 readl(dd->port->mmio + PORT_IRQ_STAT));
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002572 size += sprintf(&buf[size], "HOST IRQ STAT : 0x%08x\n",
Sam Bradshaw88523a62011-08-30 08:34:26 -06002573 readl(dd->mmio + HOST_IRQ_STAT));
2574
2575 return size;
2576}
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002577
2578static ssize_t mtip_hw_show_status(struct device *dev,
2579 struct device_attribute *attr,
2580 char *buf)
2581{
2582 struct driver_data *dd = dev_to_disk(dev)->private_data;
2583 int size = 0;
2584
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002585 if (test_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag))
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002586 size += sprintf(buf, "%s", "thermal_shutdown\n");
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002587 else if (test_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag))
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002588 size += sprintf(buf, "%s", "write_protect\n");
2589 else
2590 size += sprintf(buf, "%s", "online\n");
2591
2592 return size;
2593}
2594
Asai Thambi S P45038362012-04-09 08:35:38 +02002595static DEVICE_ATTR(registers, S_IRUGO, mtip_hw_show_registers, NULL);
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002596static DEVICE_ATTR(status, S_IRUGO, mtip_hw_show_status, NULL);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002597
2598/*
2599 * Create the sysfs related attributes.
2600 *
2601 * @dd Pointer to the driver data structure.
2602 * @kobj Pointer to the kobj for the block device.
2603 *
2604 * return value
2605 * 0 Operation completed successfully.
2606 * -EINVAL Invalid parameter.
2607 */
Jens Axboe63166682011-09-27 21:27:43 -06002608static int mtip_hw_sysfs_init(struct driver_data *dd, struct kobject *kobj)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002609{
2610 if (!kobj || !dd)
2611 return -EINVAL;
2612
2613 if (sysfs_create_file(kobj, &dev_attr_registers.attr))
2614 dev_warn(&dd->pdev->dev,
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002615 "Error creating 'registers' sysfs entry\n");
2616 if (sysfs_create_file(kobj, &dev_attr_status.attr))
2617 dev_warn(&dd->pdev->dev,
2618 "Error creating 'status' sysfs entry\n");
Sam Bradshaw88523a62011-08-30 08:34:26 -06002619 return 0;
2620}
2621
2622/*
2623 * Remove the sysfs related attributes.
2624 *
2625 * @dd Pointer to the driver data structure.
2626 * @kobj Pointer to the kobj for the block device.
2627 *
2628 * return value
2629 * 0 Operation completed successfully.
2630 * -EINVAL Invalid parameter.
2631 */
Jens Axboe63166682011-09-27 21:27:43 -06002632static int mtip_hw_sysfs_exit(struct driver_data *dd, struct kobject *kobj)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002633{
2634 if (!kobj || !dd)
2635 return -EINVAL;
2636
2637 sysfs_remove_file(kobj, &dev_attr_registers.attr);
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002638 sysfs_remove_file(kobj, &dev_attr_status.attr);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002639
2640 return 0;
2641}
2642
2643/*
2644 * Perform any init/resume time hardware setup
2645 *
2646 * @dd Pointer to the driver data structure.
2647 *
2648 * return value
2649 * None
2650 */
2651static inline void hba_setup(struct driver_data *dd)
2652{
2653 u32 hwdata;
2654 hwdata = readl(dd->mmio + HOST_HSORG);
2655
2656 /* interrupt bug workaround: use only 1 IS bit.*/
2657 writel(hwdata |
2658 HSORG_DISABLE_SLOTGRP_INTR |
2659 HSORG_DISABLE_SLOTGRP_PXIS,
2660 dd->mmio + HOST_HSORG);
2661}
2662
2663/*
2664 * Detect the details of the product, and store anything needed
2665 * into the driver data structure. This includes product type and
2666 * version and number of slot groups.
2667 *
2668 * @dd Pointer to the driver data structure.
2669 *
2670 * return value
2671 * None
2672 */
2673static void mtip_detect_product(struct driver_data *dd)
2674{
2675 u32 hwdata;
2676 unsigned int rev, slotgroups;
2677
2678 /*
2679 * HBA base + 0xFC [15:0] - vendor-specific hardware interface
2680 * info register:
2681 * [15:8] hardware/software interface rev#
2682 * [ 3] asic-style interface
2683 * [ 2:0] number of slot groups, minus 1 (only valid for asic-style).
2684 */
2685 hwdata = readl(dd->mmio + HOST_HSORG);
2686
2687 dd->product_type = MTIP_PRODUCT_UNKNOWN;
2688 dd->slot_groups = 1;
2689
2690 if (hwdata & 0x8) {
2691 dd->product_type = MTIP_PRODUCT_ASICFPGA;
2692 rev = (hwdata & HSORG_HWREV) >> 8;
2693 slotgroups = (hwdata & HSORG_SLOTGROUPS) + 1;
2694 dev_info(&dd->pdev->dev,
2695 "ASIC-FPGA design, HS rev 0x%x, "
2696 "%i slot groups [%i slots]\n",
2697 rev,
2698 slotgroups,
2699 slotgroups * 32);
2700
2701 if (slotgroups > MTIP_MAX_SLOT_GROUPS) {
2702 dev_warn(&dd->pdev->dev,
2703 "Warning: driver only supports "
2704 "%i slot groups.\n", MTIP_MAX_SLOT_GROUPS);
2705 slotgroups = MTIP_MAX_SLOT_GROUPS;
2706 }
2707 dd->slot_groups = slotgroups;
2708 return;
2709 }
2710
2711 dev_warn(&dd->pdev->dev, "Unrecognized product id\n");
2712}
2713
2714/*
2715 * Blocking wait for FTL rebuild to complete
2716 *
2717 * @dd Pointer to the DRIVER_DATA structure.
2718 *
2719 * return value
2720 * 0 FTL rebuild completed successfully
2721 * -EFAULT FTL rebuild error/timeout/interruption
2722 */
2723static int mtip_ftl_rebuild_poll(struct driver_data *dd)
2724{
2725 unsigned long timeout, cnt = 0, start;
2726
2727 dev_warn(&dd->pdev->dev,
2728 "FTL rebuild in progress. Polling for completion.\n");
2729
2730 start = jiffies;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002731 timeout = jiffies + msecs_to_jiffies(MTIP_FTL_REBUILD_TIMEOUT_MS);
2732
2733 do {
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002734 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
Asai Thambi S P45038362012-04-09 08:35:38 +02002735 &dd->dd_flag)))
2736 return -EFAULT;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002737 if (mtip_check_surprise_removal(dd->pdev))
2738 return -EFAULT;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002739
Sam Bradshaw88523a62011-08-30 08:34:26 -06002740 if (mtip_get_identify(dd->port, NULL) < 0)
2741 return -EFAULT;
2742
2743 if (*(dd->port->identify + MTIP_FTL_REBUILD_OFFSET) ==
2744 MTIP_FTL_REBUILD_MAGIC) {
2745 ssleep(1);
2746 /* Print message every 3 minutes */
2747 if (cnt++ >= 180) {
2748 dev_warn(&dd->pdev->dev,
2749 "FTL rebuild in progress (%d secs).\n",
2750 jiffies_to_msecs(jiffies - start) / 1000);
2751 cnt = 0;
2752 }
2753 } else {
2754 dev_warn(&dd->pdev->dev,
2755 "FTL rebuild complete (%d secs).\n",
2756 jiffies_to_msecs(jiffies - start) / 1000);
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01002757 mtip_block_initialize(dd);
Asai Thambi S P45038362012-04-09 08:35:38 +02002758 return 0;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002759 }
2760 ssleep(10);
2761 } while (time_before(jiffies, timeout));
2762
2763 /* Check for timeout */
Asai Thambi S P45038362012-04-09 08:35:38 +02002764 dev_err(&dd->pdev->dev,
Sam Bradshaw88523a62011-08-30 08:34:26 -06002765 "Timed out waiting for FTL rebuild to complete (%d secs).\n",
2766 jiffies_to_msecs(jiffies - start) / 1000);
Asai Thambi S P45038362012-04-09 08:35:38 +02002767 return -EFAULT;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002768}
2769
2770/*
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002771 * service thread to issue queued commands
2772 *
2773 * @data Pointer to the driver data structure.
2774 *
2775 * return value
2776 * 0
2777 */
2778
2779static int mtip_service_thread(void *data)
2780{
2781 struct driver_data *dd = (struct driver_data *)data;
2782 unsigned long slot, slot_start, slot_wrap;
2783 unsigned int num_cmd_slots = dd->slot_groups * 32;
2784 struct mtip_port *port = dd->port;
2785
2786 while (1) {
2787 /*
2788 * the condition is to check neither an internal command is
2789 * is in progress nor error handling is active
2790 */
2791 wait_event_interruptible(port->svc_wait, (port->flags) &&
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02002792 !(port->flags & MTIP_PF_PAUSE_IO));
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002793
2794 if (kthread_should_stop())
2795 break;
2796
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002797 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
Asai Thambi S P45038362012-04-09 08:35:38 +02002798 &dd->dd_flag)))
2799 break;
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02002800
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002801 set_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags);
2802 if (test_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags)) {
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002803 slot = 1;
2804 /* used to restrict the loop to one iteration */
2805 slot_start = num_cmd_slots;
2806 slot_wrap = 0;
2807 while (1) {
2808 slot = find_next_bit(port->cmds_to_issue,
2809 num_cmd_slots, slot);
2810 if (slot_wrap == 1) {
2811 if ((slot_start >= slot) ||
2812 (slot >= num_cmd_slots))
2813 break;
2814 }
2815 if (unlikely(slot_start == num_cmd_slots))
2816 slot_start = slot;
2817
2818 if (unlikely(slot == num_cmd_slots)) {
2819 slot = 1;
2820 slot_wrap = 1;
2821 continue;
2822 }
2823
2824 /* Issue the command to the hardware */
2825 mtip_issue_ncq_command(port, slot);
2826
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002827 clear_bit(slot, port->cmds_to_issue);
2828 }
2829
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002830 clear_bit(MTIP_PF_ISSUE_CMDS_BIT, &port->flags);
2831 } else if (test_bit(MTIP_PF_REBUILD_BIT, &port->flags)) {
Asai Thambi S P8182b492012-04-09 08:35:38 +02002832 if (!mtip_ftl_rebuild_poll(dd))
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002833 set_bit(MTIP_DDF_REBUILD_FAILED_BIT,
Asai Thambi S P8182b492012-04-09 08:35:38 +02002834 &dd->dd_flag);
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002835 clear_bit(MTIP_PF_REBUILD_BIT, &port->flags);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002836 }
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002837 clear_bit(MTIP_PF_SVC_THD_ACTIVE_BIT, &port->flags);
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01002838
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02002839 if (test_bit(MTIP_PF_SVC_THD_STOP_BIT, &port->flags))
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01002840 break;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002841 }
2842 return 0;
2843}
2844
2845/*
Sam Bradshaw88523a62011-08-30 08:34:26 -06002846 * Called once for each card.
2847 *
2848 * @dd Pointer to the driver data structure.
2849 *
2850 * return value
2851 * 0 on success, else an error code.
2852 */
Jens Axboe63166682011-09-27 21:27:43 -06002853static int mtip_hw_init(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06002854{
2855 int i;
2856 int rv;
2857 unsigned int num_command_slots;
Asai Thambi S P45038362012-04-09 08:35:38 +02002858 unsigned long timeout, timetaken;
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002859 unsigned char *buf;
2860 struct smart_attr attr242;
Sam Bradshaw88523a62011-08-30 08:34:26 -06002861
2862 dd->mmio = pcim_iomap_table(dd->pdev)[MTIP_ABAR];
2863
2864 mtip_detect_product(dd);
2865 if (dd->product_type == MTIP_PRODUCT_UNKNOWN) {
2866 rv = -EIO;
2867 goto out1;
2868 }
2869 num_command_slots = dd->slot_groups * 32;
2870
2871 hba_setup(dd);
2872
Sam Bradshaw88523a62011-08-30 08:34:26 -06002873 tasklet_init(&dd->tasklet, mtip_tasklet, (unsigned long)dd);
2874
2875 dd->port = kzalloc(sizeof(struct mtip_port), GFP_KERNEL);
2876 if (!dd->port) {
2877 dev_err(&dd->pdev->dev,
2878 "Memory allocation: port structure\n");
2879 return -ENOMEM;
2880 }
2881
2882 /* Counting semaphore to track command slot usage */
2883 sema_init(&dd->port->cmd_slot, num_command_slots - 1);
2884
2885 /* Spinlock to prevent concurrent issue */
2886 spin_lock_init(&dd->port->cmd_issue_lock);
2887
2888 /* Set the port mmio base address. */
2889 dd->port->mmio = dd->mmio + PORT_OFFSET;
2890 dd->port->dd = dd;
2891
2892 /* Allocate memory for the command list. */
2893 dd->port->command_list =
2894 dmam_alloc_coherent(&dd->pdev->dev,
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002895 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
Sam Bradshaw88523a62011-08-30 08:34:26 -06002896 &dd->port->command_list_dma,
2897 GFP_KERNEL);
2898 if (!dd->port->command_list) {
2899 dev_err(&dd->pdev->dev,
2900 "Memory allocation: command list\n");
2901 rv = -ENOMEM;
2902 goto out1;
2903 }
2904
2905 /* Clear the memory we have allocated. */
2906 memset(dd->port->command_list,
2907 0,
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002908 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4));
Sam Bradshaw88523a62011-08-30 08:34:26 -06002909
2910 /* Setup the addresse of the RX FIS. */
2911 dd->port->rxfis = dd->port->command_list + HW_CMD_SLOT_SZ;
2912 dd->port->rxfis_dma = dd->port->command_list_dma + HW_CMD_SLOT_SZ;
2913
2914 /* Setup the address of the command tables. */
2915 dd->port->command_table = dd->port->rxfis + AHCI_RX_FIS_SZ;
2916 dd->port->command_tbl_dma = dd->port->rxfis_dma + AHCI_RX_FIS_SZ;
2917
2918 /* Setup the address of the identify data. */
2919 dd->port->identify = dd->port->command_table +
2920 HW_CMD_TBL_AR_SZ;
2921 dd->port->identify_dma = dd->port->command_tbl_dma +
2922 HW_CMD_TBL_AR_SZ;
2923
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002924 /* Setup the address of the sector buffer - for some non-ncq cmds */
Sam Bradshaw88523a62011-08-30 08:34:26 -06002925 dd->port->sector_buffer = (void *) dd->port->identify + ATA_SECT_SIZE;
2926 dd->port->sector_buffer_dma = dd->port->identify_dma + ATA_SECT_SIZE;
2927
Asai Thambi S Pf6587212012-04-09 08:35:38 +02002928 /* Setup the address of the log buf - for read log command */
2929 dd->port->log_buf = (void *)dd->port->sector_buffer + ATA_SECT_SIZE;
2930 dd->port->log_buf_dma = dd->port->sector_buffer_dma + ATA_SECT_SIZE;
2931
2932 /* Setup the address of the smart buf - for smart read data command */
2933 dd->port->smart_buf = (void *)dd->port->log_buf + ATA_SECT_SIZE;
2934 dd->port->smart_buf_dma = dd->port->log_buf_dma + ATA_SECT_SIZE;
2935
2936
Sam Bradshaw88523a62011-08-30 08:34:26 -06002937 /* Point the command headers at the command tables. */
2938 for (i = 0; i < num_command_slots; i++) {
2939 dd->port->commands[i].command_header =
2940 dd->port->command_list +
2941 (sizeof(struct mtip_cmd_hdr) * i);
2942 dd->port->commands[i].command_header_dma =
2943 dd->port->command_list_dma +
2944 (sizeof(struct mtip_cmd_hdr) * i);
2945
2946 dd->port->commands[i].command =
2947 dd->port->command_table + (HW_CMD_TBL_SZ * i);
2948 dd->port->commands[i].command_dma =
2949 dd->port->command_tbl_dma + (HW_CMD_TBL_SZ * i);
2950
2951 if (readl(dd->mmio + HOST_CAP) & HOST_CAP_64)
2952 dd->port->commands[i].command_header->ctbau =
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002953 __force_bit2int cpu_to_le32(
Sam Bradshaw88523a62011-08-30 08:34:26 -06002954 (dd->port->commands[i].command_dma >> 16) >> 16);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01002955 dd->port->commands[i].command_header->ctba =
2956 __force_bit2int cpu_to_le32(
2957 dd->port->commands[i].command_dma & 0xFFFFFFFF);
Sam Bradshaw88523a62011-08-30 08:34:26 -06002958
2959 /*
2960 * If this is not done, a bug is reported by the stock
2961 * FC11 i386. Due to the fact that it has lots of kernel
2962 * debugging enabled.
2963 */
2964 sg_init_table(dd->port->commands[i].sg, MTIP_MAX_SG);
2965
2966 /* Mark all commands as currently inactive.*/
2967 atomic_set(&dd->port->commands[i].active, 0);
2968 }
2969
2970 /* Setup the pointers to the extended s_active and CI registers. */
2971 for (i = 0; i < dd->slot_groups; i++) {
2972 dd->port->s_active[i] =
2973 dd->port->mmio + i*0x80 + PORT_SCR_ACT;
2974 dd->port->cmd_issue[i] =
2975 dd->port->mmio + i*0x80 + PORT_COMMAND_ISSUE;
2976 dd->port->completed[i] =
2977 dd->port->mmio + i*0x80 + PORT_SDBV;
2978 }
2979
Asai Thambi S P45038362012-04-09 08:35:38 +02002980 timetaken = jiffies;
2981 timeout = jiffies + msecs_to_jiffies(30000);
2982 while (((readl(dd->port->mmio + PORT_SCR_STAT) & 0x0F) != 0x03) &&
2983 time_before(jiffies, timeout)) {
2984 mdelay(100);
2985 }
2986 if (unlikely(mtip_check_surprise_removal(dd->pdev))) {
2987 timetaken = jiffies - timetaken;
2988 dev_warn(&dd->pdev->dev,
2989 "Surprise removal detected at %u ms\n",
2990 jiffies_to_msecs(timetaken));
2991 rv = -ENODEV;
2992 goto out2 ;
2993 }
Asai Thambi S P8a857a82012-04-09 08:35:38 +02002994 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag))) {
Asai Thambi S P45038362012-04-09 08:35:38 +02002995 timetaken = jiffies - timetaken;
2996 dev_warn(&dd->pdev->dev,
2997 "Removal detected at %u ms\n",
2998 jiffies_to_msecs(timetaken));
2999 rv = -EFAULT;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003000 goto out2;
3001 }
3002
Asai Thambi S P45038362012-04-09 08:35:38 +02003003 /* Conditionally reset the HBA. */
3004 if (!(readl(dd->mmio + HOST_CAP) & HOST_CAP_NZDMA)) {
3005 if (mtip_hba_reset(dd) < 0) {
3006 dev_err(&dd->pdev->dev,
3007 "Card did not reset within timeout\n");
3008 rv = -EIO;
3009 goto out2;
3010 }
3011 } else {
3012 /* Clear any pending interrupts on the HBA */
3013 writel(readl(dd->mmio + HOST_IRQ_STAT),
3014 dd->mmio + HOST_IRQ_STAT);
3015 }
3016
Sam Bradshaw88523a62011-08-30 08:34:26 -06003017 mtip_init_port(dd->port);
3018 mtip_start_port(dd->port);
3019
3020 /* Setup the ISR and enable interrupts. */
3021 rv = devm_request_irq(&dd->pdev->dev,
3022 dd->pdev->irq,
3023 mtip_irq_handler,
3024 IRQF_SHARED,
3025 dev_driver_string(&dd->pdev->dev),
3026 dd);
3027
3028 if (rv) {
3029 dev_err(&dd->pdev->dev,
3030 "Unable to allocate IRQ %d\n", dd->pdev->irq);
3031 goto out2;
3032 }
3033
3034 /* Enable interrupts on the HBA. */
3035 writel(readl(dd->mmio + HOST_CTL) | HOST_IRQ_EN,
3036 dd->mmio + HOST_CTL);
3037
3038 init_timer(&dd->port->cmd_timer);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003039 init_waitqueue_head(&dd->port->svc_wait);
3040
Sam Bradshaw88523a62011-08-30 08:34:26 -06003041 dd->port->cmd_timer.data = (unsigned long int) dd->port;
3042 dd->port->cmd_timer.function = mtip_timeout_function;
3043 mod_timer(&dd->port->cmd_timer,
3044 jiffies + msecs_to_jiffies(MTIP_TIMEOUT_CHECK_PERIOD));
3045
Asai Thambi S P45038362012-04-09 08:35:38 +02003046
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003047 if (test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)) {
Asai Thambi S P45038362012-04-09 08:35:38 +02003048 rv = -EFAULT;
3049 goto out3;
3050 }
3051
Sam Bradshaw88523a62011-08-30 08:34:26 -06003052 if (mtip_get_identify(dd->port, NULL) < 0) {
3053 rv = -EFAULT;
3054 goto out3;
3055 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06003056
3057 if (*(dd->port->identify + MTIP_FTL_REBUILD_OFFSET) ==
3058 MTIP_FTL_REBUILD_MAGIC) {
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003059 set_bit(MTIP_PF_REBUILD_BIT, &dd->port->flags);
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003060 return MTIP_FTL_REBUILD_MAGIC;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003061 }
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003062 mtip_dump_identify(dd->port);
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003063
3064 /* check write protect, over temp and rebuild statuses */
3065 rv = mtip_read_log_page(dd->port, ATA_LOG_SATA_NCQ,
3066 dd->port->log_buf,
3067 dd->port->log_buf_dma, 1);
3068 if (rv) {
3069 dev_warn(&dd->pdev->dev,
3070 "Error in READ LOG EXT (10h) command\n");
3071 /* non-critical error, don't fail the load */
3072 } else {
3073 buf = (unsigned char *)dd->port->log_buf;
3074 if (buf[259] & 0x1) {
3075 dev_info(&dd->pdev->dev,
3076 "Write protect bit is set.\n");
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003077 set_bit(MTIP_DDF_WRITE_PROTECT_BIT, &dd->dd_flag);
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003078 }
3079 if (buf[288] == 0xF7) {
3080 dev_info(&dd->pdev->dev,
3081 "Exceeded Tmax, drive in thermal shutdown.\n");
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003082 set_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag);
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003083 }
3084 if (buf[288] == 0xBF) {
3085 dev_info(&dd->pdev->dev,
3086 "Drive indicates rebuild has failed.\n");
3087 /* TODO */
3088 }
3089 }
3090
3091 /* get write protect progess */
3092 memset(&attr242, 0, sizeof(struct smart_attr));
3093 if (mtip_get_smart_attr(dd->port, 242, &attr242))
3094 dev_warn(&dd->pdev->dev,
3095 "Unable to check write protect progress\n");
3096 else
3097 dev_info(&dd->pdev->dev,
3098 "Write protect progress: %d%% (%d blocks)\n",
3099 attr242.cur, attr242.data);
Sam Bradshaw88523a62011-08-30 08:34:26 -06003100 return rv;
3101
3102out3:
3103 del_timer_sync(&dd->port->cmd_timer);
3104
3105 /* Disable interrupts on the HBA. */
3106 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3107 dd->mmio + HOST_CTL);
3108
3109 /*Release the IRQ. */
3110 devm_free_irq(&dd->pdev->dev, dd->pdev->irq, dd);
3111
3112out2:
3113 mtip_deinit_port(dd->port);
3114
3115 /* Free the command/command header memory. */
3116 dmam_free_coherent(&dd->pdev->dev,
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003117 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
Sam Bradshaw88523a62011-08-30 08:34:26 -06003118 dd->port->command_list,
3119 dd->port->command_list_dma);
3120out1:
3121 /* Free the memory allocated for the for structure. */
3122 kfree(dd->port);
3123
3124 return rv;
3125}
3126
3127/*
3128 * Called to deinitialize an interface.
3129 *
3130 * @dd Pointer to the driver data structure.
3131 *
3132 * return value
3133 * 0
3134 */
Jens Axboe63166682011-09-27 21:27:43 -06003135static int mtip_hw_exit(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003136{
3137 /*
3138 * Send standby immediate (E0h) to the drive so that it
3139 * saves its state.
3140 */
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003141 if (!test_bit(MTIP_DDF_CLEANUP_BIT, &dd->dd_flag)) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06003142
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003143 if (!test_bit(MTIP_PF_REBUILD_BIT, &dd->port->flags))
Asai Thambi S P45038362012-04-09 08:35:38 +02003144 if (mtip_standby_immediate(dd->port))
3145 dev_warn(&dd->pdev->dev,
3146 "STANDBY IMMEDIATE failed\n");
Sam Bradshaw88523a62011-08-30 08:34:26 -06003147
3148 /* de-initialize the port. */
3149 mtip_deinit_port(dd->port);
3150
3151 /* Disable interrupts on the HBA. */
3152 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3153 dd->mmio + HOST_CTL);
3154 }
3155
3156 del_timer_sync(&dd->port->cmd_timer);
3157
Sam Bradshaw88523a62011-08-30 08:34:26 -06003158 /* Release the IRQ. */
3159 devm_free_irq(&dd->pdev->dev, dd->pdev->irq, dd);
3160
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003161 /* Stop the bottom half tasklet. */
3162 tasklet_kill(&dd->tasklet);
3163
Sam Bradshaw88523a62011-08-30 08:34:26 -06003164 /* Free the command/command header memory. */
3165 dmam_free_coherent(&dd->pdev->dev,
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003166 HW_PORT_PRIV_DMA_SZ + (ATA_SECT_SIZE * 4),
Sam Bradshaw88523a62011-08-30 08:34:26 -06003167 dd->port->command_list,
3168 dd->port->command_list_dma);
3169 /* Free the memory allocated for the for structure. */
3170 kfree(dd->port);
3171
3172 return 0;
3173}
3174
3175/*
3176 * Issue a Standby Immediate command to the device.
3177 *
3178 * This function is called by the Block Layer just before the
3179 * system powers off during a shutdown.
3180 *
3181 * @dd Pointer to the driver data structure.
3182 *
3183 * return value
3184 * 0
3185 */
Jens Axboe63166682011-09-27 21:27:43 -06003186static int mtip_hw_shutdown(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003187{
3188 /*
3189 * Send standby immediate (E0h) to the drive so that it
3190 * saves its state.
3191 */
3192 mtip_standby_immediate(dd->port);
3193
3194 return 0;
3195}
3196
3197/*
3198 * Suspend function
3199 *
3200 * This function is called by the Block Layer just before the
3201 * system hibernates.
3202 *
3203 * @dd Pointer to the driver data structure.
3204 *
3205 * return value
3206 * 0 Suspend was successful
3207 * -EFAULT Suspend was not successful
3208 */
Jens Axboe63166682011-09-27 21:27:43 -06003209static int mtip_hw_suspend(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003210{
3211 /*
3212 * Send standby immediate (E0h) to the drive
3213 * so that it saves its state.
3214 */
3215 if (mtip_standby_immediate(dd->port) != 0) {
3216 dev_err(&dd->pdev->dev,
3217 "Failed standby-immediate command\n");
3218 return -EFAULT;
3219 }
3220
3221 /* Disable interrupts on the HBA.*/
3222 writel(readl(dd->mmio + HOST_CTL) & ~HOST_IRQ_EN,
3223 dd->mmio + HOST_CTL);
3224 mtip_deinit_port(dd->port);
3225
3226 return 0;
3227}
3228
3229/*
3230 * Resume function
3231 *
3232 * This function is called by the Block Layer as the
3233 * system resumes.
3234 *
3235 * @dd Pointer to the driver data structure.
3236 *
3237 * return value
3238 * 0 Resume was successful
3239 * -EFAULT Resume was not successful
3240 */
Jens Axboe63166682011-09-27 21:27:43 -06003241static int mtip_hw_resume(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003242{
3243 /* Perform any needed hardware setup steps */
3244 hba_setup(dd);
3245
3246 /* Reset the HBA */
3247 if (mtip_hba_reset(dd) != 0) {
3248 dev_err(&dd->pdev->dev,
3249 "Unable to reset the HBA\n");
3250 return -EFAULT;
3251 }
3252
3253 /*
3254 * Enable the port, DMA engine, and FIS reception specific
3255 * h/w in controller.
3256 */
3257 mtip_init_port(dd->port);
3258 mtip_start_port(dd->port);
3259
3260 /* Enable interrupts on the HBA.*/
3261 writel(readl(dd->mmio + HOST_CTL) | HOST_IRQ_EN,
3262 dd->mmio + HOST_CTL);
3263
3264 return 0;
3265}
3266
3267/*
Sam Bradshaw88523a62011-08-30 08:34:26 -06003268 * Helper function for reusing disk name
3269 * upon hot insertion.
3270 */
3271static int rssd_disk_name_format(char *prefix,
3272 int index,
3273 char *buf,
3274 int buflen)
3275{
3276 const int base = 'z' - 'a' + 1;
3277 char *begin = buf + strlen(prefix);
3278 char *end = buf + buflen;
3279 char *p;
3280 int unit;
3281
3282 p = end - 1;
3283 *p = '\0';
3284 unit = base;
3285 do {
3286 if (p == begin)
3287 return -EINVAL;
3288 *--p = 'a' + (index % unit);
3289 index = (index / unit) - 1;
3290 } while (index >= 0);
3291
3292 memmove(begin, p, end - p);
3293 memcpy(buf, prefix, strlen(prefix));
3294
3295 return 0;
3296}
3297
3298/*
3299 * Block layer IOCTL handler.
3300 *
3301 * @dev Pointer to the block_device structure.
3302 * @mode ignored
3303 * @cmd IOCTL command passed from the user application.
3304 * @arg Argument passed from the user application.
3305 *
3306 * return value
3307 * 0 IOCTL completed successfully.
3308 * -ENOTTY IOCTL not supported or invalid driver data
3309 * structure pointer.
3310 */
3311static int mtip_block_ioctl(struct block_device *dev,
3312 fmode_t mode,
3313 unsigned cmd,
3314 unsigned long arg)
3315{
3316 struct driver_data *dd = dev->bd_disk->private_data;
3317
3318 if (!capable(CAP_SYS_ADMIN))
3319 return -EACCES;
3320
3321 if (!dd)
3322 return -ENOTTY;
3323
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003324 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)))
Asai Thambi S P45038362012-04-09 08:35:38 +02003325 return -ENOTTY;
3326
Sam Bradshaw88523a62011-08-30 08:34:26 -06003327 switch (cmd) {
3328 case BLKFLSBUF:
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003329 return -ENOTTY;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003330 default:
Jens Axboeef0f1582011-09-27 21:19:53 -06003331 return mtip_hw_ioctl(dd, cmd, arg);
Sam Bradshaw88523a62011-08-30 08:34:26 -06003332 }
3333}
3334
Jens Axboe16d02c02011-09-27 15:50:01 -06003335#ifdef CONFIG_COMPAT
Sam Bradshaw88523a62011-08-30 08:34:26 -06003336/*
3337 * Block layer compat IOCTL handler.
3338 *
3339 * @dev Pointer to the block_device structure.
3340 * @mode ignored
3341 * @cmd IOCTL command passed from the user application.
3342 * @arg Argument passed from the user application.
3343 *
3344 * return value
3345 * 0 IOCTL completed successfully.
3346 * -ENOTTY IOCTL not supported or invalid driver data
3347 * structure pointer.
3348 */
3349static int mtip_block_compat_ioctl(struct block_device *dev,
3350 fmode_t mode,
3351 unsigned cmd,
3352 unsigned long arg)
3353{
3354 struct driver_data *dd = dev->bd_disk->private_data;
3355
3356 if (!capable(CAP_SYS_ADMIN))
3357 return -EACCES;
3358
3359 if (!dd)
3360 return -ENOTTY;
3361
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003362 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag)))
Asai Thambi S P45038362012-04-09 08:35:38 +02003363 return -ENOTTY;
3364
Sam Bradshaw88523a62011-08-30 08:34:26 -06003365 switch (cmd) {
3366 case BLKFLSBUF:
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003367 return -ENOTTY;
Jens Axboeef0f1582011-09-27 21:19:53 -06003368 case HDIO_DRIVE_TASKFILE: {
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003369 struct mtip_compat_ide_task_request_s __user *compat_req_task;
Jens Axboeef0f1582011-09-27 21:19:53 -06003370 ide_task_request_t req_task;
3371 int compat_tasksize, outtotal, ret;
3372
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003373 compat_tasksize =
3374 sizeof(struct mtip_compat_ide_task_request_s);
Jens Axboeef0f1582011-09-27 21:19:53 -06003375
3376 compat_req_task =
3377 (struct mtip_compat_ide_task_request_s __user *) arg;
3378
3379 if (copy_from_user(&req_task, (void __user *) arg,
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003380 compat_tasksize - (2 * sizeof(compat_long_t))))
Jens Axboeef0f1582011-09-27 21:19:53 -06003381 return -EFAULT;
3382
3383 if (get_user(req_task.out_size, &compat_req_task->out_size))
3384 return -EFAULT;
3385
3386 if (get_user(req_task.in_size, &compat_req_task->in_size))
3387 return -EFAULT;
3388
3389 outtotal = sizeof(struct mtip_compat_ide_task_request_s);
3390
3391 ret = exec_drive_taskfile(dd, (void __user *) arg,
3392 &req_task, outtotal);
3393
3394 if (copy_to_user((void __user *) arg, &req_task,
3395 compat_tasksize -
3396 (2 * sizeof(compat_long_t))))
3397 return -EFAULT;
3398
3399 if (put_user(req_task.out_size, &compat_req_task->out_size))
3400 return -EFAULT;
3401
3402 if (put_user(req_task.in_size, &compat_req_task->in_size))
3403 return -EFAULT;
3404
3405 return ret;
3406 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06003407 default:
Jens Axboeef0f1582011-09-27 21:19:53 -06003408 return mtip_hw_ioctl(dd, cmd, arg);
Sam Bradshaw88523a62011-08-30 08:34:26 -06003409 }
3410}
Jens Axboe16d02c02011-09-27 15:50:01 -06003411#endif
Sam Bradshaw88523a62011-08-30 08:34:26 -06003412
3413/*
3414 * Obtain the geometry of the device.
3415 *
3416 * You may think that this function is obsolete, but some applications,
3417 * fdisk for example still used CHS values. This function describes the
3418 * device as having 224 heads and 56 sectors per cylinder. These values are
3419 * chosen so that each cylinder is aligned on a 4KB boundary. Since a
3420 * partition is described in terms of a start and end cylinder this means
3421 * that each partition is also 4KB aligned. Non-aligned partitions adversely
3422 * affects performance.
3423 *
3424 * @dev Pointer to the block_device strucutre.
3425 * @geo Pointer to a hd_geometry structure.
3426 *
3427 * return value
3428 * 0 Operation completed successfully.
3429 * -ENOTTY An error occurred while reading the drive capacity.
3430 */
3431static int mtip_block_getgeo(struct block_device *dev,
3432 struct hd_geometry *geo)
3433{
3434 struct driver_data *dd = dev->bd_disk->private_data;
3435 sector_t capacity;
3436
3437 if (!dd)
3438 return -ENOTTY;
3439
3440 if (!(mtip_hw_get_capacity(dd, &capacity))) {
3441 dev_warn(&dd->pdev->dev,
3442 "Could not get drive capacity.\n");
3443 return -ENOTTY;
3444 }
3445
3446 geo->heads = 224;
3447 geo->sectors = 56;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003448 sector_div(capacity, (geo->heads * geo->sectors));
Sam Bradshaw88523a62011-08-30 08:34:26 -06003449 geo->cylinders = capacity;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003450 return 0;
3451}
3452
3453/*
3454 * Block device operation function.
3455 *
3456 * This structure contains pointers to the functions required by the block
3457 * layer.
3458 */
3459static const struct block_device_operations mtip_block_ops = {
3460 .ioctl = mtip_block_ioctl,
Jens Axboe16d02c02011-09-27 15:50:01 -06003461#ifdef CONFIG_COMPAT
Sam Bradshaw88523a62011-08-30 08:34:26 -06003462 .compat_ioctl = mtip_block_compat_ioctl,
Jens Axboe16d02c02011-09-27 15:50:01 -06003463#endif
Sam Bradshaw88523a62011-08-30 08:34:26 -06003464 .getgeo = mtip_block_getgeo,
3465 .owner = THIS_MODULE
3466};
3467
3468/*
3469 * Block layer make request function.
3470 *
3471 * This function is called by the kernel to process a BIO for
3472 * the P320 device.
3473 *
3474 * @queue Pointer to the request queue. Unused other than to obtain
3475 * the driver data structure.
3476 * @bio Pointer to the BIO.
3477 *
Sam Bradshaw88523a62011-08-30 08:34:26 -06003478 */
Jens Axboea71f4832011-11-05 08:36:21 +01003479static void mtip_make_request(struct request_queue *queue, struct bio *bio)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003480{
3481 struct driver_data *dd = queue->queuedata;
3482 struct scatterlist *sg;
3483 struct bio_vec *bvec;
3484 int nents = 0;
3485 int tag = 0;
3486
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02003487 if (unlikely(dd->dd_flag & MTIP_DDF_STOP_IO)) {
3488 if (unlikely(test_bit(MTIP_DDF_REMOVE_PENDING_BIT,
3489 &dd->dd_flag))) {
3490 bio_endio(bio, -ENXIO);
3491 return;
3492 }
3493 if (unlikely(test_bit(MTIP_DDF_OVER_TEMP_BIT, &dd->dd_flag))) {
3494 bio_endio(bio, -ENODATA);
3495 return;
3496 }
3497 if (unlikely(test_bit(MTIP_DDF_WRITE_PROTECT_BIT,
3498 &dd->dd_flag) &&
3499 bio_data_dir(bio))) {
3500 bio_endio(bio, -ENODATA);
3501 return;
3502 }
Asai Thambi S P45038362012-04-09 08:35:38 +02003503 }
3504
Sam Bradshaw88523a62011-08-30 08:34:26 -06003505 if (unlikely(!bio_has_data(bio))) {
3506 blk_queue_flush(queue, 0);
3507 bio_endio(bio, 0);
Jens Axboea71f4832011-11-05 08:36:21 +01003508 return;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003509 }
3510
Sam Bradshaw88523a62011-08-30 08:34:26 -06003511 sg = mtip_hw_get_scatterlist(dd, &tag);
3512 if (likely(sg != NULL)) {
3513 blk_queue_bounce(queue, &bio);
3514
3515 if (unlikely((bio)->bi_vcnt > MTIP_MAX_SG)) {
3516 dev_warn(&dd->pdev->dev,
Asai Thambi S P45038362012-04-09 08:35:38 +02003517 "Maximum number of SGL entries exceeded\n");
Sam Bradshaw88523a62011-08-30 08:34:26 -06003518 bio_io_error(bio);
3519 mtip_hw_release_scatterlist(dd, tag);
Jens Axboea71f4832011-11-05 08:36:21 +01003520 return;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003521 }
3522
3523 /* Create the scatter list for this bio. */
3524 bio_for_each_segment(bvec, bio, nents) {
3525 sg_set_page(&sg[nents],
3526 bvec->bv_page,
3527 bvec->bv_len,
3528 bvec->bv_offset);
3529 }
3530
3531 /* Issue the read/write. */
3532 mtip_hw_submit_io(dd,
3533 bio->bi_sector,
3534 bio_sectors(bio),
3535 nents,
3536 tag,
3537 bio_endio,
3538 bio,
Sam Bradshaw88523a62011-08-30 08:34:26 -06003539 bio_data_dir(bio));
Jens Axboea71f4832011-11-05 08:36:21 +01003540 } else
Sam Bradshaw88523a62011-08-30 08:34:26 -06003541 bio_io_error(bio);
Sam Bradshaw88523a62011-08-30 08:34:26 -06003542}
3543
3544/*
3545 * Block layer initialization function.
3546 *
3547 * This function is called once by the PCI layer for each P320
3548 * device that is connected to the system.
3549 *
3550 * @dd Pointer to the driver data structure.
3551 *
3552 * return value
3553 * 0 on success else an error code.
3554 */
Jens Axboe63166682011-09-27 21:27:43 -06003555static int mtip_block_initialize(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003556{
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003557 int rv = 0, wait_for_rebuild = 0;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003558 sector_t capacity;
3559 unsigned int index = 0;
3560 struct kobject *kobj;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003561 unsigned char thd_name[16];
Sam Bradshaw88523a62011-08-30 08:34:26 -06003562
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003563 if (dd->disk)
3564 goto skip_create_disk; /* hw init done, before rebuild */
3565
Sam Bradshaw88523a62011-08-30 08:34:26 -06003566 /* Initialize the protocol layer. */
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003567 wait_for_rebuild = mtip_hw_init(dd);
3568 if (wait_for_rebuild < 0) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06003569 dev_err(&dd->pdev->dev,
3570 "Protocol layer initialization failed\n");
3571 rv = -EINVAL;
3572 goto protocol_init_error;
3573 }
3574
Sam Bradshaw88523a62011-08-30 08:34:26 -06003575 dd->disk = alloc_disk(MTIP_MAX_MINORS);
3576 if (dd->disk == NULL) {
3577 dev_err(&dd->pdev->dev,
3578 "Unable to allocate gendisk structure\n");
3579 rv = -EINVAL;
3580 goto alloc_disk_error;
3581 }
3582
3583 /* Generate the disk name, implemented same as in sd.c */
3584 do {
3585 if (!ida_pre_get(&rssd_index_ida, GFP_KERNEL))
3586 goto ida_get_error;
3587
3588 spin_lock(&rssd_index_lock);
3589 rv = ida_get_new(&rssd_index_ida, &index);
3590 spin_unlock(&rssd_index_lock);
3591 } while (rv == -EAGAIN);
3592
3593 if (rv)
3594 goto ida_get_error;
3595
3596 rv = rssd_disk_name_format("rssd",
3597 index,
3598 dd->disk->disk_name,
3599 DISK_NAME_LEN);
3600 if (rv)
3601 goto disk_index_error;
3602
3603 dd->disk->driverfs_dev = &dd->pdev->dev;
3604 dd->disk->major = dd->major;
3605 dd->disk->first_minor = dd->instance * MTIP_MAX_MINORS;
3606 dd->disk->fops = &mtip_block_ops;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003607 dd->disk->private_data = dd;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003608 dd->index = index;
3609
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003610 /*
3611 * if rebuild pending, start the service thread, and delay the block
3612 * queue creation and add_disk()
3613 */
3614 if (wait_for_rebuild == MTIP_FTL_REBUILD_MAGIC)
3615 goto start_service_thread;
3616
3617skip_create_disk:
3618 /* Allocate the request queue. */
3619 dd->queue = blk_alloc_queue(GFP_KERNEL);
3620 if (dd->queue == NULL) {
3621 dev_err(&dd->pdev->dev,
3622 "Unable to allocate request queue\n");
3623 rv = -ENOMEM;
3624 goto block_queue_alloc_init_error;
3625 }
3626
3627 /* Attach our request function to the request queue. */
3628 blk_queue_make_request(dd->queue, mtip_make_request);
3629
3630 dd->disk->queue = dd->queue;
3631 dd->queue->queuedata = dd;
3632
3633 /* Set device limits. */
3634 set_bit(QUEUE_FLAG_NONROT, &dd->queue->queue_flags);
3635 blk_queue_max_segments(dd->queue, MTIP_MAX_SG);
3636 blk_queue_physical_block_size(dd->queue, 4096);
3637 blk_queue_io_min(dd->queue, 4096);
Asai Thambi S P4e8670e2012-02-07 07:54:31 +01003638 /*
3639 * write back cache is not supported in the device. FUA depends on
3640 * write back cache support, hence setting flush support to zero.
3641 */
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003642 blk_queue_flush(dd->queue, 0);
3643
Sam Bradshaw88523a62011-08-30 08:34:26 -06003644 /* Set the capacity of the device in 512 byte sectors. */
3645 if (!(mtip_hw_get_capacity(dd, &capacity))) {
3646 dev_warn(&dd->pdev->dev,
3647 "Could not read drive capacity\n");
3648 rv = -EIO;
3649 goto read_capacity_error;
3650 }
3651 set_capacity(dd->disk, capacity);
3652
3653 /* Enable the block device and add it to /dev */
3654 add_disk(dd->disk);
3655
3656 /*
3657 * Now that the disk is active, initialize any sysfs attributes
3658 * managed by the protocol layer.
3659 */
3660 kobj = kobject_get(&disk_to_dev(dd->disk)->kobj);
3661 if (kobj) {
3662 mtip_hw_sysfs_init(dd, kobj);
3663 kobject_put(kobj);
3664 }
3665
Asai Thambi S P45038362012-04-09 08:35:38 +02003666 if (dd->mtip_svc_handler) {
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003667 set_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag);
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003668 return rv; /* service thread created for handling rebuild */
Asai Thambi S P45038362012-04-09 08:35:38 +02003669 }
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003670
3671start_service_thread:
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003672 sprintf(thd_name, "mtip_svc_thd_%02d", index);
3673
3674 dd->mtip_svc_handler = kthread_run(mtip_service_thread,
3675 dd, thd_name);
3676
3677 if (IS_ERR(dd->mtip_svc_handler)) {
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02003678 dev_err(&dd->pdev->dev, "service thread failed to start\n");
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003679 dd->mtip_svc_handler = NULL;
3680 rv = -EFAULT;
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003681 goto kthread_run_error;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003682 }
3683
Asai Thambi S P45038362012-04-09 08:35:38 +02003684 if (wait_for_rebuild == MTIP_FTL_REBUILD_MAGIC)
3685 rv = wait_for_rebuild;
3686
Sam Bradshaw88523a62011-08-30 08:34:26 -06003687 return rv;
3688
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003689kthread_run_error:
3690 /* Delete our gendisk. This also removes the device from /dev */
Sam Bradshaw88523a62011-08-30 08:34:26 -06003691 del_gendisk(dd->disk);
3692
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003693read_capacity_error:
3694 blk_cleanup_queue(dd->queue);
3695
3696block_queue_alloc_init_error:
Sam Bradshaw88523a62011-08-30 08:34:26 -06003697disk_index_error:
3698 spin_lock(&rssd_index_lock);
3699 ida_remove(&rssd_index_ida, index);
3700 spin_unlock(&rssd_index_lock);
3701
3702ida_get_error:
3703 put_disk(dd->disk);
3704
3705alloc_disk_error:
Asai Thambi S P62ee8c12012-01-04 22:01:32 +01003706 mtip_hw_exit(dd); /* De-initialize the protocol layer. */
Sam Bradshaw88523a62011-08-30 08:34:26 -06003707
3708protocol_init_error:
3709 return rv;
3710}
3711
3712/*
3713 * Block layer deinitialization function.
3714 *
3715 * Called by the PCI layer as each P320 device is removed.
3716 *
3717 * @dd Pointer to the driver data structure.
3718 *
3719 * return value
3720 * 0
3721 */
Jens Axboe63166682011-09-27 21:27:43 -06003722static int mtip_block_remove(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003723{
3724 struct kobject *kobj;
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003725
3726 if (dd->mtip_svc_handler) {
Asai Thambi S Pc74b0f52012-04-09 08:35:39 +02003727 set_bit(MTIP_PF_SVC_THD_STOP_BIT, &dd->port->flags);
Asai Thambi S P60ec0ee2011-11-23 08:29:24 +01003728 wake_up_interruptible(&dd->port->svc_wait);
3729 kthread_stop(dd->mtip_svc_handler);
3730 }
3731
Asai Thambi S Pf6587212012-04-09 08:35:38 +02003732 /* Clean up the sysfs attributes, if created */
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003733 if (test_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag)) {
Asai Thambi S P45038362012-04-09 08:35:38 +02003734 kobj = kobject_get(&disk_to_dev(dd->disk)->kobj);
3735 if (kobj) {
3736 mtip_hw_sysfs_exit(dd, kobj);
3737 kobject_put(kobj);
3738 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06003739 }
3740
3741 /*
3742 * Delete our gendisk structure. This also removes the device
3743 * from /dev
3744 */
3745 del_gendisk(dd->disk);
Asai Thambi S P8182b492012-04-09 08:35:38 +02003746
3747 spin_lock(&rssd_index_lock);
3748 ida_remove(&rssd_index_ida, dd->index);
3749 spin_unlock(&rssd_index_lock);
3750
Sam Bradshaw88523a62011-08-30 08:34:26 -06003751 blk_cleanup_queue(dd->queue);
3752 dd->disk = NULL;
3753 dd->queue = NULL;
3754
3755 /* De-initialize the protocol layer. */
3756 mtip_hw_exit(dd);
3757
3758 return 0;
3759}
3760
3761/*
3762 * Function called by the PCI layer when just before the
3763 * machine shuts down.
3764 *
3765 * If a protocol layer shutdown function is present it will be called
3766 * by this function.
3767 *
3768 * @dd Pointer to the driver data structure.
3769 *
3770 * return value
3771 * 0
3772 */
Jens Axboe63166682011-09-27 21:27:43 -06003773static int mtip_block_shutdown(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003774{
3775 dev_info(&dd->pdev->dev,
3776 "Shutting down %s ...\n", dd->disk->disk_name);
3777
3778 /* Delete our gendisk structure, and cleanup the blk queue. */
3779 del_gendisk(dd->disk);
Asai Thambi S P8182b492012-04-09 08:35:38 +02003780
3781 spin_lock(&rssd_index_lock);
3782 ida_remove(&rssd_index_ida, dd->index);
3783 spin_unlock(&rssd_index_lock);
3784
Sam Bradshaw88523a62011-08-30 08:34:26 -06003785 blk_cleanup_queue(dd->queue);
3786 dd->disk = NULL;
3787 dd->queue = NULL;
3788
3789 mtip_hw_shutdown(dd);
3790 return 0;
3791}
3792
Jens Axboe63166682011-09-27 21:27:43 -06003793static int mtip_block_suspend(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003794{
3795 dev_info(&dd->pdev->dev,
3796 "Suspending %s ...\n", dd->disk->disk_name);
3797 mtip_hw_suspend(dd);
3798 return 0;
3799}
3800
Jens Axboe63166682011-09-27 21:27:43 -06003801static int mtip_block_resume(struct driver_data *dd)
Sam Bradshaw88523a62011-08-30 08:34:26 -06003802{
3803 dev_info(&dd->pdev->dev, "Resuming %s ...\n",
3804 dd->disk->disk_name);
3805 mtip_hw_resume(dd);
3806 return 0;
3807}
3808
3809/*
3810 * Called for each supported PCI device detected.
3811 *
3812 * This function allocates the private data structure, enables the
3813 * PCI device and then calls the block layer initialization function.
3814 *
3815 * return value
3816 * 0 on success else an error code.
3817 */
3818static int mtip_pci_probe(struct pci_dev *pdev,
3819 const struct pci_device_id *ent)
3820{
3821 int rv = 0;
3822 struct driver_data *dd = NULL;
3823
3824 /* Allocate memory for this devices private data. */
3825 dd = kzalloc(sizeof(struct driver_data), GFP_KERNEL);
3826 if (dd == NULL) {
3827 dev_err(&pdev->dev,
3828 "Unable to allocate memory for driver data\n");
3829 return -ENOMEM;
3830 }
3831
Sam Bradshaw88523a62011-08-30 08:34:26 -06003832 /* Attach the private data to this PCI device. */
3833 pci_set_drvdata(pdev, dd);
3834
3835 rv = pcim_enable_device(pdev);
3836 if (rv < 0) {
3837 dev_err(&pdev->dev, "Unable to enable device\n");
3838 goto iomap_err;
3839 }
3840
3841 /* Map BAR5 to memory. */
3842 rv = pcim_iomap_regions(pdev, 1 << MTIP_ABAR, MTIP_DRV_NAME);
3843 if (rv < 0) {
3844 dev_err(&pdev->dev, "Unable to map regions\n");
3845 goto iomap_err;
3846 }
3847
3848 if (!pci_set_dma_mask(pdev, DMA_BIT_MASK(64))) {
3849 rv = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
3850
3851 if (rv) {
3852 rv = pci_set_consistent_dma_mask(pdev,
3853 DMA_BIT_MASK(32));
3854 if (rv) {
3855 dev_warn(&pdev->dev,
3856 "64-bit DMA enable failed\n");
3857 goto setmask_err;
3858 }
3859 }
3860 }
3861
3862 pci_set_master(pdev);
3863
3864 if (pci_enable_msi(pdev)) {
3865 dev_warn(&pdev->dev,
3866 "Unable to enable MSI interrupt.\n");
3867 goto block_initialize_err;
3868 }
3869
3870 /* Copy the info we may need later into the private data structure. */
3871 dd->major = mtip_major;
Sam Bradshaw88523a62011-08-30 08:34:26 -06003872 dd->instance = instance;
3873 dd->pdev = pdev;
3874
3875 /* Initialize the block layer. */
3876 rv = mtip_block_initialize(dd);
3877 if (rv < 0) {
3878 dev_err(&pdev->dev,
3879 "Unable to initialize block layer\n");
3880 goto block_initialize_err;
3881 }
3882
3883 /*
3884 * Increment the instance count so that each device has a unique
3885 * instance number.
3886 */
3887 instance++;
Asai Thambi S P45038362012-04-09 08:35:38 +02003888 if (rv != MTIP_FTL_REBUILD_MAGIC)
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003889 set_bit(MTIP_DDF_INIT_DONE_BIT, &dd->dd_flag);
Sam Bradshaw88523a62011-08-30 08:34:26 -06003890 goto done;
3891
3892block_initialize_err:
3893 pci_disable_msi(pdev);
3894
3895setmask_err:
3896 pcim_iounmap_regions(pdev, 1 << MTIP_ABAR);
3897
3898iomap_err:
3899 kfree(dd);
3900 pci_set_drvdata(pdev, NULL);
3901 return rv;
3902done:
Sam Bradshaw88523a62011-08-30 08:34:26 -06003903 return rv;
3904}
3905
3906/*
3907 * Called for each probed device when the device is removed or the
3908 * driver is unloaded.
3909 *
3910 * return value
3911 * None
3912 */
3913static void mtip_pci_remove(struct pci_dev *pdev)
3914{
3915 struct driver_data *dd = pci_get_drvdata(pdev);
3916 int counter = 0;
3917
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003918 set_bit(MTIP_DDF_REMOVE_PENDING_BIT, &dd->dd_flag);
Asai Thambi S P45038362012-04-09 08:35:38 +02003919
Sam Bradshaw88523a62011-08-30 08:34:26 -06003920 if (mtip_check_surprise_removal(pdev)) {
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003921 while (!test_bit(MTIP_DDF_CLEANUP_BIT, &dd->dd_flag)) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06003922 counter++;
3923 msleep(20);
3924 if (counter == 10) {
3925 /* Cleanup the outstanding commands */
3926 mtip_command_cleanup(dd);
3927 break;
3928 }
3929 }
3930 }
Sam Bradshaw88523a62011-08-30 08:34:26 -06003931
3932 /* Clean up the block layer. */
3933 mtip_block_remove(dd);
3934
3935 pci_disable_msi(pdev);
3936
3937 kfree(dd);
3938 pcim_iounmap_regions(pdev, 1 << MTIP_ABAR);
3939}
3940
3941/*
3942 * Called for each probed device when the device is suspended.
3943 *
3944 * return value
3945 * 0 Success
3946 * <0 Error
3947 */
3948static int mtip_pci_suspend(struct pci_dev *pdev, pm_message_t mesg)
3949{
3950 int rv = 0;
3951 struct driver_data *dd = pci_get_drvdata(pdev);
3952
3953 if (!dd) {
3954 dev_err(&pdev->dev,
3955 "Driver private datastructure is NULL\n");
3956 return -EFAULT;
3957 }
3958
Asai Thambi S P8a857a82012-04-09 08:35:38 +02003959 set_bit(MTIP_DDF_RESUME_BIT, &dd->dd_flag);
Sam Bradshaw88523a62011-08-30 08:34:26 -06003960
3961 /* Disable ports & interrupts then send standby immediate */
3962 rv = mtip_block_suspend(dd);
3963 if (rv < 0) {
3964 dev_err(&pdev->dev,
3965 "Failed to suspend controller\n");
3966 return rv;
3967 }
3968
3969 /*
3970 * Save the pci config space to pdev structure &
3971 * disable the device
3972 */
3973 pci_save_state(pdev);
3974 pci_disable_device(pdev);
3975
3976 /* Move to Low power state*/
3977 pci_set_power_state(pdev, PCI_D3hot);
3978
3979 return rv;
3980}
3981
3982/*
3983 * Called for each probed device when the device is resumed.
3984 *
3985 * return value
3986 * 0 Success
3987 * <0 Error
3988 */
3989static int mtip_pci_resume(struct pci_dev *pdev)
3990{
3991 int rv = 0;
3992 struct driver_data *dd;
3993
3994 dd = pci_get_drvdata(pdev);
3995 if (!dd) {
3996 dev_err(&pdev->dev,
3997 "Driver private datastructure is NULL\n");
3998 return -EFAULT;
3999 }
4000
4001 /* Move the device to active State */
4002 pci_set_power_state(pdev, PCI_D0);
4003
4004 /* Restore PCI configuration space */
4005 pci_restore_state(pdev);
4006
4007 /* Enable the PCI device*/
4008 rv = pcim_enable_device(pdev);
4009 if (rv < 0) {
4010 dev_err(&pdev->dev,
4011 "Failed to enable card during resume\n");
4012 goto err;
4013 }
4014 pci_set_master(pdev);
4015
4016 /*
4017 * Calls hbaReset, initPort, & startPort function
4018 * then enables interrupts
4019 */
4020 rv = mtip_block_resume(dd);
4021 if (rv < 0)
4022 dev_err(&pdev->dev, "Unable to resume\n");
4023
4024err:
Asai Thambi S P8a857a82012-04-09 08:35:38 +02004025 clear_bit(MTIP_DDF_RESUME_BIT, &dd->dd_flag);
Sam Bradshaw88523a62011-08-30 08:34:26 -06004026
4027 return rv;
4028}
4029
4030/*
4031 * Shutdown routine
4032 *
4033 * return value
4034 * None
4035 */
4036static void mtip_pci_shutdown(struct pci_dev *pdev)
4037{
4038 struct driver_data *dd = pci_get_drvdata(pdev);
4039 if (dd)
4040 mtip_block_shutdown(dd);
4041}
4042
Sam Bradshaw88523a62011-08-30 08:34:26 -06004043/* Table of device ids supported by this driver. */
4044static DEFINE_PCI_DEVICE_TABLE(mtip_pci_tbl) = {
4045 { PCI_DEVICE(PCI_VENDOR_ID_MICRON, P320_DEVICE_ID) },
4046 { 0 }
4047};
4048
4049/* Structure that describes the PCI driver functions. */
Jens Axboe3ff147d2011-09-27 21:33:53 -06004050static struct pci_driver mtip_pci_driver = {
Sam Bradshaw88523a62011-08-30 08:34:26 -06004051 .name = MTIP_DRV_NAME,
4052 .id_table = mtip_pci_tbl,
4053 .probe = mtip_pci_probe,
4054 .remove = mtip_pci_remove,
4055 .suspend = mtip_pci_suspend,
4056 .resume = mtip_pci_resume,
4057 .shutdown = mtip_pci_shutdown,
4058};
4059
4060MODULE_DEVICE_TABLE(pci, mtip_pci_tbl);
4061
4062/*
4063 * Module initialization function.
4064 *
4065 * Called once when the module is loaded. This function allocates a major
4066 * block device number to the Cyclone devices and registers the PCI layer
4067 * of the driver.
4068 *
4069 * Return value
4070 * 0 on success else error code.
4071 */
4072static int __init mtip_init(void)
4073{
Ryosuke Saito6d27f092012-04-05 08:09:34 -06004074 int error;
4075
Sam Bradshaw88523a62011-08-30 08:34:26 -06004076 printk(KERN_INFO MTIP_DRV_NAME " Version " MTIP_DRV_VERSION "\n");
4077
4078 /* Allocate a major block device number to use with this driver. */
Ryosuke Saito6d27f092012-04-05 08:09:34 -06004079 error = register_blkdev(0, MTIP_DRV_NAME);
4080 if (error <= 0) {
Sam Bradshaw88523a62011-08-30 08:34:26 -06004081 printk(KERN_ERR "Unable to register block device (%d)\n",
Ryosuke Saito6d27f092012-04-05 08:09:34 -06004082 error);
Sam Bradshaw88523a62011-08-30 08:34:26 -06004083 return -EBUSY;
4084 }
Ryosuke Saito6d27f092012-04-05 08:09:34 -06004085 mtip_major = error;
Sam Bradshaw88523a62011-08-30 08:34:26 -06004086
4087 /* Register our PCI operations. */
Ryosuke Saito6d27f092012-04-05 08:09:34 -06004088 error = pci_register_driver(&mtip_pci_driver);
4089 if (error)
4090 unregister_blkdev(mtip_major, MTIP_DRV_NAME);
4091
4092 return error;
Sam Bradshaw88523a62011-08-30 08:34:26 -06004093}
4094
4095/*
4096 * Module de-initialization function.
4097 *
4098 * Called once when the module is unloaded. This function deallocates
4099 * the major block device number allocated by mtip_init() and
4100 * unregisters the PCI layer of the driver.
4101 *
4102 * Return value
4103 * none
4104 */
4105static void __exit mtip_exit(void)
4106{
4107 /* Release the allocated major block device number. */
4108 unregister_blkdev(mtip_major, MTIP_DRV_NAME);
4109
4110 /* Unregister the PCI driver. */
4111 pci_unregister_driver(&mtip_pci_driver);
4112}
4113
4114MODULE_AUTHOR("Micron Technology, Inc");
4115MODULE_DESCRIPTION("Micron RealSSD PCIe Block Driver");
4116MODULE_LICENSE("GPL");
4117MODULE_VERSION(MTIP_DRV_VERSION);
4118
4119module_init(mtip_init);
4120module_exit(mtip_exit);