2 * pata_serverworks.c - Serverworks PATA for new ATA layer
4 * Alan Cox <alan@redhat.com>
10 * Copyright (C) 1998-2000 Michel Aubry
11 * Copyright (C) 1998-2000 Andrzej Krzysztofowicz
12 * Copyright (C) 1998-2000 Andre Hedrick <andre@linux-ide.org>
13 * Portions copyright (c) 2001 Sun Microsystems
16 * RCC/ServerWorks IDE driver for Linux
18 * OSB4: `Open South Bridge' IDE Interface (fn 1)
19 * supports UDMA mode 2 (33 MB/s)
21 * CSB5: `Champion South Bridge' IDE Interface (fn 1)
22 * all revisions support UDMA mode 4 (66 MB/s)
23 * revision A2.0 and up support UDMA mode 5 (100 MB/s)
25 * *** The CSB5 does not provide ANY register ***
26 * *** to detect 80-conductor cable presence. ***
28 * CSB6: `Champion South Bridge' IDE Interface (optional: third channel)
31 * Available under NDA only. Errata info very hard to get.
34 #include <linux/kernel.h>
35 #include <linux/module.h>
36 #include <linux/pci.h>
37 #include <linux/init.h>
38 #include <linux/blkdev.h>
39 #include <linux/delay.h>
40 #include <scsi/scsi_host.h>
41 #include <linux/libata.h>
43 #define DRV_NAME "pata_serverworks"
44 #define DRV_VERSION "0.4.0"
46 #define SVWKS_CSB5_REVISION_NEW 0x92 /* min PCI_REVISION_ID for UDMA5 (A2.0) */
47 #define SVWKS_CSB6_REVISION 0xa0 /* min PCI_REVISION_ID for UDMA4 (A1.0) */
49 /* Seagate Barracuda ATA IV Family drives in UDMA mode 5
50 * can overrun their FIFOs when used with the CSB5 */
52 static const char *csb_bad_ata100[] = {
61 * dell_cable - Dell serverworks cable detection
62 * @ap: ATA port to do cable detect
64 * Dell hide the 40/80 pin select for their interfaces in the top two
65 * bits of the subsystem ID.
68 static int dell_cable(struct ata_port *ap) {
69 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
71 if (pdev->subsystem_device & (1 << (ap->port_no + 14)))
72 return ATA_CBL_PATA80;
73 return ATA_CBL_PATA40;
77 * sun_cable - Sun Cobalt 'Alpine' cable detection
78 * @ap: ATA port to do cable select
80 * Cobalt CSB5 IDE hides the 40/80pin in the top two bits of the
81 * subsystem ID the same as dell. We could use one function but we may
82 * need to extend the Dell one in future
85 static int sun_cable(struct ata_port *ap) {
86 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
88 if (pdev->subsystem_device & (1 << (ap->port_no + 14)))
89 return ATA_CBL_PATA80;
90 return ATA_CBL_PATA40;
94 * osb4_cable - OSB4 cable detect
95 * @ap: ATA port to check
97 * The OSB4 isn't UDMA66 capable so this is easy
100 static int osb4_cable(struct ata_port *ap) {
101 return ATA_CBL_PATA40;
105 * csb4_cable - CSB5/6 cable detect
106 * @ap: ATA port to check
108 * Serverworks default arrangement is to use the drive side detection
112 static int csb_cable(struct ata_port *ap) {
113 return ATA_CBL_PATA80;
116 struct sv_cable_table {
119 int (*cable_detect)(struct ata_port *ap);
123 * Note that we don't copy the old serverworks code because the old
124 * code contains obvious mistakes
127 static struct sv_cable_table cable_detect[] = {
128 { PCI_DEVICE_ID_SERVERWORKS_CSB5IDE, PCI_VENDOR_ID_DELL, dell_cable },
129 { PCI_DEVICE_ID_SERVERWORKS_CSB6IDE, PCI_VENDOR_ID_DELL, dell_cable },
130 { PCI_DEVICE_ID_SERVERWORKS_CSB5IDE, PCI_VENDOR_ID_SUN, sun_cable },
131 { PCI_DEVICE_ID_SERVERWORKS_OSB4IDE, PCI_ANY_ID, osb4_cable },
132 { PCI_DEVICE_ID_SERVERWORKS_CSB5IDE, PCI_ANY_ID, csb_cable },
133 { PCI_DEVICE_ID_SERVERWORKS_CSB6IDE, PCI_ANY_ID, csb_cable },
134 { PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2, PCI_ANY_ID, csb_cable },
135 { PCI_DEVICE_ID_SERVERWORKS_HT1000IDE, PCI_ANY_ID, csb_cable },
140 * serverworks_cable_detect - cable detection
142 * @deadline: deadline jiffies for the operation
144 * Perform cable detection according to the device and subvendor
148 static int serverworks_cable_detect(struct ata_port *ap)
150 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
151 struct sv_cable_table *cb = cable_detect;
154 if (cb->device == pdev->device &&
155 (cb->subvendor == pdev->subsystem_vendor ||
156 cb->subvendor == PCI_ANY_ID)) {
157 return cb->cable_detect(ap);
163 return -1; /* kill compiler warning */
167 * serverworks_is_csb - Check for CSB or OSB
168 * @pdev: PCI device to check
170 * Returns true if the device being checked is known to be a CSB
174 static u8 serverworks_is_csb(struct pci_dev *pdev)
176 switch (pdev->device) {
177 case PCI_DEVICE_ID_SERVERWORKS_CSB5IDE:
178 case PCI_DEVICE_ID_SERVERWORKS_CSB6IDE:
179 case PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2:
180 case PCI_DEVICE_ID_SERVERWORKS_HT1000IDE:
189 * serverworks_osb4_filter - mode selection filter
191 * @mask: Mask of proposed modes
193 * Filter the offered modes for the device to apply controller
194 * specific rules. OSB4 requires no UDMA for disks due to a FIFO
198 static unsigned long serverworks_osb4_filter(struct ata_device *adev, unsigned long mask)
200 if (adev->class == ATA_DEV_ATA)
201 mask &= ~ATA_MASK_UDMA;
202 return ata_pci_default_filter(adev, mask);
207 * serverworks_csb_filter - mode selection filter
209 * @mask: Mask of proposed modes
211 * Check the blacklist and disable UDMA5 if matched
214 static unsigned long serverworks_csb_filter(struct ata_device *adev, unsigned long mask)
217 char model_num[ATA_ID_PROD_LEN + 1];
221 if (adev->class != ATA_DEV_ATA)
222 return ata_pci_default_filter(adev, mask);
224 /* Actually do need to check */
225 ata_id_c_string(adev->id, model_num, ATA_ID_PROD, sizeof(model_num));
227 for (i = 0; (p = csb_bad_ata100[i]) != NULL; i++) {
228 if (!strcmp(p, model_num))
229 mask &= ~(0x1F << ATA_SHIFT_UDMA);
231 return ata_pci_default_filter(adev, mask);
236 * serverworks_set_piomode - set initial PIO mode data
240 * Program the OSB4/CSB5 timing registers for PIO. The PIO register
241 * load is done as a simple lookup.
243 static void serverworks_set_piomode(struct ata_port *ap, struct ata_device *adev)
245 static const u8 pio_mode[] = { 0x5d, 0x47, 0x34, 0x22, 0x20 };
246 int offset = 1 + (2 * ap->port_no) - adev->devno;
247 int devbits = (2 * ap->port_no + adev->devno) * 4;
249 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
250 int pio = adev->pio_mode - XFER_PIO_0;
252 pci_write_config_byte(pdev, 0x40 + offset, pio_mode[pio]);
254 /* The OSB4 just requires the timing but the CSB series want the
255 mode number as well */
256 if (serverworks_is_csb(pdev)) {
257 pci_read_config_word(pdev, 0x4A, &csb5_pio);
258 csb5_pio &= ~(0x0F << devbits);
259 pci_write_config_byte(pdev, 0x4A, csb5_pio | (pio << devbits));
264 * serverworks_set_dmamode - set initial DMA mode data
268 * Program the MWDMA/UDMA modes for the serverworks OSB4/CSB5
269 * chipset. The MWDMA mode values are pulled from a lookup table
270 * while the chipset uses mode number for UDMA.
273 static void serverworks_set_dmamode(struct ata_port *ap, struct ata_device *adev)
275 static const u8 dma_mode[] = { 0x77, 0x21, 0x20 };
276 int offset = 1 + 2 * ap->port_no - adev->devno;
277 int devbits = (2 * ap->port_no + adev->devno);
280 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
282 pci_read_config_byte(pdev, 0x54, &ultra_cfg);
284 if (adev->dma_mode >= XFER_UDMA_0) {
285 pci_write_config_byte(pdev, 0x44 + offset, 0x20);
287 pci_read_config_byte(pdev, 0x56 + ap->port_no, &ultra);
288 ultra &= ~(0x0F << (ap->port_no * 4));
289 ultra |= (adev->dma_mode - XFER_UDMA_0)
290 << (ap->port_no * 4);
291 pci_write_config_byte(pdev, 0x56 + ap->port_no, ultra);
293 ultra_cfg |= (1 << devbits);
295 pci_write_config_byte(pdev, 0x44 + offset,
296 dma_mode[adev->dma_mode - XFER_MW_DMA_0]);
297 ultra_cfg &= ~(1 << devbits);
299 pci_write_config_byte(pdev, 0x54, ultra_cfg);
302 static struct scsi_host_template serverworks_sht = {
303 .module = THIS_MODULE,
305 .ioctl = ata_scsi_ioctl,
306 .queuecommand = ata_scsi_queuecmd,
307 .can_queue = ATA_DEF_QUEUE,
308 .this_id = ATA_SHT_THIS_ID,
309 .sg_tablesize = LIBATA_MAX_PRD,
310 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
311 .emulated = ATA_SHT_EMULATED,
312 .use_clustering = ATA_SHT_USE_CLUSTERING,
313 .proc_name = DRV_NAME,
314 .dma_boundary = ATA_DMA_BOUNDARY,
315 .slave_configure = ata_scsi_slave_config,
316 .slave_destroy = ata_scsi_slave_destroy,
317 .bios_param = ata_std_bios_param,
320 static struct ata_port_operations serverworks_osb4_port_ops = {
321 .port_disable = ata_port_disable,
322 .set_piomode = serverworks_set_piomode,
323 .set_dmamode = serverworks_set_dmamode,
324 .mode_filter = serverworks_osb4_filter,
326 .tf_load = ata_tf_load,
327 .tf_read = ata_tf_read,
328 .check_status = ata_check_status,
329 .exec_command = ata_exec_command,
330 .dev_select = ata_std_dev_select,
332 .freeze = ata_bmdma_freeze,
333 .thaw = ata_bmdma_thaw,
334 .error_handler = ata_bmdma_error_handler,
335 .post_internal_cmd = ata_bmdma_post_internal_cmd,
336 .cable_detect = serverworks_cable_detect,
338 .bmdma_setup = ata_bmdma_setup,
339 .bmdma_start = ata_bmdma_start,
340 .bmdma_stop = ata_bmdma_stop,
341 .bmdma_status = ata_bmdma_status,
343 .qc_prep = ata_qc_prep,
344 .qc_issue = ata_qc_issue_prot,
346 .data_xfer = ata_data_xfer,
348 .irq_handler = ata_interrupt,
349 .irq_clear = ata_bmdma_irq_clear,
350 .irq_on = ata_irq_on,
351 .irq_ack = ata_irq_ack,
353 .port_start = ata_port_start,
356 static struct ata_port_operations serverworks_csb_port_ops = {
357 .port_disable = ata_port_disable,
358 .set_piomode = serverworks_set_piomode,
359 .set_dmamode = serverworks_set_dmamode,
360 .mode_filter = serverworks_csb_filter,
362 .tf_load = ata_tf_load,
363 .tf_read = ata_tf_read,
364 .check_status = ata_check_status,
365 .exec_command = ata_exec_command,
366 .dev_select = ata_std_dev_select,
368 .freeze = ata_bmdma_freeze,
369 .thaw = ata_bmdma_thaw,
370 .error_handler = ata_bmdma_error_handler,
371 .post_internal_cmd = ata_bmdma_post_internal_cmd,
372 .cable_detect = serverworks_cable_detect,
374 .bmdma_setup = ata_bmdma_setup,
375 .bmdma_start = ata_bmdma_start,
376 .bmdma_stop = ata_bmdma_stop,
377 .bmdma_status = ata_bmdma_status,
379 .qc_prep = ata_qc_prep,
380 .qc_issue = ata_qc_issue_prot,
382 .data_xfer = ata_data_xfer,
384 .irq_handler = ata_interrupt,
385 .irq_clear = ata_bmdma_irq_clear,
386 .irq_on = ata_irq_on,
387 .irq_ack = ata_irq_ack,
389 .port_start = ata_port_start,
392 static int serverworks_fixup_osb4(struct pci_dev *pdev)
395 struct pci_dev *isa_dev = pci_get_device(PCI_VENDOR_ID_SERVERWORKS,
396 PCI_DEVICE_ID_SERVERWORKS_OSB4, NULL);
398 pci_read_config_dword(isa_dev, 0x64, ®);
399 reg &= ~0x00002000; /* disable 600ns interrupt mask */
400 if (!(reg & 0x00004000))
401 printk(KERN_DEBUG DRV_NAME ": UDMA not BIOS enabled.\n");
402 reg |= 0x00004000; /* enable UDMA/33 support */
403 pci_write_config_dword(isa_dev, 0x64, reg);
404 pci_dev_put(isa_dev);
407 printk(KERN_WARNING "ata_serverworks: Unable to find bridge.\n");
411 static int serverworks_fixup_csb(struct pci_dev *pdev)
416 pci_read_config_byte(pdev, PCI_REVISION_ID, &rev);
418 /* Third Channel Test */
419 if (!(PCI_FUNC(pdev->devfn) & 1)) {
420 struct pci_dev * findev = NULL;
422 findev = pci_get_device(PCI_VENDOR_ID_SERVERWORKS,
423 PCI_DEVICE_ID_SERVERWORKS_CSB5, NULL);
425 pci_read_config_dword(findev, 0x4C, ®4c);
426 reg4c &= ~0x000007FF;
429 pci_write_config_dword(findev, 0x4C, reg4c);
433 struct pci_dev * findev = NULL;
436 findev = pci_get_device(PCI_VENDOR_ID_SERVERWORKS,
437 PCI_DEVICE_ID_SERVERWORKS_CSB6, NULL);
439 pci_read_config_byte(findev, 0x41, ®41);
441 pci_write_config_byte(findev, 0x41, reg41);
445 /* setup the UDMA Control register
447 * 1. clear bit 6 to enable DMA
448 * 2. enable DMA modes with bits 0-1
452 * 11 : udma2/udma4/udma5
454 pci_read_config_byte(pdev, 0x5A, &btr);
456 if (!(PCI_FUNC(pdev->devfn) & 1))
459 btr |= (rev >= SVWKS_CSB5_REVISION_NEW) ? 0x3 : 0x2;
460 pci_write_config_byte(pdev, 0x5A, btr);
465 static void serverworks_fixup_ht1000(struct pci_dev *pdev)
468 /* Setup HT1000 SouthBridge Controller - Single Channel Only */
469 pci_read_config_byte(pdev, 0x5A, &btr);
472 pci_write_config_byte(pdev, 0x5A, btr);
476 static int serverworks_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
479 static struct ata_port_info info[4] = {
481 .sht = &serverworks_sht,
482 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
486 .port_ops = &serverworks_osb4_port_ops
487 }, { /* OSB4 no UDMA */
488 .sht = &serverworks_sht,
489 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
493 .port_ops = &serverworks_osb4_port_ops
495 .sht = &serverworks_sht,
496 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
500 .port_ops = &serverworks_csb_port_ops
501 }, { /* CSB5 - later revisions*/
502 .sht = &serverworks_sht,
503 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
507 .port_ops = &serverworks_csb_port_ops
510 static struct ata_port_info *port_info[2];
511 struct ata_port_info *devinfo = &info[id->driver_data];
513 /* Force master latency timer to 64 PCI clocks */
514 pci_write_config_byte(pdev, PCI_LATENCY_TIMER, 0x40);
516 /* OSB4 : South Bridge and IDE */
517 if (pdev->device == PCI_DEVICE_ID_SERVERWORKS_OSB4IDE) {
518 /* Select non UDMA capable OSB4 if we can't do fixups */
519 if ( serverworks_fixup_osb4(pdev) < 0)
522 /* setup CSB5/CSB6 : South Bridge and IDE option RAID */
523 else if ((pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB5IDE) ||
524 (pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE) ||
525 (pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2)) {
527 /* If the returned btr is the newer revision then
528 select the right info block */
529 if (serverworks_fixup_csb(pdev) == 3)
532 /* Is this the 3rd channel CSB6 IDE ? */
533 if (pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2)
537 else if (pdev->device == PCI_DEVICE_ID_SERVERWORKS_HT1000IDE)
538 serverworks_fixup_ht1000(pdev);
540 if (pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB5IDE)
541 ata_pci_clear_simplex(pdev);
543 port_info[0] = port_info[1] = devinfo;
544 return ata_pci_init_one(pdev, port_info, ports);
548 static int serverworks_reinit_one(struct pci_dev *pdev)
550 /* Force master latency timer to 64 PCI clocks */
551 pci_write_config_byte(pdev, PCI_LATENCY_TIMER, 0x40);
553 switch (pdev->device)
555 case PCI_DEVICE_ID_SERVERWORKS_OSB4IDE:
556 serverworks_fixup_osb4(pdev);
558 case PCI_DEVICE_ID_SERVERWORKS_CSB5IDE:
559 ata_pci_clear_simplex(pdev);
561 case PCI_DEVICE_ID_SERVERWORKS_CSB6IDE:
562 case PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2:
563 serverworks_fixup_csb(pdev);
565 case PCI_DEVICE_ID_SERVERWORKS_HT1000IDE:
566 serverworks_fixup_ht1000(pdev);
569 return ata_pci_device_resume(pdev);
573 static const struct pci_device_id serverworks[] = {
574 { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_OSB4IDE), 0},
575 { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_CSB5IDE), 2},
576 { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_CSB6IDE), 2},
577 { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2), 2},
578 { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_HT1000IDE), 2},
583 static struct pci_driver serverworks_pci_driver = {
585 .id_table = serverworks,
586 .probe = serverworks_init_one,
587 .remove = ata_pci_remove_one,
589 .suspend = ata_pci_device_suspend,
590 .resume = serverworks_reinit_one,
594 static int __init serverworks_init(void)
596 return pci_register_driver(&serverworks_pci_driver);
599 static void __exit serverworks_exit(void)
601 pci_unregister_driver(&serverworks_pci_driver);
604 MODULE_AUTHOR("Alan Cox");
605 MODULE_DESCRIPTION("low-level driver for Serverworks OSB4/CSB5/CSB6");
606 MODULE_LICENSE("GPL");
607 MODULE_DEVICE_TABLE(pci, serverworks);
608 MODULE_VERSION(DRV_VERSION);
610 module_init(serverworks_init);
611 module_exit(serverworks_exit);