xref: /freebsd/sys/arm/allwinner/aw_mmc.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2018 Emmanuel Vadot <manu@FreeBSD.org>
5  * Copyright (c) 2013 Alexander Fedorov <alexander.fedorov@rtlservice.com>
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #ifndef	_AW_MMC_H_
31 #define	_AW_MMC_H_
32 
33 #define	AW_MMC_GCTL		0x00	/* Control Register */
34 #define	AW_MMC_CKCR		0x04	/* Clock Control Register */
35 #define	AW_MMC_TMOR		0x08	/* Timeout Register */
36 #define	AW_MMC_BWDR		0x0C	/* Bus Width Register */
37 #define	AW_MMC_BKSR		0x10	/* Block Size Register */
38 #define	AW_MMC_BYCR		0x14	/* Byte Count Register */
39 #define	AW_MMC_CMDR		0x18	/* Command Register */
40 #define	AW_MMC_CAGR		0x1C	/* Argument Register */
41 #define	AW_MMC_RESP0		0x20	/* Response Register 0 */
42 #define	AW_MMC_RESP1		0x24	/* Response Register 1 */
43 #define	AW_MMC_RESP2		0x28	/* Response Register 2 */
44 #define	AW_MMC_RESP3		0x2C	/* Response Register 3 */
45 #define	AW_MMC_IMKR		0x30	/* Interrupt Mask Register */
46 #define	AW_MMC_MISR		0x34	/* Masked Interrupt Status Register */
47 #define	AW_MMC_RISR		0x38	/* Raw Interrupt Status Register */
48 #define	AW_MMC_STAR		0x3C	/* Status Register */
49 #define	AW_MMC_FWLR		0x40	/* FIFO Threshold Watermark Register */
50 #define	AW_MMC_FUNS		0x44	/* Function Select Register */
51 #define	AW_MMC_DBGC		0x50	/* Debug register */
52 #define	AW_MMC_CSDC		0x54	/* CRC status detect controler register (A64 smhc2 only) */
53 #define	AW_MMC_A12A		0x58	/* Auto command 12 argument register */
54 #define	AW_MMC_NTSR		0x5C	/* SD new timing register (H3, A64 smhc0/1 only) */
55 #define	AW_MMC_HWRST		0x78	/* Hardware reset */
56 #define	AW_MMC_DMAC		0x80	/* IDMAC Control Register */
57 #define	AW_MMC_DLBA		0x84	/* IDMAC Desc List Base Address Reg */
58 #define	AW_MMC_IDST		0x88	/* IDMAC Status Register */
59 #define	AW_MMC_IDIE		0x8C	/* IDMAC Interrupt Enable Register */
60 
61 #define	AW_MMC_DDR_SBIT_DET	0x10C	/* eMMC4.5 DDR Start Bit Detection control register */
62 #define	AW_MMC_DRV_DL		0x140	/* Drive Delay control register */
63 #define	AW_MMC_SAMP_DL		0x144	/* Sample Delay controle register */
64 #define	AW_MMC_DS_DL		0x148	/* Data strobe delay control register */
65 
66 #define	AW_MMC_FIFO		0x100	/* FIFO Access Address (A10/A20) */
67 #define	A31_MMC_FIFO		0x200	/* FIFO Access Address (A31) */
68 
69 /* AW_MMC_GCTL */
70 #define	AW_MMC_GCTL_SOFT_RST		(1U << 0)
71 #define	AW_MMC_GCTL_FIFO_RST		(1U << 1)
72 #define	AW_MMC_GCTL_DMA_RST		(1U << 2)
73 #define	AW_MMC_GCTL_INT_ENB		(1U << 4)
74 #define	AW_MMC_GCTL_DMA_ENB		(1U << 5)
75 #define	AW_MMC_GCTL_CD_DBC_ENB		(1U << 8)
76 #define	AW_MMC_GCTL_DDR_MOD_SEL		(1U << 10)
77 #define	AW_MMC_GCTL_WAIT_MEM_ACCESS	(1U << 30)
78 #define	AW_MMC_GCTL_FIFO_AC_MOD		(1U << 31)
79 #define	AW_MMC_GCTL_RESET			\
80 	(AW_MMC_GCTL_SOFT_RST | AW_MMC_GCTL_FIFO_RST | AW_MMC_GCTL_DMA_RST)
81 
82 /* AW_MMC_CKCR */
83 #define	AW_MMC_CKCR_DIV		0xff
84 #define	AW_MMC_CKCR_ENB		(1U << 16)
85 #define	AW_MMC_CKCR_LOW_POWER	(1U << 17)
86 #define	AW_MMC_CKCR_MASK_DATA0	(1U << 31)
87 
88 /* AW_MMC_TMOR */
89 #define	AW_MMC_TMOR_RTO_LMT_SHIFT(x)	x		/* Response timeout limit */
90 #define	AW_MMC_TMOR_RTO_LMT_MASK	0xff
91 #define	AW_MMC_TMOR_DTO_LMT_SHIFT(x)	(x << 8)	/* Data timeout limit */
92 #define	AW_MMC_TMOR_DTO_LMT_MASK	0xffffff
93 
94 /* AW_MMC_BWDR */
95 #define	AW_MMC_BWDR1			0
96 #define	AW_MMC_BWDR4			1
97 #define	AW_MMC_BWDR8			2
98 
99 /* AW_MMC_CMDR */
100 #define	AW_MMC_CMDR_RESP_RCV		(1U << 6)
101 #define	AW_MMC_CMDR_LONG_RESP		(1U << 7)
102 #define	AW_MMC_CMDR_CHK_RESP_CRC	(1U << 8)
103 #define	AW_MMC_CMDR_DATA_TRANS		(1U << 9)
104 #define	AW_MMC_CMDR_DIR_WRITE		(1U << 10)
105 #define	AW_MMC_CMDR_TRANS_MODE_STREAM	(1U << 11)
106 #define	AW_MMC_CMDR_STOP_CMD_FLAG	(1U << 12)
107 #define	AW_MMC_CMDR_WAIT_PRE_OVER	(1U << 13)
108 #define	AW_MMC_CMDR_STOP_ABT_CMD	(1U << 14)
109 #define	AW_MMC_CMDR_SEND_INIT_SEQ	(1U << 15)
110 #define	AW_MMC_CMDR_PRG_CLK		(1U << 21)
111 #define	AW_MMC_CMDR_RD_CEDATA_DEV	(1U << 22)
112 #define	AW_MMC_CMDR_CCS_EXP		(1U << 23)
113 #define	AW_MMC_CMDR_BOOT_MOD_SHIFT	24
114 #define	AW_MMC_CMDR_BOOT_MOD_NORMAL	0
115 #define	AW_MMC_CMDR_BOOT_MOD_MANDATORY	1
116 #define	AW_MMC_CMDR_BOOT_MOD_ALT	2
117 #define	AW_MMC_CMDR_EXP_BOOT_ACK	(1U << 26)
118 #define	AW_MMC_CMDR_BOOT_ABT		(1U << 27)
119 #define	AW_MMC_CMDR_VOL_SW		(1U << 28)
120 #define	AW_MMC_CMDR_LOAD		(1U << 31)
121 
122 /* AW_MMC_IMKR and AW_MMC_RISR */
123 #define	AW_MMC_INT_RESP_ERR	(1U << 1)
124 #define	AW_MMC_INT_CMD_DONE		(1U << 2)
125 #define	AW_MMC_INT_DATA_OVER		(1U << 3)
126 #define	AW_MMC_INT_TX_DATA_REQ		(1U << 4)
127 #define	AW_MMC_INT_RX_DATA_REQ		(1U << 5)
128 #define	AW_MMC_INT_RESP_CRC_ERR		(1U << 6)
129 #define	AW_MMC_INT_DATA_CRC_ERR		(1U << 7)
130 #define	AW_MMC_INT_RESP_TIMEOUT		(1U << 8)
131 #define	AW_MMC_INT_BOOT_ACK_RECV	(1U << 8)
132 #define	AW_MMC_INT_DATA_TIMEOUT		(1U << 9)
133 #define	AW_MMC_INT_BOOT_START		(1U << 9)
134 #define	AW_MMC_INT_DATA_STARVE		(1U << 10)
135 #define	AW_MMC_INT_VOL_CHG_DONE		(1U << 10)
136 #define	AW_MMC_INT_FIFO_RUN_ERR		(1U << 11)
137 #define	AW_MMC_INT_CMD_BUSY		(1U << 12)
138 #define	AW_MMC_INT_DATA_START_ERR	(1U << 13)
139 #define	AW_MMC_INT_AUTO_STOP_DONE	(1U << 14)
140 #define	AW_MMC_INT_DATA_END_BIT_ERR	(1U << 15)
141 #define	AW_MMC_INT_SDIO			(1U << 16)
142 #define	AW_MMC_INT_CARD_INSERT		(1U << 30)
143 #define	AW_MMC_INT_CARD_REMOVE		(1U << 31)
144 #define	AW_MMC_INT_ERR_BIT				\
145 	(AW_MMC_INT_RESP_ERR | AW_MMC_INT_RESP_CRC_ERR |	\
146 	 AW_MMC_INT_DATA_CRC_ERR | AW_MMC_INT_RESP_TIMEOUT |	\
147 	 AW_MMC_INT_FIFO_RUN_ERR |	AW_MMC_INT_CMD_BUSY |	\
148 	 AW_MMC_INT_DATA_START_ERR | AW_MMC_INT_DATA_END_BIT_ERR)
149 
150 /* AW_MMC_STAR */
151 #define	AW_MMC_STAR_FIFO_RX_LEVEL	(1U << 0)
152 #define	AW_MMC_STAR_FIFO_TX_LEVEL	(1U << 1)
153 #define	AW_MMC_STAR_FIFO_EMPTY		(1U << 2)
154 #define	AW_MMC_STAR_FIFO_FULL		(1U << 3)
155 #define	AW_MMC_STAR_CARD_PRESENT	(1U << 8)
156 #define	AW_MMC_STAR_CARD_BUSY		(1U << 9)
157 #define	AW_MMC_STAR_FSM_BUSY		(1U << 10)
158 #define	AW_MMC_STAR_DMA_REQ			(1U << 31)
159 
160 /* AW_MMC_FUNS */
161 #define	AW_MMC_CE_ATA_ON		(0xceaaU << 16)
162 #define	AW_MMC_SEND_IRQ_RESP		(1U << 0)
163 #define	AW_MMC_SDIO_RD_WAIT		(1U << 1)
164 #define	AW_MMC_ABT_RD_DATA		(1U << 2)
165 #define	AW_MMC_SEND_CC_SD		(1U << 8)
166 #define	AW_MMC_SEND_AUTOSTOP_CC_SD	(1U << 9)
167 #define	AW_MMC_CE_ATA_DEV_INT_ENB	(1U << 10)
168 
169 /* AW_MMC_NTSR */
170 #define	AW_MMC_NTSR_MODE_SELECT		(1U << 31)
171 
172 /* IDMA CONTROLLER BUS MOD BIT FIELD */
173 #define	AW_MMC_DMAC_IDMAC_SOFT_RST	(1U << 0)
174 #define	AW_MMC_DMAC_IDMAC_FIX_BURST	(1U << 1)
175 #define	AW_MMC_DMAC_IDMAC_IDMA_ON	(1U << 7)
176 #define	AW_MMC_DMAC_IDMAC_REFETCH_DES	(1U << 31)
177 
178 /* AW_MMC_IDST */
179 #define	AW_MMC_IDST_TX_INT		(1U << 0)
180 #define	AW_MMC_IDST_RX_INT		(1U << 1)
181 #define	AW_MMC_IDST_FATAL_BERR_INT	(1U << 2)
182 #define	AW_MMC_IDST_DES_UNAVL_INT	(1U << 4)
183 #define	AW_MMC_IDST_ERR_FLAG_SUM	(1U << 5)
184 #define	AW_MMC_IDST_NOR_INT_SUM		(1U << 8)
185 #define	AW_MMC_IDST_ABN_INT_SUM		(1U << 9)
186 #define	AW_MMC_IDST_HOST_ABT_INTX	(1U << 10)
187 #define	AW_MMC_IDST_HOST_ABT_INRX	(1U << 10)
188 #define	AW_MMC_IDST_IDLE		(0U << 13)
189 #define	AW_MMC_IDST_SUSPEND		(1U << 13)
190 #define	AW_MMC_IDST_DESC_RD		(2U << 13)
191 #define	AW_MMC_IDST_DESC_CHECK		(3U << 13)
192 #define	AW_MMC_IDST_RD_REQ_WAIT		(4U << 13)
193 #define	AW_MMC_IDST_WR_REQ_WAIT		(5U << 13)
194 #define	AW_MMC_IDST_RD			(6U << 13)
195 #define	AW_MMC_IDST_WR			(7U << 13)
196 #define	AW_MMC_IDST_DESC_CLOSE		(8U << 13)
197 #define	AW_MMC_IDST_ERROR				\
198 	(AW_MMC_IDST_FATAL_BERR_INT | AW_MMC_IDST_ERR_FLAG_SUM |	\
199 	 AW_MMC_IDST_DES_UNAVL_INT | AW_MMC_IDST_ABN_INT_SUM)
200 #define	AW_MMC_IDST_COMPLETE				\
201 	(AW_MMC_IDST_TX_INT | AW_MMC_IDST_RX_INT)
202 
203 /* AW_MMC_DDR_SBIT_DET */
204 #define	AW_MMC_DDR_SBIT_HS_MD_EN	(1U << 31)
205 
206 /* AW_MMC_SAMP */
207 #define	AW_MMC_SAMP_DL_SW_EN		(1U << 7)
208 
209 /* The DMA descriptor table. */
210 struct aw_mmc_dma_desc {
211 	uint32_t config;
212 #define	AW_MMC_DMA_CONFIG_DIC		(1U << 1)	/* Disable Interrupt Completion */
213 #define	AW_MMC_DMA_CONFIG_LD		(1U << 2)	/* Last DES */
214 #define	AW_MMC_DMA_CONFIG_FD		(1U << 3)	/* First DES */
215 #define	AW_MMC_DMA_CONFIG_CH		(1U << 4)	/* CHAIN MOD */
216 #define	AW_MMC_DMA_CONFIG_ER		(1U << 5)	/* End of Ring (undocumented register) */
217 #define	AW_MMC_DMA_CONFIG_CES		(1U << 30)	/* Card Error Summary */
218 #define	AW_MMC_DMA_CONFIG_OWN		(1U << 31)	/* DES Own Flag */
219 	uint32_t buf_size;
220 	uint32_t buf_addr;
221 	uint32_t next;
222 };
223 
224 #define	AW_MMC_DMA_ALIGN	4
225 
226 #endif /* _AW_MMC_H_ */
227