[deliverable/linux.git] / drivers / ata / pata_acpi.c

/*
 *	ACPI PATA driver
 *
 *	(c) 2007 Red Hat  <alan@redhat.com>
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/init.h>
#include <linux/blkdev.h>
#include <linux/delay.h>
#include <linux/device.h>
#include <scsi/scsi_host.h>
#include <acpi/acpi_bus.h>
#include <acpi/acnames.h>
#include <acpi/acnamesp.h>
#include <acpi/acparser.h>
#include <acpi/acexcep.h>
#include <acpi/acmacros.h>
#include <acpi/actypes.h>

#include <linux/libata.h>
#include <linux/ata.h>

#define DRV_NAME	"pata_acpi"
#define DRV_VERSION	"0.2.3"

struct pata_acpi {
	struct ata_acpi_gtm gtm;
	void *last;
	unsigned long mask[2];
};

/**
 *	pacpi_pre_reset	-	check for 40/80 pin
 *	@ap: Port
 *	@deadline: deadline jiffies for the operation
 *
 *	Perform the PATA port setup we need.
 */

static int pacpi_pre_reset(struct ata_link *link, unsigned long deadline)
{
	struct ata_port *ap = link->ap;
	struct pata_acpi *acpi = ap->private_data;
	if (ap->acpi_handle == NULL || ata_acpi_gtm(ap, &acpi->gtm) < 0)
		return -ENODEV;

	return ata_std_prereset(link, deadline);
}

/**
 *	pacpi_cable_detect	-	cable type detection
 *	@ap: port to detect
 *
 *	Perform device specific cable detection
 */

static int pacpi_cable_detect(struct ata_port *ap)
{
	struct pata_acpi *acpi = ap->private_data;

	if ((acpi->mask[0] | acpi->mask[1]) & (0xF8 << ATA_SHIFT_UDMA))
		return ATA_CBL_PATA80;
	else
		return ATA_CBL_PATA40;
}

/**
 *	pacpi_error_handler - Setup and error handler
 *	@ap: Port to handle
 *
 *	LOCKING:
 *	None (inherited from caller).
 */

static void pacpi_error_handler(struct ata_port *ap)
{
	ata_bmdma_drive_eh(ap, pacpi_pre_reset, ata_std_softreset, NULL,
			   ata_std_postreset);
}

/**
 *	pacpi_discover_modes	-	filter non ACPI modes
 *	@adev: ATA device
 *	@mask: proposed modes
 *
 *	Try the modes available and see which ones the ACPI method will
 *	set up sensibly. From this we get a mask of ACPI modes we can use
 */

static unsigned long pacpi_discover_modes(struct ata_port *ap, struct ata_device *adev)
{
	struct pata_acpi *acpi = ap->private_data;
	struct ata_acpi_gtm probe;
	unsigned int xfer_mask;

	probe = acpi->gtm;

	ata_acpi_gtm(ap, &probe);

	xfer_mask = ata_acpi_gtm_xfermask(adev, &probe);

	if (xfer_mask & (0xF8 << ATA_SHIFT_UDMA))
		ap->cbl = ATA_CBL_PATA80;

	return xfer_mask;
}

/**
 *	pacpi_mode_filter	-	mode filter for ACPI
 *	@adev: device
 *	@mask: mask of valid modes
 *
 *	Filter the valid mode list according to our own specific rules, in
 *	this case the list of discovered valid modes obtained by ACPI probing
 */

static unsigned long pacpi_mode_filter(struct ata_device *adev, unsigned long mask)
{
	struct pata_acpi *acpi = adev->link->ap->private_data;
	return ata_pci_default_filter(adev, mask & acpi->mask[adev->devno]);
}

/**
 *	pacpi_set_piomode	-	set initial PIO mode data
 *	@ap: ATA interface
 *	@adev: ATA device
 */

static void pacpi_set_piomode(struct ata_port *ap, struct ata_device *adev)
{
	int unit = adev->devno;
	struct pata_acpi *acpi = ap->private_data;
	const struct ata_timing *t;

	if (!(acpi->gtm.flags & 0x10))
		unit = 0;

	/* Now stuff the nS values into the structure */
	t = ata_timing_find_mode(adev->pio_mode);
	acpi->gtm.drive[unit].pio = t->cycle;
	ata_acpi_stm(ap, &acpi->gtm);
	/* See what mode we actually got */
	ata_acpi_gtm(ap, &acpi->gtm);
}

/**
 *	pacpi_set_dmamode	-	set initial DMA mode data
 *	@ap: ATA interface
 *	@adev: ATA device
 */

static void pacpi_set_dmamode(struct ata_port *ap, struct ata_device *adev)
{
	int unit = adev->devno;
	struct pata_acpi *acpi = ap->private_data;
	const struct ata_timing *t;

	if (!(acpi->gtm.flags & 0x10))
		unit = 0;

	/* Now stuff the nS values into the structure */
	t = ata_timing_find_mode(adev->dma_mode);
	if (adev->dma_mode >= XFER_UDMA_0) {
		acpi->gtm.drive[unit].dma = t->udma;
		acpi->gtm.flags |= (1 << (2 * unit));
	} else {
		acpi->gtm.drive[unit].dma = t->cycle;
		acpi->gtm.flags &= ~(1 << (2 * unit));
	}
	ata_acpi_stm(ap, &acpi->gtm);
	/* See what mode we actually got */
	ata_acpi_gtm(ap, &acpi->gtm);
}

/**
 *	pacpi_qc_issue_prot	-	command issue
 *	@qc: command pending
 *
 *	Called when the libata layer is about to issue a command. We wrap
 *	this interface so that we can load the correct ATA timings if
 *	neccessary.
 */

static unsigned int pacpi_qc_issue_prot(struct ata_queued_cmd *qc)
{
	struct ata_port *ap = qc->ap;
	struct ata_device *adev = qc->dev;
	struct pata_acpi *acpi = ap->private_data;

	if (acpi->gtm.flags & 0x10)
		return ata_qc_issue_prot(qc);

	if (adev != acpi->last) {
		pacpi_set_piomode(ap, adev);
		if (adev->dma_mode)
			pacpi_set_dmamode(ap, adev);
		acpi->last = adev;
	}
	return ata_qc_issue_prot(qc);
}

/**
 *	pacpi_port_start	-	port setup
 *	@ap: ATA port being set up
 *
 *	Use the port_start hook to maintain private control structures
 */

static int pacpi_port_start(struct ata_port *ap)
{
	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
	struct pata_acpi *acpi;

	int ret;

	if (ap->acpi_handle == NULL)
		return -ENODEV;

	acpi = ap->private_data = devm_kzalloc(&pdev->dev, sizeof(struct pata_acpi), GFP_KERNEL);
	if (ap->private_data == NULL)
		return -ENOMEM;
	acpi->mask[0] = pacpi_discover_modes(ap, &ap->link.device[0]);
	acpi->mask[1] = pacpi_discover_modes(ap, &ap->link.device[1]);
	ret = ata_sff_port_start(ap);
	if (ret < 0)
		return ret;

	return ret;
}

static struct scsi_host_template pacpi_sht = {
	ATA_BMDMA_SHT(DRV_NAME),
};

static const struct ata_port_operations pacpi_ops = {
	.set_piomode		= pacpi_set_piomode,
	.set_dmamode		= pacpi_set_dmamode,
	.mode_filter		= pacpi_mode_filter,

	/* Task file is PCI ATA format, use helpers */
	.tf_load		= ata_tf_load,
	.tf_read		= ata_tf_read,
	.check_status		= ata_check_status,
	.exec_command		= ata_exec_command,
	.dev_select		= ata_std_dev_select,

	.freeze			= ata_bmdma_freeze,
	.thaw			= ata_bmdma_thaw,
	.error_handler		= pacpi_error_handler,
	.post_internal_cmd	= ata_bmdma_post_internal_cmd,
	.cable_detect		= pacpi_cable_detect,

	/* BMDMA handling is PCI ATA format, use helpers */
	.bmdma_setup		= ata_bmdma_setup,
	.bmdma_start		= ata_bmdma_start,
	.bmdma_stop		= ata_bmdma_stop,
	.bmdma_status		= ata_bmdma_status,
	.qc_prep		= ata_qc_prep,
	.qc_issue		= pacpi_qc_issue_prot,
	.data_xfer		= ata_data_xfer,

	/* Timeout handling */
	.irq_handler		= ata_interrupt,
	.irq_clear		= ata_bmdma_irq_clear,
	.irq_on			= ata_irq_on,

	/* Generic PATA PCI ATA helpers */
	.port_start		= pacpi_port_start,
};


/**
 *	pacpi_init_one - Register ACPI ATA PCI device with kernel services
 *	@pdev: PCI device to register
 *	@ent: Entry in pacpi_pci_tbl matching with @pdev
 *
 *	Called from kernel PCI layer.
 *
 *	LOCKING:
 *	Inherited from PCI layer (may sleep).
 *
 *	RETURNS:
 *	Zero on success, or -ERRNO value.
 */

static int pacpi_init_one (struct pci_dev *pdev, const struct pci_device_id *id)
{
	static const struct ata_port_info info = {
		.sht		= &pacpi_sht,
		.flags		= ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,

		.pio_mask	= 0x1f,
		.mwdma_mask	= 0x07,
		.udma_mask 	= 0x7f,

		.port_ops	= &pacpi_ops,
	};
	const struct ata_port_info *ppi[] = { &info, NULL };
	return ata_pci_init_one(pdev, ppi);
}

static const struct pci_device_id pacpi_pci_tbl[] = {
	{ PCI_ANY_ID,		PCI_ANY_ID,			   PCI_ANY_ID, PCI_ANY_ID, PCI_CLASS_STORAGE_IDE << 8, 0xFFFFFF00UL, 1},
	{ }	/* terminate list */
};

static struct pci_driver pacpi_pci_driver = {
	.name			= DRV_NAME,
	.id_table		= pacpi_pci_tbl,
	.probe			= pacpi_init_one,
	.remove			= ata_pci_remove_one,
#ifdef CONFIG_PM
	.suspend		= ata_pci_device_suspend,
	.resume			= ata_pci_device_resume,
#endif
};

static int __init pacpi_init(void)
{
	return pci_register_driver(&pacpi_pci_driver);
}

static void __exit pacpi_exit(void)
{
	pci_unregister_driver(&pacpi_pci_driver);
}

module_init(pacpi_init);
module_exit(pacpi_exit);

MODULE_AUTHOR("Alan Cox");
MODULE_DESCRIPTION("SCSI low-level driver for ATA in ACPI mode");
MODULE_LICENSE("GPL");
MODULE_DEVICE_TABLE(pci, pacpi_pci_tbl);
MODULE_VERSION(DRV_VERSION);
Commit	Line	Data
025621f9 AC	1	/*
	2	* ACPI PATA driver
	3	*
	4	* (c) 2007 Red Hat <alan@redhat.com>
	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 <scsi/scsi_host.h>
	15	#include <acpi/acpi_bus.h>
	16	#include <acpi/acnames.h>
	17	#include <acpi/acnamesp.h>
	18	#include <acpi/acparser.h>
	19	#include <acpi/acexcep.h>
	20	#include <acpi/acmacros.h>
	21	#include <acpi/actypes.h>
	22
	23	#include <linux/libata.h>
	24	#include <linux/ata.h>
	25
	26	#define DRV_NAME "pata_acpi"
	27	#define DRV_VERSION "0.2.3"
	28
	29	struct pata_acpi {
	30	struct ata_acpi_gtm gtm;
	31	void *last;
	32	unsigned long mask[2];
	33	};
	34
	35	/**
	36	* pacpi_pre_reset - check for 40/80 pin
	37	* @ap: Port
	38	* @deadline: deadline jiffies for the operation
	39	*
	40	* Perform the PATA port setup we need.
	41	*/
	42
	43	static int pacpi_pre_reset(struct ata_link *link, unsigned long deadline)
	44	{
	45	struct ata_port *ap = link->ap;
	46	struct pata_acpi *acpi = ap->private_data;
	47	if (ap->acpi_handle == NULL \|\| ata_acpi_gtm(ap, &acpi->gtm) < 0)
	48	return -ENODEV;
	49
	50	return ata_std_prereset(link, deadline);
	51	}
	52
	53	/**
	54	* pacpi_cable_detect - cable type detection
	55	* @ap: port to detect
	56	*
	57	* Perform device specific cable detection
	58	*/
	59
	60	static int pacpi_cable_detect(struct ata_port *ap)
	61	{
	62	struct pata_acpi *acpi = ap->private_data;
	63
	64	if ((acpi->mask[0] \| acpi->mask[1]) & (0xF8 << ATA_SHIFT_UDMA))
65	return ATA_CBL_PATA80;
66	else
67	return ATA_CBL_PATA40;
68	}
69
70	/**
71	* pacpi_error_handler - Setup and error handler
72	* @ap: Port to handle
73	*
74	* LOCKING:
75	* None (inherited from caller).
76	*/
77
78	static void pacpi_error_handler(struct ata_port *ap)
79	{
5410f729 HH	80	ata_bmdma_drive_eh(ap, pacpi_pre_reset, ata_std_softreset, NULL,
5410f729 HH	81	ata_std_postreset);
025621f9 AC	82	}
025621f9 AC	83
025621f9 AC	84	/**
	85	* pacpi_discover_modes - filter non ACPI modes
	86	* @adev: ATA device
	87	* @mask: proposed modes
	88	*
	89	* Try the modes available and see which ones the ACPI method will
	90	* set up sensibly. From this we get a mask of ACPI modes we can use
	91	*/
	92
	93	static unsigned long pacpi_discover_modes(struct ata_port ap, struct ata_device adev)
	94	{
025621f9	95	struct pata_acpi *acpi = ap->private_data;
025621f9	96	struct ata_acpi_gtm probe;
7c77fa4d	97	unsigned int xfer_mask;
025621f9 AC	98
	99	probe = acpi->gtm;
	100
025621f9 AC	101	ata_acpi_gtm(ap, &probe);
025621f9 AC	102
7c77fa4d	103	xfer_mask = ata_acpi_gtm_xfermask(adev, &probe);
025621f9	104
7c77fa4d	105	if (xfer_mask & (0xF8 << ATA_SHIFT_UDMA))
025621f9	106	ap->cbl = ATA_CBL_PATA80;
7c77fa4d TH	107
7c77fa4d TH	108	return xfer_mask;
025621f9 AC	109	}
	110
	111	/**
	112	* pacpi_mode_filter - mode filter for ACPI
	113	* @adev: device
	114	* @mask: mask of valid modes
	115	*
	116	* Filter the valid mode list according to our own specific rules, in
	117	* this case the list of discovered valid modes obtained by ACPI probing
	118	*/
	119
	120	static unsigned long pacpi_mode_filter(struct ata_device *adev, unsigned long mask)
	121	{
	122	struct pata_acpi *acpi = adev->link->ap->private_data;
	123	return ata_pci_default_filter(adev, mask & acpi->mask[adev->devno]);
	124	}
	125
	126	/**
	127	* pacpi_set_piomode - set initial PIO mode data
	128	* @ap: ATA interface
	129	* @adev: ATA device
	130	*/
	131
	132	static void pacpi_set_piomode(struct ata_port ap, struct ata_device adev)
	133	{
	134	int unit = adev->devno;
	135	struct pata_acpi *acpi = ap->private_data;
a0f79b92	136	const struct ata_timing *t;
025621f9	137
b447916e	138	if (!(acpi->gtm.flags & 0x10))
025621f9 AC	139	unit = 0;
	140
	141	/* Now stuff the nS values into the structure */
a0f79b92 TH	142	t = ata_timing_find_mode(adev->pio_mode);
a0f79b92 TH	143	acpi->gtm.drive[unit].pio = t->cycle;
025621f9 AC	144	ata_acpi_stm(ap, &acpi->gtm);
	145	/* See what mode we actually got */
	146	ata_acpi_gtm(ap, &acpi->gtm);
	147	}
	148
	149	/**
	150	* pacpi_set_dmamode - set initial DMA mode data
	151	* @ap: ATA interface
	152	* @adev: ATA device
	153	*/
	154
	155	static void pacpi_set_dmamode(struct ata_port ap, struct ata_device adev)
	156	{
	157	int unit = adev->devno;
	158	struct pata_acpi *acpi = ap->private_data;
a0f79b92	159	const struct ata_timing *t;
025621f9	160
b447916e	161	if (!(acpi->gtm.flags & 0x10))
025621f9 AC	162	unit = 0;
	163
	164	/* Now stuff the nS values into the structure */
a0f79b92	165	t = ata_timing_find_mode(adev->dma_mode);
025621f9	166	if (adev->dma_mode >= XFER_UDMA_0) {
a0f79b92	167	acpi->gtm.drive[unit].dma = t->udma;
025621f9 AC	168	acpi->gtm.flags \|= (1 << (2 * unit));
025621f9 AC	169	} else {
a0f79b92	170	acpi->gtm.drive[unit].dma = t->cycle;
025621f9 AC	171	acpi->gtm.flags &= ~(1 << (2 * unit));
	172	}
	173	ata_acpi_stm(ap, &acpi->gtm);
	174	/* See what mode we actually got */
	175	ata_acpi_gtm(ap, &acpi->gtm);
	176	}
	177
	178	/**
	179	* pacpi_qc_issue_prot - command issue
	180	* @qc: command pending
	181	*
	182	* Called when the libata layer is about to issue a command. We wrap
	183	* this interface so that we can load the correct ATA timings if
	184	* neccessary.
	185	*/
	186
	187	static unsigned int pacpi_qc_issue_prot(struct ata_queued_cmd *qc)
	188	{
	189	struct ata_port *ap = qc->ap;
	190	struct ata_device *adev = qc->dev;
	191	struct pata_acpi *acpi = ap->private_data;
	192
	193	if (acpi->gtm.flags & 0x10)
	194	return ata_qc_issue_prot(qc);
	195
	196	if (adev != acpi->last) {
	197	pacpi_set_piomode(ap, adev);
	198	if (adev->dma_mode)
	199	pacpi_set_dmamode(ap, adev);
	200	acpi->last = adev;
	201	}
	202	return ata_qc_issue_prot(qc);
	203	}
	204
	205	/**
	206	* pacpi_port_start - port setup
	207	* @ap: ATA port being set up
	208	*
	209	* Use the port_start hook to maintain private control structures
	210	*/
	211
	212	static int pacpi_port_start(struct ata_port *ap)
	213	{
	214	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
	215	struct pata_acpi *acpi;
	216
	217	int ret;
	218
	219	if (ap->acpi_handle == NULL)
	220	return -ENODEV;
	221
	222	acpi = ap->private_data = devm_kzalloc(&pdev->dev, sizeof(struct pata_acpi), GFP_KERNEL);
	223	if (ap->private_data == NULL)
	224	return -ENOMEM;
	225	acpi->mask[0] = pacpi_discover_modes(ap, &ap->link.device[0]);
	226	acpi->mask[1] = pacpi_discover_modes(ap, &ap->link.device[1]);
	227	ret = ata_sff_port_start(ap);
	228	if (ret < 0)
	229	return ret;
	230
	231	return ret;
	232	}
	233
	234	static struct scsi_host_template pacpi_sht = {
68d1d07b	235	ATA_BMDMA_SHT(DRV_NAME),
025621f9 AC	236	};
	237
	238	static const struct ata_port_operations pacpi_ops = {
	239	.set_piomode = pacpi_set_piomode,
	240	.set_dmamode = pacpi_set_dmamode,
	241	.mode_filter = pacpi_mode_filter,
	242
	243	/* Task file is PCI ATA format, use helpers */
	244	.tf_load = ata_tf_load,
	245	.tf_read = ata_tf_read,
	246	.check_status = ata_check_status,
	247	.exec_command = ata_exec_command,
	248	.dev_select = ata_std_dev_select,
	249
	250	.freeze = ata_bmdma_freeze,
	251	.thaw = ata_bmdma_thaw,
	252	.error_handler = pacpi_error_handler,
	253	.post_internal_cmd = ata_bmdma_post_internal_cmd,
	254	.cable_detect = pacpi_cable_detect,
	255
	256	/* BMDMA handling is PCI ATA format, use helpers */
	257	.bmdma_setup = ata_bmdma_setup,
	258	.bmdma_start = ata_bmdma_start,
	259	.bmdma_stop = ata_bmdma_stop,
	260	.bmdma_status = ata_bmdma_status,
	261	.qc_prep = ata_qc_prep,
	262	.qc_issue = pacpi_qc_issue_prot,
	263	.data_xfer = ata_data_xfer,
	264
	265	/* Timeout handling */
	266	.irq_handler = ata_interrupt,
	267	.irq_clear = ata_bmdma_irq_clear,
	268	.irq_on = ata_irq_on,
	269
	270	/* Generic PATA PCI ATA helpers */
	271	.port_start = pacpi_port_start,
	272	};
	273
	274
	275	/**
	276	* pacpi_init_one - Register ACPI ATA PCI device with kernel services
	277	* @pdev: PCI device to register
	278	* @ent: Entry in pacpi_pci_tbl matching with @pdev
	279	*
	280	* Called from kernel PCI layer.
	281	*
	282	* LOCKING:
	283	* Inherited from PCI layer (may sleep).
	284	*
	285	* RETURNS:
	286	* Zero on success, or -ERRNO value.
	287	*/
	288
	289	static int pacpi_init_one (struct pci_dev pdev, const struct pci_device_id id)
	290	{
	291	static const struct ata_port_info info = {
	292	.sht = &pacpi_sht,
	293	.flags = ATA_FLAG_SLAVE_POSS \| ATA_FLAG_SRST,
	294
	295	.pio_mask = 0x1f,
	296	.mwdma_mask = 0x07,
	297	.udma_mask = 0x7f,
	298
	299	.port_ops = &pacpi_ops,
300	};
301	const struct ata_port_info *ppi[] = { &info, NULL };
302	return ata_pci_init_one(pdev, ppi);
303	}
304
305	static const struct pci_device_id pacpi_pci_tbl[] = {
306	{ PCI_ANY_ID, PCI_ANY_ID, PCI_ANY_ID, PCI_ANY_ID, PCI_CLASS_STORAGE_IDE << 8, 0xFFFFFF00UL, 1},
307	{ } /* terminate list */
308	};
309
310	static struct pci_driver pacpi_pci_driver = {
311	.name = DRV_NAME,
312	.id_table = pacpi_pci_tbl,
313	.probe = pacpi_init_one,
314	.remove = ata_pci_remove_one,
8e2840e0	315	#ifdef CONFIG_PM
025621f9 AC	316	.suspend = ata_pci_device_suspend,
025621f9 AC	317	.resume = ata_pci_device_resume,
8e2840e0	318	#endif
025621f9 AC	319	};
	320
	321	static int __init pacpi_init(void)
	322	{
	323	return pci_register_driver(&pacpi_pci_driver);
	324	}
	325
	326	static void __exit pacpi_exit(void)
	327	{
	328	pci_unregister_driver(&pacpi_pci_driver);
	329	}
	330
	331	module_init(pacpi_init);
	332	module_exit(pacpi_exit);
	333
	334	MODULE_AUTHOR("Alan Cox");
	335	MODULE_DESCRIPTION("SCSI low-level driver for ATA in ACPI mode");
	336	MODULE_LICENSE("GPL");
	337	MODULE_DEVICE_TABLE(pci, pacpi_pci_tbl);
	338	MODULE_VERSION(DRV_VERSION);
	339