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 rev;
  86         const char *name;
  87         int (*patch)(struct hda_codec *codec);
  88 };
  89
  90 #define HDA_CODEC_ID_GENERIC_HDMI       0x00000101
  91 #define HDA_CODEC_ID_GENERIC            0x00000201
  92
  93 struct hda_codec_driver {
  94         struct hdac_driver core;
  95         const struct hda_codec_preset *preset;
  96 };
  97
  98 int __hda_codec_driver_register(struct hda_codec_driver *drv, const char *name,
  99                                struct module *owner);
 100 #define hda_codec_driver_register(drv) \
 101         __hda_codec_driver_register(drv, KBUILD_MODNAME, THIS_MODULE)
 102 void hda_codec_driver_unregister(struct hda_codec_driver *drv);
 103 #define module_hda_codec_driver(drv) \
 104         module_driver(drv, hda_codec_driver_register, \
 105                       hda_codec_driver_unregister)
 106
 107 /* ops set by the preset patch */
 108 struct hda_codec_ops {
 109         int (*build_controls)(struct hda_codec *codec);
 110         int (*build_pcms)(struct hda_codec *codec);
 111         int (*init)(struct hda_codec *codec);
 112         void (*free)(struct hda_codec *codec);
 113         void (*unsol_event)(struct hda_codec *codec, unsigned int res);
 114         void (*set_power_state)(struct hda_codec *codec, hda_nid_t fg,
 115                                 unsigned int power_state);
 116 #ifdef CONFIG_PM
 117         int (*suspend)(struct hda_codec *codec);
 118         int (*resume)(struct hda_codec *codec);
 119         int (*check_power_status)(struct hda_codec *codec, hda_nid_t nid);
 120 #endif
 121         void (*reboot_notify)(struct hda_codec *codec);
 122         void (*stream_pm)(struct hda_codec *codec, hda_nid_t nid, bool on);
 123 };
 124
 125 /* PCM callbacks */
 126 struct hda_pcm_ops {
 127         int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
 128                     struct snd_pcm_substream *substream);
 129         int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
 130                      struct snd_pcm_substream *substream);
 131         int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
 132                        unsigned int stream_tag, unsigned int format,
 133                        struct snd_pcm_substream *substream);
 134         int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
 135                        struct snd_pcm_substream *substream);
 136         unsigned int (*get_delay)(struct hda_pcm_stream *info,
 137                                   struct hda_codec *codec,
 138                                   struct snd_pcm_substream *substream);
 139 };
 140
 141 /* PCM information for each substream */
 142 struct hda_pcm_stream {
 143         unsigned int substreams;        /* number of substreams, 0 = not exist*/
 144         unsigned int channels_min;      /* min. number of channels */
 145         unsigned int channels_max;      /* max. number of channels */
 146         hda_nid_t nid;  /* default NID to query rates/formats/bps, or set up */
 147         u32 rates;      /* supported rates */
 148         u64 formats;    /* supported formats (SNDRV_PCM_FMTBIT_) */
 149         unsigned int maxbps;    /* supported max. bit per sample */
 150         const struct snd_pcm_chmap_elem *chmap; /* chmap to override */
 151         struct hda_pcm_ops ops;
 152 };
 153
 154 /* PCM types */
 155 enum {
 156         HDA_PCM_TYPE_AUDIO,
 157         HDA_PCM_TYPE_SPDIF,
 158         HDA_PCM_TYPE_HDMI,
 159         HDA_PCM_TYPE_MODEM,
 160         HDA_PCM_NTYPES
 161 };
 162
 163 /* for PCM creation */
 164 struct hda_pcm {
 165         char *name;
 166         struct hda_pcm_stream stream[2];
 167         unsigned int pcm_type;  /* HDA_PCM_TYPE_XXX */
 168         int device;             /* device number to assign */
 169         struct snd_pcm *pcm;    /* assigned PCM instance */
 170         bool own_chmap;         /* codec driver provides own channel maps */
 171         /* private: */
 172         struct hda_codec *codec;
 173         struct kref kref;
 174         struct list_head list;
 175 };
 176
 177 /* codec information */
 178 struct hda_codec {
 179         struct hdac_device core;
 180         struct hda_bus *bus;
 181         struct snd_card *card;
 182         unsigned int addr;      /* codec addr*/
 183         u32 probe_id; /* overridden id for probing */
 184
 185         /* detected preset */
 186         const struct hda_codec_preset *preset;
 187         const char *modelname;  /* model name for preset */
 188
 189         /* set by patch */
 190         struct hda_codec_ops patch_ops;
 191
 192         /* PCM to create, set by patch_ops.build_pcms callback */
 193         struct list_head pcm_list_head;
 194
 195         /* codec specific info */
 196         void *spec;
 197
 198         /* beep device */
 199         struct hda_beep *beep;
 200         unsigned int beep_mode;
 201
 202         /* widget capabilities cache */
 203         u32 *wcaps;
 204
 205         struct snd_array mixers;        /* list of assigned mixer elements */
 206         struct snd_array nids;          /* list of mapped mixer elements */
 207
 208         struct list_head conn_list;     /* linked-list of connection-list */
 209
 210         struct mutex spdif_mutex;
 211         struct mutex control_mutex;
 212         struct snd_array spdif_out;
 213         unsigned int spdif_in_enable;   /* SPDIF input enable? */
 214         const hda_nid_t *slave_dig_outs; /* optional digital out slave widgets */
 215         struct snd_array init_pins;     /* initial (BIOS) pin configurations */
 216         struct snd_array driver_pins;   /* pin configs set by codec parser */
 217         struct snd_array cvt_setups;    /* audio convert setups */
 218
 219         struct mutex user_mutex;
 220 #ifdef CONFIG_SND_HDA_RECONFIG
 221         struct snd_array init_verbs;    /* additional init verbs */
 222         struct snd_array hints;         /* additional hints */
 223         struct snd_array user_pins;     /* default pin configs to override */
 224 #endif
 225
 226 #ifdef CONFIG_SND_HDA_HWDEP
 227         struct snd_hwdep *hwdep;        /* assigned hwdep device */
 228 #endif
 229
 230         /* misc flags */
 231         unsigned int in_freeing:1; /* being released */
 232         unsigned int registered:1; /* codec was registered */
 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 #ifdef CONFIG_PM
 256         unsigned long power_on_acct;
 257         unsigned long power_off_acct;
 258         unsigned long power_jiffies;
 259 #endif
 260
 261         /* filter the requested power state per nid */
 262         unsigned int (*power_filter)(struct hda_codec *codec, hda_nid_t nid,
 263                                      unsigned int power_state);
 264
 265         /* codec-specific additional proc output */
 266         void (*proc_widget_hook)(struct snd_info_buffer *buffer,
 267                                  struct hda_codec *codec, hda_nid_t nid);
 268
 269         /* jack detection */
 270         struct snd_array jacktbl;
 271         unsigned long jackpoll_interval; /* In jiffies. Zero means no poll, rely on unsol events */
 272         struct delayed_work jackpoll_work;
 273
 274         /* jack detection */
 275         struct snd_array jacks;
 276
 277         int depop_delay; /* depop delay in ms, -1 for default delay time */
 278
 279         /* fix-up list */
 280         int fixup_id;
 281         const struct hda_fixup *fixup_list;
 282         const char *fixup_name;
 283
 284         /* additional init verbs */
 285         struct snd_array verbs;
 286 };
 287
 288 #define dev_to_hda_codec(_dev)  container_of(_dev, struct hda_codec, core.dev)
 289 #define hda_codec_dev(_dev)     (&(_dev)->core.dev)
 290
 291 #define list_for_each_codec(c, bus) \
 292         list_for_each_entry(c, &(bus)->core.codec_list, core.list)
 293
 294 /* snd_hda_codec_read/write optional flags */
 295 #define HDA_RW_NO_RESPONSE_FALLBACK     (1 << 0)
 296
 297 /*
 298  * constructors
 299  */
 300 int snd_hda_bus_new(struct snd_card *card,
 301                     const struct hdac_bus_ops *ops,
 302                     const struct hdac_io_ops *io_ops,
 303                     struct hda_bus **busp);
 304 int snd_hda_codec_new(struct hda_bus *bus, struct snd_card *card,
 305                       unsigned int codec_addr, struct hda_codec **codecp);
 306 int snd_hda_codec_configure(struct hda_codec *codec);
 307 int snd_hda_codec_update_widgets(struct hda_codec *codec);
 308
 309 /*
 310  * low level functions
 311  */
 312 unsigned int snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
 313                                 int flags,
 314                                 unsigned int verb, unsigned int parm);
 315 int snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags,
 316                         unsigned int verb, unsigned int parm);
 317 #define snd_hda_param_read(codec, nid, param) \
 318         snd_hdac_read_parm(&(codec)->core, nid, param)
 319 #define snd_hda_get_sub_nodes(codec, nid, start_nid) \
 320         snd_hdac_get_sub_nodes(&(codec)->core, nid, start_nid)
 321 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
 322                             hda_nid_t *conn_list, int max_conns);
 323 static inline int
 324 snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid)
 325 {
 326         return snd_hda_get_connections(codec, nid, NULL, 0);
 327 }
 328
 329 #define snd_hda_get_raw_connections(codec, nid, list, max_conns) \
 330         snd_hdac_get_connections(&(codec)->core, nid, list, max_conns)
 331 #define snd_hda_get_num_raw_conns(codec, nid) \
 332         snd_hdac_get_connections(&(codec)->core, nid, NULL, 0);
 333
 334 int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid,
 335                           const hda_nid_t **listp);
 336 int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums,
 337                           const hda_nid_t *list);
 338 int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux,
 339                            hda_nid_t nid, int recursive);
 340 int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid,
 341                         u8 *dev_list, int max_devices);
 342
 343 struct hda_verb {
 344         hda_nid_t nid;
 345         u32 verb;
 346         u32 param;
 347 };
 348
 349 void snd_hda_sequence_write(struct hda_codec *codec,
 350                             const struct hda_verb *seq);
 351
 352 /* unsolicited event */
 353 static inline void
 354 snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex)
 355 {
 356         snd_hdac_bus_queue_event(&bus->core, res, res_ex);
 357 }
 358
 359 /* cached write */
 360 static inline int
 361 snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
 362                           int flags, unsigned int verb, unsigned int parm)
 363 {
 364         return snd_hdac_regmap_write(&codec->core, nid, verb, parm);
 365 }
 366
 367 #define snd_hda_codec_update_cache(codec, nid, flags, verb, parm) \
 368         snd_hda_codec_write_cache(codec, nid, flags, verb, parm)
 369
 370 /* the struct for codec->pin_configs */
 371 struct hda_pincfg {
 372         hda_nid_t nid;
 373         unsigned char ctrl;     /* original pin control value */
 374         unsigned char target;   /* target pin control value */
 375         unsigned int cfg;       /* default configuration */
 376 };
 377
 378 unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid);
 379 int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid,
 380                              unsigned int cfg);
 381 int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
 382                        hda_nid_t nid, unsigned int cfg); /* for hwdep */
 383 void snd_hda_shutup_pins(struct hda_codec *codec);
 384
 385 /* SPDIF controls */
 386 struct hda_spdif_out {
 387         hda_nid_t nid;          /* Converter nid values relate to */
 388         unsigned int status;    /* IEC958 status bits */
 389         unsigned short ctls;    /* SPDIF control bits */
 390 };
 391 struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec,
 392                                                hda_nid_t nid);
 393 void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx);
 394 void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid);
 395
 396 /*
 397  * Mixer
 398  */
 399 int snd_hda_codec_build_controls(struct hda_codec *codec);
 400
 401 /*
 402  * PCM
 403  */
 404 int snd_hda_codec_parse_pcms(struct hda_codec *codec);
 405 int snd_hda_codec_build_pcms(struct hda_codec *codec);
 406
 407 __printf(2, 3)
 408 struct hda_pcm *snd_hda_codec_pcm_new(struct hda_codec *codec,
 409                                       const char *fmt, ...);
 410
 411 static inline void snd_hda_codec_pcm_get(struct hda_pcm *pcm)
 412 {
 413         kref_get(&pcm->kref);
 414 }
 415 void snd_hda_codec_pcm_put(struct hda_pcm *pcm);
 416
 417 int snd_hda_codec_prepare(struct hda_codec *codec,
 418                           struct hda_pcm_stream *hinfo,
 419                           unsigned int stream,
 420                           unsigned int format,
 421                           struct snd_pcm_substream *substream);
 422 void snd_hda_codec_cleanup(struct hda_codec *codec,
 423                            struct hda_pcm_stream *hinfo,
 424                            struct snd_pcm_substream *substream);
 425
 426 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
 427                                 u32 stream_tag,
 428                                 int channel_id, int format);
 429 void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid,
 430                                     int do_now);
 431 #define snd_hda_codec_cleanup_stream(codec, nid) \
 432         __snd_hda_codec_cleanup_stream(codec, nid, 0)
 433
 434 #define snd_hda_query_supported_pcm(codec, nid, ratesp, fmtsp, bpsp) \
 435         snd_hdac_query_supported_pcm(&(codec)->core, nid, ratesp, fmtsp, bpsp)
 436 #define snd_hda_is_supported_format(codec, nid, fmt) \
 437         snd_hdac_is_supported_format(&(codec)->core, nid, fmt)
 438
 439 extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[];
 440
 441 int snd_hda_attach_pcm_stream(struct hda_bus *_bus, struct hda_codec *codec,
 442                               struct hda_pcm *cpcm);
 443
 444 /*
 445  * Misc
 446  */
 447 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
 448 void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg,
 449                                     unsigned int power_state);
 450
 451 int snd_hda_lock_devices(struct hda_bus *bus);
 452 void snd_hda_unlock_devices(struct hda_bus *bus);
 453 void snd_hda_bus_reset(struct hda_bus *bus);
 454 void snd_hda_bus_reset_codecs(struct hda_bus *bus);
 455
 456 /*
 457  * power management
 458  */
 459 extern const struct dev_pm_ops hda_codec_driver_pm;
 460
 461 static inline
 462 int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid)
 463 {
 464 #ifdef CONFIG_PM
 465         if (codec->patch_ops.check_power_status)
 466                 return codec->patch_ops.check_power_status(codec, nid);
 467 #endif
 468         return 0;
 469 }
 470
 471 /*
 472  * power saving
 473  */
 474 #define snd_hda_power_up(codec)         snd_hdac_power_up(&(codec)->core)
 475 #define snd_hda_power_up_pm(codec)      snd_hdac_power_up_pm(&(codec)->core)
 476 #define snd_hda_power_down(codec)       snd_hdac_power_down(&(codec)->core)
 477 #define snd_hda_power_down_pm(codec)    snd_hdac_power_down_pm(&(codec)->core)
 478 #ifdef CONFIG_PM
 479 void snd_hda_set_power_save(struct hda_bus *bus, int delay);
 480 void snd_hda_update_power_acct(struct hda_codec *codec);
 481 #else
 482 static inline void snd_hda_set_power_save(struct hda_bus *bus, int delay) {}
 483 #endif
 484
 485 #ifdef CONFIG_SND_HDA_PATCH_LOADER
 486 /*
 487  * patch firmware
 488  */
 489 int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf);
 490 #endif
 491
 492 #ifdef CONFIG_SND_HDA_DSP_LOADER
 493 int snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
 494                                    unsigned int size,
 495                                    struct snd_dma_buffer *bufp);
 496 void snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start);
 497 void snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
 498                                     struct snd_dma_buffer *dmab);
 499 #else
 500 static inline int
 501 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
 502                                 unsigned int size,
 503                                 struct snd_dma_buffer *bufp)
 504 {
 505         return -ENOSYS;
 506 }
 507 static inline void
 508 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {}
 509 static inline void
 510 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
 511                                 struct snd_dma_buffer *dmab) {}
 512 #endif
 513
 514 #endif /* __SOUND_HDA_CODEC_H */