2 * Copyright (C) 1999-2000 Andre Hedrick <andre@linux-ide.org>
3 * Copyright (C) 2002 Lionel Bouton <Lionel.Bouton@inet6.fr>, Maintainer
4 * Copyright (C) 2003 Vojtech Pavlik <vojtech@suse.cz>
5 * Copyright (C) 2007-2009 Bartlomiej Zolnierkiewicz
7 * May be copied or modified under the terms of the GNU General Public License
12 * SiS Taiwan : for direct support and hardware.
13 * Daniela Engert : for initial ATA100 advices and numerous others.
14 * John Fremlin, Manfred Spraul, Dave Morgan, Peter Kjellerstedt :
15 * for checking code correctness, providing patches.
18 * Original tests and design on the SiS620 chipset.
19 * ATA100 tests and design on the SiS735 chipset.
20 * ATA16/33 support from specs
21 * ATA133 support for SiS961/962 by L.C. Chang <lcchang@sis.com.tw>
22 * ATA133 961/962/963 fixes by Vojtech Pavlik <vojtech@suse.cz>
25 * SiS chipset documentation available under NDA to companies only
26 * (not to individuals).
30 * The original SiS5513 comes from a SiS5511/55112/5513 chipset. The original
31 * SiS5513 was also used in the SiS5596/5513 chipset. Thus if we see a SiS5511
32 * or SiS5596, we can assume we see the first MWDMA-16 capable SiS5513 chip.
34 * Later SiS chipsets integrated the 5513 functionality into the NorthBridge,
35 * starting with SiS5571 and up to SiS745. The PCI ID didn't change, though. We
36 * can figure out that we have a more modern and more capable 5513 by looking
37 * for the respective NorthBridge IDs.
39 * Even later (96x family) SiS chipsets use the MuTIOL link and place the 5513
40 * into the SouthBrige. Here we cannot rely on looking up the NorthBridge PCI
41 * ID, while the now ATA-133 capable 5513 still has the same PCI ID.
42 * Fortunately the 5513 can be 'unmasked' by fiddling with some config space
43 * bits, changing its device id to the true one - 5517 for 961 and 5518 for
47 #include <linux/types.h>
48 #include <linux/module.h>
49 #include <linux/kernel.h>
50 #include <linux/pci.h>
51 #include <linux/init.h>
52 #include <linux/ide.h>
54 #define DRV_NAME "sis5513"
56 /* registers layout and init values are chipset family dependent */
61 #define ATA_100a 0x04 /* SiS730/SiS550 is ATA100 with ATA66 layout */
63 #define ATA_133a 0x06 /* SiS961b with 133 support */
64 #define ATA_133 0x07 /* SiS962/963 */
66 static u8 chipset_family;
76 } SiSHostChipInfo[] = {
77 { "SiS968", PCI_DEVICE_ID_SI_968, ATA_133 },
78 { "SiS966", PCI_DEVICE_ID_SI_966, ATA_133 },
79 { "SiS965", PCI_DEVICE_ID_SI_965, ATA_133 },
80 { "SiS745", PCI_DEVICE_ID_SI_745, ATA_100 },
81 { "SiS735", PCI_DEVICE_ID_SI_735, ATA_100 },
82 { "SiS733", PCI_DEVICE_ID_SI_733, ATA_100 },
83 { "SiS635", PCI_DEVICE_ID_SI_635, ATA_100 },
84 { "SiS633", PCI_DEVICE_ID_SI_633, ATA_100 },
86 { "SiS730", PCI_DEVICE_ID_SI_730, ATA_100a },
87 { "SiS550", PCI_DEVICE_ID_SI_550, ATA_100a },
89 { "SiS640", PCI_DEVICE_ID_SI_640, ATA_66 },
90 { "SiS630", PCI_DEVICE_ID_SI_630, ATA_66 },
91 { "SiS620", PCI_DEVICE_ID_SI_620, ATA_66 },
92 { "SiS540", PCI_DEVICE_ID_SI_540, ATA_66 },
93 { "SiS530", PCI_DEVICE_ID_SI_530, ATA_66 },
95 { "SiS5600", PCI_DEVICE_ID_SI_5600, ATA_33 },
96 { "SiS5598", PCI_DEVICE_ID_SI_5598, ATA_33 },
97 { "SiS5597", PCI_DEVICE_ID_SI_5597, ATA_33 },
98 { "SiS5591/2", PCI_DEVICE_ID_SI_5591, ATA_33 },
99 { "SiS5582", PCI_DEVICE_ID_SI_5582, ATA_33 },
100 { "SiS5581", PCI_DEVICE_ID_SI_5581, ATA_33 },
102 { "SiS5596", PCI_DEVICE_ID_SI_5596, ATA_16 },
103 { "SiS5571", PCI_DEVICE_ID_SI_5571, ATA_16 },
104 { "SiS5517", PCI_DEVICE_ID_SI_5517, ATA_16 },
105 { "SiS551x", PCI_DEVICE_ID_SI_5511, ATA_16 },
108 /* Cycle time bits and values vary across chip dma capabilities
109 These three arrays hold the register layout and the values to set.
110 Indexed by chipset_family and (dma_mode - XFER_UDMA_0) */
112 /* {0, ATA_16, ATA_33, ATA_66, ATA_100a, ATA_100, ATA_133} */
113 static u8 cycle_time_offset[] = { 0, 0, 5, 4, 4, 0, 0 };
114 static u8 cycle_time_range[] = { 0, 0, 2, 3, 3, 4, 4 };
115 static u8 cycle_time_value[][XFER_UDMA_6 - XFER_UDMA_0 + 1] = {
116 { 0, 0, 0, 0, 0, 0, 0 }, /* no UDMA */
117 { 0, 0, 0, 0, 0, 0, 0 }, /* no UDMA */
118 { 3, 2, 1, 0, 0, 0, 0 }, /* ATA_33 */
119 { 7, 5, 3, 2, 1, 0, 0 }, /* ATA_66 */
120 { 7, 5, 3, 2, 1, 0, 0 }, /* ATA_100a (730 specific),
121 different cycle_time range and offset */
122 { 11, 7, 5, 4, 2, 1, 0 }, /* ATA_100 */
123 { 15, 10, 7, 5, 3, 2, 1 }, /* ATA_133a (earliest 691 southbridges) */
124 { 15, 10, 7, 5, 3, 2, 1 }, /* ATA_133 */
126 /* CRC Valid Setup Time vary across IDE clock setting 33/66/100/133
127 See SiS962 data sheet for more detail */
128 static u8 cvs_time_value[][XFER_UDMA_6 - XFER_UDMA_0 + 1] = {
129 { 0, 0, 0, 0, 0, 0, 0 }, /* no UDMA */
130 { 0, 0, 0, 0, 0, 0, 0 }, /* no UDMA */
131 { 2, 1, 1, 0, 0, 0, 0 },
132 { 4, 3, 2, 1, 0, 0, 0 },
133 { 4, 3, 2, 1, 0, 0, 0 },
134 { 6, 4, 3, 1, 1, 1, 0 },
135 { 9, 6, 4, 2, 2, 2, 2 },
136 { 9, 6, 4, 2, 2, 2, 2 },
138 /* Initialize time, Active time, Recovery time vary across
139 IDE clock settings. These 3 arrays hold the register value
140 for PIO0/1/2/3/4 and DMA0/1/2 mode in order */
141 static u8 ini_time_value[][8] = {
142 { 0, 0, 0, 0, 0, 0, 0, 0 },
143 { 0, 0, 0, 0, 0, 0, 0, 0 },
144 { 2, 1, 0, 0, 0, 1, 0, 0 },
145 { 4, 3, 1, 1, 1, 3, 1, 1 },
146 { 4, 3, 1, 1, 1, 3, 1, 1 },
147 { 6, 4, 2, 2, 2, 4, 2, 2 },
148 { 9, 6, 3, 3, 3, 6, 3, 3 },
149 { 9, 6, 3, 3, 3, 6, 3, 3 },
151 static u8 act_time_value[][8] = {
152 { 0, 0, 0, 0, 0, 0, 0, 0 },
153 { 0, 0, 0, 0, 0, 0, 0, 0 },
154 { 9, 9, 9, 2, 2, 7, 2, 2 },
155 { 19, 19, 19, 5, 4, 14, 5, 4 },
156 { 19, 19, 19, 5, 4, 14, 5, 4 },
157 { 28, 28, 28, 7, 6, 21, 7, 6 },
158 { 38, 38, 38, 10, 9, 28, 10, 9 },
159 { 38, 38, 38, 10, 9, 28, 10, 9 },
161 static u8 rco_time_value[][8] = {
162 { 0, 0, 0, 0, 0, 0, 0, 0 },
163 { 0, 0, 0, 0, 0, 0, 0, 0 },
164 { 9, 2, 0, 2, 0, 7, 1, 1 },
165 { 19, 5, 1, 5, 2, 16, 3, 2 },
166 { 19, 5, 1, 5, 2, 16, 3, 2 },
167 { 30, 9, 3, 9, 4, 25, 6, 4 },
168 { 40, 12, 4, 12, 5, 34, 12, 5 },
169 { 40, 12, 4, 12, 5, 34, 12, 5 },
173 * Printing configuration
175 /* Used for chipset type printing at boot time */
176 static char *chipset_capability[] = {
179 "ATA 100 (1st gen)", "ATA 100 (2nd gen)",
180 "ATA 133 (1st gen)", "ATA 133 (2nd gen)"
184 * Configuration functions
187 static u8 sis_ata133_get_base(ide_drive_t *drive)
189 struct pci_dev *dev = to_pci_dev(drive->hwif->dev);
192 pci_read_config_dword(dev, 0x54, ®54);
194 return ((reg54 & 0x40000000) ? 0x70 : 0x40) + drive->dn * 4;
197 static void sis_ata16_program_timings(ide_drive_t *drive, const u8 mode)
199 struct pci_dev *dev = to_pci_dev(drive->hwif->dev);
201 u8 drive_pci = 0x40 + drive->dn * 2;
203 const u16 pio_timings[] = { 0x000, 0x607, 0x404, 0x303, 0x301 };
204 const u16 mwdma_timings[] = { 0x008, 0x302, 0x301 };
206 pci_read_config_word(dev, drive_pci, &t1);
208 /* clear active/recovery timings */
210 if (mode >= XFER_MW_DMA_0) {
211 if (chipset_family > ATA_16)
212 t1 &= ~0x8000; /* disable UDMA */
213 t1 |= mwdma_timings[mode - XFER_MW_DMA_0];
215 t1 |= pio_timings[mode - XFER_PIO_0];
217 pci_write_config_word(dev, drive_pci, t1);
220 static void sis_ata100_program_timings(ide_drive_t *drive, const u8 mode)
222 struct pci_dev *dev = to_pci_dev(drive->hwif->dev);
223 u8 t1, drive_pci = 0x40 + drive->dn * 2;
225 /* timing bits: 7:4 active 3:0 recovery */
226 const u8 pio_timings[] = { 0x00, 0x67, 0x44, 0x33, 0x31 };
227 const u8 mwdma_timings[] = { 0x08, 0x32, 0x31 };
229 if (mode >= XFER_MW_DMA_0) {
232 pci_read_config_byte(dev, drive_pci, &t2);
233 t2 &= ~0x80; /* disable UDMA */
234 pci_write_config_byte(dev, drive_pci, t2);
236 t1 = mwdma_timings[mode - XFER_MW_DMA_0];
238 t1 = pio_timings[mode - XFER_PIO_0];
240 pci_write_config_byte(dev, drive_pci + 1, t1);
243 static void sis_ata133_program_timings(ide_drive_t *drive, const u8 mode)
245 struct pci_dev *dev = to_pci_dev(drive->hwif->dev);
247 u8 drive_pci = sis_ata133_get_base(drive), clk, idx;
249 pci_read_config_dword(dev, drive_pci, &t1);
252 clk = (t1 & 0x08) ? ATA_133 : ATA_100;
253 if (mode >= XFER_MW_DMA_0) {
254 t1 &= ~0x04; /* disable UDMA */
255 idx = mode - XFER_MW_DMA_0 + 5;
257 idx = mode - XFER_PIO_0;
258 t1 |= ini_time_value[clk][idx] << 12;
259 t1 |= act_time_value[clk][idx] << 16;
260 t1 |= rco_time_value[clk][idx] << 24;
262 pci_write_config_dword(dev, drive_pci, t1);
265 static void sis_program_timings(ide_drive_t *drive, const u8 mode)
267 if (chipset_family < ATA_100) /* ATA_16/33/66/100a */
268 sis_ata16_program_timings(drive, mode);
269 else if (chipset_family < ATA_133) /* ATA_100/133a */
270 sis_ata100_program_timings(drive, mode);
272 sis_ata133_program_timings(drive, mode);
275 static void config_drive_art_rwp(ide_drive_t *drive)
277 ide_hwif_t *hwif = drive->hwif;
278 struct pci_dev *dev = to_pci_dev(hwif->dev);
282 pci_read_config_byte(dev, 0x4b, ®4bh);
284 rw_prefetch = reg4bh & ~(0x11 << drive->dn);
286 if (drive->media == ide_disk)
287 rw_prefetch |= 0x11 << drive->dn;
289 if (reg4bh != rw_prefetch)
290 pci_write_config_byte(dev, 0x4b, rw_prefetch);
293 static void sis_set_pio_mode(ide_hwif_t *hwif, ide_drive_t *drive)
295 config_drive_art_rwp(drive);
296 sis_program_timings(drive, drive->pio_mode);
299 static void sis_ata133_program_udma_timings(ide_drive_t *drive, const u8 mode)
301 struct pci_dev *dev = to_pci_dev(drive->hwif->dev);
303 u8 drive_pci = sis_ata133_get_base(drive), clk, idx;
305 pci_read_config_dword(dev, drive_pci, ®dw);
309 /* check if ATA133 enable */
310 clk = (regdw & 0x08) ? ATA_133 : ATA_100;
311 idx = mode - XFER_UDMA_0;
312 regdw |= cycle_time_value[clk][idx] << 4;
313 regdw |= cvs_time_value[clk][idx] << 8;
315 pci_write_config_dword(dev, drive_pci, regdw);
318 static void sis_ata33_program_udma_timings(ide_drive_t *drive, const u8 mode)
320 struct pci_dev *dev = to_pci_dev(drive->hwif->dev);
321 u8 drive_pci = 0x40 + drive->dn * 2, reg = 0, i = chipset_family;
323 pci_read_config_byte(dev, drive_pci + 1, ®);
325 /* force the UDMA bit on if we want to use UDMA */
327 /* clean reg cycle time bits */
328 reg &= ~((0xff >> (8 - cycle_time_range[i])) << cycle_time_offset[i]);
329 /* set reg cycle time bits */
330 reg |= cycle_time_value[i][mode - XFER_UDMA_0] << cycle_time_offset[i];
332 pci_write_config_byte(dev, drive_pci + 1, reg);
335 static void sis_program_udma_timings(ide_drive_t *drive, const u8 mode)
337 if (chipset_family >= ATA_133) /* ATA_133 */
338 sis_ata133_program_udma_timings(drive, mode);
339 else /* ATA_33/66/100a/100/133a */
340 sis_ata33_program_udma_timings(drive, mode);
343 static void sis_set_dma_mode(ide_hwif_t *hwif, ide_drive_t *drive)
345 const u8 speed = drive->dma_mode;
347 if (speed >= XFER_UDMA_0)
348 sis_program_udma_timings(drive, speed);
350 sis_program_timings(drive, speed);
353 static u8 sis_ata133_udma_filter(ide_drive_t *drive)
355 struct pci_dev *dev = to_pci_dev(drive->hwif->dev);
357 u8 drive_pci = sis_ata133_get_base(drive);
359 pci_read_config_dword(dev, drive_pci, ®dw);
361 /* if ATA133 disable, we should not set speed above UDMA5 */
362 return (regdw & 0x08) ? ATA_UDMA6 : ATA_UDMA5;
365 static int sis_find_family(struct pci_dev *dev)
367 struct pci_dev *host;
372 for (i = 0; i < ARRAY_SIZE(SiSHostChipInfo) && !chipset_family; i++) {
374 host = pci_get_device(PCI_VENDOR_ID_SI, SiSHostChipInfo[i].host_id, NULL);
379 chipset_family = SiSHostChipInfo[i].chipset_family;
381 /* Special case for SiS630 : 630S/ET is ATA_100a */
382 if (SiSHostChipInfo[i].host_id == PCI_DEVICE_ID_SI_630) {
383 if (host->revision >= 0x30)
384 chipset_family = ATA_100a;
388 printk(KERN_INFO DRV_NAME " %s: %s %s controller\n",
389 pci_name(dev), SiSHostChipInfo[i].name,
390 chipset_capability[chipset_family]);
393 if (!chipset_family) { /* Belongs to pci-quirks */
398 /* Disable ID masking and register remapping */
399 pci_read_config_dword(dev, 0x54, &idemisc);
400 pci_write_config_dword(dev, 0x54, (idemisc & 0x7fffffff));
401 pci_read_config_word(dev, PCI_DEVICE_ID, &trueid);
402 pci_write_config_dword(dev, 0x54, idemisc);
404 if (trueid == 0x5518) {
405 printk(KERN_INFO DRV_NAME " %s: SiS 962/963 MuTIOL IDE UDMA133 controller\n",
407 chipset_family = ATA_133;
409 /* Check for 5513 compatibility mapping
410 * We must use this, else the port enabled code will fail,
411 * as it expects the enablebits at 0x4a.
413 if ((idemisc & 0x40000000) == 0) {
414 pci_write_config_dword(dev, 0x54, idemisc | 0x40000000);
415 printk(KERN_INFO DRV_NAME " %s: Switching to 5513 register mapping\n",
421 if (!chipset_family) { /* Belongs to pci-quirks */
423 struct pci_dev *lpc_bridge;
428 pci_read_config_byte(dev, 0x4a, &idecfg);
429 pci_write_config_byte(dev, 0x4a, idecfg | 0x10);
430 pci_read_config_word(dev, PCI_DEVICE_ID, &trueid);
431 pci_write_config_byte(dev, 0x4a, idecfg);
433 if (trueid == 0x5517) { /* SiS 961/961B */
435 lpc_bridge = pci_get_slot(dev->bus, 0x10); /* Bus 0, Dev 2, Fn 0 */
436 pci_read_config_byte(dev, 0x49, &prefctl);
437 pci_dev_put(lpc_bridge);
439 if (lpc_bridge->revision == 0x10 && (prefctl & 0x80)) {
440 printk(KERN_INFO DRV_NAME " %s: SiS 961B MuTIOL IDE UDMA133 controller\n",
442 chipset_family = ATA_133a;
444 printk(KERN_INFO DRV_NAME " %s: SiS 961 MuTIOL IDE UDMA100 controller\n",
446 chipset_family = ATA_100;
451 return chipset_family;
454 static int init_chipset_sis5513(struct pci_dev *dev)
456 /* Make general config ops here
457 1/ tell IDE channels to operate in Compatibility mode only
458 2/ tell old chips to allow per drive IDE timings */
463 switch (chipset_family) {
465 /* SiS962 operation mode */
466 pci_read_config_word(dev, 0x50, ®w);
468 pci_write_config_word(dev, 0x50, regw&0xfff7);
469 pci_read_config_word(dev, 0x52, ®w);
471 pci_write_config_word(dev, 0x52, regw&0xfff7);
476 pci_write_config_byte(dev, PCI_LATENCY_TIMER, 0x80);
477 /* Set compatibility bit */
478 pci_read_config_byte(dev, 0x49, ®);
480 pci_write_config_byte(dev, 0x49, reg|0x01);
485 pci_write_config_byte(dev, PCI_LATENCY_TIMER, 0x10);
487 /* On ATA_66 chips the bit was elsewhere */
488 pci_read_config_byte(dev, 0x52, ®);
490 pci_write_config_byte(dev, 0x52, reg|0x04);
493 /* On ATA_33 we didn't have a single bit to set */
494 pci_read_config_byte(dev, 0x09, ®);
495 if ((reg & 0x0f) != 0x00)
496 pci_write_config_byte(dev, 0x09, reg&0xf0);
499 /* force per drive recovery and active timings
500 needed on ATA_33 and below chips */
501 pci_read_config_byte(dev, 0x52, ®);
503 pci_write_config_byte(dev, 0x52, reg|0x08);
516 static const struct sis_laptop sis_laptop[] = {
517 /* devid, subvendor, subdev */
518 { 0x5513, 0x1043, 0x1107 }, /* ASUS A6K */
519 { 0x5513, 0x1734, 0x105f }, /* FSC Amilo A1630 */
520 { 0x5513, 0x1071, 0x8640 }, /* EasyNote K5305 */
525 static u8 sis_cable_detect(ide_hwif_t *hwif)
527 struct pci_dev *pdev = to_pci_dev(hwif->dev);
528 const struct sis_laptop *lap = &sis_laptop[0];
531 while (lap->device) {
532 if (lap->device == pdev->device &&
533 lap->subvendor == pdev->subsystem_vendor &&
534 lap->subdevice == pdev->subsystem_device)
535 return ATA_CBL_PATA40_SHORT;
539 if (chipset_family >= ATA_133) {
541 u16 reg_addr = hwif->channel ? 0x52: 0x50;
542 pci_read_config_word(pdev, reg_addr, ®w);
543 ata66 = (regw & 0x8000) ? 0 : 1;
544 } else if (chipset_family >= ATA_66) {
546 u8 mask = hwif->channel ? 0x20 : 0x10;
547 pci_read_config_byte(pdev, 0x48, ®48h);
548 ata66 = (reg48h & mask) ? 0 : 1;
551 return ata66 ? ATA_CBL_PATA80 : ATA_CBL_PATA40;
554 static const struct ide_port_ops sis_port_ops = {
555 .set_pio_mode = sis_set_pio_mode,
556 .set_dma_mode = sis_set_dma_mode,
557 .cable_detect = sis_cable_detect,
560 static const struct ide_port_ops sis_ata133_port_ops = {
561 .set_pio_mode = sis_set_pio_mode,
562 .set_dma_mode = sis_set_dma_mode,
563 .udma_filter = sis_ata133_udma_filter,
564 .cable_detect = sis_cable_detect,
567 static const struct ide_port_info sis5513_chipset = {
569 .init_chipset = init_chipset_sis5513,
570 .enablebits = { {0x4a, 0x02, 0x02}, {0x4a, 0x04, 0x04} },
571 .host_flags = IDE_HFLAG_NO_AUTODMA,
572 .pio_mask = ATA_PIO4,
573 .mwdma_mask = ATA_MWDMA2,
576 static int sis5513_init_one(struct pci_dev *dev, const struct pci_device_id *id)
578 struct ide_port_info d = sis5513_chipset;
579 u8 udma_rates[] = { 0x00, 0x00, 0x07, 0x1f, 0x3f, 0x3f, 0x7f, 0x7f };
582 rc = pci_enable_device(dev);
586 if (sis_find_family(dev) == 0)
589 if (chipset_family >= ATA_133)
590 d.port_ops = &sis_ata133_port_ops;
592 d.port_ops = &sis_port_ops;
594 d.udma_mask = udma_rates[chipset_family];
596 return ide_pci_init_one(dev, &d, NULL);
599 static void sis5513_remove(struct pci_dev *dev)
602 pci_disable_device(dev);
605 static const struct pci_device_id sis5513_pci_tbl[] = {
606 { PCI_VDEVICE(SI, PCI_DEVICE_ID_SI_5513), 0 },
607 { PCI_VDEVICE(SI, PCI_DEVICE_ID_SI_5518), 0 },
608 { PCI_VDEVICE(SI, PCI_DEVICE_ID_SI_1180), 0 },
611 MODULE_DEVICE_TABLE(pci, sis5513_pci_tbl);
613 static struct pci_driver sis5513_pci_driver = {
615 .id_table = sis5513_pci_tbl,
616 .probe = sis5513_init_one,
617 .remove = sis5513_remove,
618 .suspend = ide_pci_suspend,
619 .resume = ide_pci_resume,
622 static int __init sis5513_ide_init(void)
624 return ide_pci_register_driver(&sis5513_pci_driver);
627 static void __exit sis5513_ide_exit(void)
629 pci_unregister_driver(&sis5513_pci_driver);
632 module_init(sis5513_ide_init);
633 module_exit(sis5513_ide_exit);
635 MODULE_AUTHOR("Lionel Bouton, L C Chang, Andre Hedrick, Vojtech Pavlik");
636 MODULE_DESCRIPTION("PCI driver module for SIS IDE");
637 MODULE_LICENSE("GPL");