[mirror_ubuntu-zesty-kernel.git] / drivers / mmc / sdhci.h

/*
 *  linux/drivers/mmc/sdhci.h - Secure Digital Host Controller Interface driver
 *
 *  Copyright (C) 2005 Pierre Ossman, All Rights Reserved.
 *
 * 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.
 */

/*
 * PCI registers
 */

#define PCI_SLOT_INFO			0x40	/* 8 bits */
#define  PCI_SLOT_INFO_SLOTS(x)		((x >> 4) & 7)
#define  PCI_SLOT_INFO_FIRST_BAR_MASK	0x07

/*
 * Controller registers
 */

#define SDHCI_DMA_ADDRESS	0x00

#define SDHCI_BLOCK_SIZE	0x04

#define SDHCI_BLOCK_COUNT	0x06

#define SDHCI_ARGUMENT		0x08

#define SDHCI_TRANSFER_MODE	0x0C
#define  SDHCI_TRNS_DMA		0x01
#define  SDHCI_TRNS_BLK_CNT_EN	0x02
#define  SDHCI_TRNS_ACMD12	0x04
#define  SDHCI_TRNS_READ	0x10
#define  SDHCI_TRNS_MULTI	0x20

#define SDHCI_COMMAND		0x0E
#define  SDHCI_CMD_RESP_MASK	0x03
#define  SDHCI_CMD_CRC		0x08
#define  SDHCI_CMD_INDEX	0x10
#define  SDHCI_CMD_DATA		0x20

#define  SDHCI_CMD_RESP_NONE	0x00
#define  SDHCI_CMD_RESP_LONG	0x01
#define  SDHCI_CMD_RESP_SHORT	0x02
#define  SDHCI_CMD_RESP_SHORT_BUSY 0x03

#define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) | (f & 0xff))

#define SDHCI_RESPONSE		0x10

#define SDHCI_BUFFER		0x20

#define SDHCI_PRESENT_STATE	0x24
#define  SDHCI_CMD_INHIBIT	0x00000001
#define  SDHCI_DATA_INHIBIT	0x00000002
#define  SDHCI_DOING_WRITE	0x00000100
#define  SDHCI_DOING_READ	0x00000200
#define  SDHCI_SPACE_AVAILABLE	0x00000400
#define  SDHCI_DATA_AVAILABLE	0x00000800
#define  SDHCI_CARD_PRESENT	0x00010000
#define  SDHCI_WRITE_PROTECT	0x00080000

#define SDHCI_HOST_CONTROL 	0x28
#define  SDHCI_CTRL_LED		0x01
#define  SDHCI_CTRL_4BITBUS	0x02

#define SDHCI_POWER_CONTROL	0x29
#define  SDHCI_POWER_ON		0x01
#define  SDHCI_POWER_180	0x0A
#define  SDHCI_POWER_300	0x0C
#define  SDHCI_POWER_330	0x0E

#define SDHCI_BLOCK_GAP_CONTROL	0x2A

#define SDHCI_WALK_UP_CONTROL	0x2B

#define SDHCI_CLOCK_CONTROL	0x2C
#define  SDHCI_DIVIDER_SHIFT	8
#define  SDHCI_CLOCK_CARD_EN	0x0004
#define  SDHCI_CLOCK_INT_STABLE	0x0002
#define  SDHCI_CLOCK_INT_EN	0x0001

#define SDHCI_TIMEOUT_CONTROL	0x2E

#define SDHCI_SOFTWARE_RESET	0x2F
#define  SDHCI_RESET_ALL	0x01
#define  SDHCI_RESET_CMD	0x02
#define  SDHCI_RESET_DATA	0x04

#define SDHCI_INT_STATUS	0x30
#define SDHCI_INT_ENABLE	0x34
#define SDHCI_SIGNAL_ENABLE	0x38
#define  SDHCI_INT_RESPONSE	0x00000001
#define  SDHCI_INT_DATA_END	0x00000002
#define  SDHCI_INT_DMA_END	0x00000008
#define  SDHCI_INT_BUF_EMPTY	0x00000010
#define  SDHCI_INT_BUF_FULL	0x00000020
#define  SDHCI_INT_CARD_INSERT	0x00000040
#define  SDHCI_INT_CARD_REMOVE	0x00000080
#define  SDHCI_INT_CARD_INT	0x00000100
#define  SDHCI_INT_TIMEOUT	0x00010000
#define  SDHCI_INT_CRC		0x00020000
#define  SDHCI_INT_END_BIT	0x00040000
#define  SDHCI_INT_INDEX	0x00080000
#define  SDHCI_INT_DATA_TIMEOUT	0x00100000
#define  SDHCI_INT_DATA_CRC	0x00200000
#define  SDHCI_INT_DATA_END_BIT	0x00400000
#define  SDHCI_INT_BUS_POWER	0x00800000
#define  SDHCI_INT_ACMD12ERR	0x01000000

#define  SDHCI_INT_NORMAL_MASK	0x00007FFF
#define  SDHCI_INT_ERROR_MASK	0xFFFF8000

#define  SDHCI_INT_CMD_MASK	(SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \
		SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX)
#define  SDHCI_INT_DATA_MASK	(SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
		SDHCI_INT_BUF_EMPTY | SDHCI_INT_BUF_FULL | \
		SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
		SDHCI_INT_DATA_END_BIT)

#define SDHCI_ACMD12_ERR	0x3C

/* 3E-3F reserved */

#define SDHCI_CAPABILITIES	0x40
#define  SDHCI_TIMEOUT_CLK_MASK	0x0000003F
#define  SDHCI_TIMEOUT_CLK_SHIFT 0
#define  SDHCI_TIMEOUT_CLK_UNIT	0x00000080
#define  SDHCI_CLOCK_BASE_MASK	0x00003F00
#define  SDHCI_CLOCK_BASE_SHIFT	8
#define  SDHCI_CAN_DO_DMA	0x00400000
#define  SDHCI_CAN_VDD_330	0x01000000
#define  SDHCI_CAN_VDD_300	0x02000000
#define  SDHCI_CAN_VDD_180	0x04000000

/* 44-47 reserved for more caps */

#define SDHCI_MAX_CURRENT	0x48

/* 4C-4F reserved for more max current */

/* 50-FB reserved */

#define SDHCI_SLOT_INT_STATUS	0xFC

#define SDHCI_HOST_VERSION	0xFE

struct sdhci_chip;

struct sdhci_host {
	struct sdhci_chip	*chip;
	struct mmc_host		*mmc;		/* MMC structure */

	spinlock_t		lock;		/* Mutex */

	int			flags;		/* Host attributes */
#define SDHCI_USE_DMA		(1<<0)

	unsigned int		max_clk;	/* Max possible freq (MHz) */
	unsigned int		timeout_clk;	/* Timeout freq (KHz) */

	unsigned int		clock;		/* Current clock (MHz) */
	unsigned short		power;		/* Current voltage */

	struct mmc_request	*mrq;		/* Current request */
	struct mmc_command	*cmd;		/* Current command */
	struct mmc_data		*data;		/* Current data request */

	struct scatterlist	*cur_sg;	/* We're working on this */
	char			*mapped_sg;	/* This is where it's mapped */
	int			num_sg;		/* Entries left */
	int			offset;		/* Offset into current sg */
	int			remain;		/* Bytes left in current */

	int			size;		/* Remaining bytes in transfer */

	char			slot_descr[20];	/* Name for reservations */

	int			irq;		/* Device IRQ */
	int			bar;		/* PCI BAR index */
	unsigned long		addr;		/* Bus address */
	void __iomem *		ioaddr;		/* Mapped address */

	struct tasklet_struct	card_tasklet;	/* Tasklet structures */
	struct tasklet_struct	finish_tasklet;

	struct timer_list	timer;		/* Timer for timeouts */
};

struct sdhci_chip {
	struct pci_dev		*pdev;

	int			num_slots;	/* Slots on controller */
	struct sdhci_host	*hosts[0];	/* Pointers to hosts */
};
Commit	Line	Data
d129bceb PO	1	/*
	2	* linux/drivers/mmc/sdhci.h - Secure Digital Host Controller Interface driver
	3	*
	4	* Copyright (C) 2005 Pierre Ossman, All Rights Reserved.
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2 as
	8	* published by the Free Software Foundation.
	9	*/
	10
	11	/*
	12	* PCI registers
	13	*/
	14
	15	#define PCI_SLOT_INFO 0x40 /* 8 bits */
	16	#define PCI_SLOT_INFO_SLOTS(x) ((x >> 4) & 7)
	17	#define PCI_SLOT_INFO_FIRST_BAR_MASK 0x07
	18
	19	/*
	20	* Controller registers
	21	*/
	22
	23	#define SDHCI_DMA_ADDRESS 0x00
	24
	25	#define SDHCI_BLOCK_SIZE 0x04
	26
	27	#define SDHCI_BLOCK_COUNT 0x06
	28
	29	#define SDHCI_ARGUMENT 0x08
	30
	31	#define SDHCI_TRANSFER_MODE 0x0C
	32	#define SDHCI_TRNS_DMA 0x01
	33	#define SDHCI_TRNS_BLK_CNT_EN 0x02
	34	#define SDHCI_TRNS_ACMD12 0x04
	35	#define SDHCI_TRNS_READ 0x10
	36	#define SDHCI_TRNS_MULTI 0x20
	37
	38	#define SDHCI_COMMAND 0x0E
	39	#define SDHCI_CMD_RESP_MASK 0x03
	40	#define SDHCI_CMD_CRC 0x08
	41	#define SDHCI_CMD_INDEX 0x10
	42	#define SDHCI_CMD_DATA 0x20
	43
	44	#define SDHCI_CMD_RESP_NONE 0x00
	45	#define SDHCI_CMD_RESP_LONG 0x01
	46	#define SDHCI_CMD_RESP_SHORT 0x02
	47	#define SDHCI_CMD_RESP_SHORT_BUSY 0x03
	48
	49	#define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) \| (f & 0xff))
	50
	51	#define SDHCI_RESPONSE 0x10
	52
	53	#define SDHCI_BUFFER 0x20
	54
	55	#define SDHCI_PRESENT_STATE 0x24
	56	#define SDHCI_CMD_INHIBIT 0x00000001
	57	#define SDHCI_DATA_INHIBIT 0x00000002
	58	#define SDHCI_DOING_WRITE 0x00000100
	59	#define SDHCI_DOING_READ 0x00000200
	60	#define SDHCI_SPACE_AVAILABLE 0x00000400
	61	#define SDHCI_DATA_AVAILABLE 0x00000800
	62	#define SDHCI_CARD_PRESENT 0x00010000
	63	#define SDHCI_WRITE_PROTECT 0x00080000
	64
65	#define SDHCI_HOST_CONTROL 0x28
66	#define SDHCI_CTRL_LED 0x01
67	#define SDHCI_CTRL_4BITBUS 0x02
68
69	#define SDHCI_POWER_CONTROL 0x29
146ad66e PO	70	#define SDHCI_POWER_ON 0x01
	71	#define SDHCI_POWER_180 0x0A
	72	#define SDHCI_POWER_300 0x0C
	73	#define SDHCI_POWER_330 0x0E
d129bceb PO	74
	75	#define SDHCI_BLOCK_GAP_CONTROL 0x2A
	76
	77	#define SDHCI_WALK_UP_CONTROL 0x2B
	78
	79	#define SDHCI_CLOCK_CONTROL 0x2C
	80	#define SDHCI_DIVIDER_SHIFT 8
	81	#define SDHCI_CLOCK_CARD_EN 0x0004
	82	#define SDHCI_CLOCK_INT_STABLE 0x0002
	83	#define SDHCI_CLOCK_INT_EN 0x0001
	84
	85	#define SDHCI_TIMEOUT_CONTROL 0x2E
	86
	87	#define SDHCI_SOFTWARE_RESET 0x2F
	88	#define SDHCI_RESET_ALL 0x01
	89	#define SDHCI_RESET_CMD 0x02
	90	#define SDHCI_RESET_DATA 0x04
	91
	92	#define SDHCI_INT_STATUS 0x30
	93	#define SDHCI_INT_ENABLE 0x34
	94	#define SDHCI_SIGNAL_ENABLE 0x38
	95	#define SDHCI_INT_RESPONSE 0x00000001
	96	#define SDHCI_INT_DATA_END 0x00000002
	97	#define SDHCI_INT_DMA_END 0x00000008
	98	#define SDHCI_INT_BUF_EMPTY 0x00000010
	99	#define SDHCI_INT_BUF_FULL 0x00000020
	100	#define SDHCI_INT_CARD_INSERT 0x00000040
	101	#define SDHCI_INT_CARD_REMOVE 0x00000080
	102	#define SDHCI_INT_CARD_INT 0x00000100
	103	#define SDHCI_INT_TIMEOUT 0x00010000
	104	#define SDHCI_INT_CRC 0x00020000
	105	#define SDHCI_INT_END_BIT 0x00040000
	106	#define SDHCI_INT_INDEX 0x00080000
	107	#define SDHCI_INT_DATA_TIMEOUT 0x00100000
	108	#define SDHCI_INT_DATA_CRC 0x00200000
	109	#define SDHCI_INT_DATA_END_BIT 0x00400000
	110	#define SDHCI_INT_BUS_POWER 0x00800000
	111	#define SDHCI_INT_ACMD12ERR 0x01000000
	112
	113	#define SDHCI_INT_NORMAL_MASK 0x00007FFF
	114	#define SDHCI_INT_ERROR_MASK 0xFFFF8000
	115
	116	#define SDHCI_INT_CMD_MASK (SDHCI_INT_RESPONSE \| SDHCI_INT_TIMEOUT \| \
	117	SDHCI_INT_CRC \| SDHCI_INT_END_BIT \| SDHCI_INT_INDEX)
	118	#define SDHCI_INT_DATA_MASK (SDHCI_INT_DATA_END \| SDHCI_INT_DMA_END \| \
	119	SDHCI_INT_BUF_EMPTY \| SDHCI_INT_BUF_FULL \| \
	120	SDHCI_INT_DATA_TIMEOUT \| SDHCI_INT_DATA_CRC \| \
	121	SDHCI_INT_DATA_END_BIT)
	122
	123	#define SDHCI_ACMD12_ERR 0x3C
	124
	125	/* 3E-3F reserved */
	126
	127	#define SDHCI_CAPABILITIES 0x40
1c8cde92 PO	128	#define SDHCI_TIMEOUT_CLK_MASK 0x0000003F
	129	#define SDHCI_TIMEOUT_CLK_SHIFT 0
	130	#define SDHCI_TIMEOUT_CLK_UNIT 0x00000080
d129bceb PO	131	#define SDHCI_CLOCK_BASE_MASK 0x00003F00
d129bceb PO	132	#define SDHCI_CLOCK_BASE_SHIFT 8
146ad66e PO	133	#define SDHCI_CAN_DO_DMA 0x00400000
	134	#define SDHCI_CAN_VDD_330 0x01000000
	135	#define SDHCI_CAN_VDD_300 0x02000000
	136	#define SDHCI_CAN_VDD_180 0x04000000
d129bceb PO	137
	138	/* 44-47 reserved for more caps */
	139
	140	#define SDHCI_MAX_CURRENT 0x48
	141
	142	/* 4C-4F reserved for more max current */
	143
	144	/* 50-FB reserved */
	145
	146	#define SDHCI_SLOT_INT_STATUS 0xFC
	147
	148	#define SDHCI_HOST_VERSION 0xFE
	149
	150	struct sdhci_chip;
	151
	152	struct sdhci_host {
	153	struct sdhci_chip *chip;
	154	struct mmc_host mmc; / MMC structure */
	155
	156	spinlock_t lock; /* Mutex */
	157
	158	int flags; /* Host attributes */
	159	#define SDHCI_USE_DMA (1<<0)
	160
	161	unsigned int max_clk; /* Max possible freq (MHz) */
1c8cde92	162	unsigned int timeout_clk; /* Timeout freq (KHz) */
d129bceb PO	163
d129bceb PO	164	unsigned int clock; /* Current clock (MHz) */
146ad66e	165	unsigned short power; /* Current voltage */
d129bceb PO	166
	167	struct mmc_request mrq; / Current request */
	168	struct mmc_command cmd; / Current command */
	169	struct mmc_data data; / Current data request */
	170
	171	struct scatterlist cur_sg; / We're working on this */
	172	char mapped_sg; / This is where it's mapped */
	173	int num_sg; /* Entries left */
	174	int offset; /* Offset into current sg */
	175	int remain; /* Bytes left in current */
	176
	177	int size; /* Remaining bytes in transfer */
	178
	179	char slot_descr[20]; /* Name for reservations */
	180
	181	int irq; /* Device IRQ */
	182	int bar; /* PCI BAR index */
	183	unsigned long addr; /* Bus address */
	184	void __iomem * ioaddr; /* Mapped address */
	185
	186	struct tasklet_struct card_tasklet; /* Tasklet structures */
	187	struct tasklet_struct finish_tasklet;
	188
	189	struct timer_list timer; /* Timer for timeouts */
	190	};
	191
	192	struct sdhci_chip {
	193	struct pci_dev *pdev;
	194
	195	int num_slots; /* Slots on controller */
	196	struct sdhci_host hosts[0]; / Pointers to hosts */
	197	};