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 #define IS_BXT(pci) ((pci)->vendor == 0x8086 && (pci)->device == 0x5a98)
  22 #define IS_CFL(pci) ((pci)->vendor == 0x8086 && (pci)->device == 0xa348)
  23
  24 /*
  25  * Structures
  26  */
  27
  28 struct hda_bus;
  29 struct hda_beep;
  30 struct hda_codec;
  31 struct hda_pcm;
  32 struct hda_pcm_stream;
  33
  34 /*
  35  * codec bus
  36  *
  37  * each controller needs to creata a hda_bus to assign the accessor.
  38  * A hda_bus contains several codecs in the list codec_list.
  39  */
  40 struct hda_bus {
  41         struct hdac_bus core;
  42
  43         struct snd_card *card;
  44
  45         struct pci_dev *pci;
  46         const char *modelname;
  47
  48         struct mutex prepare_mutex;
  49
  50         /* assigned PCMs */
  51         DECLARE_BITMAP(pcm_dev_bits, SNDRV_PCM_DEVICES);
  52
  53         /* misc op flags */
  54         unsigned int needs_damn_long_delay :1;
  55         unsigned int allow_bus_reset:1; /* allow bus reset at fatal error */
  56         /* status for codec/controller */
  57         unsigned int shutdown :1;       /* being unloaded */
  58         unsigned int response_reset:1;  /* controller was reset */
  59         unsigned int in_reset:1;        /* during reset operation */
  60         unsigned int no_response_fallback:1; /* don't fallback at RIRB error */
  61         unsigned int bus_probing :1;    /* during probing process */
  62         unsigned int keep_power:1;      /* keep power up for notification */
  63
  64         int primary_dig_out_type;       /* primary digital out PCM type */
  65         unsigned int mixer_assigned;    /* codec addr for mixer name */
  66 };
  67
  68 /* from hdac_bus to hda_bus */
  69 #define to_hda_bus(bus)         container_of(bus, struct hda_bus, core)
  70
  71 /*
  72  * codec preset
  73  *
  74  * Known codecs have the patch to build and set up the controls/PCMs
  75  * better than the generic parser.
  76  */
  77 typedef int (*hda_codec_patch_t)(struct hda_codec *);
  78
  79 #define HDA_CODEC_ID_SKIP_PROBE         0x00000001
  80 #define HDA_CODEC_ID_GENERIC_HDMI       0x00000101
  81 #define HDA_CODEC_ID_GENERIC            0x00000201
  82
  83 #define HDA_CODEC_REV_ENTRY(_vid, _rev, _name, _patch) \
  84         { .vendor_id = (_vid), .rev_id = (_rev), .name = (_name), \
  85           .api_version = HDA_DEV_LEGACY, \
  86           .driver_data = (unsigned long)(_patch) }
  87 #define HDA_CODEC_ENTRY(_vid, _name, _patch) \
  88         HDA_CODEC_REV_ENTRY(_vid, 0, _name, _patch)
  89
  90 struct hda_codec_driver {
  91         struct hdac_driver core;
  92         const struct hda_device_id *id;
  93 };
  94
  95 int __hda_codec_driver_register(struct hda_codec_driver *drv, const char *name,
  96                                struct module *owner);
  97 #define hda_codec_driver_register(drv) \
  98         __hda_codec_driver_register(drv, KBUILD_MODNAME, THIS_MODULE)
  99 void hda_codec_driver_unregister(struct hda_codec_driver *drv);
 100 #define module_hda_codec_driver(drv) \
 101         module_driver(drv, hda_codec_driver_register, \
 102                       hda_codec_driver_unregister)
 103
 104 /* ops set by the preset patch */
 105 struct hda_codec_ops {
 106         int (*build_controls)(struct hda_codec *codec);
 107         int (*build_pcms)(struct hda_codec *codec);
 108         int (*init)(struct hda_codec *codec);
 109         void (*free)(struct hda_codec *codec);
 110         void (*unsol_event)(struct hda_codec *codec, unsigned int res);
 111         void (*set_power_state)(struct hda_codec *codec, hda_nid_t fg,
 112                                 unsigned int power_state);
 113 #ifdef CONFIG_PM
 114         int (*suspend)(struct hda_codec *codec);
 115         int (*resume)(struct hda_codec *codec);
 116         int (*check_power_status)(struct hda_codec *codec, hda_nid_t nid);
 117 #endif
 118         void (*reboot_notify)(struct hda_codec *codec);
 119         void (*stream_pm)(struct hda_codec *codec, hda_nid_t nid, bool on);
 120 };
 121
 122 /* PCM callbacks */
 123 struct hda_pcm_ops {
 124         int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
 125                     struct snd_pcm_substream *substream);
 126         int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
 127                      struct snd_pcm_substream *substream);
 128         int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
 129                        unsigned int stream_tag, unsigned int format,
 130                        struct snd_pcm_substream *substream);
 131         int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
 132                        struct snd_pcm_substream *substream);
 133         unsigned int (*get_delay)(struct hda_pcm_stream *info,
 134                                   struct hda_codec *codec,
 135                                   struct snd_pcm_substream *substream);
 136 };
 137
 138 /* PCM information for each substream */
 139 struct hda_pcm_stream {
 140         unsigned int substreams;        /* number of substreams, 0 = not exist*/
 141         unsigned int channels_min;      /* min. number of channels */
 142         unsigned int channels_max;      /* max. number of channels */
 143         hda_nid_t nid;  /* default NID to query rates/formats/bps, or set up */
 144         u32 rates;      /* supported rates */
 145         u64 formats;    /* supported formats (SNDRV_PCM_FMTBIT_) */
 146         unsigned int maxbps;    /* supported max. bit per sample */
 147         const struct snd_pcm_chmap_elem *chmap; /* chmap to override */
 148         struct hda_pcm_ops ops;
 149 };
 150
 151 /* PCM types */
 152 enum {
 153         HDA_PCM_TYPE_AUDIO,
 154         HDA_PCM_TYPE_SPDIF,
 155         HDA_PCM_TYPE_HDMI,
 156         HDA_PCM_TYPE_MODEM,
 157         HDA_PCM_NTYPES
 158 };
 159
 160 #define SNDRV_PCM_INVALID_DEVICE        (-1)
 161 /* for PCM creation */
 162 struct hda_pcm {
 163         char *name;
 164         struct hda_pcm_stream stream[2];
 165         unsigned int pcm_type;  /* HDA_PCM_TYPE_XXX */
 166         int device;             /* device number to assign */
 167         struct snd_pcm *pcm;    /* assigned PCM instance */
 168         bool own_chmap;         /* codec driver provides own channel maps */
 169         /* private: */
 170         struct hda_codec *codec;
 171         struct kref kref;
 172         struct list_head list;
 173 };
 174
 175 /* codec information */
 176 struct hda_codec {
 177         struct hdac_device core;
 178         struct hda_bus *bus;
 179         struct snd_card *card;
 180         unsigned int addr;      /* codec addr*/
 181         u32 probe_id; /* overridden id for probing */
 182
 183         /* detected preset */
 184         const struct hda_device_id *preset;
 185         const char *modelname;  /* model name for preset */
 186
 187         /* set by patch */
 188         struct hda_codec_ops patch_ops;
 189
 190         /* PCM to create, set by patch_ops.build_pcms callback */
 191         struct list_head pcm_list_head;
 192
 193         /* codec specific info */
 194         void *spec;
 195
 196         /* beep device */
 197         struct hda_beep *beep;
 198         unsigned int beep_mode;
 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 *slave_dig_outs; /* optional digital out slave 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 in_freeing:1; /* being released */
 230         unsigned int registered:1; /* codec was registered */
 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 mst_no_extra_pcms:1; /* no backup PCMs for DP-MST */
 258
 259 #ifdef CONFIG_PM
 260         unsigned long power_on_acct;
 261         unsigned long power_off_acct;
 262         unsigned long power_jiffies;
 263 #endif
 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 list_for_each_codec(c, bus) \
 293         list_for_each_entry(c, &(bus)->core.codec_list, core.list)
 294 #define list_for_each_codec_safe(c, n, bus)                             \
 295         list_for_each_entry_safe(c, n, &(bus)->core.codec_list, core.list)
 296
 297 /* snd_hda_codec_read/write optional flags */
 298 #define HDA_RW_NO_RESPONSE_FALLBACK     (1 << 0)
 299
 300 /*
 301  * constructors
 302  */
 303 int snd_hda_codec_new(struct hda_bus *bus, struct snd_card *card,
 304                       unsigned int codec_addr, struct hda_codec **codecp);
 305 int snd_hda_codec_device_new(struct hda_bus *bus, struct snd_card *card,
 306                       unsigned int codec_addr, struct hda_codec *codec);
 307 int snd_hda_codec_configure(struct hda_codec *codec);
 308 int snd_hda_codec_update_widgets(struct hda_codec *codec);
 309
 310 /*
 311  * low level functions
 312  */
 313 static inline unsigned int
 314 snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
 315                                 int flags,
 316                                 unsigned int verb, unsigned int parm)
 317 {
 318         return snd_hdac_codec_read(&codec->core, nid, flags, verb, parm);
 319 }
 320
 321 static inline int
 322 snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags,
 323                         unsigned int verb, unsigned int parm)
 324 {
 325         return snd_hdac_codec_write(&codec->core, nid, flags, verb, parm);
 326 }
 327
 328 #define snd_hda_param_read(codec, nid, param) \
 329         snd_hdac_read_parm(&(codec)->core, nid, param)
 330 #define snd_hda_get_sub_nodes(codec, nid, start_nid) \
 331         snd_hdac_get_sub_nodes(&(codec)->core, nid, start_nid)
 332 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
 333                             hda_nid_t *conn_list, int max_conns);
 334 static inline int
 335 snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid)
 336 {
 337         return snd_hda_get_connections(codec, nid, NULL, 0);
 338 }
 339
 340 #define snd_hda_get_raw_connections(codec, nid, list, max_conns) \
 341         snd_hdac_get_connections(&(codec)->core, nid, list, max_conns)
 342 #define snd_hda_get_num_raw_conns(codec, nid) \
 343         snd_hdac_get_connections(&(codec)->core, nid, NULL, 0);
 344
 345 int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid,
 346                           const hda_nid_t **listp);
 347 int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums,
 348                           const hda_nid_t *list);
 349 int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux,
 350                            hda_nid_t nid, int recursive);
 351 unsigned int snd_hda_get_num_devices(struct hda_codec *codec, hda_nid_t nid);
 352 int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid,
 353                         u8 *dev_list, int max_devices);
 354 int snd_hda_get_dev_select(struct hda_codec *codec, hda_nid_t nid);
 355 int snd_hda_set_dev_select(struct hda_codec *codec, hda_nid_t nid, int dev_id);
 356
 357 struct hda_verb {
 358         hda_nid_t nid;
 359         u32 verb;
 360         u32 param;
 361 };
 362
 363 void snd_hda_sequence_write(struct hda_codec *codec,
 364                             const struct hda_verb *seq);
 365
 366 /* unsolicited event */
 367 static inline void
 368 snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex)
 369 {
 370         snd_hdac_bus_queue_event(&bus->core, res, res_ex);
 371 }
 372
 373 /* cached write */
 374 static inline int
 375 snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
 376                           int flags, unsigned int verb, unsigned int parm)
 377 {
 378         return snd_hdac_regmap_write(&codec->core, nid, verb, parm);
 379 }
 380
 381 /* the struct for codec->pin_configs */
 382 struct hda_pincfg {
 383         hda_nid_t nid;
 384         unsigned char ctrl;     /* original pin control value */
 385         unsigned char target;   /* target pin control value */
 386         unsigned int cfg;       /* default configuration */
 387 };
 388
 389 unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid);
 390 int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid,
 391                              unsigned int cfg);
 392 int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
 393                        hda_nid_t nid, unsigned int cfg); /* for hwdep */
 394 void snd_hda_shutup_pins(struct hda_codec *codec);
 395
 396 /* SPDIF controls */
 397 struct hda_spdif_out {
 398         hda_nid_t nid;          /* Converter nid values relate to */
 399         unsigned int status;    /* IEC958 status bits */
 400         unsigned short ctls;    /* SPDIF control bits */
 401 };
 402 struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec,
 403                                                hda_nid_t nid);
 404 void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx);
 405 void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid);
 406
 407 /*
 408  * Mixer
 409  */
 410 int snd_hda_codec_build_controls(struct hda_codec *codec);
 411
 412 /*
 413  * PCM
 414  */
 415 int snd_hda_codec_parse_pcms(struct hda_codec *codec);
 416 int snd_hda_codec_build_pcms(struct hda_codec *codec);
 417
 418 __printf(2, 3)
 419 struct hda_pcm *snd_hda_codec_pcm_new(struct hda_codec *codec,
 420                                       const char *fmt, ...);
 421
 422 static inline void snd_hda_codec_pcm_get(struct hda_pcm *pcm)
 423 {
 424         kref_get(&pcm->kref);
 425 }
 426 void snd_hda_codec_pcm_put(struct hda_pcm *pcm);
 427
 428 int snd_hda_codec_prepare(struct hda_codec *codec,
 429                           struct hda_pcm_stream *hinfo,
 430                           unsigned int stream,
 431                           unsigned int format,
 432                           struct snd_pcm_substream *substream);
 433 void snd_hda_codec_cleanup(struct hda_codec *codec,
 434                            struct hda_pcm_stream *hinfo,
 435                            struct snd_pcm_substream *substream);
 436
 437 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
 438                                 u32 stream_tag,
 439                                 int channel_id, int format);
 440 void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid,
 441                                     int do_now);
 442 #define snd_hda_codec_cleanup_stream(codec, nid) \
 443         __snd_hda_codec_cleanup_stream(codec, nid, 0)
 444
 445 #define snd_hda_query_supported_pcm(codec, nid, ratesp, fmtsp, bpsp) \
 446         snd_hdac_query_supported_pcm(&(codec)->core, nid, ratesp, fmtsp, bpsp)
 447 #define snd_hda_is_supported_format(codec, nid, fmt) \
 448         snd_hdac_is_supported_format(&(codec)->core, nid, fmt)
 449
 450 extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[];
 451
 452 int snd_hda_attach_pcm_stream(struct hda_bus *_bus, struct hda_codec *codec,
 453                               struct hda_pcm *cpcm);
 454
 455 /*
 456  * Misc
 457  */
 458 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
 459 void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg,
 460                                     unsigned int power_state);
 461
 462 int snd_hda_lock_devices(struct hda_bus *bus);
 463 void snd_hda_unlock_devices(struct hda_bus *bus);
 464 void snd_hda_bus_reset(struct hda_bus *bus);
 465 void snd_hda_bus_reset_codecs(struct hda_bus *bus);
 466
 467 int snd_hda_codec_set_name(struct hda_codec *codec, const char *name);
 468
 469 /*
 470  * power management
 471  */
 472 extern const struct dev_pm_ops hda_codec_driver_pm;
 473
 474 static inline
 475 int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid)
 476 {
 477 #ifdef CONFIG_PM
 478         if (codec->patch_ops.check_power_status)
 479                 return codec->patch_ops.check_power_status(codec, nid);
 480 #endif
 481         return 0;
 482 }
 483
 484 /*
 485  * power saving
 486  */
 487 #define snd_hda_power_up(codec)         snd_hdac_power_up(&(codec)->core)
 488 #define snd_hda_power_up_pm(codec)      snd_hdac_power_up_pm(&(codec)->core)
 489 #define snd_hda_power_down(codec)       snd_hdac_power_down(&(codec)->core)
 490 #define snd_hda_power_down_pm(codec)    snd_hdac_power_down_pm(&(codec)->core)
 491 #ifdef CONFIG_PM
 492 void snd_hda_set_power_save(struct hda_bus *bus, int delay);
 493 void snd_hda_update_power_acct(struct hda_codec *codec);
 494 #else
 495 static inline void snd_hda_set_power_save(struct hda_bus *bus, int delay) {}
 496 #endif
 497
 498 #ifdef CONFIG_SND_HDA_PATCH_LOADER
 499 /*
 500  * patch firmware
 501  */
 502 int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf);
 503 #endif
 504
 505 #ifdef CONFIG_SND_HDA_DSP_LOADER
 506 int snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
 507                                    unsigned int size,
 508                                    struct snd_dma_buffer *bufp);
 509 void snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start);
 510 void snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
 511                                     struct snd_dma_buffer *dmab);
 512 #else
 513 static inline int
 514 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
 515                                 unsigned int size,
 516                                 struct snd_dma_buffer *bufp)
 517 {
 518         return -ENOSYS;
 519 }
 520 static inline void
 521 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {}
 522 static inline void
 523 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
 524                                 struct snd_dma_buffer *dmab) {}
 525 #endif
 526
 527 #endif /* __SOUND_HDA_CODEC_H */