1 /* SPDX-License-Identifier: GPL-2.0
2  *
3  * simple_card_utils.h
4  *
5  * Copyright (c) 2016 Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
6  */
7 
8 #ifndef __SIMPLE_CARD_UTILS_H
9 #define __SIMPLE_CARD_UTILS_H
10 
11 #include <linux/clk.h>
12 #include <sound/soc.h>
13 
14 #define asoc_simple_init_hp(card, sjack, prefix) \
15 	asoc_simple_init_jack(card, sjack, 1, prefix, NULL)
16 #define asoc_simple_init_mic(card, sjack, prefix) \
17 	asoc_simple_init_jack(card, sjack, 0, prefix, NULL)
18 
19 struct asoc_simple_dai {
20 	const char *name;
21 	unsigned int sysclk;
22 	int clk_direction;
23 	int slots;
24 	int slot_width;
25 	unsigned int tx_slot_mask;
26 	unsigned int rx_slot_mask;
27 	struct clk *clk;
28 };
29 
30 struct asoc_simple_data {
31 	u32 convert_rate;
32 	u32 convert_channels;
33 };
34 
35 struct asoc_simple_jack {
36 	struct snd_soc_jack jack;
37 	struct snd_soc_jack_pin pin;
38 	struct snd_soc_jack_gpio gpio;
39 };
40 
41 struct prop_nums {
42 	int cpus;
43 	int codecs;
44 	int platforms;
45 };
46 
47 struct asoc_simple_priv {
48 	struct snd_soc_card snd_card;
49 	struct simple_dai_props {
50 		struct asoc_simple_dai *cpu_dai;
51 		struct asoc_simple_dai *codec_dai;
52 		struct snd_soc_dai_link_component *cpus;
53 		struct snd_soc_dai_link_component *codecs;
54 		struct snd_soc_dai_link_component *platforms;
55 		struct asoc_simple_data adata;
56 		struct snd_soc_codec_conf *codec_conf;
57 		struct prop_nums num;
58 		unsigned int mclk_fs;
59 	} *dai_props;
60 	struct asoc_simple_jack hp_jack;
61 	struct asoc_simple_jack mic_jack;
62 	struct snd_soc_dai_link *dai_link;
63 	struct asoc_simple_dai *dais;
64 	struct snd_soc_dai_link_component *dlcs;
65 	struct snd_soc_dai_link_component dummy;
66 	struct snd_soc_codec_conf *codec_conf;
67 	struct gpio_desc *pa_gpio;
68 	const struct snd_soc_ops *ops;
69 	unsigned int dpcm_selectable:1;
70 	unsigned int force_dpcm:1;
71 };
72 #define simple_priv_to_card(priv)	(&(priv)->snd_card)
73 #define simple_priv_to_props(priv, i)	((priv)->dai_props + (i))
74 #define simple_priv_to_dev(priv)	(simple_priv_to_card(priv)->dev)
75 #define simple_priv_to_link(priv, i)	(simple_priv_to_card(priv)->dai_link + (i))
76 
77 #define simple_props_to_dlc_cpu(props, i)	((props)->cpus + i)
78 #define simple_props_to_dlc_codec(props, i)	((props)->codecs + i)
79 #define simple_props_to_dlc_platform(props, i)	((props)->platforms + i)
80 
81 #define simple_props_to_dai_cpu(props, i)	((props)->cpu_dai + i)
82 #define simple_props_to_dai_codec(props, i)	((props)->codec_dai + i)
83 #define simple_props_to_codec_conf(props, i)	((props)->codec_conf + i)
84 
85 #define for_each_prop_dlc_cpus(props, i, cpu)				\
86 	for ((i) = 0;							\
87 	     ((i) < (props)->num.cpus) &&				\
88 		     ((cpu) = simple_props_to_dlc_cpu(props, i));	\
89 	     (i)++)
90 #define for_each_prop_dlc_codecs(props, i, codec)			\
91 	for ((i) = 0;							\
92 	     ((i) < (props)->num.codecs) &&				\
93 		     ((codec) = simple_props_to_dlc_codec(props, i));	\
94 	     (i)++)
95 #define for_each_prop_dlc_platforms(props, i, platform)			\
96 	for ((i) = 0;							\
97 	     ((i) < (props)->num.platforms) &&				\
98 		     ((platform) = simple_props_to_dlc_platform(props, i)); \
99 	     (i)++)
100 #define for_each_prop_codec_conf(props, i, conf)			\
101 	for ((i) = 0;							\
102 	     ((i) < (props)->num.codecs) &&				\
103 		     (props)->codec_conf &&				\
104 		     ((conf) = simple_props_to_codec_conf(props, i));	\
105 	     (i)++)
106 
107 #define for_each_prop_dai_cpu(props, i, cpu)				\
108 	for ((i) = 0;							\
109 	     ((i) < (props)->num.cpus) &&				\
110 		     ((cpu) = simple_props_to_dai_cpu(props, i));	\
111 	     (i)++)
112 #define for_each_prop_dai_codec(props, i, codec)			\
113 	for ((i) = 0;							\
114 	     ((i) < (props)->num.codecs) &&				\
115 		     ((codec) = simple_props_to_dai_codec(props, i));	\
116 	     (i)++)
117 
118 #define SNDRV_MAX_LINKS 128
119 
120 struct link_info {
121 	int link; /* number of link */
122 	int cpu;  /* turn for CPU / Codec */
123 	struct prop_nums num[SNDRV_MAX_LINKS];
124 };
125 
126 int asoc_simple_parse_daifmt(struct device *dev,
127 			     struct device_node *node,
128 			     struct device_node *codec,
129 			     char *prefix,
130 			     unsigned int *retfmt);
131 __printf(3, 4)
132 int asoc_simple_set_dailink_name(struct device *dev,
133 				 struct snd_soc_dai_link *dai_link,
134 				 const char *fmt, ...);
135 int asoc_simple_parse_card_name(struct snd_soc_card *card,
136 				char *prefix);
137 
138 int asoc_simple_parse_clk(struct device *dev,
139 			  struct device_node *node,
140 			  struct asoc_simple_dai *simple_dai,
141 			  struct snd_soc_dai_link_component *dlc);
142 int asoc_simple_startup(struct snd_pcm_substream *substream);
143 void asoc_simple_shutdown(struct snd_pcm_substream *substream);
144 int asoc_simple_hw_params(struct snd_pcm_substream *substream,
145 			  struct snd_pcm_hw_params *params);
146 int asoc_simple_dai_init(struct snd_soc_pcm_runtime *rtd);
147 int asoc_simple_be_hw_params_fixup(struct snd_soc_pcm_runtime *rtd,
148 				   struct snd_pcm_hw_params *params);
149 
150 #define asoc_simple_parse_tdm(np, dai)			\
151 	snd_soc_of_parse_tdm_slot(np,	&(dai)->tx_slot_mask,	\
152 					&(dai)->rx_slot_mask,	\
153 					&(dai)->slots,		\
154 					&(dai)->slot_width);
155 
156 void asoc_simple_canonicalize_platform(struct snd_soc_dai_link_component *platforms,
157 				       struct snd_soc_dai_link_component *cpus);
158 void asoc_simple_canonicalize_cpu(struct snd_soc_dai_link_component *cpus,
159 				  int is_single_links);
160 
161 int asoc_simple_clean_reference(struct snd_soc_card *card);
162 
163 void asoc_simple_convert_fixup(struct asoc_simple_data *data,
164 				      struct snd_pcm_hw_params *params);
165 void asoc_simple_parse_convert(struct device_node *np, char *prefix,
166 			       struct asoc_simple_data *data);
167 
168 int asoc_simple_parse_routing(struct snd_soc_card *card,
169 				      char *prefix);
170 int asoc_simple_parse_widgets(struct snd_soc_card *card,
171 				      char *prefix);
172 int asoc_simple_parse_pin_switches(struct snd_soc_card *card,
173 				   char *prefix);
174 
175 int asoc_simple_init_jack(struct snd_soc_card *card,
176 			       struct asoc_simple_jack *sjack,
177 			       int is_hp, char *prefix, char *pin);
178 int asoc_simple_init_priv(struct asoc_simple_priv *priv,
179 			       struct link_info *li);
180 int asoc_simple_remove(struct platform_device *pdev);
181 
182 int asoc_graph_card_probe(struct snd_soc_card *card);
183 
184 #ifdef DEBUG
185 static inline void asoc_simple_debug_dai(struct asoc_simple_priv *priv,
186 					 char *name,
187 					 struct asoc_simple_dai *dai)
188 {
189 	struct device *dev = simple_priv_to_dev(priv);
190 
191 	/* dai might be NULL */
192 	if (!dai)
193 		return;
194 
195 	if (dai->name)
196 		dev_dbg(dev, "%s dai name = %s\n",
197 			name, dai->name);
198 
199 	if (dai->slots)
200 		dev_dbg(dev, "%s slots = %d\n", name, dai->slots);
201 	if (dai->slot_width)
202 		dev_dbg(dev, "%s slot width = %d\n", name, dai->slot_width);
203 	if (dai->tx_slot_mask)
204 		dev_dbg(dev, "%s tx slot mask = %d\n", name, dai->tx_slot_mask);
205 	if (dai->rx_slot_mask)
206 		dev_dbg(dev, "%s rx slot mask = %d\n", name, dai->rx_slot_mask);
207 	if (dai->clk)
208 		dev_dbg(dev, "%s clk %luHz\n", name, clk_get_rate(dai->clk));
209 	if (dai->sysclk)
210 		dev_dbg(dev, "%s sysclk = %dHz\n",
211 			name, dai->sysclk);
212 	if (dai->clk || dai->sysclk)
213 		dev_dbg(dev, "%s direction = %s\n",
214 			name, dai->clk_direction ? "OUT" : "IN");
215 }
216 
217 static inline void asoc_simple_debug_info(struct asoc_simple_priv *priv)
218 {
219 	struct snd_soc_card *card = simple_priv_to_card(priv);
220 	struct device *dev = simple_priv_to_dev(priv);
221 
222 	int i;
223 
224 	if (card->name)
225 		dev_dbg(dev, "Card Name: %s\n", card->name);
226 
227 	for (i = 0; i < card->num_links; i++) {
228 		struct simple_dai_props *props = simple_priv_to_props(priv, i);
229 		struct snd_soc_dai_link *link = simple_priv_to_link(priv, i);
230 		struct asoc_simple_dai *dai;
231 		struct snd_soc_codec_conf *cnf;
232 		int j;
233 
234 		dev_dbg(dev, "DAI%d\n", i);
235 
236 		dev_dbg(dev, "cpu num = %d\n", link->num_cpus);
237 		for_each_prop_dai_cpu(props, j, dai)
238 			asoc_simple_debug_dai(priv, "cpu", dai);
239 		dev_dbg(dev, "codec num = %d\n", link->num_codecs);
240 		for_each_prop_dai_codec(props, j, dai)
241 			asoc_simple_debug_dai(priv, "codec", dai);
242 
243 		if (link->name)
244 			dev_dbg(dev, "dai name = %s\n", link->name);
245 		if (link->dai_fmt)
246 			dev_dbg(dev, "dai format = %04x\n", link->dai_fmt);
247 		if (props->adata.convert_rate)
248 			dev_dbg(dev, "convert_rate = %d\n", props->adata.convert_rate);
249 		if (props->adata.convert_channels)
250 			dev_dbg(dev, "convert_channels = %d\n", props->adata.convert_channels);
251 		for_each_prop_codec_conf(props, j, cnf)
252 			if (cnf->name_prefix)
253 				dev_dbg(dev, "name prefix = %s\n", cnf->name_prefix);
254 		if (props->mclk_fs)
255 			dev_dbg(dev, "mclk-fs = %d\n", props->mclk_fs);
256 	}
257 }
258 #else
259 #define  asoc_simple_debug_info(priv)
260 #endif /* DEBUG */
261 
262 #endif /* __SIMPLE_CARD_UTILS_H */
263