2 * Copyright (C) 2004 Red Hat
3 * Copyright (C) 2007 Bartlomiej Zolnierkiewicz
5 * May be copied or modified under the terms of the GNU General Public License
6 * Based in part on the ITE vendor provided SCSI driver.
8 * Documentation available from
9 * http://www.ite.com.tw/pc/IT8212F_V04.pdf
10 * Some other documents are NDA.
12 * The ITE8212 isn't exactly a standard IDE controller. It has two
13 * modes. In pass through mode then it is an IDE controller. In its smart
14 * mode its actually quite a capable hardware raid controller disguised
15 * as an IDE controller. Smart mode only understands DMA read/write and
16 * identify, none of the fancier commands apply. The IT8211 is identical
17 * in other respects but lacks the raid mode.
20 * o Rev 0x10 also requires master/slave hold the same DMA timings and
21 * cannot do ATAPI MWDMA.
22 * o The identify data for raid volumes lacks CHS info (technically ok)
23 * but also fails to set the LBA28 and other bits. We fix these in
24 * the IDE probe quirk code.
25 * o If you write LBA48 sized I/O's (ie > 256 sector) in smart mode
26 * raid then the controller firmware dies
27 * o Smart mode without RAID doesn't clear all the necessary identify
28 * bits to reduce the command set to the one used
30 * This has a few impacts on the driver
31 * - In pass through mode we do all the work you would expect
32 * - In smart mode the clocking set up is done by the controller generally
33 * but we must watch the other limits and filter.
34 * - There are a few extra vendor commands that actually talk to the
35 * controller but only work PIO with no IRQ.
37 * Vendor areas of the identify block in smart mode are used for the
38 * timing and policy set up. Each HDD in raid mode also has a serial
39 * block on the disk. The hardware extra commands are get/set chip status,
40 * rebuild, get rebuild status.
42 * In Linux the driver supports pass through mode as if the device was
43 * just another IDE controller. If the smart mode is running then
44 * volumes are managed by the controller firmware and each IDE "disk"
45 * is a raid volume. Even more cute - the controller can do automated
46 * hotplug and rebuild.
48 * The pass through controller itself is a little demented. It has a
49 * flaw that it has a single set of PIO/MWDMA timings per channel so
50 * non UDMA devices restrict each others performance. It also has a
51 * single clock source per channel so mixed UDMA100/133 performance
52 * isn't perfect and we have to pick a clock. Thankfully none of this
53 * matters in smart mode. ATAPI DMA is not currently supported.
55 * It seems the smart mode is a win for RAID1/RAID10 but otherwise not.
58 * - ATAPI UDMA is ok but not MWDMA it seems
59 * - RAID configuration ioctls
60 * - Move to libata once it grows up
63 #include <linux/types.h>
64 #include <linux/module.h>
65 #include <linux/pci.h>
66 #include <linux/ide.h>
67 #include <linux/init.h>
69 #define DRV_NAME "it821x"
71 #define QUIRK_VORTEX86 1
75 unsigned int smart:1, /* Are we in smart raid mode */
76 timing10:1; /* Rev 0x10 */
77 u8 clock_mode; /* 0, ATA_50 or ATA_66 */
78 u8 want[2][2]; /* Mode/Pri log for master slave */
79 /* We need these for switching the clock when DMA goes on/off
80 The high byte is the 66Mhz timing */
81 u16 pio[2]; /* Cached PIO values */
82 u16 mwdma[2]; /* Cached MWDMA values */
83 u16 udma[2]; /* Cached UDMA values (per drive) */
95 * We allow users to force the card into non raid mode without
96 * flashing the alternative BIOS. This is also necessary right now
97 * for embedded platforms that cannot run a PC BIOS but are using this
101 static int it8212_noraid;
104 * it821x_program - program the PIO/MWDMA registers
105 * @drive: drive to tune
106 * @timing: timing info
108 * Program the PIO/MWDMA timing for this channel according to the
112 static void it821x_program(ide_drive_t *drive, u16 timing)
114 ide_hwif_t *hwif = drive->hwif;
115 struct pci_dev *dev = to_pci_dev(hwif->dev);
116 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
117 int channel = hwif->channel;
120 /* Program PIO/MWDMA timing bits */
121 if(itdev->clock_mode == ATA_66)
124 conf = timing & 0xFF;
126 pci_write_config_byte(dev, 0x54 + 4 * channel, conf);
130 * it821x_program_udma - program the UDMA registers
131 * @drive: drive to tune
132 * @timing: timing info
134 * Program the UDMA timing for this drive according to the
138 static void it821x_program_udma(ide_drive_t *drive, u16 timing)
140 ide_hwif_t *hwif = drive->hwif;
141 struct pci_dev *dev = to_pci_dev(hwif->dev);
142 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
143 int channel = hwif->channel;
144 u8 unit = drive->dn & 1, conf;
146 /* Program UDMA timing bits */
147 if(itdev->clock_mode == ATA_66)
150 conf = timing & 0xFF;
152 if (itdev->timing10 == 0)
153 pci_write_config_byte(dev, 0x56 + 4 * channel + unit, conf);
155 pci_write_config_byte(dev, 0x56 + 4 * channel, conf);
156 pci_write_config_byte(dev, 0x56 + 4 * channel + 1, conf);
161 * it821x_clock_strategy
162 * @drive: drive to set up
164 * Select between the 50 and 66Mhz base clocks to get the best
165 * results for this interface.
168 static void it821x_clock_strategy(ide_drive_t *drive)
170 ide_hwif_t *hwif = drive->hwif;
171 struct pci_dev *dev = to_pci_dev(hwif->dev);
172 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
173 ide_drive_t *pair = ide_get_pair_dev(drive);
174 int clock, altclock, sel = 0;
175 u8 unit = drive->dn & 1, v;
177 if(itdev->want[0][0] > itdev->want[1][0]) {
178 clock = itdev->want[0][1];
179 altclock = itdev->want[1][1];
181 clock = itdev->want[1][1];
182 altclock = itdev->want[0][1];
186 * if both clocks can be used for the mode with the higher priority
187 * use the clock needed by the mode with the lower priority
189 if (clock == ATA_ANY)
192 /* Nobody cares - keep the same clock */
196 if(clock == itdev->clock_mode)
199 /* Load this into the controller ? */
201 itdev->clock_mode = ATA_66;
203 itdev->clock_mode = ATA_50;
207 pci_read_config_byte(dev, 0x50, &v);
208 v &= ~(1 << (1 + hwif->channel));
209 v |= sel << (1 + hwif->channel);
210 pci_write_config_byte(dev, 0x50, v);
213 * Reprogram the UDMA/PIO of the pair drive for the switch
214 * MWDMA will be dealt with by the dma switcher
216 if(pair && itdev->udma[1-unit] != UDMA_OFF) {
217 it821x_program_udma(pair, itdev->udma[1-unit]);
218 it821x_program(pair, itdev->pio[1-unit]);
221 * Reprogram the UDMA/PIO of our drive for the switch.
222 * MWDMA will be dealt with by the dma switcher
224 if(itdev->udma[unit] != UDMA_OFF) {
225 it821x_program_udma(drive, itdev->udma[unit]);
226 it821x_program(drive, itdev->pio[unit]);
231 * it821x_set_pio_mode - set host controller for PIO mode
233 * @pio: PIO mode number
235 * Tune the host to the desired PIO mode taking into the consideration
236 * the maximum PIO mode supported by the other device on the cable.
239 static void it821x_set_pio_mode(ide_drive_t *drive, const u8 pio)
241 ide_hwif_t *hwif = drive->hwif;
242 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
243 ide_drive_t *pair = ide_get_pair_dev(drive);
244 u8 unit = drive->dn & 1, set_pio = pio;
246 /* Spec says 89 ref driver uses 88 */
247 static u16 pio_timings[]= { 0xAA88, 0xA382, 0xA181, 0x3332, 0x3121 };
248 static u8 pio_want[] = { ATA_66, ATA_66, ATA_66, ATA_66, ATA_ANY };
251 * Compute the best PIO mode we can for a given device. We must
252 * pick a speed that does not cause problems with the other device
256 u8 pair_pio = ide_get_best_pio_mode(pair, 255, 4);
257 /* trim PIO to the slowest of the master/slave */
258 if (pair_pio < set_pio)
262 /* We prefer 66Mhz clock for PIO 0-3, don't care for PIO4 */
263 itdev->want[unit][1] = pio_want[set_pio];
264 itdev->want[unit][0] = 1; /* PIO is lowest priority */
265 itdev->pio[unit] = pio_timings[set_pio];
266 it821x_clock_strategy(drive);
267 it821x_program(drive, itdev->pio[unit]);
271 * it821x_tune_mwdma - tune a channel for MWDMA
272 * @drive: drive to set up
273 * @mode_wanted: the target operating mode
275 * Load the timing settings for this device mode into the
276 * controller when doing MWDMA in pass through mode. The caller
277 * must manage the whole lack of per device MWDMA/PIO timings and
278 * the shared MWDMA/PIO timing register.
281 static void it821x_tune_mwdma(ide_drive_t *drive, u8 mode_wanted)
283 ide_hwif_t *hwif = drive->hwif;
284 struct pci_dev *dev = to_pci_dev(hwif->dev);
285 struct it821x_dev *itdev = (void *)ide_get_hwifdata(hwif);
286 u8 unit = drive->dn & 1, channel = hwif->channel, conf;
288 static u16 dma[] = { 0x8866, 0x3222, 0x3121 };
289 static u8 mwdma_want[] = { ATA_ANY, ATA_66, ATA_ANY };
291 itdev->want[unit][1] = mwdma_want[mode_wanted];
292 itdev->want[unit][0] = 2; /* MWDMA is low priority */
293 itdev->mwdma[unit] = dma[mode_wanted];
294 itdev->udma[unit] = UDMA_OFF;
296 /* UDMA bits off - Revision 0x10 do them in pairs */
297 pci_read_config_byte(dev, 0x50, &conf);
299 conf |= channel ? 0x60: 0x18;
301 conf |= 1 << (3 + 2 * channel + unit);
302 pci_write_config_byte(dev, 0x50, conf);
304 it821x_clock_strategy(drive);
305 /* FIXME: do we need to program this ? */
306 /* it821x_program(drive, itdev->mwdma[unit]); */
310 * it821x_tune_udma - tune a channel for UDMA
311 * @drive: drive to set up
312 * @mode_wanted: the target operating mode
314 * Load the timing settings for this device mode into the
315 * controller when doing UDMA modes in pass through.
318 static void it821x_tune_udma(ide_drive_t *drive, u8 mode_wanted)
320 ide_hwif_t *hwif = drive->hwif;
321 struct pci_dev *dev = to_pci_dev(hwif->dev);
322 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
323 u8 unit = drive->dn & 1, channel = hwif->channel, conf;
325 static u16 udma[] = { 0x4433, 0x4231, 0x3121, 0x2121, 0x1111, 0x2211, 0x1111 };
326 static u8 udma_want[] = { ATA_ANY, ATA_50, ATA_ANY, ATA_66, ATA_66, ATA_50, ATA_66 };
328 itdev->want[unit][1] = udma_want[mode_wanted];
329 itdev->want[unit][0] = 3; /* UDMA is high priority */
330 itdev->mwdma[unit] = MWDMA_OFF;
331 itdev->udma[unit] = udma[mode_wanted];
333 itdev->udma[unit] |= 0x8080; /* UDMA 5/6 select on */
335 /* UDMA on. Again revision 0x10 must do the pair */
336 pci_read_config_byte(dev, 0x50, &conf);
338 conf &= channel ? 0x9F: 0xE7;
340 conf &= ~ (1 << (3 + 2 * channel + unit));
341 pci_write_config_byte(dev, 0x50, conf);
343 it821x_clock_strategy(drive);
344 it821x_program_udma(drive, itdev->udma[unit]);
349 * it821x_dma_read - DMA hook
350 * @drive: drive for DMA
352 * The IT821x has a single timing register for MWDMA and for PIO
353 * operations. As we flip back and forth we have to reload the
354 * clock. In addition the rev 0x10 device only works if the same
355 * timing value is loaded into the master and slave UDMA clock
356 * so we must also reload that.
358 * FIXME: we could figure out in advance if we need to do reloads
361 static void it821x_dma_start(ide_drive_t *drive)
363 ide_hwif_t *hwif = drive->hwif;
364 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
365 u8 unit = drive->dn & 1;
367 if(itdev->mwdma[unit] != MWDMA_OFF)
368 it821x_program(drive, itdev->mwdma[unit]);
369 else if(itdev->udma[unit] != UDMA_OFF && itdev->timing10)
370 it821x_program_udma(drive, itdev->udma[unit]);
371 ide_dma_start(drive);
375 * it821x_dma_write - DMA hook
376 * @drive: drive for DMA stop
378 * The IT821x has a single timing register for MWDMA and for PIO
379 * operations. As we flip back and forth we have to reload the
383 static int it821x_dma_end(ide_drive_t *drive)
385 ide_hwif_t *hwif = drive->hwif;
386 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
387 int ret = ide_dma_end(drive);
388 u8 unit = drive->dn & 1;
390 if(itdev->mwdma[unit] != MWDMA_OFF)
391 it821x_program(drive, itdev->pio[unit]);
396 * it821x_set_dma_mode - set host controller for DMA mode
400 * Tune the ITE chipset for the desired DMA mode.
403 static void it821x_set_dma_mode(ide_drive_t *drive, const u8 speed)
406 * MWDMA tuning is really hard because our MWDMA and PIO
407 * timings are kept in the same place. We can switch in the
408 * host dma on/off callbacks.
410 if (speed >= XFER_UDMA_0 && speed <= XFER_UDMA_6)
411 it821x_tune_udma(drive, speed - XFER_UDMA_0);
412 else if (speed >= XFER_MW_DMA_0 && speed <= XFER_MW_DMA_2)
413 it821x_tune_mwdma(drive, speed - XFER_MW_DMA_0);
417 * it821x_cable_detect - cable detection
418 * @hwif: interface to check
420 * Check for the presence of an ATA66 capable cable on the
421 * interface. Problematic as it seems some cards don't have
422 * the needed logic onboard.
425 static u8 it821x_cable_detect(ide_hwif_t *hwif)
427 /* The reference driver also only does disk side */
428 return ATA_CBL_PATA80;
432 * it821x_quirkproc - post init callback
435 * This callback is run after the drive has been probed but
436 * before anything gets attached. It allows drivers to do any
437 * final tuning that is needed, or fixups to work around bugs.
440 static void it821x_quirkproc(ide_drive_t *drive)
442 struct it821x_dev *itdev = ide_get_hwifdata(drive->hwif);
447 * If we are in pass through mode then not much
448 * needs to be done, but we do bother to clear the
449 * IRQ mask as we may well be in PIO (eg rev 0x10)
450 * for now and we know unmasking is safe on this chipset.
452 drive->dev_flags |= IDE_DFLAG_UNMASK;
455 * Perform fixups on smart mode. We need to "lose" some
456 * capabilities the firmware lacks but does not filter, and
457 * also patch up some capability bits that it forgets to set
461 /* Check for RAID v native */
462 if (strstr((char *)&id[ATA_ID_PROD],
463 "Integrated Technology Express")) {
464 /* In raid mode the ident block is slightly buggy
465 We need to set the bits so that the IDE layer knows
466 LBA28. LBA48 and DMA ar valid */
467 id[ATA_ID_CAPABILITY] |= (3 << 8); /* LBA28, DMA */
468 id[ATA_ID_COMMAND_SET_2] |= 0x0400; /* LBA48 valid */
469 id[ATA_ID_CFS_ENABLE_2] |= 0x0400; /* LBA48 on */
470 /* Reporting logic */
471 printk(KERN_INFO "%s: IT8212 %sRAID %d volume",
472 drive->name, id[147] ? "Bootable " : "",
474 if (id[ATA_ID_CSFO] != 1)
475 printk(KERN_CONT "(%dK stripe)", id[146]);
476 printk(KERN_CONT ".\n");
478 /* Non RAID volume. Fixups to stop the core code
479 doing unsupported things */
480 id[ATA_ID_FIELD_VALID] &= 3;
481 id[ATA_ID_QUEUE_DEPTH] = 0;
482 id[ATA_ID_COMMAND_SET_1] = 0;
483 id[ATA_ID_COMMAND_SET_2] &= 0xC400;
484 id[ATA_ID_CFSSE] &= 0xC000;
485 id[ATA_ID_CFS_ENABLE_1] = 0;
486 id[ATA_ID_CFS_ENABLE_2] &= 0xC400;
487 id[ATA_ID_CSF_DEFAULT] &= 0xC000;
491 id[ATA_ID_CFA_POWER] = 0;
492 printk(KERN_INFO "%s: Performing identify fixups.\n",
497 * Set MWDMA0 mode as enabled/support - just to tell
498 * IDE core that DMA is supported (it821x hardware
499 * takes care of DMA mode programming).
501 if (ata_id_has_dma(id)) {
502 id[ATA_ID_MWDMA_MODES] |= 0x0101;
503 drive->current_speed = XFER_MW_DMA_0;
509 static struct ide_dma_ops it821x_pass_through_dma_ops = {
510 .dma_host_set = ide_dma_host_set,
511 .dma_setup = ide_dma_setup,
512 .dma_exec_cmd = ide_dma_exec_cmd,
513 .dma_start = it821x_dma_start,
514 .dma_end = it821x_dma_end,
515 .dma_test_irq = ide_dma_test_irq,
516 .dma_timeout = ide_dma_timeout,
517 .dma_lost_irq = ide_dma_lost_irq,
518 .dma_sff_read_status = ide_dma_sff_read_status,
522 * init_hwif_it821x - set up hwif structs
523 * @hwif: interface to set up
525 * We do the basic set up of the interface structure. The IT8212
526 * requires several custom handlers so we override the default
527 * ide DMA handlers appropriately
530 static void __devinit init_hwif_it821x(ide_hwif_t *hwif)
532 struct pci_dev *dev = to_pci_dev(hwif->dev);
533 struct ide_host *host = pci_get_drvdata(dev);
534 struct it821x_dev *itdevs = host->host_priv;
535 struct it821x_dev *idev = itdevs + hwif->channel;
538 ide_set_hwifdata(hwif, idev);
540 pci_read_config_byte(dev, 0x50, &conf);
543 hwif->host_flags |= IDE_HFLAG_NO_ATAPI_DMA;
544 /* Long I/O's although allowed in LBA48 space cause the
545 onboard firmware to enter the twighlight zone */
549 /* Pull the current clocks from 0x50 also */
550 if (conf & (1 << (1 + hwif->channel)))
551 idev->clock_mode = ATA_50;
553 idev->clock_mode = ATA_66;
555 idev->want[0][1] = ATA_ANY;
556 idev->want[1][1] = ATA_ANY;
559 * Not in the docs but according to the reference driver
563 if (dev->revision == 0x10) {
565 hwif->host_flags |= IDE_HFLAG_NO_ATAPI_DMA;
566 if (idev->smart == 0)
567 printk(KERN_WARNING DRV_NAME " %s: revision 0x10, "
568 "workarounds activated\n", pci_name(dev));
571 if (idev->smart == 0) {
572 /* MWDMA/PIO clock switching for pass through mode */
573 hwif->dma_ops = &it821x_pass_through_dma_ops;
575 hwif->host_flags |= IDE_HFLAG_NO_SET_MODE;
577 if (hwif->dma_base == 0)
580 hwif->ultra_mask = ATA_UDMA6;
581 hwif->mwdma_mask = ATA_MWDMA2;
583 /* Vortex86SX quirk: prevent Ultra-DMA mode to fix BadCRC issue */
584 if (idev->quirks & QUIRK_VORTEX86) {
585 if (dev->revision == 0x11)
586 hwif->ultra_mask = 0;
590 static void it8212_disable_raid(struct pci_dev *dev)
592 /* Reset local CPU, and set BIOS not ready */
593 pci_write_config_byte(dev, 0x5E, 0x01);
595 /* Set to bypass mode, and reset PCI bus */
596 pci_write_config_byte(dev, 0x50, 0x00);
597 pci_write_config_word(dev, PCI_COMMAND,
598 PCI_COMMAND_PARITY | PCI_COMMAND_IO |
599 PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER);
600 pci_write_config_word(dev, 0x40, 0xA0F3);
602 pci_write_config_dword(dev,0x4C, 0x02040204);
603 pci_write_config_byte(dev, 0x42, 0x36);
604 pci_write_config_byte(dev, PCI_LATENCY_TIMER, 0x20);
607 static unsigned int init_chipset_it821x(struct pci_dev *dev)
610 static char *mode[2] = { "pass through", "smart" };
612 /* Force the card into bypass mode if so requested */
614 printk(KERN_INFO DRV_NAME " %s: forcing bypass mode\n",
616 it8212_disable_raid(dev);
618 pci_read_config_byte(dev, 0x50, &conf);
619 printk(KERN_INFO DRV_NAME " %s: controller in %s mode\n",
620 pci_name(dev), mode[conf & 1]);
624 static const struct ide_port_ops it821x_port_ops = {
625 /* it821x_set_{pio,dma}_mode() are only used in pass-through mode */
626 .set_pio_mode = it821x_set_pio_mode,
627 .set_dma_mode = it821x_set_dma_mode,
628 .quirkproc = it821x_quirkproc,
629 .cable_detect = it821x_cable_detect,
632 static const struct ide_port_info it821x_chipset __devinitdata = {
634 .init_chipset = init_chipset_it821x,
635 .init_hwif = init_hwif_it821x,
636 .port_ops = &it821x_port_ops,
637 .pio_mask = ATA_PIO4,
641 * it821x_init_one - pci layer discovery entry
643 * @id: ident table entry
645 * Called by the PCI code when it finds an ITE821x controller.
646 * We then use the IDE PCI generic helper to do most of the work.
649 static int __devinit it821x_init_one(struct pci_dev *dev, const struct pci_device_id *id)
651 struct it821x_dev *itdevs;
654 itdevs = kzalloc(2 * sizeof(*itdevs), GFP_KERNEL);
655 if (itdevs == NULL) {
656 printk(KERN_ERR DRV_NAME " %s: out of memory\n", pci_name(dev));
660 itdevs->quirks = id->driver_data;
662 rc = ide_pci_init_one(dev, &it821x_chipset, itdevs);
669 static void __devexit it821x_remove(struct pci_dev *dev)
671 struct ide_host *host = pci_get_drvdata(dev);
672 struct it821x_dev *itdevs = host->host_priv;
678 static const struct pci_device_id it821x_pci_tbl[] = {
679 { PCI_VDEVICE(ITE, PCI_DEVICE_ID_ITE_8211), 0 },
680 { PCI_VDEVICE(ITE, PCI_DEVICE_ID_ITE_8212), 0 },
681 { PCI_VDEVICE(RDC, PCI_DEVICE_ID_RDC_D1010), QUIRK_VORTEX86 },
685 MODULE_DEVICE_TABLE(pci, it821x_pci_tbl);
687 static struct pci_driver it821x_pci_driver = {
688 .name = "ITE821x IDE",
689 .id_table = it821x_pci_tbl,
690 .probe = it821x_init_one,
691 .remove = __devexit_p(it821x_remove),
692 .suspend = ide_pci_suspend,
693 .resume = ide_pci_resume,
696 static int __init it821x_ide_init(void)
698 return ide_pci_register_driver(&it821x_pci_driver);
701 static void __exit it821x_ide_exit(void)
703 pci_unregister_driver(&it821x_pci_driver);
706 module_init(it821x_ide_init);
707 module_exit(it821x_ide_exit);
709 module_param_named(noraid, it8212_noraid, int, S_IRUGO);
710 MODULE_PARM_DESC(noraid, "Force card into bypass mode");
712 MODULE_AUTHOR("Alan Cox");
713 MODULE_DESCRIPTION("PCI driver module for the ITE 821x");
714 MODULE_LICENSE("GPL");