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