xref: /openbmc/linux/drivers/mmc/host/toshsd.h (revision d3964221)
1 /*
2  *  Toshiba PCI Secure Digital Host Controller Interface driver
3  *
4  *  Copyright (C) 2014 Ondrej Zary
5  *  Copyright (C) 2007 Richard Betts, All Rights Reserved.
6  *
7  *      Based on asic3_mmc.c Copyright (c) 2005 SDG Systems, LLC
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or (at
12  * your option) any later version.
13  */
14 
15 #define HCLK	33000000	/* 33 MHz (PCI clock) */
16 
17 #define SD_PCICFG_CLKSTOP	0x40	/* 0x1f = clock controller, 0 = stop */
18 #define SD_PCICFG_GATEDCLK	0x41	/* Gated clock */
19 #define SD_PCICFG_CLKMODE	0x42	/* Control clock of SD controller */
20 #define SD_PCICFG_PINSTATUS	0x44	/* R/O: read status of SD pins */
21 #define SD_PCICFG_POWER1	0x48
22 #define SD_PCICFG_POWER2	0x49
23 #define SD_PCICFG_POWER3	0x4a
24 #define SD_PCICFG_CARDDETECT	0x4c
25 #define SD_PCICFG_SLOTS		0x50	/* R/O: define support slot number */
26 #define SD_PCICFG_EXTGATECLK1	0xf0	/* Could be used for gated clock */
27 #define SD_PCICFG_EXTGATECLK2	0xf1	/* Could be used for gated clock */
28 #define SD_PCICFG_EXTGATECLK3	0xf9	/* Bit 1: double buffer/single buffer */
29 #define SD_PCICFG_SDLED_ENABLE1	0xfa
30 #define SD_PCICFG_SDLED_ENABLE2	0xfe
31 
32 #define SD_PCICFG_CLKMODE_DIV_DISABLE	BIT(0)
33 #define SD_PCICFG_CLKSTOP_ENABLE_ALL	0x1f
34 #define SD_PCICFG_LED_ENABLE1_START	0x12
35 #define SD_PCICFG_LED_ENABLE2_START	0x80
36 
37 #define SD_PCICFG_PWR1_33V	0x08	/* Set for 3.3 volts */
38 #define SD_PCICFG_PWR1_OFF	0x00	/* Turn off power */
39 #define SD_PCICFG_PWR2_AUTO	0x02
40 
41 #define SD_CMD			0x00	/* also for SDIO */
42 #define SD_ARG0			0x04	/* also for SDIO */
43 #define SD_ARG1			0x06	/* also for SDIO */
44 #define SD_STOPINTERNAL		0x08
45 #define SD_BLOCKCOUNT		0x0a	/* also for SDIO */
46 #define SD_RESPONSE0		0x0c	/* also for SDIO */
47 #define SD_RESPONSE1		0x0e	/* also for SDIO */
48 #define SD_RESPONSE2		0x10	/* also for SDIO */
49 #define SD_RESPONSE3		0x12	/* also for SDIO */
50 #define SD_RESPONSE4		0x14	/* also for SDIO */
51 #define SD_RESPONSE5		0x16	/* also for SDIO */
52 #define SD_RESPONSE6		0x18	/* also for SDIO */
53 #define SD_RESPONSE7		0x1a	/* also for SDIO */
54 #define SD_CARDSTATUS		0x1c	/* also for SDIO */
55 #define SD_BUFFERCTRL		0x1e	/* also for SDIO */
56 #define SD_INTMASKCARD		0x20	/* also for SDIO */
57 #define SD_INTMASKBUFFER	0x22	/* also for SDIO */
58 #define SD_CARDCLOCKCTRL	0x24
59 #define SD_CARDXFERDATALEN	0x26	/* also for SDIO */
60 #define SD_CARDOPTIONSETUP	0x28	/* also for SDIO */
61 #define SD_ERRORSTATUS0		0x2c	/* also for SDIO */
62 #define SD_ERRORSTATUS1		0x2e	/* also for SDIO */
63 #define SD_DATAPORT		0x30	/* also for SDIO */
64 #define SD_TRANSACTIONCTRL	0x34	/* also for SDIO */
65 #define SD_SOFTWARERESET	0xe0	/* also for SDIO */
66 
67 /* registers above marked "also for SDIO" and all SDIO registers below can be
68  * accessed at SDIO_BASE + reg address */
69 #define SDIO_BASE	 0x100
70 
71 #define SDIO_CARDPORTSEL	0x02
72 #define SDIO_CARDINTCTRL	0x36
73 #define SDIO_CLOCKNWAITCTRL	0x38
74 #define SDIO_HOSTINFORMATION	0x3a
75 #define SDIO_ERRORCTRL		0x3c
76 #define SDIO_LEDCTRL		0x3e
77 
78 #define SD_TRANSCTL_SET		BIT(8)
79 
80 #define SD_CARDCLK_DIV_DISABLE	BIT(15)
81 #define SD_CARDCLK_ENABLE_CLOCK	BIT(8)
82 #define SD_CARDCLK_CLK_DIV_512	BIT(7)
83 #define SD_CARDCLK_CLK_DIV_256	BIT(6)
84 #define SD_CARDCLK_CLK_DIV_128	BIT(5)
85 #define SD_CARDCLK_CLK_DIV_64	BIT(4)
86 #define SD_CARDCLK_CLK_DIV_32	BIT(3)
87 #define SD_CARDCLK_CLK_DIV_16	BIT(2)
88 #define SD_CARDCLK_CLK_DIV_8	BIT(1)
89 #define SD_CARDCLK_CLK_DIV_4	BIT(0)
90 #define SD_CARDCLK_CLK_DIV_2	0
91 
92 #define SD_CARDOPT_REQUIRED		0x000e
93 #define SD_CARDOPT_DATA_RESP_TIMEOUT(x)	(((x) & 0x0f) << 4) /* 4 bits */
94 #define SD_CARDOPT_C2_MODULE_ABSENT	BIT(14)
95 #define SD_CARDOPT_DATA_XFR_WIDTH_1	(1 << 15)
96 #define SD_CARDOPT_DATA_XFR_WIDTH_4	(0 << 15)
97 
98 #define SD_CMD_TYPE_CMD			(0 << 6)
99 #define SD_CMD_TYPE_ACMD		(1 << 6)
100 #define SD_CMD_TYPE_AUTHEN		(2 << 6)
101 #define SD_CMD_RESP_TYPE_NONE		(3 << 8)
102 #define SD_CMD_RESP_TYPE_EXT_R1		(4 << 8)
103 #define SD_CMD_RESP_TYPE_EXT_R1B	(5 << 8)
104 #define SD_CMD_RESP_TYPE_EXT_R2		(6 << 8)
105 #define SD_CMD_RESP_TYPE_EXT_R3		(7 << 8)
106 #define SD_CMD_RESP_TYPE_EXT_R6		(4 << 8)
107 #define SD_CMD_RESP_TYPE_EXT_R7		(4 << 8)
108 #define SD_CMD_DATA_PRESENT		BIT(11)
109 #define SD_CMD_TRANSFER_READ		BIT(12)
110 #define SD_CMD_MULTI_BLOCK		BIT(13)
111 #define SD_CMD_SECURITY_CMD		BIT(14)
112 
113 #define SD_STOPINT_ISSUE_CMD12		BIT(0)
114 #define SD_STOPINT_AUTO_ISSUE_CMD12	BIT(8)
115 
116 #define SD_CARD_RESP_END	BIT(0)
117 #define SD_CARD_RW_END		BIT(2)
118 #define SD_CARD_CARD_REMOVED_0	BIT(3)
119 #define SD_CARD_CARD_INSERTED_0	BIT(4)
120 #define SD_CARD_PRESENT_0	BIT(5)
121 #define SD_CARD_UNK6		BIT(6)
122 #define SD_CARD_WRITE_PROTECT	BIT(7)
123 #define SD_CARD_CARD_REMOVED_3	BIT(8)
124 #define SD_CARD_CARD_INSERTED_3	BIT(9)
125 #define SD_CARD_PRESENT_3	BIT(10)
126 
127 #define SD_BUF_CMD_INDEX_ERR	BIT(16)
128 #define SD_BUF_CRC_ERR		BIT(17)
129 #define SD_BUF_STOP_BIT_END_ERR	BIT(18)
130 #define SD_BUF_DATA_TIMEOUT	BIT(19)
131 #define SD_BUF_OVERFLOW		BIT(20)
132 #define SD_BUF_UNDERFLOW	BIT(21)
133 #define SD_BUF_CMD_TIMEOUT	BIT(22)
134 #define SD_BUF_UNK7		BIT(23)
135 #define SD_BUF_READ_ENABLE	BIT(24)
136 #define SD_BUF_WRITE_ENABLE	BIT(25)
137 #define SD_BUF_ILLEGAL_FUNCTION	BIT(29)
138 #define SD_BUF_CMD_BUSY		BIT(30)
139 #define SD_BUF_ILLEGAL_ACCESS	BIT(31)
140 
141 #define SD_ERR0_RESP_CMD_ERR			BIT(0)
142 #define SD_ERR0_RESP_NON_CMD12_END_BIT_ERR	BIT(2)
143 #define SD_ERR0_RESP_CMD12_END_BIT_ERR		BIT(3)
144 #define SD_ERR0_READ_DATA_END_BIT_ERR		BIT(4)
145 #define SD_ERR0_WRITE_CRC_STATUS_END_BIT_ERR	BIT(5)
146 #define SD_ERR0_RESP_NON_CMD12_CRC_ERR		BIT(8)
147 #define SD_ERR0_RESP_CMD12_CRC_ERR		BIT(9)
148 #define SD_ERR0_READ_DATA_CRC_ERR		BIT(10)
149 #define SD_ERR0_WRITE_CMD_CRC_ERR		BIT(11)
150 
151 #define SD_ERR1_NO_CMD_RESP		BIT(16)
152 #define SD_ERR1_TIMEOUT_READ_DATA	BIT(20)
153 #define SD_ERR1_TIMEOUT_CRS_STATUS	BIT(21)
154 #define SD_ERR1_TIMEOUT_CRC_BUSY	BIT(22)
155 
156 #define IRQ_DONT_CARE_BITS (SD_CARD_PRESENT_3 \
157 	| SD_CARD_WRITE_PROTECT \
158 	| SD_CARD_UNK6 \
159 	| SD_CARD_PRESENT_0 \
160 	| SD_BUF_UNK7 \
161 	| SD_BUF_CMD_BUSY)
162 
163 struct toshsd_host {
164 	struct pci_dev *pdev;
165 	struct mmc_host *mmc;
166 
167 	spinlock_t lock;
168 
169 	struct mmc_request *mrq;/* Current request */
170 	struct mmc_command *cmd;/* Current command */
171 	struct mmc_data *data;	/* Current data request */
172 
173 	struct sg_mapping_iter sg_miter; /* for PIO */
174 
175 	void __iomem *ioaddr; /* mapped address */
176 };
177