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