75638ccc0183f69fbfbc9cb0406c81053e9022e5
[linux-3.10.git] / drivers / ata / pata_sc1200.c
1 /*
2  * New ATA layer SC1200 driver          Alan Cox <alan@redhat.com>
3  *
4  * TODO: Mode selection filtering
5  * TODO: Can't enable second channel until ATA core has serialize
6  * TODO: Needs custom DMA cleanup code
7  *
8  * Based very heavily on
9  *
10  * linux/drivers/ide/pci/sc1200.c               Version 0.91    28-Jan-2003
11  *
12  * Copyright (C) 2000-2002              Mark Lord <mlord@pobox.com>
13  * May be copied or modified under the terms of the GNU General Public License
14  *
15  * Development of this chipset driver was funded
16  * by the nice folks at National Semiconductor.
17  *
18  * This program is free software; you can redistribute it and/or modify
19  * it under the terms of the GNU General Public License version 2 as
20  * published by the Free Software Foundation.
21  *
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.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30  *
31  */
32
33 #include <linux/kernel.h>
34 #include <linux/module.h>
35 #include <linux/pci.h>
36 #include <linux/init.h>
37 #include <linux/blkdev.h>
38 #include <linux/delay.h>
39 #include <scsi/scsi_host.h>
40 #include <linux/libata.h>
41
42 #define DRV_NAME        "sc1200"
43 #define DRV_VERSION     "0.2.4"
44
45 #define SC1200_REV_A    0x00
46 #define SC1200_REV_B1   0x01
47 #define SC1200_REV_B3   0x02
48 #define SC1200_REV_C1   0x03
49 #define SC1200_REV_D1   0x04
50
51 /**
52  *      sc1200_clock    -       PCI clock
53  *
54  *      Return the PCI bus clocking for the SC1200 chipset configuration
55  *      in use. We return 0 for 33MHz 1 for 48MHz and 2 for 66Mhz
56  */
57
58 static int sc1200_clock(void)
59 {
60         /* Magic registers that give us the chipset data */
61         u8 chip_id = inb(0x903C);
62         u8 silicon_rev = inb(0x903D);
63         u16 pci_clock;
64
65         if (chip_id == 0x04 && silicon_rev < SC1200_REV_B1)
66                 return 0;       /* 33 MHz mode */
67
68         /* Clock generator configuration 0x901E its 8/9 are the PCI clocking
69            0/3 is 33Mhz 1 is 48 2 is 66 */
70
71         pci_clock = inw(0x901E);
72         pci_clock >>= 8;
73         pci_clock &= 0x03;
74         if (pci_clock == 3)
75                 pci_clock = 0;
76         return pci_clock;
77 }
78
79 /**
80  *      sc1200_set_piomode              -       PIO setup
81  *      @ap: ATA interface
82  *      @adev: device on the interface
83  *
84  *      Set our PIO requirements. This is fairly simple on the SC1200
85  */
86
87 static void sc1200_set_piomode(struct ata_port *ap, struct ata_device *adev)
88 {
89         static const u32 pio_timings[4][5] = {
90                 {0x00009172, 0x00012171, 0x00020080, 0x00032010, 0x00040010},   // format0  33Mhz
91                 {0xd1329172, 0x71212171, 0x30200080, 0x20102010, 0x00100010},   // format1, 33Mhz
92                 {0xfaa3f4f3, 0xc23232b2, 0x513101c1, 0x31213121, 0x10211021},   // format1, 48Mhz
93                 {0xfff4fff4, 0xf35353d3, 0x814102f1, 0x42314231, 0x11311131}    // format1, 66Mhz
94         };
95
96         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
97         u32 format;
98         unsigned int reg = 0x40 + 0x10 * ap->port_no;
99         int mode = adev->pio_mode - XFER_PIO_0;
100
101         pci_read_config_dword(pdev, reg + 4, &format);
102         format >>= 31;
103         format += sc1200_clock();
104         pci_write_config_dword(pdev, reg + 8 * adev->devno,
105                                 pio_timings[format][mode]);
106 }
107
108 /**
109  *      sc1200_set_dmamode              -       DMA timing setup
110  *      @ap: ATA interface
111  *      @adev: Device being configured
112  *
113  *      We cannot mix MWDMA and UDMA without reloading timings each switch
114  *      master to slave.
115  */
116
117 static void sc1200_set_dmamode(struct ata_port *ap, struct ata_device *adev)
118 {
119         static const u32 udma_timing[3][3] = {
120                 { 0x00921250, 0x00911140, 0x00911030 },
121                 { 0x00932470, 0x00922260, 0x00922140 },
122                 { 0x009436A1, 0x00933481, 0x00923261 }
123         };
124
125         static const u32 mwdma_timing[3][3] = {
126                 { 0x00077771, 0x00012121, 0x00002020 },
127                 { 0x000BBBB2, 0x00024241, 0x00013131 },
128                 { 0x000FFFF3, 0x00035352, 0x00015151 }
129         };
130
131         int clock = sc1200_clock();
132         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
133         unsigned int reg = 0x40 + 0x10 * ap->port_no;
134         int mode = adev->dma_mode;
135         u32 format;
136
137         if (mode >= XFER_UDMA_0)
138                 format = udma_timing[clock][mode - XFER_UDMA_0];
139         else
140                 format = mwdma_timing[clock][mode - XFER_MW_DMA_0];
141
142         if (adev->devno == 0) {
143                 u32 timings;
144
145                 pci_read_config_dword(pdev, reg + 4, &timings);
146                 timings &= 0x80000000UL;
147                 timings |= format;
148                 pci_write_config_dword(pdev, reg + 4, timings);
149         } else
150                 pci_write_config_dword(pdev, reg + 12, format);
151 }
152
153 /**
154  *      sc1200_qc_issue_prot    -       command issue
155  *      @qc: command pending
156  *
157  *      Called when the libata layer is about to issue a command. We wrap
158  *      this interface so that we can load the correct ATA timings if
159  *      neccessary.  Specifically we have a problem that there is only
160  *      one MWDMA/UDMA bit.
161  */
162
163 static unsigned int sc1200_qc_issue_prot(struct ata_queued_cmd *qc)
164 {
165         struct ata_port *ap = qc->ap;
166         struct ata_device *adev = qc->dev;
167         struct ata_device *prev = ap->private_data;
168
169         /* See if the DMA settings could be wrong */
170         if (adev->dma_mode != 0 && adev != prev && prev != NULL) {
171                 /* Maybe, but do the channels match MWDMA/UDMA ? */
172                 if ((adev->dma_mode >= XFER_UDMA_0 && prev->dma_mode < XFER_UDMA_0) ||
173                     (adev->dma_mode < XFER_UDMA_0 && prev->dma_mode >= XFER_UDMA_0))
174                         /* Switch the mode bits */
175                         sc1200_set_dmamode(ap, adev);
176         }
177
178         return ata_qc_issue_prot(qc);
179 }
180
181 static struct scsi_host_template sc1200_sht = {
182         .module                 = THIS_MODULE,
183         .name                   = DRV_NAME,
184         .ioctl                  = ata_scsi_ioctl,
185         .queuecommand           = ata_scsi_queuecmd,
186         .can_queue              = ATA_DEF_QUEUE,
187         .this_id                = ATA_SHT_THIS_ID,
188         .sg_tablesize           = LIBATA_MAX_PRD,
189         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
190         .emulated               = ATA_SHT_EMULATED,
191         .use_clustering         = ATA_SHT_USE_CLUSTERING,
192         .proc_name              = DRV_NAME,
193         .dma_boundary           = ATA_DMA_BOUNDARY,
194         .slave_configure        = ata_scsi_slave_config,
195         .slave_destroy          = ata_scsi_slave_destroy,
196         .bios_param             = ata_std_bios_param,
197         .resume                 = ata_scsi_device_resume,
198         .suspend                = ata_scsi_device_suspend,
199 };
200
201 static struct ata_port_operations sc1200_port_ops = {
202         .port_disable   = ata_port_disable,
203         .set_piomode    = sc1200_set_piomode,
204         .set_dmamode    = sc1200_set_dmamode,
205         .mode_filter    = ata_pci_default_filter,
206
207         .tf_load        = ata_tf_load,
208         .tf_read        = ata_tf_read,
209         .check_status   = ata_check_status,
210         .exec_command   = ata_exec_command,
211         .dev_select     = ata_std_dev_select,
212
213         .error_handler  = ata_bmdma_error_handler,
214
215         .bmdma_setup    = ata_bmdma_setup,
216         .bmdma_start    = ata_bmdma_start,
217         .bmdma_stop     = ata_bmdma_stop,
218         .bmdma_status   = ata_bmdma_status,
219
220         .qc_prep        = ata_qc_prep,
221         .qc_issue       = sc1200_qc_issue_prot,
222
223         .data_xfer      = ata_pio_data_xfer,
224
225         .irq_handler    = ata_interrupt,
226         .irq_clear      = ata_bmdma_irq_clear,
227
228         .port_start     = ata_port_start,
229 };
230
231 /**
232  *      sc1200_init_one         -       Initialise an SC1200
233  *      @dev: PCI device
234  *      @id: Entry in match table
235  *
236  *      Just throw the needed data at the libata helper and it does all
237  *      our work.
238  */
239
240 static int sc1200_init_one(struct pci_dev *dev, const struct pci_device_id *id)
241 {
242         static struct ata_port_info info = {
243                 .sht = &sc1200_sht,
244                 .flags = ATA_FLAG_SLAVE_POSS|ATA_FLAG_SRST,
245                 .pio_mask = 0x1f,
246                 .mwdma_mask = 0x07,
247                 .udma_mask = 0x07,
248                 .port_ops = &sc1200_port_ops
249         };
250         static struct ata_port_info *port_info[2] = { &info, &info };
251
252         /* Can't enable port 2 yet, see top comments */
253         return ata_pci_init_one(dev, port_info, 1);
254 }
255
256 static const struct pci_device_id sc1200[] = {
257         { PCI_VDEVICE(NS, PCI_DEVICE_ID_NS_SCx200_IDE), },
258
259         { },
260 };
261
262 static struct pci_driver sc1200_pci_driver = {
263         .name           = DRV_NAME,
264         .id_table       = sc1200,
265         .probe          = sc1200_init_one,
266         .remove         = ata_pci_remove_one,
267         .suspend        = ata_pci_device_suspend,
268         .resume         = ata_pci_device_resume,
269 };
270
271 static int __init sc1200_init(void)
272 {
273         return pci_register_driver(&sc1200_pci_driver);
274 }
275
276 static void __exit sc1200_exit(void)
277 {
278         pci_unregister_driver(&sc1200_pci_driver);
279 }
280
281 MODULE_AUTHOR("Alan Cox, Mark Lord");
282 MODULE_DESCRIPTION("low-level driver for the NS/AMD SC1200");
283 MODULE_LICENSE("GPL");
284 MODULE_DEVICE_TABLE(pci, sc1200);
285 MODULE_VERSION(DRV_VERSION);
286
287 module_init(sc1200_init);
288 module_exit(sc1200_exit);