1 /*
2  * (C) Copyright 2008
3  * Texas Instruments, <www.ti.com>
4  * Syed Mohammed Khasim <khasim@ti.com>
5  *
6  * See file CREDITS for list of people who contributed to this
7  * project.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License as
11  * published by the Free Software Foundation's version 2 of
12  * the License.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
22  * MA 02111-1307 USA
23  */
24 
25 #ifndef MMC_H
26 #define MMC_H
27 
28 #include "mmc_host_def.h"
29 
30 /* Responses */
31 #define RSP_TYPE_NONE	(RSP_TYPE_NORSP   | CCCE_NOCHECK | CICE_NOCHECK)
32 #define RSP_TYPE_R1	(RSP_TYPE_LGHT48  | CCCE_CHECK   | CICE_CHECK)
33 #define RSP_TYPE_R1B	(RSP_TYPE_LGHT48B | CCCE_CHECK   | CICE_CHECK)
34 #define RSP_TYPE_R2	(RSP_TYPE_LGHT136 | CCCE_CHECK   | CICE_NOCHECK)
35 #define RSP_TYPE_R3	(RSP_TYPE_LGHT48  | CCCE_NOCHECK | CICE_NOCHECK)
36 #define RSP_TYPE_R4	(RSP_TYPE_LGHT48  | CCCE_NOCHECK | CICE_NOCHECK)
37 #define RSP_TYPE_R5	(RSP_TYPE_LGHT48  | CCCE_CHECK   | CICE_CHECK)
38 #define RSP_TYPE_R6	(RSP_TYPE_LGHT48  | CCCE_CHECK   | CICE_CHECK)
39 #define RSP_TYPE_R7	(RSP_TYPE_LGHT48  | CCCE_CHECK   | CICE_CHECK)
40 
41 /* All supported commands */
42 #define MMC_CMD0	(INDEX(0)  | RSP_TYPE_NONE | DP_NO_DATA | DDIR_WRITE)
43 #define MMC_CMD1	(INDEX(1)  | RSP_TYPE_R3   | DP_NO_DATA | DDIR_WRITE)
44 #define MMC_CMD2	(INDEX(2)  | RSP_TYPE_R2   | DP_NO_DATA | DDIR_WRITE)
45 #define MMC_CMD3	(INDEX(3)  | RSP_TYPE_R1   | DP_NO_DATA | DDIR_WRITE)
46 #define MMC_SDCMD3	(INDEX(3)  | RSP_TYPE_R6   | DP_NO_DATA | DDIR_WRITE)
47 #define MMC_CMD4	(INDEX(4)  | RSP_TYPE_NONE | DP_NO_DATA | DDIR_WRITE)
48 #define MMC_CMD6	(INDEX(6)  | RSP_TYPE_R1B  | DP_NO_DATA | DDIR_WRITE)
49 #define MMC_CMD7_SELECT	(INDEX(7)  | RSP_TYPE_R1B  | DP_NO_DATA | DDIR_WRITE)
50 #define MMC_CMD7_DESELECT (INDEX(7)| RSP_TYPE_NONE | DP_NO_DATA | DDIR_WRITE)
51 #define MMC_CMD8	(INDEX(8)  | RSP_TYPE_R1   | DP_DATA    | DDIR_READ)
52 #define MMC_SDCMD8	(INDEX(8)  | RSP_TYPE_R7   | DP_NO_DATA | DDIR_WRITE)
53 #define MMC_CMD9	(INDEX(9)  | RSP_TYPE_R2   | DP_NO_DATA | DDIR_WRITE)
54 #define MMC_CMD12	(INDEX(12) | RSP_TYPE_R1B  | DP_NO_DATA | DDIR_WRITE)
55 #define MMC_CMD13	(INDEX(13) | RSP_TYPE_R1   | DP_NO_DATA | DDIR_WRITE)
56 #define MMC_CMD15	(INDEX(15) | RSP_TYPE_NONE | DP_NO_DATA | DDIR_WRITE)
57 #define MMC_CMD16	(INDEX(16) | RSP_TYPE_R1   | DP_NO_DATA | DDIR_WRITE)
58 #define MMC_CMD17	(INDEX(17) | RSP_TYPE_R1   | DP_DATA    | DDIR_READ)
59 #define MMC_CMD24	(INDEX(24) | RSP_TYPE_R1   | DP_DATA    | DDIR_WRITE)
60 #define MMC_ACMD6	(INDEX(6)  | RSP_TYPE_R1   | DP_NO_DATA | DDIR_WRITE)
61 #define MMC_ACMD41	(INDEX(41) | RSP_TYPE_R3   | DP_NO_DATA | DDIR_WRITE)
62 #define MMC_ACMD51	(INDEX(51) | RSP_TYPE_R1   | DP_DATA    | DDIR_READ)
63 #define MMC_CMD55	(INDEX(55) | RSP_TYPE_R1   | DP_NO_DATA | DDIR_WRITE)
64 
65 #define MMC_AC_CMD_RCA_MASK	(unsigned int)(0xFFFF << 16)
66 #define MMC_BC_CMD_DSR_MASK	(unsigned int)(0xFFFF << 16)
67 #define MMC_DSR_DEFAULT		0x0404
68 #define SD_CMD8_CHECK_PATTERN	0xAA
69 #define SD_CMD8_2_7_3_6_V_RANGE	(0x01 << 8)
70 
71 /* Clock Configurations and Macros */
72 
73 #define MMC_CLOCK_REFERENCE		96
74 #define MMC_RELATIVE_CARD_ADDRESS	0x1234
75 #define MMC_INIT_SEQ_CLK		(MMC_CLOCK_REFERENCE * 1000 / 80)
76 #define MMC_400kHz_CLK			(MMC_CLOCK_REFERENCE * 1000 / 400)
77 #define CLKDR(r, f, u)			((((r)*100) / ((f)*(u))) + 1)
78 #define CLKD(f, u)			(CLKDR(MMC_CLOCK_REFERENCE, f, u))
79 
80 #define MMC_OCR_REG_ACCESS_MODE_MASK	(0x3 << 29)
81 #define MMC_OCR_REG_ACCESS_MODE_BYTE 	(0x0 << 29)
82 #define MMC_OCR_REG_ACCESS_MODE_SECTOR	(0x2 << 29)
83 
84 #define MMC_OCR_REG_HOST_CAPACITY_SUPPORT_MASK		(0x1 << 30)
85 #define MMC_OCR_REG_HOST_CAPACITY_SUPPORT_BYTE		(0x0 << 30)
86 #define MMC_OCR_REG_HOST_CAPACITY_SUPPORT_SECTOR	(0x1 << 30)
87 
88 #define MMC_SD2_CSD_C_SIZE_LSB_MASK	0xFFFF
89 #define MMC_SD2_CSD_C_SIZE_MSB_MASK	0x003F
90 #define MMC_SD2_CSD_C_SIZE_MSB_OFFSET	16
91 #define MMC_CSD_C_SIZE_LSB_MASK		0x0003
92 #define MMC_CSD_C_SIZE_MSB_MASK		0x03FF
93 #define MMC_CSD_C_SIZE_MSB_OFFSET	2
94 
95 #define MMC_CSD_TRAN_SPEED_UNIT_MASK	(0x07 << 0)
96 #define MMC_CSD_TRAN_SPEED_FACTOR_MASK	(0x0F << 3)
97 #define MMC_CSD_TRAN_SPEED_UNIT_100MHZ	(0x3 << 0)
98 #define MMC_CSD_TRAN_SPEED_FACTOR_1_0	(0x01 << 3)
99 #define MMC_CSD_TRAN_SPEED_FACTOR_8_0	(0x0F << 3)
100 
101 typedef struct {
102 	unsigned not_used:1;
103 	unsigned crc:7;
104 	unsigned ecc:2;
105 	unsigned file_format:2;
106 	unsigned tmp_write_protect:1;
107 	unsigned perm_write_protect:1;
108 	unsigned copy:1;
109 	unsigned file_format_grp:1;
110 	unsigned content_prot_app:1;
111 	unsigned reserved_1:4;
112 	unsigned write_bl_partial:1;
113 	unsigned write_bl_len:4;
114 	unsigned r2w_factor:3;
115 	unsigned default_ecc:2;
116 	unsigned wp_grp_enable:1;
117 	unsigned wp_grp_size:5;
118 	unsigned erase_grp_mult:5;
119 	unsigned erase_grp_size:5;
120 	unsigned c_size_mult:3;
121 	unsigned vdd_w_curr_max:3;
122 	unsigned vdd_w_curr_min:3;
123 	unsigned vdd_r_curr_max:3;
124 	unsigned vdd_r_curr_min:3;
125 	unsigned c_size_lsb:2;
126 	unsigned c_size_msb:10;
127 	unsigned reserved_2:2;
128 	unsigned dsr_imp:1;
129 	unsigned read_blk_misalign:1;
130 	unsigned write_blk_misalign:1;
131 	unsigned read_bl_partial:1;
132 	unsigned read_bl_len:4;
133 	unsigned ccc:12;
134 	unsigned tran_speed:8;
135 	unsigned nsac:8;
136 	unsigned taac:8;
137 	unsigned reserved_3:2;
138 	unsigned spec_vers:4;
139 	unsigned csd_structure:2;
140 } mmc_csd_reg_t;
141 
142 /* csd for sd2.0 */
143 typedef struct {
144 	unsigned not_used:1;
145 	unsigned crc:7;
146 	unsigned reserved_1:2;
147 	unsigned file_format:2;
148 	unsigned tmp_write_protect:1;
149 	unsigned perm_write_protect:1;
150 	unsigned copy:1;
151 	unsigned file_format_grp:1;
152 	unsigned reserved_2:5;
153 	unsigned write_bl_partial:1;
154 	unsigned write_bl_len:4;
155 	unsigned r2w_factor:3;
156 	unsigned reserved_3:2;
157 	unsigned wp_grp_enable:1;
158 	unsigned wp_grp_size:7;
159 	unsigned sector_size:7;
160 	unsigned erase_blk_len:1;
161 	unsigned reserved_4:1;
162 	unsigned c_size_lsb:16;
163 	unsigned c_size_msb:6;
164 	unsigned reserved_5:6;
165 	unsigned dsr_imp:1;
166 	unsigned read_blk_misalign:1;
167 	unsigned write_blk_misalign:1;
168 	unsigned read_bl_partial:1;
169 	unsigned read_bl_len:4;
170 	unsigned ccc:12;
171 	unsigned tran_speed:8;
172 	unsigned nsac:8;
173 	unsigned taac:8;
174 	unsigned reserved_6:6;
175 	unsigned csd_structure:2;
176 } mmc_sd2_csd_reg_t;
177 
178 /* extended csd - 512 bytes long */
179 typedef struct {
180 	unsigned char reserved_1[181];
181 	unsigned char erasedmemorycontent;
182 	unsigned char reserved_2;
183 	unsigned char buswidthmode;
184 	unsigned char reserved_3;
185 	unsigned char highspeedinterfacetiming;
186 	unsigned char reserved_4;
187 	unsigned char powerclass;
188 	unsigned char reserved_5;
189 	unsigned char commandsetrevision;
190 	unsigned char reserved_6;
191 	unsigned char commandset;
192 	unsigned char extendedcsdrevision;
193 	unsigned char reserved_7;
194 	unsigned char csdstructureversion;
195 	unsigned char reserved_8;
196 	unsigned char cardtype;
197 	unsigned char reserved_9[3];
198 	unsigned char powerclass_52mhz_1_95v;
199 	unsigned char powerclass_26mhz_1_95v;
200 	unsigned char powerclass_52mhz_3_6v;
201 	unsigned char powerclass_26mhz_3_6v;
202 	unsigned char reserved_10;
203 	unsigned char minreadperf_4b_26mhz;
204 	unsigned char minwriteperf_4b_26mhz;
205 	unsigned char minreadperf_8b_26mhz_4b_52mhz;
206 	unsigned char minwriteperf_8b_26mhz_4b_52mhz;
207 	unsigned char minreadperf_8b_52mhz;
208 	unsigned char minwriteperf_8b_52mhz;
209 	unsigned char reserved_11;
210 	unsigned int sectorcount;
211 	unsigned char reserved_12[288];
212 	unsigned char supportedcommandsets;
213 	unsigned char reserved_13[7];
214 } mmc_extended_csd_reg_t;
215 
216 /* mmc sd responce */
217 typedef struct {
218 	unsigned int ocr;
219 } mmc_resp_r3;
220 
221 typedef struct {
222 	unsigned short cardstatus;
223 	unsigned short newpublishedrca;
224 } mmc_resp_r6;
225 
226 typedef union {
227 	unsigned int resp[4];
228 	mmc_resp_r3 r3;
229 	mmc_resp_r6 r6;
230 	mmc_csd_reg_t Card_CSD;
231 } mmc_resp_t;
232 
233 extern mmc_card_data mmc_dev;
234 
235 unsigned char mmc_lowlevel_init(void);
236 unsigned char mmc_send_command(unsigned int cmd, unsigned int arg,
237 			       unsigned int *response);
238 unsigned char mmc_setup_clock(unsigned int iclk, unsigned short clkd);
239 unsigned char mmc_set_opendrain(unsigned char state);
240 unsigned char mmc_read_data(unsigned int *output_buf);
241 
242 #endif /* MMC_H */
243