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