xref: /linux/drivers/ata/pata_mpiix.c (revision b8bb76713ec50df2f11efee386e16f93d51e1076)
1 /*
2  * pata_mpiix.c 	- Intel MPIIX PATA for new ATA layer
3  *			  (C) 2005-2006 Red Hat Inc
4  *			  Alan Cox <alan@lxorguk.ukuu.org.uk>
5  *
6  * The MPIIX is different enough to the PIIX4 and friends that we give it
7  * a separate driver. The old ide/pci code handles this by just not tuning
8  * MPIIX at all.
9  *
10  * The MPIIX also differs in another important way from the majority of PIIX
11  * devices. The chip is a bridge (pardon the pun) between the old world of
12  * ISA IDE and PCI IDE. Although the ATA timings are PCI configured the actual
13  * IDE controller is not decoded in PCI space and the chip does not claim to
14  * be IDE class PCI. This requires slightly non-standard probe logic compared
15  * with PCI IDE and also that we do not disable the device when our driver is
16  * unloaded (as it has many other functions).
17  *
18  * The driver conciously keeps this logic internally to avoid pushing quirky
19  * PATA history into the clean libata layer.
20  *
21  * Thinkpad specific note: If you boot an MPIIX using a thinkpad with a PCMCIA
22  * hard disk present this driver will not detect it. This is not a bug. In this
23  * configuration the secondary port of the MPIIX is disabled and the addresses
24  * are decoded by the PCMCIA bridge and therefore are for a generic IDE driver
25  * to operate.
26  */
27 
28 #include <linux/kernel.h>
29 #include <linux/module.h>
30 #include <linux/pci.h>
31 #include <linux/init.h>
32 #include <linux/blkdev.h>
33 #include <linux/delay.h>
34 #include <scsi/scsi_host.h>
35 #include <linux/libata.h>
36 
37 #define DRV_NAME "pata_mpiix"
38 #define DRV_VERSION "0.7.7"
39 
40 enum {
41 	IDETIM = 0x6C,		/* IDE control register */
42 	IORDY = (1 << 1),
43 	PPE = (1 << 2),
44 	FTIM = (1 << 0),
45 	ENABLED = (1 << 15),
46 	SECONDARY = (1 << 14)
47 };
48 
49 static int mpiix_pre_reset(struct ata_link *link, unsigned long deadline)
50 {
51 	struct ata_port *ap = link->ap;
52 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
53 	static const struct pci_bits mpiix_enable_bits = { 0x6D, 1, 0x80, 0x80 };
54 
55 	if (!pci_test_config_bits(pdev, &mpiix_enable_bits))
56 		return -ENOENT;
57 
58 	return ata_sff_prereset(link, deadline);
59 }
60 
61 /**
62  *	mpiix_set_piomode	-	set initial PIO mode data
63  *	@ap: ATA interface
64  *	@adev: ATA device
65  *
66  *	Called to do the PIO mode setup. The MPIIX allows us to program the
67  *	IORDY sample point (2-5 clocks), recovery (1-4 clocks) and whether
68  *	prefetching or IORDY are used.
69  *
70  *	This would get very ugly because we can only program timing for one
71  *	device at a time, the other gets PIO0. Fortunately libata calls
72  *	our qc_issue command before a command is issued so we can flip the
73  *	timings back and forth to reduce the pain.
74  */
75 
76 static void mpiix_set_piomode(struct ata_port *ap, struct ata_device *adev)
77 {
78 	int control = 0;
79 	int pio = adev->pio_mode - XFER_PIO_0;
80 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
81 	u16 idetim;
82 	static const	 /* ISP  RTC */
83 	u8 timings[][2]	= { { 0, 0 },
84 			    { 0, 0 },
85 			    { 1, 0 },
86 			    { 2, 1 },
87 			    { 2, 3 }, };
88 
89 	pci_read_config_word(pdev, IDETIM, &idetim);
90 
91 	/* Mask the IORDY/TIME/PPE for this device */
92 	if (adev->class == ATA_DEV_ATA)
93 		control |= PPE;		/* Enable prefetch/posting for disk */
94 	if (ata_pio_need_iordy(adev))
95 		control |= IORDY;
96 	if (pio > 1)
97 		control |= FTIM;	/* This drive is on the fast timing bank */
98 
99 	/* Mask out timing and clear both TIME bank selects */
100 	idetim &= 0xCCEE;
101 	idetim &= ~(0x07  << (4 * adev->devno));
102 	idetim |= control << (4 * adev->devno);
103 
104 	idetim |= (timings[pio][0] << 12) | (timings[pio][1] << 8);
105 	pci_write_config_word(pdev, IDETIM, idetim);
106 
107 	/* We use ap->private_data as a pointer to the device currently
108 	   loaded for timing */
109 	ap->private_data = adev;
110 }
111 
112 /**
113  *	mpiix_qc_issue		-	command issue
114  *	@qc: command pending
115  *
116  *	Called when the libata layer is about to issue a command. We wrap
117  *	this interface so that we can load the correct ATA timings if
118  *	necessary. Our logic also clears TIME0/TIME1 for the other device so
119  *	that, even if we get this wrong, cycles to the other device will
120  *	be made PIO0.
121  */
122 
123 static unsigned int mpiix_qc_issue(struct ata_queued_cmd *qc)
124 {
125 	struct ata_port *ap = qc->ap;
126 	struct ata_device *adev = qc->dev;
127 
128 	/* If modes have been configured and the channel data is not loaded
129 	   then load it. We have to check if pio_mode is set as the core code
130 	   does not set adev->pio_mode to XFER_PIO_0 while probing as would be
131 	   logical */
132 
133 	if (adev->pio_mode && adev != ap->private_data)
134 		mpiix_set_piomode(ap, adev);
135 
136 	return ata_sff_qc_issue(qc);
137 }
138 
139 static struct scsi_host_template mpiix_sht = {
140 	ATA_PIO_SHT(DRV_NAME),
141 };
142 
143 static struct ata_port_operations mpiix_port_ops = {
144 	.inherits	= &ata_sff_port_ops,
145 	.qc_issue	= mpiix_qc_issue,
146 	.cable_detect	= ata_cable_40wire,
147 	.set_piomode	= mpiix_set_piomode,
148 	.prereset	= mpiix_pre_reset,
149 	.sff_data_xfer	= ata_sff_data_xfer32,
150 };
151 
152 static int mpiix_init_one(struct pci_dev *dev, const struct pci_device_id *id)
153 {
154 	/* Single threaded by the PCI probe logic */
155 	static int printed_version;
156 	struct ata_host *host;
157 	struct ata_port *ap;
158 	void __iomem *cmd_addr, *ctl_addr;
159 	u16 idetim;
160 	int cmd, ctl, irq;
161 
162 	if (!printed_version++)
163 		dev_printk(KERN_DEBUG, &dev->dev, "version " DRV_VERSION "\n");
164 
165 	host = ata_host_alloc(&dev->dev, 1);
166 	if (!host)
167 		return -ENOMEM;
168 	ap = host->ports[0];
169 
170 	/* MPIIX has many functions which can be turned on or off according
171 	   to other devices present. Make sure IDE is enabled before we try
172 	   and use it */
173 
174 	pci_read_config_word(dev, IDETIM, &idetim);
175 	if (!(idetim & ENABLED))
176 		return -ENODEV;
177 
178 	/* See if it's primary or secondary channel... */
179 	if (!(idetim & SECONDARY)) {
180 		cmd = 0x1F0;
181 		ctl = 0x3F6;
182 		irq = 14;
183 	} else {
184 		cmd = 0x170;
185 		ctl = 0x376;
186 		irq = 15;
187 	}
188 
189 	cmd_addr = devm_ioport_map(&dev->dev, cmd, 8);
190 	ctl_addr = devm_ioport_map(&dev->dev, ctl, 1);
191 	if (!cmd_addr || !ctl_addr)
192 		return -ENOMEM;
193 
194 	ata_port_desc(ap, "cmd 0x%x ctl 0x%x", cmd, ctl);
195 
196 	/* We do our own plumbing to avoid leaking special cases for whacko
197 	   ancient hardware into the core code. There are two issues to
198 	   worry about.  #1 The chip is a bridge so if in legacy mode and
199 	   without BARs set fools the setup.  #2 If you pci_disable_device
200 	   the MPIIX your box goes castors up */
201 
202 	ap->ops = &mpiix_port_ops;
203 	ap->pio_mask = ATA_PIO4;
204 	ap->flags |= ATA_FLAG_SLAVE_POSS;
205 
206 	ap->ioaddr.cmd_addr = cmd_addr;
207 	ap->ioaddr.ctl_addr = ctl_addr;
208 	ap->ioaddr.altstatus_addr = ctl_addr;
209 
210 	/* Let libata fill in the port details */
211 	ata_sff_std_ports(&ap->ioaddr);
212 
213 	/* activate host */
214 	return ata_host_activate(host, irq, ata_sff_interrupt, IRQF_SHARED,
215 				 &mpiix_sht);
216 }
217 
218 static const struct pci_device_id mpiix[] = {
219 	{ PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82371MX), },
220 
221 	{ },
222 };
223 
224 static struct pci_driver mpiix_pci_driver = {
225 	.name 		= DRV_NAME,
226 	.id_table	= mpiix,
227 	.probe 		= mpiix_init_one,
228 	.remove		= ata_pci_remove_one,
229 #ifdef CONFIG_PM
230 	.suspend	= ata_pci_device_suspend,
231 	.resume		= ata_pci_device_resume,
232 #endif
233 };
234 
235 static int __init mpiix_init(void)
236 {
237 	return pci_register_driver(&mpiix_pci_driver);
238 }
239 
240 static void __exit mpiix_exit(void)
241 {
242 	pci_unregister_driver(&mpiix_pci_driver);
243 }
244 
245 MODULE_AUTHOR("Alan Cox");
246 MODULE_DESCRIPTION("low-level driver for Intel MPIIX");
247 MODULE_LICENSE("GPL");
248 MODULE_DEVICE_TABLE(pci, mpiix);
249 MODULE_VERSION(DRV_VERSION);
250 
251 module_init(mpiix_init);
252 module_exit(mpiix_exit);
253