xref: /openbmc/linux/sound/soc/fsl/fsl_spdif.h (revision 887069f4) 
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * fsl_spdif.h - ALSA S/PDIF interface for the Freescale i.MX SoC
4  *
5  * Copyright (C) 2013 Freescale Semiconductor, Inc.
6  *
7  * Author: Nicolin Chen <b42378@freescale.com>
8  *
9  * Based on fsl_ssi.h
10  * Author: Timur Tabi <timur@freescale.com>
11  * Copyright 2007-2008 Freescale Semiconductor, Inc.
12  */
13 
14 #ifndef _FSL_SPDIF_DAI_H
15 #define _FSL_SPDIF_DAI_H
16 
17 /* S/PDIF Register Map */
18 #define REG_SPDIF_SCR 			0x0	/* SPDIF Configuration Register */
19 #define REG_SPDIF_SRCD		 	0x4	/* CDText Control Register */
20 #define REG_SPDIF_SRPC			0x8	/* PhaseConfig Register */
21 #define REG_SPDIF_SIE			0xc	/* InterruptEn Register */
22 #define REG_SPDIF_SIS			0x10	/* InterruptStat Register */
23 #define REG_SPDIF_SIC			0x10	/* InterruptClear Register */
24 #define REG_SPDIF_SRL			0x14	/* SPDIFRxLeft Register */
25 #define REG_SPDIF_SRR			0x18	/* SPDIFRxRight Register */
26 #define REG_SPDIF_SRCSH			0x1c	/* SPDIFRxCChannel_h Register */
27 #define REG_SPDIF_SRCSL			0x20	/* SPDIFRxCChannel_l Register */
28 #define REG_SPDIF_SRU			0x24	/* UchannelRx Register */
29 #define REG_SPDIF_SRQ			0x28	/* QchannelRx Register */
30 #define REG_SPDIF_STL			0x2C	/* SPDIFTxLeft Register */
31 #define REG_SPDIF_STR			0x30	/* SPDIFTxRight Register */
32 #define REG_SPDIF_STCSCH		0x34	/* SPDIFTxCChannelCons_h Register */
33 #define REG_SPDIF_STCSCL		0x38	/* SPDIFTxCChannelCons_l Register */
34 #define REG_SPDIF_SRFM			0x44	/* FreqMeas Register */
35 #define REG_SPDIF_STC			0x50	/* SPDIFTxClk Register */
36 
37 
38 /* SPDIF Configuration register */
39 #define SCR_RXFIFO_CTL_OFFSET		23
40 #define SCR_RXFIFO_CTL_MASK		(1 << SCR_RXFIFO_CTL_OFFSET)
41 #define SCR_RXFIFO_CTL_ZERO		(1 << SCR_RXFIFO_CTL_OFFSET)
42 #define SCR_RXFIFO_OFF_OFFSET		22
43 #define SCR_RXFIFO_OFF_MASK		(1 << SCR_RXFIFO_OFF_OFFSET)
44 #define SCR_RXFIFO_OFF			(1 << SCR_RXFIFO_OFF_OFFSET)
45 #define SCR_RXFIFO_RST_OFFSET		21
46 #define SCR_RXFIFO_RST_MASK		(1 << SCR_RXFIFO_RST_OFFSET)
47 #define SCR_RXFIFO_RST			(1 << SCR_RXFIFO_RST_OFFSET)
48 #define SCR_RXFIFO_FSEL_OFFSET		19
49 #define SCR_RXFIFO_FSEL_MASK		(0x3 << SCR_RXFIFO_FSEL_OFFSET)
50 #define SCR_RXFIFO_FSEL_IF0		(0x0 << SCR_RXFIFO_FSEL_OFFSET)
51 #define SCR_RXFIFO_FSEL_IF4		(0x1 << SCR_RXFIFO_FSEL_OFFSET)
52 #define SCR_RXFIFO_FSEL_IF8		(0x2 << SCR_RXFIFO_FSEL_OFFSET)
53 #define SCR_RXFIFO_FSEL_IF12		(0x3 << SCR_RXFIFO_FSEL_OFFSET)
54 #define SCR_RXFIFO_AUTOSYNC_OFFSET	18
55 #define SCR_RXFIFO_AUTOSYNC_MASK	(1 << SCR_RXFIFO_AUTOSYNC_OFFSET)
56 #define SCR_RXFIFO_AUTOSYNC		(1 << SCR_RXFIFO_AUTOSYNC_OFFSET)
57 #define SCR_TXFIFO_AUTOSYNC_OFFSET	17
58 #define SCR_TXFIFO_AUTOSYNC_MASK	(1 << SCR_TXFIFO_AUTOSYNC_OFFSET)
59 #define SCR_TXFIFO_AUTOSYNC		(1 << SCR_TXFIFO_AUTOSYNC_OFFSET)
60 #define SCR_TXFIFO_FSEL_OFFSET		15
61 #define SCR_TXFIFO_FSEL_MASK		(0x3 << SCR_TXFIFO_FSEL_OFFSET)
62 #define SCR_TXFIFO_FSEL_IF0		(0x0 << SCR_TXFIFO_FSEL_OFFSET)
63 #define SCR_TXFIFO_FSEL_IF4		(0x1 << SCR_TXFIFO_FSEL_OFFSET)
64 #define SCR_TXFIFO_FSEL_IF8		(0x2 << SCR_TXFIFO_FSEL_OFFSET)
65 #define SCR_TXFIFO_FSEL_IF12		(0x3 << SCR_TXFIFO_FSEL_OFFSET)
66 #define SCR_RAW_CAPTURE_MODE		BIT(14)
67 #define SCR_LOW_POWER			(1 << 13)
68 #define SCR_SOFT_RESET			(1 << 12)
69 #define SCR_TXFIFO_CTRL_OFFSET		10
70 #define SCR_TXFIFO_CTRL_MASK		(0x3 << SCR_TXFIFO_CTRL_OFFSET)
71 #define SCR_TXFIFO_CTRL_ZERO		(0x0 << SCR_TXFIFO_CTRL_OFFSET)
72 #define SCR_TXFIFO_CTRL_NORMAL		(0x1 << SCR_TXFIFO_CTRL_OFFSET)
73 #define SCR_TXFIFO_CTRL_ONESAMPLE	(0x2 << SCR_TXFIFO_CTRL_OFFSET)
74 #define SCR_DMA_RX_EN_OFFSET		9
75 #define SCR_DMA_RX_EN_MASK		(1 << SCR_DMA_RX_EN_OFFSET)
76 #define SCR_DMA_RX_EN			(1 << SCR_DMA_RX_EN_OFFSET)
77 #define SCR_DMA_TX_EN_OFFSET		8
78 #define SCR_DMA_TX_EN_MASK		(1 << SCR_DMA_TX_EN_OFFSET)
79 #define SCR_DMA_TX_EN			(1 << SCR_DMA_TX_EN_OFFSET)
80 #define SCR_VAL_OFFSET			5
81 #define SCR_VAL_MASK			(1 << SCR_VAL_OFFSET)
82 #define SCR_VAL_CLEAR			(1 << SCR_VAL_OFFSET)
83 #define SCR_TXSEL_OFFSET		2
84 #define SCR_TXSEL_MASK			(0x7 << SCR_TXSEL_OFFSET)
85 #define SCR_TXSEL_OFF			(0 << SCR_TXSEL_OFFSET)
86 #define SCR_TXSEL_RX			(1 << SCR_TXSEL_OFFSET)
87 #define SCR_TXSEL_NORMAL		(0x5 << SCR_TXSEL_OFFSET)
88 #define SCR_USRC_SEL_OFFSET		0x0
89 #define SCR_USRC_SEL_MASK		(0x3 << SCR_USRC_SEL_OFFSET)
90 #define SCR_USRC_SEL_NONE		(0x0 << SCR_USRC_SEL_OFFSET)
91 #define SCR_USRC_SEL_RECV		(0x1 << SCR_USRC_SEL_OFFSET)
92 #define SCR_USRC_SEL_CHIP		(0x3 << SCR_USRC_SEL_OFFSET)
93 
94 #define SCR_DMA_xX_EN(tx)		(tx ? SCR_DMA_TX_EN : SCR_DMA_RX_EN)
95 
96 /* SPDIF CDText control */
97 #define SRCD_CD_USER_OFFSET		1
98 #define SRCD_CD_USER			(1 << SRCD_CD_USER_OFFSET)
99 
100 /* SPDIF Phase Configuration register */
101 #define SRPC_DPLL_LOCKED		(1 << 6)
102 #define SRPC_CLKSRC_SEL_OFFSET		7
103 #define SRPC_CLKSRC_SEL_MASK		(0xf << SRPC_CLKSRC_SEL_OFFSET)
104 #define SRPC_CLKSRC_SEL_SET(x)		((x << SRPC_CLKSRC_SEL_OFFSET) & SRPC_CLKSRC_SEL_MASK)
105 #define SRPC_CLKSRC_SEL_LOCKED_OFFSET1	5
106 #define SRPC_CLKSRC_SEL_LOCKED_OFFSET2	2
107 #define SRPC_GAINSEL_OFFSET		3
108 #define SRPC_GAINSEL_MASK		(0x7 << SRPC_GAINSEL_OFFSET)
109 #define SRPC_GAINSEL_SET(x)		((x << SRPC_GAINSEL_OFFSET) & SRPC_GAINSEL_MASK)
110 
111 #define SRPC_CLKSRC_MAX			16
112 
113 enum spdif_gainsel {
114 	GAINSEL_MULTI_24 = 0,
115 	GAINSEL_MULTI_16,
116 	GAINSEL_MULTI_12,
117 	GAINSEL_MULTI_8,
118 	GAINSEL_MULTI_6,
119 	GAINSEL_MULTI_4,
120 	GAINSEL_MULTI_3,
121 };
122 #define GAINSEL_MULTI_MAX		(GAINSEL_MULTI_3 + 1)
123 #define SPDIF_DEFAULT_GAINSEL		GAINSEL_MULTI_8
124 
125 /* SPDIF interrupt mask define */
126 #define INT_DPLL_LOCKED			(1 << 20)
127 #define INT_TXFIFO_UNOV			(1 << 19)
128 #define INT_TXFIFO_RESYNC		(1 << 18)
129 #define INT_CNEW			(1 << 17)
130 #define INT_VAL_NOGOOD			(1 << 16)
131 #define INT_SYM_ERR			(1 << 15)
132 #define INT_BIT_ERR			(1 << 14)
133 #define INT_URX_FUL			(1 << 10)
134 #define INT_URX_OV			(1 << 9)
135 #define INT_QRX_FUL			(1 << 8)
136 #define INT_QRX_OV			(1 << 7)
137 #define INT_UQ_SYNC			(1 << 6)
138 #define INT_UQ_ERR			(1 << 5)
139 #define INT_RXFIFO_UNOV			(1 << 4)
140 #define INT_RXFIFO_RESYNC		(1 << 3)
141 #define INT_LOSS_LOCK			(1 << 2)
142 #define INT_TX_EM			(1 << 1)
143 #define INT_RXFIFO_FUL			(1 << 0)
144 
145 /* SPDIF Clock register */
146 #define STC_SYSCLK_DF_OFFSET		11
147 #define STC_SYSCLK_DF_MASK		(0x1ff << STC_SYSCLK_DF_OFFSET)
148 #define STC_SYSCLK_DF(x)		((((x) - 1) << STC_SYSCLK_DF_OFFSET) & STC_SYSCLK_DF_MASK)
149 #define STC_TXCLK_SRC_OFFSET		8
150 #define STC_TXCLK_SRC_MASK		(0x7 << STC_TXCLK_SRC_OFFSET)
151 #define STC_TXCLK_SRC_SET(x)		((x << STC_TXCLK_SRC_OFFSET) & STC_TXCLK_SRC_MASK)
152 #define STC_TXCLK_ALL_EN_OFFSET		7
153 #define STC_TXCLK_ALL_EN_MASK		(1 << STC_TXCLK_ALL_EN_OFFSET)
154 #define STC_TXCLK_ALL_EN		(1 << STC_TXCLK_ALL_EN_OFFSET)
155 #define STC_TXCLK_DF_OFFSET		0
156 #define STC_TXCLK_DF_MASK		(0x7f << STC_TXCLK_DF_OFFSET)
157 #define STC_TXCLK_DF(x)		((((x) - 1) << STC_TXCLK_DF_OFFSET) & STC_TXCLK_DF_MASK)
158 #define STC_TXCLK_SRC_MAX		8
159 
160 #define STC_TXCLK_SPDIF_ROOT		1
161 
162 /* SPDIF tx rate */
163 enum spdif_txrate {
164 	SPDIF_TXRATE_32000 = 0,
165 	SPDIF_TXRATE_44100,
166 	SPDIF_TXRATE_48000,
167 	SPDIF_TXRATE_88200,
168 	SPDIF_TXRATE_96000,
169 	SPDIF_TXRATE_176400,
170 	SPDIF_TXRATE_192000,
171 };
172 #define SPDIF_TXRATE_MAX		(SPDIF_TXRATE_192000 + 1)
173 
174 
175 #define SPDIF_CSTATUS_BYTE		6
176 #define SPDIF_UBITS_SIZE		96
177 #define SPDIF_QSUB_SIZE			(SPDIF_UBITS_SIZE / 8)
178 
179 
180 #define FSL_SPDIF_RATES_PLAYBACK	(SNDRV_PCM_RATE_32000 |	\
181 					 SNDRV_PCM_RATE_44100 |	\
182 					 SNDRV_PCM_RATE_48000 |	\
183 					 SNDRV_PCM_RATE_88200 | \
184 					 SNDRV_PCM_RATE_96000 |	\
185 					 SNDRV_PCM_RATE_176400 | \
186 					 SNDRV_PCM_RATE_192000)
187 
188 #define FSL_SPDIF_RATES_CAPTURE		(SNDRV_PCM_RATE_16000 | \
189 					 SNDRV_PCM_RATE_32000 |	\
190 					 SNDRV_PCM_RATE_44100 | \
191 					 SNDRV_PCM_RATE_48000 |	\
192 					 SNDRV_PCM_RATE_88200 | \
193 					 SNDRV_PCM_RATE_64000 | \
194 					 SNDRV_PCM_RATE_96000 | \
195 					 SNDRV_PCM_RATE_176400 | \
196 					 SNDRV_PCM_RATE_192000)
197 
198 #define FSL_SPDIF_FORMATS_PLAYBACK	(SNDRV_PCM_FMTBIT_S16_LE | \
199 					 SNDRV_PCM_FMTBIT_S20_3LE | \
200 					 SNDRV_PCM_FMTBIT_S24_LE)
201 
202 #define FSL_SPDIF_FORMATS_CAPTURE	(SNDRV_PCM_FMTBIT_S24_LE)
203 
204 #endif /* _FSL_SPDIF_DAI_H */
205