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 28struct hda_bus; 29struct hda_beep; 30struct hda_codec; 31struct hda_pcm; 32struct 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 */ 40struct 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 */ 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 (*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 */ 122struct 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 */ 138struct 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 */ 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 kref kref; 171 struct list_head list; 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 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 configured:1; /* codec was configured */ 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 forced_resume:1; /* forced resume for jack */ 258 unsigned int mst_no_extra_pcms:1; /* no backup PCMs for DP-MST */ 259 260#ifdef CONFIG_PM 261 unsigned long power_on_acct; 262 unsigned long power_off_acct; 263 unsigned long power_jiffies; 264#endif 265 266 /* filter the requested power state per nid */ 267 unsigned int (*power_filter)(struct hda_codec *codec, hda_nid_t nid, 268 unsigned int power_state); 269 270 /* codec-specific additional proc output */ 271 void (*proc_widget_hook)(struct snd_info_buffer *buffer, 272 struct hda_codec *codec, hda_nid_t nid); 273 274 /* jack detection */ 275 struct snd_array jacktbl; 276 unsigned long jackpoll_interval; /* In jiffies. Zero means no poll, rely on unsol events */ 277 struct delayed_work jackpoll_work; 278 279 int depop_delay; /* depop delay in ms, -1 for default delay time */ 280 281 /* fix-up list */ 282 int fixup_id; 283 const struct hda_fixup *fixup_list; 284 const char *fixup_name; 285 286 /* additional init verbs */ 287 struct snd_array verbs; 288}; 289 290#define dev_to_hda_codec(_dev) container_of(_dev, struct hda_codec, core.dev) 291#define hda_codec_dev(_dev) (&(_dev)->core.dev) 292 293#define hdac_to_hda_priv(_hdac) \ 294 container_of(_hdac, struct hdac_hda_priv, codec.core) 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 */ 308int snd_hda_codec_new(struct hda_bus *bus, struct snd_card *card, 309 unsigned int codec_addr, struct hda_codec **codecp); 310int snd_hda_codec_device_new(struct hda_bus *bus, struct snd_card *card, 311 unsigned int codec_addr, struct hda_codec *codec); 312int snd_hda_codec_configure(struct hda_codec *codec); 313int snd_hda_codec_update_widgets(struct hda_codec *codec); 314 315/* 316 * low level functions 317 */ 318static inline unsigned int 319snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid, 320 int flags, 321 unsigned int verb, unsigned int parm) 322{ 323 return snd_hdac_codec_read(&codec->core, nid, flags, verb, parm); 324} 325 326static inline int 327snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags, 328 unsigned int verb, unsigned int parm) 329{ 330 return snd_hdac_codec_write(&codec->core, nid, flags, verb, parm); 331} 332 333#define snd_hda_param_read(codec, nid, param) \ 334 snd_hdac_read_parm(&(codec)->core, nid, param) 335#define snd_hda_get_sub_nodes(codec, nid, start_nid) \ 336 snd_hdac_get_sub_nodes(&(codec)->core, nid, start_nid) 337int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid, 338 hda_nid_t *conn_list, int max_conns); 339static inline int 340snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid) 341{ 342 return snd_hda_get_connections(codec, nid, NULL, 0); 343} 344 345#define snd_hda_get_raw_connections(codec, nid, list, max_conns) \ 346 snd_hdac_get_connections(&(codec)->core, nid, list, max_conns) 347#define snd_hda_get_num_raw_conns(codec, nid) \ 348 snd_hdac_get_connections(&(codec)->core, nid, NULL, 0); 349 350int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid, 351 const hda_nid_t **listp); 352int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums, 353 const hda_nid_t *list); 354int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux, 355 hda_nid_t nid, int recursive); 356unsigned int snd_hda_get_num_devices(struct hda_codec *codec, hda_nid_t nid); 357int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid, 358 u8 *dev_list, int max_devices); 359int snd_hda_get_dev_select(struct hda_codec *codec, hda_nid_t nid); 360int snd_hda_set_dev_select(struct hda_codec *codec, hda_nid_t nid, int dev_id); 361 362struct hda_verb { 363 hda_nid_t nid; 364 u32 verb; 365 u32 param; 366}; 367 368void snd_hda_sequence_write(struct hda_codec *codec, 369 const struct hda_verb *seq); 370 371/* cached write */ 372static inline int 373snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid, 374 int flags, unsigned int verb, unsigned int parm) 375{ 376 return snd_hdac_regmap_write(&codec->core, nid, verb, parm); 377} 378 379/* the struct for codec->pin_configs */ 380struct hda_pincfg { 381 hda_nid_t nid; 382 unsigned char ctrl; /* original pin control value */ 383 unsigned char target; /* target pin control value */ 384 unsigned int cfg; /* default configuration */ 385}; 386 387unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid); 388int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid, 389 unsigned int cfg); 390int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list, 391 hda_nid_t nid, unsigned int cfg); /* for hwdep */ 392void snd_hda_shutup_pins(struct hda_codec *codec); 393 394/* SPDIF controls */ 395struct hda_spdif_out { 396 hda_nid_t nid; /* Converter nid values relate to */ 397 unsigned int status; /* IEC958 status bits */ 398 unsigned short ctls; /* SPDIF control bits */ 399}; 400struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec, 401 hda_nid_t nid); 402void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx); 403void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid); 404 405/* 406 * Mixer 407 */ 408int snd_hda_codec_build_controls(struct hda_codec *codec); 409 410/* 411 * PCM 412 */ 413int snd_hda_codec_parse_pcms(struct hda_codec *codec); 414int snd_hda_codec_build_pcms(struct hda_codec *codec); 415 416__printf(2, 3) 417struct hda_pcm *snd_hda_codec_pcm_new(struct hda_codec *codec, 418 const char *fmt, ...); 419 420void snd_hda_codec_cleanup_for_unbind(struct hda_codec *codec); 421 422static inline void snd_hda_codec_pcm_get(struct hda_pcm *pcm) 423{ 424 kref_get(&pcm->kref); 425} 426void snd_hda_codec_pcm_put(struct hda_pcm *pcm); 427 428int 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); 433void snd_hda_codec_cleanup(struct hda_codec *codec, 434 struct hda_pcm_stream *hinfo, 435 struct snd_pcm_substream *substream); 436 437void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid, 438 u32 stream_tag, 439 int channel_id, int format); 440void __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 450extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[]; 451 452int snd_hda_attach_pcm_stream(struct hda_bus *_bus, struct hda_codec *codec, 453 struct hda_pcm *cpcm); 454 455/* 456 * Misc 457 */ 458void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen); 459void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg, 460 unsigned int power_state); 461 462int snd_hda_lock_devices(struct hda_bus *bus); 463void snd_hda_unlock_devices(struct hda_bus *bus); 464void snd_hda_bus_reset(struct hda_bus *bus); 465void snd_hda_bus_reset_codecs(struct hda_bus *bus); 466 467int snd_hda_codec_set_name(struct hda_codec *codec, const char *name); 468 469/* 470 * power management 471 */ 472extern const struct dev_pm_ops hda_codec_driver_pm; 473 474static inline 475int 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 492void snd_hda_set_power_save(struct hda_bus *bus, int delay); 493void snd_hda_update_power_acct(struct hda_codec *codec); 494#else 495static inline void snd_hda_set_power_save(struct hda_bus *bus, int delay) {} 496#endif 497 498static inline bool hda_codec_need_resume(struct hda_codec *codec) 499{ 500 return !codec->relaxed_resume && codec->jacktbl.used; 501} 502 503#ifdef CONFIG_SND_HDA_PATCH_LOADER 504/* 505 * patch firmware 506 */ 507int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf); 508#endif 509 510#ifdef CONFIG_SND_HDA_DSP_LOADER 511int snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format, 512 unsigned int size, 513 struct snd_dma_buffer *bufp); 514void snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start); 515void snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec, 516 struct snd_dma_buffer *dmab); 517#else 518static inline int 519snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format, 520 unsigned int size, 521 struct snd_dma_buffer *bufp) 522{ 523 return -ENOSYS; 524} 525static inline void 526snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {} 527static inline void 528snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec, 529 struct snd_dma_buffer *dmab) {} 530#endif 531 532#endif /* __SOUND_HDA_CODEC_H */ 533