ide: rework the code for selecting the best DMA transfer mode (v3)
[safe/jmp/linux-2.6] / drivers / ide / pci / it8213.c
1 /*
2  * ITE 8213 IDE driver
3  *
4  * Copyright (C) 2006 Jack Lee
5  * Copyright (C) 2006 Alan Cox
6  * Copyright (C) 2007 Bartlomiej Zolnierkiewicz
7  */
8
9 #include <linux/kernel.h>
10 #include <linux/types.h>
11 #include <linux/module.h>
12 #include <linux/pci.h>
13 #include <linux/delay.h>
14 #include <linux/hdreg.h>
15 #include <linux/ide.h>
16 #include <linux/init.h>
17
18 #include <asm/io.h>
19
20 /**
21  *      it8213_dma_2_pio                -       return the PIO mode matching DMA
22  *      @xfer_rate: transfer speed
23  *
24  *      Returns the nearest equivalent PIO timing for the PIO or DMA
25  *      mode requested by the controller.
26  */
27
28 static u8 it8213_dma_2_pio (u8 xfer_rate) {
29         switch(xfer_rate) {
30                 case XFER_UDMA_6:
31                 case XFER_UDMA_5:
32                 case XFER_UDMA_4:
33                 case XFER_UDMA_3:
34                 case XFER_UDMA_2:
35                 case XFER_UDMA_1:
36                 case XFER_UDMA_0:
37                 case XFER_MW_DMA_2:
38                 case XFER_PIO_4:
39                         return 4;
40                 case XFER_MW_DMA_1:
41                 case XFER_PIO_3:
42                         return 3;
43                 case XFER_SW_DMA_2:
44                 case XFER_PIO_2:
45                         return 2;
46                 case XFER_MW_DMA_0:
47                 case XFER_SW_DMA_1:
48                 case XFER_SW_DMA_0:
49                 case XFER_PIO_1:
50                 case XFER_PIO_0:
51                 case XFER_PIO_SLOW:
52                 default:
53                         return 0;
54         }
55 }
56
57 /*
58  *      it8213_tuneproc -       tune a drive
59  *      @drive: drive to tune
60  *      @pio: desired PIO mode
61  *
62  *      Set the interface PIO mode.
63  */
64
65 static void it8213_tuneproc (ide_drive_t *drive, u8 pio)
66 {
67         ide_hwif_t *hwif        = HWIF(drive);
68         struct pci_dev *dev     = hwif->pci_dev;
69         int is_slave            = drive->dn & 1;
70         int master_port         = 0x40;
71         int slave_port          = 0x44;
72         unsigned long flags;
73         u16 master_data;
74         u8 slave_data;
75         static DEFINE_SPINLOCK(tune_lock);
76         int control = 0;
77
78         static const u8 timings[][2]= {
79                                         { 0, 0 },
80                                         { 0, 0 },
81                                         { 1, 0 },
82                                         { 2, 1 },
83                                         { 2, 3 }, };
84
85         pio = ide_get_best_pio_mode(drive, pio, 4, NULL);
86
87         spin_lock_irqsave(&tune_lock, flags);
88         pci_read_config_word(dev, master_port, &master_data);
89
90         if (pio > 1)
91                 control |= 1;   /* Programmable timing on */
92         if (drive->media != ide_disk)
93                 control |= 4;   /* ATAPI */
94         if (pio > 2)
95                 control |= 2;   /* IORDY */
96         if (is_slave) {
97                 master_data |=  0x4000;
98                 master_data &= ~0x0070;
99                 if (pio > 1)
100                         master_data = master_data | (control << 4);
101                 pci_read_config_byte(dev, slave_port, &slave_data);
102                 slave_data = slave_data & 0xf0;
103                 slave_data = slave_data | (timings[pio][0] << 2) | timings[pio][1];
104         } else {
105                 master_data &= ~0x3307;
106                 if (pio > 1)
107                         master_data = master_data | control;
108                 master_data = master_data | (timings[pio][0] << 12) | (timings[pio][1] << 8);
109         }
110         pci_write_config_word(dev, master_port, master_data);
111         if (is_slave)
112                 pci_write_config_byte(dev, slave_port, slave_data);
113         spin_unlock_irqrestore(&tune_lock, flags);
114 }
115
116 /**
117  *      it8213_tune_chipset     -       set controller timings
118  *      @drive: Drive to set up
119  *      @xferspeed: speed we want to achieve
120  *
121  *      Tune the ITE chipset for the desired mode. If we can't achieve
122  *      the desired mode then tune for a lower one, but ultimately
123  *      make the thing work.
124  */
125
126 static int it8213_tune_chipset (ide_drive_t *drive, u8 xferspeed)
127 {
128
129         ide_hwif_t *hwif        = HWIF(drive);
130         struct pci_dev *dev     = hwif->pci_dev;
131         u8 maslave              = 0x40;
132         u8 speed                = ide_rate_filter(drive, xferspeed);
133         int a_speed             = 3 << (drive->dn * 4);
134         int u_flag              = 1 << drive->dn;
135         int v_flag              = 0x01 << drive->dn;
136         int w_flag              = 0x10 << drive->dn;
137         int u_speed             = 0;
138         u16                     reg4042, reg4a;
139         u8                      reg48, reg54, reg55;
140
141         pci_read_config_word(dev, maslave, &reg4042);
142         pci_read_config_byte(dev, 0x48, &reg48);
143         pci_read_config_word(dev, 0x4a, &reg4a);
144         pci_read_config_byte(dev, 0x54, &reg54);
145         pci_read_config_byte(dev, 0x55, &reg55);
146
147         switch(speed) {
148                 case XFER_UDMA_6:
149                 case XFER_UDMA_4:
150                 case XFER_UDMA_2:       u_speed = 2 << (drive->dn * 4); break;
151                 case XFER_UDMA_5:
152                 case XFER_UDMA_3:
153                 case XFER_UDMA_1:       u_speed = 1 << (drive->dn * 4); break;
154                 case XFER_UDMA_0:       u_speed = 0 << (drive->dn * 4); break;
155                         break;
156                 case XFER_MW_DMA_2:
157                 case XFER_MW_DMA_1:
158                 case XFER_SW_DMA_2:
159                         break;
160                 case XFER_PIO_4:
161                 case XFER_PIO_3:
162                 case XFER_PIO_2:
163                 case XFER_PIO_1:
164                 case XFER_PIO_0:
165                         break;
166                 default:
167                         return -1;
168         }
169
170         if (speed >= XFER_UDMA_0) {
171                 if (!(reg48 & u_flag))
172                         pci_write_config_byte(dev, 0x48, reg48 | u_flag);
173                 if (speed >= XFER_UDMA_5) {
174                         pci_write_config_byte(dev, 0x55, (u8) reg55|w_flag);
175                 } else {
176                         pci_write_config_byte(dev, 0x55, (u8) reg55 & ~w_flag);
177                 }
178
179                 if ((reg4a & a_speed) != u_speed)
180                         pci_write_config_word(dev, 0x4a, (reg4a & ~a_speed) | u_speed);
181                 if (speed > XFER_UDMA_2) {
182                         if (!(reg54 & v_flag))
183                                 pci_write_config_byte(dev, 0x54, reg54 | v_flag);
184                 } else
185                         pci_write_config_byte(dev, 0x54, reg54 & ~v_flag);
186         } else {
187                 if (reg48 & u_flag)
188                         pci_write_config_byte(dev, 0x48, reg48 & ~u_flag);
189                 if (reg4a & a_speed)
190                         pci_write_config_word(dev, 0x4a, reg4a & ~a_speed);
191                 if (reg54 & v_flag)
192                         pci_write_config_byte(dev, 0x54, reg54 & ~v_flag);
193                 if (reg55 & w_flag)
194                         pci_write_config_byte(dev, 0x55, (u8) reg55 & ~w_flag);
195         }
196         it8213_tuneproc(drive, it8213_dma_2_pio(speed));
197         return ide_config_drive_speed(drive, speed);
198 }
199
200 /*
201  *      config_chipset_for_dma  -       configure for DMA
202  *      @drive: drive to configure
203  *
204  *      Called by the IDE layer when it wants the timings set up.
205  */
206
207 static int config_chipset_for_dma (ide_drive_t *drive)
208 {
209         u8 speed = ide_max_dma_mode(drive);
210
211         if (!speed)
212                 return 0;
213
214         it8213_tune_chipset(drive, speed);
215
216         return ide_dma_enable(drive);
217 }
218
219 /**
220  *      it8213_configure_drive_for_dma  -       set up for DMA transfers
221  *      @drive: drive we are going to set up
222  *
223  *      Set up the drive for DMA, tune the controller and drive as
224  *      required. If the drive isn't suitable for DMA or we hit
225  *      other problems then we will drop down to PIO and set up
226  *      PIO appropriately
227  */
228
229 static int it8213_config_drive_for_dma (ide_drive_t *drive)
230 {
231         u8 pio;
232
233         if (ide_use_dma(drive) && config_chipset_for_dma(drive))
234                 return 0;
235
236         pio = ide_get_best_pio_mode(drive, 255, 4, NULL);
237         it8213_tune_chipset(drive, XFER_PIO_0 + pio);
238
239         return -1;
240 }
241
242 /**
243  *      init_hwif_it8213        -       set up hwif structs
244  *      @hwif: interface to set up
245  *
246  *      We do the basic set up of the interface structure. The IT8212
247  *      requires several custom handlers so we override the default
248  *      ide DMA handlers appropriately
249  */
250
251 static void __devinit init_hwif_it8213(ide_hwif_t *hwif)
252 {
253         u8 reg42h = 0, ata66 = 0;
254
255         hwif->speedproc = &it8213_tune_chipset;
256         hwif->tuneproc  = &it8213_tuneproc;
257
258         hwif->autodma = 0;
259
260         hwif->drives[0].autotune = 1;
261         hwif->drives[1].autotune = 1;
262
263         if (!hwif->dma_base)
264                 return;
265
266         hwif->atapi_dma = 1;
267         hwif->ultra_mask = 0x7f;
268         hwif->mwdma_mask = 0x06;
269         hwif->swdma_mask = 0x04;
270
271         pci_read_config_byte(hwif->pci_dev, 0x42, &reg42h);
272         ata66 = (reg42h & 0x02) ? 0 : 1;
273
274         hwif->ide_dma_check = &it8213_config_drive_for_dma;
275         if (!(hwif->udma_four))
276                 hwif->udma_four = ata66;
277
278         /*
279          *      The BIOS often doesn't set up DMA on this controller
280          *      so we always do it.
281          */
282         if (!noautodma)
283                 hwif->autodma = 1;
284
285         hwif->drives[0].autodma = hwif->autodma;
286         hwif->drives[1].autodma = hwif->autodma;
287 }
288
289
290 #define DECLARE_ITE_DEV(name_str)                       \
291         {                                               \
292                 .name           = name_str,             \
293                 .init_hwif      = init_hwif_it8213,     \
294                 .channels       = 1,                    \
295                 .autodma        = AUTODMA,              \
296                 .enablebits     = {{0x41,0x80,0x80}}, \
297                 .bootable       = ON_BOARD,             \
298         }
299
300 static ide_pci_device_t it8213_chipsets[] __devinitdata = {
301         /* 0 */ DECLARE_ITE_DEV("IT8213"),
302 };
303
304
305 /**
306  *      it8213_init_one -       pci layer discovery entry
307  *      @dev: PCI device
308  *      @id: ident table entry
309  *
310  *      Called by the PCI code when it finds an ITE8213 controller. As
311  *      this device follows the standard interfaces we can use the
312  *      standard helper functions to do almost all the work for us.
313  */
314
315 static int __devinit it8213_init_one(struct pci_dev *dev, const struct pci_device_id *id)
316 {
317         ide_setup_pci_device(dev, &it8213_chipsets[id->driver_data]);
318         return 0;
319 }
320
321
322 static struct pci_device_id it8213_pci_tbl[] = {
323         { PCI_VENDOR_ID_ITE, 0x8213, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 },
324         { 0, },
325 };
326
327 MODULE_DEVICE_TABLE(pci, it8213_pci_tbl);
328
329 static struct pci_driver driver = {
330         .name           = "ITE8213_IDE",
331         .id_table       = it8213_pci_tbl,
332         .probe          = it8213_init_one,
333 };
334
335 static int __init it8213_ide_init(void)
336 {
337         return ide_pci_register_driver(&driver);
338 }
339
340 module_init(it8213_ide_init);
341
342 MODULE_AUTHOR("Jack Lee, Alan Cox");
343 MODULE_DESCRIPTION("PCI driver module for the ITE 8213");
344 MODULE_LICENSE("GPL");