include/sound/soc-component.h

   1 /* SPDX-License-Identifier: GPL-2.0
   2  *
   3  * soc-component.h
   4  *
   5  * Copyright (C) 2019 Renesas Electronics Corp.
   6  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
   7  */
   8 #ifndef __SOC_COMPONENT_H
   9 #define __SOC_COMPONENT_H
  10
  11 #include <sound/soc.h>
  12
  13 /*
  14  * Component probe and remove ordering levels for components with runtime
  15  * dependencies.
  16  */
  17 #define SND_SOC_COMP_ORDER_FIRST        -2
  18 #define SND_SOC_COMP_ORDER_EARLY        -1
  19 #define SND_SOC_COMP_ORDER_NORMAL        0
  20 #define SND_SOC_COMP_ORDER_LATE          1
  21 #define SND_SOC_COMP_ORDER_LAST          2
  22
  23 #define for_each_comp_order(order)              \
  24         for (order  = SND_SOC_COMP_ORDER_FIRST; \
  25              order <= SND_SOC_COMP_ORDER_LAST;  \
  26              order++)
  27
  28 /* component interface */
  29 struct snd_compress_ops {
  30         int (*open)(struct snd_soc_component *component,
  31                     struct snd_compr_stream *stream);
  32         int (*free)(struct snd_soc_component *component,
  33                     struct snd_compr_stream *stream);
  34         int (*set_params)(struct snd_soc_component *component,
  35                           struct snd_compr_stream *stream,
  36                           struct snd_compr_params *params);
  37         int (*get_params)(struct snd_soc_component *component,
  38                           struct snd_compr_stream *stream,
  39                           struct snd_codec *params);
  40         int (*set_metadata)(struct snd_soc_component *component,
  41                             struct snd_compr_stream *stream,
  42                             struct snd_compr_metadata *metadata);
  43         int (*get_metadata)(struct snd_soc_component *component,
  44                             struct snd_compr_stream *stream,
  45                             struct snd_compr_metadata *metadata);
  46         int (*trigger)(struct snd_soc_component *component,
  47                        struct snd_compr_stream *stream, int cmd);
  48         int (*pointer)(struct snd_soc_component *component,
  49                        struct snd_compr_stream *stream,
  50                        struct snd_compr_tstamp *tstamp);
  51         int (*copy)(struct snd_soc_component *component,
  52                     struct snd_compr_stream *stream, char __user *buf,
  53                     size_t count);
  54         int (*mmap)(struct snd_soc_component *component,
  55                     struct snd_compr_stream *stream,
  56                     struct vm_area_struct *vma);
  57         int (*ack)(struct snd_soc_component *component,
  58                    struct snd_compr_stream *stream, size_t bytes);
  59         int (*get_caps)(struct snd_soc_component *component,
  60                         struct snd_compr_stream *stream,
  61                         struct snd_compr_caps *caps);
  62         int (*get_codec_caps)(struct snd_soc_component *component,
  63                               struct snd_compr_stream *stream,
  64                               struct snd_compr_codec_caps *codec);
  65 };
  66
  67 struct snd_soc_component_driver {
  68         const char *name;
  69
  70         /* Default control and setup, added after probe() is run */
  71         const struct snd_kcontrol_new *controls;
  72         unsigned int num_controls;
  73         const struct snd_soc_dapm_widget *dapm_widgets;
  74         unsigned int num_dapm_widgets;
  75         const struct snd_soc_dapm_route *dapm_routes;
  76         unsigned int num_dapm_routes;
  77
  78         int (*probe)(struct snd_soc_component *component);
  79         void (*remove)(struct snd_soc_component *component);
  80         int (*suspend)(struct snd_soc_component *component);
  81         int (*resume)(struct snd_soc_component *component);
  82
  83         unsigned int (*read)(struct snd_soc_component *component,
  84                              unsigned int reg);
  85         int (*write)(struct snd_soc_component *component,
  86                      unsigned int reg, unsigned int val);
  87
  88         /* pcm creation and destruction */
  89         int (*pcm_construct)(struct snd_soc_component *component,
  90                              struct snd_soc_pcm_runtime *rtd);
  91         void (*pcm_destruct)(struct snd_soc_component *component,
  92                              struct snd_pcm *pcm);
  93
  94         /* component wide operations */
  95         int (*set_sysclk)(struct snd_soc_component *component,
  96                           int clk_id, int source, unsigned int freq, int dir);
  97         int (*set_pll)(struct snd_soc_component *component, int pll_id,
  98                        int source, unsigned int freq_in, unsigned int freq_out);
  99         int (*set_jack)(struct snd_soc_component *component,
 100                         struct snd_soc_jack *jack,  void *data);
 101
 102         /* DT */
 103         int (*of_xlate_dai_name)(struct snd_soc_component *component,
 104                                  struct of_phandle_args *args,
 105                                  const char **dai_name);
 106         int (*of_xlate_dai_id)(struct snd_soc_component *comment,
 107                                struct device_node *endpoint);
 108         void (*seq_notifier)(struct snd_soc_component *component,
 109                              enum snd_soc_dapm_type type, int subseq);
 110         int (*stream_event)(struct snd_soc_component *component, int event);
 111         int (*set_bias_level)(struct snd_soc_component *component,
 112                               enum snd_soc_bias_level level);
 113
 114         int (*open)(struct snd_soc_component *component,
 115                     struct snd_pcm_substream *substream);
 116         int (*close)(struct snd_soc_component *component,
 117                      struct snd_pcm_substream *substream);
 118         int (*ioctl)(struct snd_soc_component *component,
 119                      struct snd_pcm_substream *substream,
 120                      unsigned int cmd, void *arg);
 121         int (*hw_params)(struct snd_soc_component *component,
 122                          struct snd_pcm_substream *substream,
 123                          struct snd_pcm_hw_params *params);
 124         int (*hw_free)(struct snd_soc_component *component,
 125                        struct snd_pcm_substream *substream);
 126         int (*prepare)(struct snd_soc_component *component,
 127                        struct snd_pcm_substream *substream);
 128         int (*trigger)(struct snd_soc_component *component,
 129                        struct snd_pcm_substream *substream, int cmd);
 130         int (*sync_stop)(struct snd_soc_component *component,
 131                          struct snd_pcm_substream *substream);
 132         snd_pcm_uframes_t (*pointer)(struct snd_soc_component *component,
 133                                      struct snd_pcm_substream *substream);
 134         int (*get_time_info)(struct snd_soc_component *component,
 135                 struct snd_pcm_substream *substream, struct timespec64 *system_ts,
 136                 struct timespec64 *audio_ts,
 137                 struct snd_pcm_audio_tstamp_config *audio_tstamp_config,
 138                 struct snd_pcm_audio_tstamp_report *audio_tstamp_report);
 139         int (*copy_user)(struct snd_soc_component *component,
 140                          struct snd_pcm_substream *substream, int channel,
 141                          unsigned long pos, void __user *buf,
 142                          unsigned long bytes);
 143         struct page *(*page)(struct snd_soc_component *component,
 144                              struct snd_pcm_substream *substream,
 145                              unsigned long offset);
 146         int (*mmap)(struct snd_soc_component *component,
 147                     struct snd_pcm_substream *substream,
 148                     struct vm_area_struct *vma);
 149
 150         const struct snd_compress_ops *compress_ops;
 151
 152         /* probe ordering - for components with runtime dependencies */
 153         int probe_order;
 154         int remove_order;
 155
 156         /*
 157          * signal if the module handling the component should not be removed
 158          * if a pcm is open. Setting this would prevent the module
 159          * refcount being incremented in probe() but allow it be incremented
 160          * when a pcm is opened and decremented when it is closed.
 161          */
 162         unsigned int module_get_upon_open:1;
 163
 164         /* bits */
 165         unsigned int idle_bias_on:1;
 166         unsigned int suspend_bias_off:1;
 167         unsigned int use_pmdown_time:1; /* care pmdown_time at stop */
 168         unsigned int endianness:1;
 169         unsigned int non_legacy_dai_naming:1;
 170
 171         /* this component uses topology and ignore machine driver FEs */
 172         const char *ignore_machine;
 173         const char *topology_name_prefix;
 174         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
 175                                   struct snd_pcm_hw_params *params);
 176         bool use_dai_pcm_id;    /* use DAI link PCM ID as PCM device number */
 177         int be_pcm_base;        /* base device ID for all BE PCMs */
 178 };
 179
 180 struct snd_soc_component {
 181         const char *name;
 182         int id;
 183         const char *name_prefix;
 184         struct device *dev;
 185         struct snd_soc_card *card;
 186
 187         unsigned int active;
 188
 189         unsigned int suspended:1; /* is in suspend PM state */
 190
 191         struct list_head list;
 192         struct list_head card_aux_list; /* for auxiliary bound components */
 193         struct list_head card_list;
 194
 195         const struct snd_soc_component_driver *driver;
 196
 197         struct list_head dai_list;
 198         int num_dai;
 199
 200         struct regmap *regmap;
 201         int val_bytes;
 202
 203         struct mutex io_mutex;
 204
 205         /* attached dynamic objects */
 206         struct list_head dobj_list;
 207
 208         /*
 209          * DO NOT use any of the fields below in drivers, they are temporary and
 210          * are going to be removed again soon. If you use them in driver code
 211          * the driver will be marked as BROKEN when these fields are removed.
 212          */
 213
 214         /* Don't use these, use snd_soc_component_get_dapm() */
 215         struct snd_soc_dapm_context dapm;
 216
 217         /* machine specific init */
 218         int (*init)(struct snd_soc_component *component);
 219
 220         /* function mark */
 221         struct snd_pcm_substream *mark_module;
 222         struct snd_pcm_substream *mark_open;
 223         struct snd_pcm_substream *mark_hw_params;
 224         struct snd_pcm_substream *mark_trigger;
 225         struct snd_compr_stream  *mark_compr_open;
 226         void *mark_pm;
 227
 228 #ifdef CONFIG_DEBUG_FS
 229         struct dentry *debugfs_root;
 230         const char *debugfs_prefix;
 231 #endif
 232 };
 233
 234 #define for_each_component_dais(component, dai)\
 235         list_for_each_entry(dai, &(component)->dai_list, list)
 236 #define for_each_component_dais_safe(component, dai, _dai)\
 237         list_for_each_entry_safe(dai, _dai, &(component)->dai_list, list)
 238
 239 /**
 240  * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
 241  *  embedded in
 242  * @dapm: The DAPM context to cast to the component
 243  *
 244  * This function must only be used on DAPM contexts that are known to be part of
 245  * a component (e.g. in a component driver). Otherwise the behavior is
 246  * undefined.
 247  */
 248 static inline struct snd_soc_component *snd_soc_dapm_to_component(
 249         struct snd_soc_dapm_context *dapm)
 250 {
 251         return container_of(dapm, struct snd_soc_component, dapm);
 252 }
 253
 254 /**
 255  * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
 256  *  component
 257  * @component: The component for which to get the DAPM context
 258  */
 259 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
 260         struct snd_soc_component *component)
 261 {
 262         return &component->dapm;
 263 }
 264
 265 /**
 266  * snd_soc_component_init_bias_level() - Initialize COMPONENT DAPM bias level
 267  * @component: The COMPONENT for which to initialize the DAPM bias level
 268  * @level: The DAPM level to initialize to
 269  *
 270  * Initializes the COMPONENT DAPM bias level. See snd_soc_dapm_init_bias_level()
 271  */
 272 static inline void
 273 snd_soc_component_init_bias_level(struct snd_soc_component *component,
 274                                   enum snd_soc_bias_level level)
 275 {
 276         snd_soc_dapm_init_bias_level(
 277                 snd_soc_component_get_dapm(component), level);
 278 }
 279
 280 /**
 281  * snd_soc_component_get_bias_level() - Get current COMPONENT DAPM bias level
 282  * @component: The COMPONENT for which to get the DAPM bias level
 283  *
 284  * Returns: The current DAPM bias level of the COMPONENT.
 285  */
 286 static inline enum snd_soc_bias_level
 287 snd_soc_component_get_bias_level(struct snd_soc_component *component)
 288 {
 289         return snd_soc_dapm_get_bias_level(
 290                 snd_soc_component_get_dapm(component));
 291 }
 292
 293 /**
 294  * snd_soc_component_force_bias_level() - Set the COMPONENT DAPM bias level
 295  * @component: The COMPONENT for which to set the level
 296  * @level: The level to set to
 297  *
 298  * Forces the COMPONENT bias level to a specific state. See
 299  * snd_soc_dapm_force_bias_level().
 300  */
 301 static inline int
 302 snd_soc_component_force_bias_level(struct snd_soc_component *component,
 303                                    enum snd_soc_bias_level level)
 304 {
 305         return snd_soc_dapm_force_bias_level(
 306                 snd_soc_component_get_dapm(component),
 307                 level);
 308 }
 309
 310 /**
 311  * snd_soc_dapm_kcontrol_component() - Returns the component associated to a
 312  * kcontrol
 313  * @kcontrol: The kcontrol
 314  *
 315  * This function must only be used on DAPM contexts that are known to be part of
 316  * a COMPONENT (e.g. in a COMPONENT driver). Otherwise the behavior is undefined
 317  */
 318 static inline struct snd_soc_component *snd_soc_dapm_kcontrol_component(
 319         struct snd_kcontrol *kcontrol)
 320 {
 321         return snd_soc_dapm_to_component(snd_soc_dapm_kcontrol_dapm(kcontrol));
 322 }
 323
 324 /**
 325  * snd_soc_component_cache_sync() - Sync the register cache with the hardware
 326  * @component: COMPONENT to sync
 327  *
 328  * Note: This function will call regcache_sync()
 329  */
 330 static inline int snd_soc_component_cache_sync(
 331         struct snd_soc_component *component)
 332 {
 333         return regcache_sync(component->regmap);
 334 }
 335
 336 void snd_soc_component_set_aux(struct snd_soc_component *component,
 337                                struct snd_soc_aux_dev *aux);
 338 int snd_soc_component_init(struct snd_soc_component *component);
 339
 340 /* component IO */
 341 unsigned int snd_soc_component_read(struct snd_soc_component *component,
 342                                       unsigned int reg);
 343 int snd_soc_component_write(struct snd_soc_component *component,
 344                             unsigned int reg, unsigned int val);
 345 int snd_soc_component_update_bits(struct snd_soc_component *component,
 346                                   unsigned int reg, unsigned int mask,
 347                                   unsigned int val);
 348 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
 349                                         unsigned int reg, unsigned int mask,
 350                                         unsigned int val);
 351 void snd_soc_component_async_complete(struct snd_soc_component *component);
 352 int snd_soc_component_test_bits(struct snd_soc_component *component,
 353                                 unsigned int reg, unsigned int mask,
 354                                 unsigned int value);
 355
 356 /* component wide operations */
 357 int snd_soc_component_set_sysclk(struct snd_soc_component *component,
 358                                  int clk_id, int source,
 359                                  unsigned int freq, int dir);
 360 int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id,
 361                               int source, unsigned int freq_in,
 362                               unsigned int freq_out);
 363 int snd_soc_component_set_jack(struct snd_soc_component *component,
 364                                struct snd_soc_jack *jack, void *data);
 365
 366 void snd_soc_component_seq_notifier(struct snd_soc_component *component,
 367                                     enum snd_soc_dapm_type type, int subseq);
 368 int snd_soc_component_stream_event(struct snd_soc_component *component,
 369                                    int event);
 370 int snd_soc_component_set_bias_level(struct snd_soc_component *component,
 371                                      enum snd_soc_bias_level level);
 372
 373 void snd_soc_component_setup_regmap(struct snd_soc_component *component);
 374 #ifdef CONFIG_REGMAP
 375 void snd_soc_component_init_regmap(struct snd_soc_component *component,
 376                                    struct regmap *regmap);
 377 void snd_soc_component_exit_regmap(struct snd_soc_component *component);
 378 #endif
 379
 380 #define snd_soc_component_module_get_when_probe(component)\
 381         snd_soc_component_module_get(component, NULL, 0)
 382 #define snd_soc_component_module_get_when_open(component, substream)    \
 383         snd_soc_component_module_get(component, substream, 1)
 384 int snd_soc_component_module_get(struct snd_soc_component *component,
 385                                  struct snd_pcm_substream *substream,
 386                                  int upon_open);
 387 #define snd_soc_component_module_put_when_remove(component)     \
 388         snd_soc_component_module_put(component, NULL, 0, 0)
 389 #define snd_soc_component_module_put_when_close(component, substream, rollback) \
 390         snd_soc_component_module_put(component, substream, 1, rollback)
 391 void snd_soc_component_module_put(struct snd_soc_component *component,
 392                                   struct snd_pcm_substream *substream,
 393                                   int upon_open, int rollback);
 394
 395 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
 396                                                  void *data)
 397 {
 398         dev_set_drvdata(c->dev, data);
 399 }
 400
 401 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
 402 {
 403         return dev_get_drvdata(c->dev);
 404 }
 405
 406 static inline unsigned int
 407 snd_soc_component_active(struct snd_soc_component *component)
 408 {
 409         return component->active;
 410 }
 411
 412 /* component pin */
 413 int snd_soc_component_enable_pin(struct snd_soc_component *component,
 414                                  const char *pin);
 415 int snd_soc_component_enable_pin_unlocked(struct snd_soc_component *component,
 416                                           const char *pin);
 417 int snd_soc_component_disable_pin(struct snd_soc_component *component,
 418                                   const char *pin);
 419 int snd_soc_component_disable_pin_unlocked(struct snd_soc_component *component,
 420                                            const char *pin);
 421 int snd_soc_component_nc_pin(struct snd_soc_component *component,
 422                              const char *pin);
 423 int snd_soc_component_nc_pin_unlocked(struct snd_soc_component *component,
 424                                       const char *pin);
 425 int snd_soc_component_get_pin_status(struct snd_soc_component *component,
 426                                      const char *pin);
 427 int snd_soc_component_force_enable_pin(struct snd_soc_component *component,
 428                                        const char *pin);
 429 int snd_soc_component_force_enable_pin_unlocked(
 430         struct snd_soc_component *component,
 431         const char *pin);
 432
 433 /* component driver ops */
 434 int snd_soc_component_open(struct snd_soc_component *component,
 435                            struct snd_pcm_substream *substream);
 436 int snd_soc_component_close(struct snd_soc_component *component,
 437                             struct snd_pcm_substream *substream,
 438                             int rollback);
 439 void snd_soc_component_suspend(struct snd_soc_component *component);
 440 void snd_soc_component_resume(struct snd_soc_component *component);
 441 int snd_soc_component_is_suspended(struct snd_soc_component *component);
 442 int snd_soc_component_probe(struct snd_soc_component *component);
 443 void snd_soc_component_remove(struct snd_soc_component *component);
 444 int snd_soc_component_of_xlate_dai_id(struct snd_soc_component *component,
 445                                       struct device_node *ep);
 446 int snd_soc_component_of_xlate_dai_name(struct snd_soc_component *component,
 447                                         struct of_phandle_args *args,
 448                                         const char **dai_name);
 449 int snd_soc_component_compr_open(struct snd_compr_stream *cstream);
 450 void snd_soc_component_compr_free(struct snd_compr_stream *cstream,
 451                                   int rollback);
 452 int snd_soc_component_compr_trigger(struct snd_compr_stream *cstream, int cmd);
 453 int snd_soc_component_compr_set_params(struct snd_compr_stream *cstream,
 454                                        struct snd_compr_params *params);
 455 int snd_soc_component_compr_get_params(struct snd_compr_stream *cstream,
 456                                        struct snd_codec *params);
 457 int snd_soc_component_compr_get_caps(struct snd_compr_stream *cstream,
 458                                      struct snd_compr_caps *caps);
 459 int snd_soc_component_compr_get_codec_caps(struct snd_compr_stream *cstream,
 460                                            struct snd_compr_codec_caps *codec);
 461 int snd_soc_component_compr_ack(struct snd_compr_stream *cstream, size_t bytes);
 462 int snd_soc_component_compr_pointer(struct snd_compr_stream *cstream,
 463                                     struct snd_compr_tstamp *tstamp);
 464 int snd_soc_component_compr_copy(struct snd_compr_stream *cstream,
 465                                  char __user *buf, size_t count);
 466 int snd_soc_component_compr_set_metadata(struct snd_compr_stream *cstream,
 467                                          struct snd_compr_metadata *metadata);
 468 int snd_soc_component_compr_get_metadata(struct snd_compr_stream *cstream,
 469                                          struct snd_compr_metadata *metadata);
 470
 471 int snd_soc_pcm_component_pointer(struct snd_pcm_substream *substream);
 472 int snd_soc_pcm_component_ioctl(struct snd_pcm_substream *substream,
 473                                 unsigned int cmd, void *arg);
 474 int snd_soc_pcm_component_sync_stop(struct snd_pcm_substream *substream);
 475 int snd_soc_pcm_component_copy_user(struct snd_pcm_substream *substream,
 476                                     int channel, unsigned long pos,
 477                                     void __user *buf, unsigned long bytes);
 478 struct page *snd_soc_pcm_component_page(struct snd_pcm_substream *substream,
 479                                         unsigned long offset);
 480 int snd_soc_pcm_component_mmap(struct snd_pcm_substream *substream,
 481                                struct vm_area_struct *vma);
 482 int snd_soc_pcm_component_new(struct snd_soc_pcm_runtime *rtd);
 483 void snd_soc_pcm_component_free(struct snd_soc_pcm_runtime *rtd);
 484 int snd_soc_pcm_component_prepare(struct snd_pcm_substream *substream);
 485 int snd_soc_pcm_component_hw_params(struct snd_pcm_substream *substream,
 486                                     struct snd_pcm_hw_params *params);
 487 void snd_soc_pcm_component_hw_free(struct snd_pcm_substream *substream,
 488                                    int rollback);
 489 int snd_soc_pcm_component_trigger(struct snd_pcm_substream *substream,
 490                                   int cmd, int rollback);
 491 int snd_soc_pcm_component_pm_runtime_get(struct snd_soc_pcm_runtime *rtd,
 492                                          void *stream);
 493 void snd_soc_pcm_component_pm_runtime_put(struct snd_soc_pcm_runtime *rtd,
 494                                           void *stream, int rollback);
 495
 496 #endif /* __SOC_COMPONENT_H */