[deliverable/linux.git] / drivers / mmc / host / tmio_mmc.h

/*
 * linux/drivers/mmc/host/tmio_mmc.h
 *
 * Copyright (C) 2007 Ian Molton
 * Copyright (C) 2004 Ian Molton
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * Driver for the MMC / SD / SDIO cell found in:
 *
 * TC6393XB TC6391XB TC6387XB T7L66XB ASIC3
 */

#ifndef TMIO_MMC_H
#define TMIO_MMC_H

#include <linux/highmem.h>
#include <linux/mmc/tmio.h>
#include <linux/mutex.h>
#include <linux/pagemap.h>
#include <linux/spinlock.h>
#include <linux/scatterlist.h>

/* Definitions for values the CTRL_SDIO_STATUS register can take. */
#define TMIO_SDIO_STAT_IOIRQ	0x0001
#define TMIO_SDIO_STAT_EXPUB52	0x4000
#define TMIO_SDIO_STAT_EXWT	0x8000
#define TMIO_SDIO_MASK_ALL	0xc007

/* Define some IRQ masks */
/* This is the mask used at reset by the chip */
#define TMIO_MASK_ALL           0x837f031d
#define TMIO_MASK_READOP  (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND)
#define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND)
#define TMIO_MASK_CMD     (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \
		TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT)
#define TMIO_MASK_IRQ     (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD)

struct tmio_mmc_data;

struct tmio_mmc_host {
	void __iomem *ctl;
	unsigned long bus_shift;
	struct mmc_command      *cmd;
	struct mmc_request      *mrq;
	struct mmc_data         *data;
	struct mmc_host         *mmc;
	unsigned int		sdio_irq_enabled;

	/* Callbacks for clock / power control */
	void (*set_pwr)(struct platform_device *host, int state);
	void (*set_clk_div)(struct platform_device *host, int state);

	int			pm_error;
	/* recognise system-wide suspend in runtime PM methods */
	bool			pm_global;

	/* pio related stuff */
	struct scatterlist      *sg_ptr;
	struct scatterlist      *sg_orig;
	unsigned int            sg_len;
	unsigned int            sg_off;

	struct platform_device *pdev;
	struct tmio_mmc_data *pdata;

	/* DMA support */
	bool			force_pio;
	struct dma_chan		*chan_rx;
	struct dma_chan		*chan_tx;
	struct tasklet_struct	dma_complete;
	struct tasklet_struct	dma_issue;
	struct scatterlist	bounce_sg;
	u8			*bounce_buf;

	/* Track lost interrupts */
	struct delayed_work	delayed_reset_work;
	struct work_struct	done;

	/* Cache IRQ mask */
	u32			sdcard_irq_mask;
	u32			sdio_irq_mask;

	spinlock_t		lock;		/* protect host private data */
	unsigned long		last_req_ts;
	struct mutex		ios_lock;	/* protect set_ios() context */
};

int tmio_mmc_host_probe(struct tmio_mmc_host **host,
			struct platform_device *pdev,
			struct tmio_mmc_data *pdata);
void tmio_mmc_host_remove(struct tmio_mmc_host *host);
void tmio_mmc_do_data_irq(struct tmio_mmc_host *host);

void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
irqreturn_t tmio_mmc_irq(int irq, void *devid);
irqreturn_t tmio_mmc_sdcard_irq(int irq, void *devid);
irqreturn_t tmio_mmc_card_detect_irq(int irq, void *devid);
irqreturn_t tmio_mmc_sdio_irq(int irq, void *devid);

static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg,
					 unsigned long *flags)
{
	local_irq_save(*flags);
	return kmap_atomic(sg_page(sg), KM_BIO_SRC_IRQ) + sg->offset;
}

static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg,
					  unsigned long *flags, void *virt)
{
	kunmap_atomic(virt - sg->offset, KM_BIO_SRC_IRQ);
	local_irq_restore(*flags);
}

#if defined(CONFIG_MMC_SDHI) || defined(CONFIG_MMC_SDHI_MODULE)
void tmio_mmc_start_dma(struct tmio_mmc_host *host, struct mmc_data *data);
void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable);
void tmio_mmc_request_dma(struct tmio_mmc_host *host, struct tmio_mmc_data *pdata);
void tmio_mmc_release_dma(struct tmio_mmc_host *host);
#else
static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host,
			       struct mmc_data *data)
{
}

static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable)
{
}

static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host,
				 struct tmio_mmc_data *pdata)
{
	host->chan_tx = NULL;
	host->chan_rx = NULL;
}

static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host)
{
}
#endif

#ifdef CONFIG_PM
int tmio_mmc_host_suspend(struct device *dev);
int tmio_mmc_host_resume(struct device *dev);
#else
#define tmio_mmc_host_suspend NULL
#define tmio_mmc_host_resume NULL
#endif

int tmio_mmc_host_runtime_suspend(struct device *dev);
int tmio_mmc_host_runtime_resume(struct device *dev);

static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr)
{
	return readw(host->ctl + (addr << host->bus_shift));
}

static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr,
		u16 *buf, int count)
{
	readsw(host->ctl + (addr << host->bus_shift), buf, count);
}

static inline u32 sd_ctrl_read32(struct tmio_mmc_host *host, int addr)
{
	return readw(host->ctl + (addr << host->bus_shift)) |
	       readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16;
}

static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val)
{
	/* If there is a hook and it returns non-zero then there
	 * is an error and the write should be skipped
	 */
	if (host->pdata->write16_hook && host->pdata->write16_hook(host, addr))
		return;
	writew(val, host->ctl + (addr << host->bus_shift));
}

static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr,
		u16 *buf, int count)
{
	writesw(host->ctl + (addr << host->bus_shift), buf, count);
}

static inline void sd_ctrl_write32(struct tmio_mmc_host *host, int addr, u32 val)
{
	writew(val, host->ctl + (addr << host->bus_shift));
	writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift));
}


#endif
Commit	Line	Data
b6147490 GL	1	/*
	2	* linux/drivers/mmc/host/tmio_mmc.h
	3	*
	4	* Copyright (C) 2007 Ian Molton
	5	* Copyright (C) 2004 Ian Molton
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License version 2 as
	9	* published by the Free Software Foundation.
	10	*
	11	* Driver for the MMC / SD / SDIO cell found in:
	12	*
	13	* TC6393XB TC6391XB TC6387XB T7L66XB ASIC3
	14	*/
	15
	16	#ifndef TMIO_MMC_H
	17	#define TMIO_MMC_H
	18
	19	#include <linux/highmem.h>
cba179ae	20	#include <linux/mmc/tmio.h>
b9269fdd	21	#include <linux/mutex.h>
b6147490	22	#include <linux/pagemap.h>
df3ef2d3	23	#include <linux/spinlock.h>
6c0cbef6	24	#include <linux/scatterlist.h>
b6147490	25
b6147490	26	/* Definitions for values the CTRL_SDIO_STATUS register can take. */
cba179ae	27	#define TMIO_SDIO_STAT_IOIRQ 0x0001
b6147490	28	#define TMIO_SDIO_STAT_EXPUB52 0x4000
cba179ae SH	29	#define TMIO_SDIO_STAT_EXWT 0x8000
cba179ae SH	30	#define TMIO_SDIO_MASK_ALL 0xc007
b6147490 GL	31
	32	/* Define some IRQ masks */
	33	/* This is the mask used at reset by the chip */
	34	#define TMIO_MASK_ALL 0x837f031d
	35	#define TMIO_MASK_READOP (TMIO_STAT_RXRDY \| TMIO_STAT_DATAEND)
	36	#define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ \| TMIO_STAT_DATAEND)
	37	#define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND \| TMIO_STAT_CMDTIMEOUT \| \
	38	TMIO_STAT_CARD_REMOVE \| TMIO_STAT_CARD_INSERT)
	39	#define TMIO_MASK_IRQ (TMIO_MASK_READOP \| TMIO_MASK_WRITEOP \| TMIO_MASK_CMD)
	40
	41	struct tmio_mmc_data;
	42
	43	struct tmio_mmc_host {
	44	void __iomem *ctl;
	45	unsigned long bus_shift;
	46	struct mmc_command *cmd;
	47	struct mmc_request *mrq;
	48	struct mmc_data *data;
	49	struct mmc_host *mmc;
b6147490 GL	50	unsigned int sdio_irq_enabled;
	51
	52	/* Callbacks for clock / power control */
	53	void (set_pwr)(struct platform_device host, int state);
	54	void (set_clk_div)(struct platform_device host, int state);
	55
e6ee7182	56	int pm_error;
71d111cd GL	57	/* recognise system-wide suspend in runtime PM methods */
71d111cd GL	58	bool pm_global;
e6ee7182	59
b6147490 GL	60	/* pio related stuff */
	61	struct scatterlist *sg_ptr;
	62	struct scatterlist *sg_orig;
	63	unsigned int sg_len;
	64	unsigned int sg_off;
	65
	66	struct platform_device *pdev;
	67	struct tmio_mmc_data *pdata;
	68
	69	/* DMA support */
	70	bool force_pio;
	71	struct dma_chan *chan_rx;
	72	struct dma_chan *chan_tx;
	73	struct tasklet_struct dma_complete;
	74	struct tasklet_struct dma_issue;
	75	struct scatterlist bounce_sg;
	76	u8 *bounce_buf;
	77
	78	/* Track lost interrupts */
	79	struct delayed_work delayed_reset_work;
b9269fdd GL	80	struct work_struct done;
b9269fdd GL	81
54680fe7 SH	82	/* Cache IRQ mask */
	83	u32 sdcard_irq_mask;
	84	u32 sdio_irq_mask;
	85
b9269fdd	86	spinlock_t lock; /* protect host private data */
b6147490	87	unsigned long last_req_ts;
b9269fdd	88	struct mutex ios_lock; /* protect set_ios() context */
b6147490 GL	89	};
	90
	91	int tmio_mmc_host_probe(struct tmio_mmc_host **host,
	92	struct platform_device *pdev,
	93	struct tmio_mmc_data *pdata);
	94	void tmio_mmc_host_remove(struct tmio_mmc_host *host);
	95	void tmio_mmc_do_data_irq(struct tmio_mmc_host *host);
	96
	97	void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
	98	void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
8e7bfdb3	99	irqreturn_t tmio_mmc_irq(int irq, void *devid);
7729c7a2 SH	100	irqreturn_t tmio_mmc_sdcard_irq(int irq, void *devid);
	101	irqreturn_t tmio_mmc_card_detect_irq(int irq, void *devid);
	102	irqreturn_t tmio_mmc_sdio_irq(int irq, void *devid);
b6147490 GL	103
	104	static inline char tmio_mmc_kmap_atomic(struct scatterlist sg,
	105	unsigned long *flags)
	106	{
	107	local_irq_save(*flags);
	108	return kmap_atomic(sg_page(sg), KM_BIO_SRC_IRQ) + sg->offset;
	109	}
	110
	111	static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg,
	112	unsigned long flags, void virt)
	113	{
	114	kunmap_atomic(virt - sg->offset, KM_BIO_SRC_IRQ);
	115	local_irq_restore(*flags);
	116	}
	117
42051e8a	118	#if defined(CONFIG_MMC_SDHI) \|\| defined(CONFIG_MMC_SDHI_MODULE)
b6147490	119	void tmio_mmc_start_dma(struct tmio_mmc_host host, struct mmc_data data);
162f43e3	120	void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable);
b6147490 GL	121	void tmio_mmc_request_dma(struct tmio_mmc_host host, struct tmio_mmc_data pdata);
	122	void tmio_mmc_release_dma(struct tmio_mmc_host *host);
	123	#else
	124	static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host,
	125	struct mmc_data *data)
	126	{
	127	}
	128
162f43e3 GL	129	static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable)
	130	{
	131	}
	132
b6147490 GL	133	static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host,
	134	struct tmio_mmc_data *pdata)
	135	{
	136	host->chan_tx = NULL;
	137	host->chan_rx = NULL;
	138	}
	139
	140	static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host)
	141	{
	142	}
	143	#endif
	144
e6ee7182 GL	145	#ifdef CONFIG_PM
	146	int tmio_mmc_host_suspend(struct device *dev);
	147	int tmio_mmc_host_resume(struct device *dev);
	148	#else
	149	#define tmio_mmc_host_suspend NULL
	150	#define tmio_mmc_host_resume NULL
	151	#endif
	152
7311bef0 GL	153	int tmio_mmc_host_runtime_suspend(struct device *dev);
	154	int tmio_mmc_host_runtime_resume(struct device *dev);
	155
a11862d3 SH	156	static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr)
	157	{
	158	return readw(host->ctl + (addr << host->bus_shift));
	159	}
	160
	161	static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr,
	162	u16 *buf, int count)
	163	{
	164	readsw(host->ctl + (addr << host->bus_shift), buf, count);
	165	}
	166
	167	static inline u32 sd_ctrl_read32(struct tmio_mmc_host *host, int addr)
	168	{
	169	return readw(host->ctl + (addr << host->bus_shift)) \|
	170	readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16;
	171	}
	172
	173	static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val)
	174	{
973ed3af SH	175	/* If there is a hook and it returns non-zero then there
	176	* is an error and the write should be skipped
	177	*/
	178	if (host->pdata->write16_hook && host->pdata->write16_hook(host, addr))
	179	return;
a11862d3 SH	180	writew(val, host->ctl + (addr << host->bus_shift));
	181	}
	182
	183	static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr,
	184	u16 *buf, int count)
	185	{
	186	writesw(host->ctl + (addr << host->bus_shift), buf, count);
	187	}
	188
	189	static inline void sd_ctrl_write32(struct tmio_mmc_host *host, int addr, u32 val)
	190	{
	191	writew(val, host->ctl + (addr << host->bus_shift));
	192	writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift));
	193	}
	194
	195
b6147490	196	#endif