xref: /linux/drivers/ata/pata_acpi.c (revision 4413e16d9d21673bb5048a2e542f1aaa00015c2e)
1 /*
2  *	ACPI PATA driver
3  *
4  *	(c) 2007 Red Hat
5  */
6 
7 #include <linux/kernel.h>
8 #include <linux/module.h>
9 #include <linux/pci.h>
10 #include <linux/init.h>
11 #include <linux/blkdev.h>
12 #include <linux/delay.h>
13 #include <linux/device.h>
14 #include <linux/gfp.h>
15 #include <scsi/scsi_host.h>
16 #include <acpi/acpi_bus.h>
17 
18 #include <linux/libata.h>
19 #include <linux/ata.h>
20 
21 #define DRV_NAME	"pata_acpi"
22 #define DRV_VERSION	"0.2.3"
23 
24 struct pata_acpi {
25 	struct ata_acpi_gtm gtm;
26 	void *last;
27 	unsigned long mask[2];
28 };
29 
30 /**
31  *	pacpi_pre_reset	-	check for 40/80 pin
32  *	@ap: Port
33  *	@deadline: deadline jiffies for the operation
34  *
35  *	Perform the PATA port setup we need.
36  */
37 
38 static int pacpi_pre_reset(struct ata_link *link, unsigned long deadline)
39 {
40 	struct ata_port *ap = link->ap;
41 	struct pata_acpi *acpi = ap->private_data;
42 	if (ata_ap_acpi_handle(ap) == NULL || ata_acpi_gtm(ap, &acpi->gtm) < 0)
43 		return -ENODEV;
44 
45 	return ata_sff_prereset(link, deadline);
46 }
47 
48 /**
49  *	pacpi_cable_detect	-	cable type detection
50  *	@ap: port to detect
51  *
52  *	Perform device specific cable detection
53  */
54 
55 static int pacpi_cable_detect(struct ata_port *ap)
56 {
57 	struct pata_acpi *acpi = ap->private_data;
58 
59 	if ((acpi->mask[0] | acpi->mask[1]) & (0xF8 << ATA_SHIFT_UDMA))
60 		return ATA_CBL_PATA80;
61 	else
62 		return ATA_CBL_PATA40;
63 }
64 
65 /**
66  *	pacpi_discover_modes	-	filter non ACPI modes
67  *	@adev: ATA device
68  *	@mask: proposed modes
69  *
70  *	Try the modes available and see which ones the ACPI method will
71  *	set up sensibly. From this we get a mask of ACPI modes we can use
72  */
73 
74 static unsigned long pacpi_discover_modes(struct ata_port *ap, struct ata_device *adev)
75 {
76 	struct pata_acpi *acpi = ap->private_data;
77 	struct ata_acpi_gtm probe;
78 	unsigned int xfer_mask;
79 
80 	probe = acpi->gtm;
81 
82 	ata_acpi_gtm(ap, &probe);
83 
84 	xfer_mask = ata_acpi_gtm_xfermask(adev, &probe);
85 
86 	if (xfer_mask & (0xF8 << ATA_SHIFT_UDMA))
87 		ap->cbl = ATA_CBL_PATA80;
88 
89 	return xfer_mask;
90 }
91 
92 /**
93  *	pacpi_mode_filter	-	mode filter for ACPI
94  *	@adev: device
95  *	@mask: mask of valid modes
96  *
97  *	Filter the valid mode list according to our own specific rules, in
98  *	this case the list of discovered valid modes obtained by ACPI probing
99  */
100 
101 static unsigned long pacpi_mode_filter(struct ata_device *adev, unsigned long mask)
102 {
103 	struct pata_acpi *acpi = adev->link->ap->private_data;
104 	return mask & acpi->mask[adev->devno];
105 }
106 
107 /**
108  *	pacpi_set_piomode	-	set initial PIO mode data
109  *	@ap: ATA interface
110  *	@adev: ATA device
111  */
112 
113 static void pacpi_set_piomode(struct ata_port *ap, struct ata_device *adev)
114 {
115 	int unit = adev->devno;
116 	struct pata_acpi *acpi = ap->private_data;
117 	const struct ata_timing *t;
118 
119 	if (!(acpi->gtm.flags & 0x10))
120 		unit = 0;
121 
122 	/* Now stuff the nS values into the structure */
123 	t = ata_timing_find_mode(adev->pio_mode);
124 	acpi->gtm.drive[unit].pio = t->cycle;
125 	ata_acpi_stm(ap, &acpi->gtm);
126 	/* See what mode we actually got */
127 	ata_acpi_gtm(ap, &acpi->gtm);
128 }
129 
130 /**
131  *	pacpi_set_dmamode	-	set initial DMA mode data
132  *	@ap: ATA interface
133  *	@adev: ATA device
134  */
135 
136 static void pacpi_set_dmamode(struct ata_port *ap, struct ata_device *adev)
137 {
138 	int unit = adev->devno;
139 	struct pata_acpi *acpi = ap->private_data;
140 	const struct ata_timing *t;
141 
142 	if (!(acpi->gtm.flags & 0x10))
143 		unit = 0;
144 
145 	/* Now stuff the nS values into the structure */
146 	t = ata_timing_find_mode(adev->dma_mode);
147 	if (adev->dma_mode >= XFER_UDMA_0) {
148 		acpi->gtm.drive[unit].dma = t->udma;
149 		acpi->gtm.flags |= (1 << (2 * unit));
150 	} else {
151 		acpi->gtm.drive[unit].dma = t->cycle;
152 		acpi->gtm.flags &= ~(1 << (2 * unit));
153 	}
154 	ata_acpi_stm(ap, &acpi->gtm);
155 	/* See what mode we actually got */
156 	ata_acpi_gtm(ap, &acpi->gtm);
157 }
158 
159 /**
160  *	pacpi_qc_issue	-	command issue
161  *	@qc: command pending
162  *
163  *	Called when the libata layer is about to issue a command. We wrap
164  *	this interface so that we can load the correct ATA timings if
165  *	necessary.
166  */
167 
168 static unsigned int pacpi_qc_issue(struct ata_queued_cmd *qc)
169 {
170 	struct ata_port *ap = qc->ap;
171 	struct ata_device *adev = qc->dev;
172 	struct pata_acpi *acpi = ap->private_data;
173 
174 	if (acpi->gtm.flags & 0x10)
175 		return ata_bmdma_qc_issue(qc);
176 
177 	if (adev != acpi->last) {
178 		pacpi_set_piomode(ap, adev);
179 		if (ata_dma_enabled(adev))
180 			pacpi_set_dmamode(ap, adev);
181 		acpi->last = adev;
182 	}
183 	return ata_bmdma_qc_issue(qc);
184 }
185 
186 /**
187  *	pacpi_port_start	-	port setup
188  *	@ap: ATA port being set up
189  *
190  *	Use the port_start hook to maintain private control structures
191  */
192 
193 static int pacpi_port_start(struct ata_port *ap)
194 {
195 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
196 	struct pata_acpi *acpi;
197 
198 	if (ata_ap_acpi_handle(ap) == NULL)
199 		return -ENODEV;
200 
201 	acpi = ap->private_data = devm_kzalloc(&pdev->dev, sizeof(struct pata_acpi), GFP_KERNEL);
202 	if (ap->private_data == NULL)
203 		return -ENOMEM;
204 	acpi->mask[0] = pacpi_discover_modes(ap, &ap->link.device[0]);
205 	acpi->mask[1] = pacpi_discover_modes(ap, &ap->link.device[1]);
206 	return ata_bmdma_port_start(ap);
207 }
208 
209 static struct scsi_host_template pacpi_sht = {
210 	ATA_BMDMA_SHT(DRV_NAME),
211 };
212 
213 static struct ata_port_operations pacpi_ops = {
214 	.inherits		= &ata_bmdma_port_ops,
215 	.qc_issue		= pacpi_qc_issue,
216 	.cable_detect		= pacpi_cable_detect,
217 	.mode_filter		= pacpi_mode_filter,
218 	.set_piomode		= pacpi_set_piomode,
219 	.set_dmamode		= pacpi_set_dmamode,
220 	.prereset		= pacpi_pre_reset,
221 	.port_start		= pacpi_port_start,
222 };
223 
224 
225 /**
226  *	pacpi_init_one - Register ACPI ATA PCI device with kernel services
227  *	@pdev: PCI device to register
228  *	@ent: Entry in pacpi_pci_tbl matching with @pdev
229  *
230  *	Called from kernel PCI layer.
231  *
232  *	LOCKING:
233  *	Inherited from PCI layer (may sleep).
234  *
235  *	RETURNS:
236  *	Zero on success, or -ERRNO value.
237  */
238 
239 static int pacpi_init_one (struct pci_dev *pdev, const struct pci_device_id *id)
240 {
241 	static const struct ata_port_info info = {
242 		.flags		= ATA_FLAG_SLAVE_POSS,
243 
244 		.pio_mask	= ATA_PIO4,
245 		.mwdma_mask	= ATA_MWDMA2,
246 		.udma_mask 	= ATA_UDMA6,
247 
248 		.port_ops	= &pacpi_ops,
249 	};
250 	const struct ata_port_info *ppi[] = { &info, NULL };
251 	if (pdev->vendor == PCI_VENDOR_ID_ATI) {
252 		int rc = pcim_enable_device(pdev);
253 		if (rc < 0)
254 			return rc;
255 		pcim_pin_device(pdev);
256 	}
257 	return ata_pci_bmdma_init_one(pdev, ppi, &pacpi_sht, NULL, 0);
258 }
259 
260 static const struct pci_device_id pacpi_pci_tbl[] = {
261 	{ PCI_ANY_ID,		PCI_ANY_ID,			   PCI_ANY_ID, PCI_ANY_ID, PCI_CLASS_STORAGE_IDE << 8, 0xFFFFFF00UL, 1},
262 	{ }	/* terminate list */
263 };
264 
265 static struct pci_driver pacpi_pci_driver = {
266 	.name			= DRV_NAME,
267 	.id_table		= pacpi_pci_tbl,
268 	.probe			= pacpi_init_one,
269 	.remove			= ata_pci_remove_one,
270 #ifdef CONFIG_PM
271 	.suspend		= ata_pci_device_suspend,
272 	.resume			= ata_pci_device_resume,
273 #endif
274 };
275 
276 module_pci_driver(pacpi_pci_driver);
277 
278 MODULE_AUTHOR("Alan Cox");
279 MODULE_DESCRIPTION("SCSI low-level driver for ATA in ACPI mode");
280 MODULE_LICENSE("GPL");
281 MODULE_DEVICE_TABLE(pci, pacpi_pci_tbl);
282 MODULE_VERSION(DRV_VERSION);
283