3 * linux/drivers/ide/pci/it821x.c Version 0.16 Jul 3 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 necessary 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_set_pio_mode - set host controller for PIO mode
234 * @pio: PIO mode number
236 * Tune the host to the desired PIO mode taking into the consideration
237 * the maximum PIO mode supported by the other device on the cable.
240 static void it821x_set_pio_mode(ide_drive_t *drive, const u8 pio)
242 ide_hwif_t *hwif = drive->hwif;
243 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
244 int unit = drive->select.b.unit;
245 ide_drive_t *pair = &hwif->drives[1 - unit];
248 /* Spec says 89 ref driver uses 88 */
249 static u16 pio_timings[]= { 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);
259 /* trim PIO to the slowest of the master/slave */
260 if (pair_pio < set_pio)
264 /* We prefer 66Mhz clock for PIO 0-3, don't care for PIO4 */
265 itdev->want[unit][1] = pio_want[set_pio];
266 itdev->want[unit][0] = 1; /* PIO is lowest priority */
267 itdev->pio[unit] = pio_timings[set_pio];
268 it821x_clock_strategy(drive);
269 it821x_program(drive, itdev->pio[unit]);
273 * it821x_tune_mwdma - tune a channel for MWDMA
274 * @drive: drive to set up
275 * @mode_wanted: the target operating mode
277 * Load the timing settings for this device mode into the
278 * controller when doing MWDMA in pass through mode. The caller
279 * must manage the whole lack of per device MWDMA/PIO timings and
280 * the shared MWDMA/PIO timing register.
283 static void it821x_tune_mwdma (ide_drive_t *drive, byte mode_wanted)
285 ide_hwif_t *hwif = drive->hwif;
286 struct it821x_dev *itdev = (void *)ide_get_hwifdata(hwif);
287 int unit = drive->select.b.unit;
288 int channel = hwif->channel;
291 static u16 dma[] = { 0x8866, 0x3222, 0x3121 };
292 static u8 mwdma_want[] = { ATA_ANY, ATA_66, ATA_ANY };
294 itdev->want[unit][1] = mwdma_want[mode_wanted];
295 itdev->want[unit][0] = 2; /* MWDMA is low priority */
296 itdev->mwdma[unit] = dma[mode_wanted];
297 itdev->udma[unit] = UDMA_OFF;
299 /* UDMA bits off - Revision 0x10 do them in pairs */
300 pci_read_config_byte(hwif->pci_dev, 0x50, &conf);
302 conf |= channel ? 0x60: 0x18;
304 conf |= 1 << (3 + 2 * channel + unit);
305 pci_write_config_byte(hwif->pci_dev, 0x50, conf);
307 it821x_clock_strategy(drive);
308 /* FIXME: do we need to program this ? */
309 /* it821x_program(drive, itdev->mwdma[unit]); */
313 * it821x_tune_udma - tune a channel for UDMA
314 * @drive: drive to set up
315 * @mode_wanted: the target operating mode
317 * Load the timing settings for this device mode into the
318 * controller when doing UDMA modes in pass through.
321 static void it821x_tune_udma (ide_drive_t *drive, byte mode_wanted)
323 ide_hwif_t *hwif = drive->hwif;
324 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
325 int unit = drive->select.b.unit;
326 int channel = hwif->channel;
329 static u16 udma[] = { 0x4433, 0x4231, 0x3121, 0x2121, 0x1111, 0x2211, 0x1111 };
330 static u8 udma_want[] = { ATA_ANY, ATA_50, ATA_ANY, ATA_66, ATA_66, ATA_50, ATA_66 };
332 itdev->want[unit][1] = udma_want[mode_wanted];
333 itdev->want[unit][0] = 3; /* UDMA is high priority */
334 itdev->mwdma[unit] = MWDMA_OFF;
335 itdev->udma[unit] = udma[mode_wanted];
337 itdev->udma[unit] |= 0x8080; /* UDMA 5/6 select on */
339 /* UDMA on. Again revision 0x10 must do the pair */
340 pci_read_config_byte(hwif->pci_dev, 0x50, &conf);
342 conf &= channel ? 0x9F: 0xE7;
344 conf &= ~ (1 << (3 + 2 * channel + unit));
345 pci_write_config_byte(hwif->pci_dev, 0x50, conf);
347 it821x_clock_strategy(drive);
348 it821x_program_udma(drive, itdev->udma[unit]);
353 * it821x_dma_read - DMA hook
354 * @drive: drive for DMA
356 * The IT821x has a single timing register for MWDMA and for PIO
357 * operations. As we flip back and forth we have to reload the
358 * clock. In addition the rev 0x10 device only works if the same
359 * timing value is loaded into the master and slave UDMA clock
360 * so we must also reload that.
362 * FIXME: we could figure out in advance if we need to do reloads
365 static void it821x_dma_start(ide_drive_t *drive)
367 ide_hwif_t *hwif = drive->hwif;
368 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
369 int unit = drive->select.b.unit;
370 if(itdev->mwdma[unit] != MWDMA_OFF)
371 it821x_program(drive, itdev->mwdma[unit]);
372 else if(itdev->udma[unit] != UDMA_OFF && itdev->timing10)
373 it821x_program_udma(drive, itdev->udma[unit]);
374 ide_dma_start(drive);
378 * it821x_dma_write - DMA hook
379 * @drive: drive for DMA stop
381 * The IT821x has a single timing register for MWDMA and for PIO
382 * operations. As we flip back and forth we have to reload the
386 static int it821x_dma_end(ide_drive_t *drive)
388 ide_hwif_t *hwif = drive->hwif;
389 int unit = drive->select.b.unit;
390 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
391 int ret = __ide_dma_end(drive);
392 if(itdev->mwdma[unit] != MWDMA_OFF)
393 it821x_program(drive, itdev->pio[unit]);
398 * it821x_set_dma_mode - set host controller for DMA mode
402 * Tune the ITE chipset for the desired DMA mode.
405 static void it821x_set_dma_mode(ide_drive_t *drive, const u8 speed)
408 * MWDMA tuning is really hard because our MWDMA and PIO
409 * timings are kept in the same place. We can switch in the
410 * host dma on/off callbacks.
412 if (speed >= XFER_UDMA_0 && speed <= XFER_UDMA_6)
413 it821x_tune_udma(drive, speed - XFER_UDMA_0);
414 else if (speed >= XFER_MW_DMA_0 && speed <= XFER_MW_DMA_2)
415 it821x_tune_mwdma(drive, speed - XFER_MW_DMA_0);
419 * ata66_it821x - check for 80 pin cable
420 * @hwif: interface to check
422 * Check for the presence of an ATA66 capable cable on the
423 * interface. Problematic as it seems some cards don't have
424 * the needed logic onboard.
427 static u8 __devinit ata66_it821x(ide_hwif_t *hwif)
429 /* The reference driver also only does disk side */
430 return ATA_CBL_PATA80;
434 * it821x_fixup - post init callback
437 * This callback is run after the drives have been probed but
438 * before anything gets attached. It allows drivers to do any
439 * final tuning that is needed, or fixups to work around bugs.
442 static void __devinit it821x_fixups(ide_hwif_t *hwif)
444 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
449 * If we are in pass through mode then not much
450 * needs to be done, but we do bother to clear the
451 * IRQ mask as we may well be in PIO (eg rev 0x10)
452 * for now and we know unmasking is safe on this chipset.
454 for (i = 0; i < 2; i++) {
455 ide_drive_t *drive = &hwif->drives[i];
462 * Perform fixups on smart mode. We need to "lose" some
463 * capabilities the firmware lacks but does not filter, and
464 * also patch up some capability bits that it forgets to set
468 for(i = 0; i < 2; i++) {
469 ide_drive_t *drive = &hwif->drives[i];
470 struct hd_driveid *id;
476 idbits = (u16 *)drive->id;
478 /* Check for RAID v native */
479 if(strstr(id->model, "Integrated Technology Express")) {
480 /* In raid mode the ident block is slightly buggy
481 We need to set the bits so that the IDE layer knows
482 LBA28. LBA48 and DMA ar valid */
483 id->capability |= 3; /* LBA28, DMA */
484 id->command_set_2 |= 0x0400; /* LBA48 valid */
485 id->cfs_enable_2 |= 0x0400; /* LBA48 on */
486 /* Reporting logic */
487 printk(KERN_INFO "%s: IT8212 %sRAID %d volume",
489 idbits[147] ? "Bootable ":"",
492 printk("(%dK stripe)", idbits[146]);
495 /* Non RAID volume. Fixups to stop the core code
496 doing unsupported things */
497 id->field_valid &= 3;
499 id->command_set_1 = 0;
500 id->command_set_2 &= 0xC400;
502 id->cfs_enable_1 = 0;
503 id->cfs_enable_2 &= 0xC400;
504 id->csf_default &= 0xC000;
509 printk(KERN_INFO "%s: Performing identify fixups.\n",
514 * Set MWDMA0 mode as enabled/support - just to tell
515 * IDE core that DMA is supported (it821x hardware
516 * takes care of DMA mode programming).
518 if (id->capability & 1) {
519 id->dma_mword |= 0x0101;
520 drive->current_speed = XFER_MW_DMA_0;
527 * init_hwif_it821x - set up hwif structs
528 * @hwif: interface to set up
530 * We do the basic set up of the interface structure. The IT8212
531 * requires several custom handlers so we override the default
532 * ide DMA handlers appropriately
535 static void __devinit init_hwif_it821x(ide_hwif_t *hwif)
537 struct it821x_dev *idev = kzalloc(sizeof(struct it821x_dev), GFP_KERNEL);
541 printk(KERN_ERR "it821x: out of memory, falling back to legacy behaviour.\n");
545 ide_set_hwifdata(hwif, idev);
547 pci_read_config_byte(hwif->pci_dev, 0x50, &conf);
550 hwif->host_flags |= IDE_HFLAG_NO_ATAPI_DMA;
551 /* Long I/O's although allowed in LBA48 space cause the
552 onboard firmware to enter the twighlight zone */
556 /* Pull the current clocks from 0x50 also */
557 if (conf & (1 << (1 + hwif->channel)))
558 idev->clock_mode = ATA_50;
560 idev->clock_mode = ATA_66;
562 idev->want[0][1] = ATA_ANY;
563 idev->want[1][1] = ATA_ANY;
566 * Not in the docs but according to the reference driver
570 pci_read_config_byte(hwif->pci_dev, 0x08, &conf);
573 hwif->host_flags |= IDE_HFLAG_NO_ATAPI_DMA;
574 if (idev->smart == 0)
575 printk(KERN_WARNING "it821x: Revision 0x10, workarounds activated.\n");
578 if (idev->smart == 0) {
579 hwif->set_pio_mode = &it821x_set_pio_mode;
580 hwif->set_dma_mode = &it821x_set_dma_mode;
582 /* MWDMA/PIO clock switching for pass through mode */
583 hwif->dma_start = &it821x_dma_start;
584 hwif->ide_dma_end = &it821x_dma_end;
586 hwif->host_flags |= IDE_HFLAG_NO_SET_MODE;
588 if (hwif->dma_base == 0)
591 hwif->ultra_mask = ATA_UDMA6;
592 hwif->mwdma_mask = ATA_MWDMA2;
594 if (hwif->cbl != ATA_CBL_PATA40_SHORT)
595 hwif->cbl = ata66_it821x(hwif);
598 static void __devinit it8212_disable_raid(struct pci_dev *dev)
600 /* Reset local CPU, and set BIOS not ready */
601 pci_write_config_byte(dev, 0x5E, 0x01);
603 /* Set to bypass mode, and reset PCI bus */
604 pci_write_config_byte(dev, 0x50, 0x00);
605 pci_write_config_word(dev, PCI_COMMAND,
606 PCI_COMMAND_PARITY | PCI_COMMAND_IO |
607 PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER);
608 pci_write_config_word(dev, 0x40, 0xA0F3);
610 pci_write_config_dword(dev,0x4C, 0x02040204);
611 pci_write_config_byte(dev, 0x42, 0x36);
612 pci_write_config_byte(dev, PCI_LATENCY_TIMER, 0x20);
615 static unsigned int __devinit init_chipset_it821x(struct pci_dev *dev, const char *name)
618 static char *mode[2] = { "pass through", "smart" };
620 /* Force the card into bypass mode if so requested */
622 printk(KERN_INFO "it8212: forcing bypass mode.\n");
623 it8212_disable_raid(dev);
625 pci_read_config_byte(dev, 0x50, &conf);
626 printk(KERN_INFO "it821x: controller in %s mode.\n", mode[conf & 1]);
631 #define DECLARE_ITE_DEV(name_str) \
634 .init_chipset = init_chipset_it821x, \
635 .init_hwif = init_hwif_it821x, \
636 .fixup = it821x_fixups, \
637 .host_flags = IDE_HFLAG_BOOTABLE, \
638 .pio_mask = ATA_PIO4, \
641 static const struct ide_port_info it821x_chipsets[] __devinitdata = {
642 /* 0 */ DECLARE_ITE_DEV("IT8212"),
646 * it821x_init_one - pci layer discovery entry
648 * @id: ident table entry
650 * Called by the PCI code when it finds an ITE821x controller.
651 * We then use the IDE PCI generic helper to do most of the work.
654 static int __devinit it821x_init_one(struct pci_dev *dev, const struct pci_device_id *id)
656 return ide_setup_pci_device(dev, &it821x_chipsets[id->driver_data]);
659 static const struct pci_device_id it821x_pci_tbl[] = {
660 { PCI_VDEVICE(ITE, PCI_DEVICE_ID_ITE_8211), 0 },
661 { PCI_VDEVICE(ITE, PCI_DEVICE_ID_ITE_8212), 0 },
665 MODULE_DEVICE_TABLE(pci, it821x_pci_tbl);
667 static struct pci_driver driver = {
668 .name = "ITE821x IDE",
669 .id_table = it821x_pci_tbl,
670 .probe = it821x_init_one,
673 static int __init it821x_ide_init(void)
675 return ide_pci_register_driver(&driver);
678 module_init(it821x_ide_init);
680 module_param_named(noraid, it8212_noraid, int, S_IRUGO);
681 MODULE_PARM_DESC(it8212_noraid, "Force card into bypass mode");
683 MODULE_AUTHOR("Alan Cox");
684 MODULE_DESCRIPTION("PCI driver module for the ITE 821x");
685 MODULE_LICENSE("GPL");