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