sound/pci/hda/hda_codec.h

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