3 * linux/drivers/ide/pci/it821x.c Version 0.10 Mar 10 2007
5 * Copyright (C) 2004 Red Hat <alan@redhat.com>
6 * Copyright (C) 2007 Bartlomiej Zolnierkiewicz
8 * May be copied or modified under the terms of the GNU General Public License
9 * Based in part on the ITE vendor provided SCSI driver.
11 * Documentation available from
12 * http://www.ite.com.tw/pc/IT8212F_V04.pdf
13 * Some other documents are NDA.
15 * The ITE8212 isn't exactly a standard IDE controller. It has two
16 * modes. In pass through mode then it is an IDE controller. In its smart
17 * mode its actually quite a capable hardware raid controller disguised
18 * as an IDE controller. Smart mode only understands DMA read/write and
19 * identify, none of the fancier commands apply. The IT8211 is identical
20 * in other respects but lacks the raid mode.
23 * o Rev 0x10 also requires master/slave hold the same DMA timings and
24 * cannot do ATAPI MWDMA.
25 * o The identify data for raid volumes lacks CHS info (technically ok)
26 * but also fails to set the LBA28 and other bits. We fix these in
27 * the IDE probe quirk code.
28 * o If you write LBA48 sized I/O's (ie > 256 sector) in smart mode
29 * raid then the controller firmware dies
30 * o Smart mode without RAID doesn't clear all the necessary identify
31 * bits to reduce the command set to the one used
33 * This has a few impacts on the driver
34 * - In pass through mode we do all the work you would expect
35 * - In smart mode the clocking set up is done by the controller generally
36 * but we must watch the other limits and filter.
37 * - There are a few extra vendor commands that actually talk to the
38 * controller but only work PIO with no IRQ.
40 * Vendor areas of the identify block in smart mode are used for the
41 * timing and policy set up. Each HDD in raid mode also has a serial
42 * block on the disk. The hardware extra commands are get/set chip status,
43 * rebuild, get rebuild status.
45 * In Linux the driver supports pass through mode as if the device was
46 * just another IDE controller. If the smart mode is running then
47 * volumes are managed by the controller firmware and each IDE "disk"
48 * is a raid volume. Even more cute - the controller can do automated
49 * hotplug and rebuild.
51 * The pass through controller itself is a little demented. It has a
52 * flaw that it has a single set of PIO/MWDMA timings per channel so
53 * non UDMA devices restrict each others performance. It also has a
54 * single clock source per channel so mixed UDMA100/133 performance
55 * isn't perfect and we have to pick a clock. Thankfully none of this
56 * matters in smart mode. ATAPI DMA is not currently supported.
58 * It seems the smart mode is a win for RAID1/RAID10 but otherwise not.
61 * - ATAPI UDMA is ok but not MWDMA it seems
62 * - RAID configuration ioctls
63 * - Move to libata once it grows up
66 #include <linux/types.h>
67 #include <linux/module.h>
68 #include <linux/pci.h>
69 #include <linux/delay.h>
70 #include <linux/hdreg.h>
71 #include <linux/ide.h>
72 #include <linux/init.h>
78 unsigned int smart:1, /* Are we in smart raid mode */
79 timing10:1; /* Rev 0x10 */
80 u8 clock_mode; /* 0, ATA_50 or ATA_66 */
81 u8 want[2][2]; /* Mode/Pri log for master slave */
82 /* We need these for switching the clock when DMA goes on/off
83 The high byte is the 66Mhz timing */
84 u16 pio[2]; /* Cached PIO values */
85 u16 mwdma[2]; /* Cached MWDMA values */
86 u16 udma[2]; /* Cached UDMA values (per drive) */
97 * We allow users to force the card into non raid mode without
98 * flashing the alternative BIOS. This is also neccessary right now
99 * for embedded platforms that cannot run a PC BIOS but are using this
103 static int it8212_noraid;
106 * it821x_program - program the PIO/MWDMA registers
107 * @drive: drive to tune
108 * @timing: timing info
110 * Program the PIO/MWDMA timing for this channel according to the
114 static void it821x_program(ide_drive_t *drive, u16 timing)
116 ide_hwif_t *hwif = drive->hwif;
117 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
118 int channel = hwif->channel;
121 /* Program PIO/MWDMA timing bits */
122 if(itdev->clock_mode == ATA_66)
125 conf = timing & 0xFF;
126 pci_write_config_byte(hwif->pci_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 it821x_dev *itdev = ide_get_hwifdata(hwif);
142 int channel = hwif->channel;
143 int unit = drive->select.b.unit;
146 /* Program UDMA timing bits */
147 if(itdev->clock_mode == ATA_66)
150 conf = timing & 0xFF;
151 if(itdev->timing10 == 0)
152 pci_write_config_byte(hwif->pci_dev, 0x56 + 4 * channel + unit, conf);
154 pci_write_config_byte(hwif->pci_dev, 0x56 + 4 * channel, conf);
155 pci_write_config_byte(hwif->pci_dev, 0x56 + 4 * channel + 1, conf);
160 * it821x_clock_strategy
161 * @drive: drive to set up
163 * Select between the 50 and 66Mhz base clocks to get the best
164 * results for this interface.
167 static void it821x_clock_strategy(ide_drive_t *drive)
169 ide_hwif_t *hwif = drive->hwif;
170 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
172 u8 unit = drive->select.b.unit;
173 ide_drive_t *pair = &hwif->drives[1-unit];
179 if(itdev->want[0][0] > itdev->want[1][0]) {
180 clock = itdev->want[0][1];
181 altclock = itdev->want[1][1];
183 clock = itdev->want[1][1];
184 altclock = itdev->want[0][1];
188 * if both clocks can be used for the mode with the higher priority
189 * use the clock needed by the mode with the lower priority
191 if (clock == ATA_ANY)
194 /* Nobody cares - keep the same clock */
198 if(clock == itdev->clock_mode)
201 /* Load this into the controller ? */
203 itdev->clock_mode = ATA_66;
205 itdev->clock_mode = ATA_50;
208 pci_read_config_byte(hwif->pci_dev, 0x50, &v);
209 v &= ~(1 << (1 + hwif->channel));
210 v |= sel << (1 + hwif->channel);
211 pci_write_config_byte(hwif->pci_dev, 0x50, v);
214 * Reprogram the UDMA/PIO of the pair drive for the switch
215 * MWDMA will be dealt with by the dma switcher
217 if(pair && itdev->udma[1-unit] != UDMA_OFF) {
218 it821x_program_udma(pair, itdev->udma[1-unit]);
219 it821x_program(pair, itdev->pio[1-unit]);
222 * Reprogram the UDMA/PIO of our drive for the switch.
223 * MWDMA will be dealt with by the dma switcher
225 if(itdev->udma[unit] != UDMA_OFF) {
226 it821x_program_udma(drive, itdev->udma[unit]);
227 it821x_program(drive, itdev->pio[unit]);
232 * it821x_ratemask - Compute available modes
235 * Compute the available speeds for the devices on the interface. This
236 * is all modes to ATA133 clipped by drive cable setup.
239 static u8 it821x_ratemask (ide_drive_t *drive)
242 if (!eighty_ninty_three(drive))
243 mode = min(mode, (u8)1);
248 * it821x_tunepio - tune a drive
249 * @drive: drive to tune
250 * @pio: the desired PIO mode
252 * Try to tune the drive/host to the desired PIO mode taking into
253 * the consideration the maximum PIO mode supported by the other
254 * device on the cable.
257 static int it821x_tunepio(ide_drive_t *drive, u8 set_pio)
259 ide_hwif_t *hwif = drive->hwif;
260 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
261 int unit = drive->select.b.unit;
262 ide_drive_t *pair = &hwif->drives[1 - unit];
264 /* Spec says 89 ref driver uses 88 */
265 static u16 pio[] = { 0xAA88, 0xA382, 0xA181, 0x3332, 0x3121 };
266 static u8 pio_want[] = { ATA_66, ATA_66, ATA_66, ATA_66, ATA_ANY };
269 * Compute the best PIO mode we can for a given device. We must
270 * pick a speed that does not cause problems with the other device
274 u8 pair_pio = ide_get_best_pio_mode(pair, 255, 4, NULL);
275 /* trim PIO to the slowest of the master/slave */
276 if (pair_pio < set_pio)
281 goto set_drive_speed;
283 /* We prefer 66Mhz clock for PIO 0-3, don't care for PIO4 */
284 itdev->want[unit][1] = pio_want[set_pio];
285 itdev->want[unit][0] = 1; /* PIO is lowest priority */
286 itdev->pio[unit] = pio[set_pio];
287 it821x_clock_strategy(drive);
288 it821x_program(drive, itdev->pio[unit]);
291 return ide_config_drive_speed(drive, XFER_PIO_0 + set_pio);
294 static void it821x_tuneproc(ide_drive_t *drive, u8 pio)
296 pio = ide_get_best_pio_mode(drive, pio, 4, NULL);
297 (void)it821x_tunepio(drive, pio);
301 * it821x_tune_mwdma - tune a channel for MWDMA
302 * @drive: drive to set up
303 * @mode_wanted: the target operating mode
305 * Load the timing settings for this device mode into the
306 * controller when doing MWDMA in pass through mode. The caller
307 * must manage the whole lack of per device MWDMA/PIO timings and
308 * the shared MWDMA/PIO timing register.
311 static void it821x_tune_mwdma (ide_drive_t *drive, byte mode_wanted)
313 ide_hwif_t *hwif = drive->hwif;
314 struct it821x_dev *itdev = (void *)ide_get_hwifdata(hwif);
315 int unit = drive->select.b.unit;
316 int channel = hwif->channel;
319 static u16 dma[] = { 0x8866, 0x3222, 0x3121 };
320 static u8 mwdma_want[] = { ATA_ANY, ATA_66, ATA_ANY };
322 itdev->want[unit][1] = mwdma_want[mode_wanted];
323 itdev->want[unit][0] = 2; /* MWDMA is low priority */
324 itdev->mwdma[unit] = dma[mode_wanted];
325 itdev->udma[unit] = UDMA_OFF;
327 /* UDMA bits off - Revision 0x10 do them in pairs */
328 pci_read_config_byte(hwif->pci_dev, 0x50, &conf);
330 conf |= channel ? 0x60: 0x18;
332 conf |= 1 << (3 + 2 * channel + unit);
333 pci_write_config_byte(hwif->pci_dev, 0x50, conf);
335 it821x_clock_strategy(drive);
336 /* FIXME: do we need to program this ? */
337 /* it821x_program(drive, itdev->mwdma[unit]); */
341 * it821x_tune_udma - tune a channel for UDMA
342 * @drive: drive to set up
343 * @mode_wanted: the target operating mode
345 * Load the timing settings for this device mode into the
346 * controller when doing UDMA modes in pass through.
349 static void it821x_tune_udma (ide_drive_t *drive, byte mode_wanted)
351 ide_hwif_t *hwif = drive->hwif;
352 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
353 int unit = drive->select.b.unit;
354 int channel = hwif->channel;
357 static u16 udma[] = { 0x4433, 0x4231, 0x3121, 0x2121, 0x1111, 0x2211, 0x1111 };
358 static u8 udma_want[] = { ATA_ANY, ATA_50, ATA_ANY, ATA_66, ATA_66, ATA_50, ATA_66 };
360 itdev->want[unit][1] = udma_want[mode_wanted];
361 itdev->want[unit][0] = 3; /* UDMA is high priority */
362 itdev->mwdma[unit] = MWDMA_OFF;
363 itdev->udma[unit] = udma[mode_wanted];
365 itdev->udma[unit] |= 0x8080; /* UDMA 5/6 select on */
367 /* UDMA on. Again revision 0x10 must do the pair */
368 pci_read_config_byte(hwif->pci_dev, 0x50, &conf);
370 conf &= channel ? 0x9F: 0xE7;
372 conf &= ~ (1 << (3 + 2 * channel + unit));
373 pci_write_config_byte(hwif->pci_dev, 0x50, conf);
375 it821x_clock_strategy(drive);
376 it821x_program_udma(drive, itdev->udma[unit]);
381 * it821x_dma_read - DMA hook
382 * @drive: drive for DMA
384 * The IT821x has a single timing register for MWDMA and for PIO
385 * operations. As we flip back and forth we have to reload the
386 * clock. In addition the rev 0x10 device only works if the same
387 * timing value is loaded into the master and slave UDMA clock
388 * so we must also reload that.
390 * FIXME: we could figure out in advance if we need to do reloads
393 static void it821x_dma_start(ide_drive_t *drive)
395 ide_hwif_t *hwif = drive->hwif;
396 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
397 int unit = drive->select.b.unit;
398 if(itdev->mwdma[unit] != MWDMA_OFF)
399 it821x_program(drive, itdev->mwdma[unit]);
400 else if(itdev->udma[unit] != UDMA_OFF && itdev->timing10)
401 it821x_program_udma(drive, itdev->udma[unit]);
402 ide_dma_start(drive);
406 * it821x_dma_write - DMA hook
407 * @drive: drive for DMA stop
409 * The IT821x has a single timing register for MWDMA and for PIO
410 * operations. As we flip back and forth we have to reload the
414 static int it821x_dma_end(ide_drive_t *drive)
416 ide_hwif_t *hwif = drive->hwif;
417 int unit = drive->select.b.unit;
418 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
419 int ret = __ide_dma_end(drive);
420 if(itdev->mwdma[unit] != MWDMA_OFF)
421 it821x_program(drive, itdev->pio[unit]);
427 * it821x_tune_chipset - set controller timings
428 * @drive: Drive to set up
429 * @xferspeed: speed we want to achieve
431 * Tune the ITE chipset for the desired mode. If we can't achieve
432 * the desired mode then tune for a lower one, but ultimately
433 * make the thing work.
436 static int it821x_tune_chipset (ide_drive_t *drive, byte xferspeed)
439 ide_hwif_t *hwif = drive->hwif;
440 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
441 u8 speed = ide_rate_filter(it821x_ratemask(drive), xferspeed);
449 return it821x_tunepio(drive, speed - XFER_PIO_0);
452 if (itdev->smart == 0) {
454 /* MWDMA tuning is really hard because our MWDMA and PIO
455 timings are kept in the same place. We can switch in the
456 host dma on/off callbacks */
460 it821x_tune_mwdma(drive, (speed - XFER_MW_DMA_0));
469 it821x_tune_udma(drive, (speed - XFER_UDMA_0));
476 * In smart mode the clocking is done by the host controller
477 * snooping the mode we picked. The rest of it is not our problem
479 return ide_config_drive_speed(drive, speed);
483 * config_chipset_for_dma - configure for DMA
484 * @drive: drive to configure
486 * Called by the IDE layer when it wants the timings set up.
489 static int config_chipset_for_dma (ide_drive_t *drive)
491 u8 speed = ide_dma_speed(drive, it821x_ratemask(drive));
496 it821x_tune_chipset(drive, speed);
498 return ide_dma_enable(drive);
502 * it821x_configure_drive_for_dma - set up for DMA transfers
503 * @drive: drive we are going to set up
505 * Set up the drive for DMA, tune the controller and drive as
506 * required. If the drive isn't suitable for DMA or we hit
507 * other problems then we will drop down to PIO and set up
511 static int it821x_config_drive_for_dma (ide_drive_t *drive)
513 if (ide_use_dma(drive) && config_chipset_for_dma(drive))
516 it821x_tuneproc(drive, 255);
522 * ata66_it821x - check for 80 pin cable
523 * @hwif: interface to check
525 * Check for the presence of an ATA66 capable cable on the
526 * interface. Problematic as it seems some cards don't have
527 * the needed logic onboard.
530 static unsigned int __devinit ata66_it821x(ide_hwif_t *hwif)
532 /* The reference driver also only does disk side */
537 * it821x_fixup - post init callback
540 * This callback is run after the drives have been probed but
541 * before anything gets attached. It allows drivers to do any
542 * final tuning that is needed, or fixups to work around bugs.
545 static void __devinit it821x_fixups(ide_hwif_t *hwif)
547 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
552 * If we are in pass through mode then not much
553 * needs to be done, but we do bother to clear the
554 * IRQ mask as we may well be in PIO (eg rev 0x10)
555 * for now and we know unmasking is safe on this chipset.
557 for (i = 0; i < 2; i++) {
558 ide_drive_t *drive = &hwif->drives[i];
565 * Perform fixups on smart mode. We need to "lose" some
566 * capabilities the firmware lacks but does not filter, and
567 * also patch up some capability bits that it forgets to set
571 for(i = 0; i < 2; i++) {
572 ide_drive_t *drive = &hwif->drives[i];
573 struct hd_driveid *id;
579 idbits = (u16 *)drive->id;
581 /* Check for RAID v native */
582 if(strstr(id->model, "Integrated Technology Express")) {
583 /* In raid mode the ident block is slightly buggy
584 We need to set the bits so that the IDE layer knows
585 LBA28. LBA48 and DMA ar valid */
586 id->capability |= 3; /* LBA28, DMA */
587 id->command_set_2 |= 0x0400; /* LBA48 valid */
588 id->cfs_enable_2 |= 0x0400; /* LBA48 on */
589 /* Reporting logic */
590 printk(KERN_INFO "%s: IT8212 %sRAID %d volume",
592 idbits[147] ? "Bootable ":"",
595 printk("(%dK stripe)", idbits[146]);
597 /* Now the core code will have wrongly decided no DMA
598 so we need to fix this */
599 hwif->dma_off_quietly(drive);
600 #ifdef CONFIG_IDEDMA_ONLYDISK
601 if (drive->media == ide_disk)
605 /* Non RAID volume. Fixups to stop the core code
606 doing unsupported things */
607 id->field_valid &= 1;
609 id->command_set_1 = 0;
610 id->command_set_2 &= 0xC400;
612 id->cfs_enable_1 = 0;
613 id->cfs_enable_2 &= 0xC400;
614 id->csf_default &= 0xC000;
619 printk(KERN_INFO "%s: Performing identify fixups.\n",
627 * init_hwif_it821x - set up hwif structs
628 * @hwif: interface to set up
630 * We do the basic set up of the interface structure. The IT8212
631 * requires several custom handlers so we override the default
632 * ide DMA handlers appropriately
635 static void __devinit init_hwif_it821x(ide_hwif_t *hwif)
637 struct it821x_dev *idev = kzalloc(sizeof(struct it821x_dev), GFP_KERNEL);
641 printk(KERN_ERR "it821x: out of memory, falling back to legacy behaviour.\n");
644 ide_set_hwifdata(hwif, idev);
648 pci_read_config_byte(hwif->pci_dev, 0x50, &conf);
652 /* Long I/O's although allowed in LBA48 space cause the
653 onboard firmware to enter the twighlight zone */
657 /* Pull the current clocks from 0x50 also */
658 if (conf & (1 << (1 + hwif->channel)))
659 idev->clock_mode = ATA_50;
661 idev->clock_mode = ATA_66;
663 idev->want[0][1] = ATA_ANY;
664 idev->want[1][1] = ATA_ANY;
667 * Not in the docs but according to the reference driver
668 * this is neccessary.
671 pci_read_config_byte(hwif->pci_dev, 0x08, &conf);
676 printk(KERN_WARNING "it821x: Revision 0x10, workarounds activated.\n");
679 hwif->speedproc = &it821x_tune_chipset;
680 hwif->tuneproc = &it821x_tuneproc;
682 /* MWDMA/PIO clock switching for pass through mode */
684 hwif->dma_start = &it821x_dma_start;
685 hwif->ide_dma_end = &it821x_dma_end;
688 hwif->drives[0].autotune = 1;
689 hwif->drives[1].autotune = 1;
694 hwif->ultra_mask = 0x7f;
695 hwif->mwdma_mask = 0x07;
696 hwif->swdma_mask = 0x07;
698 hwif->ide_dma_check = &it821x_config_drive_for_dma;
699 if (!(hwif->udma_four))
700 hwif->udma_four = ata66_it821x(hwif);
703 * The BIOS often doesn't set up DMA on this controller
704 * so we always do it.
708 hwif->drives[0].autodma = hwif->autodma;
709 hwif->drives[1].autodma = hwif->autodma;
716 static void __devinit it8212_disable_raid(struct pci_dev *dev)
718 /* Reset local CPU, and set BIOS not ready */
719 pci_write_config_byte(dev, 0x5E, 0x01);
721 /* Set to bypass mode, and reset PCI bus */
722 pci_write_config_byte(dev, 0x50, 0x00);
723 pci_write_config_word(dev, PCI_COMMAND,
724 PCI_COMMAND_PARITY | PCI_COMMAND_IO |
725 PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER);
726 pci_write_config_word(dev, 0x40, 0xA0F3);
728 pci_write_config_dword(dev,0x4C, 0x02040204);
729 pci_write_config_byte(dev, 0x42, 0x36);
730 pci_write_config_byte(dev, PCI_LATENCY_TIMER, 0x20);
733 static unsigned int __devinit init_chipset_it821x(struct pci_dev *dev, const char *name)
736 static char *mode[2] = { "pass through", "smart" };
738 /* Force the card into bypass mode if so requested */
740 printk(KERN_INFO "it8212: forcing bypass mode.\n");
741 it8212_disable_raid(dev);
743 pci_read_config_byte(dev, 0x50, &conf);
744 printk(KERN_INFO "it821x: controller in %s mode.\n", mode[conf & 1]);
749 #define DECLARE_ITE_DEV(name_str) \
752 .init_chipset = init_chipset_it821x, \
753 .init_hwif = init_hwif_it821x, \
755 .autodma = AUTODMA, \
756 .bootable = ON_BOARD, \
757 .fixup = it821x_fixups \
760 static ide_pci_device_t it821x_chipsets[] __devinitdata = {
761 /* 0 */ DECLARE_ITE_DEV("IT8212"),
765 * it821x_init_one - pci layer discovery entry
767 * @id: ident table entry
769 * Called by the PCI code when it finds an ITE821x controller.
770 * We then use the IDE PCI generic helper to do most of the work.
773 static int __devinit it821x_init_one(struct pci_dev *dev, const struct pci_device_id *id)
775 ide_setup_pci_device(dev, &it821x_chipsets[id->driver_data]);
779 static struct pci_device_id it821x_pci_tbl[] = {
780 { PCI_VENDOR_ID_ITE, PCI_DEVICE_ID_ITE_8211, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
781 { PCI_VENDOR_ID_ITE, PCI_DEVICE_ID_ITE_8212, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
785 MODULE_DEVICE_TABLE(pci, it821x_pci_tbl);
787 static struct pci_driver driver = {
788 .name = "ITE821x IDE",
789 .id_table = it821x_pci_tbl,
790 .probe = it821x_init_one,
793 static int __init it821x_ide_init(void)
795 return ide_pci_register_driver(&driver);
798 module_init(it821x_ide_init);
800 module_param_named(noraid, it8212_noraid, int, S_IRUGO);
801 MODULE_PARM_DESC(it8212_noraid, "Force card into bypass mode");
803 MODULE_AUTHOR("Alan Cox");
804 MODULE_DESCRIPTION("PCI driver module for the ITE 821x");
805 MODULE_LICENSE("GPL");