[GitHub/LineageOS/android_kernel_motorola_exynos9610.git] / drivers / ata / pata_atp867x.c

/*
 * pata_atp867x.c - ARTOP 867X 64bit 4-channel UDMA133 ATA controller driver
 *
 *	(C) 2009 Google Inc. John(Jung-Ik) Lee <jilee@google.com>
 *
 * Per Atp867 data sheet rev 1.2, Acard.
 * Based in part on early ide code from
 *	2003-2004 by Eric Uhrhane, Google, Inc.
 *
 * 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 of the License, 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; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 *
 * TODO:
 *   1. RAID features [comparison, XOR, striping, mirroring, etc.]
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/blkdev.h>
#include <linux/delay.h>
#include <linux/device.h>
#include <linux/gfp.h>
#include <scsi/scsi_host.h>
#include <linux/libata.h>

#define	DRV_NAME	"pata_atp867x"
#define	DRV_VERSION	"0.7.5"

/*
 * IO Registers
 * Note that all runtime hot priv ports are cached in ap private_data
 */

enum {
	ATP867X_IO_CHANNEL_OFFSET	= 0x10,

	/*
	 * IO Register Bitfields
	 */

	ATP867X_IO_PIOSPD_ACTIVE_SHIFT	= 4,
	ATP867X_IO_PIOSPD_RECOVER_SHIFT	= 0,

	ATP867X_IO_DMAMODE_MSTR_SHIFT	= 0,
	ATP867X_IO_DMAMODE_MSTR_MASK	= 0x07,
	ATP867X_IO_DMAMODE_SLAVE_SHIFT	= 4,
	ATP867X_IO_DMAMODE_SLAVE_MASK	= 0x70,

	ATP867X_IO_DMAMODE_UDMA_6	= 0x07,
	ATP867X_IO_DMAMODE_UDMA_5	= 0x06,
	ATP867X_IO_DMAMODE_UDMA_4	= 0x05,
	ATP867X_IO_DMAMODE_UDMA_3	= 0x04,
	ATP867X_IO_DMAMODE_UDMA_2	= 0x03,
	ATP867X_IO_DMAMODE_UDMA_1	= 0x02,
	ATP867X_IO_DMAMODE_UDMA_0	= 0x01,
	ATP867X_IO_DMAMODE_DISABLE	= 0x00,

	ATP867X_IO_SYS_INFO_66MHZ	= 0x04,
	ATP867X_IO_SYS_INFO_SLOW_UDMA5	= 0x02,
	ATP867X_IO_SYS_MASK_RESERVED	= (~0xf1),

	ATP867X_IO_PORTSPD_VAL		= 0x1143,
	ATP867X_PREREAD_VAL		= 0x0200,

	ATP867X_NUM_PORTS		= 4,
	ATP867X_BAR_IOBASE		= 0,
	ATP867X_BAR_ROMBASE		= 6,
};

#define ATP867X_IOBASE(ap)		((ap)->host->iomap[0])
#define ATP867X_SYS_INFO(ap)		(0x3F + ATP867X_IOBASE(ap))

#define ATP867X_IO_PORTBASE(ap, port)	(0x00 + ATP867X_IOBASE(ap) + \
					(port) * ATP867X_IO_CHANNEL_OFFSET)
#define ATP867X_IO_DMABASE(ap, port)	(0x40 + \
					ATP867X_IO_PORTBASE((ap), (port)))

#define ATP867X_IO_STATUS(ap, port)	(0x07 + \
					ATP867X_IO_PORTBASE((ap), (port)))
#define ATP867X_IO_ALTSTATUS(ap, port)	(0x0E + \
					ATP867X_IO_PORTBASE((ap), (port)))

/*
 * hot priv ports
 */
#define ATP867X_IO_MSTRPIOSPD(ap, port)	(0x08 + \
					ATP867X_IO_DMABASE((ap), (port)))
#define ATP867X_IO_SLAVPIOSPD(ap, port)	(0x09 + \
					ATP867X_IO_DMABASE((ap), (port)))
#define ATP867X_IO_8BPIOSPD(ap, port)	(0x0A + \
					ATP867X_IO_DMABASE((ap), (port)))
#define ATP867X_IO_DMAMODE(ap, port)	(0x0B + \
					ATP867X_IO_DMABASE((ap), (port)))

#define ATP867X_IO_PORTSPD(ap, port)	(0x4A + \
					ATP867X_IO_PORTBASE((ap), (port)))
#define ATP867X_IO_PREREAD(ap, port)	(0x4C + \
					ATP867X_IO_PORTBASE((ap), (port)))

struct atp867x_priv {
	void __iomem *dma_mode;
	void __iomem *mstr_piospd;
	void __iomem *slave_piospd;
	void __iomem *eightb_piospd;
	int		pci66mhz;
};

static void atp867x_set_dmamode(struct ata_port *ap, struct ata_device *adev)
{
	struct pci_dev *pdev	= to_pci_dev(ap->host->dev);
	struct atp867x_priv *dp = ap->private_data;
	u8 speed = adev->dma_mode;
	u8 b;
	u8 mode = speed - XFER_UDMA_0 + 1;

	/*
	 * Doc 6.6.9: decrease the udma mode value by 1 for safer UDMA speed
	 * on 66MHz bus
	 *   rev-A: UDMA_1~4 (5, 6 no change)
	 *   rev-B: all UDMA modes
	 *   UDMA_0 stays not to disable UDMA
	 */
	if (dp->pci66mhz && mode > ATP867X_IO_DMAMODE_UDMA_0  &&
	   (pdev->device == PCI_DEVICE_ID_ARTOP_ATP867B ||
	    mode < ATP867X_IO_DMAMODE_UDMA_5))
		mode--;

	b = ioread8(dp->dma_mode);
	if (adev->devno & 1) {
		b = (b & ~ATP867X_IO_DMAMODE_SLAVE_MASK) |
			(mode << ATP867X_IO_DMAMODE_SLAVE_SHIFT);
	} else {
		b = (b & ~ATP867X_IO_DMAMODE_MSTR_MASK) |
			(mode << ATP867X_IO_DMAMODE_MSTR_SHIFT);
	}
	iowrite8(b, dp->dma_mode);
}

static int atp867x_get_active_clocks_shifted(struct ata_port *ap,
	unsigned int clk)
{
	struct atp867x_priv *dp = ap->private_data;
	unsigned char clocks = clk;

	/*
	 * Doc 6.6.9: increase the clock value by 1 for safer PIO speed
	 * on 66MHz bus
	 */
	if (dp->pci66mhz)
		clocks++;

	switch (clocks) {
	case 0:
		clocks = 1;
		break;
	case 1 ... 6:
		break;
	default:
		printk(KERN_WARNING "ATP867X: active %dclk is invalid. "
			"Using 12clk.\n", clk);
	case 9 ... 12:
		clocks = 7;	/* 12 clk */
		break;
	case 7:
	case 8:	/* default 8 clk */
		clocks = 0;
		goto active_clock_shift_done;
	}

active_clock_shift_done:
	return clocks << ATP867X_IO_PIOSPD_ACTIVE_SHIFT;
}

static int atp867x_get_recover_clocks_shifted(unsigned int clk)
{
	unsigned char clocks = clk;

	switch (clocks) {
	case 0:
		clocks = 1;
		break;
	case 1 ... 11:
		break;
	case 13:
	case 14:
		--clocks;	/* by the spec */
		break;
	case 15:
		break;
	default:
		printk(KERN_WARNING "ATP867X: recover %dclk is invalid. "
			"Using default 12clk.\n", clk);
	case 12:	/* default 12 clk */
		clocks = 0;
		break;
	}

	return clocks << ATP867X_IO_PIOSPD_RECOVER_SHIFT;
}

static void atp867x_set_piomode(struct ata_port *ap, struct ata_device *adev)
{
	struct ata_device *peer = ata_dev_pair(adev);
	struct atp867x_priv *dp = ap->private_data;
	u8 speed = adev->pio_mode;
	struct ata_timing t, p;
	int T, UT;
	u8 b;

	T = 1000000000 / 33333;
	UT = T / 4;

	ata_timing_compute(adev, speed, &t, T, UT);
	if (peer && peer->pio_mode) {
		ata_timing_compute(peer, peer->pio_mode, &p, T, UT);
		ata_timing_merge(&p, &t, &t, ATA_TIMING_8BIT);
	}

	b = ioread8(dp->dma_mode);
	if (adev->devno & 1)
		b = (b & ~ATP867X_IO_DMAMODE_SLAVE_MASK);
	else
		b = (b & ~ATP867X_IO_DMAMODE_MSTR_MASK);
	iowrite8(b, dp->dma_mode);

	b = atp867x_get_active_clocks_shifted(ap, t.active) |
	    atp867x_get_recover_clocks_shifted(t.recover);

	if (adev->devno & 1)
		iowrite8(b, dp->slave_piospd);
	else
		iowrite8(b, dp->mstr_piospd);

	b = atp867x_get_active_clocks_shifted(ap, t.act8b) |
	    atp867x_get_recover_clocks_shifted(t.rec8b);

	iowrite8(b, dp->eightb_piospd);
}

static int atp867x_cable_override(struct pci_dev *pdev)
{
	if (pdev->subsystem_vendor == PCI_VENDOR_ID_ARTOP &&
		(pdev->subsystem_device == PCI_DEVICE_ID_ARTOP_ATP867A ||
		 pdev->subsystem_device == PCI_DEVICE_ID_ARTOP_ATP867B)) {
		return 1;
	}
	return 0;
}

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

	if (atp867x_cable_override(pdev))
		return ATA_CBL_PATA40_SHORT;

	return ATA_CBL_PATA_UNK;
}

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

static struct ata_port_operations atp867x_ops = {
	.inherits		= &ata_bmdma_port_ops,
	.cable_detect		= atp867x_cable_detect,
	.set_piomode		= atp867x_set_piomode,
	.set_dmamode		= atp867x_set_dmamode,
};


#ifdef	ATP867X_DEBUG
static void atp867x_check_res(struct pci_dev *pdev)
{
	int i;
	unsigned long start, len;

	/* Check the PCI resources for this channel are enabled */
	for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
		start = pci_resource_start(pdev, i);
		len   = pci_resource_len(pdev, i);
		printk(KERN_DEBUG "ATP867X: resource start:len=%lx:%lx\n",
			start, len);
	}
}

static void atp867x_check_ports(struct ata_port *ap, int port)
{
	struct ata_ioports *ioaddr = &ap->ioaddr;
	struct atp867x_priv *dp = ap->private_data;

	printk(KERN_DEBUG "ATP867X: port[%d] addresses\n"
		"  cmd_addr	=0x%llx, 0x%llx\n"
		"  ctl_addr	=0x%llx, 0x%llx\n"
		"  bmdma_addr	=0x%llx, 0x%llx\n"
		"  data_addr	=0x%llx\n"
		"  error_addr	=0x%llx\n"
		"  feature_addr	=0x%llx\n"
		"  nsect_addr	=0x%llx\n"
		"  lbal_addr	=0x%llx\n"
		"  lbam_addr	=0x%llx\n"
		"  lbah_addr	=0x%llx\n"
		"  device_addr	=0x%llx\n"
		"  status_addr	=0x%llx\n"
		"  command_addr	=0x%llx\n"
		"  dp->dma_mode	=0x%llx\n"
		"  dp->mstr_piospd	=0x%llx\n"
		"  dp->slave_piospd	=0x%llx\n"
		"  dp->eightb_piospd	=0x%llx\n"
		"  dp->pci66mhz		=0x%lx\n",
		port,
		(unsigned long long)ioaddr->cmd_addr,
		(unsigned long long)ATP867X_IO_PORTBASE(ap, port),
		(unsigned long long)ioaddr->ctl_addr,
		(unsigned long long)ATP867X_IO_ALTSTATUS(ap, port),
		(unsigned long long)ioaddr->bmdma_addr,
		(unsigned long long)ATP867X_IO_DMABASE(ap, port),
		(unsigned long long)ioaddr->data_addr,
		(unsigned long long)ioaddr->error_addr,
		(unsigned long long)ioaddr->feature_addr,
		(unsigned long long)ioaddr->nsect_addr,
		(unsigned long long)ioaddr->lbal_addr,
		(unsigned long long)ioaddr->lbam_addr,
		(unsigned long long)ioaddr->lbah_addr,
		(unsigned long long)ioaddr->device_addr,
		(unsigned long long)ioaddr->status_addr,
		(unsigned long long)ioaddr->command_addr,
		(unsigned long long)dp->dma_mode,
		(unsigned long long)dp->mstr_piospd,
		(unsigned long long)dp->slave_piospd,
		(unsigned long long)dp->eightb_piospd,
		(unsigned long)dp->pci66mhz);
}
#endif

static int atp867x_set_priv(struct ata_port *ap)
{
	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
	struct atp867x_priv *dp;
	int port = ap->port_no;

	dp = ap->private_data =
		devm_kzalloc(&pdev->dev, sizeof(*dp), GFP_KERNEL);
	if (dp == NULL)
		return -ENOMEM;

	dp->dma_mode	 = ATP867X_IO_DMAMODE(ap, port);
	dp->mstr_piospd	 = ATP867X_IO_MSTRPIOSPD(ap, port);
	dp->slave_piospd = ATP867X_IO_SLAVPIOSPD(ap, port);
	dp->eightb_piospd = ATP867X_IO_8BPIOSPD(ap, port);

	dp->pci66mhz =
		ioread8(ATP867X_SYS_INFO(ap)) & ATP867X_IO_SYS_INFO_66MHZ;

	return 0;
}

static void atp867x_fixup(struct ata_host *host)
{
	struct pci_dev *pdev = to_pci_dev(host->dev);
	struct ata_port *ap = host->ports[0];
	int i;
	u8 v;

	/*
	 * Broken BIOS might not set latency high enough
	 */
	pci_read_config_byte(pdev, PCI_LATENCY_TIMER, &v);
	if (v < 0x80) {
		v = 0x80;
		pci_write_config_byte(pdev, PCI_LATENCY_TIMER, v);
		printk(KERN_DEBUG "ATP867X: set latency timer of device %s"
			" to %d\n", pci_name(pdev), v);
	}

	/*
	 * init 8bit io ports speed(0aaarrrr) to 43h and
	 * init udma modes of master/slave to 0/0(11h)
	 */
	for (i = 0; i < ATP867X_NUM_PORTS; i++)
		iowrite16(ATP867X_IO_PORTSPD_VAL, ATP867X_IO_PORTSPD(ap, i));

	/*
	 * init PreREAD counts
	 */
	for (i = 0; i < ATP867X_NUM_PORTS; i++)
		iowrite16(ATP867X_PREREAD_VAL, ATP867X_IO_PREREAD(ap, i));

	v = ioread8(ATP867X_IOBASE(ap) + 0x28);
	v &= 0xcf;	/* Enable INTA#: bit4=0 means enable */
	v |= 0xc0;	/* Enable PCI burst, MRM & not immediate interrupts */
	iowrite8(v, ATP867X_IOBASE(ap) + 0x28);

	/*
	 * Turn off the over clocked udma5 mode, only for Rev-B
	 */
	v = ioread8(ATP867X_SYS_INFO(ap));
	v &= ATP867X_IO_SYS_MASK_RESERVED;
	if (pdev->device == PCI_DEVICE_ID_ARTOP_ATP867B)
		v |= ATP867X_IO_SYS_INFO_SLOW_UDMA5;
	iowrite8(v, ATP867X_SYS_INFO(ap));
}

static int atp867x_ata_pci_sff_init_host(struct ata_host *host)
{
	struct device *gdev = host->dev;
	struct pci_dev *pdev = to_pci_dev(gdev);
	unsigned int mask = 0;
	int i, rc;

	/*
	 * do not map rombase
	 */
	rc = pcim_iomap_regions(pdev, 1 << ATP867X_BAR_IOBASE, DRV_NAME);
	if (rc == -EBUSY)
		pcim_pin_device(pdev);
	if (rc)
		return rc;
	host->iomap = pcim_iomap_table(pdev);

#ifdef	ATP867X_DEBUG
	atp867x_check_res(pdev);

	for (i = 0; i < PCI_ROM_RESOURCE; i++)
		printk(KERN_DEBUG "ATP867X: iomap[%d]=0x%llx\n", i,
			(unsigned long long)(host->iomap[i]));
#endif

	/*
	 * request, iomap BARs and init port addresses accordingly
	 */
	for (i = 0; i < host->n_ports; i++) {
		struct ata_port *ap = host->ports[i];
		struct ata_ioports *ioaddr = &ap->ioaddr;

		ioaddr->cmd_addr = ATP867X_IO_PORTBASE(ap, i);
		ioaddr->ctl_addr = ioaddr->altstatus_addr
				 = ATP867X_IO_ALTSTATUS(ap, i);
		ioaddr->bmdma_addr = ATP867X_IO_DMABASE(ap, i);

		ata_sff_std_ports(ioaddr);
		rc = atp867x_set_priv(ap);
		if (rc)
			return rc;

#ifdef	ATP867X_DEBUG
		atp867x_check_ports(ap, i);
#endif
		ata_port_desc(ap, "cmd 0x%lx ctl 0x%lx",
			(unsigned long)ioaddr->cmd_addr,
			(unsigned long)ioaddr->ctl_addr);
		ata_port_desc(ap, "bmdma 0x%lx",
			(unsigned long)ioaddr->bmdma_addr);

		mask |= 1 << i;
	}

	if (!mask) {
		dev_err(gdev, "no available native port\n");
		return -ENODEV;
	}

	atp867x_fixup(host);

	rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
	if (rc)
		return rc;

	rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
	return rc;
}

static int atp867x_init_one(struct pci_dev *pdev,
	const struct pci_device_id *id)
{
	static const struct ata_port_info info_867x = {
		.flags		= ATA_FLAG_SLAVE_POSS,
		.pio_mask	= ATA_PIO4,
		.udma_mask 	= ATA_UDMA6,
		.port_ops	= &atp867x_ops,
	};

	struct ata_host *host;
	const struct ata_port_info *ppi[] = { &info_867x, NULL };
	int rc;

	ata_print_version_once(&pdev->dev, DRV_VERSION);

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

	printk(KERN_INFO "ATP867X: ATP867 ATA UDMA133 controller (rev %02X)",
		pdev->device);

	host = ata_host_alloc_pinfo(&pdev->dev, ppi, ATP867X_NUM_PORTS);
	if (!host) {
		dev_err(&pdev->dev, "failed to allocate ATA host\n");
		rc = -ENOMEM;
		goto err_out;
	}

	rc = atp867x_ata_pci_sff_init_host(host);
	if (rc) {
		dev_err(&pdev->dev, "failed to init host\n");
		goto err_out;
	}

	pci_set_master(pdev);

	rc = ata_host_activate(host, pdev->irq, ata_bmdma_interrupt,
				IRQF_SHARED, &atp867x_sht);
	if (rc)
		dev_err(&pdev->dev, "failed to activate host\n");

err_out:
	return rc;
}

#ifdef CONFIG_PM_SLEEP
static int atp867x_reinit_one(struct pci_dev *pdev)
{
	struct ata_host *host = pci_get_drvdata(pdev);
	int rc;

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

	atp867x_fixup(host);

	ata_host_resume(host);
	return 0;
}
#endif

static struct pci_device_id atp867x_pci_tbl[] = {
	{ PCI_VDEVICE(ARTOP, PCI_DEVICE_ID_ARTOP_ATP867A),	0 },
	{ PCI_VDEVICE(ARTOP, PCI_DEVICE_ID_ARTOP_ATP867B),	0 },
	{ },
};

static struct pci_driver atp867x_driver = {
	.name 		= DRV_NAME,
	.id_table 	= atp867x_pci_tbl,
	.probe 		= atp867x_init_one,
	.remove		= ata_pci_remove_one,
#ifdef CONFIG_PM_SLEEP
	.suspend	= ata_pci_device_suspend,
	.resume		= atp867x_reinit_one,
#endif
};

module_pci_driver(atp867x_driver);

MODULE_AUTHOR("John(Jung-Ik) Lee, Google Inc.");
MODULE_DESCRIPTION("low level driver for Artop/Acard 867x ATA controller");
MODULE_LICENSE("GPL");
MODULE_DEVICE_TABLE(pci, atp867x_pci_tbl);
MODULE_VERSION(DRV_VERSION);
Commit	Line	Data
d15d6e6c JJIL	1	/*
	2	* pata_atp867x.c - ARTOP 867X 64bit 4-channel UDMA133 ATA controller driver
	3	*
	4	* (C) 2009 Google Inc. John(Jung-Ik) Lee <jilee@google.com>
	5	*
	6	* Per Atp867 data sheet rev 1.2, Acard.
	7	* Based in part on early ide code from
	8	* 2003-2004 by Eric Uhrhane, Google, Inc.
	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
	12	* the Free Software Foundation; either version 2 of the License, or
	13	* (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software
	22	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	23	*
	24	*
	25	* TODO:
	26	* 1. RAID features [comparison, XOR, striping, mirroring, etc.]
	27	*/
	28
	29	#include <linux/kernel.h>
	30	#include <linux/module.h>
	31	#include <linux/pci.h>
d15d6e6c JJIL	32	#include <linux/blkdev.h>
	33	#include <linux/delay.h>
	34	#include <linux/device.h>
5a0e3ad6	35	#include <linux/gfp.h>
d15d6e6c JJIL	36	#include <scsi/scsi_host.h>
	37	#include <linux/libata.h>
	38
	39	#define DRV_NAME "pata_atp867x"
	40	#define DRV_VERSION "0.7.5"
	41
	42	/*
	43	* IO Registers
	44	* Note that all runtime hot priv ports are cached in ap private_data
	45	*/
	46
	47	enum {
	48	ATP867X_IO_CHANNEL_OFFSET = 0x10,
	49
	50	/*
	51	* IO Register Bitfields
	52	*/
	53
	54	ATP867X_IO_PIOSPD_ACTIVE_SHIFT = 4,
	55	ATP867X_IO_PIOSPD_RECOVER_SHIFT = 0,
	56
	57	ATP867X_IO_DMAMODE_MSTR_SHIFT = 0,
	58	ATP867X_IO_DMAMODE_MSTR_MASK = 0x07,
	59	ATP867X_IO_DMAMODE_SLAVE_SHIFT = 4,
	60	ATP867X_IO_DMAMODE_SLAVE_MASK = 0x70,
	61
	62	ATP867X_IO_DMAMODE_UDMA_6 = 0x07,
	63	ATP867X_IO_DMAMODE_UDMA_5 = 0x06,
	64	ATP867X_IO_DMAMODE_UDMA_4 = 0x05,
	65	ATP867X_IO_DMAMODE_UDMA_3 = 0x04,
	66	ATP867X_IO_DMAMODE_UDMA_2 = 0x03,
	67	ATP867X_IO_DMAMODE_UDMA_1 = 0x02,
	68	ATP867X_IO_DMAMODE_UDMA_0 = 0x01,
	69	ATP867X_IO_DMAMODE_DISABLE = 0x00,
	70
	71	ATP867X_IO_SYS_INFO_66MHZ = 0x04,
	72	ATP867X_IO_SYS_INFO_SLOW_UDMA5 = 0x02,
	73	ATP867X_IO_SYS_MASK_RESERVED = (~0xf1),
	74
	75	ATP867X_IO_PORTSPD_VAL = 0x1143,
	76	ATP867X_PREREAD_VAL = 0x0200,
	77
	78	ATP867X_NUM_PORTS = 4,
	79	ATP867X_BAR_IOBASE = 0,
	80	ATP867X_BAR_ROMBASE = 6,
	81	};
	82
	83	#define ATP867X_IOBASE(ap) ((ap)->host->iomap[0])
	84	#define ATP867X_SYS_INFO(ap) (0x3F + ATP867X_IOBASE(ap))
	85
	86	#define ATP867X_IO_PORTBASE(ap, port) (0x00 + ATP867X_IOBASE(ap) + \
	87	(port) * ATP867X_IO_CHANNEL_OFFSET)
	88	#define ATP867X_IO_DMABASE(ap, port) (0x40 + \
	89	ATP867X_IO_PORTBASE((ap), (port)))
	90
	91	#define ATP867X_IO_STATUS(ap, port) (0x07 + \
	92	ATP867X_IO_PORTBASE((ap), (port)))
	93	#define ATP867X_IO_ALTSTATUS(ap, port) (0x0E + \
	94	ATP867X_IO_PORTBASE((ap), (port)))
	95
	96	/*
	97	* hot priv ports
	98	*/
	99	#define ATP867X_IO_MSTRPIOSPD(ap, port) (0x08 + \
100	ATP867X_IO_DMABASE((ap), (port)))
101	#define ATP867X_IO_SLAVPIOSPD(ap, port) (0x09 + \
102	ATP867X_IO_DMABASE((ap), (port)))
103	#define ATP867X_IO_8BPIOSPD(ap, port) (0x0A + \
104	ATP867X_IO_DMABASE((ap), (port)))
105	#define ATP867X_IO_DMAMODE(ap, port) (0x0B + \
106	ATP867X_IO_DMABASE((ap), (port)))
107
108	#define ATP867X_IO_PORTSPD(ap, port) (0x4A + \
109	ATP867X_IO_PORTBASE((ap), (port)))
110	#define ATP867X_IO_PREREAD(ap, port) (0x4C + \
111	ATP867X_IO_PORTBASE((ap), (port)))
112
113	struct atp867x_priv {
114	void __iomem *dma_mode;
115	void __iomem *mstr_piospd;
116	void __iomem *slave_piospd;
117	void __iomem *eightb_piospd;
118	int pci66mhz;
119	};
120
d15d6e6c JJIL	121	static void atp867x_set_dmamode(struct ata_port ap, struct ata_device adev)
	122	{
	123	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
	124	struct atp867x_priv *dp = ap->private_data;
	125	u8 speed = adev->dma_mode;
	126	u8 b;
566b54c8	127	u8 mode = speed - XFER_UDMA_0 + 1;
d15d6e6c JJIL	128
	129	/*
	130	* Doc 6.6.9: decrease the udma mode value by 1 for safer UDMA speed
	131	* on 66MHz bus
	132	* rev-A: UDMA_1~4 (5, 6 no change)
	133	* rev-B: all UDMA modes
	134	* UDMA_0 stays not to disable UDMA
	135	*/
	136	if (dp->pci66mhz && mode > ATP867X_IO_DMAMODE_UDMA_0 &&
	137	(pdev->device == PCI_DEVICE_ID_ARTOP_ATP867B \|\|
	138	mode < ATP867X_IO_DMAMODE_UDMA_5))
	139	mode--;
	140
	141	b = ioread8(dp->dma_mode);
	142	if (adev->devno & 1) {
	143	b = (b & ~ATP867X_IO_DMAMODE_SLAVE_MASK) \|
	144	(mode << ATP867X_IO_DMAMODE_SLAVE_SHIFT);
	145	} else {
	146	b = (b & ~ATP867X_IO_DMAMODE_MSTR_MASK) \|
	147	(mode << ATP867X_IO_DMAMODE_MSTR_SHIFT);
	148	}
	149	iowrite8(b, dp->dma_mode);
	150	}
	151
64207f59 JJIL	152	static int atp867x_get_active_clocks_shifted(struct ata_port *ap,
64207f59 JJIL	153	unsigned int clk)
d15d6e6c	154	{
64207f59	155	struct atp867x_priv *dp = ap->private_data;
d15d6e6c JJIL	156	unsigned char clocks = clk;
d15d6e6c JJIL	157
c59bcc37 BZ	158	/*
	159	* Doc 6.6.9: increase the clock value by 1 for safer PIO speed
	160	* on 66MHz bus
	161	*/
	162	if (dp->pci66mhz)
	163	clocks++;
	164
d15d6e6c JJIL	165	switch (clocks) {
	166	case 0:
	167	clocks = 1;
	168	break;
c59bcc37	169	case 1 ... 6:
d15d6e6c JJIL	170	break;
	171	default:
	172	printk(KERN_WARNING "ATP867X: active %dclk is invalid. "
c59bcc37 BZ	173	"Using 12clk.\n", clk);
	174	case 9 ... 12:
	175	clocks = 7; /* 12 clk */
	176	break;
	177	case 7:
64207f59 JJIL	178	case 8: /* default 8 clk */
	179	clocks = 0;
	180	goto active_clock_shift_done;
d15d6e6c	181	}
64207f59	182
64207f59	183	active_clock_shift_done:
d15d6e6c JJIL	184	return clocks << ATP867X_IO_PIOSPD_ACTIVE_SHIFT;
	185	}
	186
	187	static int atp867x_get_recover_clocks_shifted(unsigned int clk)
	188	{
	189	unsigned char clocks = clk;
	190
	191	switch (clocks) {
	192	case 0:
	193	clocks = 1;
	194	break;
	195	case 1 ... 11:
	196	break;
c59bcc37 BZ	197	case 13:
c59bcc37 BZ	198	case 14:
64207f59	199	--clocks; /* by the spec */
d15d6e6c JJIL	200	break;
	201	case 15:
	202	break;
	203	default:
	204	printk(KERN_WARNING "ATP867X: recover %dclk is invalid. "
64207f59 JJIL	205	"Using default 12clk.\n", clk);
	206	case 12: /* default 12 clk */
	207	clocks = 0;
d15d6e6c JJIL	208	break;
d15d6e6c JJIL	209	}
64207f59	210
d15d6e6c JJIL	211	return clocks << ATP867X_IO_PIOSPD_RECOVER_SHIFT;
	212	}
	213
	214	static void atp867x_set_piomode(struct ata_port ap, struct ata_device adev)
	215	{
	216	struct ata_device *peer = ata_dev_pair(adev);
	217	struct atp867x_priv *dp = ap->private_data;
	218	u8 speed = adev->pio_mode;
	219	struct ata_timing t, p;
	220	int T, UT;
	221	u8 b;
	222
	223	T = 1000000000 / 33333;
	224	UT = T / 4;
	225
	226	ata_timing_compute(adev, speed, &t, T, UT);
	227	if (peer && peer->pio_mode) {
	228	ata_timing_compute(peer, peer->pio_mode, &p, T, UT);
	229	ata_timing_merge(&p, &t, &t, ATA_TIMING_8BIT);
	230	}
	231
	232	b = ioread8(dp->dma_mode);
	233	if (adev->devno & 1)
	234	b = (b & ~ATP867X_IO_DMAMODE_SLAVE_MASK);
	235	else
	236	b = (b & ~ATP867X_IO_DMAMODE_MSTR_MASK);
	237	iowrite8(b, dp->dma_mode);
	238
64207f59	239	b = atp867x_get_active_clocks_shifted(ap, t.active) \|
c59bcc37	240	atp867x_get_recover_clocks_shifted(t.recover);
d15d6e6c JJIL	241
	242	if (adev->devno & 1)
	243	iowrite8(b, dp->slave_piospd);
	244	else
	245	iowrite8(b, dp->mstr_piospd);
	246
c59bcc37 BZ	247	b = atp867x_get_active_clocks_shifted(ap, t.act8b) \|
	248	atp867x_get_recover_clocks_shifted(t.rec8b);
	249
d15d6e6c JJIL	250	iowrite8(b, dp->eightb_piospd);
	251	}
	252
64207f59 JJIL	253	static int atp867x_cable_override(struct pci_dev *pdev)
	254	{
	255	if (pdev->subsystem_vendor == PCI_VENDOR_ID_ARTOP &&
	256	(pdev->subsystem_device == PCI_DEVICE_ID_ARTOP_ATP867A \|\|
	257	pdev->subsystem_device == PCI_DEVICE_ID_ARTOP_ATP867B)) {
	258	return 1;
	259	}
	260	return 0;
	261	}
	262
d15d6e6c JJIL	263	static int atp867x_cable_detect(struct ata_port *ap)
d15d6e6c JJIL	264	{
64207f59 JJIL	265	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
	266
	267	if (atp867x_cable_override(pdev))
	268	return ATA_CBL_PATA40_SHORT;
	269
	270	return ATA_CBL_PATA_UNK;
d15d6e6c JJIL	271	}
	272
	273	static struct scsi_host_template atp867x_sht = {
	274	ATA_BMDMA_SHT(DRV_NAME),
	275	};
	276
	277	static struct ata_port_operations atp867x_ops = {
	278	.inherits = &ata_bmdma_port_ops,
	279	.cable_detect = atp867x_cable_detect,
	280	.set_piomode = atp867x_set_piomode,
	281	.set_dmamode = atp867x_set_dmamode,
	282	};
	283
	284
	285	#ifdef ATP867X_DEBUG
	286	static void atp867x_check_res(struct pci_dev *pdev)
	287	{
	288	int i;
	289	unsigned long start, len;
	290
	291	/* Check the PCI resources for this channel are enabled */
	292	for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
	293	start = pci_resource_start(pdev, i);
	294	len = pci_resource_len(pdev, i);
	295	printk(KERN_DEBUG "ATP867X: resource start:len=%lx:%lx\n",
	296	start, len);
	297	}
	298	}
	299
	300	static void atp867x_check_ports(struct ata_port *ap, int port)
	301	{
	302	struct ata_ioports *ioaddr = &ap->ioaddr;
	303	struct atp867x_priv *dp = ap->private_data;
	304
	305	printk(KERN_DEBUG "ATP867X: port[%d] addresses\n"
	306	" cmd_addr =0x%llx, 0x%llx\n"
	307	" ctl_addr =0x%llx, 0x%llx\n"
	308	" bmdma_addr =0x%llx, 0x%llx\n"
	309	" data_addr =0x%llx\n"
	310	" error_addr =0x%llx\n"
	311	" feature_addr =0x%llx\n"
	312	" nsect_addr =0x%llx\n"
	313	" lbal_addr =0x%llx\n"
	314	" lbam_addr =0x%llx\n"
	315	" lbah_addr =0x%llx\n"
	316	" device_addr =0x%llx\n"
	317	" status_addr =0x%llx\n"
	318	" command_addr =0x%llx\n"
	319	" dp->dma_mode =0x%llx\n"
	320	" dp->mstr_piospd =0x%llx\n"
	321	" dp->slave_piospd =0x%llx\n"
	322	" dp->eightb_piospd =0x%llx\n"
	323	" dp->pci66mhz =0x%lx\n",
	324	port,
	325	(unsigned long long)ioaddr->cmd_addr,
	326	(unsigned long long)ATP867X_IO_PORTBASE(ap, port),
	327	(unsigned long long)ioaddr->ctl_addr,
	328	(unsigned long long)ATP867X_IO_ALTSTATUS(ap, port),
	329	(unsigned long long)ioaddr->bmdma_addr,
	330	(unsigned long long)ATP867X_IO_DMABASE(ap, port),
	331	(unsigned long long)ioaddr->data_addr,
	332	(unsigned long long)ioaddr->error_addr,
	333	(unsigned long long)ioaddr->feature_addr,
	334	(unsigned long long)ioaddr->nsect_addr,
335	(unsigned long long)ioaddr->lbal_addr,
336	(unsigned long long)ioaddr->lbam_addr,
337	(unsigned long long)ioaddr->lbah_addr,
338	(unsigned long long)ioaddr->device_addr,
339	(unsigned long long)ioaddr->status_addr,
340	(unsigned long long)ioaddr->command_addr,
341	(unsigned long long)dp->dma_mode,
342	(unsigned long long)dp->mstr_piospd,
343	(unsigned long long)dp->slave_piospd,
344	(unsigned long long)dp->eightb_piospd,
345	(unsigned long)dp->pci66mhz);
346	}
347	#endif
348
349	static int atp867x_set_priv(struct ata_port *ap)
350	{
351	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
352	struct atp867x_priv *dp;
353	int port = ap->port_no;
354
355	dp = ap->private_data =
356	devm_kzalloc(&pdev->dev, sizeof(*dp), GFP_KERNEL);
357	if (dp == NULL)
358	return -ENOMEM;
359
360	dp->dma_mode = ATP867X_IO_DMAMODE(ap, port);
361	dp->mstr_piospd = ATP867X_IO_MSTRPIOSPD(ap, port);
362	dp->slave_piospd = ATP867X_IO_SLAVPIOSPD(ap, port);
363	dp->eightb_piospd = ATP867X_IO_8BPIOSPD(ap, port);
364
365	dp->pci66mhz =
366	ioread8(ATP867X_SYS_INFO(ap)) & ATP867X_IO_SYS_INFO_66MHZ;
367
368	return 0;
369	}
370
371	static void atp867x_fixup(struct ata_host *host)
372	{
373	struct pci_dev *pdev = to_pci_dev(host->dev);
374	struct ata_port *ap = host->ports[0];
375	int i;
376	u8 v;
377
378	/*
379	* Broken BIOS might not set latency high enough
380	*/
381	pci_read_config_byte(pdev, PCI_LATENCY_TIMER, &v);
382	if (v < 0x80) {
383	v = 0x80;
384	pci_write_config_byte(pdev, PCI_LATENCY_TIMER, v);
385	printk(KERN_DEBUG "ATP867X: set latency timer of device %s"
386	" to %d\n", pci_name(pdev), v);
387	}
388
389	/*
390	* init 8bit io ports speed(0aaarrrr) to 43h and
391	* init udma modes of master/slave to 0/0(11h)
392	*/
393	for (i = 0; i < ATP867X_NUM_PORTS; i++)
394	iowrite16(ATP867X_IO_PORTSPD_VAL, ATP867X_IO_PORTSPD(ap, i));
395
396	/*
397	* init PreREAD counts
398	*/
399	for (i = 0; i < ATP867X_NUM_PORTS; i++)
400	iowrite16(ATP867X_PREREAD_VAL, ATP867X_IO_PREREAD(ap, i));
401
402	v = ioread8(ATP867X_IOBASE(ap) + 0x28);
403	v &= 0xcf; /* Enable INTA#: bit4=0 means enable */
404	v \|= 0xc0; /* Enable PCI burst, MRM & not immediate interrupts */
405	iowrite8(v, ATP867X_IOBASE(ap) + 0x28);
406
407	/*
408	* Turn off the over clocked udma5 mode, only for Rev-B
409	*/
410	v = ioread8(ATP867X_SYS_INFO(ap));
411	v &= ATP867X_IO_SYS_MASK_RESERVED;
412	if (pdev->device == PCI_DEVICE_ID_ARTOP_ATP867B)
413	v \|= ATP867X_IO_SYS_INFO_SLOW_UDMA5;
414	iowrite8(v, ATP867X_SYS_INFO(ap));
415	}
416
417	static int atp867x_ata_pci_sff_init_host(struct ata_host *host)
418	{
419	struct device *gdev = host->dev;
420	struct pci_dev *pdev = to_pci_dev(gdev);
421	unsigned int mask = 0;
422	int i, rc;
423
424	/*
425	* do not map rombase
426	*/
427	rc = pcim_iomap_regions(pdev, 1 << ATP867X_BAR_IOBASE, DRV_NAME);
428	if (rc == -EBUSY)
429	pcim_pin_device(pdev);
430	if (rc)
431	return rc;
432	host->iomap = pcim_iomap_table(pdev);
433
434	#ifdef ATP867X_DEBUG
435	atp867x_check_res(pdev);
436
437	for (i = 0; i < PCI_ROM_RESOURCE; i++)
438	printk(KERN_DEBUG "ATP867X: iomap[%d]=0x%llx\n", i,
439	(unsigned long long)(host->iomap[i]));
440	#endif
441
442	/*
443	* request, iomap BARs and init port addresses accordingly
444	*/
445	for (i = 0; i < host->n_ports; i++) {
446	struct ata_port *ap = host->ports[i];
447	struct ata_ioports *ioaddr = &ap->ioaddr;
448
449	ioaddr->cmd_addr = ATP867X_IO_PORTBASE(ap, i);
450	ioaddr->ctl_addr = ioaddr->altstatus_addr
451	= ATP867X_IO_ALTSTATUS(ap, i);
452	ioaddr->bmdma_addr = ATP867X_IO_DMABASE(ap, i);
453
454	ata_sff_std_ports(ioaddr);
455	rc = atp867x_set_priv(ap);
456	if (rc)
457	return rc;
458
459	#ifdef ATP867X_DEBUG
460	atp867x_check_ports(ap, i);
461	#endif
462	ata_port_desc(ap, "cmd 0x%lx ctl 0x%lx",
463	(unsigned long)ioaddr->cmd_addr,
464	(unsigned long)ioaddr->ctl_addr);
465	ata_port_desc(ap, "bmdma 0x%lx",
466	(unsigned long)ioaddr->bmdma_addr);
467
468	mask \|= 1 << i;
469	}
470
471	if (!mask) {
a44fec1f	472	dev_err(gdev, "no available native port\n");
d15d6e6c JJIL	473	return -ENODEV;
	474	}
	475
	476	atp867x_fixup(host);
	477
	478	rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
	479	if (rc)
	480	return rc;
	481
	482	rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
	483	return rc;
	484	}
	485
	486	static int atp867x_init_one(struct pci_dev *pdev,
	487	const struct pci_device_id *id)
	488	{
d15d6e6c JJIL	489	static const struct ata_port_info info_867x = {
	490	.flags = ATA_FLAG_SLAVE_POSS,
	491	.pio_mask = ATA_PIO4,
d15d6e6c JJIL	492	.udma_mask = ATA_UDMA6,
	493	.port_ops = &atp867x_ops,
	494	};
	495
	496	struct ata_host *host;
	497	const struct ata_port_info *ppi[] = { &info_867x, NULL };
	498	int rc;
	499
06296a1e	500	ata_print_version_once(&pdev->dev, DRV_VERSION);
d15d6e6c JJIL	501
	502	rc = pcim_enable_device(pdev);
	503	if (rc)
	504	return rc;
	505
	506	printk(KERN_INFO "ATP867X: ATP867 ATA UDMA133 controller (rev %02X)",
	507	pdev->device);
	508
	509	host = ata_host_alloc_pinfo(&pdev->dev, ppi, ATP867X_NUM_PORTS);
	510	if (!host) {
a44fec1f	511	dev_err(&pdev->dev, "failed to allocate ATA host\n");
d15d6e6c JJIL	512	rc = -ENOMEM;
	513	goto err_out;
	514	}
	515
	516	rc = atp867x_ata_pci_sff_init_host(host);
	517	if (rc) {
a44fec1f	518	dev_err(&pdev->dev, "failed to init host\n");
d15d6e6c JJIL	519	goto err_out;
	520	}
	521
	522	pci_set_master(pdev);
	523
c3b28894	524	rc = ata_host_activate(host, pdev->irq, ata_bmdma_interrupt,
d15d6e6c JJIL	525	IRQF_SHARED, &atp867x_sht);
d15d6e6c JJIL	526	if (rc)
a44fec1f	527	dev_err(&pdev->dev, "failed to activate host\n");
d15d6e6c JJIL	528
	529	err_out:
	530	return rc;
	531	}
	532
58eb8cd5	533	#ifdef CONFIG_PM_SLEEP
7affb32a BZ	534	static int atp867x_reinit_one(struct pci_dev *pdev)
7affb32a BZ	535	{
0a86e1c8	536	struct ata_host *host = pci_get_drvdata(pdev);
7affb32a BZ	537	int rc;
	538
	539	rc = ata_pci_device_do_resume(pdev);
	540	if (rc)
	541	return rc;
	542
	543	atp867x_fixup(host);
	544
	545	ata_host_resume(host);
	546	return 0;
	547	}
	548	#endif
	549
d15d6e6c JJIL	550	static struct pci_device_id atp867x_pci_tbl[] = {
	551	{ PCI_VDEVICE(ARTOP, PCI_DEVICE_ID_ARTOP_ATP867A), 0 },
	552	{ PCI_VDEVICE(ARTOP, PCI_DEVICE_ID_ARTOP_ATP867B), 0 },
	553	{ },
	554	};
	555
	556	static struct pci_driver atp867x_driver = {
	557	.name = DRV_NAME,
	558	.id_table = atp867x_pci_tbl,
	559	.probe = atp867x_init_one,
	560	.remove = ata_pci_remove_one,
58eb8cd5	561	#ifdef CONFIG_PM_SLEEP
7affb32a BZ	562	.suspend = ata_pci_device_suspend,
	563	.resume = atp867x_reinit_one,
	564	#endif
d15d6e6c JJIL	565	};
d15d6e6c JJIL	566
2fc75da0	567	module_pci_driver(atp867x_driver);
d15d6e6c JJIL	568
	569	MODULE_AUTHOR("John(Jung-Ik) Lee, Google Inc.");
	570	MODULE_DESCRIPTION("low level driver for Artop/Acard 867x ATA controller");
	571	MODULE_LICENSE("GPL");
	572	MODULE_DEVICE_TABLE(pci, atp867x_pci_tbl);
	573	MODULE_VERSION(DRV_VERSION);