2 * linux/drivers/ide/pci/sis5513.c Version 0.31 Aug 9, 2007
4 * Copyright (C) 1999-2000 Andre Hedrick <andre@linux-ide.org>
5 * Copyright (C) 2002 Lionel Bouton <Lionel.Bouton@inet6.fr>, Maintainer
6 * Copyright (C) 2003 Vojtech Pavlik <vojtech@suse.cz>
7 * Copyright (C) 2007 Bartlomiej Zolnierkiewicz
9 * May be copied or modified under the terms of the GNU General Public License
14 * SiS Taiwan : for direct support and hardware.
15 * Daniela Engert : for initial ATA100 advices and numerous others.
16 * John Fremlin, Manfred Spraul, Dave Morgan, Peter Kjellerstedt :
17 * for checking code correctness, providing patches.
20 * Original tests and design on the SiS620 chipset.
21 * ATA100 tests and design on the SiS735 chipset.
22 * ATA16/33 support from specs
23 * ATA133 support for SiS961/962 by L.C. Chang <lcchang@sis.com.tw>
24 * ATA133 961/962/963 fixes by Vojtech Pavlik <vojtech@suse.cz>
27 * SiS chipset documentation available under NDA to companies only
28 * (not to individuals).
32 * The original SiS5513 comes from a SiS5511/55112/5513 chipset. The original
33 * SiS5513 was also used in the SiS5596/5513 chipset. Thus if we see a SiS5511
34 * or SiS5596, we can assume we see the first MWDMA-16 capable SiS5513 chip.
36 * Later SiS chipsets integrated the 5513 functionality into the NorthBridge,
37 * starting with SiS5571 and up to SiS745. The PCI ID didn't change, though. We
38 * can figure out that we have a more modern and more capable 5513 by looking
39 * for the respective NorthBridge IDs.
41 * Even later (96x family) SiS chipsets use the MuTIOL link and place the 5513
42 * into the SouthBrige. Here we cannot rely on looking up the NorthBridge PCI
43 * ID, while the now ATA-133 capable 5513 still has the same PCI ID.
44 * Fortunately the 5513 can be 'unmasked' by fiddling with some config space
45 * bits, changing its device id to the true one - 5517 for 961 and 5518 for
49 #include <linux/types.h>
50 #include <linux/module.h>
51 #include <linux/kernel.h>
52 #include <linux/delay.h>
53 #include <linux/timer.h>
55 #include <linux/ioport.h>
56 #include <linux/blkdev.h>
57 #include <linux/hdreg.h>
59 #include <linux/interrupt.h>
60 #include <linux/pci.h>
61 #include <linux/init.h>
62 #include <linux/ide.h>
66 #include "ide-timing.h"
68 /* registers layout and init values are chipset family dependant */
73 #define ATA_100a 0x04 // SiS730/SiS550 is ATA100 with ATA66 layout
75 #define ATA_133a 0x06 // SiS961b with 133 support
76 #define ATA_133 0x07 // SiS962/963
78 static u8 chipset_family
;
88 } SiSHostChipInfo
[] = {
89 { "SiS968", PCI_DEVICE_ID_SI_968
, ATA_133
},
90 { "SiS966", PCI_DEVICE_ID_SI_966
, ATA_133
},
91 { "SiS965", PCI_DEVICE_ID_SI_965
, ATA_133
},
92 { "SiS745", PCI_DEVICE_ID_SI_745
, ATA_100
},
93 { "SiS735", PCI_DEVICE_ID_SI_735
, ATA_100
},
94 { "SiS733", PCI_DEVICE_ID_SI_733
, ATA_100
},
95 { "SiS635", PCI_DEVICE_ID_SI_635
, ATA_100
},
96 { "SiS633", PCI_DEVICE_ID_SI_633
, ATA_100
},
98 { "SiS730", PCI_DEVICE_ID_SI_730
, ATA_100a
},
99 { "SiS550", PCI_DEVICE_ID_SI_550
, ATA_100a
},
101 { "SiS640", PCI_DEVICE_ID_SI_640
, ATA_66
},
102 { "SiS630", PCI_DEVICE_ID_SI_630
, ATA_66
},
103 { "SiS620", PCI_DEVICE_ID_SI_620
, ATA_66
},
104 { "SiS540", PCI_DEVICE_ID_SI_540
, ATA_66
},
105 { "SiS530", PCI_DEVICE_ID_SI_530
, ATA_66
},
107 { "SiS5600", PCI_DEVICE_ID_SI_5600
, ATA_33
},
108 { "SiS5598", PCI_DEVICE_ID_SI_5598
, ATA_33
},
109 { "SiS5597", PCI_DEVICE_ID_SI_5597
, ATA_33
},
110 { "SiS5591/2", PCI_DEVICE_ID_SI_5591
, ATA_33
},
111 { "SiS5582", PCI_DEVICE_ID_SI_5582
, ATA_33
},
112 { "SiS5581", PCI_DEVICE_ID_SI_5581
, ATA_33
},
114 { "SiS5596", PCI_DEVICE_ID_SI_5596
, ATA_16
},
115 { "SiS5571", PCI_DEVICE_ID_SI_5571
, ATA_16
},
116 { "SiS5517", PCI_DEVICE_ID_SI_5517
, ATA_16
},
117 { "SiS551x", PCI_DEVICE_ID_SI_5511
, ATA_16
},
120 /* Cycle time bits and values vary across chip dma capabilities
121 These three arrays hold the register layout and the values to set.
122 Indexed by chipset_family and (dma_mode - XFER_UDMA_0) */
124 /* {0, ATA_16, ATA_33, ATA_66, ATA_100a, ATA_100, ATA_133} */
125 static u8 cycle_time_offset
[] = {0,0,5,4,4,0,0};
126 static u8 cycle_time_range
[] = {0,0,2,3,3,4,4};
127 static u8 cycle_time_value
[][XFER_UDMA_6
- XFER_UDMA_0
+ 1] = {
128 {0,0,0,0,0,0,0}, /* no udma */
129 {0,0,0,0,0,0,0}, /* no udma */
130 {3,2,1,0,0,0,0}, /* ATA_33 */
131 {7,5,3,2,1,0,0}, /* ATA_66 */
132 {7,5,3,2,1,0,0}, /* ATA_100a (730 specific), differences are on cycle_time range and offset */
133 {11,7,5,4,2,1,0}, /* ATA_100 */
134 {15,10,7,5,3,2,1}, /* ATA_133a (earliest 691 southbridges) */
135 {15,10,7,5,3,2,1}, /* ATA_133 */
137 /* CRC Valid Setup Time vary across IDE clock setting 33/66/100/133
138 See SiS962 data sheet for more detail */
139 static u8 cvs_time_value
[][XFER_UDMA_6
- XFER_UDMA_0
+ 1] = {
140 {0,0,0,0,0,0,0}, /* no udma */
141 {0,0,0,0,0,0,0}, /* no udma */
149 /* Initialize time, Active time, Recovery time vary across
150 IDE clock settings. These 3 arrays hold the register value
151 for PIO0/1/2/3/4 and DMA0/1/2 mode in order */
152 static u8 ini_time_value
[][8] = {
162 static u8 act_time_value
[][8] = {
166 {19,19,19,5,4,14,5,4},
167 {19,19,19,5,4,14,5,4},
168 {28,28,28,7,6,21,7,6},
169 {38,38,38,10,9,28,10,9},
170 {38,38,38,10,9,28,10,9},
172 static u8 rco_time_value
[][8] = {
179 {40,12,4,12,5,34,12,5},
180 {40,12,4,12,5,34,12,5},
184 * Printing configuration
186 /* Used for chipset type printing at boot time */
187 static char* chipset_capability
[] = {
190 "ATA 100 (1st gen)", "ATA 100 (2nd gen)",
191 "ATA 133 (1st gen)", "ATA 133 (2nd gen)"
195 * Configuration functions
198 static u8
sis_ata133_get_base(ide_drive_t
*drive
)
200 struct pci_dev
*dev
= drive
->hwif
->pci_dev
;
203 pci_read_config_dword(dev
, 0x54, ®54
);
205 return ((reg54
& 0x40000000) ? 0x70 : 0x40) + drive
->dn
* 4;
208 static void sis_ata16_program_timings(ide_drive_t
*drive
, const u8 mode
)
210 struct pci_dev
*dev
= drive
->hwif
->pci_dev
;
212 u8 drive_pci
= 0x40 + drive
->dn
* 2;
214 const u16 pio_timings
[] = { 0x000, 0x607, 0x404, 0x303, 0x301 };
215 const u16 mwdma_timings
[] = { 0x008, 0x302, 0x301 };
217 pci_read_config_word(dev
, drive_pci
, &t1
);
219 /* clear active/recovery timings */
221 if (mode
>= XFER_MW_DMA_0
) {
222 if (chipset_family
> ATA_16
)
223 t1
&= ~0x8000; /* disable UDMA */
224 t1
|= mwdma_timings
[mode
- XFER_MW_DMA_0
];
226 t1
|= pio_timings
[mode
- XFER_PIO_0
];
228 pci_write_config_word(dev
, drive_pci
, t1
);
231 static void sis_ata100_program_timings(ide_drive_t
*drive
, const u8 mode
)
233 struct pci_dev
*dev
= drive
->hwif
->pci_dev
;
234 u8 t1
, drive_pci
= 0x40 + drive
->dn
* 2;
236 /* timing bits: 7:4 active 3:0 recovery */
237 const u8 pio_timings
[] = { 0x00, 0x67, 0x44, 0x33, 0x31 };
238 const u8 mwdma_timings
[] = { 0x08, 0x32, 0x31 };
240 if (mode
>= XFER_MW_DMA_0
) {
243 pci_read_config_byte(dev
, drive_pci
, &t2
);
244 t2
&= ~0x80; /* disable UDMA */
245 pci_write_config_byte(dev
, drive_pci
, t2
);
247 t1
= mwdma_timings
[mode
- XFER_MW_DMA_0
];
249 t1
= pio_timings
[mode
- XFER_PIO_0
];
251 pci_write_config_byte(dev
, drive_pci
+ 1, t1
);
254 static void sis_ata133_program_timings(ide_drive_t
*drive
, const u8 mode
)
256 struct pci_dev
*dev
= drive
->hwif
->pci_dev
;
258 u8 drive_pci
= sis_ata133_get_base(drive
), clk
, idx
;
260 pci_read_config_dword(dev
, drive_pci
, &t1
);
263 clk
= (t1
& 0x08) ? ATA_133
: ATA_100
;
264 if (mode
>= XFER_MW_DMA_0
) {
265 t1
&= ~0x04; /* disable UDMA */
266 idx
= mode
- XFER_MW_DMA_0
+ 5;
268 idx
= mode
- XFER_PIO_0
;
269 t1
|= ini_time_value
[clk
][idx
] << 12;
270 t1
|= act_time_value
[clk
][idx
] << 16;
271 t1
|= rco_time_value
[clk
][idx
] << 24;
273 pci_write_config_dword(dev
, drive_pci
, t1
);
276 static void sis_program_timings(ide_drive_t
*drive
, const u8 mode
)
278 if (chipset_family
< ATA_100
) /* ATA_16/33/66/100a */
279 sis_ata16_program_timings(drive
, mode
);
280 else if (chipset_family
< ATA_133
) /* ATA_100/133a */
281 sis_ata100_program_timings(drive
, mode
);
283 sis_ata133_program_timings(drive
, mode
);
286 static void config_drive_art_rwp (ide_drive_t
*drive
)
288 ide_hwif_t
*hwif
= HWIF(drive
);
289 struct pci_dev
*dev
= hwif
->pci_dev
;
293 pci_read_config_byte(dev
, 0x4b, ®4bh
);
295 if (drive
->media
== ide_disk
)
296 rw_prefetch
= 0x11 << drive
->dn
;
298 if ((reg4bh
& (0x11 << drive
->dn
)) != rw_prefetch
)
299 pci_write_config_byte(dev
, 0x4b, reg4bh
|rw_prefetch
);
302 static void sis_set_pio_mode(ide_drive_t
*drive
, const u8 pio
)
304 config_drive_art_rwp(drive
);
305 sis_program_timings(drive
, XFER_PIO_0
+ pio
);
308 static void sis_ata133_program_udma_timings(ide_drive_t
*drive
, const u8 mode
)
310 struct pci_dev
*dev
= drive
->hwif
->pci_dev
;
312 u8 drive_pci
= sis_ata133_get_base(drive
), clk
, idx
;
314 pci_read_config_dword(dev
, drive_pci
, ®dw
);
318 /* check if ATA133 enable */
319 clk
= (regdw
& 0x08) ? ATA_133
: ATA_100
;
320 idx
= mode
- XFER_UDMA_0
;
321 regdw
|= cycle_time_value
[clk
][idx
] << 4;
322 regdw
|= cvs_time_value
[clk
][idx
] << 8;
324 pci_write_config_dword(dev
, drive_pci
, regdw
);
327 static void sis_ata33_program_udma_timings(ide_drive_t
*drive
, const u8 mode
)
329 struct pci_dev
*dev
= drive
->hwif
->pci_dev
;
330 u8 drive_pci
= 0x40 + drive
->dn
* 2, reg
= 0, i
= chipset_family
;
332 pci_read_config_byte(dev
, drive_pci
+ 1, ®
);
334 /* force the UDMA bit on if we want to use UDMA */
336 /* clean reg cycle time bits */
337 reg
&= ~((0xff >> (8 - cycle_time_range
[i
])) << cycle_time_offset
[i
]);
338 /* set reg cycle time bits */
339 reg
|= cycle_time_value
[i
][mode
- XFER_UDMA_0
] << cycle_time_offset
[i
];
341 pci_write_config_byte(dev
, drive_pci
+ 1, reg
);
344 static void sis_program_udma_timings(ide_drive_t
*drive
, const u8 mode
)
346 if (chipset_family
>= ATA_133
) /* ATA_133 */
347 sis_ata133_program_udma_timings(drive
, mode
);
348 else /* ATA_33/66/100a/100/133a */
349 sis_ata33_program_udma_timings(drive
, mode
);
352 static void sis_set_dma_mode(ide_drive_t
*drive
, const u8 speed
)
354 if (speed
>= XFER_UDMA_0
)
355 sis_program_udma_timings(drive
, speed
);
357 sis_program_timings(drive
, speed
);
360 static u8
sis5513_ata133_udma_filter(ide_drive_t
*drive
)
362 struct pci_dev
*dev
= drive
->hwif
->pci_dev
;
364 u8 drive_pci
= sis_ata133_get_base(drive
);
366 pci_read_config_dword(dev
, drive_pci
, ®dw
);
368 /* if ATA133 disable, we should not set speed above UDMA5 */
369 return (regdw
& 0x08) ? ATA_UDMA6
: ATA_UDMA5
;
372 /* Chip detection and general config */
373 static unsigned int __devinit
init_chipset_sis5513 (struct pci_dev
*dev
, const char *name
)
375 struct pci_dev
*host
;
380 for (i
= 0; i
< ARRAY_SIZE(SiSHostChipInfo
) && !chipset_family
; i
++) {
382 host
= pci_get_device(PCI_VENDOR_ID_SI
, SiSHostChipInfo
[i
].host_id
, NULL
);
387 chipset_family
= SiSHostChipInfo
[i
].chipset_family
;
389 /* Special case for SiS630 : 630S/ET is ATA_100a */
390 if (SiSHostChipInfo
[i
].host_id
== PCI_DEVICE_ID_SI_630
) {
391 if (host
->revision
>= 0x30)
392 chipset_family
= ATA_100a
;
396 printk(KERN_INFO
"SIS5513: %s %s controller\n",
397 SiSHostChipInfo
[i
].name
, chipset_capability
[chipset_family
]);
400 if (!chipset_family
) { /* Belongs to pci-quirks */
405 /* Disable ID masking and register remapping */
406 pci_read_config_dword(dev
, 0x54, &idemisc
);
407 pci_write_config_dword(dev
, 0x54, (idemisc
& 0x7fffffff));
408 pci_read_config_word(dev
, PCI_DEVICE_ID
, &trueid
);
409 pci_write_config_dword(dev
, 0x54, idemisc
);
411 if (trueid
== 0x5518) {
412 printk(KERN_INFO
"SIS5513: SiS 962/963 MuTIOL IDE UDMA133 controller\n");
413 chipset_family
= ATA_133
;
415 /* Check for 5513 compability mapping
416 * We must use this, else the port enabled code will fail,
417 * as it expects the enablebits at 0x4a.
419 if ((idemisc
& 0x40000000) == 0) {
420 pci_write_config_dword(dev
, 0x54, idemisc
| 0x40000000);
421 printk(KERN_INFO
"SIS5513: Switching to 5513 register mapping\n");
426 if (!chipset_family
) { /* Belongs to pci-quirks */
428 struct pci_dev
*lpc_bridge
;
433 pci_read_config_byte(dev
, 0x4a, &idecfg
);
434 pci_write_config_byte(dev
, 0x4a, idecfg
| 0x10);
435 pci_read_config_word(dev
, PCI_DEVICE_ID
, &trueid
);
436 pci_write_config_byte(dev
, 0x4a, idecfg
);
438 if (trueid
== 0x5517) { /* SiS 961/961B */
440 lpc_bridge
= pci_get_slot(dev
->bus
, 0x10); /* Bus 0, Dev 2, Fn 0 */
441 pci_read_config_byte(dev
, 0x49, &prefctl
);
442 pci_dev_put(lpc_bridge
);
444 if (lpc_bridge
->revision
== 0x10 && (prefctl
& 0x80)) {
445 printk(KERN_INFO
"SIS5513: SiS 961B MuTIOL IDE UDMA133 controller\n");
446 chipset_family
= ATA_133a
;
448 printk(KERN_INFO
"SIS5513: SiS 961 MuTIOL IDE UDMA100 controller\n");
449 chipset_family
= ATA_100
;
457 /* Make general config ops here
458 1/ tell IDE channels to operate in Compatibility mode only
459 2/ tell old chips to allow per drive IDE timings */
465 switch(chipset_family
) {
467 /* SiS962 operation mode */
468 pci_read_config_word(dev
, 0x50, ®w
);
470 pci_write_config_word(dev
, 0x50, regw
&0xfff7);
471 pci_read_config_word(dev
, 0x52, ®w
);
473 pci_write_config_word(dev
, 0x52, regw
&0xfff7);
478 pci_write_config_byte(dev
, PCI_LATENCY_TIMER
, 0x80);
479 /* Set compatibility bit */
480 pci_read_config_byte(dev
, 0x49, ®
);
482 pci_write_config_byte(dev
, 0x49, reg
|0x01);
488 pci_write_config_byte(dev
, PCI_LATENCY_TIMER
, 0x10);
490 /* On ATA_66 chips the bit was elsewhere */
491 pci_read_config_byte(dev
, 0x52, ®
);
493 pci_write_config_byte(dev
, 0x52, reg
|0x04);
497 /* On ATA_33 we didn't have a single bit to set */
498 pci_read_config_byte(dev
, 0x09, ®
);
499 if ((reg
& 0x0f) != 0x00) {
500 pci_write_config_byte(dev
, 0x09, reg
&0xf0);
503 /* force per drive recovery and active timings
504 needed on ATA_33 and below chips */
505 pci_read_config_byte(dev
, 0x52, ®
);
507 pci_write_config_byte(dev
, 0x52, reg
|0x08);
522 static const struct sis_laptop sis_laptop
[] = {
523 /* devid, subvendor, subdev */
524 { 0x5513, 0x1043, 0x1107 }, /* ASUS A6K */
525 { 0x5513, 0x1734, 0x105f }, /* FSC Amilo A1630 */
526 { 0x5513, 0x1071, 0x8640 }, /* EasyNote K5305 */
531 static u8 __devinit
ata66_sis5513(ide_hwif_t
*hwif
)
533 struct pci_dev
*pdev
= hwif
->pci_dev
;
534 const struct sis_laptop
*lap
= &sis_laptop
[0];
537 while (lap
->device
) {
538 if (lap
->device
== pdev
->device
&&
539 lap
->subvendor
== pdev
->subsystem_vendor
&&
540 lap
->subdevice
== pdev
->subsystem_device
)
541 return ATA_CBL_PATA40_SHORT
;
545 if (chipset_family
>= ATA_133
) {
547 u16 reg_addr
= hwif
->channel
? 0x52: 0x50;
548 pci_read_config_word(hwif
->pci_dev
, reg_addr
, ®w
);
549 ata66
= (regw
& 0x8000) ? 0 : 1;
550 } else if (chipset_family
>= ATA_66
) {
552 u8 mask
= hwif
->channel
? 0x20 : 0x10;
553 pci_read_config_byte(hwif
->pci_dev
, 0x48, ®48h
);
554 ata66
= (reg48h
& mask
) ? 0 : 1;
557 return ata66
? ATA_CBL_PATA80
: ATA_CBL_PATA40
;
560 static void __devinit
init_hwif_sis5513 (ide_hwif_t
*hwif
)
562 u8 udma_rates
[] = { 0x00, 0x00, 0x07, 0x1f, 0x3f, 0x3f, 0x7f, 0x7f };
564 hwif
->set_pio_mode
= &sis_set_pio_mode
;
565 hwif
->set_dma_mode
= &sis_set_dma_mode
;
567 if (chipset_family
>= ATA_133
)
568 hwif
->udma_filter
= sis5513_ata133_udma_filter
;
570 if (hwif
->dma_base
== 0)
573 hwif
->ultra_mask
= udma_rates
[chipset_family
];
575 if (hwif
->cbl
!= ATA_CBL_PATA40_SHORT
)
576 hwif
->cbl
= ata66_sis5513(hwif
);
579 static const struct ide_port_info sis5513_chipset __devinitdata
= {
581 .init_chipset
= init_chipset_sis5513
,
582 .init_hwif
= init_hwif_sis5513
,
583 .enablebits
= {{0x4a,0x02,0x02}, {0x4a,0x04,0x04}},
584 .host_flags
= IDE_HFLAG_LEGACY_IRQS
| IDE_HFLAG_NO_AUTODMA
|
586 .pio_mask
= ATA_PIO4
,
587 .mwdma_mask
= ATA_MWDMA2
,
590 static int __devinit
sis5513_init_one(struct pci_dev
*dev
, const struct pci_device_id
*id
)
592 return ide_setup_pci_device(dev
, &sis5513_chipset
);
595 static const struct pci_device_id sis5513_pci_tbl
[] = {
596 { PCI_VDEVICE(SI
, PCI_DEVICE_ID_SI_5513
), 0 },
597 { PCI_VDEVICE(SI
, PCI_DEVICE_ID_SI_5518
), 0 },
598 { PCI_VDEVICE(SI
, PCI_DEVICE_ID_SI_1180
), 0 },
601 MODULE_DEVICE_TABLE(pci
, sis5513_pci_tbl
);
603 static struct pci_driver driver
= {
605 .id_table
= sis5513_pci_tbl
,
606 .probe
= sis5513_init_one
,
609 static int __init
sis5513_ide_init(void)
611 return ide_pci_register_driver(&driver
);
614 module_init(sis5513_ide_init
);
616 MODULE_AUTHOR("Lionel Bouton, L C Chang, Andre Hedrick, Vojtech Pavlik");
617 MODULE_DESCRIPTION("PCI driver module for SIS IDE");
618 MODULE_LICENSE("GPL");
623 * - Use drivers/ide/ide-timing.h !
624 * - More checks in the config registers (force values instead of
625 * relying on the BIOS setting them correctly).
626 * - Further optimisations ?
627 * . for example ATA66+ regs 0x48 & 0x4A