2 * pata_optidma.c - Opti DMA PATA for new ATA layer
4 * Alan Cox <alan@redhat.com>
6 * The Opti DMA controllers are related to the older PIO PCI controllers
7 * and indeed the VLB ones. The main differences are that the timing
8 * numbers are now based off PCI clocks not VLB and differ, and that
11 * This driver should support Viper-N+, FireStar, FireStar Plus.
13 * These devices support virtual DMA for read (aka the CS5520). Later
14 * chips support UDMA33, but only if the rest of the board logic does,
15 * so you have to get this right. We don't support the virtual DMA
16 * but we do handle UDMA.
18 * Bits that are worth knowing
19 * Most control registers are shadowed into I/O registers
20 * 0x1F5 bit 0 tells you if the PCI/VLB clock is 33 or 25Mhz
21 * Virtual DMA registers *move* between rev 0x02 and rev 0x10
22 * UDMA requires a 66MHz FSB
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/pci.h>
29 #include <linux/init.h>
30 #include <linux/blkdev.h>
31 #include <linux/delay.h>
32 #include <scsi/scsi_host.h>
33 #include <linux/libata.h>
35 #define DRV_NAME "pata_optidma"
36 #define DRV_VERSION "0.2.1"
39 READ_REG
= 0, /* index of Read cycle timing register */
40 WRITE_REG
= 1, /* index of Write cycle timing register */
41 CNTRL_REG
= 3, /* index of Control register */
42 STRAP_REG
= 5, /* index of Strap register */
43 MISC_REG
= 6 /* index of Miscellaneous register */
46 static int pci_clock
; /* 0 = 33 1 = 25 */
49 * optidma_pre_reset - probe begin
52 * Set up cable type and use generic probe init
55 static int optidma_pre_reset(struct ata_port
*ap
)
57 struct pci_dev
*pdev
= to_pci_dev(ap
->host
->dev
);
58 static const struct pci_bits optidma_enable_bits
= {
62 if (ap
->port_no
&& !pci_test_config_bits(pdev
, &optidma_enable_bits
)) {
64 printk(KERN_INFO
"ata%u: port disabled. ignoring.\n", ap
->id
);
67 ap
->cbl
= ATA_CBL_PATA40
;
68 return ata_std_prereset(ap
);
72 * optidma_probe_reset - probe reset
75 * Perform the ATA probe and bus reset sequence plus specific handling
76 * for this hardware. The Opti needs little handling - we have no UDMA66
77 * capability that needs cable detection. All we must do is check the port
81 static void optidma_error_handler(struct ata_port
*ap
)
83 ata_bmdma_drive_eh(ap
, optidma_pre_reset
, ata_std_softreset
, NULL
, ata_std_postreset
);
87 * optidma_unlock - unlock control registers
90 * Unlock the control register block for this adapter. Registers must not
91 * be unlocked in a situation where libata might look at them.
94 static void optidma_unlock(struct ata_port
*ap
)
96 unsigned long regio
= ap
->ioaddr
.cmd_addr
;
98 /* These 3 unlock the control register access */
105 * optidma_lock - issue temporary relock
108 * Re-lock the configuration register settings.
111 static void optidma_lock(struct ata_port
*ap
)
113 unsigned long regio
= ap
->ioaddr
.cmd_addr
;
116 outb(0x83, regio
+ 2);
120 * optidma_set_mode - set mode data
125 * Called to do the DMA or PIO mode setup. Timing numbers are all
126 * pre computed to keep the code clean. There are two tables depending
127 * on the hardware clock speed.
129 * WARNING: While we do this the IDE registers vanish. If we take an
130 * IRQ here we depend on the host set locking to avoid catastrophe.
133 static void optidma_set_mode(struct ata_port
*ap
, struct ata_device
*adev
, u8 mode
)
135 struct ata_device
*pair
= ata_dev_pair(adev
);
136 int pio
= adev
->pio_mode
- XFER_PIO_0
;
137 int dma
= adev
->dma_mode
- XFER_MW_DMA_0
;
138 unsigned long regio
= ap
->ioaddr
.cmd_addr
;
141 /* Address table precomputed with a DCLK of 2 */
142 static const u8 addr_timing
[2][5] = {
143 { 0x30, 0x20, 0x20, 0x10, 0x10 },
144 { 0x20, 0x20, 0x10, 0x10, 0x10 }
146 static const u8 data_rec_timing
[2][5] = {
147 { 0x59, 0x46, 0x30, 0x20, 0x20 },
148 { 0x46, 0x32, 0x20, 0x20, 0x10 }
150 static const u8 dma_data_rec_timing
[2][3] = {
151 { 0x76, 0x20, 0x20 },
155 /* Switch from IDE to control mode */
160 * As with many controllers the address setup time is shared
161 * and must suit both devices if present. FIXME: Check if we
162 * need to look at slowest of PIO/DMA mode of either device
165 if (mode
>= XFER_MW_DMA_0
)
168 addr
= addr_timing
[pci_clock
][pio
];
172 /* Hardware constraint */
176 pair_addr
= addr_timing
[pci_clock
][pair
->pio_mode
- XFER_PIO_0
];
177 if (pair_addr
> addr
)
181 /* Commence primary programming sequence */
182 /* First we load the device number into the timing select */
183 outb(adev
->devno
, regio
+ MISC_REG
);
184 /* Now we load the data timings into read data/write data */
185 if (mode
< XFER_MW_DMA_0
) {
186 outb(data_rec_timing
[pci_clock
][pio
], regio
+ READ_REG
);
187 outb(data_rec_timing
[pci_clock
][pio
], regio
+ WRITE_REG
);
188 } else if (mode
< XFER_UDMA_0
) {
189 outb(dma_data_rec_timing
[pci_clock
][dma
], regio
+ READ_REG
);
190 outb(dma_data_rec_timing
[pci_clock
][dma
], regio
+ WRITE_REG
);
192 /* Finally we load the address setup into the misc register */
193 outb(addr
| adev
->devno
, regio
+ MISC_REG
);
195 /* Programming sequence complete, timing 0 dev 0, timing 1 dev 1 */
196 outb(0x85, regio
+ CNTRL_REG
);
198 /* Switch back to IDE mode */
201 /* Note: at this point our programming is incomplete. We are
202 not supposed to program PCI 0x43 "things we hacked onto the chip"
203 until we've done both sets of PIO/DMA timings */
207 * optiplus_set_mode - DMA setup for Firestar Plus
210 * @mode: desired mode
212 * The Firestar plus has additional UDMA functionality for UDMA0-2 and
213 * requires we do some additional work. Because the base work we must do
214 * is mostly shared we wrap the Firestar setup functionality in this
218 static void optiplus_set_mode(struct ata_port
*ap
, struct ata_device
*adev
, u8 mode
)
220 struct pci_dev
*pdev
= to_pci_dev(ap
->host
->dev
);
223 int dev2
= 2 * adev
->devno
;
224 int unit
= 2 * ap
->port_no
+ adev
->devno
;
225 int udma
= mode
- XFER_UDMA_0
;
227 pci_read_config_byte(pdev
, 0x44, &udcfg
);
228 if (mode
<= XFER_UDMA_0
) {
229 udcfg
&= ~(1 << unit
);
230 optidma_set_mode(ap
, adev
, adev
->dma_mode
);
232 udcfg
|= (1 << unit
);
234 pci_read_config_byte(pdev
, 0x45, &udslave
);
235 udslave
&= ~(0x03 << dev2
);
236 udslave
|= (udma
<< dev2
);
237 pci_write_config_byte(pdev
, 0x45, udslave
);
239 udcfg
&= ~(0x30 << dev2
);
240 udcfg
|= (udma
<< dev2
);
243 pci_write_config_byte(pdev
, 0x44, udcfg
);
247 * optidma_set_pio_mode - PIO setup callback
251 * The libata core provides separate functions for handling PIO and
252 * DMA programming. The architecture of the Firestar makes it easier
253 * for us to have a common function so we provide wrappers
256 static void optidma_set_pio_mode(struct ata_port
*ap
, struct ata_device
*adev
)
258 optidma_set_mode(ap
, adev
, adev
->pio_mode
);
262 * optidma_set_dma_mode - DMA setup callback
266 * The libata core provides separate functions for handling PIO and
267 * DMA programming. The architecture of the Firestar makes it easier
268 * for us to have a common function so we provide wrappers
271 static void optidma_set_dma_mode(struct ata_port
*ap
, struct ata_device
*adev
)
273 optidma_set_mode(ap
, adev
, adev
->dma_mode
);
277 * optiplus_set_pio_mode - PIO setup callback
281 * The libata core provides separate functions for handling PIO and
282 * DMA programming. The architecture of the Firestar makes it easier
283 * for us to have a common function so we provide wrappers
286 static void optiplus_set_pio_mode(struct ata_port
*ap
, struct ata_device
*adev
)
288 optiplus_set_mode(ap
, adev
, adev
->pio_mode
);
292 * optiplus_set_dma_mode - DMA setup callback
296 * The libata core provides separate functions for handling PIO and
297 * DMA programming. The architecture of the Firestar makes it easier
298 * for us to have a common function so we provide wrappers
301 static void optiplus_set_dma_mode(struct ata_port
*ap
, struct ata_device
*adev
)
303 optiplus_set_mode(ap
, adev
, adev
->dma_mode
);
307 * optidma_make_bits - PCI setup helper
310 * Turn the ATA device setup into PCI configuration bits
311 * for register 0x43 and return the two bits needed.
314 static u8
optidma_make_bits43(struct ata_device
*adev
)
316 static const u8 bits43
[5] = {
319 if (!ata_dev_enabled(adev
))
322 return adev
->dma_mode
- XFER_MW_DMA_0
;
323 return bits43
[adev
->pio_mode
- XFER_PIO_0
];
327 * optidma_post_set_mode - finalize PCI setup
328 * @ap: port to set up
330 * Finalise the configuration by writing the nibble of extra bits
331 * of data into the chip.
334 static void optidma_post_set_mode(struct ata_port
*ap
)
337 int nybble
= 4 * ap
->port_no
;
338 struct pci_dev
*pdev
= to_pci_dev(ap
->host
->dev
);
340 pci_read_config_byte(pdev
, 0x43, &r
);
342 r
&= (0x0F << nybble
);
343 r
|= (optidma_make_bits43(&ap
->device
[0]) +
344 (optidma_make_bits43(&ap
->device
[0]) << 2)) << nybble
;
346 pci_write_config_byte(pdev
, 0x43, r
);
349 static struct scsi_host_template optidma_sht
= {
350 .module
= THIS_MODULE
,
352 .ioctl
= ata_scsi_ioctl
,
353 .queuecommand
= ata_scsi_queuecmd
,
354 .can_queue
= ATA_DEF_QUEUE
,
355 .this_id
= ATA_SHT_THIS_ID
,
356 .sg_tablesize
= LIBATA_MAX_PRD
,
357 .max_sectors
= ATA_MAX_SECTORS
,
358 .cmd_per_lun
= ATA_SHT_CMD_PER_LUN
,
359 .emulated
= ATA_SHT_EMULATED
,
360 .use_clustering
= ATA_SHT_USE_CLUSTERING
,
361 .proc_name
= DRV_NAME
,
362 .dma_boundary
= ATA_DMA_BOUNDARY
,
363 .slave_configure
= ata_scsi_slave_config
,
364 .bios_param
= ata_std_bios_param
,
367 static struct ata_port_operations optidma_port_ops
= {
368 .port_disable
= ata_port_disable
,
369 .set_piomode
= optidma_set_pio_mode
,
370 .set_dmamode
= optidma_set_dma_mode
,
372 .tf_load
= ata_tf_load
,
373 .tf_read
= ata_tf_read
,
374 .check_status
= ata_check_status
,
375 .exec_command
= ata_exec_command
,
376 .dev_select
= ata_std_dev_select
,
378 .freeze
= ata_bmdma_freeze
,
379 .thaw
= ata_bmdma_thaw
,
380 .post_internal_cmd
= ata_bmdma_post_internal_cmd
,
381 .error_handler
= optidma_error_handler
,
382 .post_set_mode
= optidma_post_set_mode
,
384 .bmdma_setup
= ata_bmdma_setup
,
385 .bmdma_start
= ata_bmdma_start
,
386 .bmdma_stop
= ata_bmdma_stop
,
387 .bmdma_status
= ata_bmdma_status
,
389 .qc_prep
= ata_qc_prep
,
390 .qc_issue
= ata_qc_issue_prot
,
391 .eng_timeout
= ata_eng_timeout
,
392 .data_xfer
= ata_pio_data_xfer
,
394 .irq_handler
= ata_interrupt
,
395 .irq_clear
= ata_bmdma_irq_clear
,
397 .port_start
= ata_port_start
,
398 .port_stop
= ata_port_stop
,
399 .host_stop
= ata_host_stop
402 static struct ata_port_operations optiplus_port_ops
= {
403 .port_disable
= ata_port_disable
,
404 .set_piomode
= optiplus_set_pio_mode
,
405 .set_dmamode
= optiplus_set_dma_mode
,
407 .tf_load
= ata_tf_load
,
408 .tf_read
= ata_tf_read
,
409 .check_status
= ata_check_status
,
410 .exec_command
= ata_exec_command
,
411 .dev_select
= ata_std_dev_select
,
413 .freeze
= ata_bmdma_freeze
,
414 .thaw
= ata_bmdma_thaw
,
415 .post_internal_cmd
= ata_bmdma_post_internal_cmd
,
416 .error_handler
= optidma_error_handler
,
417 .post_set_mode
= optidma_post_set_mode
,
419 .bmdma_setup
= ata_bmdma_setup
,
420 .bmdma_start
= ata_bmdma_start
,
421 .bmdma_stop
= ata_bmdma_stop
,
422 .bmdma_status
= ata_bmdma_status
,
424 .qc_prep
= ata_qc_prep
,
425 .qc_issue
= ata_qc_issue_prot
,
426 .eng_timeout
= ata_eng_timeout
,
427 .data_xfer
= ata_pio_data_xfer
,
429 .irq_handler
= ata_interrupt
,
430 .irq_clear
= ata_bmdma_irq_clear
,
432 .port_start
= ata_port_start
,
433 .port_stop
= ata_port_stop
,
434 .host_stop
= ata_host_stop
438 * optiplus_with_udma - Look for UDMA capable setup
439 * @pdev; ATA controller
442 static int optiplus_with_udma(struct pci_dev
*pdev
)
447 struct pci_dev
*dev1
;
449 /* Find function 1 */
450 dev1
= pci_get_device(0x1045, 0xC701, NULL
);
454 /* Rev must be >= 0x10 */
455 pci_read_config_byte(dev1
, 0x08, &r
);
458 /* Read the chipset system configuration to check our mode */
459 pci_read_config_byte(dev1
, 0x5F, &r
);
462 /* Must be 66Mhz sync */
463 if ((inb(ioport
+ 2) & 1) == 0)
466 /* Check the ATA arbitration/timing is suitable */
467 pci_read_config_byte(pdev
, 0x42, &r
);
468 if ((r
& 0x36) != 0x36)
470 pci_read_config_byte(dev1
, 0x52, &r
);
471 if (r
& 0x80) /* IDEDIR disabled */
474 printk(KERN_WARNING
"UDMA not supported in this configuration.\n");
475 done_nomsg
: /* Wrong chip revision */
480 static int optidma_init_one(struct pci_dev
*dev
, const struct pci_device_id
*id
)
482 static struct ata_port_info info_82c700
= {
484 .flags
= ATA_FLAG_SLAVE_POSS
| ATA_FLAG_SRST
,
487 .port_ops
= &optidma_port_ops
489 static struct ata_port_info info_82c700_udma
= {
491 .flags
= ATA_FLAG_SLAVE_POSS
| ATA_FLAG_SRST
,
495 .port_ops
= &optiplus_port_ops
497 static struct ata_port_info
*port_info
[2];
498 struct ata_port_info
*info
= &info_82c700
;
499 static int printed_version
;
501 if (!printed_version
++)
502 dev_printk(KERN_DEBUG
, &dev
->dev
, "version " DRV_VERSION
"\n");
504 /* Fixed location chipset magic */
507 pci_clock
= inb(0x1F5) & 1; /* 0 = 33Mhz, 1 = 25Mhz */
509 if (optiplus_with_udma(dev
))
510 info
= &info_82c700_udma
;
512 port_info
[0] = port_info
[1] = info
;
513 return ata_pci_init_one(dev
, port_info
, 2);
516 static const struct pci_device_id optidma
[] = {
517 { PCI_DEVICE(0x1045, 0xD568), }, /* Opti 82C700 */
521 static struct pci_driver optidma_pci_driver
= {
524 .probe
= optidma_init_one
,
525 .remove
= ata_pci_remove_one
528 static int __init
optidma_init(void)
530 return pci_register_driver(&optidma_pci_driver
);
534 static void __exit
optidma_exit(void)
536 pci_unregister_driver(&optidma_pci_driver
);
540 MODULE_AUTHOR("Alan Cox");
541 MODULE_DESCRIPTION("low-level driver for Opti Firestar/Firestar Plus");
542 MODULE_LICENSE("GPL");
543 MODULE_DEVICE_TABLE(pci
, optidma
);
544 MODULE_VERSION(DRV_VERSION
);
546 module_init(optidma_init
);
547 module_exit(optidma_exit
);