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