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