git.oblomov.eu Git - linux-2.6/blob - 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 <sound/info.h>
  25 #include <sound/control.h>
  26 #include <sound/pcm.h>
  27
  28 /*
  29  * nodes
  30  */
  31 #define AC_NODE_ROOT            0x00
  32
  33 /*
  34  * function group types
  35  */
  36 enum {
  37         AC_GRP_AUDIO_FUNCTION = 0x01,
  38         AC_GRP_MODEM_FUNCTION = 0x02,
  39 };
  40
  41 /*
  42  * widget types
  43  */
  44 enum {
  45         AC_WID_AUD_OUT,         /* Audio Out */
  46         AC_WID_AUD_IN,          /* Audio In */
  47         AC_WID_AUD_MIX,         /* Audio Mixer */
  48         AC_WID_AUD_SEL,         /* Audio Selector */
  49         AC_WID_PIN,             /* Pin Complex */
  50         AC_WID_POWER,           /* Power */
  51         AC_WID_VOL_KNB,         /* Volume Knob */
  52         AC_WID_BEEP,            /* Beep Generator */
  53         AC_WID_VENDOR = 0x0f    /* Vendor specific */
  54 };
  55
  56 /*
  57  * GET verbs
  58  */
  59 #define AC_VERB_GET_STREAM_FORMAT               0x0a00
  60 #define AC_VERB_GET_AMP_GAIN_MUTE               0x0b00
  61 #define AC_VERB_GET_PROC_COEF                   0x0c00
  62 #define AC_VERB_GET_COEF_INDEX                  0x0d00
  63 #define AC_VERB_PARAMETERS                      0x0f00
  64 #define AC_VERB_GET_CONNECT_SEL                 0x0f01
  65 #define AC_VERB_GET_CONNECT_LIST                0x0f02
  66 #define AC_VERB_GET_PROC_STATE                  0x0f03
  67 #define AC_VERB_GET_SDI_SELECT                  0x0f04
  68 #define AC_VERB_GET_POWER_STATE                 0x0f05
  69 #define AC_VERB_GET_CONV                        0x0f06
  70 #define AC_VERB_GET_PIN_WIDGET_CONTROL          0x0f07
  71 #define AC_VERB_GET_UNSOLICITED_RESPONSE        0x0f08
  72 #define AC_VERB_GET_PIN_SENSE                   0x0f09
  73 #define AC_VERB_GET_BEEP_CONTROL                0x0f0a
  74 #define AC_VERB_GET_EAPD_BTLENABLE              0x0f0c
  75 #define AC_VERB_GET_DIGI_CONVERT                0x0f0d
  76 #define AC_VERB_GET_VOLUME_KNOB_CONTROL         0x0f0f
  77 /* f10-f1a: GPIO */
  78 #define AC_VERB_GET_GPIO_DATA                   0x0f15
  79 #define AC_VERB_GET_GPIO_MASK                   0x0f16
  80 #define AC_VERB_GET_GPIO_DIRECTION              0x0f17
  81 #define AC_VERB_GET_CONFIG_DEFAULT              0x0f1c
  82 /* f20: AFG/MFG */
  83 #define AC_VERB_GET_SUBSYSTEM_ID                0x0f20
  84
  85 /*
  86  * SET verbs
  87  */
  88 #define AC_VERB_SET_STREAM_FORMAT               0x200
  89 #define AC_VERB_SET_AMP_GAIN_MUTE               0x300
  90 #define AC_VERB_SET_PROC_COEF                   0x400
  91 #define AC_VERB_SET_COEF_INDEX                  0x500
  92 #define AC_VERB_SET_CONNECT_SEL                 0x701
  93 #define AC_VERB_SET_PROC_STATE                  0x703
  94 #define AC_VERB_SET_SDI_SELECT                  0x704
  95 #define AC_VERB_SET_POWER_STATE                 0x705
  96 #define AC_VERB_SET_CHANNEL_STREAMID            0x706
  97 #define AC_VERB_SET_PIN_WIDGET_CONTROL          0x707
  98 #define AC_VERB_SET_UNSOLICITED_ENABLE          0x708
  99 #define AC_VERB_SET_PIN_SENSE                   0x709
 100 #define AC_VERB_SET_BEEP_CONTROL                0x70a
 101 #define AC_VERB_SET_EAPD_BTLENABLE              0x70c
 102 #define AC_VERB_SET_DIGI_CONVERT_1              0x70d
 103 #define AC_VERB_SET_DIGI_CONVERT_2              0x70e
 104 #define AC_VERB_SET_VOLUME_KNOB_CONTROL         0x70f
 105 #define AC_VERB_SET_GPIO_DATA                   0x715
 106 #define AC_VERB_SET_GPIO_MASK                   0x716
 107 #define AC_VERB_SET_GPIO_DIRECTION              0x717
 108 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_0      0x71c
 109 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_1      0x71d
 110 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_2      0x71e
 111 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_3      0x71f
 112 #define AC_VERB_SET_CODEC_RESET                 0x7ff
 113
 114 /*
 115  * Parameter IDs
 116  */
 117 #define AC_PAR_VENDOR_ID                0x00
 118 #define AC_PAR_SUBSYSTEM_ID             0x01
 119 #define AC_PAR_REV_ID                   0x02
 120 #define AC_PAR_NODE_COUNT               0x04
 121 #define AC_PAR_FUNCTION_TYPE            0x05
 122 #define AC_PAR_AUDIO_FG_CAP             0x08
 123 #define AC_PAR_AUDIO_WIDGET_CAP         0x09
 124 #define AC_PAR_PCM                      0x0a
 125 #define AC_PAR_STREAM                   0x0b
 126 #define AC_PAR_PIN_CAP                  0x0c
 127 #define AC_PAR_AMP_IN_CAP               0x0d
 128 #define AC_PAR_CONNLIST_LEN             0x0e
 129 #define AC_PAR_POWER_STATE              0x0f
 130 #define AC_PAR_PROC_CAP                 0x10
 131 #define AC_PAR_GPIO_CAP                 0x11
 132 #define AC_PAR_AMP_OUT_CAP              0x12
 133
 134 /*
 135  * AC_VERB_PARAMETERS results (32bit)
 136  */
 137
 138 /* Function Group Type */
 139 #define AC_FGT_TYPE                     (0xff<<0)
 140 #define AC_FGT_TYPE_SHIFT               0
 141 #define AC_FGT_UNSOL_CAP                (1<<8)
 142
 143 /* Audio Function Group Capabilities */
 144 #define AC_AFG_OUT_DELAY                (0xf<<0)
 145 #define AC_AFG_IN_DELAY                 (0xf<<8)
 146 #define AC_AFG_BEEP_GEN                 (1<<16)
 147
 148 /* Audio Widget Capabilities */
 149 #define AC_WCAP_STEREO                  (1<<0)  /* stereo I/O */
 150 #define AC_WCAP_IN_AMP                  (1<<1)  /* AMP-in present */
 151 #define AC_WCAP_OUT_AMP                 (1<<2)  /* AMP-out present */
 152 #define AC_WCAP_AMP_OVRD                (1<<3)  /* AMP-parameter override */
 153 #define AC_WCAP_FORMAT_OVRD             (1<<4)  /* format override */
 154 #define AC_WCAP_STRIPE                  (1<<5)  /* stripe */
 155 #define AC_WCAP_PROC_WID                (1<<6)  /* Proc Widget */
 156 #define AC_WCAP_UNSOL_CAP               (1<<7)  /* Unsol capable */
 157 #define AC_WCAP_CONN_LIST               (1<<8)  /* connection list */
 158 #define AC_WCAP_DIGITAL                 (1<<9)  /* digital I/O */
 159 #define AC_WCAP_POWER                   (1<<10) /* power control */
 160 #define AC_WCAP_LR_SWAP                 (1<<11) /* L/R swap */
 161 #define AC_WCAP_DELAY                   (0xf<<16)
 162 #define AC_WCAP_DELAY_SHIFT             16
 163 #define AC_WCAP_TYPE                    (0xf<<20)
 164 #define AC_WCAP_TYPE_SHIFT              20
 165
 166 /* supported PCM rates and bits */
 167 #define AC_SUPPCM_RATES                 (0xfff << 0)
 168 #define AC_SUPPCM_BITS_8                (1<<16)
 169 #define AC_SUPPCM_BITS_16               (1<<17)
 170 #define AC_SUPPCM_BITS_20               (1<<18)
 171 #define AC_SUPPCM_BITS_24               (1<<19)
 172 #define AC_SUPPCM_BITS_32               (1<<20)
 173
 174 /* supported PCM stream format */
 175 #define AC_SUPFMT_PCM                   (1<<0)
 176 #define AC_SUPFMT_FLOAT32               (1<<1)
 177 #define AC_SUPFMT_AC3                   (1<<2)
 178
 179 /* Pin widget capabilies */
 180 #define AC_PINCAP_IMP_SENSE             (1<<0)  /* impedance sense capable */
 181 #define AC_PINCAP_TRIG_REQ              (1<<1)  /* trigger required */
 182 #define AC_PINCAP_PRES_DETECT           (1<<2)  /* presence detect capable */
 183 #define AC_PINCAP_HP_DRV                (1<<3)  /* headphone drive capable */
 184 #define AC_PINCAP_OUT                   (1<<4)  /* output capable */
 185 #define AC_PINCAP_IN                    (1<<5)  /* input capable */
 186 #define AC_PINCAP_BALANCE               (1<<6)  /* balanced I/O capable */
 187 #define AC_PINCAP_VREF                  (0x37<<8)
 188 #define AC_PINCAP_VREF_SHIFT            8
 189 #define AC_PINCAP_EAPD                  (1<<16) /* EAPD capable */
 190 /* Vref status (used in pin cap) */
 191 #define AC_PINCAP_VREF_HIZ              (1<<0)  /* Hi-Z */
 192 #define AC_PINCAP_VREF_50               (1<<1)  /* 50% */
 193 #define AC_PINCAP_VREF_GRD              (1<<2)  /* ground */
 194 #define AC_PINCAP_VREF_80               (1<<4)  /* 80% */
 195 #define AC_PINCAP_VREF_100              (1<<5)  /* 100% */
 196
 197 /* Amplifier capabilities */
 198 #define AC_AMPCAP_OFFSET                (0x7f<<0)  /* 0dB offset */
 199 #define AC_AMPCAP_OFFSET_SHIFT          0
 200 #define AC_AMPCAP_NUM_STEPS             (0x7f<<8)  /* number of steps */
 201 #define AC_AMPCAP_NUM_STEPS_SHIFT       8
 202 #define AC_AMPCAP_STEP_SIZE             (0x7f<<16) /* step size 0-32dB
 203                                                     * in 0.25dB
 204                                                     */
 205 #define AC_AMPCAP_STEP_SIZE_SHIFT       16
 206 #define AC_AMPCAP_MUTE                  (1<<31)    /* mute capable */
 207 #define AC_AMPCAP_MUTE_SHIFT            31
 208
 209 /* Connection list */
 210 #define AC_CLIST_LENGTH                 (0x7f<<0)
 211 #define AC_CLIST_LONG                   (1<<7)
 212
 213 /* Supported power status */
 214 #define AC_PWRST_D0SUP                  (1<<0)
 215 #define AC_PWRST_D1SUP                  (1<<1)
 216 #define AC_PWRST_D2SUP                  (1<<2)
 217 #define AC_PWRST_D3SUP                  (1<<3)
 218
 219 /* Power state values */
 220 #define AC_PWRST_D0                     0x00
 221 #define AC_PWRST_D1                     0x01
 222 #define AC_PWRST_D2                     0x02
 223 #define AC_PWRST_D3                     0x03
 224
 225 /* Processing capabilies */
 226 #define AC_PCAP_BENIGN                  (1<<0)
 227 #define AC_PCAP_NUM_COEF                (0xff<<8)
 228
 229 /* Volume knobs capabilities */
 230 #define AC_KNBCAP_NUM_STEPS             (0x7f<<0)
 231 #define AC_KNBCAP_DELTA                 (1<<8)
 232
 233 /*
 234  * Control Parameters
 235  */
 236
 237 /* Amp gain/mute */
 238 #define AC_AMP_MUTE                     (1<<7)
 239 #define AC_AMP_GAIN                     (0x7f)
 240 #define AC_AMP_GET_INDEX                (0xf<<0)
 241
 242 #define AC_AMP_GET_LEFT                 (1<<13)
 243 #define AC_AMP_GET_RIGHT                (0<<13)
 244 #define AC_AMP_GET_OUTPUT               (1<<15)
 245 #define AC_AMP_GET_INPUT                (0<<15)
 246
 247 #define AC_AMP_SET_INDEX                (0xf<<8)
 248 #define AC_AMP_SET_INDEX_SHIFT          8
 249 #define AC_AMP_SET_RIGHT                (1<<12)
 250 #define AC_AMP_SET_LEFT                 (1<<13)
 251 #define AC_AMP_SET_INPUT                (1<<14)
 252 #define AC_AMP_SET_OUTPUT               (1<<15)
 253
 254 /* DIGITAL1 bits */
 255 #define AC_DIG1_ENABLE                  (1<<0)
 256 #define AC_DIG1_V                       (1<<1)
 257 #define AC_DIG1_VCFG                    (1<<2)
 258 #define AC_DIG1_EMPHASIS                (1<<3)
 259 #define AC_DIG1_COPYRIGHT               (1<<4)
 260 #define AC_DIG1_NONAUDIO                (1<<5)
 261 #define AC_DIG1_PROFESSIONAL            (1<<6)
 262 #define AC_DIG1_LEVEL                   (1<<7)
 263
 264 /* Pin widget control - 8bit */
 265 #define AC_PINCTL_VREFEN                (0x7<<0)
 266 #define AC_PINCTL_VREF_HIZ              0       /* Hi-Z */
 267 #define AC_PINCTL_VREF_50               1       /* 50% */
 268 #define AC_PINCTL_VREF_GRD              2       /* ground */
 269 #define AC_PINCTL_VREF_80               4       /* 80% */
 270 #define AC_PINCTL_VREF_100              5       /* 100% */
 271 #define AC_PINCTL_IN_EN                 (1<<5)
 272 #define AC_PINCTL_OUT_EN                (1<<6)
 273 #define AC_PINCTL_HP_EN                 (1<<7)
 274
 275 /* Unsolicited response - 8bit */
 276 #define AC_USRSP_EN                     (1<<7)
 277
 278 /* configuration default - 32bit */
 279 #define AC_DEFCFG_SEQUENCE              (0xf<<0)
 280 #define AC_DEFCFG_DEF_ASSOC             (0xf<<4)
 281 #define AC_DEFCFG_ASSOC_SHIFT           4
 282 #define AC_DEFCFG_MISC                  (0xf<<8)
 283 #define AC_DEFCFG_MISC_SHIFT            8
 284 #define AC_DEFCFG_COLOR                 (0xf<<12)
 285 #define AC_DEFCFG_COLOR_SHIFT           12
 286 #define AC_DEFCFG_CONN_TYPE             (0xf<<16)
 287 #define AC_DEFCFG_CONN_TYPE_SHIFT       16
 288 #define AC_DEFCFG_DEVICE                (0xf<<20)
 289 #define AC_DEFCFG_DEVICE_SHIFT          20
 290 #define AC_DEFCFG_LOCATION              (0x3f<<24)
 291 #define AC_DEFCFG_LOCATION_SHIFT        24
 292 #define AC_DEFCFG_PORT_CONN             (0x3<<30)
 293 #define AC_DEFCFG_PORT_CONN_SHIFT       30
 294
 295 /* device device types (0x0-0xf) */
 296 enum {
 297         AC_JACK_LINE_OUT,
 298         AC_JACK_SPEAKER,
 299         AC_JACK_HP_OUT,
 300         AC_JACK_CD,
 301         AC_JACK_SPDIF_OUT,
 302         AC_JACK_DIG_OTHER_OUT,
 303         AC_JACK_MODEM_LINE_SIDE,
 304         AC_JACK_MODEM_HAND_SIDE,
 305         AC_JACK_LINE_IN,
 306         AC_JACK_AUX,
 307         AC_JACK_MIC_IN,
 308         AC_JACK_TELEPHONY,
 309         AC_JACK_SPDIF_IN,
 310         AC_JACK_DIG_OTHER_IN,
 311         AC_JACK_OTHER = 0xf,
 312 };
 313
 314 /* jack connection types (0x0-0xf) */
 315 enum {
 316         AC_JACK_CONN_UNKNOWN,
 317         AC_JACK_CONN_1_8,
 318         AC_JACK_CONN_1_4,
 319         AC_JACK_CONN_ATAPI,
 320         AC_JACK_CONN_RCA,
 321         AC_JACK_CONN_OPTICAL,
 322         AC_JACK_CONN_OTHER_DIGITAL,
 323         AC_JACK_CONN_OTHER_ANALOG,
 324         AC_JACK_CONN_DIN,
 325         AC_JACK_CONN_XLR,
 326         AC_JACK_CONN_RJ11,
 327         AC_JACK_CONN_COMB,
 328         AC_JACK_CONN_OTHER = 0xf,
 329 };
 330
 331 /* jack colors (0x0-0xf) */
 332 enum {
 333         AC_JACK_COLOR_UNKNOWN,
 334         AC_JACK_COLOR_BLACK,
 335         AC_JACK_COLOR_GREY,
 336         AC_JACK_COLOR_BLUE,
 337         AC_JACK_COLOR_GREEN,
 338         AC_JACK_COLOR_RED,
 339         AC_JACK_COLOR_ORANGE,
 340         AC_JACK_COLOR_YELLOW,
 341         AC_JACK_COLOR_PURPLE,
 342         AC_JACK_COLOR_PINK,
 343         AC_JACK_COLOR_WHITE = 0xe,
 344         AC_JACK_COLOR_OTHER,
 345 };
 346
 347 /* Jack location (0x0-0x3f) */
 348 /* common case */
 349 enum {
 350         AC_JACK_LOC_NONE,
 351         AC_JACK_LOC_REAR,
 352         AC_JACK_LOC_FRONT,
 353         AC_JACK_LOC_LEFT,
 354         AC_JACK_LOC_RIGHT,
 355         AC_JACK_LOC_TOP,
 356         AC_JACK_LOC_BOTTOM,
 357 };
 358 /* bits 4-5 */
 359 enum {
 360         AC_JACK_LOC_EXTERNAL = 0x00,
 361         AC_JACK_LOC_INTERNAL = 0x10,
 362         AC_JACK_LOC_SEPARATE = 0x20,
 363         AC_JACK_LOC_OTHER    = 0x30,
 364 };
 365 enum {
 366         /* external on primary chasis */
 367         AC_JACK_LOC_REAR_PANEL = 0x07,
 368         AC_JACK_LOC_DRIVE_BAY,
 369         /* internal */
 370         AC_JACK_LOC_RISER = 0x17,
 371         AC_JACK_LOC_HDMI,
 372         AC_JACK_LOC_ATAPI,
 373         /* others */
 374         AC_JACK_LOC_MOBILE_IN = 0x37,
 375         AC_JACK_LOC_MOBILE_OUT,
 376 };
 377
 378 /* Port connectivity (0-3) */
 379 enum {
 380         AC_JACK_PORT_COMPLEX,
 381         AC_JACK_PORT_NONE,
 382         AC_JACK_PORT_FIXED,
 383         AC_JACK_PORT_BOTH,
 384 };
 385
 386 /* max. connections to a widget */
 387 #define HDA_MAX_CONNECTIONS     32
 388
 389 /* max. codec address */
 390 #define HDA_MAX_CODEC_ADDRESS   0x0f
 391
 392 /*
 393  * Structures
 394  */
 395
 396 struct hda_bus;
 397 struct hda_codec;
 398 struct hda_pcm;
 399 struct hda_pcm_stream;
 400 struct hda_bus_unsolicited;
 401
 402 /* NID type */
 403 typedef u16 hda_nid_t;
 404
 405 /* bus operators */
 406 struct hda_bus_ops {
 407         /* send a single command */
 408         int (*command)(struct hda_codec *codec, hda_nid_t nid, int direct,
 409                        unsigned int verb, unsigned int parm);
 410         /* get a response from the last command */
 411         unsigned int (*get_response)(struct hda_codec *codec);
 412         /* free the private data */
 413         void (*private_free)(struct hda_bus *);
 414 };
 415
 416 /* template to pass to the bus constructor */
 417 struct hda_bus_template {
 418         void *private_data;
 419         struct pci_dev *pci;
 420         const char *modelname;
 421         struct hda_bus_ops ops;
 422 };
 423
 424 /*
 425  * codec bus
 426  *
 427  * each controller needs to creata a hda_bus to assign the accessor.
 428  * A hda_bus contains several codecs in the list codec_list.
 429  */
 430 struct hda_bus {
 431         struct snd_card *card;
 432
 433         /* copied from template */
 434         void *private_data;
 435         struct pci_dev *pci;
 436         const char *modelname;
 437         struct hda_bus_ops ops;
 438
 439         /* codec linked list */
 440         struct list_head codec_list;
 441         /* link caddr -> codec */
 442         struct hda_codec *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
 443
 444         struct mutex cmd_mutex;
 445
 446         /* unsolicited event queue */
 447         struct hda_bus_unsolicited *unsol;
 448
 449         struct snd_info_entry *proc;
 450 };
 451
 452 /*
 453  * codec preset
 454  *
 455  * Known codecs have the patch to build and set up the controls/PCMs
 456  * better than the generic parser.
 457  */
 458 struct hda_codec_preset {
 459         unsigned int id;
 460         unsigned int mask;
 461         unsigned int subs;
 462         unsigned int subs_mask;
 463         unsigned int rev;
 464         const char *name;
 465         int (*patch)(struct hda_codec *codec);
 466 };
 467
 468 /* ops set by the preset patch */
 469 struct hda_codec_ops {
 470         int (*build_controls)(struct hda_codec *codec);
 471         int (*build_pcms)(struct hda_codec *codec);
 472         int (*init)(struct hda_codec *codec);
 473         void (*free)(struct hda_codec *codec);
 474         void (*unsol_event)(struct hda_codec *codec, unsigned int res);
 475 #ifdef CONFIG_PM
 476         int (*suspend)(struct hda_codec *codec, pm_message_t state);
 477         int (*resume)(struct hda_codec *codec);
 478 #endif
 479 };
 480
 481 /* record for amp information cache */
 482 struct hda_amp_info {
 483         u32 key;                /* hash key */
 484         u32 amp_caps;           /* amp capabilities */
 485         u16 vol[2];             /* current volume & mute */
 486         u16 status;             /* update flag */
 487         u16 next;               /* next link */
 488 };
 489
 490 /* PCM callbacks */
 491 struct hda_pcm_ops {
 492         int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
 493                     struct snd_pcm_substream *substream);
 494         int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
 495                      struct snd_pcm_substream *substream);
 496         int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
 497                        unsigned int stream_tag, unsigned int format,
 498                        struct snd_pcm_substream *substream);
 499         int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
 500                        struct snd_pcm_substream *substream);
 501 };
 502
 503 /* PCM information for each substream */
 504 struct hda_pcm_stream {
 505         unsigned int substreams;        /* number of substreams, 0 = not exist*/
 506         unsigned int channels_min;      /* min. number of channels */
 507         unsigned int channels_max;      /* max. number of channels */
 508         hda_nid_t nid;  /* default NID to query rates/formats/bps, or set up */
 509         u32 rates;      /* supported rates */
 510         u64 formats;    /* supported formats (SNDRV_PCM_FMTBIT_) */
 511         unsigned int maxbps;    /* supported max. bit per sample */
 512         struct hda_pcm_ops ops;
 513 };
 514
 515 /* for PCM creation */
 516 struct hda_pcm {
 517         char *name;
 518         struct hda_pcm_stream stream[2];
 519         unsigned int is_modem;  /* modem codec? */
 520 };
 521
 522 /* codec information */
 523 struct hda_codec {
 524         struct hda_bus *bus;
 525         unsigned int addr;      /* codec addr*/
 526         struct list_head list;  /* list point */
 527
 528         hda_nid_t afg;  /* AFG node id */
 529         hda_nid_t mfg;  /* MFG node id */
 530
 531         /* ids */
 532         u32 vendor_id;
 533         u32 subsystem_id;
 534         u32 revision_id;
 535
 536         /* detected preset */
 537         const struct hda_codec_preset *preset;
 538
 539         /* set by patch */
 540         struct hda_codec_ops patch_ops;
 541
 542         /* resume phase - all controls should update even if
 543          * the values are not changed
 544          */
 545         unsigned int in_resume;
 546
 547         /* PCM to create, set by patch_ops.build_pcms callback */
 548         unsigned int num_pcms;
 549         struct hda_pcm *pcm_info;
 550
 551         /* codec specific info */
 552         void *spec;
 553
 554         /* widget capabilities cache */
 555         unsigned int num_nodes;
 556         hda_nid_t start_nid;
 557         u32 *wcaps;
 558
 559         /* hash for amp access */
 560         u16 amp_hash[32];
 561         int num_amp_entries;
 562         int amp_info_size;
 563         struct hda_amp_info *amp_info;
 564
 565         struct mutex spdif_mutex;
 566         unsigned int spdif_status;      /* IEC958 status bits */
 567         unsigned short spdif_ctls;      /* SPDIF control bits */
 568         unsigned int spdif_in_enable;   /* SPDIF input enable? */
 569 };
 570
 571 /* direction */
 572 enum {
 573         HDA_INPUT, HDA_OUTPUT
 574 };
 575
 576
 577 /*
 578  * constructors
 579  */
 580 int snd_hda_bus_new(struct snd_card *card, const struct hda_bus_template *temp,
 581                     struct hda_bus **busp);
 582 int snd_hda_codec_new(struct hda_bus *bus, unsigned int codec_addr,
 583                       struct hda_codec **codecp);
 584
 585 /*
 586  * low level functions
 587  */
 588 unsigned int snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
 589                                 int direct,
 590                                 unsigned int verb, unsigned int parm);
 591 int snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int direct,
 592                         unsigned int verb, unsigned int parm);
 593 #define snd_hda_param_read(codec, nid, param) \
 594         snd_hda_codec_read(codec, nid, 0, AC_VERB_PARAMETERS, param)
 595 int snd_hda_get_sub_nodes(struct hda_codec *codec, hda_nid_t nid,
 596                           hda_nid_t *start_id);
 597 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
 598                             hda_nid_t *conn_list, int max_conns);
 599
 600 struct hda_verb {
 601         hda_nid_t nid;
 602         u32 verb;
 603         u32 param;
 604 };
 605
 606 void snd_hda_sequence_write(struct hda_codec *codec,
 607                             const struct hda_verb *seq);
 608
 609 /* unsolicited event */
 610 int snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex);
 611
 612 /*
 613  * Mixer
 614  */
 615 int snd_hda_build_controls(struct hda_bus *bus);
 616
 617 /*
 618  * PCM
 619  */
 620 int snd_hda_build_pcms(struct hda_bus *bus);
 621 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
 622                                 u32 stream_tag,
 623                                 int channel_id, int format);
 624 unsigned int snd_hda_calc_stream_format(unsigned int rate,
 625                                         unsigned int channels,
 626                                         unsigned int format,
 627                                         unsigned int maxbps);
 628 int snd_hda_query_supported_pcm(struct hda_codec *codec, hda_nid_t nid,
 629                                 u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
 630 int snd_hda_is_supported_format(struct hda_codec *codec, hda_nid_t nid,
 631                                 unsigned int format);
 632
 633 /*
 634  * Misc
 635  */
 636 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
 637
 638 /*
 639  * power management
 640  */
 641 #ifdef CONFIG_PM
 642 int snd_hda_suspend(struct hda_bus *bus, pm_message_t state);
 643 int snd_hda_resume(struct hda_bus *bus);
 644 #endif
 645
 646 #endif /* __SOUND_HDA_CODEC_H */