include/sound/simple_card_utils.h

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