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_tunepio - tune a drive
233 * @drive: drive to tune
234 * @pio: the desired PIO mode
236 * Try to tune the drive/host to the desired PIO mode taking into
237 * the consideration the maximum PIO mode supported by the other
238 * device on the cable.
241 static int it821x_tunepio(ide_drive_t *drive, u8 set_pio)
243 ide_hwif_t *hwif = drive->hwif;
244 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
245 int unit = drive->select.b.unit;
246 ide_drive_t *pair = &hwif->drives[1 - unit];
248 /* Spec says 89 ref driver uses 88 */
249 static u16 pio[] = { 0xAA88, 0xA382, 0xA181, 0x3332, 0x3121 };
250 static u8 pio_want[] = { ATA_66, ATA_66, ATA_66, ATA_66, ATA_ANY };
253 * Compute the best PIO mode we can for a given device. We must
254 * pick a speed that does not cause problems with the other device
258 u8 pair_pio = ide_get_best_pio_mode(pair, 255, 4, NULL);
259 /* trim PIO to the slowest of the master/slave */
260 if (pair_pio < set_pio)
265 goto set_drive_speed;
267 /* We prefer 66Mhz clock for PIO 0-3, don't care for PIO4 */
268 itdev->want[unit][1] = pio_want[set_pio];
269 itdev->want[unit][0] = 1; /* PIO is lowest priority */
270 itdev->pio[unit] = pio[set_pio];
271 it821x_clock_strategy(drive);
272 it821x_program(drive, itdev->pio[unit]);
275 return ide_config_drive_speed(drive, XFER_PIO_0 + set_pio);
278 static void it821x_tuneproc(ide_drive_t *drive, u8 pio)
280 pio = ide_get_best_pio_mode(drive, pio, 4, NULL);
281 (void)it821x_tunepio(drive, pio);
285 * it821x_tune_mwdma - tune a channel for MWDMA
286 * @drive: drive to set up
287 * @mode_wanted: the target operating mode
289 * Load the timing settings for this device mode into the
290 * controller when doing MWDMA in pass through mode. The caller
291 * must manage the whole lack of per device MWDMA/PIO timings and
292 * the shared MWDMA/PIO timing register.
295 static void it821x_tune_mwdma (ide_drive_t *drive, byte mode_wanted)
297 ide_hwif_t *hwif = drive->hwif;
298 struct it821x_dev *itdev = (void *)ide_get_hwifdata(hwif);
299 int unit = drive->select.b.unit;
300 int channel = hwif->channel;
303 static u16 dma[] = { 0x8866, 0x3222, 0x3121 };
304 static u8 mwdma_want[] = { ATA_ANY, ATA_66, ATA_ANY };
306 itdev->want[unit][1] = mwdma_want[mode_wanted];
307 itdev->want[unit][0] = 2; /* MWDMA is low priority */
308 itdev->mwdma[unit] = dma[mode_wanted];
309 itdev->udma[unit] = UDMA_OFF;
311 /* UDMA bits off - Revision 0x10 do them in pairs */
312 pci_read_config_byte(hwif->pci_dev, 0x50, &conf);
314 conf |= channel ? 0x60: 0x18;
316 conf |= 1 << (3 + 2 * channel + unit);
317 pci_write_config_byte(hwif->pci_dev, 0x50, conf);
319 it821x_clock_strategy(drive);
320 /* FIXME: do we need to program this ? */
321 /* it821x_program(drive, itdev->mwdma[unit]); */
325 * it821x_tune_udma - tune a channel for UDMA
326 * @drive: drive to set up
327 * @mode_wanted: the target operating mode
329 * Load the timing settings for this device mode into the
330 * controller when doing UDMA modes in pass through.
333 static void it821x_tune_udma (ide_drive_t *drive, byte mode_wanted)
335 ide_hwif_t *hwif = drive->hwif;
336 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
337 int unit = drive->select.b.unit;
338 int channel = hwif->channel;
341 static u16 udma[] = { 0x4433, 0x4231, 0x3121, 0x2121, 0x1111, 0x2211, 0x1111 };
342 static u8 udma_want[] = { ATA_ANY, ATA_50, ATA_ANY, ATA_66, ATA_66, ATA_50, ATA_66 };
344 itdev->want[unit][1] = udma_want[mode_wanted];
345 itdev->want[unit][0] = 3; /* UDMA is high priority */
346 itdev->mwdma[unit] = MWDMA_OFF;
347 itdev->udma[unit] = udma[mode_wanted];
349 itdev->udma[unit] |= 0x8080; /* UDMA 5/6 select on */
351 /* UDMA on. Again revision 0x10 must do the pair */
352 pci_read_config_byte(hwif->pci_dev, 0x50, &conf);
354 conf &= channel ? 0x9F: 0xE7;
356 conf &= ~ (1 << (3 + 2 * channel + unit));
357 pci_write_config_byte(hwif->pci_dev, 0x50, conf);
359 it821x_clock_strategy(drive);
360 it821x_program_udma(drive, itdev->udma[unit]);
365 * it821x_dma_read - DMA hook
366 * @drive: drive for DMA
368 * The IT821x has a single timing register for MWDMA and for PIO
369 * operations. As we flip back and forth we have to reload the
370 * clock. In addition the rev 0x10 device only works if the same
371 * timing value is loaded into the master and slave UDMA clock
372 * so we must also reload that.
374 * FIXME: we could figure out in advance if we need to do reloads
377 static void it821x_dma_start(ide_drive_t *drive)
379 ide_hwif_t *hwif = drive->hwif;
380 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
381 int unit = drive->select.b.unit;
382 if(itdev->mwdma[unit] != MWDMA_OFF)
383 it821x_program(drive, itdev->mwdma[unit]);
384 else if(itdev->udma[unit] != UDMA_OFF && itdev->timing10)
385 it821x_program_udma(drive, itdev->udma[unit]);
386 ide_dma_start(drive);
390 * it821x_dma_write - DMA hook
391 * @drive: drive for DMA stop
393 * The IT821x has a single timing register for MWDMA and for PIO
394 * operations. As we flip back and forth we have to reload the
398 static int it821x_dma_end(ide_drive_t *drive)
400 ide_hwif_t *hwif = drive->hwif;
401 int unit = drive->select.b.unit;
402 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
403 int ret = __ide_dma_end(drive);
404 if(itdev->mwdma[unit] != MWDMA_OFF)
405 it821x_program(drive, itdev->pio[unit]);
411 * it821x_tune_chipset - set controller timings
412 * @drive: Drive to set up
413 * @xferspeed: speed we want to achieve
415 * Tune the ITE chipset for the desired mode. If we can't achieve
416 * the desired mode then tune for a lower one, but ultimately
417 * make the thing work.
420 static int it821x_tune_chipset (ide_drive_t *drive, byte xferspeed)
423 ide_hwif_t *hwif = drive->hwif;
424 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
425 u8 speed = ide_rate_filter(drive, xferspeed);
433 return it821x_tunepio(drive, speed - XFER_PIO_0);
436 if (itdev->smart == 0) {
438 /* MWDMA tuning is really hard because our MWDMA and PIO
439 timings are kept in the same place. We can switch in the
440 host dma on/off callbacks */
444 it821x_tune_mwdma(drive, (speed - XFER_MW_DMA_0));
453 it821x_tune_udma(drive, (speed - XFER_UDMA_0));
460 * In smart mode the clocking is done by the host controller
461 * snooping the mode we picked. The rest of it is not our problem
463 return ide_config_drive_speed(drive, speed);
467 * config_chipset_for_dma - configure for DMA
468 * @drive: drive to configure
470 * Called by the IDE layer when it wants the timings set up.
473 static int config_chipset_for_dma (ide_drive_t *drive)
475 u8 speed = ide_max_dma_mode(drive);
480 it821x_tune_chipset(drive, speed);
482 return ide_dma_enable(drive);
486 * it821x_configure_drive_for_dma - set up for DMA transfers
487 * @drive: drive we are going to set up
489 * Set up the drive for DMA, tune the controller and drive as
490 * required. If the drive isn't suitable for DMA or we hit
491 * other problems then we will drop down to PIO and set up
495 static int it821x_config_drive_for_dma (ide_drive_t *drive)
497 if (ide_use_dma(drive) && config_chipset_for_dma(drive))
500 it821x_tuneproc(drive, 255);
506 * ata66_it821x - check for 80 pin cable
507 * @hwif: interface to check
509 * Check for the presence of an ATA66 capable cable on the
510 * interface. Problematic as it seems some cards don't have
511 * the needed logic onboard.
514 static unsigned int __devinit ata66_it821x(ide_hwif_t *hwif)
516 /* The reference driver also only does disk side */
521 * it821x_fixup - post init callback
524 * This callback is run after the drives have been probed but
525 * before anything gets attached. It allows drivers to do any
526 * final tuning that is needed, or fixups to work around bugs.
529 static void __devinit it821x_fixups(ide_hwif_t *hwif)
531 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
536 * If we are in pass through mode then not much
537 * needs to be done, but we do bother to clear the
538 * IRQ mask as we may well be in PIO (eg rev 0x10)
539 * for now and we know unmasking is safe on this chipset.
541 for (i = 0; i < 2; i++) {
542 ide_drive_t *drive = &hwif->drives[i];
549 * Perform fixups on smart mode. We need to "lose" some
550 * capabilities the firmware lacks but does not filter, and
551 * also patch up some capability bits that it forgets to set
555 for(i = 0; i < 2; i++) {
556 ide_drive_t *drive = &hwif->drives[i];
557 struct hd_driveid *id;
563 idbits = (u16 *)drive->id;
565 /* Check for RAID v native */
566 if(strstr(id->model, "Integrated Technology Express")) {
567 /* In raid mode the ident block is slightly buggy
568 We need to set the bits so that the IDE layer knows
569 LBA28. LBA48 and DMA ar valid */
570 id->capability |= 3; /* LBA28, DMA */
571 id->command_set_2 |= 0x0400; /* LBA48 valid */
572 id->cfs_enable_2 |= 0x0400; /* LBA48 on */
573 /* Reporting logic */
574 printk(KERN_INFO "%s: IT8212 %sRAID %d volume",
576 idbits[147] ? "Bootable ":"",
579 printk("(%dK stripe)", idbits[146]);
581 /* Now the core code will have wrongly decided no DMA
582 so we need to fix this */
583 hwif->dma_off_quietly(drive);
584 #ifdef CONFIG_IDEDMA_ONLYDISK
585 if (drive->media == ide_disk)
589 /* Non RAID volume. Fixups to stop the core code
590 doing unsupported things */
591 id->field_valid &= 1;
593 id->command_set_1 = 0;
594 id->command_set_2 &= 0xC400;
596 id->cfs_enable_1 = 0;
597 id->cfs_enable_2 &= 0xC400;
598 id->csf_default &= 0xC000;
603 printk(KERN_INFO "%s: Performing identify fixups.\n",
611 * init_hwif_it821x - set up hwif structs
612 * @hwif: interface to set up
614 * We do the basic set up of the interface structure. The IT8212
615 * requires several custom handlers so we override the default
616 * ide DMA handlers appropriately
619 static void __devinit init_hwif_it821x(ide_hwif_t *hwif)
621 struct it821x_dev *idev = kzalloc(sizeof(struct it821x_dev), GFP_KERNEL);
625 printk(KERN_ERR "it821x: out of memory, falling back to legacy behaviour.\n");
628 ide_set_hwifdata(hwif, idev);
632 pci_read_config_byte(hwif->pci_dev, 0x50, &conf);
636 /* Long I/O's although allowed in LBA48 space cause the
637 onboard firmware to enter the twighlight zone */
641 /* Pull the current clocks from 0x50 also */
642 if (conf & (1 << (1 + hwif->channel)))
643 idev->clock_mode = ATA_50;
645 idev->clock_mode = ATA_66;
647 idev->want[0][1] = ATA_ANY;
648 idev->want[1][1] = ATA_ANY;
651 * Not in the docs but according to the reference driver
652 * this is neccessary.
655 pci_read_config_byte(hwif->pci_dev, 0x08, &conf);
660 printk(KERN_WARNING "it821x: Revision 0x10, workarounds activated.\n");
663 hwif->speedproc = &it821x_tune_chipset;
664 hwif->tuneproc = &it821x_tuneproc;
666 /* MWDMA/PIO clock switching for pass through mode */
668 hwif->dma_start = &it821x_dma_start;
669 hwif->ide_dma_end = &it821x_dma_end;
672 hwif->drives[0].autotune = 1;
673 hwif->drives[1].autotune = 1;
678 hwif->ultra_mask = 0x7f;
679 hwif->mwdma_mask = 0x07;
680 hwif->swdma_mask = 0x07;
682 hwif->ide_dma_check = &it821x_config_drive_for_dma;
683 if (!(hwif->udma_four))
684 hwif->udma_four = ata66_it821x(hwif);
687 * The BIOS often doesn't set up DMA on this controller
688 * so we always do it.
692 hwif->drives[0].autodma = hwif->autodma;
693 hwif->drives[1].autodma = hwif->autodma;
700 static void __devinit it8212_disable_raid(struct pci_dev *dev)
702 /* Reset local CPU, and set BIOS not ready */
703 pci_write_config_byte(dev, 0x5E, 0x01);
705 /* Set to bypass mode, and reset PCI bus */
706 pci_write_config_byte(dev, 0x50, 0x00);
707 pci_write_config_word(dev, PCI_COMMAND,
708 PCI_COMMAND_PARITY | PCI_COMMAND_IO |
709 PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER);
710 pci_write_config_word(dev, 0x40, 0xA0F3);
712 pci_write_config_dword(dev,0x4C, 0x02040204);
713 pci_write_config_byte(dev, 0x42, 0x36);
714 pci_write_config_byte(dev, PCI_LATENCY_TIMER, 0x20);
717 static unsigned int __devinit init_chipset_it821x(struct pci_dev *dev, const char *name)
720 static char *mode[2] = { "pass through", "smart" };
722 /* Force the card into bypass mode if so requested */
724 printk(KERN_INFO "it8212: forcing bypass mode.\n");
725 it8212_disable_raid(dev);
727 pci_read_config_byte(dev, 0x50, &conf);
728 printk(KERN_INFO "it821x: controller in %s mode.\n", mode[conf & 1]);
733 #define DECLARE_ITE_DEV(name_str) \
736 .init_chipset = init_chipset_it821x, \
737 .init_hwif = init_hwif_it821x, \
739 .autodma = AUTODMA, \
740 .bootable = ON_BOARD, \
741 .fixup = it821x_fixups \
744 static ide_pci_device_t it821x_chipsets[] __devinitdata = {
745 /* 0 */ DECLARE_ITE_DEV("IT8212"),
749 * it821x_init_one - pci layer discovery entry
751 * @id: ident table entry
753 * Called by the PCI code when it finds an ITE821x controller.
754 * We then use the IDE PCI generic helper to do most of the work.
757 static int __devinit it821x_init_one(struct pci_dev *dev, const struct pci_device_id *id)
759 ide_setup_pci_device(dev, &it821x_chipsets[id->driver_data]);
763 static struct pci_device_id it821x_pci_tbl[] = {
764 { PCI_VENDOR_ID_ITE, PCI_DEVICE_ID_ITE_8211, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
765 { PCI_VENDOR_ID_ITE, PCI_DEVICE_ID_ITE_8212, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
769 MODULE_DEVICE_TABLE(pci, it821x_pci_tbl);
771 static struct pci_driver driver = {
772 .name = "ITE821x IDE",
773 .id_table = it821x_pci_tbl,
774 .probe = it821x_init_one,
777 static int __init it821x_ide_init(void)
779 return ide_pci_register_driver(&driver);
782 module_init(it821x_ide_init);
784 module_param_named(noraid, it8212_noraid, int, S_IRUGO);
785 MODULE_PARM_DESC(it8212_noraid, "Force card into bypass mode");
787 MODULE_AUTHOR("Alan Cox");
788 MODULE_DESCRIPTION("PCI driver module for the ITE 821x");
789 MODULE_LICENSE("GPL");