libata: implement and use ops inheritance
[deliverable/linux.git] / drivers / ata / pata_artop.c
CommitLineData
669a5db4
JG
1/*
2 * pata_artop.c - ARTOP ATA controller driver
3 *
4 * (C) 2006 Red Hat <alan@redhat.com>
be456b77 5 * (C) 2007 Bartlomiej Zolnierkiewicz
669a5db4
JG
6 *
7 * Based in part on drivers/ide/pci/aec62xx.c
8 * Copyright (C) 1999-2002 Andre Hedrick <andre@linux-ide.org>
9 * 865/865R fixes for Macintosh card version from a patch to the old
10 * driver by Thibaut VARENE <varenet@parisc-linux.org>
11 * When setting the PCI latency we must set 0x80 or higher for burst
12 * performance Alessandro Zummo <alessandro.zummo@towertech.it>
13 *
14 * TODO
15 * 850 serialization once the core supports it
16 * Investigate no_dsc on 850R
17 * Clock detect
18 */
19
20#include <linux/kernel.h>
21#include <linux/module.h>
22#include <linux/pci.h>
23#include <linux/init.h>
24#include <linux/blkdev.h>
25#include <linux/delay.h>
26#include <linux/device.h>
27#include <scsi/scsi_host.h>
28#include <linux/libata.h>
29#include <linux/ata.h>
30
31#define DRV_NAME "pata_artop"
be456b77 32#define DRV_VERSION "0.4.4"
669a5db4
JG
33
34/*
35 * The ARTOP has 33 Mhz and "over clocked" timing tables. Until we
36 * get PCI bus speed functionality we leave this as 0. Its a variable
37 * for when we get the functionality and also for folks wanting to
38 * test stuff.
39 */
40
41static int clock = 0;
42
cc0680a5 43static int artop6210_pre_reset(struct ata_link *link, unsigned long deadline)
669a5db4 44{
cc0680a5 45 struct ata_port *ap = link->ap;
669a5db4
JG
46 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
47 const struct pci_bits artop_enable_bits[] = {
48 { 0x4AU, 1U, 0x02UL, 0x02UL }, /* port 0 */
49 { 0x4AU, 1U, 0x04UL, 0x04UL }, /* port 1 */
50 };
51
c961922b
AC
52 if (!pci_test_config_bits(pdev, &artop_enable_bits[ap->port_no]))
53 return -ENOENT;
d4b2bab4 54
cc0680a5 55 return ata_std_prereset(link, deadline);
669a5db4
JG
56}
57
58/**
59 * artop6210_error_handler - Probe specified port on PATA host controller
60 * @ap: Port to probe
61 *
62 * LOCKING:
63 * None (inherited from caller).
64 */
65
66static void artop6210_error_handler(struct ata_port *ap)
67{
68 ata_bmdma_drive_eh(ap, artop6210_pre_reset,
69 ata_std_softreset, NULL,
70 ata_std_postreset);
71}
72
73/**
74 * artop6260_pre_reset - check for 40/80 pin
cc0680a5 75 * @link: link
d4b2bab4 76 * @deadline: deadline jiffies for the operation
669a5db4
JG
77 *
78 * The ARTOP hardware reports the cable detect bits in register 0x49.
79 * Nothing complicated needed here.
80 */
81
cc0680a5 82static int artop6260_pre_reset(struct ata_link *link, unsigned long deadline)
669a5db4
JG
83{
84 static const struct pci_bits artop_enable_bits[] = {
85 { 0x4AU, 1U, 0x02UL, 0x02UL }, /* port 0 */
86 { 0x4AU, 1U, 0x04UL, 0x04UL }, /* port 1 */
87 };
88
cc0680a5 89 struct ata_port *ap = link->ap;
669a5db4 90 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
669a5db4
JG
91
92 /* Odd numbered device ids are the units with enable bits (the -R cards) */
c961922b
AC
93 if (pdev->device % 1 && !pci_test_config_bits(pdev, &artop_enable_bits[ap->port_no]))
94 return -ENOENT;
27c78b37 95
cc0680a5 96 return ata_std_prereset(link, deadline);
a73984a0 97}
c961922b 98
a73984a0
JG
99/**
100 * artop6260_cable_detect - identify cable type
101 * @ap: Port
102 *
c343a839 103 * Identify the cable type for the ARTOP interface in question
a73984a0 104 */
a617c09f 105
a73984a0
JG
106static int artop6260_cable_detect(struct ata_port *ap)
107{
108 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
109 u8 tmp;
669a5db4 110 pci_read_config_byte(pdev, 0x49, &tmp);
3f9dd27a 111 if (tmp & (1 << ap->port_no))
a73984a0
JG
112 return ATA_CBL_PATA40;
113 return ATA_CBL_PATA80;
669a5db4
JG
114}
115
116/**
117 * artop6260_error_handler - Probe specified port on PATA host controller
118 * @ap: Port to probe
119 *
120 * LOCKING:
121 * None (inherited from caller).
122 */
123
124static void artop6260_error_handler(struct ata_port *ap)
125{
126 ata_bmdma_drive_eh(ap, artop6260_pre_reset,
127 ata_std_softreset, NULL,
128 ata_std_postreset);
129}
130
131/**
132 * artop6210_load_piomode - Load a set of PATA PIO timings
133 * @ap: Port whose timings we are configuring
134 * @adev: Device
135 * @pio: PIO mode
136 *
137 * Set PIO mode for device, in host controller PCI config space. This
138 * is used both to set PIO timings in PIO mode and also to set the
139 * matching PIO clocking for UDMA, as well as the MWDMA timings.
140 *
141 * LOCKING:
142 * None (inherited from caller).
143 */
144
145static void artop6210_load_piomode(struct ata_port *ap, struct ata_device *adev, unsigned int pio)
146{
147 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
148 int dn = adev->devno + 2 * ap->port_no;
149 const u16 timing[2][5] = {
150 { 0x0000, 0x000A, 0x0008, 0x0303, 0x0301 },
151 { 0x0700, 0x070A, 0x0708, 0x0403, 0x0401 }
152
153 };
154 /* Load the PIO timing active/recovery bits */
155 pci_write_config_word(pdev, 0x40 + 2 * dn, timing[clock][pio]);
156}
157
158/**
159 * artop6210_set_piomode - Initialize host controller PATA PIO timings
160 * @ap: Port whose timings we are configuring
161 * @adev: Device we are configuring
162 *
163 * Set PIO mode for device, in host controller PCI config space. For
164 * ARTOP we must also clear the UDMA bits if we are not doing UDMA. In
165 * the event UDMA is used the later call to set_dmamode will set the
166 * bits as required.
167 *
168 * LOCKING:
169 * None (inherited from caller).
170 */
171
172static void artop6210_set_piomode(struct ata_port *ap, struct ata_device *adev)
173{
174 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
175 int dn = adev->devno + 2 * ap->port_no;
176 u8 ultra;
177
178 artop6210_load_piomode(ap, adev, adev->pio_mode - XFER_PIO_0);
179
180 /* Clear the UDMA mode bits (set_dmamode will redo this if needed) */
181 pci_read_config_byte(pdev, 0x54, &ultra);
182 ultra &= ~(3 << (2 * dn));
183 pci_write_config_byte(pdev, 0x54, ultra);
184}
185
186/**
187 * artop6260_load_piomode - Initialize host controller PATA PIO timings
188 * @ap: Port whose timings we are configuring
189 * @adev: Device we are configuring
190 * @pio: PIO mode
191 *
192 * Set PIO mode for device, in host controller PCI config space. The
193 * ARTOP6260 and relatives store the timing data differently.
194 *
195 * LOCKING:
196 * None (inherited from caller).
197 */
198
199static void artop6260_load_piomode (struct ata_port *ap, struct ata_device *adev, unsigned int pio)
200{
201 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
202 int dn = adev->devno + 2 * ap->port_no;
203 const u8 timing[2][5] = {
204 { 0x00, 0x0A, 0x08, 0x33, 0x31 },
205 { 0x70, 0x7A, 0x78, 0x43, 0x41 }
206
207 };
208 /* Load the PIO timing active/recovery bits */
209 pci_write_config_byte(pdev, 0x40 + dn, timing[clock][pio]);
210}
211
212/**
213 * artop6260_set_piomode - Initialize host controller PATA PIO timings
214 * @ap: Port whose timings we are configuring
215 * @adev: Device we are configuring
216 *
217 * Set PIO mode for device, in host controller PCI config space. For
218 * ARTOP we must also clear the UDMA bits if we are not doing UDMA. In
219 * the event UDMA is used the later call to set_dmamode will set the
220 * bits as required.
221 *
222 * LOCKING:
223 * None (inherited from caller).
224 */
225
226static void artop6260_set_piomode(struct ata_port *ap, struct ata_device *adev)
227{
228 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
229 u8 ultra;
230
231 artop6260_load_piomode(ap, adev, adev->pio_mode - XFER_PIO_0);
232
233 /* Clear the UDMA mode bits (set_dmamode will redo this if needed) */
234 pci_read_config_byte(pdev, 0x44 + ap->port_no, &ultra);
235 ultra &= ~(7 << (4 * adev->devno)); /* One nibble per drive */
236 pci_write_config_byte(pdev, 0x44 + ap->port_no, ultra);
237}
238
239/**
240 * artop6210_set_dmamode - Initialize host controller PATA PIO timings
241 * @ap: Port whose timings we are configuring
a73984a0 242 * @adev: Device whose timings we are configuring
669a5db4
JG
243 *
244 * Set DMA mode for device, in host controller PCI config space.
245 *
246 * LOCKING:
247 * None (inherited from caller).
248 */
249
250static void artop6210_set_dmamode (struct ata_port *ap, struct ata_device *adev)
251{
252 unsigned int pio;
253 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
254 int dn = adev->devno + 2 * ap->port_no;
255 u8 ultra;
256
257 if (adev->dma_mode == XFER_MW_DMA_0)
258 pio = 1;
259 else
260 pio = 4;
261
262 /* Load the PIO timing active/recovery bits */
263 artop6210_load_piomode(ap, adev, pio);
264
265 pci_read_config_byte(pdev, 0x54, &ultra);
266 ultra &= ~(3 << (2 * dn));
267
268 /* Add ultra DMA bits if in UDMA mode */
269 if (adev->dma_mode >= XFER_UDMA_0) {
270 u8 mode = (adev->dma_mode - XFER_UDMA_0) + 1 - clock;
271 if (mode == 0)
272 mode = 1;
273 ultra |= (mode << (2 * dn));
274 }
275 pci_write_config_byte(pdev, 0x54, ultra);
276}
277
278/**
279 * artop6260_set_dmamode - Initialize host controller PATA PIO timings
280 * @ap: Port whose timings we are configuring
281 * @adev: Device we are configuring
282 *
283 * Set DMA mode for device, in host controller PCI config space. The
284 * ARTOP6260 and relatives store the timing data differently.
285 *
286 * LOCKING:
287 * None (inherited from caller).
288 */
289
290static void artop6260_set_dmamode (struct ata_port *ap, struct ata_device *adev)
291{
292 unsigned int pio = adev->pio_mode - XFER_PIO_0;
293 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
294 u8 ultra;
295
296 if (adev->dma_mode == XFER_MW_DMA_0)
297 pio = 1;
298 else
299 pio = 4;
300
301 /* Load the PIO timing active/recovery bits */
302 artop6260_load_piomode(ap, adev, pio);
303
304 /* Add ultra DMA bits if in UDMA mode */
305 pci_read_config_byte(pdev, 0x44 + ap->port_no, &ultra);
306 ultra &= ~(7 << (4 * adev->devno)); /* One nibble per drive */
307 if (adev->dma_mode >= XFER_UDMA_0) {
308 u8 mode = adev->dma_mode - XFER_UDMA_0 + 1 - clock;
309 if (mode == 0)
310 mode = 1;
311 ultra |= (mode << (4 * adev->devno));
312 }
313 pci_write_config_byte(pdev, 0x44 + ap->port_no, ultra);
314}
315
316static struct scsi_host_template artop_sht = {
68d1d07b 317 ATA_BMDMA_SHT(DRV_NAME),
669a5db4
JG
318};
319
029cfd6b
TH
320static struct ata_port_operations artop6210_ops = {
321 .inherits = &ata_bmdma_port_ops,
322 .cable_detect = ata_cable_40wire,
669a5db4
JG
323 .set_piomode = artop6210_set_piomode,
324 .set_dmamode = artop6210_set_dmamode,
669a5db4 325 .error_handler = artop6210_error_handler,
669a5db4
JG
326};
327
029cfd6b
TH
328static struct ata_port_operations artop6260_ops = {
329 .inherits = &ata_bmdma_port_ops,
330 .cable_detect = artop6260_cable_detect,
669a5db4
JG
331 .set_piomode = artop6260_set_piomode,
332 .set_dmamode = artop6260_set_dmamode,
669a5db4 333 .error_handler = artop6260_error_handler,
669a5db4
JG
334};
335
336
337/**
338 * artop_init_one - Register ARTOP ATA PCI device with kernel services
339 * @pdev: PCI device to register
340 * @ent: Entry in artop_pci_tbl matching with @pdev
341 *
342 * Called from kernel PCI layer.
343 *
344 * LOCKING:
345 * Inherited from PCI layer (may sleep).
346 *
347 * RETURNS:
348 * Zero on success, or -ERRNO value.
349 */
350
351static int artop_init_one (struct pci_dev *pdev, const struct pci_device_id *id)
352{
353 static int printed_version;
1626aeb8 354 static const struct ata_port_info info_6210 = {
669a5db4 355 .sht = &artop_sht,
1d2808fd 356 .flags = ATA_FLAG_SLAVE_POSS,
669a5db4
JG
357 .pio_mask = 0x1f, /* pio0-4 */
358 .mwdma_mask = 0x07, /* mwdma0-2 */
359 .udma_mask = ATA_UDMA2,
360 .port_ops = &artop6210_ops,
361 };
1626aeb8 362 static const struct ata_port_info info_626x = {
669a5db4 363 .sht = &artop_sht,
1d2808fd 364 .flags = ATA_FLAG_SLAVE_POSS,
669a5db4
JG
365 .pio_mask = 0x1f, /* pio0-4 */
366 .mwdma_mask = 0x07, /* mwdma0-2 */
367 .udma_mask = ATA_UDMA4,
368 .port_ops = &artop6260_ops,
369 };
be456b77 370 static const struct ata_port_info info_628x = {
669a5db4 371 .sht = &artop_sht,
1d2808fd 372 .flags = ATA_FLAG_SLAVE_POSS,
669a5db4
JG
373 .pio_mask = 0x1f, /* pio0-4 */
374 .mwdma_mask = 0x07, /* mwdma0-2 */
375 .udma_mask = ATA_UDMA5,
376 .port_ops = &artop6260_ops,
377 };
be456b77
BZ
378 static const struct ata_port_info info_628x_fast = {
379 .sht = &artop_sht,
380 .flags = ATA_FLAG_SLAVE_POSS,
381 .pio_mask = 0x1f, /* pio0-4 */
382 .mwdma_mask = 0x07, /* mwdma0-2 */
383 .udma_mask = ATA_UDMA6,
384 .port_ops = &artop6260_ops,
385 };
1626aeb8 386 const struct ata_port_info *ppi[] = { NULL, NULL };
f08048e9 387 int rc;
669a5db4
JG
388
389 if (!printed_version++)
390 dev_printk(KERN_DEBUG, &pdev->dev,
391 "version " DRV_VERSION "\n");
392
f08048e9
TH
393 rc = pcim_enable_device(pdev);
394 if (rc)
395 return rc;
396
669a5db4 397 if (id->driver_data == 0) { /* 6210 variant */
1626aeb8
TH
398 ppi[0] = &info_6210;
399 ppi[1] = &ata_dummy_port_info;
669a5db4
JG
400 /* BIOS may have left us in UDMA, clear it before libata probe */
401 pci_write_config_byte(pdev, 0x54, 0);
402 /* For the moment (also lacks dsc) */
403 printk(KERN_WARNING "ARTOP 6210 requires serialize functionality not yet supported by libata.\n");
404 printk(KERN_WARNING "Secondary ATA ports will not be activated.\n");
669a5db4
JG
405 }
406 else if (id->driver_data == 1) /* 6260 */
1626aeb8 407 ppi[0] = &info_626x;
be456b77 408 else if (id->driver_data == 2) { /* 6280 or 6280 + fast */
669a5db4
JG
409 unsigned long io = pci_resource_start(pdev, 4);
410 u8 reg;
411
be456b77 412 ppi[0] = &info_628x;
669a5db4 413 if (inb(io) & 0x10)
be456b77 414 ppi[0] = &info_628x_fast;
669a5db4
JG
415 /* Mac systems come up with some registers not set as we
416 will need them */
417
418 /* Clear reset & test bits */
419 pci_read_config_byte(pdev, 0x49, &reg);
420 pci_write_config_byte(pdev, 0x49, reg & ~ 0x30);
421
422 /* PCI latency must be > 0x80 for burst mode, tweak it
423 * if required.
424 */
425 pci_read_config_byte(pdev, PCI_LATENCY_TIMER, &reg);
426 if (reg <= 0x80)
427 pci_write_config_byte(pdev, PCI_LATENCY_TIMER, 0x90);
428
429 /* Enable IRQ output and burst mode */
430 pci_read_config_byte(pdev, 0x4a, &reg);
431 pci_write_config_byte(pdev, 0x4a, (reg & ~0x01) | 0x80);
432
433 }
15a7c3bb 434
1626aeb8 435 BUG_ON(ppi[0] == NULL);
15a7c3bb 436
1626aeb8 437 return ata_pci_init_one(pdev, ppi);
669a5db4
JG
438}
439
440static const struct pci_device_id artop_pci_tbl[] = {
2d2744fc
JG
441 { PCI_VDEVICE(ARTOP, 0x0005), 0 },
442 { PCI_VDEVICE(ARTOP, 0x0006), 1 },
443 { PCI_VDEVICE(ARTOP, 0x0007), 1 },
444 { PCI_VDEVICE(ARTOP, 0x0008), 2 },
445 { PCI_VDEVICE(ARTOP, 0x0009), 2 },
446
669a5db4
JG
447 { } /* terminate list */
448};
449
450static struct pci_driver artop_pci_driver = {
451 .name = DRV_NAME,
452 .id_table = artop_pci_tbl,
453 .probe = artop_init_one,
454 .remove = ata_pci_remove_one,
455};
456
457static int __init artop_init(void)
458{
459 return pci_register_driver(&artop_pci_driver);
460}
461
462static void __exit artop_exit(void)
463{
464 pci_unregister_driver(&artop_pci_driver);
465}
466
669a5db4
JG
467module_init(artop_init);
468module_exit(artop_exit);
469
470MODULE_AUTHOR("Alan Cox");
471MODULE_DESCRIPTION("SCSI low-level driver for ARTOP PATA");
472MODULE_LICENSE("GPL");
473MODULE_DEVICE_TABLE(pci, artop_pci_tbl);
474MODULE_VERSION(DRV_VERSION);
475
This page took 0.22702 seconds and 5 git commands to generate.