[deliverable/linux.git] / drivers / scsi / sata_uli.c

/*
 *  sata_uli.c - ULi Electronics SATA
 *
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; see the file COPYING.  If not, write to
 *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *
 *  libata documentation is available via 'make {ps|pdf}docs',
 *  as Documentation/DocBook/libata.*
 *
 *  Hardware documentation available under NDA.
 *
 */

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

#define DRV_NAME	"sata_uli"
#define DRV_VERSION	"0.6"

enum {
	uli_5289		= 0,
	uli_5287		= 1,
	uli_5281		= 2,

	uli_max_ports		= 4,

	/* PCI configuration registers */
	ULI5287_BASE		= 0x90, /* sata0 phy SCR registers */
	ULI5287_OFFS		= 0x10, /* offset from sata0->sata1 phy regs */
	ULI5281_BASE		= 0x60, /* sata0 phy SCR  registers */
	ULI5281_OFFS		= 0x60, /* offset from sata0->sata1 phy regs */
};

struct uli_priv {
	unsigned int		scr_cfg_addr[uli_max_ports];
};

static int uli_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
static u32 uli_scr_read (struct ata_port *ap, unsigned int sc_reg);
static void uli_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);

static const struct pci_device_id uli_pci_tbl[] = {
	{ PCI_VENDOR_ID_AL, 0x5289, PCI_ANY_ID, PCI_ANY_ID, 0, 0, uli_5289 },
	{ PCI_VENDOR_ID_AL, 0x5287, PCI_ANY_ID, PCI_ANY_ID, 0, 0, uli_5287 },
	{ PCI_VENDOR_ID_AL, 0x5281, PCI_ANY_ID, PCI_ANY_ID, 0, 0, uli_5281 },
	{ }	/* terminate list */
};


static struct pci_driver uli_pci_driver = {
	.name			= DRV_NAME,
	.id_table		= uli_pci_tbl,
	.probe			= uli_init_one,
	.remove			= ata_pci_remove_one,
};

static struct scsi_host_template uli_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,
	.bios_param		= ata_std_bios_param,
};

static const struct ata_port_operations uli_ops = {
	.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,

	.phy_reset		= sata_phy_reset,

	.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		= ata_qc_issue_prot,

	.eng_timeout		= ata_eng_timeout,

	.irq_handler		= ata_interrupt,
	.irq_clear		= ata_bmdma_irq_clear,

	.scr_read		= uli_scr_read,
	.scr_write		= uli_scr_write,

	.port_start		= ata_port_start,
	.port_stop		= ata_port_stop,
	.host_stop		= ata_host_stop,
};

static struct ata_port_info uli_port_info = {
	.sht            = &uli_sht,
	.host_flags     = ATA_FLAG_SATA | ATA_FLAG_SATA_RESET |
			  ATA_FLAG_NO_LEGACY,
	.pio_mask       = 0x1f,		/* pio0-4 */
	.udma_mask      = 0x7f,		/* udma0-6 */
	.port_ops       = &uli_ops,
};


MODULE_AUTHOR("Peer Chen");
MODULE_DESCRIPTION("low-level driver for ULi Electronics SATA controller");
MODULE_LICENSE("GPL");
MODULE_DEVICE_TABLE(pci, uli_pci_tbl);
MODULE_VERSION(DRV_VERSION);

static unsigned int get_scr_cfg_addr(struct ata_port *ap, unsigned int sc_reg)
{
	struct uli_priv *hpriv = ap->host_set->private_data;
	return hpriv->scr_cfg_addr[ap->port_no] + (4 * sc_reg);
}

static u32 uli_scr_cfg_read (struct ata_port *ap, unsigned int sc_reg)
{
	struct pci_dev *pdev = to_pci_dev(ap->host_set->dev);
	unsigned int cfg_addr = get_scr_cfg_addr(ap, sc_reg);
	u32 val;

	pci_read_config_dword(pdev, cfg_addr, &val);
	return val;
}

static void uli_scr_cfg_write (struct ata_port *ap, unsigned int scr, u32 val)
{
	struct pci_dev *pdev = to_pci_dev(ap->host_set->dev);
	unsigned int cfg_addr = get_scr_cfg_addr(ap, scr);

	pci_write_config_dword(pdev, cfg_addr, val);
}

static u32 uli_scr_read (struct ata_port *ap, unsigned int sc_reg)
{
	if (sc_reg > SCR_CONTROL)
		return 0xffffffffU;

	return uli_scr_cfg_read(ap, sc_reg);
}

static void uli_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
{
	if (sc_reg > SCR_CONTROL)	//SCR_CONTROL=2, SCR_ERROR=1, SCR_STATUS=0
		return;

	uli_scr_cfg_write(ap, sc_reg, val);
}

static int uli_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
{
	static int printed_version;
	struct ata_probe_ent *probe_ent;
	struct ata_port_info *ppi;
	int rc;
	unsigned int board_idx = (unsigned int) ent->driver_data;
	int pci_dev_busy = 0;
	struct uli_priv *hpriv;

	if (!printed_version++)
		dev_printk(KERN_INFO, &pdev->dev, "version " DRV_VERSION "\n");

	rc = pci_enable_device(pdev);
	if (rc)
		return rc;

	rc = pci_request_regions(pdev, DRV_NAME);
	if (rc) {
		pci_dev_busy = 1;
		goto err_out;
	}

	rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
	if (rc)
		goto err_out_regions;
	rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
	if (rc)
		goto err_out_regions;

	ppi = &uli_port_info;
	probe_ent = ata_pci_init_native_mode(pdev, &ppi, ATA_PORT_PRIMARY | ATA_PORT_SECONDARY);
	if (!probe_ent) {
		rc = -ENOMEM;
		goto err_out_regions;
	}

	hpriv = kzalloc(sizeof(*hpriv), GFP_KERNEL);
	if (!hpriv) {
		rc = -ENOMEM;
		goto err_out_probe_ent;
	}

	probe_ent->private_data = hpriv;

	switch (board_idx) {
	case uli_5287:
		hpriv->scr_cfg_addr[0] = ULI5287_BASE;
		hpriv->scr_cfg_addr[1] = ULI5287_BASE + ULI5287_OFFS;
       		probe_ent->n_ports = 4;

       		probe_ent->port[2].cmd_addr = pci_resource_start(pdev, 0) + 8;
		probe_ent->port[2].altstatus_addr =
		probe_ent->port[2].ctl_addr =
			(pci_resource_start(pdev, 1) | ATA_PCI_CTL_OFS) + 4;
		probe_ent->port[2].bmdma_addr = pci_resource_start(pdev, 4) + 16;
		hpriv->scr_cfg_addr[2] = ULI5287_BASE + ULI5287_OFFS*4;

		probe_ent->port[3].cmd_addr = pci_resource_start(pdev, 2) + 8;
		probe_ent->port[3].altstatus_addr =
		probe_ent->port[3].ctl_addr =
			(pci_resource_start(pdev, 3) | ATA_PCI_CTL_OFS) + 4;
		probe_ent->port[3].bmdma_addr = pci_resource_start(pdev, 4) + 24;
		hpriv->scr_cfg_addr[3] = ULI5287_BASE + ULI5287_OFFS*5;

		ata_std_ports(&probe_ent->port[2]);
		ata_std_ports(&probe_ent->port[3]);
		break;

	case uli_5289:
		hpriv->scr_cfg_addr[0] = ULI5287_BASE;
		hpriv->scr_cfg_addr[1] = ULI5287_BASE + ULI5287_OFFS;
		break;

	case uli_5281:
		hpriv->scr_cfg_addr[0] = ULI5281_BASE;
		hpriv->scr_cfg_addr[1] = ULI5281_BASE + ULI5281_OFFS;
		break;

	default:
		BUG();
		break;
	}

	pci_set_master(pdev);
	pci_intx(pdev, 1);

	/* FIXME: check ata_device_add return value */
	ata_device_add(probe_ent);
	kfree(probe_ent);

	return 0;

err_out_probe_ent:
	kfree(probe_ent);
err_out_regions:
	pci_release_regions(pdev);
err_out:
	if (!pci_dev_busy)
		pci_disable_device(pdev);
	return rc;

}

static int __init uli_init(void)
{
	return pci_module_init(&uli_pci_driver);
}

static void __exit uli_exit(void)
{
	pci_unregister_driver(&uli_pci_driver);
}


module_init(uli_init);
module_exit(uli_exit);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* sata_uli.c - ULi Electronics SATA
	3	*
af36d7f0 JG	4	*
	5	* This program is free software; you can redistribute it and/or modify
	6	* it under the terms of the GNU General Public License as published by
	7	* the Free Software Foundation; either version 2, or (at your option)
	8	* any later version.
	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
	14	*
	15	* You should have received a copy of the GNU General Public License
	16	* along with this program; see the file COPYING. If not, write to
	17	* the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
	18	*
	19	*
	20	* libata documentation is available via 'make {ps\|pdf}docs',
	21	* as Documentation/DocBook/libata.*
	22	*
	23	* Hardware documentation available under NDA.
1da177e4 LT	24	*
	25	*/
	26
	27	#include <linux/config.h>
	28	#include <linux/kernel.h>
	29	#include <linux/module.h>
	30	#include <linux/pci.h>
	31	#include <linux/init.h>
	32	#include <linux/blkdev.h>
	33	#include <linux/delay.h>
	34	#include <linux/interrupt.h>
a9524a76	35	#include <linux/device.h>
1da177e4 LT	36	#include <scsi/scsi_host.h>
	37	#include <linux/libata.h>
	38
	39	#define DRV_NAME "sata_uli"
af64371a	40	#define DRV_VERSION "0.6"
1da177e4 LT	41
	42	enum {
	43	uli_5289 = 0,
	44	uli_5287 = 1,
	45	uli_5281 = 2,
	46
50106c5a JG	47	uli_max_ports = 4,
50106c5a JG	48
1da177e4 LT	49	/* PCI configuration registers */
	50	ULI5287_BASE = 0x90, /* sata0 phy SCR registers */
	51	ULI5287_OFFS = 0x10, /* offset from sata0->sata1 phy regs */
	52	ULI5281_BASE = 0x60, /* sata0 phy SCR registers */
	53	ULI5281_OFFS = 0x60, /* offset from sata0->sata1 phy regs */
	54	};
	55
50106c5a JG	56	struct uli_priv {
	57	unsigned int scr_cfg_addr[uli_max_ports];
	58	};
	59
1da177e4 LT	60	static int uli_init_one (struct pci_dev pdev, const struct pci_device_id ent);
	61	static u32 uli_scr_read (struct ata_port *ap, unsigned int sc_reg);
	62	static void uli_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
	63
3b7d697d	64	static const struct pci_device_id uli_pci_tbl[] = {
1da177e4 LT	65	{ PCI_VENDOR_ID_AL, 0x5289, PCI_ANY_ID, PCI_ANY_ID, 0, 0, uli_5289 },
	66	{ PCI_VENDOR_ID_AL, 0x5287, PCI_ANY_ID, PCI_ANY_ID, 0, 0, uli_5287 },
	67	{ PCI_VENDOR_ID_AL, 0x5281, PCI_ANY_ID, PCI_ANY_ID, 0, 0, uli_5281 },
	68	{ } /* terminate list */
	69	};
	70
	71
	72	static struct pci_driver uli_pci_driver = {
	73	.name = DRV_NAME,
	74	.id_table = uli_pci_tbl,
	75	.probe = uli_init_one,
	76	.remove = ata_pci_remove_one,
	77	};
	78
193515d5	79	static struct scsi_host_template uli_sht = {
1da177e4 LT	80	.module = THIS_MODULE,
	81	.name = DRV_NAME,
	82	.ioctl = ata_scsi_ioctl,
	83	.queuecommand = ata_scsi_queuecmd,
1da177e4 LT	84	.can_queue = ATA_DEF_QUEUE,
	85	.this_id = ATA_SHT_THIS_ID,
	86	.sg_tablesize = LIBATA_MAX_PRD,
1da177e4 LT	87	.cmd_per_lun = ATA_SHT_CMD_PER_LUN,
	88	.emulated = ATA_SHT_EMULATED,
	89	.use_clustering = ATA_SHT_USE_CLUSTERING,
	90	.proc_name = DRV_NAME,
	91	.dma_boundary = ATA_DMA_BOUNDARY,
	92	.slave_configure = ata_scsi_slave_config,
	93	.bios_param = ata_std_bios_param,
1da177e4 LT	94	};
1da177e4 LT	95
057ace5e	96	static const struct ata_port_operations uli_ops = {
1da177e4 LT	97	.port_disable = ata_port_disable,
	98
	99	.tf_load = ata_tf_load,
	100	.tf_read = ata_tf_read,
	101	.check_status = ata_check_status,
	102	.exec_command = ata_exec_command,
	103	.dev_select = ata_std_dev_select,
	104
	105	.phy_reset = sata_phy_reset,
	106
	107	.bmdma_setup = ata_bmdma_setup,
	108	.bmdma_start = ata_bmdma_start,
	109	.bmdma_stop = ata_bmdma_stop,
	110	.bmdma_status = ata_bmdma_status,
	111	.qc_prep = ata_qc_prep,
	112	.qc_issue = ata_qc_issue_prot,
	113
	114	.eng_timeout = ata_eng_timeout,
	115
	116	.irq_handler = ata_interrupt,
	117	.irq_clear = ata_bmdma_irq_clear,
	118
	119	.scr_read = uli_scr_read,
	120	.scr_write = uli_scr_write,
	121
	122	.port_start = ata_port_start,
	123	.port_stop = ata_port_stop,
aa8f0dc6	124	.host_stop = ata_host_stop,
1da177e4 LT	125	};
	126
	127	static struct ata_port_info uli_port_info = {
	128	.sht = &uli_sht,
	129	.host_flags = ATA_FLAG_SATA \| ATA_FLAG_SATA_RESET \|
	130	ATA_FLAG_NO_LEGACY,
7da79312 BR	131	.pio_mask = 0x1f, /* pio0-4 */
7da79312 BR	132	.udma_mask = 0x7f, /* udma0-6 */
1da177e4 LT	133	.port_ops = &uli_ops,
	134	};
	135
	136
	137	MODULE_AUTHOR("Peer Chen");
	138	MODULE_DESCRIPTION("low-level driver for ULi Electronics SATA controller");
	139	MODULE_LICENSE("GPL");
	140	MODULE_DEVICE_TABLE(pci, uli_pci_tbl);
	141	MODULE_VERSION(DRV_VERSION);
	142
	143	static unsigned int get_scr_cfg_addr(struct ata_port *ap, unsigned int sc_reg)
	144	{
50106c5a JG	145	struct uli_priv *hpriv = ap->host_set->private_data;
50106c5a JG	146	return hpriv->scr_cfg_addr[ap->port_no] + (4 * sc_reg);
1da177e4 LT	147	}
	148
	149	static u32 uli_scr_cfg_read (struct ata_port *ap, unsigned int sc_reg)
	150	{
	151	struct pci_dev *pdev = to_pci_dev(ap->host_set->dev);
	152	unsigned int cfg_addr = get_scr_cfg_addr(ap, sc_reg);
	153	u32 val;
	154
	155	pci_read_config_dword(pdev, cfg_addr, &val);
	156	return val;
	157	}
	158
	159	static void uli_scr_cfg_write (struct ata_port *ap, unsigned int scr, u32 val)
	160	{
	161	struct pci_dev *pdev = to_pci_dev(ap->host_set->dev);
	162	unsigned int cfg_addr = get_scr_cfg_addr(ap, scr);
	163
	164	pci_write_config_dword(pdev, cfg_addr, val);
	165	}
	166
	167	static u32 uli_scr_read (struct ata_port *ap, unsigned int sc_reg)
	168	{
	169	if (sc_reg > SCR_CONTROL)
	170	return 0xffffffffU;
	171
	172	return uli_scr_cfg_read(ap, sc_reg);
	173	}
	174
	175	static void uli_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
	176	{
	177	if (sc_reg > SCR_CONTROL) //SCR_CONTROL=2, SCR_ERROR=1, SCR_STATUS=0
	178	return;
	179
	180	uli_scr_cfg_write(ap, sc_reg, val);
	181	}
	182
1da177e4 LT	183	static int uli_init_one (struct pci_dev pdev, const struct pci_device_id ent)
1da177e4 LT	184	{
a9524a76	185	static int printed_version;
1da177e4 LT	186	struct ata_probe_ent *probe_ent;
	187	struct ata_port_info *ppi;
	188	int rc;
	189	unsigned int board_idx = (unsigned int) ent->driver_data;
	190	int pci_dev_busy = 0;
50106c5a	191	struct uli_priv *hpriv;
1da177e4	192
a9524a76 JG	193	if (!printed_version++)
	194	dev_printk(KERN_INFO, &pdev->dev, "version " DRV_VERSION "\n");
	195
1da177e4 LT	196	rc = pci_enable_device(pdev);
	197	if (rc)
	198	return rc;
	199
	200	rc = pci_request_regions(pdev, DRV_NAME);
	201	if (rc) {
	202	pci_dev_busy = 1;
	203	goto err_out;
	204	}
	205
	206	rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
	207	if (rc)
	208	goto err_out_regions;
	209	rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
	210	if (rc)
	211	goto err_out_regions;
	212
	213	ppi = &uli_port_info;
47a86593	214	probe_ent = ata_pci_init_native_mode(pdev, &ppi, ATA_PORT_PRIMARY \| ATA_PORT_SECONDARY);
1da177e4 LT	215	if (!probe_ent) {
	216	rc = -ENOMEM;
	217	goto err_out_regions;
	218	}
8a60a071	219
50106c5a JG	220	hpriv = kzalloc(sizeof(*hpriv), GFP_KERNEL);
	221	if (!hpriv) {
	222	rc = -ENOMEM;
	223	goto err_out_probe_ent;
	224	}
	225
	226	probe_ent->private_data = hpriv;
	227
1da177e4 LT	228	switch (board_idx) {
1da177e4 LT	229	case uli_5287:
50106c5a JG	230	hpriv->scr_cfg_addr[0] = ULI5287_BASE;
50106c5a JG	231	hpriv->scr_cfg_addr[1] = ULI5287_BASE + ULI5287_OFFS;
1da177e4 LT	232	probe_ent->n_ports = 4;
	233
	234	probe_ent->port[2].cmd_addr = pci_resource_start(pdev, 0) + 8;
	235	probe_ent->port[2].altstatus_addr =
	236	probe_ent->port[2].ctl_addr =
	237	(pci_resource_start(pdev, 1) \| ATA_PCI_CTL_OFS) + 4;
	238	probe_ent->port[2].bmdma_addr = pci_resource_start(pdev, 4) + 16;
50106c5a	239	hpriv->scr_cfg_addr[2] = ULI5287_BASE + ULI5287_OFFS*4;
1da177e4 LT	240
	241	probe_ent->port[3].cmd_addr = pci_resource_start(pdev, 2) + 8;
	242	probe_ent->port[3].altstatus_addr =
	243	probe_ent->port[3].ctl_addr =
	244	(pci_resource_start(pdev, 3) \| ATA_PCI_CTL_OFS) + 4;
	245	probe_ent->port[3].bmdma_addr = pci_resource_start(pdev, 4) + 24;
50106c5a	246	hpriv->scr_cfg_addr[3] = ULI5287_BASE + ULI5287_OFFS*5;
1da177e4 LT	247
	248	ata_std_ports(&probe_ent->port[2]);
	249	ata_std_ports(&probe_ent->port[3]);
	250	break;
	251
	252	case uli_5289:
50106c5a JG	253	hpriv->scr_cfg_addr[0] = ULI5287_BASE;
50106c5a JG	254	hpriv->scr_cfg_addr[1] = ULI5287_BASE + ULI5287_OFFS;
1da177e4 LT	255	break;
	256
	257	case uli_5281:
50106c5a JG	258	hpriv->scr_cfg_addr[0] = ULI5281_BASE;
50106c5a JG	259	hpriv->scr_cfg_addr[1] = ULI5281_BASE + ULI5281_OFFS;
1da177e4 LT	260	break;
	261
	262	default:
	263	BUG();
	264	break;
	265	}
	266
	267	pci_set_master(pdev);
a04ce0ff	268	pci_intx(pdev, 1);
1da177e4 LT	269
	270	/* FIXME: check ata_device_add return value */
	271	ata_device_add(probe_ent);
	272	kfree(probe_ent);
	273
	274	return 0;
	275
50106c5a JG	276	err_out_probe_ent:
50106c5a JG	277	kfree(probe_ent);
1da177e4 LT	278	err_out_regions:
1da177e4 LT	279	pci_release_regions(pdev);
1da177e4 LT	280	err_out:
	281	if (!pci_dev_busy)
	282	pci_disable_device(pdev);
	283	return rc;
	284
	285	}
	286
	287	static int __init uli_init(void)
	288	{
	289	return pci_module_init(&uli_pci_driver);
	290	}
	291
	292	static void __exit uli_exit(void)
	293	{
	294	pci_unregister_driver(&uli_pci_driver);
	295	}
	296
	297
	298	module_init(uli_init);
	299	module_exit(uli_exit);