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 /* REMOVE ME */ 15 #define asoc_simple_init_hp simple_util_init_hp 16 #define asoc_simple_init_mic simple_util_init_mic 17 18 #define simple_util_init_hp(card, sjack, prefix) \ 19 simple_util_init_jack(card, sjack, 1, prefix, NULL) 20 #define simple_util_init_mic(card, sjack, prefix) \ 21 simple_util_init_jack(card, sjack, 0, prefix, NULL) 22 23 /* REMOVE ME */ 24 #define asoc_simple_tdm_width_map simple_util_tdm_width_map 25 #define asoc_simple_dai simple_util_dai 26 #define asoc_simple_data simple_util_data 27 #define asoc_simple_jack simple_util_jack 28 #define asoc_simple_priv simple_util_priv 29 30 struct simple_util_tdm_width_map { 31 u8 sample_bits; 32 u8 slot_count; 33 u16 slot_width; 34 }; 35 36 struct simple_util_dai { 37 const char *name; 38 unsigned int sysclk; 39 int clk_direction; 40 int slots; 41 int slot_width; 42 unsigned int tx_slot_mask; 43 unsigned int rx_slot_mask; 44 struct clk *clk; 45 bool clk_fixed; 46 struct simple_util_tdm_width_map *tdm_width_map; 47 int n_tdm_widths; 48 }; 49 50 struct simple_util_data { 51 u32 convert_rate; 52 u32 convert_channels; 53 const char *convert_sample_format; 54 }; 55 56 struct simple_util_jack { 57 struct snd_soc_jack jack; 58 struct snd_soc_jack_pin pin; 59 struct snd_soc_jack_gpio gpio; 60 }; 61 62 struct prop_nums { 63 int cpus; 64 int codecs; 65 int platforms; 66 }; 67 68 struct simple_util_priv { 69 struct snd_soc_card snd_card; 70 struct simple_dai_props { 71 struct simple_util_dai *cpu_dai; 72 struct simple_util_dai *codec_dai; 73 struct simple_util_data adata; 74 struct snd_soc_codec_conf *codec_conf; 75 struct prop_nums num; 76 unsigned int mclk_fs; 77 } *dai_props; 78 struct simple_util_jack hp_jack; 79 struct simple_util_jack mic_jack; 80 struct snd_soc_jack *aux_jacks; 81 struct snd_soc_dai_link *dai_link; 82 struct simple_util_dai *dais; 83 struct snd_soc_dai_link_component *dlcs; 84 struct snd_soc_codec_conf *codec_conf; 85 struct gpio_desc *pa_gpio; 86 const struct snd_soc_ops *ops; 87 unsigned int dpcm_selectable:1; 88 unsigned int force_dpcm:1; 89 }; 90 #define simple_priv_to_card(priv) (&(priv)->snd_card) 91 #define simple_priv_to_props(priv, i) ((priv)->dai_props + (i)) 92 #define simple_priv_to_dev(priv) (simple_priv_to_card(priv)->dev) 93 #define simple_priv_to_link(priv, i) (simple_priv_to_card(priv)->dai_link + (i)) 94 95 #define simple_props_to_dlc_cpu(props, i) ((props)->cpus + i) 96 #define simple_props_to_dlc_codec(props, i) ((props)->codecs + i) 97 #define simple_props_to_dlc_platform(props, i) ((props)->platforms + i) 98 99 #define simple_props_to_dai_cpu(props, i) ((props)->cpu_dai + i) 100 #define simple_props_to_dai_codec(props, i) ((props)->codec_dai + i) 101 #define simple_props_to_codec_conf(props, i) ((props)->codec_conf + i) 102 103 #define for_each_prop_dlc_cpus(props, i, cpu) \ 104 for ((i) = 0; \ 105 ((i) < (props)->num.cpus) && \ 106 ((cpu) = simple_props_to_dlc_cpu(props, i)); \ 107 (i)++) 108 #define for_each_prop_dlc_codecs(props, i, codec) \ 109 for ((i) = 0; \ 110 ((i) < (props)->num.codecs) && \ 111 ((codec) = simple_props_to_dlc_codec(props, i)); \ 112 (i)++) 113 #define for_each_prop_dlc_platforms(props, i, platform) \ 114 for ((i) = 0; \ 115 ((i) < (props)->num.platforms) && \ 116 ((platform) = simple_props_to_dlc_platform(props, i)); \ 117 (i)++) 118 #define for_each_prop_codec_conf(props, i, conf) \ 119 for ((i) = 0; \ 120 ((i) < (props)->num.codecs) && \ 121 (props)->codec_conf && \ 122 ((conf) = simple_props_to_codec_conf(props, i)); \ 123 (i)++) 124 125 #define for_each_prop_dai_cpu(props, i, cpu) \ 126 for ((i) = 0; \ 127 ((i) < (props)->num.cpus) && \ 128 ((cpu) = simple_props_to_dai_cpu(props, i)); \ 129 (i)++) 130 #define for_each_prop_dai_codec(props, i, codec) \ 131 for ((i) = 0; \ 132 ((i) < (props)->num.codecs) && \ 133 ((codec) = simple_props_to_dai_codec(props, i)); \ 134 (i)++) 135 136 #define SNDRV_MAX_LINKS 512 137 138 struct link_info { 139 int link; /* number of link */ 140 int cpu; /* turn for CPU / Codec */ 141 struct prop_nums num[SNDRV_MAX_LINKS]; 142 }; 143 144 /* REMOVE ME */ 145 #define asoc_simple_parse_daifmt simple_util_parse_daifmt 146 #define asoc_simple_parse_tdm_width_map simple_util_parse_tdm_width_map 147 #define asoc_simple_set_dailink_name simple_util_set_dailink_name 148 #define asoc_simple_parse_card_name simple_util_parse_card_name 149 #define asoc_simple_parse_clk simple_util_parse_clk 150 #define asoc_simple_startup simple_util_startup 151 #define asoc_simple_shutdown simple_util_shutdown 152 #define asoc_simple_hw_params simple_util_hw_params 153 #define asoc_simple_dai_init simple_util_dai_init 154 #define asoc_simple_be_hw_params_fixup simple_util_be_hw_params_fixup 155 #define asoc_simple_parse_tdm simple_util_parse_tdm 156 #define asoc_simple_canonicalize_platform simple_util_canonicalize_platform 157 #define asoc_simple_canonicalize_cpu simple_util_canonicalize_cpu 158 #define asoc_simple_clean_reference simple_util_clean_reference 159 #define asoc_simple_parse_convert simple_util_parse_convert 160 #define asoc_simple_is_convert_required simple_util_is_convert_required 161 #define asoc_simple_parse_routing simple_util_parse_routing 162 #define asoc_simple_parse_widgets simple_util_parse_widgets 163 #define asoc_simple_parse_pin_switches simple_util_parse_pin_switches 164 #define asoc_simple_init_jack simple_util_init_jack 165 #define asoc_simple_init_aux_jacks simple_util_init_aux_jacks 166 #define asoc_simple_init_priv simple_util_init_priv 167 #define asoc_simple_remove simple_util_remove 168 #define asoc_simple_debug_info simple_util_debug_info 169 #define asoc_graph_card_probe graph_util_card_probe 170 #define asoc_graph_is_ports0 graph_util_is_ports0 171 #define asoc_graph_parse_dai graph_util_parse_dai 172 173 int simple_util_parse_daifmt(struct device *dev, 174 struct device_node *node, 175 struct device_node *codec, 176 char *prefix, 177 unsigned int *retfmt); 178 int simple_util_parse_tdm_width_map(struct device *dev, struct device_node *np, 179 struct simple_util_dai *dai); 180 181 __printf(3, 4) 182 int simple_util_set_dailink_name(struct device *dev, 183 struct snd_soc_dai_link *dai_link, 184 const char *fmt, ...); 185 int simple_util_parse_card_name(struct snd_soc_card *card, 186 char *prefix); 187 188 int simple_util_parse_clk(struct device *dev, 189 struct device_node *node, 190 struct simple_util_dai *simple_dai, 191 struct snd_soc_dai_link_component *dlc); 192 int simple_util_startup(struct snd_pcm_substream *substream); 193 void simple_util_shutdown(struct snd_pcm_substream *substream); 194 int simple_util_hw_params(struct snd_pcm_substream *substream, 195 struct snd_pcm_hw_params *params); 196 int simple_util_dai_init(struct snd_soc_pcm_runtime *rtd); 197 int simple_util_be_hw_params_fixup(struct snd_soc_pcm_runtime *rtd, 198 struct snd_pcm_hw_params *params); 199 200 #define simple_util_parse_tdm(np, dai) \ 201 snd_soc_of_parse_tdm_slot(np, &(dai)->tx_slot_mask, \ 202 &(dai)->rx_slot_mask, \ 203 &(dai)->slots, \ 204 &(dai)->slot_width); 205 206 void simple_util_canonicalize_platform(struct snd_soc_dai_link_component *platforms, 207 struct snd_soc_dai_link_component *cpus); 208 void simple_util_canonicalize_cpu(struct snd_soc_dai_link_component *cpus, 209 int is_single_links); 210 211 void simple_util_clean_reference(struct snd_soc_card *card); 212 213 void simple_util_parse_convert(struct device_node *np, char *prefix, 214 struct simple_util_data *data); 215 bool simple_util_is_convert_required(const struct simple_util_data *data); 216 217 int simple_util_parse_routing(struct snd_soc_card *card, 218 char *prefix); 219 int simple_util_parse_widgets(struct snd_soc_card *card, 220 char *prefix); 221 int simple_util_parse_pin_switches(struct snd_soc_card *card, 222 char *prefix); 223 224 int simple_util_init_jack(struct snd_soc_card *card, 225 struct simple_util_jack *sjack, 226 int is_hp, char *prefix, char *pin); 227 int simple_util_init_aux_jacks(struct simple_util_priv *priv, 228 char *prefix); 229 int simple_util_init_priv(struct simple_util_priv *priv, 230 struct link_info *li); 231 int simple_util_remove(struct platform_device *pdev); 232 233 int graph_util_card_probe(struct snd_soc_card *card); 234 int graph_util_is_ports0(struct device_node *port); 235 int graph_util_parse_dai(struct device *dev, struct device_node *ep, 236 struct snd_soc_dai_link_component *dlc, int *is_single_link); 237 238 #ifdef DEBUG 239 static inline void simple_util_debug_dai(struct simple_util_priv *priv, 240 char *name, 241 struct simple_util_dai *dai) 242 { 243 struct device *dev = simple_priv_to_dev(priv); 244 245 /* dai might be NULL */ 246 if (!dai) 247 return; 248 249 if (dai->name) 250 dev_dbg(dev, "%s dai name = %s\n", 251 name, dai->name); 252 253 if (dai->slots) 254 dev_dbg(dev, "%s slots = %d\n", name, dai->slots); 255 if (dai->slot_width) 256 dev_dbg(dev, "%s slot width = %d\n", name, dai->slot_width); 257 if (dai->tx_slot_mask) 258 dev_dbg(dev, "%s tx slot mask = %d\n", name, dai->tx_slot_mask); 259 if (dai->rx_slot_mask) 260 dev_dbg(dev, "%s rx slot mask = %d\n", name, dai->rx_slot_mask); 261 if (dai->clk) 262 dev_dbg(dev, "%s clk %luHz\n", name, clk_get_rate(dai->clk)); 263 if (dai->sysclk) 264 dev_dbg(dev, "%s sysclk = %dHz\n", 265 name, dai->sysclk); 266 if (dai->clk || dai->sysclk) 267 dev_dbg(dev, "%s direction = %s\n", 268 name, dai->clk_direction ? "OUT" : "IN"); 269 } 270 271 static inline void simple_util_debug_info(struct simple_util_priv *priv) 272 { 273 struct snd_soc_card *card = simple_priv_to_card(priv); 274 struct device *dev = simple_priv_to_dev(priv); 275 276 int i; 277 278 if (card->name) 279 dev_dbg(dev, "Card Name: %s\n", card->name); 280 281 for (i = 0; i < card->num_links; i++) { 282 struct simple_dai_props *props = simple_priv_to_props(priv, i); 283 struct snd_soc_dai_link *link = simple_priv_to_link(priv, i); 284 struct simple_util_dai *dai; 285 struct snd_soc_codec_conf *cnf; 286 int j; 287 288 dev_dbg(dev, "DAI%d\n", i); 289 290 dev_dbg(dev, "cpu num = %d\n", link->num_cpus); 291 for_each_prop_dai_cpu(props, j, dai) 292 simple_util_debug_dai(priv, "cpu", dai); 293 dev_dbg(dev, "codec num = %d\n", link->num_codecs); 294 for_each_prop_dai_codec(props, j, dai) 295 simple_util_debug_dai(priv, "codec", dai); 296 297 if (link->name) 298 dev_dbg(dev, "dai name = %s\n", link->name); 299 if (link->dai_fmt) 300 dev_dbg(dev, "dai format = %04x\n", link->dai_fmt); 301 if (props->adata.convert_rate) 302 dev_dbg(dev, "convert_rate = %d\n", props->adata.convert_rate); 303 if (props->adata.convert_channels) 304 dev_dbg(dev, "convert_channels = %d\n", props->adata.convert_channels); 305 for_each_prop_codec_conf(props, j, cnf) 306 if (cnf->name_prefix) 307 dev_dbg(dev, "name prefix = %s\n", cnf->name_prefix); 308 if (props->mclk_fs) 309 dev_dbg(dev, "mclk-fs = %d\n", props->mclk_fs); 310 } 311 } 312 #else 313 #define simple_util_debug_info(priv) 314 #endif /* DEBUG */ 315 316 #endif /* __SIMPLE_CARD_UTILS_H */ 317