1/*
2 * pata_ns87410.c 	- National Semiconductor 87410 PATA for new ATA layer
3 *			  (C) 2006 Red Hat Inc
4 *			  Alan Cox <alan@redhat.com>
5 *
6 *  This program is free software; you can redistribute it and/or modify
7 *  it under the terms of the GNU General Public License as published by
8 *  the Free Software Foundation; either version 2, or (at your option)
9 *  any later version.
10 *
11 *  This program is distributed in the hope that it will be useful,
12 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 *  GNU General Public License for more details.
15 *
16 *  You should have received a copy of the GNU General Public License
17 *  along with this program; see the file COPYING.  If not, write to
18 *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
20
21#include <linux/kernel.h>
22#include <linux/module.h>
23#include <linux/pci.h>
24#include <linux/init.h>
25#include <linux/blkdev.h>
26#include <linux/delay.h>
27#include <scsi/scsi_host.h>
28#include <linux/libata.h>
29
30#define DRV_NAME "pata_ns87410"
31#define DRV_VERSION "0.4.6"
32
33/**
34 *	ns87410_pre_reset		-	probe begin
35 *	@ap: ATA port
36 *	@deadline: deadline jiffies for the operation
37 *
38 *	Check enabled ports
39 */
40
41static int ns87410_pre_reset(struct ata_port *ap, unsigned long deadline)
42{
43	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
44	static const struct pci_bits ns87410_enable_bits[] = {
45		{ 0x43, 1, 0x08, 0x08 },
46		{ 0x47, 1, 0x08, 0x08 }
47	};
48
49	if (!pci_test_config_bits(pdev, &ns87410_enable_bits[ap->port_no]))
50		return -ENOENT;
51
52	return ata_std_prereset(ap, deadline);
53}
54
55/**
56 *	ns87410_error_handler		-	probe reset
57 *	@ap: ATA port
58 *
59 *	Perform the ATA probe and bus reset sequence plus specific handling
60 *	for this hardware. The MPIIX has the enable bits in a different place
61 *	to PIIX4 and friends. As a pure PIO device it has no cable detect
62 */
63
64static void ns87410_error_handler(struct ata_port *ap)
65{
66	ata_bmdma_drive_eh(ap, ns87410_pre_reset, ata_std_softreset, NULL, ata_std_postreset);
67}
68
69/**
70 *	ns87410_set_piomode	-	set initial PIO mode data
71 *	@ap: ATA interface
72 *	@adev: ATA device
73 *
74 *	Program timing data. This is kept per channel not per device,
75 *	and only affects the data port.
76 */
77
78static void ns87410_set_piomode(struct ata_port *ap, struct ata_device *adev)
79{
80	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
81	int port = 0x40 + 4 * ap->port_no;
82	u8 idetcr, idefr;
83	struct ata_timing at;
84
85	static const u8 activebits[15] = {
86		0, 1, 2, 3, 4,
87		5, 5, 6, 6, 6,
88		6, 7, 7, 7, 7
89	};
90
91	static const u8 recoverbits[12] = {
92		0, 1, 2, 3, 4, 5, 6, 6, 7, 7, 7, 7
93	};
94
95	pci_read_config_byte(pdev, port + 3, &idefr);
96
97	if (ata_pio_need_iordy(adev))
98		idefr |= 0x04;	/* IORDY enable */
99	else
100		idefr &= ~0x04;
101
102	if (ata_timing_compute(adev, adev->pio_mode, &at, 30303, 1) < 0) {
103		dev_printk(KERN_ERR, &pdev->dev, "unknown mode %d.\n", adev->pio_mode);
104		return;
105	}
106
107	at.active = FIT(at.active, 2, 16) - 2;
108	at.setup = FIT(at.setup, 1, 4) - 1;
109	at.recover = FIT(at.recover, 1, 12) - 1;
110
111	idetcr = (at.setup << 6) | (recoverbits[at.recover] << 3) | activebits[at.active];
112
113	pci_write_config_byte(pdev, port, idetcr);
114	pci_write_config_byte(pdev, port + 3, idefr);
115	/* We use ap->private_data as a pointer to the device currently
116	   loaded for timing */
117	ap->private_data = adev;
118}
119
120/**
121 *	ns87410_qc_issue_prot	-	command issue
122 *	@qc: command pending
123 *
124 *	Called when the libata layer is about to issue a command. We wrap
125 *	this interface so that we can load the correct ATA timings if
126 *	neccessary.
127 */
128
129static unsigned int ns87410_qc_issue_prot(struct ata_queued_cmd *qc)
130{
131	struct ata_port *ap = qc->ap;
132	struct ata_device *adev = qc->dev;
133
134	/* If modes have been configured and the channel data is not loaded
135	   then load it. We have to check if pio_mode is set as the core code
136	   does not set adev->pio_mode to XFER_PIO_0 while probing as would be
137	   logical */
138
139	if (adev->pio_mode && adev != ap->private_data)
140		ns87410_set_piomode(ap, adev);
141
142	return ata_qc_issue_prot(qc);
143}
144
145static struct scsi_host_template ns87410_sht = {
146	.module			= THIS_MODULE,
147	.name			= DRV_NAME,
148	.ioctl			= ata_scsi_ioctl,
149	.queuecommand		= ata_scsi_queuecmd,
150	.can_queue		= ATA_DEF_QUEUE,
151	.this_id		= ATA_SHT_THIS_ID,
152	.sg_tablesize		= LIBATA_MAX_PRD,
153	.cmd_per_lun		= ATA_SHT_CMD_PER_LUN,
154	.emulated		= ATA_SHT_EMULATED,
155	.use_clustering		= ATA_SHT_USE_CLUSTERING,
156	.proc_name		= DRV_NAME,
157	.dma_boundary		= ATA_DMA_BOUNDARY,
158	.slave_configure	= ata_scsi_slave_config,
159	.slave_destroy		= ata_scsi_slave_destroy,
160	.bios_param		= ata_std_bios_param,
161};
162
163static struct ata_port_operations ns87410_port_ops = {
164	.port_disable	= ata_port_disable,
165	.set_piomode	= ns87410_set_piomode,
166
167	.tf_load	= ata_tf_load,
168	.tf_read	= ata_tf_read,
169	.check_status 	= ata_check_status,
170	.exec_command	= ata_exec_command,
171	.dev_select 	= ata_std_dev_select,
172
173	.freeze		= ata_bmdma_freeze,
174	.thaw		= ata_bmdma_thaw,
175	.error_handler	= ns87410_error_handler,
176	.post_internal_cmd = ata_bmdma_post_internal_cmd,
177	.cable_detect	= ata_cable_40wire,
178
179	.qc_prep 	= ata_qc_prep,
180	.qc_issue	= ns87410_qc_issue_prot,
181
182	.data_xfer	= ata_data_xfer,
183
184	.irq_handler	= ata_interrupt,
185	.irq_clear	= ata_bmdma_irq_clear,
186	.irq_on		= ata_irq_on,
187	.irq_ack	= ata_irq_ack,
188
189	.port_start	= ata_port_start,
190};
191
192static int ns87410_init_one(struct pci_dev *dev, const struct pci_device_id *id)
193{
194	static const struct ata_port_info info = {
195		.sht = &ns87410_sht,
196		.flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
197		.pio_mask = 0x0F,
198		.port_ops = &ns87410_port_ops
199	};
200	const struct ata_port_info *ppi[] = { &info, NULL };
201	return ata_pci_init_one(dev, ppi);
202}
203
204static const struct pci_device_id ns87410[] = {
205	{ PCI_VDEVICE(NS, PCI_DEVICE_ID_NS_87410), },
206
207	{ },
208};
209
210static struct pci_driver ns87410_pci_driver = {
211	.name 		= DRV_NAME,
212	.id_table	= ns87410,
213	.probe 		= ns87410_init_one,
214	.remove		= ata_pci_remove_one,
215#ifdef CONFIG_PM
216	.suspend	= ata_pci_device_suspend,
217	.resume		= ata_pci_device_resume,
218#endif
219};
220
221static int __init ns87410_init(void)
222{
223	return pci_register_driver(&ns87410_pci_driver);
224}
225
226static void __exit ns87410_exit(void)
227{
228	pci_unregister_driver(&ns87410_pci_driver);
229}
230
231MODULE_AUTHOR("Alan Cox");
232MODULE_DESCRIPTION("low-level driver for Nat Semi 87410");
233MODULE_LICENSE("GPL");
234MODULE_DEVICE_TABLE(pci, ns87410);
235MODULE_VERSION(DRV_VERSION);
236
237module_init(ns87410_init);
238module_exit(ns87410_exit);
239