1 /*
2  * Copyright (C) 1997-1998	Mark Lord <mlord@pobox.com>
3  * Copyright (C) 1998		Eddie C. Dost <ecd@skynet.be>
4  * Copyright (C) 1999-2000	Andre Hedrick <andre@linux-ide.org>
5  * Copyright (C) 2004		Grant Grundler <grundler at parisc-linux.org>
6  *
7  * Inspired by an earlier effort from David S. Miller <davem@redhat.com>
8  */
9 
10 #include <linux/module.h>
11 #include <linux/types.h>
12 #include <linux/kernel.h>
13 #include <linux/interrupt.h>
14 #include <linux/pci.h>
15 #include <linux/delay.h>
16 #include <linux/ide.h>
17 #include <linux/init.h>
18 
19 #include <asm/io.h>
20 
21 #define DRV_NAME "ns87415"
22 
23 #ifdef CONFIG_SUPERIO
24 /* SUPERIO 87560 is a PoS chip that NatSem denies exists.
25  * Unfortunately, it's built-in on all Astro-based PA-RISC workstations
26  * which use the integrated NS87514 cell for CD-ROM support.
27  * i.e we have to support for CD-ROM installs.
28  * See drivers/parisc/superio.c for more gory details.
29  */
30 #include <asm/superio.h>
31 
32 #define SUPERIO_IDE_MAX_RETRIES 25
33 
34 /* Because of a defect in Super I/O, all reads of the PCI DMA status
35  * registers, IDE status register and the IDE select register need to be
36  * retried
37  */
superio_ide_inb(unsigned long port)38 static u8 superio_ide_inb (unsigned long port)
39 {
40 	u8 tmp;
41 	int retries = SUPERIO_IDE_MAX_RETRIES;
42 
43 	/* printk(" [ reading port 0x%x with retry ] ", port); */
44 
45 	do {
46 		tmp = inb(port);
47 		if (tmp == 0)
48 			udelay(50);
49 	} while (tmp == 0 && retries-- > 0);
50 
51 	return tmp;
52 }
53 
superio_read_status(ide_hwif_t * hwif)54 static u8 superio_read_status(ide_hwif_t *hwif)
55 {
56 	return superio_ide_inb(hwif->io_ports.status_addr);
57 }
58 
superio_dma_sff_read_status(ide_hwif_t * hwif)59 static u8 superio_dma_sff_read_status(ide_hwif_t *hwif)
60 {
61 	return superio_ide_inb(hwif->dma_base + ATA_DMA_STATUS);
62 }
63 
superio_tf_read(ide_drive_t * drive,struct ide_taskfile * tf,u8 valid)64 static void superio_tf_read(ide_drive_t *drive, struct ide_taskfile *tf,
65 			    u8 valid)
66 {
67 	struct ide_io_ports *io_ports = &drive->hwif->io_ports;
68 
69 	if (valid & IDE_VALID_ERROR)
70 		tf->error  = inb(io_ports->feature_addr);
71 	if (valid & IDE_VALID_NSECT)
72 		tf->nsect  = inb(io_ports->nsect_addr);
73 	if (valid & IDE_VALID_LBAL)
74 		tf->lbal   = inb(io_ports->lbal_addr);
75 	if (valid & IDE_VALID_LBAM)
76 		tf->lbam   = inb(io_ports->lbam_addr);
77 	if (valid & IDE_VALID_LBAH)
78 		tf->lbah   = inb(io_ports->lbah_addr);
79 	if (valid & IDE_VALID_DEVICE)
80 		tf->device = superio_ide_inb(io_ports->device_addr);
81 }
82 
83 static void ns87415_dev_select(ide_drive_t *drive);
84 
85 static const struct ide_tp_ops superio_tp_ops = {
86 	.exec_command		= ide_exec_command,
87 	.read_status		= superio_read_status,
88 	.read_altstatus		= ide_read_altstatus,
89 	.write_devctl		= ide_write_devctl,
90 
91 	.dev_select		= ns87415_dev_select,
92 	.tf_load		= ide_tf_load,
93 	.tf_read		= superio_tf_read,
94 
95 	.input_data		= ide_input_data,
96 	.output_data		= ide_output_data,
97 };
98 
superio_init_iops(struct hwif_s * hwif)99 static void __devinit superio_init_iops(struct hwif_s *hwif)
100 {
101 	struct pci_dev *pdev = to_pci_dev(hwif->dev);
102 	u32 dma_stat;
103 	u8 port = hwif->channel, tmp;
104 
105 	dma_stat = (pci_resource_start(pdev, 4) & ~3) + (!port ? 2 : 0xa);
106 
107 	/* Clear error/interrupt, enable dma */
108 	tmp = superio_ide_inb(dma_stat);
109 	outb(tmp | 0x66, dma_stat);
110 }
111 #else
112 #define superio_dma_sff_read_status ide_dma_sff_read_status
113 #endif
114 
115 static unsigned int ns87415_count = 0, ns87415_control[MAX_HWIFS] = { 0 };
116 
117 /*
118  * This routine either enables/disables (according to IDE_DFLAG_PRESENT)
119  * the IRQ associated with the port,
120  * and selects either PIO or DMA handshaking for the next I/O operation.
121  */
ns87415_prepare_drive(ide_drive_t * drive,unsigned int use_dma)122 static void ns87415_prepare_drive (ide_drive_t *drive, unsigned int use_dma)
123 {
124 	ide_hwif_t *hwif = drive->hwif;
125 	struct pci_dev *dev = to_pci_dev(hwif->dev);
126 	unsigned int bit, other, new, *old = (unsigned int *) hwif->select_data;
127 	unsigned long flags;
128 
129 	local_irq_save(flags);
130 	new = *old;
131 
132 	/* Adjust IRQ enable bit */
133 	bit = 1 << (8 + hwif->channel);
134 
135 	if (drive->dev_flags & IDE_DFLAG_PRESENT)
136 		new &= ~bit;
137 	else
138 		new |= bit;
139 
140 	/* Select PIO or DMA, DMA may only be selected for one drive/channel. */
141 	bit   = 1 << (20 + (drive->dn & 1) + (hwif->channel << 1));
142 	other = 1 << (20 + (1 - (drive->dn & 1)) + (hwif->channel << 1));
143 	new = use_dma ? ((new & ~other) | bit) : (new & ~bit);
144 
145 	if (new != *old) {
146 		unsigned char stat;
147 
148 		/*
149 		 * Don't change DMA engine settings while Write Buffers
150 		 * are busy.
151 		 */
152 		(void) pci_read_config_byte(dev, 0x43, &stat);
153 		while (stat & 0x03) {
154 			udelay(1);
155 			(void) pci_read_config_byte(dev, 0x43, &stat);
156 		}
157 
158 		*old = new;
159 		(void) pci_write_config_dword(dev, 0x40, new);
160 
161 		/*
162 		 * And let things settle...
163 		 */
164 		udelay(10);
165 	}
166 
167 	local_irq_restore(flags);
168 }
169 
ns87415_dev_select(ide_drive_t * drive)170 static void ns87415_dev_select(ide_drive_t *drive)
171 {
172 	ns87415_prepare_drive(drive,
173 			      !!(drive->dev_flags & IDE_DFLAG_USING_DMA));
174 
175 	outb(drive->select | ATA_DEVICE_OBS, drive->hwif->io_ports.device_addr);
176 }
177 
ns87415_dma_start(ide_drive_t * drive)178 static void ns87415_dma_start(ide_drive_t *drive)
179 {
180 	ns87415_prepare_drive(drive, 1);
181 	ide_dma_start(drive);
182 }
183 
ns87415_dma_end(ide_drive_t * drive)184 static int ns87415_dma_end(ide_drive_t *drive)
185 {
186 	ide_hwif_t *hwif = drive->hwif;
187 	u8 dma_stat = 0, dma_cmd = 0;
188 
189 	dma_stat = hwif->dma_ops->dma_sff_read_status(hwif);
190 	/* get DMA command mode */
191 	dma_cmd = inb(hwif->dma_base + ATA_DMA_CMD);
192 	/* stop DMA */
193 	outb(dma_cmd & ~1, hwif->dma_base + ATA_DMA_CMD);
194 	/* from ERRATA: clear the INTR & ERROR bits */
195 	dma_cmd = inb(hwif->dma_base + ATA_DMA_CMD);
196 	outb(dma_cmd | 6, hwif->dma_base + ATA_DMA_CMD);
197 
198 	ns87415_prepare_drive(drive, 0);
199 
200 	/* verify good DMA status */
201 	return (dma_stat & 7) != 4;
202 }
203 
init_hwif_ns87415(ide_hwif_t * hwif)204 static void __devinit init_hwif_ns87415 (ide_hwif_t *hwif)
205 {
206 	struct pci_dev *dev = to_pci_dev(hwif->dev);
207 	unsigned int ctrl, using_inta;
208 	u8 progif;
209 #ifdef __sparc_v9__
210 	int timeout;
211 	u8 stat;
212 #endif
213 
214 	/*
215 	 * We cannot probe for IRQ: both ports share common IRQ on INTA.
216 	 * Also, leave IRQ masked during drive probing, to prevent infinite
217 	 * interrupts from a potentially floating INTA..
218 	 *
219 	 * IRQs get unmasked in dev_select() when drive is first used.
220 	 */
221 	(void) pci_read_config_dword(dev, 0x40, &ctrl);
222 	(void) pci_read_config_byte(dev, 0x09, &progif);
223 	/* is irq in "native" mode? */
224 	using_inta = progif & (1 << (hwif->channel << 1));
225 	if (!using_inta)
226 		using_inta = ctrl & (1 << (4 + hwif->channel));
227 	if (hwif->mate) {
228 		hwif->select_data = hwif->mate->select_data;
229 	} else {
230 		hwif->select_data = (unsigned long)
231 					&ns87415_control[ns87415_count++];
232 		ctrl |= (1 << 8) | (1 << 9);	/* mask both IRQs */
233 		if (using_inta)
234 			ctrl &= ~(1 << 6);	/* unmask INTA */
235 		*((unsigned int *)hwif->select_data) = ctrl;
236 		(void) pci_write_config_dword(dev, 0x40, ctrl);
237 
238 		/*
239 		 * Set prefetch size to 512 bytes for both ports,
240 		 * but don't turn on/off prefetching here.
241 		 */
242 		pci_write_config_byte(dev, 0x55, 0xee);
243 
244 #ifdef __sparc_v9__
245 		/*
246 		 * XXX: Reset the device, if we don't it will not respond to
247 		 *      dev_select() properly during first ide_probe_port().
248 		 */
249 		timeout = 10000;
250 		outb(12, hwif->io_ports.ctl_addr);
251 		udelay(10);
252 		outb(8, hwif->io_ports.ctl_addr);
253 		do {
254 			udelay(50);
255 			stat = hwif->tp_ops->read_status(hwif);
256 			if (stat == 0xff)
257 				break;
258 		} while ((stat & ATA_BUSY) && --timeout);
259 #endif
260 	}
261 
262 	if (!using_inta)
263 		hwif->irq = pci_get_legacy_ide_irq(dev, hwif->channel);
264 
265 	if (!hwif->dma_base)
266 		return;
267 
268 	outb(0x60, hwif->dma_base + ATA_DMA_STATUS);
269 }
270 
271 static const struct ide_tp_ops ns87415_tp_ops = {
272 	.exec_command		= ide_exec_command,
273 	.read_status		= ide_read_status,
274 	.read_altstatus		= ide_read_altstatus,
275 	.write_devctl		= ide_write_devctl,
276 
277 	.dev_select		= ns87415_dev_select,
278 	.tf_load		= ide_tf_load,
279 	.tf_read		= ide_tf_read,
280 
281 	.input_data		= ide_input_data,
282 	.output_data		= ide_output_data,
283 };
284 
285 static const struct ide_dma_ops ns87415_dma_ops = {
286 	.dma_host_set		= ide_dma_host_set,
287 	.dma_setup		= ide_dma_setup,
288 	.dma_start		= ns87415_dma_start,
289 	.dma_end		= ns87415_dma_end,
290 	.dma_test_irq		= ide_dma_test_irq,
291 	.dma_lost_irq		= ide_dma_lost_irq,
292 	.dma_timer_expiry	= ide_dma_sff_timer_expiry,
293 	.dma_sff_read_status	= superio_dma_sff_read_status,
294 };
295 
296 static const struct ide_port_info ns87415_chipset __devinitdata = {
297 	.name		= DRV_NAME,
298 	.init_hwif	= init_hwif_ns87415,
299 	.tp_ops 	= &ns87415_tp_ops,
300 	.dma_ops	= &ns87415_dma_ops,
301 	.host_flags	= IDE_HFLAG_TRUST_BIOS_FOR_DMA |
302 			  IDE_HFLAG_NO_ATAPI_DMA,
303 };
304 
ns87415_init_one(struct pci_dev * dev,const struct pci_device_id * id)305 static int __devinit ns87415_init_one(struct pci_dev *dev, const struct pci_device_id *id)
306 {
307 	struct ide_port_info d = ns87415_chipset;
308 
309 #ifdef CONFIG_SUPERIO
310 	if (PCI_SLOT(dev->devfn) == 0xE) {
311 		/* Built-in - assume it's under superio. */
312 		d.init_iops = superio_init_iops;
313 		d.tp_ops = &superio_tp_ops;
314 	}
315 #endif
316 	return ide_pci_init_one(dev, &d, NULL);
317 }
318 
319 static const struct pci_device_id ns87415_pci_tbl[] = {
320 	{ PCI_VDEVICE(NS, PCI_DEVICE_ID_NS_87415), 0 },
321 	{ 0, },
322 };
323 MODULE_DEVICE_TABLE(pci, ns87415_pci_tbl);
324 
325 static struct pci_driver ns87415_pci_driver = {
326 	.name		= "NS87415_IDE",
327 	.id_table	= ns87415_pci_tbl,
328 	.probe		= ns87415_init_one,
329 	.remove		= ide_pci_remove,
330 	.suspend	= ide_pci_suspend,
331 	.resume		= ide_pci_resume,
332 };
333 
ns87415_ide_init(void)334 static int __init ns87415_ide_init(void)
335 {
336 	return ide_pci_register_driver(&ns87415_pci_driver);
337 }
338 
ns87415_ide_exit(void)339 static void __exit ns87415_ide_exit(void)
340 {
341 	pci_unregister_driver(&ns87415_pci_driver);
342 }
343 
344 module_init(ns87415_ide_init);
345 module_exit(ns87415_ide_exit);
346 
347 MODULE_AUTHOR("Mark Lord, Eddie Dost, Andre Hedrick");
348 MODULE_DESCRIPTION("PCI driver module for NS87415 IDE");
349 MODULE_LICENSE("GPL");
350