2 * sata_svw.c - ServerWorks / Apple K2 SATA
4 * Maintained by: Benjamin Herrenschmidt <benh@kernel.crashing.org> and
5 * Jeff Garzik <jgarzik@pobox.com>
6 * Please ALWAYS copy linux-ide@vger.kernel.org
9 * Copyright 2003 Benjamin Herrenschmidt <benh@kernel.crashing.org>
11 * Bits from Jeff Garzik, Copyright RedHat, Inc.
13 * This driver probably works with non-Apple versions of the
17 * This program is free software; you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation; either version 2, or (at your option)
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program; see the file COPYING. If not, write to
29 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
32 * libata documentation is available via 'make {ps|pdf}docs',
33 * as Documentation/DocBook/libata.*
35 * Hardware documentation available under NDA.
39 #include <linux/kernel.h>
40 #include <linux/module.h>
41 #include <linux/pci.h>
42 #include <linux/init.h>
43 #include <linux/blkdev.h>
44 #include <linux/delay.h>
45 #include <linux/interrupt.h>
46 #include <linux/device.h>
47 #include <scsi/scsi_host.h>
48 #include <scsi/scsi_cmnd.h>
49 #include <scsi/scsi.h>
50 #include <linux/libata.h>
54 #include <asm/pci-bridge.h>
55 #endif /* CONFIG_PPC_OF */
57 #define DRV_NAME "sata_svw"
58 #define DRV_VERSION "2.3"
62 K2_FLAG_SATA_8_PORTS
= (1 << 24),
63 K2_FLAG_NO_ATAPI_DMA
= (1 << 25),
64 K2_FLAG_BAR_POS_3
= (1 << 26),
66 /* Taskfile registers offsets */
67 K2_SATA_TF_CMD_OFFSET
= 0x00,
68 K2_SATA_TF_DATA_OFFSET
= 0x00,
69 K2_SATA_TF_ERROR_OFFSET
= 0x04,
70 K2_SATA_TF_NSECT_OFFSET
= 0x08,
71 K2_SATA_TF_LBAL_OFFSET
= 0x0c,
72 K2_SATA_TF_LBAM_OFFSET
= 0x10,
73 K2_SATA_TF_LBAH_OFFSET
= 0x14,
74 K2_SATA_TF_DEVICE_OFFSET
= 0x18,
75 K2_SATA_TF_CMDSTAT_OFFSET
= 0x1c,
76 K2_SATA_TF_CTL_OFFSET
= 0x20,
79 K2_SATA_DMA_CMD_OFFSET
= 0x30,
82 K2_SATA_SCR_STATUS_OFFSET
= 0x40,
83 K2_SATA_SCR_ERROR_OFFSET
= 0x44,
84 K2_SATA_SCR_CONTROL_OFFSET
= 0x48,
87 K2_SATA_SICR1_OFFSET
= 0x80,
88 K2_SATA_SICR2_OFFSET
= 0x84,
89 K2_SATA_SIM_OFFSET
= 0x88,
92 K2_SATA_PORT_OFFSET
= 0x100,
96 chip_svw42
= 2, /* bar 3 */
97 chip_svw43
= 3, /* bar 5 */
100 static u8
k2_stat_check_status(struct ata_port
*ap
);
103 static int k2_sata_check_atapi_dma(struct ata_queued_cmd
*qc
)
105 u8 cmnd
= qc
->scsicmd
->cmnd
[0];
107 if (qc
->ap
->flags
& K2_FLAG_NO_ATAPI_DMA
)
108 return -1; /* ATAPI DMA not supported */
126 static int k2_sata_scr_read(struct ata_link
*link
,
127 unsigned int sc_reg
, u32
*val
)
129 if (sc_reg
> SCR_CONTROL
)
131 *val
= readl(link
->ap
->ioaddr
.scr_addr
+ (sc_reg
* 4));
136 static int k2_sata_scr_write(struct ata_link
*link
,
137 unsigned int sc_reg
, u32 val
)
139 if (sc_reg
> SCR_CONTROL
)
141 writel(val
, link
->ap
->ioaddr
.scr_addr
+ (sc_reg
* 4));
146 static void k2_sata_tf_load(struct ata_port
*ap
, const struct ata_taskfile
*tf
)
148 struct ata_ioports
*ioaddr
= &ap
->ioaddr
;
149 unsigned int is_addr
= tf
->flags
& ATA_TFLAG_ISADDR
;
151 if (tf
->ctl
!= ap
->last_ctl
) {
152 writeb(tf
->ctl
, ioaddr
->ctl_addr
);
153 ap
->last_ctl
= tf
->ctl
;
156 if (is_addr
&& (tf
->flags
& ATA_TFLAG_LBA48
)) {
157 writew(tf
->feature
| (((u16
)tf
->hob_feature
) << 8),
158 ioaddr
->feature_addr
);
159 writew(tf
->nsect
| (((u16
)tf
->hob_nsect
) << 8),
161 writew(tf
->lbal
| (((u16
)tf
->hob_lbal
) << 8),
163 writew(tf
->lbam
| (((u16
)tf
->hob_lbam
) << 8),
165 writew(tf
->lbah
| (((u16
)tf
->hob_lbah
) << 8),
167 } else if (is_addr
) {
168 writew(tf
->feature
, ioaddr
->feature_addr
);
169 writew(tf
->nsect
, ioaddr
->nsect_addr
);
170 writew(tf
->lbal
, ioaddr
->lbal_addr
);
171 writew(tf
->lbam
, ioaddr
->lbam_addr
);
172 writew(tf
->lbah
, ioaddr
->lbah_addr
);
175 if (tf
->flags
& ATA_TFLAG_DEVICE
)
176 writeb(tf
->device
, ioaddr
->device_addr
);
182 static void k2_sata_tf_read(struct ata_port
*ap
, struct ata_taskfile
*tf
)
184 struct ata_ioports
*ioaddr
= &ap
->ioaddr
;
185 u16 nsect
, lbal
, lbam
, lbah
, feature
;
187 tf
->command
= k2_stat_check_status(ap
);
188 tf
->device
= readw(ioaddr
->device_addr
);
189 feature
= readw(ioaddr
->error_addr
);
190 nsect
= readw(ioaddr
->nsect_addr
);
191 lbal
= readw(ioaddr
->lbal_addr
);
192 lbam
= readw(ioaddr
->lbam_addr
);
193 lbah
= readw(ioaddr
->lbah_addr
);
195 tf
->feature
= feature
;
201 if (tf
->flags
& ATA_TFLAG_LBA48
) {
202 tf
->hob_feature
= feature
>> 8;
203 tf
->hob_nsect
= nsect
>> 8;
204 tf
->hob_lbal
= lbal
>> 8;
205 tf
->hob_lbam
= lbam
>> 8;
206 tf
->hob_lbah
= lbah
>> 8;
211 * k2_bmdma_setup_mmio - Set up PCI IDE BMDMA transaction (MMIO)
212 * @qc: Info associated with this ATA transaction.
215 * spin_lock_irqsave(host lock)
218 static void k2_bmdma_setup_mmio(struct ata_queued_cmd
*qc
)
220 struct ata_port
*ap
= qc
->ap
;
221 unsigned int rw
= (qc
->tf
.flags
& ATA_TFLAG_WRITE
);
223 void __iomem
*mmio
= ap
->ioaddr
.bmdma_addr
;
225 /* load PRD table addr. */
226 mb(); /* make sure PRD table writes are visible to controller */
227 writel(ap
->bmdma_prd_dma
, mmio
+ ATA_DMA_TABLE_OFS
);
229 /* specify data direction, triple-check start bit is clear */
230 dmactl
= readb(mmio
+ ATA_DMA_CMD
);
231 dmactl
&= ~(ATA_DMA_WR
| ATA_DMA_START
);
233 dmactl
|= ATA_DMA_WR
;
234 writeb(dmactl
, mmio
+ ATA_DMA_CMD
);
236 /* issue r/w command if this is not a ATA DMA command*/
237 if (qc
->tf
.protocol
!= ATA_PROT_DMA
)
238 ap
->ops
->sff_exec_command(ap
, &qc
->tf
);
242 * k2_bmdma_start_mmio - Start a PCI IDE BMDMA transaction (MMIO)
243 * @qc: Info associated with this ATA transaction.
246 * spin_lock_irqsave(host lock)
249 static void k2_bmdma_start_mmio(struct ata_queued_cmd
*qc
)
251 struct ata_port
*ap
= qc
->ap
;
252 void __iomem
*mmio
= ap
->ioaddr
.bmdma_addr
;
255 /* start host DMA transaction */
256 dmactl
= readb(mmio
+ ATA_DMA_CMD
);
257 writeb(dmactl
| ATA_DMA_START
, mmio
+ ATA_DMA_CMD
);
258 /* This works around possible data corruption.
260 On certain SATA controllers that can be seen when the r/w
261 command is given to the controller before the host DMA is
264 On a Read command, the controller would initiate the
265 command to the drive even before it sees the DMA
266 start. When there are very fast drives connected to the
267 controller, or when the data request hits in the drive
268 cache, there is the possibility that the drive returns a
269 part or all of the requested data to the controller before
270 the DMA start is issued. In this case, the controller
271 would become confused as to what to do with the data. In
272 the worst case when all the data is returned back to the
273 controller, the controller could hang. In other cases it
274 could return partial data returning in data
275 corruption. This problem has been seen in PPC systems and
276 can also appear on an system with very fast disks, where
277 the SATA controller is sitting behind a number of bridges,
278 and hence there is significant latency between the r/w
279 command and the start command. */
280 /* issue r/w command if the access is to ATA */
281 if (qc
->tf
.protocol
== ATA_PROT_DMA
)
282 ap
->ops
->sff_exec_command(ap
, &qc
->tf
);
286 static u8
k2_stat_check_status(struct ata_port
*ap
)
288 return readl(ap
->ioaddr
.status_addr
);
294 * inout : decides on the direction of the dataflow and the meaning of the
296 * buffer: If inout==FALSE data is being written to it else read from it
297 * *start: If inout==FALSE start of the valid data in the buffer
298 * offset: If inout==FALSE offset from the beginning of the imaginary file
299 * from which we start writing into the buffer
300 * length: If inout==FALSE max number of bytes to be written into the buffer
301 * else number of bytes in the buffer
303 static int k2_sata_proc_info(struct Scsi_Host
*shost
, char *page
, char **start
,
304 off_t offset
, int count
, int inout
)
307 struct device_node
*np
;
310 /* Find the ata_port */
311 ap
= ata_shost_to_port(shost
);
315 /* Find the OF node for the PCI device proper */
316 np
= pci_device_to_OF_node(to_pci_dev(ap
->host
->dev
));
320 /* Match it to a port node */
321 index
= (ap
== ap
->host
->ports
[0]) ? 0 : 1;
322 for (np
= np
->child
; np
!= NULL
; np
= np
->sibling
) {
323 const u32
*reg
= of_get_property(np
, "reg", NULL
);
332 len
= sprintf(page
, "devspec: %s\n", np
->full_name
);
336 #endif /* CONFIG_PPC_OF */
339 static struct scsi_host_template k2_sata_sht
= {
340 ATA_BMDMA_SHT(DRV_NAME
),
342 .proc_info
= k2_sata_proc_info
,
347 static struct ata_port_operations k2_sata_ops
= {
348 .inherits
= &ata_bmdma_port_ops
,
349 .sff_tf_load
= k2_sata_tf_load
,
350 .sff_tf_read
= k2_sata_tf_read
,
351 .sff_check_status
= k2_stat_check_status
,
352 .check_atapi_dma
= k2_sata_check_atapi_dma
,
353 .bmdma_setup
= k2_bmdma_setup_mmio
,
354 .bmdma_start
= k2_bmdma_start_mmio
,
355 .scr_read
= k2_sata_scr_read
,
356 .scr_write
= k2_sata_scr_write
,
359 static const struct ata_port_info k2_port_info
[] = {
362 .flags
= ATA_FLAG_SATA
| K2_FLAG_NO_ATAPI_DMA
,
363 .pio_mask
= ATA_PIO4
,
364 .mwdma_mask
= ATA_MWDMA2
,
365 .udma_mask
= ATA_UDMA6
,
366 .port_ops
= &k2_sata_ops
,
370 .flags
= ATA_FLAG_SATA
| K2_FLAG_NO_ATAPI_DMA
|
371 K2_FLAG_SATA_8_PORTS
,
372 .pio_mask
= ATA_PIO4
,
373 .mwdma_mask
= ATA_MWDMA2
,
374 .udma_mask
= ATA_UDMA6
,
375 .port_ops
= &k2_sata_ops
,
379 .flags
= ATA_FLAG_SATA
| K2_FLAG_BAR_POS_3
,
380 .pio_mask
= ATA_PIO4
,
381 .mwdma_mask
= ATA_MWDMA2
,
382 .udma_mask
= ATA_UDMA6
,
383 .port_ops
= &k2_sata_ops
,
387 .flags
= ATA_FLAG_SATA
,
388 .pio_mask
= ATA_PIO4
,
389 .mwdma_mask
= ATA_MWDMA2
,
390 .udma_mask
= ATA_UDMA6
,
391 .port_ops
= &k2_sata_ops
,
395 static void k2_sata_setup_port(struct ata_ioports
*port
, void __iomem
*base
)
397 port
->cmd_addr
= base
+ K2_SATA_TF_CMD_OFFSET
;
398 port
->data_addr
= base
+ K2_SATA_TF_DATA_OFFSET
;
400 port
->error_addr
= base
+ K2_SATA_TF_ERROR_OFFSET
;
401 port
->nsect_addr
= base
+ K2_SATA_TF_NSECT_OFFSET
;
402 port
->lbal_addr
= base
+ K2_SATA_TF_LBAL_OFFSET
;
403 port
->lbam_addr
= base
+ K2_SATA_TF_LBAM_OFFSET
;
404 port
->lbah_addr
= base
+ K2_SATA_TF_LBAH_OFFSET
;
405 port
->device_addr
= base
+ K2_SATA_TF_DEVICE_OFFSET
;
407 port
->status_addr
= base
+ K2_SATA_TF_CMDSTAT_OFFSET
;
408 port
->altstatus_addr
=
409 port
->ctl_addr
= base
+ K2_SATA_TF_CTL_OFFSET
;
410 port
->bmdma_addr
= base
+ K2_SATA_DMA_CMD_OFFSET
;
411 port
->scr_addr
= base
+ K2_SATA_SCR_STATUS_OFFSET
;
415 static int k2_sata_init_one(struct pci_dev
*pdev
, const struct pci_device_id
*ent
)
417 const struct ata_port_info
*ppi
[] =
418 { &k2_port_info
[ent
->driver_data
], NULL
};
419 struct ata_host
*host
;
420 void __iomem
*mmio_base
;
421 int n_ports
, i
, rc
, bar_pos
;
423 ata_print_version_once(&pdev
->dev
, DRV_VERSION
);
427 if (ppi
[0]->flags
& K2_FLAG_SATA_8_PORTS
)
430 host
= ata_host_alloc_pinfo(&pdev
->dev
, ppi
, n_ports
);
435 if (ppi
[0]->flags
& K2_FLAG_BAR_POS_3
)
438 * If this driver happens to only be useful on Apple's K2, then
439 * we should check that here as it has a normal Serverworks ID
441 rc
= pcim_enable_device(pdev
);
446 * Check if we have resources mapped at all (second function may
447 * have been disabled by firmware)
449 if (pci_resource_len(pdev
, bar_pos
) == 0) {
450 /* In IDE mode we need to pin the device to ensure that
451 pcim_release does not clear the busmaster bit in config
452 space, clearing causes busmaster DMA to fail on
454 pcim_pin_device(pdev
);
458 /* Request and iomap PCI regions */
459 rc
= pcim_iomap_regions(pdev
, 1 << bar_pos
, DRV_NAME
);
461 pcim_pin_device(pdev
);
464 host
->iomap
= pcim_iomap_table(pdev
);
465 mmio_base
= host
->iomap
[bar_pos
];
467 /* different controllers have different number of ports - currently 4 or 8 */
468 /* All ports are on the same function. Multi-function device is no
469 * longer available. This should not be seen in any system. */
470 for (i
= 0; i
< host
->n_ports
; i
++) {
471 struct ata_port
*ap
= host
->ports
[i
];
472 unsigned int offset
= i
* K2_SATA_PORT_OFFSET
;
474 k2_sata_setup_port(&ap
->ioaddr
, mmio_base
+ offset
);
476 ata_port_pbar_desc(ap
, 5, -1, "mmio");
477 ata_port_pbar_desc(ap
, 5, offset
, "port");
480 rc
= pci_set_dma_mask(pdev
, ATA_DMA_MASK
);
483 rc
= pci_set_consistent_dma_mask(pdev
, ATA_DMA_MASK
);
487 /* Clear a magic bit in SCR1 according to Darwin, those help
488 * some funky seagate drives (though so far, those were already
489 * set by the firmware on the machines I had access to)
491 writel(readl(mmio_base
+ K2_SATA_SICR1_OFFSET
) & ~0x00040000,
492 mmio_base
+ K2_SATA_SICR1_OFFSET
);
494 /* Clear SATA error & interrupts we don't use */
495 writel(0xffffffff, mmio_base
+ K2_SATA_SCR_ERROR_OFFSET
);
496 writel(0x0, mmio_base
+ K2_SATA_SIM_OFFSET
);
498 pci_set_master(pdev
);
499 return ata_host_activate(host
, pdev
->irq
, ata_bmdma_interrupt
,
500 IRQF_SHARED
, &k2_sata_sht
);
503 /* 0x240 is device ID for Apple K2 device
504 * 0x241 is device ID for Serverworks Frodo4
505 * 0x242 is device ID for Serverworks Frodo8
506 * 0x24a is device ID for BCM5785 (aka HT1000) HT southbridge integrated SATA
509 static const struct pci_device_id k2_sata_pci_tbl
[] = {
510 { PCI_VDEVICE(SERVERWORKS
, 0x0240), chip_svw4
},
511 { PCI_VDEVICE(SERVERWORKS
, 0x0241), chip_svw8
},
512 { PCI_VDEVICE(SERVERWORKS
, 0x0242), chip_svw4
},
513 { PCI_VDEVICE(SERVERWORKS
, 0x024a), chip_svw4
},
514 { PCI_VDEVICE(SERVERWORKS
, 0x024b), chip_svw4
},
515 { PCI_VDEVICE(SERVERWORKS
, 0x0410), chip_svw42
},
516 { PCI_VDEVICE(SERVERWORKS
, 0x0411), chip_svw43
},
521 static struct pci_driver k2_sata_pci_driver
= {
523 .id_table
= k2_sata_pci_tbl
,
524 .probe
= k2_sata_init_one
,
525 .remove
= ata_pci_remove_one
,
528 static int __init
k2_sata_init(void)
530 return pci_register_driver(&k2_sata_pci_driver
);
533 static void __exit
k2_sata_exit(void)
535 pci_unregister_driver(&k2_sata_pci_driver
);
538 MODULE_AUTHOR("Benjamin Herrenschmidt");
539 MODULE_DESCRIPTION("low-level driver for K2 SATA controller");
540 MODULE_LICENSE("GPL");
541 MODULE_DEVICE_TABLE(pci
, k2_sata_pci_tbl
);
542 MODULE_VERSION(DRV_VERSION
);
544 module_init(k2_sata_init
);
545 module_exit(k2_sata_exit
);