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