[mirror_ubuntu-bionic-kernel.git] / drivers / ata / pata_platform.c

/*
 * Generic platform device PATA driver
 *
 * Copyright (C) 2006  Paul Mundt
 *
 * Based on pata_pcmcia:
 *
 *   Copyright 2005-2006 Red Hat Inc <alan@redhat.com>, all rights reserved.
 *
 * This file is subject to the terms and conditions of the GNU General Public
 * License.  See the file "COPYING" in the main directory of this archive
 * for more details.
 */
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/blkdev.h>
#include <scsi/scsi_host.h>
#include <linux/ata.h>
#include <linux/libata.h>
#include <linux/platform_device.h>
#include <linux/pata_platform.h>

#define DRV_NAME "pata_platform"
#define DRV_VERSION "0.1.2"

static int pio_mask = 1;

/*
 * Provide our own set_mode() as we don't want to change anything that has
 * already been configured..
 */
static int pata_platform_set_mode(struct ata_port *ap, struct ata_device **unused)
{
	int i;

	for (i = 0; i < ATA_MAX_DEVICES; i++) {
		struct ata_device *dev = &ap->device[i];

		if (ata_dev_enabled(dev)) {
			/* We don't really care */
			dev->pio_mode = dev->xfer_mode = XFER_PIO_0;
			dev->xfer_shift = ATA_SHIFT_PIO;
			dev->flags |= ATA_DFLAG_PIO;
		}
	}
	return 0;
}

static struct scsi_host_template pata_platform_sht = {
	.module			= THIS_MODULE,
	.name			= DRV_NAME,
	.ioctl			= ata_scsi_ioctl,
	.queuecommand		= ata_scsi_queuecmd,
	.can_queue		= ATA_DEF_QUEUE,
	.this_id		= ATA_SHT_THIS_ID,
	.sg_tablesize		= LIBATA_MAX_PRD,
	.cmd_per_lun		= ATA_SHT_CMD_PER_LUN,
	.emulated		= ATA_SHT_EMULATED,
	.use_clustering		= ATA_SHT_USE_CLUSTERING,
	.proc_name		= DRV_NAME,
	.dma_boundary		= ATA_DMA_BOUNDARY,
	.slave_configure	= ata_scsi_slave_config,
	.slave_destroy		= ata_scsi_slave_destroy,
	.bios_param		= ata_std_bios_param,
};

static struct ata_port_operations pata_platform_port_ops = {
	.set_mode		= pata_platform_set_mode,

	.port_disable		= ata_port_disable,
	.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		= ata_bmdma_error_handler,
	.post_internal_cmd	= ata_bmdma_post_internal_cmd,

	.qc_prep		= ata_qc_prep,
	.qc_issue		= ata_qc_issue_prot,

	.data_xfer		= ata_data_xfer_noirq,

	.irq_handler		= ata_interrupt,
	.irq_clear		= ata_bmdma_irq_clear,

	.port_start		= ata_port_start,
};

static void pata_platform_setup_port(struct ata_ioports *ioaddr,
				     struct pata_platform_info *info)
{
	unsigned int shift = 0;

	/* Fixup the port shift for platforms that need it */
	if (info && info->ioport_shift)
		shift = info->ioport_shift;

	ioaddr->data_addr	= ioaddr->cmd_addr + (ATA_REG_DATA    << shift);
	ioaddr->error_addr	= ioaddr->cmd_addr + (ATA_REG_ERR     << shift);
	ioaddr->feature_addr	= ioaddr->cmd_addr + (ATA_REG_FEATURE << shift);
	ioaddr->nsect_addr	= ioaddr->cmd_addr + (ATA_REG_NSECT   << shift);
	ioaddr->lbal_addr	= ioaddr->cmd_addr + (ATA_REG_LBAL    << shift);
	ioaddr->lbam_addr	= ioaddr->cmd_addr + (ATA_REG_LBAM    << shift);
	ioaddr->lbah_addr	= ioaddr->cmd_addr + (ATA_REG_LBAH    << shift);
	ioaddr->device_addr	= ioaddr->cmd_addr + (ATA_REG_DEVICE  << shift);
	ioaddr->status_addr	= ioaddr->cmd_addr + (ATA_REG_STATUS  << shift);
	ioaddr->command_addr	= ioaddr->cmd_addr + (ATA_REG_CMD     << shift);
}

/**
 *	pata_platform_probe		-	attach a platform interface
 *	@pdev: platform device
 *
 *	Register a platform bus IDE interface. Such interfaces are PIO and we
 *	assume do not support IRQ sharing.
 *
 *	Platform devices are expected to contain 3 resources per port:
 *
 *		- I/O Base (IORESOURCE_IO or IORESOURCE_MEM)
 *		- CTL Base (IORESOURCE_IO or IORESOURCE_MEM)
 *		- IRQ	   (IORESOURCE_IRQ)
 *
 *	If the base resources are both mem types, the ioremap() is handled
 *	here. For IORESOURCE_IO, it's assumed that there's no remapping
 *	necessary.
 */
static int __devinit pata_platform_probe(struct platform_device *pdev)
{
	struct resource *io_res, *ctl_res;
	struct ata_probe_ent ae;
	unsigned int mmio;

	/*
	 * Simple resource validation ..
	 */
	if (unlikely(pdev->num_resources != 3)) {
		dev_err(&pdev->dev, "invalid number of resources\n");
		return -EINVAL;
	}

	/*
	 * Get the I/O base first
	 */
	io_res = platform_get_resource(pdev, IORESOURCE_IO, 0);
	if (io_res == NULL) {
		io_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
		if (unlikely(io_res == NULL))
			return -EINVAL;
	}

	/*
	 * Then the CTL base
	 */
	ctl_res = platform_get_resource(pdev, IORESOURCE_IO, 1);
	if (ctl_res == NULL) {
		ctl_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
		if (unlikely(ctl_res == NULL))
			return -EINVAL;
	}

	/*
	 * Check for MMIO
	 */
	mmio = (( io_res->flags == IORESOURCE_MEM) &&
		(ctl_res->flags == IORESOURCE_MEM));

	/*
	 * Now that that's out of the way, wire up the port..
	 */
	memset(&ae, 0, sizeof(struct ata_probe_ent));
	INIT_LIST_HEAD(&ae.node);
	ae.dev = &pdev->dev;
	ae.port_ops = &pata_platform_port_ops;
	ae.sht = &pata_platform_sht;
	ae.n_ports = 1;
	ae.pio_mask = pio_mask;
	ae.irq = platform_get_irq(pdev, 0);
	ae.irq_flags = 0;
	ae.port_flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST;

	/*
	 * Handle the MMIO case
	 */
	if (mmio) {
		ae.port[0].cmd_addr = devm_ioremap(&pdev->dev, io_res->start,
				io_res->end - io_res->start + 1);
		ae.port[0].ctl_addr = devm_ioremap(&pdev->dev, ctl_res->start,
				ctl_res->end - ctl_res->start + 1);
	} else {
		ae.port[0].cmd_addr = devm_ioport_map(&pdev->dev, io_res->start,
				io_res->end - io_res->start + 1);
		ae.port[0].ctl_addr = devm_ioport_map(&pdev->dev, ctl_res->start,
				ctl_res->end - ctl_res->start + 1);
	}
	if (!ae.port[0].cmd_addr || !ae.port[0].ctl_addr) {
		dev_err(&pdev->dev, "failed to map IO/CTL base\n");
		return -ENOMEM;
	}

	ae.port[0].altstatus_addr = ae.port[0].ctl_addr;

	pata_platform_setup_port(&ae.port[0], pdev->dev.platform_data);

	if (unlikely(ata_device_add(&ae) == 0))
		return -ENODEV;

	return 0;
}

/**
 *	pata_platform_remove	-	unplug a platform interface
 *	@pdev: platform device
 *
 *	A platform bus ATA device has been unplugged. Perform the needed
 *	cleanup. Also called on module unload for any active devices.
 */
static int __devexit pata_platform_remove(struct platform_device *pdev)
{
	struct device *dev = &pdev->dev;
	struct ata_host *host = dev_get_drvdata(dev);

	ata_host_detach(host);
	dev_set_drvdata(dev, NULL);

	return 0;
}

static struct platform_driver pata_platform_driver = {
	.probe		= pata_platform_probe,
	.remove		= __devexit_p(pata_platform_remove),
	.driver = {
		.name		= DRV_NAME,
		.owner		= THIS_MODULE,
	},
};

static int __init pata_platform_init(void)
{
	return platform_driver_register(&pata_platform_driver);
}

static void __exit pata_platform_exit(void)
{
	platform_driver_unregister(&pata_platform_driver);
}
module_init(pata_platform_init);
module_exit(pata_platform_exit);

module_param(pio_mask, int, 0);

MODULE_AUTHOR("Paul Mundt");
MODULE_DESCRIPTION("low-level driver for platform device ATA");
MODULE_LICENSE("GPL");
MODULE_VERSION(DRV_VERSION);
Commit	Line	Data
a20c9e82 PM	1	/*
	2	* Generic platform device PATA driver
	3	*
	4	* Copyright (C) 2006 Paul Mundt
	5	*
	6	* Based on pata_pcmcia:
	7	*
	8	* Copyright 2005-2006 Red Hat Inc <alan@redhat.com>, all rights reserved.
	9	*
	10	* This file is subject to the terms and conditions of the GNU General Public
	11	* License. See the file "COPYING" in the main directory of this archive
	12	* for more details.
	13	*/
	14	#include <linux/kernel.h>
	15	#include <linux/module.h>
	16	#include <linux/init.h>
	17	#include <linux/blkdev.h>
	18	#include <scsi/scsi_host.h>
	19	#include <linux/ata.h>
	20	#include <linux/libata.h>
	21	#include <linux/platform_device.h>
	22	#include <linux/pata_platform.h>
	23
	24	#define DRV_NAME "pata_platform"
	25	#define DRV_VERSION "0.1.2"
	26
	27	static int pio_mask = 1;
	28
	29	/*
	30	* Provide our own set_mode() as we don't want to change anything that has
	31	* already been configured..
	32	*/
161c888b	33	static int pata_platform_set_mode(struct ata_port ap, struct ata_device *unused)
a20c9e82 PM	34	{
	35	int i;
	36
	37	for (i = 0; i < ATA_MAX_DEVICES; i++) {
	38	struct ata_device *dev = &ap->device[i];
	39
	40	if (ata_dev_enabled(dev)) {
	41	/* We don't really care */
	42	dev->pio_mode = dev->xfer_mode = XFER_PIO_0;
	43	dev->xfer_shift = ATA_SHIFT_PIO;
	44	dev->flags \|= ATA_DFLAG_PIO;
	45	}
	46	}
161c888b	47	return 0;
a20c9e82 PM	48	}
a20c9e82 PM	49
a20c9e82 PM	50	static struct scsi_host_template pata_platform_sht = {
	51	.module = THIS_MODULE,
	52	.name = DRV_NAME,
	53	.ioctl = ata_scsi_ioctl,
	54	.queuecommand = ata_scsi_queuecmd,
	55	.can_queue = ATA_DEF_QUEUE,
	56	.this_id = ATA_SHT_THIS_ID,
	57	.sg_tablesize = LIBATA_MAX_PRD,
a20c9e82 PM	58	.cmd_per_lun = ATA_SHT_CMD_PER_LUN,
	59	.emulated = ATA_SHT_EMULATED,
	60	.use_clustering = ATA_SHT_USE_CLUSTERING,
	61	.proc_name = DRV_NAME,
	62	.dma_boundary = ATA_DMA_BOUNDARY,
	63	.slave_configure = ata_scsi_slave_config,
c972b60b	64	.slave_destroy = ata_scsi_slave_destroy,
a20c9e82 PM	65	.bios_param = ata_std_bios_param,
	66	};
	67
	68	static struct ata_port_operations pata_platform_port_ops = {
	69	.set_mode = pata_platform_set_mode,
	70
	71	.port_disable = ata_port_disable,
	72	.tf_load = ata_tf_load,
	73	.tf_read = ata_tf_read,
	74	.check_status = ata_check_status,
	75	.exec_command = ata_exec_command,
	76	.dev_select = ata_std_dev_select,
	77
	78	.freeze = ata_bmdma_freeze,
	79	.thaw = ata_bmdma_thaw,
	80	.error_handler = ata_bmdma_error_handler,
	81	.post_internal_cmd = ata_bmdma_post_internal_cmd,
	82
	83	.qc_prep = ata_qc_prep,
	84	.qc_issue = ata_qc_issue_prot,
	85
0d5ff566	86	.data_xfer = ata_data_xfer_noirq,
a20c9e82 PM	87
	88	.irq_handler = ata_interrupt,
	89	.irq_clear = ata_bmdma_irq_clear,
	90
	91	.port_start = ata_port_start,
a20c9e82 PM	92	};
	93
	94	static void pata_platform_setup_port(struct ata_ioports *ioaddr,
	95	struct pata_platform_info *info)
	96	{
	97	unsigned int shift = 0;
	98
	99	/* Fixup the port shift for platforms that need it */
	100	if (info && info->ioport_shift)
	101	shift = info->ioport_shift;
	102
	103	ioaddr->data_addr = ioaddr->cmd_addr + (ATA_REG_DATA << shift);
	104	ioaddr->error_addr = ioaddr->cmd_addr + (ATA_REG_ERR << shift);
	105	ioaddr->feature_addr = ioaddr->cmd_addr + (ATA_REG_FEATURE << shift);
	106	ioaddr->nsect_addr = ioaddr->cmd_addr + (ATA_REG_NSECT << shift);
	107	ioaddr->lbal_addr = ioaddr->cmd_addr + (ATA_REG_LBAL << shift);
	108	ioaddr->lbam_addr = ioaddr->cmd_addr + (ATA_REG_LBAM << shift);
	109	ioaddr->lbah_addr = ioaddr->cmd_addr + (ATA_REG_LBAH << shift);
	110	ioaddr->device_addr = ioaddr->cmd_addr + (ATA_REG_DEVICE << shift);
	111	ioaddr->status_addr = ioaddr->cmd_addr + (ATA_REG_STATUS << shift);
	112	ioaddr->command_addr = ioaddr->cmd_addr + (ATA_REG_CMD << shift);
	113	}
	114
	115	/**
	116	* pata_platform_probe - attach a platform interface
	117	* @pdev: platform device
	118	*
	119	* Register a platform bus IDE interface. Such interfaces are PIO and we
	120	* assume do not support IRQ sharing.
	121	*
	122	* Platform devices are expected to contain 3 resources per port:
	123	*
	124	* - I/O Base (IORESOURCE_IO or IORESOURCE_MEM)
	125	* - CTL Base (IORESOURCE_IO or IORESOURCE_MEM)
	126	* - IRQ (IORESOURCE_IRQ)
	127	*
	128	* If the base resources are both mem types, the ioremap() is handled
	129	* here. For IORESOURCE_IO, it's assumed that there's no remapping
	130	* necessary.
	131	*/
	132	static int __devinit pata_platform_probe(struct platform_device *pdev)
	133	{
	134	struct resource io_res, ctl_res;
	135	struct ata_probe_ent ae;
	136	unsigned int mmio;
a20c9e82 PM	137
	138	/*
	139	* Simple resource validation ..
	140	*/
	141	if (unlikely(pdev->num_resources != 3)) {
	142	dev_err(&pdev->dev, "invalid number of resources\n");
	143	return -EINVAL;
	144	}
	145
	146	/*
	147	* Get the I/O base first
	148	*/
	149	io_res = platform_get_resource(pdev, IORESOURCE_IO, 0);
	150	if (io_res == NULL) {
	151	io_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	152	if (unlikely(io_res == NULL))
	153	return -EINVAL;
	154	}
	155
	156	/*
	157	* Then the CTL base
	158	*/
	159	ctl_res = platform_get_resource(pdev, IORESOURCE_IO, 1);
	160	if (ctl_res == NULL) {
	161	ctl_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
	162	if (unlikely(ctl_res == NULL))
	163	return -EINVAL;
	164	}
	165
	166	/*
	167	* Check for MMIO
	168	*/
	169	mmio = (( io_res->flags == IORESOURCE_MEM) &&
	170	(ctl_res->flags == IORESOURCE_MEM));
	171
	172	/*
	173	* Now that that's out of the way, wire up the port..
	174	*/
	175	memset(&ae, 0, sizeof(struct ata_probe_ent));
	176	INIT_LIST_HEAD(&ae.node);
	177	ae.dev = &pdev->dev;
	178	ae.port_ops = &pata_platform_port_ops;
	179	ae.sht = &pata_platform_sht;
	180	ae.n_ports = 1;
	181	ae.pio_mask = pio_mask;
	182	ae.irq = platform_get_irq(pdev, 0);
	183	ae.irq_flags = 0;
	184	ae.port_flags = ATA_FLAG_SLAVE_POSS \| ATA_FLAG_SRST;
	185
	186	/*
	187	* Handle the MMIO case
	188	*/
	189	if (mmio) {
0d5ff566 TH	190	ae.port[0].cmd_addr = devm_ioremap(&pdev->dev, io_res->start,
	191	io_res->end - io_res->start + 1);
	192	ae.port[0].ctl_addr = devm_ioremap(&pdev->dev, ctl_res->start,
	193	ctl_res->end - ctl_res->start + 1);
a20c9e82	194	} else {
0d5ff566 TH	195	ae.port[0].cmd_addr = devm_ioport_map(&pdev->dev, io_res->start,
	196	io_res->end - io_res->start + 1);
	197	ae.port[0].ctl_addr = devm_ioport_map(&pdev->dev, ctl_res->start,
	198	ctl_res->end - ctl_res->start + 1);
	199	}
	200	if (!ae.port[0].cmd_addr \|\| !ae.port[0].ctl_addr) {
	201	dev_err(&pdev->dev, "failed to map IO/CTL base\n");
	202	return -ENOMEM;
a20c9e82 PM	203	}
	204
	205	ae.port[0].altstatus_addr = ae.port[0].ctl_addr;
	206
	207	pata_platform_setup_port(&ae.port[0], pdev->dev.platform_data);
	208
0d5ff566 TH	209	if (unlikely(ata_device_add(&ae) == 0))
0d5ff566 TH	210	return -ENODEV;
a20c9e82 PM	211
a20c9e82 PM	212	return 0;
a20c9e82 PM	213	}
	214
	215	/**
	216	* pata_platform_remove - unplug a platform interface
	217	* @pdev: platform device
	218	*
	219	* A platform bus ATA device has been unplugged. Perform the needed
	220	* cleanup. Also called on module unload for any active devices.
	221	*/
	222	static int __devexit pata_platform_remove(struct platform_device *pdev)
	223	{
	224	struct device *dev = &pdev->dev;
	225	struct ata_host *host = dev_get_drvdata(dev);
	226
1a68ff13	227	ata_host_detach(host);
a20c9e82 PM	228	dev_set_drvdata(dev, NULL);
	229
	230	return 0;
	231	}
	232
	233	static struct platform_driver pata_platform_driver = {
	234	.probe = pata_platform_probe,
	235	.remove = __devexit_p(pata_platform_remove),
	236	.driver = {
	237	.name = DRV_NAME,
	238	.owner = THIS_MODULE,
	239	},
	240	};
	241
	242	static int __init pata_platform_init(void)
	243	{
	244	return platform_driver_register(&pata_platform_driver);
	245	}
	246
	247	static void __exit pata_platform_exit(void)
	248	{
	249	platform_driver_unregister(&pata_platform_driver);
	250	}
	251	module_init(pata_platform_init);
	252	module_exit(pata_platform_exit);
	253
	254	module_param(pio_mask, int, 0);
	255
	256	MODULE_AUTHOR("Paul Mundt");
	257	MODULE_DESCRIPTION("low-level driver for platform device ATA");
	258	MODULE_LICENSE("GPL");
	259	MODULE_VERSION(DRV_VERSION);