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 allow_bus_reset:1; /* allow bus reset at fatal error */ 55 /* status for codec/controller */ 56 unsigned int shutdown :1; /* being unloaded */ 57 unsigned int response_reset:1; /* controller was reset */ 58 unsigned int in_reset:1; /* during reset operation */ 59 unsigned int no_response_fallback:1; /* don't fallback at RIRB error */ 60 unsigned int bus_probing :1; /* during probing process */ 61 unsigned int keep_power:1; /* keep power up for notification */ 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 #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 (*reboot_notify)(struct hda_codec *codec); 118 void (*stream_pm)(struct hda_codec *codec, hda_nid_t nid, bool on); 119 }; 120 121 /* PCM callbacks */ 122 struct hda_pcm_ops { 123 int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec, 124 struct snd_pcm_substream *substream); 125 int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec, 126 struct snd_pcm_substream *substream); 127 int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec, 128 unsigned int stream_tag, unsigned int format, 129 struct snd_pcm_substream *substream); 130 int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec, 131 struct snd_pcm_substream *substream); 132 unsigned int (*get_delay)(struct hda_pcm_stream *info, 133 struct hda_codec *codec, 134 struct snd_pcm_substream *substream); 135 }; 136 137 /* PCM information for each substream */ 138 struct hda_pcm_stream { 139 unsigned int substreams; /* number of substreams, 0 = not exist*/ 140 unsigned int channels_min; /* min. number of channels */ 141 unsigned int channels_max; /* max. number of channels */ 142 hda_nid_t nid; /* default NID to query rates/formats/bps, or set up */ 143 u32 rates; /* supported rates */ 144 u64 formats; /* supported formats (SNDRV_PCM_FMTBIT_) */ 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 */ 151 enum { 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 */ 161 struct 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 kref kref; 171 struct list_head list; 172 }; 173 174 /* codec information */ 175 struct 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 192 /* codec specific info */ 193 void *spec; 194 195 /* beep device */ 196 struct hda_beep *beep; 197 unsigned int beep_mode; 198 199 /* widget capabilities cache */ 200 u32 *wcaps; 201 202 struct snd_array mixers; /* list of assigned mixer elements */ 203 struct snd_array nids; /* list of mapped mixer elements */ 204 205 struct list_head conn_list; /* linked-list of connection-list */ 206 207 struct mutex spdif_mutex; 208 struct mutex control_mutex; 209 struct snd_array spdif_out; 210 unsigned int spdif_in_enable; /* SPDIF input enable? */ 211 const hda_nid_t *follower_dig_outs; /* optional digital out follower widgets */ 212 struct snd_array init_pins; /* initial (BIOS) pin configurations */ 213 struct snd_array driver_pins; /* pin configs set by codec parser */ 214 struct snd_array cvt_setups; /* audio convert setups */ 215 216 struct mutex user_mutex; 217 #ifdef CONFIG_SND_HDA_RECONFIG 218 struct snd_array init_verbs; /* additional init verbs */ 219 struct snd_array hints; /* additional hints */ 220 struct snd_array user_pins; /* default pin configs to override */ 221 #endif 222 223 #ifdef CONFIG_SND_HDA_HWDEP 224 struct snd_hwdep *hwdep; /* assigned hwdep device */ 225 #endif 226 227 /* misc flags */ 228 unsigned int in_freeing:1; /* being released */ 229 unsigned int registered:1; /* codec was registered */ 230 unsigned int display_power_control:1; /* needs display power */ 231 unsigned int spdif_status_reset :1; /* needs to toggle SPDIF for each 232 * status change 233 * (e.g. Realtek codecs) 234 */ 235 unsigned int pin_amp_workaround:1; /* pin out-amp takes index 236 * (e.g. Conexant codecs) 237 */ 238 unsigned int single_adc_amp:1; /* adc in-amp takes no index 239 * (e.g. CX20549 codec) 240 */ 241 unsigned int no_sticky_stream:1; /* no sticky-PCM stream assignment */ 242 unsigned int pins_shutup:1; /* pins are shut up */ 243 unsigned int no_trigger_sense:1; /* don't trigger at pin-sensing */ 244 unsigned int no_jack_detect:1; /* Machine has no jack-detection */ 245 unsigned int inv_eapd:1; /* broken h/w: inverted EAPD control */ 246 unsigned int inv_jack_detect:1; /* broken h/w: inverted detection bit */ 247 unsigned int pcm_format_first:1; /* PCM format must be set first */ 248 unsigned int cached_write:1; /* write only to caches */ 249 unsigned int dp_mst:1; /* support DP1.2 Multi-stream transport */ 250 unsigned int dump_coef:1; /* dump processing coefs in codec proc file */ 251 unsigned int power_save_node:1; /* advanced PM for each widget */ 252 unsigned int auto_runtime_pm:1; /* enable automatic codec runtime pm */ 253 unsigned int force_pin_prefix:1; /* Add location prefix */ 254 unsigned int link_down_at_suspend:1; /* link down at runtime suspend */ 255 unsigned int relaxed_resume:1; /* don't resume forcibly for jack */ 256 unsigned int forced_resume:1; /* forced resume 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 hdac_to_hda_priv(_hdac) \ 293 container_of(_hdac, struct hdac_hda_priv, codec.core) 294 #define hdac_to_hda_codec(_hdac) container_of(_hdac, struct hda_codec, core) 295 296 #define list_for_each_codec(c, bus) \ 297 list_for_each_entry(c, &(bus)->core.codec_list, core.list) 298 #define list_for_each_codec_safe(c, n, bus) \ 299 list_for_each_entry_safe(c, n, &(bus)->core.codec_list, core.list) 300 301 /* snd_hda_codec_read/write optional flags */ 302 #define HDA_RW_NO_RESPONSE_FALLBACK (1 << 0) 303 304 /* 305 * constructors 306 */ 307 int snd_hda_codec_new(struct hda_bus *bus, struct snd_card *card, 308 unsigned int codec_addr, struct hda_codec **codecp); 309 int snd_hda_codec_device_new(struct hda_bus *bus, struct snd_card *card, 310 unsigned int codec_addr, struct hda_codec *codec); 311 int snd_hda_codec_configure(struct hda_codec *codec); 312 int snd_hda_codec_update_widgets(struct hda_codec *codec); 313 314 /* 315 * low level functions 316 */ 317 static inline unsigned int 318 snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid, 319 int flags, 320 unsigned int verb, unsigned int parm) 321 { 322 return snd_hdac_codec_read(&codec->core, nid, flags, verb, parm); 323 } 324 325 static inline int 326 snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags, 327 unsigned int verb, unsigned int parm) 328 { 329 return snd_hdac_codec_write(&codec->core, nid, flags, verb, parm); 330 } 331 332 #define snd_hda_param_read(codec, nid, param) \ 333 snd_hdac_read_parm(&(codec)->core, nid, param) 334 #define snd_hda_get_sub_nodes(codec, nid, start_nid) \ 335 snd_hdac_get_sub_nodes(&(codec)->core, nid, start_nid) 336 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid, 337 hda_nid_t *conn_list, int max_conns); 338 static inline int 339 snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid) 340 { 341 return snd_hda_get_connections(codec, nid, NULL, 0); 342 } 343 344 #define snd_hda_get_raw_connections(codec, nid, list, max_conns) \ 345 snd_hdac_get_connections(&(codec)->core, nid, list, max_conns) 346 #define snd_hda_get_num_raw_conns(codec, nid) \ 347 snd_hdac_get_connections(&(codec)->core, nid, NULL, 0); 348 349 int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid, 350 const hda_nid_t **listp); 351 int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums, 352 const hda_nid_t *list); 353 int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux, 354 hda_nid_t nid, int recursive); 355 unsigned int snd_hda_get_num_devices(struct hda_codec *codec, hda_nid_t nid); 356 int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid, 357 u8 *dev_list, int max_devices); 358 int snd_hda_get_dev_select(struct hda_codec *codec, hda_nid_t nid); 359 int snd_hda_set_dev_select(struct hda_codec *codec, hda_nid_t nid, int dev_id); 360 361 struct hda_verb { 362 hda_nid_t nid; 363 u32 verb; 364 u32 param; 365 }; 366 367 void snd_hda_sequence_write(struct hda_codec *codec, 368 const struct hda_verb *seq); 369 370 /* cached write */ 371 static inline int 372 snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid, 373 int flags, unsigned int verb, unsigned int parm) 374 { 375 return snd_hdac_regmap_write(&codec->core, nid, verb, parm); 376 } 377 378 /* the struct for codec->pin_configs */ 379 struct hda_pincfg { 380 hda_nid_t nid; 381 unsigned char ctrl; /* original pin control value */ 382 unsigned char target; /* target pin control value */ 383 unsigned int cfg; /* default configuration */ 384 }; 385 386 unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid); 387 int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid, 388 unsigned int cfg); 389 int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list, 390 hda_nid_t nid, unsigned int cfg); /* for hwdep */ 391 void snd_hda_shutup_pins(struct hda_codec *codec); 392 393 /* SPDIF controls */ 394 struct hda_spdif_out { 395 hda_nid_t nid; /* Converter nid values relate to */ 396 unsigned int status; /* IEC958 status bits */ 397 unsigned short ctls; /* SPDIF control bits */ 398 }; 399 struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec, 400 hda_nid_t nid); 401 void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx); 402 void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid); 403 404 /* 405 * Mixer 406 */ 407 int snd_hda_codec_build_controls(struct hda_codec *codec); 408 409 /* 410 * PCM 411 */ 412 int snd_hda_codec_parse_pcms(struct hda_codec *codec); 413 int snd_hda_codec_build_pcms(struct hda_codec *codec); 414 415 __printf(2, 3) 416 struct hda_pcm *snd_hda_codec_pcm_new(struct hda_codec *codec, 417 const char *fmt, ...); 418 419 void snd_hda_codec_cleanup_for_unbind(struct hda_codec *codec); 420 421 static inline void snd_hda_codec_pcm_get(struct hda_pcm *pcm) 422 { 423 kref_get(&pcm->kref); 424 } 425 void snd_hda_codec_pcm_put(struct hda_pcm *pcm); 426 427 int snd_hda_codec_prepare(struct hda_codec *codec, 428 struct hda_pcm_stream *hinfo, 429 unsigned int stream, 430 unsigned int format, 431 struct snd_pcm_substream *substream); 432 void snd_hda_codec_cleanup(struct hda_codec *codec, 433 struct hda_pcm_stream *hinfo, 434 struct snd_pcm_substream *substream); 435 436 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid, 437 u32 stream_tag, 438 int channel_id, int format); 439 void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid, 440 int do_now); 441 #define snd_hda_codec_cleanup_stream(codec, nid) \ 442 __snd_hda_codec_cleanup_stream(codec, nid, 0) 443 444 #define snd_hda_query_supported_pcm(codec, nid, ratesp, fmtsp, bpsp) \ 445 snd_hdac_query_supported_pcm(&(codec)->core, nid, ratesp, fmtsp, bpsp) 446 #define snd_hda_is_supported_format(codec, nid, fmt) \ 447 snd_hdac_is_supported_format(&(codec)->core, nid, fmt) 448 449 extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[]; 450 451 int snd_hda_attach_pcm_stream(struct hda_bus *_bus, struct hda_codec *codec, 452 struct hda_pcm *cpcm); 453 454 /* 455 * Misc 456 */ 457 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen); 458 void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg, 459 unsigned int power_state); 460 461 int snd_hda_lock_devices(struct hda_bus *bus); 462 void snd_hda_unlock_devices(struct hda_bus *bus); 463 void snd_hda_bus_reset(struct hda_bus *bus); 464 void snd_hda_bus_reset_codecs(struct hda_bus *bus); 465 466 int snd_hda_codec_set_name(struct hda_codec *codec, const char *name); 467 468 /* 469 * power management 470 */ 471 extern const struct dev_pm_ops hda_codec_driver_pm; 472 473 static inline 474 int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid) 475 { 476 #ifdef CONFIG_PM 477 if (codec->patch_ops.check_power_status) 478 return codec->patch_ops.check_power_status(codec, nid); 479 #endif 480 return 0; 481 } 482 483 /* 484 * power saving 485 */ 486 #define snd_hda_power_up(codec) snd_hdac_power_up(&(codec)->core) 487 #define snd_hda_power_up_pm(codec) snd_hdac_power_up_pm(&(codec)->core) 488 #define snd_hda_power_down(codec) snd_hdac_power_down(&(codec)->core) 489 #define snd_hda_power_down_pm(codec) snd_hdac_power_down_pm(&(codec)->core) 490 #ifdef CONFIG_PM 491 void snd_hda_set_power_save(struct hda_bus *bus, int delay); 492 void snd_hda_update_power_acct(struct hda_codec *codec); 493 #else 494 static inline void snd_hda_set_power_save(struct hda_bus *bus, int delay) {} 495 #endif 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 */ 532