Merge branch 'master'
[linux-2.6.git] / drivers / scsi / sata_via.c
1 /*
2  *  sata_via.c - VIA Serial ATA controllers
3  *
4  *  Maintained by:  Jeff Garzik <jgarzik@pobox.com>
5  *                 Please ALWAYS copy linux-ide@vger.kernel.org
6                    on emails.
7  *
8  *  Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
9  *  Copyright 2003-2004 Jeff Garzik
10  *
11  *
12  *  This program is free software; you can redistribute it and/or modify
13  *  it under the terms of the GNU General Public License as published by
14  *  the Free Software Foundation; either version 2, or (at your option)
15  *  any later version.
16  *
17  *  This program is distributed in the hope that it will be useful,
18  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
19  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  *  GNU General Public License for more details.
21  *
22  *  You should have received a copy of the GNU General Public License
23  *  along with this program; see the file COPYING.  If not, write to
24  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25  *
26  *
27  *  libata documentation is available via 'make {ps|pdf}docs',
28  *  as Documentation/DocBook/libata.*
29  *
30  *  Hardware documentation available under NDA.
31  *
32  *
33  *  To-do list:
34  *  - VT6421 PATA support
35  *
36  */
37
38 #include <linux/kernel.h>
39 #include <linux/module.h>
40 #include <linux/pci.h>
41 #include <linux/init.h>
42 #include <linux/blkdev.h>
43 #include <linux/delay.h>
44 #include <linux/device.h>
45 #include "scsi.h"
46 #include <scsi/scsi_host.h>
47 #include <linux/libata.h>
48 #include <asm/io.h>
49
50 #define DRV_NAME        "sata_via"
51 #define DRV_VERSION     "1.1"
52
53 enum board_ids_enum {
54         vt6420,
55         vt6421,
56 };
57
58 enum {
59         SATA_CHAN_ENAB          = 0x40, /* SATA channel enable */
60         SATA_INT_GATE           = 0x41, /* SATA interrupt gating */
61         SATA_NATIVE_MODE        = 0x42, /* Native mode enable */
62         SATA_PATA_SHARING       = 0x49, /* PATA/SATA sharing func ctrl */
63
64         PORT0                   = (1 << 1),
65         PORT1                   = (1 << 0),
66         ALL_PORTS               = PORT0 | PORT1,
67         N_PORTS                 = 2,
68
69         NATIVE_MODE_ALL         = (1 << 7) | (1 << 6) | (1 << 5) | (1 << 4),
70
71         SATA_EXT_PHY            = (1 << 6), /* 0==use PATA, 1==ext phy */
72         SATA_2DEV               = (1 << 5), /* SATA is master/slave */
73 };
74
75 static int svia_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
76 static u32 svia_scr_read (struct ata_port *ap, unsigned int sc_reg);
77 static void svia_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
78
79 static struct pci_device_id svia_pci_tbl[] = {
80         { 0x1106, 0x3149, PCI_ANY_ID, PCI_ANY_ID, 0, 0, vt6420 },
81         { 0x1106, 0x3249, PCI_ANY_ID, PCI_ANY_ID, 0, 0, vt6421 },
82
83         { }     /* terminate list */
84 };
85
86 static struct pci_driver svia_pci_driver = {
87         .name                   = DRV_NAME,
88         .id_table               = svia_pci_tbl,
89         .probe                  = svia_init_one,
90         .remove                 = ata_pci_remove_one,
91 };
92
93 static Scsi_Host_Template svia_sht = {
94         .module                 = THIS_MODULE,
95         .name                   = DRV_NAME,
96         .ioctl                  = ata_scsi_ioctl,
97         .queuecommand           = ata_scsi_queuecmd,
98         .eh_strategy_handler    = ata_scsi_error,
99         .can_queue              = ATA_DEF_QUEUE,
100         .this_id                = ATA_SHT_THIS_ID,
101         .sg_tablesize           = LIBATA_MAX_PRD,
102         .max_sectors            = ATA_MAX_SECTORS,
103         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
104         .emulated               = ATA_SHT_EMULATED,
105         .use_clustering         = ATA_SHT_USE_CLUSTERING,
106         .proc_name              = DRV_NAME,
107         .dma_boundary           = ATA_DMA_BOUNDARY,
108         .slave_configure        = ata_scsi_slave_config,
109         .bios_param             = ata_std_bios_param,
110         .ordered_flush          = 1,
111 };
112
113 static const struct ata_port_operations svia_sata_ops = {
114         .port_disable           = ata_port_disable,
115
116         .tf_load                = ata_tf_load,
117         .tf_read                = ata_tf_read,
118         .check_status           = ata_check_status,
119         .exec_command           = ata_exec_command,
120         .dev_select             = ata_std_dev_select,
121
122         .phy_reset              = sata_phy_reset,
123
124         .bmdma_setup            = ata_bmdma_setup,
125         .bmdma_start            = ata_bmdma_start,
126         .bmdma_stop             = ata_bmdma_stop,
127         .bmdma_status           = ata_bmdma_status,
128
129         .qc_prep                = ata_qc_prep,
130         .qc_issue               = ata_qc_issue_prot,
131
132         .eng_timeout            = ata_eng_timeout,
133
134         .irq_handler            = ata_interrupt,
135         .irq_clear              = ata_bmdma_irq_clear,
136
137         .scr_read               = svia_scr_read,
138         .scr_write              = svia_scr_write,
139
140         .port_start             = ata_port_start,
141         .port_stop              = ata_port_stop,
142         .host_stop              = ata_host_stop,
143 };
144
145 static struct ata_port_info svia_port_info = {
146         .sht            = &svia_sht,
147         .host_flags     = ATA_FLAG_SATA | ATA_FLAG_SRST | ATA_FLAG_NO_LEGACY,
148         .pio_mask       = 0x1f,
149         .mwdma_mask     = 0x07,
150         .udma_mask      = 0x7f,
151         .port_ops       = &svia_sata_ops,
152 };
153
154 MODULE_AUTHOR("Jeff Garzik");
155 MODULE_DESCRIPTION("SCSI low-level driver for VIA SATA controllers");
156 MODULE_LICENSE("GPL");
157 MODULE_DEVICE_TABLE(pci, svia_pci_tbl);
158 MODULE_VERSION(DRV_VERSION);
159
160 static u32 svia_scr_read (struct ata_port *ap, unsigned int sc_reg)
161 {
162         if (sc_reg > SCR_CONTROL)
163                 return 0xffffffffU;
164         return inl(ap->ioaddr.scr_addr + (4 * sc_reg));
165 }
166
167 static void svia_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
168 {
169         if (sc_reg > SCR_CONTROL)
170                 return;
171         outl(val, ap->ioaddr.scr_addr + (4 * sc_reg));
172 }
173
174 static const unsigned int svia_bar_sizes[] = {
175         8, 4, 8, 4, 16, 256
176 };
177
178 static const unsigned int vt6421_bar_sizes[] = {
179         16, 16, 16, 16, 32, 128
180 };
181
182 static unsigned long svia_scr_addr(unsigned long addr, unsigned int port)
183 {
184         return addr + (port * 128);
185 }
186
187 static unsigned long vt6421_scr_addr(unsigned long addr, unsigned int port)
188 {
189         return addr + (port * 64);
190 }
191
192 static void vt6421_init_addrs(struct ata_probe_ent *probe_ent,
193                               struct pci_dev *pdev,
194                               unsigned int port)
195 {
196         unsigned long reg_addr = pci_resource_start(pdev, port);
197         unsigned long bmdma_addr = pci_resource_start(pdev, 4) + (port * 8);
198         unsigned long scr_addr;
199
200         probe_ent->port[port].cmd_addr = reg_addr;
201         probe_ent->port[port].altstatus_addr =
202         probe_ent->port[port].ctl_addr = (reg_addr + 8) | ATA_PCI_CTL_OFS;
203         probe_ent->port[port].bmdma_addr = bmdma_addr;
204
205         scr_addr = vt6421_scr_addr(pci_resource_start(pdev, 5), port);
206         probe_ent->port[port].scr_addr = scr_addr;
207
208         ata_std_ports(&probe_ent->port[port]);
209 }
210
211 static struct ata_probe_ent *vt6420_init_probe_ent(struct pci_dev *pdev)
212 {
213         struct ata_probe_ent *probe_ent;
214         struct ata_port_info *ppi = &svia_port_info;
215
216         probe_ent = ata_pci_init_native_mode(pdev, &ppi, ATA_PORT_PRIMARY | ATA_PORT_SECONDARY);
217         if (!probe_ent)
218                 return NULL;
219
220         probe_ent->port[0].scr_addr =
221                 svia_scr_addr(pci_resource_start(pdev, 5), 0);
222         probe_ent->port[1].scr_addr =
223                 svia_scr_addr(pci_resource_start(pdev, 5), 1);
224
225         return probe_ent;
226 }
227
228 static struct ata_probe_ent *vt6421_init_probe_ent(struct pci_dev *pdev)
229 {
230         struct ata_probe_ent *probe_ent;
231         unsigned int i;
232
233         probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
234         if (!probe_ent)
235                 return NULL;
236
237         memset(probe_ent, 0, sizeof(*probe_ent));
238         probe_ent->dev = pci_dev_to_dev(pdev);
239         INIT_LIST_HEAD(&probe_ent->node);
240
241         probe_ent->sht          = &svia_sht;
242         probe_ent->host_flags   = ATA_FLAG_SATA | ATA_FLAG_SATA_RESET |
243                                   ATA_FLAG_NO_LEGACY;
244         probe_ent->port_ops     = &svia_sata_ops;
245         probe_ent->n_ports      = N_PORTS;
246         probe_ent->irq          = pdev->irq;
247         probe_ent->irq_flags    = SA_SHIRQ;
248         probe_ent->pio_mask     = 0x1f;
249         probe_ent->mwdma_mask   = 0x07;
250         probe_ent->udma_mask    = 0x7f;
251
252         for (i = 0; i < N_PORTS; i++)
253                 vt6421_init_addrs(probe_ent, pdev, i);
254
255         return probe_ent;
256 }
257
258 static void svia_configure(struct pci_dev *pdev)
259 {
260         u8 tmp8;
261
262         pci_read_config_byte(pdev, PCI_INTERRUPT_LINE, &tmp8);
263         dev_printk(KERN_INFO, &pdev->dev, "routed to hard irq line %d\n",
264                (int) (tmp8 & 0xf0) == 0xf0 ? 0 : tmp8 & 0x0f);
265
266         /* make sure SATA channels are enabled */
267         pci_read_config_byte(pdev, SATA_CHAN_ENAB, &tmp8);
268         if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
269                 dev_printk(KERN_DEBUG, &pdev->dev,
270                            "enabling SATA channels (0x%x)\n",
271                            (int) tmp8);
272                 tmp8 |= ALL_PORTS;
273                 pci_write_config_byte(pdev, SATA_CHAN_ENAB, tmp8);
274         }
275
276         /* make sure interrupts for each channel sent to us */
277         pci_read_config_byte(pdev, SATA_INT_GATE, &tmp8);
278         if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
279                 dev_printk(KERN_DEBUG, &pdev->dev,
280                            "enabling SATA channel interrupts (0x%x)\n",
281                            (int) tmp8);
282                 tmp8 |= ALL_PORTS;
283                 pci_write_config_byte(pdev, SATA_INT_GATE, tmp8);
284         }
285
286         /* make sure native mode is enabled */
287         pci_read_config_byte(pdev, SATA_NATIVE_MODE, &tmp8);
288         if ((tmp8 & NATIVE_MODE_ALL) != NATIVE_MODE_ALL) {
289                 dev_printk(KERN_DEBUG, &pdev->dev,
290                            "enabling SATA channel native mode (0x%x)\n",
291                            (int) tmp8);
292                 tmp8 |= NATIVE_MODE_ALL;
293                 pci_write_config_byte(pdev, SATA_NATIVE_MODE, tmp8);
294         }
295 }
296
297 static int svia_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
298 {
299         static int printed_version;
300         unsigned int i;
301         int rc;
302         struct ata_probe_ent *probe_ent;
303         int board_id = (int) ent->driver_data;
304         const int *bar_sizes;
305         int pci_dev_busy = 0;
306         u8 tmp8;
307
308         if (!printed_version++)
309                 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
310
311         rc = pci_enable_device(pdev);
312         if (rc)
313                 return rc;
314
315         rc = pci_request_regions(pdev, DRV_NAME);
316         if (rc) {
317                 pci_dev_busy = 1;
318                 goto err_out;
319         }
320
321         if (board_id == vt6420) {
322                 pci_read_config_byte(pdev, SATA_PATA_SHARING, &tmp8);
323                 if (tmp8 & SATA_2DEV) {
324                         dev_printk(KERN_ERR, &pdev->dev,
325                                    "SATA master/slave not supported (0x%x)\n",
326                                    (int) tmp8);
327                         rc = -EIO;
328                         goto err_out_regions;
329                 }
330
331                 bar_sizes = &svia_bar_sizes[0];
332         } else {
333                 bar_sizes = &vt6421_bar_sizes[0];
334         }
335
336         for (i = 0; i < ARRAY_SIZE(svia_bar_sizes); i++)
337                 if ((pci_resource_start(pdev, i) == 0) ||
338                     (pci_resource_len(pdev, i) < bar_sizes[i])) {
339                         dev_printk(KERN_ERR, &pdev->dev,
340                                    "invalid PCI BAR %u (sz 0x%lx, val 0x%lx)\n",
341                                    i,
342                                    pci_resource_start(pdev, i),
343                                    pci_resource_len(pdev, i));
344                         rc = -ENODEV;
345                         goto err_out_regions;
346                 }
347
348         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
349         if (rc)
350                 goto err_out_regions;
351         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
352         if (rc)
353                 goto err_out_regions;
354
355         if (board_id == vt6420)
356                 probe_ent = vt6420_init_probe_ent(pdev);
357         else
358                 probe_ent = vt6421_init_probe_ent(pdev);
359
360         if (!probe_ent) {
361                 dev_printk(KERN_ERR, &pdev->dev, "out of memory\n");
362                 rc = -ENOMEM;
363                 goto err_out_regions;
364         }
365
366         svia_configure(pdev);
367
368         pci_set_master(pdev);
369
370         /* FIXME: check ata_device_add return value */
371         ata_device_add(probe_ent);
372         kfree(probe_ent);
373
374         return 0;
375
376 err_out_regions:
377         pci_release_regions(pdev);
378 err_out:
379         if (!pci_dev_busy)
380                 pci_disable_device(pdev);
381         return rc;
382 }
383
384 static int __init svia_init(void)
385 {
386         return pci_module_init(&svia_pci_driver);
387 }
388
389 static void __exit svia_exit(void)
390 {
391         pci_unregister_driver(&svia_pci_driver);
392 }
393
394 module_init(svia_init);
395 module_exit(svia_exit);
396