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 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);
259 /* trim PIO to the slowest of the master/slave */
260 if (pair_pio
< set_pio
)
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
]);
274 return ide_config_drive_speed(drive
, XFER_PIO_0
+ set_pio
);
277 static void it821x_tuneproc(ide_drive_t
*drive
, u8 pio
)
279 pio
= ide_get_best_pio_mode(drive
, pio
, 4);
280 (void)it821x_tunepio(drive
, pio
);
284 * it821x_tune_mwdma - tune a channel for MWDMA
285 * @drive: drive to set up
286 * @mode_wanted: the target operating mode
288 * Load the timing settings for this device mode into the
289 * controller when doing MWDMA in pass through mode. The caller
290 * must manage the whole lack of per device MWDMA/PIO timings and
291 * the shared MWDMA/PIO timing register.
294 static void it821x_tune_mwdma (ide_drive_t
*drive
, byte mode_wanted
)
296 ide_hwif_t
*hwif
= drive
->hwif
;
297 struct it821x_dev
*itdev
= (void *)ide_get_hwifdata(hwif
);
298 int unit
= drive
->select
.b
.unit
;
299 int channel
= hwif
->channel
;
302 static u16 dma
[] = { 0x8866, 0x3222, 0x3121 };
303 static u8 mwdma_want
[] = { ATA_ANY
, ATA_66
, ATA_ANY
};
305 itdev
->want
[unit
][1] = mwdma_want
[mode_wanted
];
306 itdev
->want
[unit
][0] = 2; /* MWDMA is low priority */
307 itdev
->mwdma
[unit
] = dma
[mode_wanted
];
308 itdev
->udma
[unit
] = UDMA_OFF
;
310 /* UDMA bits off - Revision 0x10 do them in pairs */
311 pci_read_config_byte(hwif
->pci_dev
, 0x50, &conf
);
313 conf
|= channel
? 0x60: 0x18;
315 conf
|= 1 << (3 + 2 * channel
+ unit
);
316 pci_write_config_byte(hwif
->pci_dev
, 0x50, conf
);
318 it821x_clock_strategy(drive
);
319 /* FIXME: do we need to program this ? */
320 /* it821x_program(drive, itdev->mwdma[unit]); */
324 * it821x_tune_udma - tune a channel for UDMA
325 * @drive: drive to set up
326 * @mode_wanted: the target operating mode
328 * Load the timing settings for this device mode into the
329 * controller when doing UDMA modes in pass through.
332 static void it821x_tune_udma (ide_drive_t
*drive
, byte mode_wanted
)
334 ide_hwif_t
*hwif
= drive
->hwif
;
335 struct it821x_dev
*itdev
= ide_get_hwifdata(hwif
);
336 int unit
= drive
->select
.b
.unit
;
337 int channel
= hwif
->channel
;
340 static u16 udma
[] = { 0x4433, 0x4231, 0x3121, 0x2121, 0x1111, 0x2211, 0x1111 };
341 static u8 udma_want
[] = { ATA_ANY
, ATA_50
, ATA_ANY
, ATA_66
, ATA_66
, ATA_50
, ATA_66
};
343 itdev
->want
[unit
][1] = udma_want
[mode_wanted
];
344 itdev
->want
[unit
][0] = 3; /* UDMA is high priority */
345 itdev
->mwdma
[unit
] = MWDMA_OFF
;
346 itdev
->udma
[unit
] = udma
[mode_wanted
];
348 itdev
->udma
[unit
] |= 0x8080; /* UDMA 5/6 select on */
350 /* UDMA on. Again revision 0x10 must do the pair */
351 pci_read_config_byte(hwif
->pci_dev
, 0x50, &conf
);
353 conf
&= channel
? 0x9F: 0xE7;
355 conf
&= ~ (1 << (3 + 2 * channel
+ unit
));
356 pci_write_config_byte(hwif
->pci_dev
, 0x50, conf
);
358 it821x_clock_strategy(drive
);
359 it821x_program_udma(drive
, itdev
->udma
[unit
]);
364 * it821x_dma_read - DMA hook
365 * @drive: drive for DMA
367 * The IT821x has a single timing register for MWDMA and for PIO
368 * operations. As we flip back and forth we have to reload the
369 * clock. In addition the rev 0x10 device only works if the same
370 * timing value is loaded into the master and slave UDMA clock
371 * so we must also reload that.
373 * FIXME: we could figure out in advance if we need to do reloads
376 static void it821x_dma_start(ide_drive_t
*drive
)
378 ide_hwif_t
*hwif
= drive
->hwif
;
379 struct it821x_dev
*itdev
= ide_get_hwifdata(hwif
);
380 int unit
= drive
->select
.b
.unit
;
381 if(itdev
->mwdma
[unit
] != MWDMA_OFF
)
382 it821x_program(drive
, itdev
->mwdma
[unit
]);
383 else if(itdev
->udma
[unit
] != UDMA_OFF
&& itdev
->timing10
)
384 it821x_program_udma(drive
, itdev
->udma
[unit
]);
385 ide_dma_start(drive
);
389 * it821x_dma_write - DMA hook
390 * @drive: drive for DMA stop
392 * The IT821x has a single timing register for MWDMA and for PIO
393 * operations. As we flip back and forth we have to reload the
397 static int it821x_dma_end(ide_drive_t
*drive
)
399 ide_hwif_t
*hwif
= drive
->hwif
;
400 int unit
= drive
->select
.b
.unit
;
401 struct it821x_dev
*itdev
= ide_get_hwifdata(hwif
);
402 int ret
= __ide_dma_end(drive
);
403 if(itdev
->mwdma
[unit
] != MWDMA_OFF
)
404 it821x_program(drive
, itdev
->pio
[unit
]);
410 * it821x_tune_chipset - set controller timings
411 * @drive: Drive to set up
412 * @xferspeed: speed we want to achieve
414 * Tune the ITE chipset for the desired mode. If we can't achieve
415 * the desired mode then tune for a lower one, but ultimately
416 * make the thing work.
419 static int it821x_tune_chipset (ide_drive_t
*drive
, byte xferspeed
)
422 ide_hwif_t
*hwif
= drive
->hwif
;
423 struct it821x_dev
*itdev
= ide_get_hwifdata(hwif
);
424 u8 speed
= ide_rate_filter(drive
, xferspeed
);
432 return it821x_tunepio(drive
, speed
- XFER_PIO_0
);
435 if (itdev
->smart
== 0) {
437 /* MWDMA tuning is really hard because our MWDMA and PIO
438 timings are kept in the same place. We can switch in the
439 host dma on/off callbacks */
443 it821x_tune_mwdma(drive
, (speed
- XFER_MW_DMA_0
));
452 it821x_tune_udma(drive
, (speed
- XFER_UDMA_0
));
458 return ide_config_drive_speed(drive
, speed
);
461 /* don't touch anything in the smart mode */
466 * it821x_configure_drive_for_dma - set up for DMA transfers
467 * @drive: drive we are going to set up
469 * Set up the drive for DMA, tune the controller and drive as
470 * required. If the drive isn't suitable for DMA or we hit
471 * other problems then we will drop down to PIO and set up
475 static int it821x_config_drive_for_dma (ide_drive_t
*drive
)
477 if (ide_tune_dma(drive
))
480 it821x_tuneproc(drive
, 255);
486 * ata66_it821x - check for 80 pin cable
487 * @hwif: interface to check
489 * Check for the presence of an ATA66 capable cable on the
490 * interface. Problematic as it seems some cards don't have
491 * the needed logic onboard.
494 static u8 __devinit
ata66_it821x(ide_hwif_t
*hwif
)
496 /* The reference driver also only does disk side */
497 return ATA_CBL_PATA80
;
501 * it821x_fixup - post init callback
504 * This callback is run after the drives have been probed but
505 * before anything gets attached. It allows drivers to do any
506 * final tuning that is needed, or fixups to work around bugs.
509 static void __devinit
it821x_fixups(ide_hwif_t
*hwif
)
511 struct it821x_dev
*itdev
= ide_get_hwifdata(hwif
);
516 * If we are in pass through mode then not much
517 * needs to be done, but we do bother to clear the
518 * IRQ mask as we may well be in PIO (eg rev 0x10)
519 * for now and we know unmasking is safe on this chipset.
521 for (i
= 0; i
< 2; i
++) {
522 ide_drive_t
*drive
= &hwif
->drives
[i
];
529 * Perform fixups on smart mode. We need to "lose" some
530 * capabilities the firmware lacks but does not filter, and
531 * also patch up some capability bits that it forgets to set
535 for(i
= 0; i
< 2; i
++) {
536 ide_drive_t
*drive
= &hwif
->drives
[i
];
537 struct hd_driveid
*id
;
543 idbits
= (u16
*)drive
->id
;
545 /* Check for RAID v native */
546 if(strstr(id
->model
, "Integrated Technology Express")) {
547 /* In raid mode the ident block is slightly buggy
548 We need to set the bits so that the IDE layer knows
549 LBA28. LBA48 and DMA ar valid */
550 id
->capability
|= 3; /* LBA28, DMA */
551 id
->command_set_2
|= 0x0400; /* LBA48 valid */
552 id
->cfs_enable_2
|= 0x0400; /* LBA48 on */
553 /* Reporting logic */
554 printk(KERN_INFO
"%s: IT8212 %sRAID %d volume",
556 idbits
[147] ? "Bootable ":"",
559 printk("(%dK stripe)", idbits
[146]);
562 /* Non RAID volume. Fixups to stop the core code
563 doing unsupported things */
564 id
->field_valid
&= 3;
566 id
->command_set_1
= 0;
567 id
->command_set_2
&= 0xC400;
569 id
->cfs_enable_1
= 0;
570 id
->cfs_enable_2
&= 0xC400;
571 id
->csf_default
&= 0xC000;
576 printk(KERN_INFO
"%s: Performing identify fixups.\n",
581 * Set MWDMA0 mode as enabled/support - just to tell
582 * IDE core that DMA is supported (it821x hardware
583 * takes care of DMA mode programming).
585 if (id
->capability
& 1) {
586 id
->dma_mword
|= 0x0101;
587 drive
->current_speed
= XFER_MW_DMA_0
;
594 * init_hwif_it821x - set up hwif structs
595 * @hwif: interface to set up
597 * We do the basic set up of the interface structure. The IT8212
598 * requires several custom handlers so we override the default
599 * ide DMA handlers appropriately
602 static void __devinit
init_hwif_it821x(ide_hwif_t
*hwif
)
604 struct it821x_dev
*idev
= kzalloc(sizeof(struct it821x_dev
), GFP_KERNEL
);
608 printk(KERN_ERR
"it821x: out of memory, falling back to legacy behaviour.\n");
611 ide_set_hwifdata(hwif
, idev
);
615 pci_read_config_byte(hwif
->pci_dev
, 0x50, &conf
);
619 /* Long I/O's although allowed in LBA48 space cause the
620 onboard firmware to enter the twighlight zone */
624 /* Pull the current clocks from 0x50 also */
625 if (conf
& (1 << (1 + hwif
->channel
)))
626 idev
->clock_mode
= ATA_50
;
628 idev
->clock_mode
= ATA_66
;
630 idev
->want
[0][1] = ATA_ANY
;
631 idev
->want
[1][1] = ATA_ANY
;
634 * Not in the docs but according to the reference driver
635 * this is neccessary.
638 pci_read_config_byte(hwif
->pci_dev
, 0x08, &conf
);
643 printk(KERN_WARNING
"it821x: Revision 0x10, workarounds activated.\n");
646 hwif
->speedproc
= &it821x_tune_chipset
;
647 hwif
->tuneproc
= &it821x_tuneproc
;
649 /* MWDMA/PIO clock switching for pass through mode */
651 hwif
->dma_start
= &it821x_dma_start
;
652 hwif
->ide_dma_end
= &it821x_dma_end
;
655 hwif
->drives
[0].autotune
= 1;
656 hwif
->drives
[1].autotune
= 1;
661 hwif
->ultra_mask
= 0x7f;
662 hwif
->mwdma_mask
= 0x07;
664 hwif
->ide_dma_check
= &it821x_config_drive_for_dma
;
666 if (hwif
->cbl
!= ATA_CBL_PATA40_SHORT
)
667 hwif
->cbl
= ata66_it821x(hwif
);
670 * The BIOS often doesn't set up DMA on this controller
671 * so we always do it.
675 hwif
->drives
[0].autodma
= hwif
->autodma
;
676 hwif
->drives
[1].autodma
= hwif
->autodma
;
683 static void __devinit
it8212_disable_raid(struct pci_dev
*dev
)
685 /* Reset local CPU, and set BIOS not ready */
686 pci_write_config_byte(dev
, 0x5E, 0x01);
688 /* Set to bypass mode, and reset PCI bus */
689 pci_write_config_byte(dev
, 0x50, 0x00);
690 pci_write_config_word(dev
, PCI_COMMAND
,
691 PCI_COMMAND_PARITY
| PCI_COMMAND_IO
|
692 PCI_COMMAND_MEMORY
| PCI_COMMAND_MASTER
);
693 pci_write_config_word(dev
, 0x40, 0xA0F3);
695 pci_write_config_dword(dev
,0x4C, 0x02040204);
696 pci_write_config_byte(dev
, 0x42, 0x36);
697 pci_write_config_byte(dev
, PCI_LATENCY_TIMER
, 0x20);
700 static unsigned int __devinit
init_chipset_it821x(struct pci_dev
*dev
, const char *name
)
703 static char *mode
[2] = { "pass through", "smart" };
705 /* Force the card into bypass mode if so requested */
707 printk(KERN_INFO
"it8212: forcing bypass mode.\n");
708 it8212_disable_raid(dev
);
710 pci_read_config_byte(dev
, 0x50, &conf
);
711 printk(KERN_INFO
"it821x: controller in %s mode.\n", mode
[conf
& 1]);
716 #define DECLARE_ITE_DEV(name_str) \
719 .init_chipset = init_chipset_it821x, \
720 .init_hwif = init_hwif_it821x, \
721 .autodma = AUTODMA, \
722 .bootable = ON_BOARD, \
723 .fixup = it821x_fixups, \
724 .pio_mask = ATA_PIO4, \
727 static ide_pci_device_t it821x_chipsets
[] __devinitdata
= {
728 /* 0 */ DECLARE_ITE_DEV("IT8212"),
732 * it821x_init_one - pci layer discovery entry
734 * @id: ident table entry
736 * Called by the PCI code when it finds an ITE821x controller.
737 * We then use the IDE PCI generic helper to do most of the work.
740 static int __devinit
it821x_init_one(struct pci_dev
*dev
, const struct pci_device_id
*id
)
742 ide_setup_pci_device(dev
, &it821x_chipsets
[id
->driver_data
]);
746 static struct pci_device_id it821x_pci_tbl
[] = {
747 { PCI_VENDOR_ID_ITE
, PCI_DEVICE_ID_ITE_8211
, PCI_ANY_ID
, PCI_ANY_ID
, 0, 0, 0},
748 { PCI_VENDOR_ID_ITE
, PCI_DEVICE_ID_ITE_8212
, PCI_ANY_ID
, PCI_ANY_ID
, 0, 0, 0},
752 MODULE_DEVICE_TABLE(pci
, it821x_pci_tbl
);
754 static struct pci_driver driver
= {
755 .name
= "ITE821x IDE",
756 .id_table
= it821x_pci_tbl
,
757 .probe
= it821x_init_one
,
760 static int __init
it821x_ide_init(void)
762 return ide_pci_register_driver(&driver
);
765 module_init(it821x_ide_init
);
767 module_param_named(noraid
, it8212_noraid
, int, S_IRUGO
);
768 MODULE_PARM_DESC(it8212_noraid
, "Force card into bypass mode");
770 MODULE_AUTHOR("Alan Cox");
771 MODULE_DESCRIPTION("PCI driver module for the ITE 821x");
772 MODULE_LICENSE("GPL");