2 * Copyright (C) 2004 Red Hat <alan@redhat.com>
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/hdreg.h>
67 #include <linux/ide.h>
68 #include <linux/init.h>
70 #define DRV_NAME "it821x"
74 unsigned int smart:1, /* Are we in smart raid mode */
75 timing10:1; /* Rev 0x10 */
76 u8 clock_mode; /* 0, ATA_50 or ATA_66 */
77 u8 want[2][2]; /* Mode/Pri log for master slave */
78 /* We need these for switching the clock when DMA goes on/off
79 The high byte is the 66Mhz timing */
80 u16 pio[2]; /* Cached PIO values */
81 u16 mwdma[2]; /* Cached MWDMA values */
82 u16 udma[2]; /* Cached UDMA values (per drive) */
93 * We allow users to force the card into non raid mode without
94 * flashing the alternative BIOS. This is also necessary right now
95 * for embedded platforms that cannot run a PC BIOS but are using this
99 static int it8212_noraid;
102 * it821x_program - program the PIO/MWDMA registers
103 * @drive: drive to tune
104 * @timing: timing info
106 * Program the PIO/MWDMA timing for this channel according to the
110 static void it821x_program(ide_drive_t *drive, u16 timing)
112 ide_hwif_t *hwif = drive->hwif;
113 struct pci_dev *dev = to_pci_dev(hwif->dev);
114 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
115 int channel = hwif->channel;
118 /* Program PIO/MWDMA timing bits */
119 if(itdev->clock_mode == ATA_66)
122 conf = timing & 0xFF;
124 pci_write_config_byte(dev, 0x54 + 4 * channel, conf);
128 * it821x_program_udma - program the UDMA registers
129 * @drive: drive to tune
130 * @timing: timing info
132 * Program the UDMA timing for this drive according to the
136 static void it821x_program_udma(ide_drive_t *drive, u16 timing)
138 ide_hwif_t *hwif = drive->hwif;
139 struct pci_dev *dev = to_pci_dev(hwif->dev);
140 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
141 int channel = hwif->channel;
142 int unit = drive->select.b.unit;
145 /* Program UDMA timing bits */
146 if(itdev->clock_mode == ATA_66)
149 conf = timing & 0xFF;
151 if (itdev->timing10 == 0)
152 pci_write_config_byte(dev, 0x56 + 4 * channel + unit, conf);
154 pci_write_config_byte(dev, 0x56 + 4 * channel, conf);
155 pci_write_config_byte(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 pci_dev *dev = to_pci_dev(hwif->dev);
171 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
173 u8 unit = drive->select.b.unit;
174 ide_drive_t *pair = &hwif->drives[1-unit];
180 if(itdev->want[0][0] > itdev->want[1][0]) {
181 clock = itdev->want[0][1];
182 altclock = itdev->want[1][1];
184 clock = itdev->want[1][1];
185 altclock = itdev->want[0][1];
189 * if both clocks can be used for the mode with the higher priority
190 * use the clock needed by the mode with the lower priority
192 if (clock == ATA_ANY)
195 /* Nobody cares - keep the same clock */
199 if(clock == itdev->clock_mode)
202 /* Load this into the controller ? */
204 itdev->clock_mode = ATA_66;
206 itdev->clock_mode = ATA_50;
210 pci_read_config_byte(dev, 0x50, &v);
211 v &= ~(1 << (1 + hwif->channel));
212 v |= sel << (1 + hwif->channel);
213 pci_write_config_byte(dev, 0x50, v);
216 * Reprogram the UDMA/PIO of the pair drive for the switch
217 * MWDMA will be dealt with by the dma switcher
219 if(pair && itdev->udma[1-unit] != UDMA_OFF) {
220 it821x_program_udma(pair, itdev->udma[1-unit]);
221 it821x_program(pair, itdev->pio[1-unit]);
224 * Reprogram the UDMA/PIO of our drive for the switch.
225 * MWDMA will be dealt with by the dma switcher
227 if(itdev->udma[unit] != UDMA_OFF) {
228 it821x_program_udma(drive, itdev->udma[unit]);
229 it821x_program(drive, itdev->pio[unit]);
234 * it821x_set_pio_mode - set host controller for PIO mode
236 * @pio: PIO mode number
238 * Tune the host to the desired PIO mode taking into the consideration
239 * the maximum PIO mode supported by the other device on the cable.
242 static void it821x_set_pio_mode(ide_drive_t *drive, const u8 pio)
244 ide_hwif_t *hwif = drive->hwif;
245 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
246 int unit = drive->select.b.unit;
247 ide_drive_t *pair = &hwif->drives[1 - unit];
250 /* Spec says 89 ref driver uses 88 */
251 static u16 pio_timings[]= { 0xAA88, 0xA382, 0xA181, 0x3332, 0x3121 };
252 static u8 pio_want[] = { ATA_66, ATA_66, ATA_66, ATA_66, ATA_ANY };
255 * Compute the best PIO mode we can for a given device. We must
256 * pick a speed that does not cause problems with the other device
260 u8 pair_pio = ide_get_best_pio_mode(pair, 255, 4);
261 /* trim PIO to the slowest of the master/slave */
262 if (pair_pio < set_pio)
266 /* We prefer 66Mhz clock for PIO 0-3, don't care for PIO4 */
267 itdev->want[unit][1] = pio_want[set_pio];
268 itdev->want[unit][0] = 1; /* PIO is lowest priority */
269 itdev->pio[unit] = pio_timings[set_pio];
270 it821x_clock_strategy(drive);
271 it821x_program(drive, itdev->pio[unit]);
275 * it821x_tune_mwdma - tune a channel for MWDMA
276 * @drive: drive to set up
277 * @mode_wanted: the target operating mode
279 * Load the timing settings for this device mode into the
280 * controller when doing MWDMA in pass through mode. The caller
281 * must manage the whole lack of per device MWDMA/PIO timings and
282 * the shared MWDMA/PIO timing register.
285 static void it821x_tune_mwdma (ide_drive_t *drive, byte mode_wanted)
287 ide_hwif_t *hwif = drive->hwif;
288 struct pci_dev *dev = to_pci_dev(hwif->dev);
289 struct it821x_dev *itdev = (void *)ide_get_hwifdata(hwif);
290 int unit = drive->select.b.unit;
291 int channel = hwif->channel;
294 static u16 dma[] = { 0x8866, 0x3222, 0x3121 };
295 static u8 mwdma_want[] = { ATA_ANY, ATA_66, ATA_ANY };
297 itdev->want[unit][1] = mwdma_want[mode_wanted];
298 itdev->want[unit][0] = 2; /* MWDMA is low priority */
299 itdev->mwdma[unit] = dma[mode_wanted];
300 itdev->udma[unit] = UDMA_OFF;
302 /* UDMA bits off - Revision 0x10 do them in pairs */
303 pci_read_config_byte(dev, 0x50, &conf);
305 conf |= channel ? 0x60: 0x18;
307 conf |= 1 << (3 + 2 * channel + unit);
308 pci_write_config_byte(dev, 0x50, conf);
310 it821x_clock_strategy(drive);
311 /* FIXME: do we need to program this ? */
312 /* it821x_program(drive, itdev->mwdma[unit]); */
316 * it821x_tune_udma - tune a channel for UDMA
317 * @drive: drive to set up
318 * @mode_wanted: the target operating mode
320 * Load the timing settings for this device mode into the
321 * controller when doing UDMA modes in pass through.
324 static void it821x_tune_udma (ide_drive_t *drive, byte mode_wanted)
326 ide_hwif_t *hwif = drive->hwif;
327 struct pci_dev *dev = to_pci_dev(hwif->dev);
328 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
329 int unit = drive->select.b.unit;
330 int channel = hwif->channel;
333 static u16 udma[] = { 0x4433, 0x4231, 0x3121, 0x2121, 0x1111, 0x2211, 0x1111 };
334 static u8 udma_want[] = { ATA_ANY, ATA_50, ATA_ANY, ATA_66, ATA_66, ATA_50, ATA_66 };
336 itdev->want[unit][1] = udma_want[mode_wanted];
337 itdev->want[unit][0] = 3; /* UDMA is high priority */
338 itdev->mwdma[unit] = MWDMA_OFF;
339 itdev->udma[unit] = udma[mode_wanted];
341 itdev->udma[unit] |= 0x8080; /* UDMA 5/6 select on */
343 /* UDMA on. Again revision 0x10 must do the pair */
344 pci_read_config_byte(dev, 0x50, &conf);
346 conf &= channel ? 0x9F: 0xE7;
348 conf &= ~ (1 << (3 + 2 * channel + unit));
349 pci_write_config_byte(dev, 0x50, conf);
351 it821x_clock_strategy(drive);
352 it821x_program_udma(drive, itdev->udma[unit]);
357 * it821x_dma_read - DMA hook
358 * @drive: drive for DMA
360 * The IT821x has a single timing register for MWDMA and for PIO
361 * operations. As we flip back and forth we have to reload the
362 * clock. In addition the rev 0x10 device only works if the same
363 * timing value is loaded into the master and slave UDMA clock
364 * so we must also reload that.
366 * FIXME: we could figure out in advance if we need to do reloads
369 static void it821x_dma_start(ide_drive_t *drive)
371 ide_hwif_t *hwif = drive->hwif;
372 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
373 int unit = drive->select.b.unit;
374 if(itdev->mwdma[unit] != MWDMA_OFF)
375 it821x_program(drive, itdev->mwdma[unit]);
376 else if(itdev->udma[unit] != UDMA_OFF && itdev->timing10)
377 it821x_program_udma(drive, itdev->udma[unit]);
378 ide_dma_start(drive);
382 * it821x_dma_write - DMA hook
383 * @drive: drive for DMA stop
385 * The IT821x has a single timing register for MWDMA and for PIO
386 * operations. As we flip back and forth we have to reload the
390 static int it821x_dma_end(ide_drive_t *drive)
392 ide_hwif_t *hwif = drive->hwif;
393 int unit = drive->select.b.unit;
394 struct it821x_dev *itdev = ide_get_hwifdata(hwif);
395 int ret = __ide_dma_end(drive);
396 if(itdev->mwdma[unit] != MWDMA_OFF)
397 it821x_program(drive, itdev->pio[unit]);
402 * it821x_set_dma_mode - set host controller for DMA mode
406 * Tune the ITE chipset for the desired DMA mode.
409 static void it821x_set_dma_mode(ide_drive_t *drive, const u8 speed)
412 * MWDMA tuning is really hard because our MWDMA and PIO
413 * timings are kept in the same place. We can switch in the
414 * host dma on/off callbacks.
416 if (speed >= XFER_UDMA_0 && speed <= XFER_UDMA_6)
417 it821x_tune_udma(drive, speed - XFER_UDMA_0);
418 else if (speed >= XFER_MW_DMA_0 && speed <= XFER_MW_DMA_2)
419 it821x_tune_mwdma(drive, speed - XFER_MW_DMA_0);
423 * it821x_cable_detect - cable detection
424 * @hwif: interface to check
426 * Check for the presence of an ATA66 capable cable on the
427 * interface. Problematic as it seems some cards don't have
428 * the needed logic onboard.
431 static u8 it821x_cable_detect(ide_hwif_t *hwif)
433 /* The reference driver also only does disk side */
434 return ATA_CBL_PATA80;
438 * it821x_quirkproc - post init callback
441 * This callback is run after the drive has been probed but
442 * before anything gets attached. It allows drivers to do any
443 * final tuning that is needed, or fixups to work around bugs.
446 static void it821x_quirkproc(ide_drive_t *drive)
448 struct it821x_dev *itdev = ide_get_hwifdata(drive->hwif);
449 struct hd_driveid *id = drive->id;
450 u16 *idbits = (u16 *)drive->id;
454 * If we are in pass through mode then not much
455 * needs to be done, but we do bother to clear the
456 * IRQ mask as we may well be in PIO (eg rev 0x10)
457 * for now and we know unmasking is safe on this chipset.
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 /* Check for RAID v native */
469 if(strstr(id->model, "Integrated Technology Express")) {
470 /* In raid mode the ident block is slightly buggy
471 We need to set the bits so that the IDE layer knows
472 LBA28. LBA48 and DMA ar valid */
473 id->capability |= 3; /* LBA28, DMA */
474 id->command_set_2 |= 0x0400; /* LBA48 valid */
475 id->cfs_enable_2 |= 0x0400; /* LBA48 on */
476 /* Reporting logic */
477 printk(KERN_INFO "%s: IT8212 %sRAID %d volume",
479 idbits[147] ? "Bootable ":"",
482 printk("(%dK stripe)", idbits[146]);
485 /* Non RAID volume. Fixups to stop the core code
486 doing unsupported things */
487 id->field_valid &= 3;
489 id->command_set_1 = 0;
490 id->command_set_2 &= 0xC400;
492 id->cfs_enable_1 = 0;
493 id->cfs_enable_2 &= 0xC400;
494 id->csf_default &= 0xC000;
499 printk(KERN_INFO "%s: Performing identify fixups.\n",
504 * Set MWDMA0 mode as enabled/support - just to tell
505 * IDE core that DMA is supported (it821x hardware
506 * takes care of DMA mode programming).
508 if (id->capability & 1) {
509 id->dma_mword |= 0x0101;
510 drive->current_speed = XFER_MW_DMA_0;
516 static struct ide_dma_ops it821x_pass_through_dma_ops = {
517 .dma_host_set = ide_dma_host_set,
518 .dma_setup = ide_dma_setup,
519 .dma_exec_cmd = ide_dma_exec_cmd,
520 .dma_start = it821x_dma_start,
521 .dma_end = it821x_dma_end,
522 .dma_test_irq = ide_dma_test_irq,
523 .dma_timeout = ide_dma_timeout,
524 .dma_lost_irq = ide_dma_lost_irq,
528 * init_hwif_it821x - set up hwif structs
529 * @hwif: interface to set up
531 * We do the basic set up of the interface structure. The IT8212
532 * requires several custom handlers so we override the default
533 * ide DMA handlers appropriately
536 static void __devinit init_hwif_it821x(ide_hwif_t *hwif)
538 struct pci_dev *dev = to_pci_dev(hwif->dev);
539 struct ide_host *host = pci_get_drvdata(dev);
540 struct it821x_dev *itdevs = host->host_priv;
541 struct it821x_dev *idev = itdevs + hwif->channel;
544 ide_set_hwifdata(hwif, idev);
546 pci_read_config_byte(dev, 0x50, &conf);
549 hwif->host_flags |= IDE_HFLAG_NO_ATAPI_DMA;
550 /* Long I/O's although allowed in LBA48 space cause the
551 onboard firmware to enter the twighlight zone */
555 /* Pull the current clocks from 0x50 also */
556 if (conf & (1 << (1 + hwif->channel)))
557 idev->clock_mode = ATA_50;
559 idev->clock_mode = ATA_66;
561 idev->want[0][1] = ATA_ANY;
562 idev->want[1][1] = ATA_ANY;
565 * Not in the docs but according to the reference driver
569 pci_read_config_byte(dev, 0x08, &conf);
572 hwif->host_flags |= IDE_HFLAG_NO_ATAPI_DMA;
573 if (idev->smart == 0)
574 printk(KERN_WARNING DRV_NAME " %s: revision 0x10, "
575 "workarounds activated\n", pci_name(dev));
578 if (idev->smart == 0) {
579 /* MWDMA/PIO clock switching for pass through mode */
580 hwif->dma_ops = &it821x_pass_through_dma_ops;
582 hwif->host_flags |= IDE_HFLAG_NO_SET_MODE;
584 if (hwif->dma_base == 0)
587 hwif->ultra_mask = ATA_UDMA6;
588 hwif->mwdma_mask = ATA_MWDMA2;
591 static void __devinit it8212_disable_raid(struct pci_dev *dev)
593 /* Reset local CPU, and set BIOS not ready */
594 pci_write_config_byte(dev, 0x5E, 0x01);
596 /* Set to bypass mode, and reset PCI bus */
597 pci_write_config_byte(dev, 0x50, 0x00);
598 pci_write_config_word(dev, PCI_COMMAND,
599 PCI_COMMAND_PARITY | PCI_COMMAND_IO |
600 PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER);
601 pci_write_config_word(dev, 0x40, 0xA0F3);
603 pci_write_config_dword(dev,0x4C, 0x02040204);
604 pci_write_config_byte(dev, 0x42, 0x36);
605 pci_write_config_byte(dev, PCI_LATENCY_TIMER, 0x20);
608 static unsigned int __devinit init_chipset_it821x(struct pci_dev *dev)
611 static char *mode[2] = { "pass through", "smart" };
613 /* Force the card into bypass mode if so requested */
615 printk(KERN_INFO DRV_NAME " %s: forcing bypass mode\n",
617 it8212_disable_raid(dev);
619 pci_read_config_byte(dev, 0x50, &conf);
620 printk(KERN_INFO DRV_NAME " %s: controller in %s mode\n",
621 pci_name(dev), mode[conf & 1]);
625 static const struct ide_port_ops it821x_port_ops = {
626 /* it821x_set_{pio,dma}_mode() are only used in pass-through mode */
627 .set_pio_mode = it821x_set_pio_mode,
628 .set_dma_mode = it821x_set_dma_mode,
629 .quirkproc = it821x_quirkproc,
630 .cable_detect = it821x_cable_detect,
633 static const struct ide_port_info it821x_chipset __devinitdata = {
635 .init_chipset = init_chipset_it821x,
636 .init_hwif = init_hwif_it821x,
637 .port_ops = &it821x_port_ops,
638 .pio_mask = ATA_PIO4,
642 * it821x_init_one - pci layer discovery entry
644 * @id: ident table entry
646 * Called by the PCI code when it finds an ITE821x controller.
647 * We then use the IDE PCI generic helper to do most of the work.
650 static int __devinit it821x_init_one(struct pci_dev *dev, const struct pci_device_id *id)
652 struct it821x_dev *itdevs;
655 itdevs = kzalloc(2 * sizeof(*itdevs), GFP_KERNEL);
656 if (itdevs == NULL) {
657 printk(KERN_ERR DRV_NAME " %s: out of memory\n", pci_name(dev));
661 rc = ide_pci_init_one(dev, &it821x_chipset, itdevs);
668 static void __devexit it821x_remove(struct pci_dev *dev)
670 struct ide_host *host = pci_get_drvdata(dev);
671 struct it821x_dev *itdevs = host->host_priv;
677 static const struct pci_device_id it821x_pci_tbl[] = {
678 { PCI_VDEVICE(ITE, PCI_DEVICE_ID_ITE_8211), 0 },
679 { PCI_VDEVICE(ITE, PCI_DEVICE_ID_ITE_8212), 0 },
683 MODULE_DEVICE_TABLE(pci, it821x_pci_tbl);
685 static struct pci_driver driver = {
686 .name = "ITE821x IDE",
687 .id_table = it821x_pci_tbl,
688 .probe = it821x_init_one,
689 .remove = __devexit_p(it821x_remove),
692 static int __init it821x_ide_init(void)
694 return ide_pci_register_driver(&driver);
697 static void __exit it821x_ide_exit(void)
699 pci_unregister_driver(&driver);
702 module_init(it821x_ide_init);
703 module_exit(it821x_ide_exit);
705 module_param_named(noraid, it8212_noraid, int, S_IRUGO);
706 MODULE_PARM_DESC(noraid, "Force card into bypass mode");
708 MODULE_AUTHOR("Alan Cox");
709 MODULE_DESCRIPTION("PCI driver module for the ITE 821x");
710 MODULE_LICENSE("GPL");