/spare/repo/libata-dev branch 'upstream-fixes'
[linux-3.10.git] / drivers / scsi / sata_svw.c
1 /*
2  *  sata_svw.c - ServerWorks / Apple K2 SATA
3  *
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
7  *                  on emails.
8  *
9  *  Copyright 2003 Benjamin Herrenschmidt <benh@kernel.crashing.org>
10  *
11  *  Bits from Jeff Garzik, Copyright RedHat, Inc.
12  *
13  *  This driver probably works with non-Apple versions of the
14  *  Broadcom chipset...
15  *
16  *  The contents of this file are subject to the Open
17  *  Software License version 1.1 that can be found at
18  *  http://www.opensource.org/licenses/osl-1.1.txt and is included herein
19  *  by reference.
20  *
21  *  Alternatively, the contents of this file may be used under the terms
22  *  of the GNU General Public License version 2 (the "GPL") as distributed
23  *  in the kernel source COPYING file, in which case the provisions of
24  *  the GPL are applicable instead of the above.  If you wish to allow
25  *  the use of your version of this file only under the terms of the
26  *  GPL and not to allow others to use your version of this file under
27  *  the OSL, indicate your decision by deleting the provisions above and
28  *  replace them with the notice and other provisions required by the GPL.
29  *  If you do not delete the provisions above, a recipient may use your
30  *  version of this file under either the OSL or the GPL.
31  *
32  */
33
34 #include <linux/config.h>
35 #include <linux/kernel.h>
36 #include <linux/module.h>
37 #include <linux/pci.h>
38 #include <linux/init.h>
39 #include <linux/blkdev.h>
40 #include <linux/delay.h>
41 #include <linux/interrupt.h>
42 #include "scsi.h"
43 #include <scsi/scsi_host.h>
44 #include <linux/libata.h>
45
46 #ifdef CONFIG_PPC_OF
47 #include <asm/prom.h>
48 #include <asm/pci-bridge.h>
49 #endif /* CONFIG_PPC_OF */
50
51 #define DRV_NAME        "sata_svw"
52 #define DRV_VERSION     "1.06"
53
54 /* Taskfile registers offsets */
55 #define K2_SATA_TF_CMD_OFFSET           0x00
56 #define K2_SATA_TF_DATA_OFFSET          0x00
57 #define K2_SATA_TF_ERROR_OFFSET         0x04
58 #define K2_SATA_TF_NSECT_OFFSET         0x08
59 #define K2_SATA_TF_LBAL_OFFSET          0x0c
60 #define K2_SATA_TF_LBAM_OFFSET          0x10
61 #define K2_SATA_TF_LBAH_OFFSET          0x14
62 #define K2_SATA_TF_DEVICE_OFFSET        0x18
63 #define K2_SATA_TF_CMDSTAT_OFFSET       0x1c
64 #define K2_SATA_TF_CTL_OFFSET           0x20
65
66 /* DMA base */
67 #define K2_SATA_DMA_CMD_OFFSET          0x30
68
69 /* SCRs base */
70 #define K2_SATA_SCR_STATUS_OFFSET       0x40
71 #define K2_SATA_SCR_ERROR_OFFSET        0x44
72 #define K2_SATA_SCR_CONTROL_OFFSET      0x48
73
74 /* Others */
75 #define K2_SATA_SICR1_OFFSET            0x80
76 #define K2_SATA_SICR2_OFFSET            0x84
77 #define K2_SATA_SIM_OFFSET              0x88
78
79 /* Port stride */
80 #define K2_SATA_PORT_OFFSET             0x100
81
82
83 static u32 k2_sata_scr_read (struct ata_port *ap, unsigned int sc_reg)
84 {
85         if (sc_reg > SCR_CONTROL)
86                 return 0xffffffffU;
87         return readl((void *) ap->ioaddr.scr_addr + (sc_reg * 4));
88 }
89
90
91 static void k2_sata_scr_write (struct ata_port *ap, unsigned int sc_reg,
92                                u32 val)
93 {
94         if (sc_reg > SCR_CONTROL)
95                 return;
96         writel(val, (void *) ap->ioaddr.scr_addr + (sc_reg * 4));
97 }
98
99
100 static void k2_sata_tf_load(struct ata_port *ap, struct ata_taskfile *tf)
101 {
102         struct ata_ioports *ioaddr = &ap->ioaddr;
103         unsigned int is_addr = tf->flags & ATA_TFLAG_ISADDR;
104
105         if (tf->ctl != ap->last_ctl) {
106                 writeb(tf->ctl, ioaddr->ctl_addr);
107                 ap->last_ctl = tf->ctl;
108                 ata_wait_idle(ap);
109         }
110         if (is_addr && (tf->flags & ATA_TFLAG_LBA48)) {
111                 writew(tf->feature | (((u16)tf->hob_feature) << 8), ioaddr->feature_addr);
112                 writew(tf->nsect | (((u16)tf->hob_nsect) << 8), ioaddr->nsect_addr);
113                 writew(tf->lbal | (((u16)tf->hob_lbal) << 8), ioaddr->lbal_addr);
114                 writew(tf->lbam | (((u16)tf->hob_lbam) << 8), ioaddr->lbam_addr);
115                 writew(tf->lbah | (((u16)tf->hob_lbah) << 8), ioaddr->lbah_addr);
116         } else if (is_addr) {
117                 writew(tf->feature, ioaddr->feature_addr);
118                 writew(tf->nsect, ioaddr->nsect_addr);
119                 writew(tf->lbal, ioaddr->lbal_addr);
120                 writew(tf->lbam, ioaddr->lbam_addr);
121                 writew(tf->lbah, ioaddr->lbah_addr);
122         }
123
124         if (tf->flags & ATA_TFLAG_DEVICE)
125                 writeb(tf->device, ioaddr->device_addr);
126
127         ata_wait_idle(ap);
128 }
129
130
131 static void k2_sata_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
132 {
133         struct ata_ioports *ioaddr = &ap->ioaddr;
134         u16 nsect, lbal, lbam, lbah;
135
136         nsect = tf->nsect = readw(ioaddr->nsect_addr);
137         lbal = tf->lbal = readw(ioaddr->lbal_addr);
138         lbam = tf->lbam = readw(ioaddr->lbam_addr);
139         lbah = tf->lbah = readw(ioaddr->lbah_addr);
140         tf->device = readw(ioaddr->device_addr);
141
142         if (tf->flags & ATA_TFLAG_LBA48) {
143                 tf->hob_feature = readw(ioaddr->error_addr) >> 8;
144                 tf->hob_nsect = nsect >> 8;
145                 tf->hob_lbal = lbal >> 8;
146                 tf->hob_lbam = lbam >> 8;
147                 tf->hob_lbah = lbah >> 8;
148         }
149 }
150
151 /**
152  *      k2_bmdma_setup_mmio - Set up PCI IDE BMDMA transaction (MMIO)
153  *      @qc: Info associated with this ATA transaction.
154  *
155  *      LOCKING:
156  *      spin_lock_irqsave(host_set lock)
157  */
158
159 static void k2_bmdma_setup_mmio (struct ata_queued_cmd *qc)
160 {
161         struct ata_port *ap = qc->ap;
162         unsigned int rw = (qc->tf.flags & ATA_TFLAG_WRITE);
163         u8 dmactl;
164         void *mmio = (void *) ap->ioaddr.bmdma_addr;
165         /* load PRD table addr. */
166         mb();   /* make sure PRD table writes are visible to controller */
167         writel(ap->prd_dma, mmio + ATA_DMA_TABLE_OFS);
168
169         /* specify data direction, triple-check start bit is clear */
170         dmactl = readb(mmio + ATA_DMA_CMD);
171         dmactl &= ~(ATA_DMA_WR | ATA_DMA_START);
172         if (!rw)
173                 dmactl |= ATA_DMA_WR;
174         writeb(dmactl, mmio + ATA_DMA_CMD);
175
176         /* issue r/w command if this is not a ATA DMA command*/
177         if (qc->tf.protocol != ATA_PROT_DMA)
178                 ap->ops->exec_command(ap, &qc->tf);
179 }
180
181 /**
182  *      k2_bmdma_start_mmio - Start a PCI IDE BMDMA transaction (MMIO)
183  *      @qc: Info associated with this ATA transaction.
184  *
185  *      LOCKING:
186  *      spin_lock_irqsave(host_set lock)
187  */
188
189 static void k2_bmdma_start_mmio (struct ata_queued_cmd *qc)
190 {
191         struct ata_port *ap = qc->ap;
192         void *mmio = (void *) ap->ioaddr.bmdma_addr;
193         u8 dmactl;
194
195         /* start host DMA transaction */
196         dmactl = readb(mmio + ATA_DMA_CMD);
197         writeb(dmactl | ATA_DMA_START, mmio + ATA_DMA_CMD);
198         /* There is a race condition in certain SATA controllers that can
199            be seen when the r/w command is given to the controller before the
200            host DMA is started. On a Read command, the controller would initiate
201            the command to the drive even before it sees the DMA start. When there
202            are very fast drives connected to the controller, or when the data request
203            hits in the drive cache, there is the possibility that the drive returns a part
204            or all of the requested data to the controller before the DMA start is issued.
205            In this case, the controller would become confused as to what to do with the data.
206            In the worst case when all the data is returned back to the controller, the
207            controller could hang. In other cases it could return partial data returning
208            in data corruption. This problem has been seen in PPC systems and can also appear
209            on an system with very fast disks, where the SATA controller is sitting behind a
210            number of bridges, and hence there is significant latency between the r/w command
211            and the start command. */
212         /* issue r/w command if the access is to ATA*/
213         if (qc->tf.protocol == ATA_PROT_DMA)
214                 ap->ops->exec_command(ap, &qc->tf);
215 }
216
217
218 static u8 k2_stat_check_status(struct ata_port *ap)
219 {
220         return readl((void *) ap->ioaddr.status_addr);
221 }
222
223 #ifdef CONFIG_PPC_OF
224 /*
225  * k2_sata_proc_info
226  * inout : decides on the direction of the dataflow and the meaning of the
227  *         variables
228  * buffer: If inout==FALSE data is being written to it else read from it
229  * *start: If inout==FALSE start of the valid data in the buffer
230  * offset: If inout==FALSE offset from the beginning of the imaginary file
231  *         from which we start writing into the buffer
232  * length: If inout==FALSE max number of bytes to be written into the buffer
233  *         else number of bytes in the buffer
234  */
235 static int k2_sata_proc_info(struct Scsi_Host *shost, char *page, char **start,
236                              off_t offset, int count, int inout)
237 {
238         struct ata_port *ap;
239         struct device_node *np;
240         int len, index;
241
242         /* Find  the ata_port */
243         ap = (struct ata_port *) &shost->hostdata[0];
244         if (ap == NULL)
245                 return 0;
246
247         /* Find the OF node for the PCI device proper */
248         np = pci_device_to_OF_node(to_pci_dev(ap->host_set->dev));
249         if (np == NULL)
250                 return 0;
251
252         /* Match it to a port node */
253         index = (ap == ap->host_set->ports[0]) ? 0 : 1;
254         for (np = np->child; np != NULL; np = np->sibling) {
255                 u32 *reg = (u32 *)get_property(np, "reg", NULL);
256                 if (!reg)
257                         continue;
258                 if (index == *reg)
259                         break;
260         }
261         if (np == NULL)
262                 return 0;
263
264         len = sprintf(page, "devspec: %s\n", np->full_name);
265
266         return len;
267 }
268 #endif /* CONFIG_PPC_OF */
269
270
271 static Scsi_Host_Template k2_sata_sht = {
272         .module                 = THIS_MODULE,
273         .name                   = DRV_NAME,
274         .ioctl                  = ata_scsi_ioctl,
275         .queuecommand           = ata_scsi_queuecmd,
276         .eh_strategy_handler    = ata_scsi_error,
277         .can_queue              = ATA_DEF_QUEUE,
278         .this_id                = ATA_SHT_THIS_ID,
279         .sg_tablesize           = LIBATA_MAX_PRD,
280         .max_sectors            = ATA_MAX_SECTORS,
281         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
282         .emulated               = ATA_SHT_EMULATED,
283         .use_clustering         = ATA_SHT_USE_CLUSTERING,
284         .proc_name              = DRV_NAME,
285         .dma_boundary           = ATA_DMA_BOUNDARY,
286         .slave_configure        = ata_scsi_slave_config,
287 #ifdef CONFIG_PPC_OF
288         .proc_info              = k2_sata_proc_info,
289 #endif
290         .bios_param             = ata_std_bios_param,
291         .ordered_flush          = 1,
292 };
293
294
295 static struct ata_port_operations k2_sata_ops = {
296         .port_disable           = ata_port_disable,
297         .tf_load                = k2_sata_tf_load,
298         .tf_read                = k2_sata_tf_read,
299         .check_status           = k2_stat_check_status,
300         .exec_command           = ata_exec_command,
301         .dev_select             = ata_std_dev_select,
302         .phy_reset              = sata_phy_reset,
303         .bmdma_setup            = k2_bmdma_setup_mmio,
304         .bmdma_start            = k2_bmdma_start_mmio,
305         .bmdma_stop             = ata_bmdma_stop,
306         .bmdma_status           = ata_bmdma_status,
307         .qc_prep                = ata_qc_prep,
308         .qc_issue               = ata_qc_issue_prot,
309         .eng_timeout            = ata_eng_timeout,
310         .irq_handler            = ata_interrupt,
311         .irq_clear              = ata_bmdma_irq_clear,
312         .scr_read               = k2_sata_scr_read,
313         .scr_write              = k2_sata_scr_write,
314         .port_start             = ata_port_start,
315         .port_stop              = ata_port_stop,
316         .host_stop              = ata_host_stop,
317 };
318
319 static void k2_sata_setup_port(struct ata_ioports *port, unsigned long base)
320 {
321         port->cmd_addr          = base + K2_SATA_TF_CMD_OFFSET;
322         port->data_addr         = base + K2_SATA_TF_DATA_OFFSET;
323         port->feature_addr      =
324         port->error_addr        = base + K2_SATA_TF_ERROR_OFFSET;
325         port->nsect_addr        = base + K2_SATA_TF_NSECT_OFFSET;
326         port->lbal_addr         = base + K2_SATA_TF_LBAL_OFFSET;
327         port->lbam_addr         = base + K2_SATA_TF_LBAM_OFFSET;
328         port->lbah_addr         = base + K2_SATA_TF_LBAH_OFFSET;
329         port->device_addr       = base + K2_SATA_TF_DEVICE_OFFSET;
330         port->command_addr      =
331         port->status_addr       = base + K2_SATA_TF_CMDSTAT_OFFSET;
332         port->altstatus_addr    =
333         port->ctl_addr          = base + K2_SATA_TF_CTL_OFFSET;
334         port->bmdma_addr        = base + K2_SATA_DMA_CMD_OFFSET;
335         port->scr_addr          = base + K2_SATA_SCR_STATUS_OFFSET;
336 }
337
338
339 static int k2_sata_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
340 {
341         static int printed_version;
342         struct ata_probe_ent *probe_ent = NULL;
343         unsigned long base;
344         void *mmio_base;
345         int pci_dev_busy = 0;
346         int rc;
347         int i;
348
349         if (!printed_version++)
350                 printk(KERN_DEBUG DRV_NAME " version " DRV_VERSION "\n");
351
352         /*
353          * If this driver happens to only be useful on Apple's K2, then
354          * we should check that here as it has a normal Serverworks ID
355          */
356         rc = pci_enable_device(pdev);
357         if (rc)
358                 return rc;
359         /*
360          * Check if we have resources mapped at all (second function may
361          * have been disabled by firmware)
362          */
363         if (pci_resource_len(pdev, 5) == 0)
364                 return -ENODEV;
365
366         /* Request PCI regions */
367         rc = pci_request_regions(pdev, DRV_NAME);
368         if (rc) {
369                 pci_dev_busy = 1;
370                 goto err_out;
371         }
372
373         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
374         if (rc)
375                 goto err_out_regions;
376         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
377         if (rc)
378                 goto err_out_regions;
379
380         probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
381         if (probe_ent == NULL) {
382                 rc = -ENOMEM;
383                 goto err_out_regions;
384         }
385
386         memset(probe_ent, 0, sizeof(*probe_ent));
387         probe_ent->dev = pci_dev_to_dev(pdev);
388         INIT_LIST_HEAD(&probe_ent->node);
389
390         mmio_base = ioremap(pci_resource_start(pdev, 5),
391                             pci_resource_len(pdev, 5));
392         if (mmio_base == NULL) {
393                 rc = -ENOMEM;
394                 goto err_out_free_ent;
395         }
396         base = (unsigned long) mmio_base;
397
398         /* Clear a magic bit in SCR1 according to Darwin, those help
399          * some funky seagate drives (though so far, those were already
400          * set by the firmware on the machines I had access to)
401          */
402         writel(readl(mmio_base + K2_SATA_SICR1_OFFSET) & ~0x00040000,
403                mmio_base + K2_SATA_SICR1_OFFSET);
404
405         /* Clear SATA error & interrupts we don't use */
406         writel(0xffffffff, mmio_base + K2_SATA_SCR_ERROR_OFFSET);
407         writel(0x0, mmio_base + K2_SATA_SIM_OFFSET);
408
409         probe_ent->sht = &k2_sata_sht;
410         probe_ent->host_flags = ATA_FLAG_SATA | ATA_FLAG_SATA_RESET |
411                                 ATA_FLAG_NO_LEGACY | ATA_FLAG_MMIO;
412         probe_ent->port_ops = &k2_sata_ops;
413         probe_ent->n_ports = 4;
414         probe_ent->irq = pdev->irq;
415         probe_ent->irq_flags = SA_SHIRQ;
416         probe_ent->mmio_base = mmio_base;
417
418         /* We don't care much about the PIO/UDMA masks, but the core won't like us
419          * if we don't fill these
420          */
421         probe_ent->pio_mask = 0x1f;
422         probe_ent->mwdma_mask = 0x7;
423         probe_ent->udma_mask = 0x7f;
424
425         /* different controllers have different number of ports - currently 4 or 8 */
426         /* All ports are on the same function. Multi-function device is no
427          * longer available. This should not be seen in any system. */
428         for (i = 0; i < ent->driver_data; i++)
429                 k2_sata_setup_port(&probe_ent->port[i], base + i * K2_SATA_PORT_OFFSET);
430
431         pci_set_master(pdev);
432
433         /* FIXME: check ata_device_add return value */
434         ata_device_add(probe_ent);
435         kfree(probe_ent);
436
437         return 0;
438
439 err_out_free_ent:
440         kfree(probe_ent);
441 err_out_regions:
442         pci_release_regions(pdev);
443 err_out:
444         if (!pci_dev_busy)
445                 pci_disable_device(pdev);
446         return rc;
447 }
448
449 /* 0x240 is device ID for Apple K2 device
450  * 0x241 is device ID for Serverworks Frodo4
451  * 0x242 is device ID for Serverworks Frodo8
452  * 0x24a is device ID for BCM5785 (aka HT1000) HT southbridge integrated SATA
453  * controller
454  * */
455 static struct pci_device_id k2_sata_pci_tbl[] = {
456         { 0x1166, 0x0240, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 4 },
457         { 0x1166, 0x0241, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 4 },
458         { 0x1166, 0x0242, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 8 },
459         { 0x1166, 0x024a, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 4 },
460         { }
461 };
462
463
464 static struct pci_driver k2_sata_pci_driver = {
465         .name                   = DRV_NAME,
466         .id_table               = k2_sata_pci_tbl,
467         .probe                  = k2_sata_init_one,
468         .remove                 = ata_pci_remove_one,
469 };
470
471
472 static int __init k2_sata_init(void)
473 {
474         return pci_module_init(&k2_sata_pci_driver);
475 }
476
477
478 static void __exit k2_sata_exit(void)
479 {
480         pci_unregister_driver(&k2_sata_pci_driver);
481 }
482
483
484 MODULE_AUTHOR("Benjamin Herrenschmidt");
485 MODULE_DESCRIPTION("low-level driver for K2 SATA controller");
486 MODULE_LICENSE("GPL");
487 MODULE_DEVICE_TABLE(pci, k2_sata_pci_tbl);
488 MODULE_VERSION(DRV_VERSION);
489
490 module_init(k2_sata_init);
491 module_exit(k2_sata_exit);