2 * Jack-detection handling for HD-audio
4 * Copyright (c) 2011 Takashi Iwai <tiwai@suse.de>
6 * This driver is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
12 #include <linux/init.h>
13 #include <linux/slab.h>
14 #include <linux/export.h>
15 #include <sound/core.h>
16 #include <sound/control.h>
17 #include <sound/jack.h>
18 #include "hda_codec.h"
19 #include "hda_local.h"
20 #include "hda_auto_parser.h"
23 bool is_jack_detectable(struct hda_codec
*codec
, hda_nid_t nid
)
25 if (codec
->no_jack_detect
)
27 if (!(snd_hda_query_pin_caps(codec
, nid
) & AC_PINCAP_PRES_DETECT
))
29 if (get_defcfg_misc(snd_hda_codec_get_pincfg(codec
, nid
)) &
30 AC_DEFCFG_MISC_NO_PRESENCE
)
32 if (!(get_wcaps(codec
, nid
) & AC_WCAP_UNSOL_CAP
))
36 EXPORT_SYMBOL_HDA(is_jack_detectable
);
38 /* execute pin sense measurement */
39 static u32
read_pin_sense(struct hda_codec
*codec
, hda_nid_t nid
)
43 if (!codec
->no_trigger_sense
) {
44 pincap
= snd_hda_query_pin_caps(codec
, nid
);
45 if (pincap
& AC_PINCAP_TRIG_REQ
) /* need trigger? */
46 snd_hda_codec_read(codec
, nid
, 0,
47 AC_VERB_SET_PIN_SENSE
, 0);
49 return snd_hda_codec_read(codec
, nid
, 0,
50 AC_VERB_GET_PIN_SENSE
, 0);
54 * snd_hda_jack_tbl_get - query the jack-table entry for the given NID
57 snd_hda_jack_tbl_get(struct hda_codec
*codec
, hda_nid_t nid
)
59 struct hda_jack_tbl
*jack
= codec
->jacktbl
.list
;
64 for (i
= 0; i
< codec
->jacktbl
.used
; i
++, jack
++)
69 EXPORT_SYMBOL_HDA(snd_hda_jack_tbl_get
);
72 * snd_hda_jack_tbl_get_from_tag - query the jack-table entry for the given tag
75 snd_hda_jack_tbl_get_from_tag(struct hda_codec
*codec
, unsigned char tag
)
77 struct hda_jack_tbl
*jack
= codec
->jacktbl
.list
;
82 for (i
= 0; i
< codec
->jacktbl
.used
; i
++, jack
++)
87 EXPORT_SYMBOL_HDA(snd_hda_jack_tbl_get_from_tag
);
90 * snd_hda_jack_tbl_new - create a jack-table entry for the given NID
93 snd_hda_jack_tbl_new(struct hda_codec
*codec
, hda_nid_t nid
)
95 struct hda_jack_tbl
*jack
= snd_hda_jack_tbl_get(codec
, nid
);
98 snd_array_init(&codec
->jacktbl
, sizeof(*jack
), 16);
99 jack
= snd_array_new(&codec
->jacktbl
);
103 jack
->jack_dirty
= 1;
104 jack
->tag
= codec
->jacktbl
.used
;
107 EXPORT_SYMBOL_HDA(snd_hda_jack_tbl_new
);
109 void snd_hda_jack_tbl_clear(struct hda_codec
*codec
)
111 #ifdef CONFIG_SND_HDA_INPUT_JACK
112 /* free jack instances manually when clearing/reconfiguring */
113 if (!codec
->bus
->shutdown
&& codec
->jacktbl
.list
) {
114 struct hda_jack_tbl
*jack
= codec
->jacktbl
.list
;
116 for (i
= 0; i
< codec
->jacktbl
.used
; i
++, jack
++) {
118 snd_device_free(codec
->bus
->card
, jack
->jack
);
122 snd_array_free(&codec
->jacktbl
);
125 /* update the cached value and notification flag if needed */
126 static void jack_detect_update(struct hda_codec
*codec
,
127 struct hda_jack_tbl
*jack
)
129 if (!jack
->jack_dirty
)
132 if (jack
->phantom_jack
)
133 jack
->pin_sense
= AC_PINSENSE_PRESENCE
;
135 jack
->pin_sense
= read_pin_sense(codec
, jack
->nid
);
137 jack
->jack_dirty
= 0;
141 * snd_hda_set_dirty_all - Mark all the cached as dirty
143 * This function sets the dirty flag to all entries of jack table.
144 * It's called from the resume path in hda_codec.c.
146 void snd_hda_jack_set_dirty_all(struct hda_codec
*codec
)
148 struct hda_jack_tbl
*jack
= codec
->jacktbl
.list
;
151 for (i
= 0; i
< codec
->jacktbl
.used
; i
++, jack
++)
153 jack
->jack_dirty
= 1;
155 EXPORT_SYMBOL_HDA(snd_hda_jack_set_dirty_all
);
158 * snd_hda_pin_sense - execute pin sense measurement
159 * @codec: the CODEC to sense
160 * @nid: the pin NID to sense
162 * Execute necessary pin sense measurement and return its Presence Detect,
163 * Impedance, ELD Valid etc. status bits.
165 u32
snd_hda_pin_sense(struct hda_codec
*codec
, hda_nid_t nid
)
167 struct hda_jack_tbl
*jack
= snd_hda_jack_tbl_get(codec
, nid
);
169 jack_detect_update(codec
, jack
);
170 return jack
->pin_sense
;
172 return read_pin_sense(codec
, nid
);
174 EXPORT_SYMBOL_HDA(snd_hda_pin_sense
);
176 #define get_jack_plug_state(sense) !!(sense & AC_PINSENSE_PRESENCE)
179 * snd_hda_jack_detect - query pin Presence Detect status
180 * @codec: the CODEC to sense
181 * @nid: the pin NID to sense
183 * Query and return the pin's Presence Detect status.
185 int snd_hda_jack_detect(struct hda_codec
*codec
, hda_nid_t nid
)
187 u32 sense
= snd_hda_pin_sense(codec
, nid
);
188 return get_jack_plug_state(sense
);
190 EXPORT_SYMBOL_HDA(snd_hda_jack_detect
);
193 * snd_hda_jack_detect_enable - enable the jack-detection
195 int snd_hda_jack_detect_enable_callback(struct hda_codec
*codec
, hda_nid_t nid
,
196 unsigned char action
,
197 hda_jack_callback cb
)
199 struct hda_jack_tbl
*jack
= snd_hda_jack_tbl_new(codec
, nid
);
202 if (jack
->jack_detect
)
203 return 0; /* already registered */
204 jack
->jack_detect
= 1;
206 jack
->action
= action
;
209 return snd_hda_codec_write_cache(codec
, nid
, 0,
210 AC_VERB_SET_UNSOLICITED_ENABLE
,
211 AC_USRSP_EN
| jack
->tag
);
213 EXPORT_SYMBOL_HDA(snd_hda_jack_detect_enable_callback
);
215 int snd_hda_jack_detect_enable(struct hda_codec
*codec
, hda_nid_t nid
,
216 unsigned char action
)
218 return snd_hda_jack_detect_enable_callback(codec
, nid
, action
, NULL
);
220 EXPORT_SYMBOL_HDA(snd_hda_jack_detect_enable
);
223 * snd_hda_jack_report_sync - sync the states of all jacks and report if changed
225 void snd_hda_jack_report_sync(struct hda_codec
*codec
)
227 struct hda_jack_tbl
*jack
= codec
->jacktbl
.list
;
230 for (i
= 0; i
< codec
->jacktbl
.used
; i
++, jack
++)
232 jack_detect_update(codec
, jack
);
235 state
= get_jack_plug_state(jack
->pin_sense
);
236 snd_kctl_jack_report(codec
->bus
->card
, jack
->kctl
, state
);
237 #ifdef CONFIG_SND_HDA_INPUT_JACK
239 snd_jack_report(jack
->jack
,
240 state
? jack
->type
: 0);
244 EXPORT_SYMBOL_HDA(snd_hda_jack_report_sync
);
246 #ifdef CONFIG_SND_HDA_INPUT_JACK
247 /* guess the jack type from the pin-config */
248 static int get_input_jack_type(struct hda_codec
*codec
, hda_nid_t nid
)
250 unsigned int def_conf
= snd_hda_codec_get_pincfg(codec
, nid
);
251 switch (get_defcfg_device(def_conf
)) {
252 case AC_JACK_LINE_OUT
:
253 case AC_JACK_SPEAKER
:
254 return SND_JACK_LINEOUT
;
256 return SND_JACK_HEADPHONE
;
257 case AC_JACK_SPDIF_OUT
:
258 case AC_JACK_DIG_OTHER_OUT
:
259 return SND_JACK_AVOUT
;
261 return SND_JACK_MICROPHONE
;
263 return SND_JACK_LINEIN
;
267 static void hda_free_jack_priv(struct snd_jack
*jack
)
269 struct hda_jack_tbl
*jacks
= jack
->private_data
;
276 * snd_hda_jack_add_kctl - Add a kctl for the given pin
278 * This assigns a jack-detection kctl to the given pin. The kcontrol
279 * will have the given name and index.
281 static int __snd_hda_jack_add_kctl(struct hda_codec
*codec
, hda_nid_t nid
,
282 const char *name
, int idx
, bool phantom_jack
)
284 struct hda_jack_tbl
*jack
;
285 struct snd_kcontrol
*kctl
;
288 jack
= snd_hda_jack_tbl_new(codec
, nid
);
292 return 0; /* already created */
293 kctl
= snd_kctl_jack_new(name
, idx
, codec
);
296 err
= snd_hda_ctl_add(codec
, nid
, kctl
);
300 jack
->phantom_jack
= !!phantom_jack
;
302 state
= snd_hda_jack_detect(codec
, nid
);
303 snd_kctl_jack_report(codec
->bus
->card
, kctl
, state
);
304 #ifdef CONFIG_SND_HDA_INPUT_JACK
306 jack
->type
= get_input_jack_type(codec
, nid
);
307 err
= snd_jack_new(codec
->bus
->card
, name
, jack
->type
,
311 jack
->jack
->private_data
= jack
;
312 jack
->jack
->private_free
= hda_free_jack_priv
;
313 snd_jack_report(jack
->jack
, state
? jack
->type
: 0);
319 int snd_hda_jack_add_kctl(struct hda_codec
*codec
, hda_nid_t nid
,
320 const char *name
, int idx
)
322 return __snd_hda_jack_add_kctl(codec
, nid
, name
, idx
, false);
324 EXPORT_SYMBOL_HDA(snd_hda_jack_add_kctl
);
326 /* get the unique index number for the given kctl name */
327 static int get_unique_index(struct hda_codec
*codec
, const char *name
, int idx
)
329 struct hda_jack_tbl
*jack
;
330 int i
, len
= strlen(name
);
332 jack
= codec
->jacktbl
.list
;
333 for (i
= 0; i
< codec
->jacktbl
.used
; i
++, jack
++) {
334 /* jack->kctl.id contains "XXX Jack" name string with index */
336 !strncmp(name
, jack
->kctl
->id
.name
, len
) &&
337 !strcmp(" Jack", jack
->kctl
->id
.name
+ len
) &&
338 jack
->kctl
->id
.index
== idx
) {
346 static int add_jack_kctl(struct hda_codec
*codec
, hda_nid_t nid
,
347 const struct auto_pin_cfg
*cfg
)
349 unsigned int def_conf
, conn
;
356 def_conf
= snd_hda_codec_get_pincfg(codec
, nid
);
357 conn
= get_defcfg_connect(def_conf
);
358 if (conn
== AC_JACK_PORT_NONE
)
360 phantom_jack
= (conn
!= AC_JACK_PORT_COMPLEX
) ||
361 !is_jack_detectable(codec
, nid
);
363 snd_hda_get_pin_label(codec
, nid
, cfg
, name
, sizeof(name
), &idx
);
365 /* Example final name: "Internal Mic Phantom Jack" */
366 strncat(name
, " Phantom", sizeof(name
) - strlen(name
) - 1);
367 idx
= get_unique_index(codec
, name
, idx
);
368 err
= __snd_hda_jack_add_kctl(codec
, nid
, name
, idx
, phantom_jack
);
373 return snd_hda_jack_detect_enable(codec
, nid
, 0);
378 * snd_hda_jack_add_kctls - Add kctls for all pins included in the given pincfg
380 int snd_hda_jack_add_kctls(struct hda_codec
*codec
,
381 const struct auto_pin_cfg
*cfg
)
386 for (i
= 0, p
= cfg
->line_out_pins
; i
< cfg
->line_outs
; i
++, p
++) {
387 err
= add_jack_kctl(codec
, *p
, cfg
);
391 for (i
= 0, p
= cfg
->hp_pins
; i
< cfg
->hp_outs
; i
++, p
++) {
392 if (*p
== *cfg
->line_out_pins
) /* might be duplicated */
394 err
= add_jack_kctl(codec
, *p
, cfg
);
398 for (i
= 0, p
= cfg
->speaker_pins
; i
< cfg
->speaker_outs
; i
++, p
++) {
399 if (*p
== *cfg
->line_out_pins
) /* might be duplicated */
401 err
= add_jack_kctl(codec
, *p
, cfg
);
405 for (i
= 0; i
< cfg
->num_inputs
; i
++) {
406 err
= add_jack_kctl(codec
, cfg
->inputs
[i
].pin
, cfg
);
410 for (i
= 0, p
= cfg
->dig_out_pins
; i
< cfg
->dig_outs
; i
++, p
++) {
411 err
= add_jack_kctl(codec
, *p
, cfg
);
415 err
= add_jack_kctl(codec
, cfg
->dig_in_pin
, cfg
);
418 err
= add_jack_kctl(codec
, cfg
->mono_out_pin
, cfg
);
423 EXPORT_SYMBOL_HDA(snd_hda_jack_add_kctls
);
425 void snd_hda_jack_unsol_event(struct hda_codec
*codec
, unsigned int res
)
427 struct hda_jack_tbl
*event
;
428 int tag
= (res
>> AC_UNSOL_RES_TAG_SHIFT
) & 0x7f;
430 event
= snd_hda_jack_tbl_get_from_tag(codec
, tag
);
433 event
->jack_dirty
= 1;
436 event
->callback(codec
, event
);
438 snd_hda_jack_report_sync(codec
);
440 EXPORT_SYMBOL_HDA(snd_hda_jack_unsol_event
);