include/sound/hda_codec.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * Universal Interface for Intel High Definition Audio Codec
   4  *
   5  * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
   6  */
   7
   8 #ifndef __SOUND_HDA_CODEC_H
   9 #define __SOUND_HDA_CODEC_H
  10
  11 #include <linux/refcount.h>
  12 #include <linux/mod_devicetable.h>
  13 #include <sound/info.h>
  14 #include <sound/control.h>
  15 #include <sound/pcm.h>
  16 #include <sound/hwdep.h>
  17 #include <sound/hdaudio.h>
  18 #include <sound/hda_verbs.h>
  19 #include <sound/hda_regmap.h>
  20
  21 /*
  22  * Structures
  23  */
  24
  25 struct hda_bus;
  26 struct hda_beep;
  27 struct hda_codec;
  28 struct hda_pcm;
  29 struct hda_pcm_stream;
  30
  31 /*
  32  * codec bus
  33  *
  34  * each controller needs to creata a hda_bus to assign the accessor.
  35  * A hda_bus contains several codecs in the list codec_list.
  36  */
  37 struct hda_bus {
  38         struct hdac_bus core;
  39
  40         struct snd_card *card;
  41
  42         struct pci_dev *pci;
  43         const char *modelname;
  44
  45         struct mutex prepare_mutex;
  46
  47         /* assigned PCMs */
  48         DECLARE_BITMAP(pcm_dev_bits, SNDRV_PCM_DEVICES);
  49
  50         /* misc op flags */
  51         unsigned int allow_bus_reset:1; /* allow bus reset at fatal error */
  52         /* status for codec/controller */
  53         unsigned int shutdown :1;       /* being unloaded */
  54         unsigned int response_reset:1;  /* controller was reset */
  55         unsigned int in_reset:1;        /* during reset operation */
  56         unsigned int no_response_fallback:1; /* don't fallback at RIRB error */
  57         unsigned int bus_probing :1;    /* during probing process */
  58         unsigned int keep_power:1;      /* keep power up for notification */
  59         unsigned int jackpoll_in_suspend:1; /* keep jack polling during
  60                                              * runtime suspend
  61                                              */
  62
  63         int primary_dig_out_type;       /* primary digital out PCM type */
  64         unsigned int mixer_assigned;    /* codec addr for mixer name */
  65 };
  66
  67 /* from hdac_bus to hda_bus */
  68 #define to_hda_bus(bus)         container_of(bus, struct hda_bus, core)
  69
  70 /*
  71  * codec preset
  72  *
  73  * Known codecs have the patch to build and set up the controls/PCMs
  74  * better than the generic parser.
  75  */
  76 typedef int (*hda_codec_patch_t)(struct hda_codec *);
  77
  78 #define HDA_CODEC_ID_SKIP_PROBE         0x00000001
  79 #define HDA_CODEC_ID_GENERIC_HDMI       0x00000101
  80 #define HDA_CODEC_ID_GENERIC            0x00000201
  81
  82 #define HDA_CODEC_REV_ENTRY(_vid, _rev, _name, _patch) \
  83         { .vendor_id = (_vid), .rev_id = (_rev), .name = (_name), \
  84           .api_version = HDA_DEV_LEGACY, \
  85           .driver_data = (unsigned long)(_patch) }
  86 #define HDA_CODEC_ENTRY(_vid, _name, _patch) \
  87         HDA_CODEC_REV_ENTRY(_vid, 0, _name, _patch)
  88
  89 struct hda_codec_driver {
  90         struct hdac_driver core;
  91         const struct hda_device_id *id;
  92 };
  93
  94 int __hda_codec_driver_register(struct hda_codec_driver *drv, const char *name,
  95                                struct module *owner);
  96 #define hda_codec_driver_register(drv) \
  97         __hda_codec_driver_register(drv, KBUILD_MODNAME, THIS_MODULE)
  98 void hda_codec_driver_unregister(struct hda_codec_driver *drv);
  99 #define module_hda_codec_driver(drv) \
 100         module_driver(drv, hda_codec_driver_register, \
 101                       hda_codec_driver_unregister)
 102
 103 /* ops set by the preset patch */
 104 struct hda_codec_ops {
 105         int (*build_controls)(struct hda_codec *codec);
 106         int (*build_pcms)(struct hda_codec *codec);
 107         int (*init)(struct hda_codec *codec);
 108         void (*free)(struct hda_codec *codec);
 109         void (*unsol_event)(struct hda_codec *codec, unsigned int res);
 110         void (*set_power_state)(struct hda_codec *codec, hda_nid_t fg,
 111                                 unsigned int power_state);
 112         int (*suspend)(struct hda_codec *codec);
 113         int (*resume)(struct hda_codec *codec);
 114         int (*check_power_status)(struct hda_codec *codec, hda_nid_t nid);
 115         void (*stream_pm)(struct hda_codec *codec, hda_nid_t nid, bool on);
 116 };
 117
 118 /* PCM callbacks */
 119 struct hda_pcm_ops {
 120         int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
 121                     struct snd_pcm_substream *substream);
 122         int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
 123                      struct snd_pcm_substream *substream);
 124         int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
 125                        unsigned int stream_tag, unsigned int format,
 126                        struct snd_pcm_substream *substream);
 127         int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
 128                        struct snd_pcm_substream *substream);
 129         unsigned int (*get_delay)(struct hda_pcm_stream *info,
 130                                   struct hda_codec *codec,
 131                                   struct snd_pcm_substream *substream);
 132 };
 133
 134 /* PCM information for each substream */
 135 struct hda_pcm_stream {
 136         unsigned int substreams;        /* number of substreams, 0 = not exist*/
 137         unsigned int channels_min;      /* min. number of channels */
 138         unsigned int channels_max;      /* max. number of channels */
 139         hda_nid_t nid;  /* default NID to query rates/formats/bps, or set up */
 140         u32 rates;      /* supported rates */
 141         u64 formats;    /* supported formats (SNDRV_PCM_FMTBIT_) */
 142         u32 subformats; /* for S32_LE format, SNDRV_PCM_SUBFMTBIT_* */
 143         unsigned int maxbps;    /* supported max. bit per sample */
 144         const struct snd_pcm_chmap_elem *chmap; /* chmap to override */
 145         struct hda_pcm_ops ops;
 146 };
 147
 148 /* PCM types */
 149 enum {
 150         HDA_PCM_TYPE_AUDIO,
 151         HDA_PCM_TYPE_SPDIF,
 152         HDA_PCM_TYPE_HDMI,
 153         HDA_PCM_TYPE_MODEM,
 154         HDA_PCM_NTYPES
 155 };
 156
 157 #define SNDRV_PCM_INVALID_DEVICE        (-1)
 158 /* for PCM creation */
 159 struct hda_pcm {
 160         char *name;
 161         struct hda_pcm_stream stream[2];
 162         unsigned int pcm_type;  /* HDA_PCM_TYPE_XXX */
 163         int device;             /* device number to assign */
 164         struct snd_pcm *pcm;    /* assigned PCM instance */
 165         bool own_chmap;         /* codec driver provides own channel maps */
 166         /* private: */
 167         struct hda_codec *codec;
 168         struct list_head list;
 169         unsigned int disconnected:1;
 170 };
 171
 172 /* codec information */
 173 struct hda_codec {
 174         struct hdac_device core;
 175         struct hda_bus *bus;
 176         struct snd_card *card;
 177         unsigned int addr;      /* codec addr*/
 178         u32 probe_id; /* overridden id for probing */
 179
 180         /* detected preset */
 181         const struct hda_device_id *preset;
 182         const char *modelname;  /* model name for preset */
 183
 184         /* set by patch */
 185         struct hda_codec_ops patch_ops;
 186
 187         /* PCM to create, set by patch_ops.build_pcms callback */
 188         struct list_head pcm_list_head;
 189         refcount_t pcm_ref;
 190         wait_queue_head_t remove_sleep;
 191
 192         /* codec specific info */
 193         void *spec;
 194
 195         /* beep device */
 196         struct hda_beep *beep;
 197         unsigned int beep_mode;
 198         bool beep_just_power_on;
 199
 200         /* widget capabilities cache */
 201         u32 *wcaps;
 202
 203         struct snd_array mixers;        /* list of assigned mixer elements */
 204         struct snd_array nids;          /* list of mapped mixer elements */
 205
 206         struct list_head conn_list;     /* linked-list of connection-list */
 207
 208         struct mutex spdif_mutex;
 209         struct mutex control_mutex;
 210         struct snd_array spdif_out;
 211         unsigned int spdif_in_enable;   /* SPDIF input enable? */
 212         const hda_nid_t *follower_dig_outs; /* optional digital out follower widgets */
 213         struct snd_array init_pins;     /* initial (BIOS) pin configurations */
 214         struct snd_array driver_pins;   /* pin configs set by codec parser */
 215         struct snd_array cvt_setups;    /* audio convert setups */
 216
 217         struct mutex user_mutex;
 218 #ifdef CONFIG_SND_HDA_RECONFIG
 219         struct snd_array init_verbs;    /* additional init verbs */
 220         struct snd_array hints;         /* additional hints */
 221         struct snd_array user_pins;     /* default pin configs to override */
 222 #endif
 223
 224 #ifdef CONFIG_SND_HDA_HWDEP
 225         struct snd_hwdep *hwdep;        /* assigned hwdep device */
 226 #endif
 227
 228         /* misc flags */
 229         unsigned int configured:1; /* codec was configured */
 230         unsigned int in_freeing:1; /* being released */
 231         unsigned int display_power_control:1; /* needs display power */
 232         unsigned int spdif_status_reset :1; /* needs to toggle SPDIF for each
 233                                              * status change
 234                                              * (e.g. Realtek codecs)
 235                                              */
 236         unsigned int pin_amp_workaround:1; /* pin out-amp takes index
 237                                             * (e.g. Conexant codecs)
 238                                             */
 239         unsigned int single_adc_amp:1; /* adc in-amp takes no index
 240                                         * (e.g. CX20549 codec)
 241                                         */
 242         unsigned int no_sticky_stream:1; /* no sticky-PCM stream assignment */
 243         unsigned int pins_shutup:1;     /* pins are shut up */
 244         unsigned int no_trigger_sense:1; /* don't trigger at pin-sensing */
 245         unsigned int no_jack_detect:1;  /* Machine has no jack-detection */
 246         unsigned int inv_eapd:1; /* broken h/w: inverted EAPD control */
 247         unsigned int inv_jack_detect:1; /* broken h/w: inverted detection bit */
 248         unsigned int pcm_format_first:1; /* PCM format must be set first */
 249         unsigned int cached_write:1;    /* write only to caches */
 250         unsigned int dp_mst:1; /* support DP1.2 Multi-stream transport */
 251         unsigned int dump_coef:1; /* dump processing coefs in codec proc file */
 252         unsigned int power_save_node:1; /* advanced PM for each widget */
 253         unsigned int auto_runtime_pm:1; /* enable automatic codec runtime pm */
 254         unsigned int force_pin_prefix:1; /* Add location prefix */
 255         unsigned int link_down_at_suspend:1; /* link down at runtime suspend */
 256         unsigned int relaxed_resume:1;  /* don't resume forcibly for jack */
 257         unsigned int forced_resume:1; /* forced resume for jack */
 258         unsigned int no_stream_clean_at_suspend:1; /* do not clean streams at suspend */
 259         unsigned int ctl_dev_id:1; /* old control element id build behaviour */
 260
 261         unsigned long power_on_acct;
 262         unsigned long power_off_acct;
 263         unsigned long power_jiffies;
 264
 265         /* filter the requested power state per nid */
 266         unsigned int (*power_filter)(struct hda_codec *codec, hda_nid_t nid,
 267                                      unsigned int power_state);
 268
 269         /* codec-specific additional proc output */
 270         void (*proc_widget_hook)(struct snd_info_buffer *buffer,
 271                                  struct hda_codec *codec, hda_nid_t nid);
 272
 273         /* jack detection */
 274         struct snd_array jacktbl;
 275         unsigned long jackpoll_interval; /* In jiffies. Zero means no poll, rely on unsol events */
 276         struct delayed_work jackpoll_work;
 277
 278         int depop_delay; /* depop delay in ms, -1 for default delay time */
 279
 280         /* fix-up list */
 281         int fixup_id;
 282         const struct hda_fixup *fixup_list;
 283         const char *fixup_name;
 284
 285         /* additional init verbs */
 286         struct snd_array verbs;
 287 };
 288
 289 #define dev_to_hda_codec(_dev)  container_of(_dev, struct hda_codec, core.dev)
 290 #define hda_codec_dev(_dev)     (&(_dev)->core.dev)
 291
 292 #define hdac_to_hda_codec(_hdac) container_of(_hdac, struct hda_codec, core)
 293
 294 #define list_for_each_codec(c, bus) \
 295         list_for_each_entry(c, &(bus)->core.codec_list, core.list)
 296 #define list_for_each_codec_safe(c, n, bus)                             \
 297         list_for_each_entry_safe(c, n, &(bus)->core.codec_list, core.list)
 298
 299 /* snd_hda_codec_read/write optional flags */
 300 #define HDA_RW_NO_RESPONSE_FALLBACK     (1 << 0)
 301
 302 /*
 303  * constructors
 304  */
 305 __printf(3, 4) struct hda_codec *
 306 snd_hda_codec_device_init(struct hda_bus *bus, unsigned int codec_addr,
 307                           const char *fmt, ...);
 308 int snd_hda_codec_new(struct hda_bus *bus, struct snd_card *card,
 309                       unsigned int codec_addr, struct hda_codec **codecp);
 310 int snd_hda_codec_device_new(struct hda_bus *bus, struct snd_card *card,
 311                       unsigned int codec_addr, struct hda_codec *codec,
 312                       bool snddev_managed);
 313 int snd_hda_codec_configure(struct hda_codec *codec);
 314 int snd_hda_codec_update_widgets(struct hda_codec *codec);
 315 void snd_hda_codec_register(struct hda_codec *codec);
 316 void snd_hda_codec_unregister(struct hda_codec *codec);
 317 void snd_hda_codec_cleanup_for_unbind(struct hda_codec *codec);
 318
 319 /*
 320  * low level functions
 321  */
 322 static inline unsigned int
 323 snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
 324                                 int flags,
 325                                 unsigned int verb, unsigned int parm)
 326 {
 327         return snd_hdac_codec_read(&codec->core, nid, flags, verb, parm);
 328 }
 329
 330 static inline int
 331 snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags,
 332                         unsigned int verb, unsigned int parm)
 333 {
 334         return snd_hdac_codec_write(&codec->core, nid, flags, verb, parm);
 335 }
 336
 337 #define snd_hda_param_read(codec, nid, param) \
 338         snd_hdac_read_parm(&(codec)->core, nid, param)
 339 #define snd_hda_get_sub_nodes(codec, nid, start_nid) \
 340         snd_hdac_get_sub_nodes(&(codec)->core, nid, start_nid)
 341 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
 342                             hda_nid_t *conn_list, int max_conns);
 343 static inline int
 344 snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid)
 345 {
 346         return snd_hda_get_connections(codec, nid, NULL, 0);
 347 }
 348
 349 #define snd_hda_get_raw_connections(codec, nid, list, max_conns) \
 350         snd_hdac_get_connections(&(codec)->core, nid, list, max_conns)
 351 #define snd_hda_get_num_raw_conns(codec, nid) \
 352         snd_hdac_get_connections(&(codec)->core, nid, NULL, 0)
 353
 354 int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid,
 355                           const hda_nid_t **listp);
 356 int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums,
 357                           const hda_nid_t *list);
 358 int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux,
 359                            hda_nid_t nid, int recursive);
 360 unsigned int snd_hda_get_num_devices(struct hda_codec *codec, hda_nid_t nid);
 361 int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid,
 362                         u8 *dev_list, int max_devices);
 363 int snd_hda_get_dev_select(struct hda_codec *codec, hda_nid_t nid);
 364 int snd_hda_set_dev_select(struct hda_codec *codec, hda_nid_t nid, int dev_id);
 365
 366 struct hda_verb {
 367         hda_nid_t nid;
 368         u32 verb;
 369         u32 param;
 370 };
 371
 372 void snd_hda_sequence_write(struct hda_codec *codec,
 373                             const struct hda_verb *seq);
 374
 375 /* cached write */
 376 static inline int
 377 snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
 378                           int flags, unsigned int verb, unsigned int parm)
 379 {
 380         return snd_hdac_regmap_write(&codec->core, nid, verb, parm);
 381 }
 382
 383 /* the struct for codec->pin_configs */
 384 struct hda_pincfg {
 385         hda_nid_t nid;
 386         unsigned char ctrl;     /* original pin control value */
 387         unsigned char target;   /* target pin control value */
 388         unsigned int cfg;       /* default configuration */
 389 };
 390
 391 unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid);
 392 int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid,
 393                              unsigned int cfg);
 394 int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
 395                        hda_nid_t nid, unsigned int cfg); /* for hwdep */
 396 void snd_hda_shutup_pins(struct hda_codec *codec);
 397
 398 /* SPDIF controls */
 399 struct hda_spdif_out {
 400         hda_nid_t nid;          /* Converter nid values relate to */
 401         unsigned int status;    /* IEC958 status bits */
 402         unsigned short ctls;    /* SPDIF control bits */
 403 };
 404 struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec,
 405                                                hda_nid_t nid);
 406 void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx);
 407 void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid);
 408
 409 /*
 410  * Mixer
 411  */
 412 int snd_hda_codec_build_controls(struct hda_codec *codec);
 413
 414 /*
 415  * PCM
 416  */
 417 int snd_hda_codec_parse_pcms(struct hda_codec *codec);
 418 int snd_hda_codec_build_pcms(struct hda_codec *codec);
 419
 420 __printf(2, 3)
 421 struct hda_pcm *snd_hda_codec_pcm_new(struct hda_codec *codec,
 422                                       const char *fmt, ...);
 423
 424 void snd_hda_codec_cleanup_for_unbind(struct hda_codec *codec);
 425
 426 static inline void snd_hda_codec_pcm_get(struct hda_pcm *pcm)
 427 {
 428         refcount_inc(&pcm->codec->pcm_ref);
 429 }
 430 void snd_hda_codec_pcm_put(struct hda_pcm *pcm);
 431
 432 int snd_hda_codec_prepare(struct hda_codec *codec,
 433                           struct hda_pcm_stream *hinfo,
 434                           unsigned int stream,
 435                           unsigned int format,
 436                           struct snd_pcm_substream *substream);
 437 void snd_hda_codec_cleanup(struct hda_codec *codec,
 438                            struct hda_pcm_stream *hinfo,
 439                            struct snd_pcm_substream *substream);
 440
 441 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
 442                                 u32 stream_tag,
 443                                 int channel_id, int format);
 444 void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid,
 445                                     int do_now);
 446 #define snd_hda_codec_cleanup_stream(codec, nid) \
 447         __snd_hda_codec_cleanup_stream(codec, nid, 0)
 448
 449 #define snd_hda_query_supported_pcm(codec, nid, ratesp, fmtsp, subfmtp, bpsp) \
 450         snd_hdac_query_supported_pcm(&(codec)->core, nid, ratesp, fmtsp, subfmtp, bpsp)
 451 #define snd_hda_is_supported_format(codec, nid, fmt) \
 452         snd_hdac_is_supported_format(&(codec)->core, nid, fmt)
 453
 454 extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[];
 455
 456 int snd_hda_attach_pcm_stream(struct hda_bus *_bus, struct hda_codec *codec,
 457                               struct hda_pcm *cpcm);
 458
 459 /*
 460  * Misc
 461  */
 462 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
 463 void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg,
 464                                     unsigned int power_state);
 465
 466 int snd_hda_lock_devices(struct hda_bus *bus);
 467 void snd_hda_unlock_devices(struct hda_bus *bus);
 468 void snd_hda_bus_reset(struct hda_bus *bus);
 469 void snd_hda_bus_reset_codecs(struct hda_bus *bus);
 470
 471 int snd_hda_codec_set_name(struct hda_codec *codec, const char *name);
 472
 473 /*
 474  * power management
 475  */
 476 extern const struct dev_pm_ops hda_codec_driver_pm;
 477
 478 static inline
 479 int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid)
 480 {
 481         if (codec->patch_ops.check_power_status)
 482                 return codec->patch_ops.check_power_status(codec, nid);
 483         return 0;
 484 }
 485
 486 /*
 487  * power saving
 488  */
 489 #define snd_hda_power_up(codec)         snd_hdac_power_up(&(codec)->core)
 490 #define snd_hda_power_up_pm(codec)      snd_hdac_power_up_pm(&(codec)->core)
 491 #define snd_hda_power_down(codec)       snd_hdac_power_down(&(codec)->core)
 492 #define snd_hda_power_down_pm(codec)    snd_hdac_power_down_pm(&(codec)->core)
 493 void snd_hda_codec_set_power_save(struct hda_codec *codec, int delay);
 494 void snd_hda_set_power_save(struct hda_bus *bus, int delay);
 495 void snd_hda_update_power_acct(struct hda_codec *codec);
 496
 497 static inline bool hda_codec_need_resume(struct hda_codec *codec)
 498 {
 499         return !codec->relaxed_resume && codec->jacktbl.used;
 500 }
 501
 502 #ifdef CONFIG_SND_HDA_PATCH_LOADER
 503 /*
 504  * patch firmware
 505  */
 506 int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf);
 507 #endif
 508
 509 #ifdef CONFIG_SND_HDA_DSP_LOADER
 510 int snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
 511                                    unsigned int size,
 512                                    struct snd_dma_buffer *bufp);
 513 void snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start);
 514 void snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
 515                                     struct snd_dma_buffer *dmab);
 516 #else
 517 static inline int
 518 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
 519                                 unsigned int size,
 520                                 struct snd_dma_buffer *bufp)
 521 {
 522         return -ENOSYS;
 523 }
 524 static inline void
 525 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {}
 526 static inline void
 527 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
 528                                 struct snd_dma_buffer *dmab) {}
 529 #endif
 530
 531 #endif /* __SOUND_HDA_CODEC_H */