[mirror_ubuntu-hirsute-kernel.git] / drivers / ata / ata_generic.c

/*
 *  ata_generic.c - Generic PATA/SATA controller driver.
 *  Copyright 2005 Red Hat Inc <alan@redhat.com>, all rights reserved.
 *
 *  Elements from ide/pci/generic.c
 *	    Copyright (C) 2001-2002	Andre Hedrick <andre@linux-ide.org>
 *	    Portions (C) Copyright 2002  Red Hat Inc <alan@redhat.com>
 *
 *  May be copied or modified under the terms of the GNU General Public License
 *
 *  Driver for PCI IDE interfaces implementing the standard bus mastering
 *  interface functionality. This assumes the BIOS did the drive set up and
 *  tuning for us. By default we do not grab all IDE class devices as they
 *  may have other drivers or need fixups to avoid problems. Instead we keep
 *  a default list of stuff without documentation/driver that appears to
 *  work.
 */

#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 <scsi/scsi_host.h>
#include <linux/libata.h>

#define DRV_NAME "ata_generic"
#define DRV_VERSION "0.2.10"

/*
 *	A generic parallel ATA driver using libata
 */

/**
 *	generic_pre_reset		-	probe begin
 *	@ap: ATA port
 *
 *	Set up cable type and use generic probe init
 */

static int generic_pre_reset(struct ata_port *ap)
{
	ap->cbl = ATA_CBL_PATA80;
	return ata_std_prereset(ap);
}


/**
 *	generic_error_handler - Probe specified port on PATA host controller
 *	@ap: Port to probe
 *	@classes:
 *
 *	LOCKING:
 *	None (inherited from caller).
 */


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

/**
 *	generic_set_mode	-	mode setting
 *	@ap: interface to set up
 *	@unused: returned device on error
 *
 *	Use a non standard set_mode function. We don't want to be tuned.
 *	The BIOS configured everything. Our job is not to fiddle. We
 *	read the dma enabled bits from the PCI configuration of the device
 *	and respect them.
 */

static int generic_set_mode(struct ata_port *ap, struct ata_device **unused)
{
	int dma_enabled = 0;
	int i;

	/* Bits 5 and 6 indicate if DMA is active on master/slave */
	if (ap->ioaddr.bmdma_addr)
		dma_enabled = inb(ap->ioaddr.bmdma_addr + ATA_DMA_CMD);

	for (i = 0; i < ATA_MAX_DEVICES; i++) {
		struct ata_device *dev = &ap->device[i];
		if (ata_dev_ready(dev)) {
			/* We don't really care */
			dev->pio_mode = XFER_PIO_0;
			dev->dma_mode = XFER_MW_DMA_0;
			/* We do need the right mode information for DMA or PIO
			   and this comes from the current configuration flags */
			if (dma_enabled & (1 << (5 + i))) {
				dev->xfer_mode = XFER_MW_DMA_0;
				dev->xfer_shift = ATA_SHIFT_MWDMA;
				dev->flags &= ~ATA_DFLAG_PIO;
			} else {
				dev->xfer_mode = XFER_PIO_0;
				dev->xfer_shift = ATA_SHIFT_PIO;
				dev->flags |= ATA_DFLAG_PIO;
			}
		}
	}
	return 0;
}

static struct scsi_host_template generic_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,
	.resume			= ata_scsi_device_resume,
	.suspend		= ata_scsi_device_suspend,
};

static struct ata_port_operations generic_port_ops = {
	.set_mode	= generic_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,

	.bmdma_setup 	= ata_bmdma_setup,
	.bmdma_start 	= ata_bmdma_start,
	.bmdma_stop	= ata_bmdma_stop,
	.bmdma_status 	= ata_bmdma_status,

	.data_xfer	= ata_pio_data_xfer,

	.freeze		= ata_bmdma_freeze,
	.thaw		= ata_bmdma_thaw,
	.error_handler	= generic_error_handler,
	.post_internal_cmd = ata_bmdma_post_internal_cmd,

	.qc_prep 	= ata_qc_prep,
	.qc_issue	= ata_qc_issue_prot,

	.irq_handler	= ata_interrupt,
	.irq_clear	= ata_bmdma_irq_clear,

	.port_start	= ata_port_start,
};

static int all_generic_ide;		/* Set to claim all devices */

/**
 *	ata_generic_init		-	attach generic IDE
 *	@dev: PCI device found
 *	@id: match entry
 *
 *	Called each time a matching IDE interface is found. We check if the
 *	interface is one we wish to claim and if so we perform any chip
 *	specific hacks then let the ATA layer do the heavy lifting.
 */

static int ata_generic_init_one(struct pci_dev *dev, const struct pci_device_id *id)
{
	u16 command;
	static struct ata_port_info info = {
		.sht = &generic_sht,
		.flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
		.pio_mask = 0x1f,
		.mwdma_mask = 0x07,
		.udma_mask = 0x3f,
		.port_ops = &generic_port_ops
	};
	static struct ata_port_info *port_info[2] = { &info, &info };

	/* Don't use the generic entry unless instructed to do so */
	if (id->driver_data == 1 && all_generic_ide == 0)
		return -ENODEV;

	/* Devices that need care */
	if (dev->vendor == PCI_VENDOR_ID_UMC &&
	    dev->device == PCI_DEVICE_ID_UMC_UM8886A &&
	    (!(PCI_FUNC(dev->devfn) & 1)))
		return -ENODEV;

	if (dev->vendor == PCI_VENDOR_ID_OPTI &&
	    dev->device == PCI_DEVICE_ID_OPTI_82C558 &&
	    (!(PCI_FUNC(dev->devfn) & 1)))
		return -ENODEV;

	/* Don't re-enable devices in generic mode or we will break some
	   motherboards with disabled and unused IDE controllers */
	pci_read_config_word(dev, PCI_COMMAND, &command);
	if (!(command & PCI_COMMAND_IO))
		return -ENODEV;

	if (dev->vendor == PCI_VENDOR_ID_AL)
	    	ata_pci_clear_simplex(dev);

	return ata_pci_init_one(dev, port_info, 2);
}

static struct pci_device_id ata_generic[] = {
	{ PCI_DEVICE(PCI_VENDOR_ID_PCTECH, PCI_DEVICE_ID_PCTECH_SAMURAI_IDE), },
	{ PCI_DEVICE(PCI_VENDOR_ID_HOLTEK, PCI_DEVICE_ID_HOLTEK_6565), },
	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8673F), },
	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8886A), },
	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8886BF), },
	{ PCI_DEVICE(PCI_VENDOR_ID_HINT,   PCI_DEVICE_ID_HINT_VXPROII_IDE), },
	{ PCI_DEVICE(PCI_VENDOR_ID_VIA,    PCI_DEVICE_ID_VIA_82C561), },
	{ PCI_DEVICE(PCI_VENDOR_ID_OPTI,   PCI_DEVICE_ID_OPTI_82C558), },
	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO), },
	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_1), },
	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_2),  },
	/* Must come last. If you add entries adjust this table appropriately */
	{ PCI_ANY_ID,		PCI_ANY_ID,			   PCI_ANY_ID, PCI_ANY_ID, PCI_CLASS_STORAGE_IDE << 8, 0xFFFFFF00UL, 1},
	{ 0, },
};

static struct pci_driver ata_generic_pci_driver = {
	.name 		= DRV_NAME,
	.id_table	= ata_generic,
	.probe 		= ata_generic_init_one,
	.remove		= ata_pci_remove_one,
	.suspend	= ata_pci_device_suspend,
	.resume		= ata_pci_device_resume,
};

static int __init ata_generic_init(void)
{
	return pci_register_driver(&ata_generic_pci_driver);
}


static void __exit ata_generic_exit(void)
{
	pci_unregister_driver(&ata_generic_pci_driver);
}


MODULE_AUTHOR("Alan Cox");
MODULE_DESCRIPTION("low-level driver for generic ATA");
MODULE_LICENSE("GPL");
MODULE_DEVICE_TABLE(pci, ata_generic);
MODULE_VERSION(DRV_VERSION);

module_init(ata_generic_init);
module_exit(ata_generic_exit);

module_param(all_generic_ide, int, 0);
Commit	Line	Data
669a5db4 JG	1	/*
	2	* ata_generic.c - Generic PATA/SATA controller driver.
	3	* Copyright 2005 Red Hat Inc <alan@redhat.com>, all rights reserved.
	4	*
85cd7251	5	* Elements from ide/pci/generic.c
669a5db4 JG	6	* Copyright (C) 2001-2002 Andre Hedrick <andre@linux-ide.org>
	7	* Portions (C) Copyright 2002 Red Hat Inc <alan@redhat.com>
	8	*
	9	* May be copied or modified under the terms of the GNU General Public License
85cd7251	10	*
669a5db4 JG	11	* Driver for PCI IDE interfaces implementing the standard bus mastering
	12	* interface functionality. This assumes the BIOS did the drive set up and
	13	* tuning for us. By default we do not grab all IDE class devices as they
	14	* may have other drivers or need fixups to avoid problems. Instead we keep
	15	* a default list of stuff without documentation/driver that appears to
85cd7251	16	* work.
669a5db4 JG	17	*/
	18
	19	#include <linux/kernel.h>
	20	#include <linux/module.h>
	21	#include <linux/pci.h>
	22	#include <linux/init.h>
	23	#include <linux/blkdev.h>
	24	#include <linux/delay.h>
	25	#include <scsi/scsi_host.h>
	26	#include <linux/libata.h>
	27
	28	#define DRV_NAME "ata_generic"
30ced0f0	29	#define DRV_VERSION "0.2.10"
669a5db4 JG	30
	31	/*
	32	* A generic parallel ATA driver using libata
	33	*/
	34
	35	/**
	36	* generic_pre_reset - probe begin
	37	* @ap: ATA port
	38	*
	39	* Set up cable type and use generic probe init
	40	*/
85cd7251	41
669a5db4 JG	42	static int generic_pre_reset(struct ata_port *ap)
	43	{
	44	ap->cbl = ATA_CBL_PATA80;
	45	return ata_std_prereset(ap);
	46	}
	47
	48
	49	/**
	50	* generic_error_handler - Probe specified port on PATA host controller
	51	* @ap: Port to probe
	52	* @classes:
	53	*
	54	* LOCKING:
	55	* None (inherited from caller).
	56	*/
	57
85cd7251	58
669a5db4 JG	59	static void generic_error_handler(struct ata_port *ap)
	60	{
	61	ata_bmdma_drive_eh(ap, generic_pre_reset, ata_std_softreset, NULL, ata_std_postreset);
	62	}
	63
	64	/**
	65	* generic_set_mode - mode setting
	66	* @ap: interface to set up
b229a7b0	67	* @unused: returned device on error
669a5db4 JG	68	*
	69	* Use a non standard set_mode function. We don't want to be tuned.
	70	* The BIOS configured everything. Our job is not to fiddle. We
	71	* read the dma enabled bits from the PCI configuration of the device
85cd7251	72	* and respect them.
669a5db4	73	*/
85cd7251	74
b229a7b0	75	static int generic_set_mode(struct ata_port ap, struct ata_device *unused)
669a5db4 JG	76	{
	77	int dma_enabled = 0;
	78	int i;
	79
	80	/* Bits 5 and 6 indicate if DMA is active on master/slave */
	81	if (ap->ioaddr.bmdma_addr)
	82	dma_enabled = inb(ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
85cd7251	83
669a5db4 JG	84	for (i = 0; i < ATA_MAX_DEVICES; i++) {
669a5db4 JG	85	struct ata_device *dev = &ap->device[i];
b229a7b0	86	if (ata_dev_ready(dev)) {
669a5db4 JG	87	/* We don't really care */
	88	dev->pio_mode = XFER_PIO_0;
	89	dev->dma_mode = XFER_MW_DMA_0;
85cd7251	90	/* We do need the right mode information for DMA or PIO
669a5db4 JG	91	and this comes from the current configuration flags */
	92	if (dma_enabled & (1 << (5 + i))) {
	93	dev->xfer_mode = XFER_MW_DMA_0;
	94	dev->xfer_shift = ATA_SHIFT_MWDMA;
	95	dev->flags &= ~ATA_DFLAG_PIO;
	96	} else {
	97	dev->xfer_mode = XFER_PIO_0;
	98	dev->xfer_shift = ATA_SHIFT_PIO;
	99	dev->flags \|= ATA_DFLAG_PIO;
	100	}
	101	}
	102	}
b229a7b0	103	return 0;
669a5db4 JG	104	}
	105
	106	static struct scsi_host_template generic_sht = {
	107	.module = THIS_MODULE,
	108	.name = DRV_NAME,
	109	.ioctl = ata_scsi_ioctl,
	110	.queuecommand = ata_scsi_queuecmd,
	111	.can_queue = ATA_DEF_QUEUE,
	112	.this_id = ATA_SHT_THIS_ID,
	113	.sg_tablesize = LIBATA_MAX_PRD,
669a5db4 JG	114	.cmd_per_lun = ATA_SHT_CMD_PER_LUN,
	115	.emulated = ATA_SHT_EMULATED,
	116	.use_clustering = ATA_SHT_USE_CLUSTERING,
	117	.proc_name = DRV_NAME,
	118	.dma_boundary = ATA_DMA_BOUNDARY,
	119	.slave_configure = ata_scsi_slave_config,
afdfe899	120	.slave_destroy = ata_scsi_slave_destroy,
669a5db4	121	.bios_param = ata_std_bios_param,
30ced0f0 AC	122	.resume = ata_scsi_device_resume,
30ced0f0 AC	123	.suspend = ata_scsi_device_suspend,
669a5db4 JG	124	};
	125
	126	static struct ata_port_operations generic_port_ops = {
	127	.set_mode = generic_set_mode,
85cd7251	128
669a5db4 JG	129	.port_disable = ata_port_disable,
	130	.tf_load = ata_tf_load,
	131	.tf_read = ata_tf_read,
	132	.check_status = ata_check_status,
	133	.exec_command = ata_exec_command,
	134	.dev_select = ata_std_dev_select,
	135
	136	.bmdma_setup = ata_bmdma_setup,
	137	.bmdma_start = ata_bmdma_start,
	138	.bmdma_stop = ata_bmdma_stop,
	139	.bmdma_status = ata_bmdma_status,
85cd7251	140
669a5db4 JG	141	.data_xfer = ata_pio_data_xfer,
	142
	143	.freeze = ata_bmdma_freeze,
	144	.thaw = ata_bmdma_thaw,
	145	.error_handler = generic_error_handler,
	146	.post_internal_cmd = ata_bmdma_post_internal_cmd,
	147
	148	.qc_prep = ata_qc_prep,
	149	.qc_issue = ata_qc_issue_prot,
bda30288	150
669a5db4 JG	151	.irq_handler = ata_interrupt,
	152	.irq_clear = ata_bmdma_irq_clear,
	153
	154	.port_start = ata_port_start,
85cd7251 JG	155	};
85cd7251 JG	156
669a5db4 JG	157	static int all_generic_ide; /* Set to claim all devices */
	158
	159	/**
	160	* ata_generic_init - attach generic IDE
	161	* @dev: PCI device found
	162	* @id: match entry
	163	*
	164	* Called each time a matching IDE interface is found. We check if the
85cd7251	165	* interface is one we wish to claim and if so we perform any chip
669a5db4 JG	166	* specific hacks then let the ATA layer do the heavy lifting.
669a5db4 JG	167	*/
85cd7251	168
669a5db4 JG	169	static int ata_generic_init_one(struct pci_dev dev, const struct pci_device_id id)
	170	{
	171	u16 command;
	172	static struct ata_port_info info = {
	173	.sht = &generic_sht,
	174	.flags = ATA_FLAG_SLAVE_POSS \| ATA_FLAG_SRST,
	175	.pio_mask = 0x1f,
	176	.mwdma_mask = 0x07,
	177	.udma_mask = 0x3f,
	178	.port_ops = &generic_port_ops
	179	};
	180	static struct ata_port_info *port_info[2] = { &info, &info };
85cd7251	181
669a5db4 JG	182	/* Don't use the generic entry unless instructed to do so */
	183	if (id->driver_data == 1 && all_generic_ide == 0)
	184	return -ENODEV;
	185
	186	/* Devices that need care */
	187	if (dev->vendor == PCI_VENDOR_ID_UMC &&
	188	dev->device == PCI_DEVICE_ID_UMC_UM8886A &&
	189	(!(PCI_FUNC(dev->devfn) & 1)))
	190	return -ENODEV;
	191
	192	if (dev->vendor == PCI_VENDOR_ID_OPTI &&
	193	dev->device == PCI_DEVICE_ID_OPTI_82C558 &&
	194	(!(PCI_FUNC(dev->devfn) & 1)))
	195	return -ENODEV;
	196
	197	/* Don't re-enable devices in generic mode or we will break some
	198	motherboards with disabled and unused IDE controllers */
	199	pci_read_config_word(dev, PCI_COMMAND, &command);
	200	if (!(command & PCI_COMMAND_IO))
	201	return -ENODEV;
85cd7251	202
669a5db4 JG	203	if (dev->vendor == PCI_VENDOR_ID_AL)
	204	ata_pci_clear_simplex(dev);
	205
	206	return ata_pci_init_one(dev, port_info, 2);
	207	}
	208
	209	static struct pci_device_id ata_generic[] = {
	210	{ PCI_DEVICE(PCI_VENDOR_ID_PCTECH, PCI_DEVICE_ID_PCTECH_SAMURAI_IDE), },
	211	{ PCI_DEVICE(PCI_VENDOR_ID_HOLTEK, PCI_DEVICE_ID_HOLTEK_6565), },
85cd7251	212	{ PCI_DEVICE(PCI_VENDOR_ID_UMC, PCI_DEVICE_ID_UMC_UM8673F), },
669a5db4 JG	213	{ PCI_DEVICE(PCI_VENDOR_ID_UMC, PCI_DEVICE_ID_UMC_UM8886A), },
	214	{ PCI_DEVICE(PCI_VENDOR_ID_UMC, PCI_DEVICE_ID_UMC_UM8886BF), },
	215	{ PCI_DEVICE(PCI_VENDOR_ID_HINT, PCI_DEVICE_ID_HINT_VXPROII_IDE), },
	216	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_82C561), },
	217	{ PCI_DEVICE(PCI_VENDOR_ID_OPTI, PCI_DEVICE_ID_OPTI_82C558), },
	218	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO), },
	219	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_1), },
	220	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_2), },
	221	/* Must come last. If you add entries adjust this table appropriately */
	222	{ PCI_ANY_ID, PCI_ANY_ID, PCI_ANY_ID, PCI_ANY_ID, PCI_CLASS_STORAGE_IDE << 8, 0xFFFFFF00UL, 1},
	223	{ 0, },
	224	};
	225
	226	static struct pci_driver ata_generic_pci_driver = {
	227	.name = DRV_NAME,
	228	.id_table = ata_generic,
	229	.probe = ata_generic_init_one,
30ced0f0 AC	230	.remove = ata_pci_remove_one,
	231	.suspend = ata_pci_device_suspend,
	232	.resume = ata_pci_device_resume,
669a5db4 JG	233	};
	234
	235	static int __init ata_generic_init(void)
	236	{
3f03c671	237	return pci_register_driver(&ata_generic_pci_driver);
669a5db4 JG	238	}
	239
	240
	241	static void __exit ata_generic_exit(void)
	242	{
	243	pci_unregister_driver(&ata_generic_pci_driver);
	244	}
	245
	246
	247	MODULE_AUTHOR("Alan Cox");
	248	MODULE_DESCRIPTION("low-level driver for generic ATA");
	249	MODULE_LICENSE("GPL");
	250	MODULE_DEVICE_TABLE(pci, ata_generic);
	251	MODULE_VERSION(DRV_VERSION);
	252
	253	module_init(ata_generic_init);
	254	module_exit(ata_generic_exit);
	255
	256	module_param(all_generic_ide, int, 0);