xref: /freebsd/sys/dev/sdhci/sdhci_xenon.h (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1 /*-
2  * Copyright (c) 2018 Rubicon Communications, LLC (Netgate)
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  * $FreeBSD$
26  */
27 
28 /*
29  * Marvel Xenon SDHCI driver defines.
30  */
31 
32 #ifndef	_SDHCI_XENON_H_
33 #define	_SDHCI_XENON_H_
34 
35 #define	XENON_LOWEST_SDCLK_FREQ			100000
36 #define	XENON_MMC_MAX_CLK			400000000
37 
38 #define	XENON_SYS_OP_CTRL			0x0108
39 #define	 XENON_AUTO_CLKGATE_DISABLE		(1 << 20)
40 #define	 XENON_SDCLK_IDLEOFF_ENABLE_SHIFT	8
41 
42 #define	XENON_SYS_EXT_OP_CTRL			0x010C
43 #define	 XENON_MASK_CMD_CONFLICT_ERR		(1 << 8)
44 
45 #define	XENON_SLOT_EMMC_CTRL			0x0130
46 #define	 XENON_ENABLE_DATA_STROBE		(1 << 24)
47 #define	 XENON_ENABLE_RESP_STROBE		(1 << 25)
48 
49 /* Custom HS200 / HS400 Mode Select values in SDHCI_HOST_CONTROL2 register. */
50 #define	XENON_CTRL2_MMC_HS200			0x5
51 #define	XENON_CTRL2_MMC_HS400			0x6
52 
53 /* eMMC PHY */
54 #define	XENON_EMMC_PHY_REG_BASE			0x170
55 
56 #define	XENON_EMMC_PHY_TIMING_ADJUST		XENON_EMMC_PHY_REG_BASE
57 #define	 XENON_SAMPL_INV_QSP_PHASE_SELECT	(1 << 18)
58 #define	 XENON_TIMING_ADJUST_SDIO_MODE		(1 << 28)
59 #define	 XENON_TIMING_ADJUST_SLOW_MODE		(1 << 29)
60 #define	 XENON_PHY_INITIALIZATION		(1U << 31)
61 #define	 XENON_WAIT_CYCLE_BEFORE_USING_MASK	0xF
62 #define	 XENON_WAIT_CYCLE_BEFORE_USING_SHIFT	12
63 #define	 XENON_FC_SYNC_EN_DURATION_MASK		0xF
64 #define	 XENON_FC_SYNC_EN_DURATION_SHIFT	8
65 #define	 XENON_FC_SYNC_RST_EN_DURATION_MASK	0xF
66 #define	 XENON_FC_SYNC_RST_EN_DURATION_SHIFT	4
67 #define	 XENON_FC_SYNC_RST_DURATION_MASK	0xF
68 #define	 XENON_FC_SYNC_RST_DURATION_SHIFT	0
69 
70 #define	XENON_EMMC_PHY_FUNC_CONTROL		(XENON_EMMC_PHY_REG_BASE + 0x4)
71 #define	 XENON_DQ_ASYNC_MODE			(1 << 4)
72 #define	 XENON_CMD_DDR_MODE			(1 << 16)
73 #define	 XENON_DQ_DDR_MODE_SHIFT		8
74 #define	 XENON_DQ_DDR_MODE_MASK			0xFF
75 #define	 XENON_ASYNC_DDRMODE_MASK		(1 << 23)
76 #define	 XENON_ASYNC_DDRMODE_SHIFT		23
77 
78 #define	XENON_EMMC_PHY_PAD_CONTROL		(XENON_EMMC_PHY_REG_BASE + 0x8)
79 #define	 XENON_FC_DQ_RECEN			(1 << 24)
80 #define	 XENON_FC_CMD_RECEN			(1 << 25)
81 #define	 XENON_FC_QSP_RECEN			(1 << 26)
82 #define	 XENON_FC_QSN_RECEN			(1 << 27)
83 #define	 XENON_OEN_QSN				(1 << 28)
84 #define	 XENON_FC_ALL_CMOS_RECEIVER		0xF000
85 
86 #define	XENON_EMMC_PHY_PAD_CONTROL1		(XENON_EMMC_PHY_REG_BASE + 0xC)
87 #define	 XENON_EMMC_FC_CMD_PD			(1 << 8)
88 #define	 XENON_EMMC_FC_QSP_PD			(1 << 9)
89 #define	 XENON_EMMC_FC_CMD_PU			(1 << 24)
90 #define	 XENON_EMMC_FC_QSP_PU			(1 << 25)
91 #define	 XENON_EMMC_FC_DQ_PD			0xFF
92 #define	 XENON_EMMC_FC_DQ_PU			(0xFF << 16)
93 
94 #define	XENON_EMMC_PHY_PAD_CONTROL2		(XENON_EMMC_PHY_REG_BASE + 0x10)
95 #define	 XENON_ZNR_MASK				0x1F
96 #define	 XENON_ZNR_SHIFT			8
97 #define	 XENON_ZPR_MASK				0x1F
98 #define	 XENON_ZNR_DEF_VALUE			0xF
99 #define	 XENON_ZPR_DEF_VALUE			0xF
100 
101 #define	XENON_EMMC_PHY_LOGIC_TIMING_ADJUST	(XENON_EMMC_PHY_REG_BASE + 0x18)
102 #define	 XENON_LOGIC_TIMING_VALUE		0x00AA8977
103 
104 DECLARE_CLASS(sdhci_xenon_driver);
105 
106 struct sdhci_xenon_softc {
107 	device_t	dev;		/* Controller device */
108 	int		slot_id;	/* Controller ID */
109 
110 	struct resource	*mem_res;	/* Memory resource */
111 	struct resource *irq_res;	/* IRQ resource */
112 	void		*intrhand;	/* Interrupt handle */
113 
114 	struct sdhci_slot *slot;	/* SDHCI internal data */
115 
116 	uint8_t		znr;		/* PHY ZNR */
117 	uint8_t		zpr;		/* PHY ZPR */
118 	bool		slow_mode;	/* PHY slow mode */
119 	bool		wp_inverted;
120 	bool		skip_regulators; /* Don't switch regulators */
121 
122 	regulator_t	vmmc_supply;
123 	regulator_t	vqmmc_supply;
124 
125 #ifdef FDT
126 	struct sdhci_fdt_gpio *gpio;	/* GPIO pins for CD detection. */
127 #endif
128 };
129 
130 device_attach_t sdhci_xenon_attach;
131 device_detach_t sdhci_xenon_detach;
132 
133 #endif	/* _SDHCI_XENON_H_ */
134