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) &&
33 !codec->jackpoll_interval)
37 EXPORT_SYMBOL_HDA(is_jack_detectable);
39 /* execute pin sense measurement */
40 static u32 read_pin_sense(struct hda_codec *codec, hda_nid_t nid)
45 if (!codec->no_trigger_sense) {
46 pincap = snd_hda_query_pin_caps(codec, nid);
47 if (pincap & AC_PINCAP_TRIG_REQ) /* need trigger? */
48 snd_hda_codec_read(codec, nid, 0,
49 AC_VERB_SET_PIN_SENSE, 0);
51 val = snd_hda_codec_read(codec, nid, 0,
52 AC_VERB_GET_PIN_SENSE, 0);
53 if (codec->inv_jack_detect)
54 val ^= AC_PINSENSE_PRESENCE;
59 * snd_hda_jack_tbl_get - query the jack-table entry for the given NID
62 snd_hda_jack_tbl_get(struct hda_codec *codec, hda_nid_t nid)
64 struct hda_jack_tbl *jack = codec->jacktbl.list;
69 for (i = 0; i < codec->jacktbl.used; i++, jack++)
74 EXPORT_SYMBOL_HDA(snd_hda_jack_tbl_get);
77 * snd_hda_jack_tbl_get_from_tag - query the jack-table entry for the given tag
80 snd_hda_jack_tbl_get_from_tag(struct hda_codec *codec, unsigned char tag)
82 struct hda_jack_tbl *jack = codec->jacktbl.list;
87 for (i = 0; i < codec->jacktbl.used; i++, jack++)
92 EXPORT_SYMBOL_HDA(snd_hda_jack_tbl_get_from_tag);
95 * snd_hda_jack_tbl_new - create a jack-table entry for the given NID
98 snd_hda_jack_tbl_new(struct hda_codec *codec, hda_nid_t nid)
100 struct hda_jack_tbl *jack = snd_hda_jack_tbl_get(codec, nid);
103 jack = snd_array_new(&codec->jacktbl);
107 jack->jack_dirty = 1;
108 jack->tag = codec->jacktbl.used;
111 EXPORT_SYMBOL_HDA(snd_hda_jack_tbl_new);
113 void snd_hda_jack_tbl_clear(struct hda_codec *codec)
115 #ifdef CONFIG_SND_HDA_INPUT_JACK
116 /* free jack instances manually when clearing/reconfiguring */
117 if (!codec->bus->shutdown && codec->jacktbl.list) {
118 struct hda_jack_tbl *jack = codec->jacktbl.list;
120 for (i = 0; i < codec->jacktbl.used; i++, jack++) {
122 snd_device_free(codec->bus->card, jack->jack);
126 snd_array_free(&codec->jacktbl);
129 #define get_jack_plug_state(sense) !!(sense & AC_PINSENSE_PRESENCE)
131 /* update the cached value and notification flag if needed */
132 static void jack_detect_update(struct hda_codec *codec,
133 struct hda_jack_tbl *jack)
135 if (!jack->jack_dirty)
138 if (jack->phantom_jack)
139 jack->pin_sense = AC_PINSENSE_PRESENCE;
141 jack->pin_sense = read_pin_sense(codec, jack->nid);
143 /* A gating jack indicates the jack is invalid if gating is unplugged */
144 if (jack->gating_jack && !snd_hda_jack_detect(codec, jack->gating_jack))
145 jack->pin_sense &= ~AC_PINSENSE_PRESENCE;
147 jack->jack_dirty = 0;
149 /* If a jack is gated by this one update it. */
150 if (jack->gated_jack) {
151 struct hda_jack_tbl *gated =
152 snd_hda_jack_tbl_get(codec, jack->gated_jack);
154 gated->jack_dirty = 1;
155 jack_detect_update(codec, gated);
161 * snd_hda_set_dirty_all - Mark all the cached as dirty
163 * This function sets the dirty flag to all entries of jack table.
164 * It's called from the resume path in hda_codec.c.
166 void snd_hda_jack_set_dirty_all(struct hda_codec *codec)
168 struct hda_jack_tbl *jack = codec->jacktbl.list;
171 for (i = 0; i < codec->jacktbl.used; i++, jack++)
173 jack->jack_dirty = 1;
175 EXPORT_SYMBOL_HDA(snd_hda_jack_set_dirty_all);
178 * snd_hda_pin_sense - execute pin sense measurement
179 * @codec: the CODEC to sense
180 * @nid: the pin NID to sense
182 * Execute necessary pin sense measurement and return its Presence Detect,
183 * Impedance, ELD Valid etc. status bits.
185 u32 snd_hda_pin_sense(struct hda_codec *codec, hda_nid_t nid)
187 struct hda_jack_tbl *jack = snd_hda_jack_tbl_get(codec, nid);
189 jack_detect_update(codec, jack);
190 return jack->pin_sense;
192 return read_pin_sense(codec, nid);
194 EXPORT_SYMBOL_HDA(snd_hda_pin_sense);
197 * snd_hda_jack_detect - query pin Presence Detect status
198 * @codec: the CODEC to sense
199 * @nid: the pin NID to sense
201 * Query and return the pin's Presence Detect status.
203 int snd_hda_jack_detect(struct hda_codec *codec, hda_nid_t nid)
205 u32 sense = snd_hda_pin_sense(codec, nid);
206 return get_jack_plug_state(sense);
208 EXPORT_SYMBOL_HDA(snd_hda_jack_detect);
211 * snd_hda_jack_detect_enable - enable the jack-detection
213 int snd_hda_jack_detect_enable_callback(struct hda_codec *codec, hda_nid_t nid,
214 unsigned char action,
215 hda_jack_callback cb)
217 struct hda_jack_tbl *jack = snd_hda_jack_tbl_new(codec, nid);
220 if (jack->jack_detect)
221 return 0; /* already registered */
222 jack->jack_detect = 1;
224 jack->action = action;
227 if (codec->jackpoll_interval > 0)
228 return 0; /* No unsol if we're polling instead */
229 return snd_hda_codec_write_cache(codec, nid, 0,
230 AC_VERB_SET_UNSOLICITED_ENABLE,
231 AC_USRSP_EN | jack->tag);
233 EXPORT_SYMBOL_HDA(snd_hda_jack_detect_enable_callback);
235 int snd_hda_jack_detect_enable(struct hda_codec *codec, hda_nid_t nid,
236 unsigned char action)
238 return snd_hda_jack_detect_enable_callback(codec, nid, action, NULL);
240 EXPORT_SYMBOL_HDA(snd_hda_jack_detect_enable);
243 * snd_hda_jack_set_gating_jack - Set gating jack.
245 * Indicates the gated jack is only valid when the gating jack is plugged.
247 int snd_hda_jack_set_gating_jack(struct hda_codec *codec, hda_nid_t gated_nid,
248 hda_nid_t gating_nid)
250 struct hda_jack_tbl *gated = snd_hda_jack_tbl_get(codec, gated_nid);
251 struct hda_jack_tbl *gating = snd_hda_jack_tbl_get(codec, gating_nid);
253 if (!gated || !gating)
256 gated->gating_jack = gating_nid;
257 gating->gated_jack = gated_nid;
261 EXPORT_SYMBOL_HDA(snd_hda_jack_set_gating_jack);
264 * snd_hda_jack_report_sync - sync the states of all jacks and report if changed
266 void snd_hda_jack_report_sync(struct hda_codec *codec)
268 struct hda_jack_tbl *jack;
271 /* update all jacks at first */
272 jack = codec->jacktbl.list;
273 for (i = 0; i < codec->jacktbl.used; i++, jack++)
275 jack_detect_update(codec, jack);
277 /* report the updated jacks; it's done after updating all jacks
278 * to make sure that all gating jacks properly have been set
280 jack = codec->jacktbl.list;
281 for (i = 0; i < codec->jacktbl.used; i++, jack++)
285 state = get_jack_plug_state(jack->pin_sense);
286 snd_kctl_jack_report(codec->bus->card, jack->kctl, state);
287 #ifdef CONFIG_SND_HDA_INPUT_JACK
289 snd_jack_report(jack->jack,
290 state ? jack->type : 0);
294 EXPORT_SYMBOL_HDA(snd_hda_jack_report_sync);
296 #ifdef CONFIG_SND_HDA_INPUT_JACK
297 /* guess the jack type from the pin-config */
298 static int get_input_jack_type(struct hda_codec *codec, hda_nid_t nid)
300 unsigned int def_conf = snd_hda_codec_get_pincfg(codec, nid);
301 switch (get_defcfg_device(def_conf)) {
302 case AC_JACK_LINE_OUT:
303 case AC_JACK_SPEAKER:
304 return SND_JACK_LINEOUT;
306 return SND_JACK_HEADPHONE;
307 case AC_JACK_SPDIF_OUT:
308 case AC_JACK_DIG_OTHER_OUT:
309 return SND_JACK_AVOUT;
311 return SND_JACK_MICROPHONE;
313 return SND_JACK_LINEIN;
317 static void hda_free_jack_priv(struct snd_jack *jack)
319 struct hda_jack_tbl *jacks = jack->private_data;
326 * snd_hda_jack_add_kctl - Add a kctl for the given pin
328 * This assigns a jack-detection kctl to the given pin. The kcontrol
329 * will have the given name and index.
331 static int __snd_hda_jack_add_kctl(struct hda_codec *codec, hda_nid_t nid,
332 const char *name, int idx, bool phantom_jack)
334 struct hda_jack_tbl *jack;
335 struct snd_kcontrol *kctl;
338 jack = snd_hda_jack_tbl_new(codec, nid);
342 return 0; /* already created */
343 kctl = snd_kctl_jack_new(name, idx, codec);
346 err = snd_hda_ctl_add(codec, nid, kctl);
350 jack->phantom_jack = !!phantom_jack;
352 state = snd_hda_jack_detect(codec, nid);
353 snd_kctl_jack_report(codec->bus->card, kctl, state);
354 #ifdef CONFIG_SND_HDA_INPUT_JACK
356 jack->type = get_input_jack_type(codec, nid);
357 err = snd_jack_new(codec->bus->card, name, jack->type,
361 jack->jack->private_data = jack;
362 jack->jack->private_free = hda_free_jack_priv;
363 snd_jack_report(jack->jack, state ? jack->type : 0);
369 int snd_hda_jack_add_kctl(struct hda_codec *codec, hda_nid_t nid,
370 const char *name, int idx)
372 return __snd_hda_jack_add_kctl(codec, nid, name, idx, false);
374 EXPORT_SYMBOL_HDA(snd_hda_jack_add_kctl);
376 /* get the unique index number for the given kctl name */
377 static int get_unique_index(struct hda_codec *codec, const char *name, int idx)
379 struct hda_jack_tbl *jack;
380 int i, len = strlen(name);
382 jack = codec->jacktbl.list;
383 for (i = 0; i < codec->jacktbl.used; i++, jack++) {
384 /* jack->kctl.id contains "XXX Jack" name string with index */
386 !strncmp(name, jack->kctl->id.name, len) &&
387 !strcmp(" Jack", jack->kctl->id.name + len) &&
388 jack->kctl->id.index == idx) {
396 static int add_jack_kctl(struct hda_codec *codec, hda_nid_t nid,
397 const struct auto_pin_cfg *cfg)
399 unsigned int def_conf, conn;
406 def_conf = snd_hda_codec_get_pincfg(codec, nid);
407 conn = get_defcfg_connect(def_conf);
408 if (conn == AC_JACK_PORT_NONE)
410 phantom_jack = (conn != AC_JACK_PORT_COMPLEX) ||
411 !is_jack_detectable(codec, nid);
413 snd_hda_get_pin_label(codec, nid, cfg, name, sizeof(name), &idx);
415 /* Example final name: "Internal Mic Phantom Jack" */
416 strncat(name, " Phantom", sizeof(name) - strlen(name) - 1);
417 idx = get_unique_index(codec, name, idx);
418 err = __snd_hda_jack_add_kctl(codec, nid, name, idx, phantom_jack);
423 return snd_hda_jack_detect_enable(codec, nid, 0);
428 * snd_hda_jack_add_kctls - Add kctls for all pins included in the given pincfg
430 int snd_hda_jack_add_kctls(struct hda_codec *codec,
431 const struct auto_pin_cfg *cfg)
436 for (i = 0, p = cfg->line_out_pins; i < cfg->line_outs; i++, p++) {
437 err = add_jack_kctl(codec, *p, cfg);
441 for (i = 0, p = cfg->hp_pins; i < cfg->hp_outs; i++, p++) {
442 if (*p == *cfg->line_out_pins) /* might be duplicated */
444 err = add_jack_kctl(codec, *p, cfg);
448 for (i = 0, p = cfg->speaker_pins; i < cfg->speaker_outs; i++, p++) {
449 if (*p == *cfg->line_out_pins) /* might be duplicated */
451 err = add_jack_kctl(codec, *p, cfg);
455 for (i = 0; i < cfg->num_inputs; i++) {
456 err = add_jack_kctl(codec, cfg->inputs[i].pin, cfg);
460 for (i = 0, p = cfg->dig_out_pins; i < cfg->dig_outs; i++, p++) {
461 err = add_jack_kctl(codec, *p, cfg);
465 err = add_jack_kctl(codec, cfg->dig_in_pin, cfg);
468 err = add_jack_kctl(codec, cfg->mono_out_pin, cfg);
473 EXPORT_SYMBOL_HDA(snd_hda_jack_add_kctls);
475 static void call_jack_callback(struct hda_codec *codec,
476 struct hda_jack_tbl *jack)
479 jack->callback(codec, jack);
480 if (jack->gated_jack) {
481 struct hda_jack_tbl *gated =
482 snd_hda_jack_tbl_get(codec, jack->gated_jack);
483 if (gated && gated->callback)
484 gated->callback(codec, gated);
488 void snd_hda_jack_unsol_event(struct hda_codec *codec, unsigned int res)
490 struct hda_jack_tbl *event;
491 int tag = (res >> AC_UNSOL_RES_TAG_SHIFT) & 0x7f;
493 event = snd_hda_jack_tbl_get_from_tag(codec, tag);
496 event->jack_dirty = 1;
498 call_jack_callback(codec, event);
499 snd_hda_jack_report_sync(codec);
501 EXPORT_SYMBOL_HDA(snd_hda_jack_unsol_event);
503 void snd_hda_jack_poll_all(struct hda_codec *codec)
505 struct hda_jack_tbl *jack = codec->jacktbl.list;
508 for (i = 0; i < codec->jacktbl.used; i++, jack++) {
509 unsigned int old_sense;
510 if (!jack->nid || !jack->jack_dirty || jack->phantom_jack)
512 old_sense = get_jack_plug_state(jack->pin_sense);
513 jack_detect_update(codec, jack);
514 if (old_sense == get_jack_plug_state(jack->pin_sense))
517 call_jack_callback(codec, jack);
520 snd_hda_jack_report_sync(codec);
522 EXPORT_SYMBOL_HDA(snd_hda_jack_poll_all);