1/* 2 * Universal Interface for Intel High Definition Audio Codec 3 * 4 * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de> 5 * 6 * This program is free software; you can redistribute it and/or modify it 7 * under the terms of the GNU General Public License as published by the Free 8 * Software Foundation; either version 2 of the License, or (at your option) 9 * any later version. 10 * 11 * This program is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 14 * more details. 15 * 16 * You should have received a copy of the GNU General Public License along with 17 * this program; if not, write to the Free Software Foundation, Inc., 59 18 * Temple Place - Suite 330, Boston, MA 02111-1307, USA. 19 */ 20 21#ifndef __SOUND_HDA_CODEC_H 22#define __SOUND_HDA_CODEC_H 23 24#include <linux/kref.h> 25#include <sound/info.h> 26#include <sound/control.h> 27#include <sound/pcm.h> 28#include <sound/hwdep.h> 29#include <sound/hdaudio.h> 30#include <sound/hda_verbs.h> 31#include <sound/hda_regmap.h> 32 33/* 34 * Structures 35 */ 36 37struct hda_bus; 38struct hda_beep; 39struct hda_codec; 40struct hda_pcm; 41struct hda_pcm_stream; 42 43/* bus operators */ 44struct hda_bus_ops { 45 /* send a single command */ 46 int (*command)(struct hda_bus *bus, unsigned int cmd); 47 /* get a response from the last command */ 48 unsigned int (*get_response)(struct hda_bus *bus, unsigned int addr); 49 /* free the private data */ 50 void (*private_free)(struct hda_bus *); 51 /* attach a PCM stream */ 52 int (*attach_pcm)(struct hda_bus *bus, struct hda_codec *codec, 53 struct hda_pcm *pcm); 54 /* reset bus for retry verb */ 55 void (*bus_reset)(struct hda_bus *bus); 56#ifdef CONFIG_SND_HDA_DSP_LOADER 57 /* prepare DSP transfer */ 58 int (*load_dsp_prepare)(struct hda_bus *bus, unsigned int format, 59 unsigned int byte_size, 60 struct snd_dma_buffer *bufp); 61 /* start/stop DSP transfer */ 62 void (*load_dsp_trigger)(struct hda_bus *bus, bool start); 63 /* clean up DSP transfer */ 64 void (*load_dsp_cleanup)(struct hda_bus *bus, 65 struct snd_dma_buffer *dmab); 66#endif 67}; 68 69/* 70 * codec bus 71 * 72 * each controller needs to creata a hda_bus to assign the accessor. 73 * A hda_bus contains several codecs in the list codec_list. 74 */ 75struct hda_bus { 76 struct hdac_bus core; 77 78 struct snd_card *card; 79 80 void *private_data; 81 struct pci_dev *pci; 82 const char *modelname; 83 struct hda_bus_ops ops; 84 85 struct mutex prepare_mutex; 86 87 /* assigned PCMs */ 88 DECLARE_BITMAP(pcm_dev_bits, SNDRV_PCM_DEVICES); 89 90 /* misc op flags */ 91 unsigned int needs_damn_long_delay :1; 92 unsigned int allow_bus_reset:1; /* allow bus reset at fatal error */ 93 /* status for codec/controller */ 94 unsigned int shutdown :1; /* being unloaded */ 95 unsigned int rirb_error:1; /* error in codec communication */ 96 unsigned int response_reset:1; /* controller was reset */ 97 unsigned int in_reset:1; /* during reset operation */ 98 unsigned int no_response_fallback:1; /* don't fallback at RIRB error */ 99 100 int primary_dig_out_type; /* primary digital out PCM type */ 101}; 102 103/* 104 * codec preset 105 * 106 * Known codecs have the patch to build and set up the controls/PCMs 107 * better than the generic parser. 108 */ 109struct hda_codec_preset { 110 unsigned int id; 111 unsigned int mask; 112 unsigned int subs; 113 unsigned int subs_mask; 114 unsigned int rev; 115 hda_nid_t afg, mfg; 116 const char *name; 117 int (*patch)(struct hda_codec *codec); 118}; 119 120#define HDA_CODEC_ID_GENERIC_HDMI 0x00000101 121#define HDA_CODEC_ID_GENERIC 0x00000201 122 123struct hda_codec_driver { 124 struct hdac_driver core; 125 const struct hda_codec_preset *preset; 126}; 127 128int __hda_codec_driver_register(struct hda_codec_driver *drv, const char *name, 129 struct module *owner); 130#define hda_codec_driver_register(drv) \ 131 __hda_codec_driver_register(drv, KBUILD_MODNAME, THIS_MODULE) 132void hda_codec_driver_unregister(struct hda_codec_driver *drv); 133#define module_hda_codec_driver(drv) \ 134 module_driver(drv, hda_codec_driver_register, \ 135 hda_codec_driver_unregister) 136 137/* ops set by the preset patch */ 138struct hda_codec_ops { 139 int (*build_controls)(struct hda_codec *codec); 140 int (*build_pcms)(struct hda_codec *codec); 141 int (*init)(struct hda_codec *codec); 142 void (*free)(struct hda_codec *codec); 143 void (*unsol_event)(struct hda_codec *codec, unsigned int res); 144 void (*set_power_state)(struct hda_codec *codec, hda_nid_t fg, 145 unsigned int power_state); 146#ifdef CONFIG_PM 147 int (*suspend)(struct hda_codec *codec); 148 int (*resume)(struct hda_codec *codec); 149 int (*check_power_status)(struct hda_codec *codec, hda_nid_t nid); 150#endif 151 void (*reboot_notify)(struct hda_codec *codec); 152 void (*stream_pm)(struct hda_codec *codec, hda_nid_t nid, bool on); 153}; 154 155/* PCM callbacks */ 156struct hda_pcm_ops { 157 int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec, 158 struct snd_pcm_substream *substream); 159 int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec, 160 struct snd_pcm_substream *substream); 161 int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec, 162 unsigned int stream_tag, unsigned int format, 163 struct snd_pcm_substream *substream); 164 int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec, 165 struct snd_pcm_substream *substream); 166 unsigned int (*get_delay)(struct hda_pcm_stream *info, 167 struct hda_codec *codec, 168 struct snd_pcm_substream *substream); 169}; 170 171/* PCM information for each substream */ 172struct hda_pcm_stream { 173 unsigned int substreams; /* number of substreams, 0 = not exist*/ 174 unsigned int channels_min; /* min. number of channels */ 175 unsigned int channels_max; /* max. number of channels */ 176 hda_nid_t nid; /* default NID to query rates/formats/bps, or set up */ 177 u32 rates; /* supported rates */ 178 u64 formats; /* supported formats (SNDRV_PCM_FMTBIT_) */ 179 unsigned int maxbps; /* supported max. bit per sample */ 180 const struct snd_pcm_chmap_elem *chmap; /* chmap to override */ 181 struct hda_pcm_ops ops; 182}; 183 184/* PCM types */ 185enum { 186 HDA_PCM_TYPE_AUDIO, 187 HDA_PCM_TYPE_SPDIF, 188 HDA_PCM_TYPE_HDMI, 189 HDA_PCM_TYPE_MODEM, 190 HDA_PCM_NTYPES 191}; 192 193/* for PCM creation */ 194struct hda_pcm { 195 char *name; 196 struct hda_pcm_stream stream[2]; 197 unsigned int pcm_type; /* HDA_PCM_TYPE_XXX */ 198 int device; /* device number to assign */ 199 struct snd_pcm *pcm; /* assigned PCM instance */ 200 bool own_chmap; /* codec driver provides own channel maps */ 201 /* private: */ 202 struct hda_codec *codec; 203 struct kref kref; 204 struct list_head list; 205}; 206 207/* codec information */ 208struct hda_codec { 209 struct hdac_device core; 210 struct hda_bus *bus; 211 struct snd_card *card; 212 unsigned int addr; /* codec addr*/ 213 u32 probe_id; /* overridden id for probing */ 214 215 /* detected preset */ 216 const struct hda_codec_preset *preset; 217 const char *modelname; /* model name for preset */ 218 219 /* set by patch */ 220 struct hda_codec_ops patch_ops; 221 222 /* PCM to create, set by patch_ops.build_pcms callback */ 223 struct list_head pcm_list_head; 224 225 /* codec specific info */ 226 void *spec; 227 228 /* beep device */ 229 struct hda_beep *beep; 230 unsigned int beep_mode; 231 232 /* widget capabilities cache */ 233 u32 *wcaps; 234 235 struct snd_array mixers; /* list of assigned mixer elements */ 236 struct snd_array nids; /* list of mapped mixer elements */ 237 238 struct list_head conn_list; /* linked-list of connection-list */ 239 240 struct mutex spdif_mutex; 241 struct mutex control_mutex; 242 struct snd_array spdif_out; 243 unsigned int spdif_in_enable; /* SPDIF input enable? */ 244 const hda_nid_t *slave_dig_outs; /* optional digital out slave widgets */ 245 struct snd_array init_pins; /* initial (BIOS) pin configurations */ 246 struct snd_array driver_pins; /* pin configs set by codec parser */ 247 struct snd_array cvt_setups; /* audio convert setups */ 248 249 struct mutex user_mutex; 250#ifdef CONFIG_SND_HDA_RECONFIG 251 struct snd_array init_verbs; /* additional init verbs */ 252 struct snd_array hints; /* additional hints */ 253 struct snd_array user_pins; /* default pin configs to override */ 254#endif 255 256#ifdef CONFIG_SND_HDA_HWDEP 257 struct snd_hwdep *hwdep; /* assigned hwdep device */ 258#endif 259 260 /* misc flags */ 261 unsigned int in_freeing:1; /* being released */ 262 unsigned int registered:1; /* codec was registered */ 263 unsigned int spdif_status_reset :1; /* needs to toggle SPDIF for each 264 * status change 265 * (e.g. Realtek codecs) 266 */ 267 unsigned int pin_amp_workaround:1; /* pin out-amp takes index 268 * (e.g. Conexant codecs) 269 */ 270 unsigned int single_adc_amp:1; /* adc in-amp takes no index 271 * (e.g. CX20549 codec) 272 */ 273 unsigned int no_sticky_stream:1; /* no sticky-PCM stream assignment */ 274 unsigned int pins_shutup:1; /* pins are shut up */ 275 unsigned int no_trigger_sense:1; /* don't trigger at pin-sensing */ 276 unsigned int no_jack_detect:1; /* Machine has no jack-detection */ 277 unsigned int inv_eapd:1; /* broken h/w: inverted EAPD control */ 278 unsigned int inv_jack_detect:1; /* broken h/w: inverted detection bit */ 279 unsigned int pcm_format_first:1; /* PCM format must be set first */ 280 unsigned int cached_write:1; /* write only to caches */ 281 unsigned int dp_mst:1; /* support DP1.2 Multi-stream transport */ 282 unsigned int dump_coef:1; /* dump processing coefs in codec proc file */ 283 unsigned int power_save_node:1; /* advanced PM for each widget */ 284#ifdef CONFIG_PM 285 unsigned long power_on_acct; 286 unsigned long power_off_acct; 287 unsigned long power_jiffies; 288#endif 289 290 /* filter the requested power state per nid */ 291 unsigned int (*power_filter)(struct hda_codec *codec, hda_nid_t nid, 292 unsigned int power_state); 293 294 /* codec-specific additional proc output */ 295 void (*proc_widget_hook)(struct snd_info_buffer *buffer, 296 struct hda_codec *codec, hda_nid_t nid); 297 298 /* jack detection */ 299 struct snd_array jacktbl; 300 unsigned long jackpoll_interval; /* In jiffies. Zero means no poll, rely on unsol events */ 301 struct delayed_work jackpoll_work; 302 303#ifdef CONFIG_SND_HDA_INPUT_JACK 304 /* jack detection */ 305 struct snd_array jacks; 306#endif 307 308 int depop_delay; /* depop delay in ms, -1 for default delay time */ 309 310 /* fix-up list */ 311 int fixup_id; 312 const struct hda_fixup *fixup_list; 313 const char *fixup_name; 314 315 /* additional init verbs */ 316 struct snd_array verbs; 317}; 318 319#define dev_to_hda_codec(_dev) container_of(_dev, struct hda_codec, core.dev) 320#define hda_codec_dev(_dev) (&(_dev)->core.dev) 321 322#define list_for_each_codec(c, bus) \ 323 list_for_each_entry(c, &(bus)->core.codec_list, core.list) 324 325/* snd_hda_codec_read/write optional flags */ 326#define HDA_RW_NO_RESPONSE_FALLBACK (1 << 0) 327 328/* 329 * constructors 330 */ 331int snd_hda_bus_new(struct snd_card *card, struct hda_bus **busp); 332int snd_hda_codec_new(struct hda_bus *bus, struct snd_card *card, 333 unsigned int codec_addr, struct hda_codec **codecp); 334int snd_hda_codec_configure(struct hda_codec *codec); 335int snd_hda_codec_update_widgets(struct hda_codec *codec); 336 337/* 338 * low level functions 339 */ 340unsigned int snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid, 341 int flags, 342 unsigned int verb, unsigned int parm); 343int snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags, 344 unsigned int verb, unsigned int parm); 345#define snd_hda_param_read(codec, nid, param) \ 346 snd_hdac_read_parm(&(codec)->core, nid, param) 347#define snd_hda_get_sub_nodes(codec, nid, start_nid) \ 348 snd_hdac_get_sub_nodes(&(codec)->core, nid, start_nid) 349int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid, 350 hda_nid_t *conn_list, int max_conns); 351static inline int 352snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid) 353{ 354 return snd_hda_get_connections(codec, nid, NULL, 0); 355} 356 357#define snd_hda_get_raw_connections(codec, nid, list, max_conns) \ 358 snd_hdac_get_connections(&(codec)->core, nid, list, max_conns) 359#define snd_hda_get_num_raw_conns(codec, nid) \ 360 snd_hdac_get_connections(&(codec)->core, nid, NULL, 0); 361 362int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid, 363 const hda_nid_t **listp); 364int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums, 365 const hda_nid_t *list); 366int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux, 367 hda_nid_t nid, int recursive); 368int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid, 369 u8 *dev_list, int max_devices); 370int snd_hda_query_supported_pcm(struct hda_codec *codec, hda_nid_t nid, 371 u32 *ratesp, u64 *formatsp, unsigned int *bpsp); 372 373struct hda_verb { 374 hda_nid_t nid; 375 u32 verb; 376 u32 param; 377}; 378 379void snd_hda_sequence_write(struct hda_codec *codec, 380 const struct hda_verb *seq); 381 382/* unsolicited event */ 383static inline void 384snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex) 385{ 386 snd_hdac_bus_queue_event(&bus->core, res, res_ex); 387} 388 389/* cached write */ 390static inline int 391snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid, 392 int flags, unsigned int verb, unsigned int parm) 393{ 394 return snd_hdac_regmap_write(&codec->core, nid, verb, parm); 395} 396 397#define snd_hda_codec_update_cache(codec, nid, flags, verb, parm) \ 398 snd_hda_codec_write_cache(codec, nid, flags, verb, parm) 399 400/* the struct for codec->pin_configs */ 401struct hda_pincfg { 402 hda_nid_t nid; 403 unsigned char ctrl; /* original pin control value */ 404 unsigned char target; /* target pin control value */ 405 unsigned int cfg; /* default configuration */ 406}; 407 408unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid); 409int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid, 410 unsigned int cfg); 411int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list, 412 hda_nid_t nid, unsigned int cfg); /* for hwdep */ 413void snd_hda_shutup_pins(struct hda_codec *codec); 414 415/* SPDIF controls */ 416struct hda_spdif_out { 417 hda_nid_t nid; /* Converter nid values relate to */ 418 unsigned int status; /* IEC958 status bits */ 419 unsigned short ctls; /* SPDIF control bits */ 420}; 421struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec, 422 hda_nid_t nid); 423void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx); 424void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid); 425 426/* 427 * Mixer 428 */ 429int snd_hda_codec_build_controls(struct hda_codec *codec); 430 431/* 432 * PCM 433 */ 434int snd_hda_codec_parse_pcms(struct hda_codec *codec); 435int snd_hda_codec_build_pcms(struct hda_codec *codec); 436 437__printf(2, 3) 438struct hda_pcm *snd_hda_codec_pcm_new(struct hda_codec *codec, 439 const char *fmt, ...); 440 441static inline void snd_hda_codec_pcm_get(struct hda_pcm *pcm) 442{ 443 kref_get(&pcm->kref); 444} 445void snd_hda_codec_pcm_put(struct hda_pcm *pcm); 446 447int snd_hda_codec_prepare(struct hda_codec *codec, 448 struct hda_pcm_stream *hinfo, 449 unsigned int stream, 450 unsigned int format, 451 struct snd_pcm_substream *substream); 452void snd_hda_codec_cleanup(struct hda_codec *codec, 453 struct hda_pcm_stream *hinfo, 454 struct snd_pcm_substream *substream); 455 456void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid, 457 u32 stream_tag, 458 int channel_id, int format); 459void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid, 460 int do_now); 461#define snd_hda_codec_cleanup_stream(codec, nid) \ 462 __snd_hda_codec_cleanup_stream(codec, nid, 0) 463unsigned int snd_hda_calc_stream_format(struct hda_codec *codec, 464 unsigned int rate, 465 unsigned int channels, 466 unsigned int format, 467 unsigned int maxbps, 468 unsigned short spdif_ctls); 469int snd_hda_is_supported_format(struct hda_codec *codec, hda_nid_t nid, 470 unsigned int format); 471 472extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[]; 473 474/* 475 * Misc 476 */ 477void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen); 478void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg, 479 unsigned int power_state); 480 481int snd_hda_lock_devices(struct hda_bus *bus); 482void snd_hda_unlock_devices(struct hda_bus *bus); 483void snd_hda_bus_reset(struct hda_bus *bus); 484 485/* 486 * power management 487 */ 488extern const struct dev_pm_ops hda_codec_driver_pm; 489 490static inline 491int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid) 492{ 493#ifdef CONFIG_PM 494 if (codec->patch_ops.check_power_status) 495 return codec->patch_ops.check_power_status(codec, nid); 496#endif 497 return 0; 498} 499 500/* 501 * get widget information 502 */ 503const char *snd_hda_get_jack_connectivity(u32 cfg); 504const char *snd_hda_get_jack_type(u32 cfg); 505const char *snd_hda_get_jack_location(u32 cfg); 506 507/* 508 * power saving 509 */ 510#define snd_hda_power_up(codec) snd_hdac_power_up(&(codec)->core) 511#define snd_hda_power_up_pm(codec) snd_hdac_power_up_pm(&(codec)->core) 512#define snd_hda_power_down(codec) snd_hdac_power_down(&(codec)->core) 513#define snd_hda_power_down_pm(codec) snd_hdac_power_down_pm(&(codec)->core) 514#ifdef CONFIG_PM 515void snd_hda_set_power_save(struct hda_bus *bus, int delay); 516void snd_hda_update_power_acct(struct hda_codec *codec); 517#else 518static inline void snd_hda_set_power_save(struct hda_bus *bus, int delay) {} 519#endif 520 521#ifdef CONFIG_SND_HDA_PATCH_LOADER 522/* 523 * patch firmware 524 */ 525int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf); 526#endif 527 528#ifdef CONFIG_SND_HDA_DSP_LOADER 529static inline int 530snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format, 531 unsigned int size, 532 struct snd_dma_buffer *bufp) 533{ 534 return codec->bus->ops.load_dsp_prepare(codec->bus, format, size, bufp); 535} 536static inline void 537snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) 538{ 539 return codec->bus->ops.load_dsp_trigger(codec->bus, start); 540} 541static inline void 542snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec, 543 struct snd_dma_buffer *dmab) 544{ 545 return codec->bus->ops.load_dsp_cleanup(codec->bus, dmab); 546} 547#else 548static inline int 549snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format, 550 unsigned int size, 551 struct snd_dma_buffer *bufp) 552{ 553 return -ENOSYS; 554} 555static inline void 556snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {} 557static inline void 558snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec, 559 struct snd_dma_buffer *dmab) {} 560#endif 561 562#endif /* __SOUND_HDA_CODEC_H */ 563