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"
24 * is_jack_detectable - Check whether the given pin is jack-detectable
25 * @codec: the HDA codec
28 * Check whether the given pin is capable to report the jack detection.
29 * The jack detection might not work by various reasons, e.g. the jack
30 * detection is prohibited in the codec level, the pin config has
31 * AC_DEFCFG_MISC_NO_PRESENCE bit, no unsol support, etc.
33 bool is_jack_detectable(struct hda_codec *codec, hda_nid_t nid)
35 if (codec->no_jack_detect)
37 if (!(snd_hda_query_pin_caps(codec, nid) & AC_PINCAP_PRES_DETECT))
39 if (get_defcfg_misc(snd_hda_codec_get_pincfg(codec, nid)) &
40 AC_DEFCFG_MISC_NO_PRESENCE)
42 if (!(get_wcaps(codec, nid) & AC_WCAP_UNSOL_CAP) &&
43 !codec->jackpoll_interval)
47 EXPORT_SYMBOL_GPL(is_jack_detectable);
49 /* execute pin sense measurement */
50 static u32 read_pin_sense(struct hda_codec *codec, hda_nid_t nid)
55 if (!codec->no_trigger_sense) {
56 pincap = snd_hda_query_pin_caps(codec, nid);
57 if (pincap & AC_PINCAP_TRIG_REQ) /* need trigger? */
58 snd_hda_codec_read(codec, nid, 0,
59 AC_VERB_SET_PIN_SENSE, 0);
61 val = snd_hda_codec_read(codec, nid, 0,
62 AC_VERB_GET_PIN_SENSE, 0);
63 if (codec->inv_jack_detect)
64 val ^= AC_PINSENSE_PRESENCE;
69 * snd_hda_jack_tbl_get - query the jack-table entry for the given NID
70 * @codec: the HDA codec
71 * @nid: pin NID to refer to
74 snd_hda_jack_tbl_get(struct hda_codec *codec, hda_nid_t nid)
76 struct hda_jack_tbl *jack = codec->jacktbl.list;
81 for (i = 0; i < codec->jacktbl.used; i++, jack++)
86 EXPORT_SYMBOL_GPL(snd_hda_jack_tbl_get);
89 * snd_hda_jack_tbl_get_from_tag - query the jack-table entry for the given tag
90 * @codec: the HDA codec
91 * @tag: tag value to refer to
94 snd_hda_jack_tbl_get_from_tag(struct hda_codec *codec, unsigned char tag)
96 struct hda_jack_tbl *jack = codec->jacktbl.list;
101 for (i = 0; i < codec->jacktbl.used; i++, jack++)
102 if (jack->tag == tag)
106 EXPORT_SYMBOL_GPL(snd_hda_jack_tbl_get_from_tag);
109 * snd_hda_jack_tbl_new - create a jack-table entry for the given NID
110 * @codec: the HDA codec
111 * @nid: pin NID to assign
113 static struct hda_jack_tbl *
114 snd_hda_jack_tbl_new(struct hda_codec *codec, hda_nid_t nid)
116 struct hda_jack_tbl *jack = snd_hda_jack_tbl_get(codec, nid);
119 jack = snd_array_new(&codec->jacktbl);
123 jack->jack_dirty = 1;
124 jack->tag = codec->jacktbl.used;
128 void snd_hda_jack_tbl_clear(struct hda_codec *codec)
130 struct hda_jack_tbl *jack = codec->jacktbl.list;
133 for (i = 0; i < codec->jacktbl.used; i++, jack++) {
134 struct hda_jack_callback *cb, *next;
136 /* free jack instances manually when clearing/reconfiguring */
137 if (!codec->bus->shutdown && jack->jack)
138 snd_device_free(codec->card, jack->jack);
140 for (cb = jack->callback; cb; cb = next) {
145 snd_array_free(&codec->jacktbl);
148 #define get_jack_plug_state(sense) !!(sense & AC_PINSENSE_PRESENCE)
150 /* update the cached value and notification flag if needed */
151 static void jack_detect_update(struct hda_codec *codec,
152 struct hda_jack_tbl *jack)
154 if (!jack->jack_dirty)
157 if (jack->phantom_jack)
158 jack->pin_sense = AC_PINSENSE_PRESENCE;
160 jack->pin_sense = read_pin_sense(codec, jack->nid);
162 /* A gating jack indicates the jack is invalid if gating is unplugged */
163 if (jack->gating_jack && !snd_hda_jack_detect(codec, jack->gating_jack))
164 jack->pin_sense &= ~AC_PINSENSE_PRESENCE;
166 jack->jack_dirty = 0;
168 /* If a jack is gated by this one update it. */
169 if (jack->gated_jack) {
170 struct hda_jack_tbl *gated =
171 snd_hda_jack_tbl_get(codec, jack->gated_jack);
173 gated->jack_dirty = 1;
174 jack_detect_update(codec, gated);
180 * snd_hda_set_dirty_all - Mark all the cached as dirty
181 * @codec: the HDA codec
183 * This function sets the dirty flag to all entries of jack table.
184 * It's called from the resume path in hda_codec.c.
186 void snd_hda_jack_set_dirty_all(struct hda_codec *codec)
188 struct hda_jack_tbl *jack = codec->jacktbl.list;
191 for (i = 0; i < codec->jacktbl.used; i++, jack++)
193 jack->jack_dirty = 1;
195 EXPORT_SYMBOL_GPL(snd_hda_jack_set_dirty_all);
198 * snd_hda_pin_sense - execute pin sense measurement
199 * @codec: the CODEC to sense
200 * @nid: the pin NID to sense
202 * Execute necessary pin sense measurement and return its Presence Detect,
203 * Impedance, ELD Valid etc. status bits.
205 u32 snd_hda_pin_sense(struct hda_codec *codec, hda_nid_t nid)
207 struct hda_jack_tbl *jack = snd_hda_jack_tbl_get(codec, nid);
209 jack_detect_update(codec, jack);
210 return jack->pin_sense;
212 return read_pin_sense(codec, nid);
214 EXPORT_SYMBOL_GPL(snd_hda_pin_sense);
217 * snd_hda_jack_detect_state - query pin Presence Detect status
218 * @codec: the CODEC to sense
219 * @nid: the pin NID to sense
221 * Query and return the pin's Presence Detect status, as either
222 * HDA_JACK_NOT_PRESENT, HDA_JACK_PRESENT or HDA_JACK_PHANTOM.
224 int snd_hda_jack_detect_state(struct hda_codec *codec, hda_nid_t nid)
226 struct hda_jack_tbl *jack = snd_hda_jack_tbl_get(codec, nid);
227 if (jack && jack->phantom_jack)
228 return HDA_JACK_PHANTOM;
229 else if (snd_hda_pin_sense(codec, nid) & AC_PINSENSE_PRESENCE)
230 return HDA_JACK_PRESENT;
232 return HDA_JACK_NOT_PRESENT;
234 EXPORT_SYMBOL_GPL(snd_hda_jack_detect_state);
237 * snd_hda_jack_detect_enable - enable the jack-detection
238 * @codec: the HDA codec
239 * @nid: pin NID to enable
240 * @func: callback function to register
242 * In the case of error, the return value will be a pointer embedded with
243 * errno. Check and handle the return value appropriately with standard
244 * macros such as @IS_ERR() and @PTR_ERR().
246 struct hda_jack_callback *
247 snd_hda_jack_detect_enable_callback(struct hda_codec *codec, hda_nid_t nid,
248 hda_jack_callback_fn func)
250 struct hda_jack_tbl *jack;
251 struct hda_jack_callback *callback = NULL;
254 jack = snd_hda_jack_tbl_new(codec, nid);
256 return ERR_PTR(-ENOMEM);
258 callback = kzalloc(sizeof(*callback), GFP_KERNEL);
260 return ERR_PTR(-ENOMEM);
261 callback->func = func;
262 callback->tbl = jack;
263 callback->next = jack->callback;
264 jack->callback = callback;
267 if (jack->jack_detect)
268 return callback; /* already registered */
269 jack->jack_detect = 1;
270 if (codec->jackpoll_interval > 0)
271 return callback; /* No unsol if we're polling instead */
272 err = snd_hda_codec_write_cache(codec, nid, 0,
273 AC_VERB_SET_UNSOLICITED_ENABLE,
274 AC_USRSP_EN | jack->tag);
279 EXPORT_SYMBOL_GPL(snd_hda_jack_detect_enable_callback);
282 * snd_hda_jack_detect_enable - Enable the jack detection on the given pin
283 * @codec: the HDA codec
284 * @nid: pin NID to enable jack detection
286 * Enable the jack detection with the default callback. Returns zero if
287 * successful or a negative error code.
289 int snd_hda_jack_detect_enable(struct hda_codec *codec, hda_nid_t nid)
291 return PTR_ERR_OR_ZERO(snd_hda_jack_detect_enable_callback(codec, nid, NULL));
293 EXPORT_SYMBOL_GPL(snd_hda_jack_detect_enable);
296 * snd_hda_jack_set_gating_jack - Set gating jack.
297 * @codec: the HDA codec
298 * @gated_nid: gated pin NID
299 * @gating_nid: gating pin NID
301 * Indicates the gated jack is only valid when the gating jack is plugged.
303 int snd_hda_jack_set_gating_jack(struct hda_codec *codec, hda_nid_t gated_nid,
304 hda_nid_t gating_nid)
306 struct hda_jack_tbl *gated = snd_hda_jack_tbl_new(codec, gated_nid);
307 struct hda_jack_tbl *gating = snd_hda_jack_tbl_new(codec, gating_nid);
309 if (!gated || !gating)
312 gated->gating_jack = gating_nid;
313 gating->gated_jack = gated_nid;
317 EXPORT_SYMBOL_GPL(snd_hda_jack_set_gating_jack);
320 * snd_hda_jack_report_sync - sync the states of all jacks and report if changed
321 * @codec: the HDA codec
323 void snd_hda_jack_report_sync(struct hda_codec *codec)
325 struct hda_jack_tbl *jack;
328 /* update all jacks at first */
329 jack = codec->jacktbl.list;
330 for (i = 0; i < codec->jacktbl.used; i++, jack++)
332 jack_detect_update(codec, jack);
334 /* report the updated jacks; it's done after updating all jacks
335 * to make sure that all gating jacks properly have been set
337 jack = codec->jacktbl.list;
338 for (i = 0; i < codec->jacktbl.used; i++, jack++)
340 if (!jack->jack || jack->block_report)
342 state = get_jack_plug_state(jack->pin_sense);
343 snd_jack_report(jack->jack,
344 state ? jack->type : 0);
347 EXPORT_SYMBOL_GPL(snd_hda_jack_report_sync);
349 /* guess the jack type from the pin-config */
350 static int get_input_jack_type(struct hda_codec *codec, hda_nid_t nid)
352 unsigned int def_conf = snd_hda_codec_get_pincfg(codec, nid);
353 switch (get_defcfg_device(def_conf)) {
354 case AC_JACK_LINE_OUT:
355 case AC_JACK_SPEAKER:
356 return SND_JACK_LINEOUT;
358 return SND_JACK_HEADPHONE;
359 case AC_JACK_SPDIF_OUT:
360 case AC_JACK_DIG_OTHER_OUT:
361 return SND_JACK_AVOUT;
363 return SND_JACK_MICROPHONE;
365 return SND_JACK_LINEIN;
369 static void hda_free_jack_priv(struct snd_jack *jack)
371 struct hda_jack_tbl *jacks = jack->private_data;
377 * snd_hda_jack_add_kctl - Add a kctl for the given pin
378 * @codec: the HDA codec
379 * @nid: pin NID to assign
380 * @name: string name for the jack
381 * @phantom_jack: flag to deal as a phantom jack
383 * This assigns a jack-detection kctl to the given pin. The kcontrol
384 * will have the given name and index.
386 static int __snd_hda_jack_add_kctl(struct hda_codec *codec, hda_nid_t nid,
387 const char *name, bool phantom_jack)
389 struct hda_jack_tbl *jack;
390 int err, state, type;
392 jack = snd_hda_jack_tbl_new(codec, nid);
396 return 0; /* already created */
398 type = get_input_jack_type(codec, nid);
399 err = snd_jack_new(codec->card, name, type,
400 &jack->jack, true, phantom_jack);
404 jack->phantom_jack = !!phantom_jack;
406 jack->jack->private_data = jack;
407 jack->jack->private_free = hda_free_jack_priv;
408 state = snd_hda_jack_detect(codec, nid);
409 snd_jack_report(jack->jack, state ? jack->type : 0);
415 * snd_hda_jack_add_kctl - Add a jack kctl for the given pin
416 * @codec: the HDA codec
418 * @name: the name string for the jack ctl
420 * This is a simple helper calling __snd_hda_jack_add_kctl().
422 int snd_hda_jack_add_kctl(struct hda_codec *codec, hda_nid_t nid,
425 return __snd_hda_jack_add_kctl(codec, nid, name, false);
427 EXPORT_SYMBOL_GPL(snd_hda_jack_add_kctl);
429 static int add_jack_kctl(struct hda_codec *codec, hda_nid_t nid,
430 const struct auto_pin_cfg *cfg,
431 const char *base_name)
433 unsigned int def_conf, conn;
434 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
440 def_conf = snd_hda_codec_get_pincfg(codec, nid);
441 conn = get_defcfg_connect(def_conf);
442 if (conn == AC_JACK_PORT_NONE)
444 phantom_jack = (conn != AC_JACK_PORT_COMPLEX) ||
445 !is_jack_detectable(codec, nid);
448 strlcpy(name, base_name, sizeof(name));
450 snd_hda_get_pin_label(codec, nid, cfg, name, sizeof(name), NULL);
452 /* Example final name: "Internal Mic Phantom Jack" */
453 strncat(name, " Phantom", sizeof(name) - strlen(name) - 1);
454 err = __snd_hda_jack_add_kctl(codec, nid, name, phantom_jack);
459 return snd_hda_jack_detect_enable(codec, nid);
464 * snd_hda_jack_add_kctls - Add kctls for all pins included in the given pincfg
465 * @codec: the HDA codec
466 * @cfg: pin config table to parse
468 int snd_hda_jack_add_kctls(struct hda_codec *codec,
469 const struct auto_pin_cfg *cfg)
474 for (i = 0; i < cfg->num_inputs; i++) {
475 /* If we have headphone mics; make sure they get the right name
476 before grabbed by output pins */
477 if (cfg->inputs[i].is_headphone_mic) {
478 if (auto_cfg_hp_outs(cfg) == 1)
479 err = add_jack_kctl(codec, auto_cfg_hp_pins(cfg)[0],
480 cfg, "Headphone Mic");
482 err = add_jack_kctl(codec, cfg->inputs[i].pin,
483 cfg, "Headphone Mic");
485 err = add_jack_kctl(codec, cfg->inputs[i].pin, cfg,
491 for (i = 0, p = cfg->line_out_pins; i < cfg->line_outs; i++, p++) {
492 err = add_jack_kctl(codec, *p, cfg, NULL);
496 for (i = 0, p = cfg->hp_pins; i < cfg->hp_outs; i++, p++) {
497 if (*p == *cfg->line_out_pins) /* might be duplicated */
499 err = add_jack_kctl(codec, *p, cfg, NULL);
503 for (i = 0, p = cfg->speaker_pins; i < cfg->speaker_outs; i++, p++) {
504 if (*p == *cfg->line_out_pins) /* might be duplicated */
506 err = add_jack_kctl(codec, *p, cfg, NULL);
510 for (i = 0, p = cfg->dig_out_pins; i < cfg->dig_outs; i++, p++) {
511 err = add_jack_kctl(codec, *p, cfg, NULL);
515 err = add_jack_kctl(codec, cfg->dig_in_pin, cfg, NULL);
518 err = add_jack_kctl(codec, cfg->mono_out_pin, cfg, NULL);
523 EXPORT_SYMBOL_GPL(snd_hda_jack_add_kctls);
525 static void call_jack_callback(struct hda_codec *codec,
526 struct hda_jack_tbl *jack)
528 struct hda_jack_callback *cb;
530 for (cb = jack->callback; cb; cb = cb->next)
532 if (jack->gated_jack) {
533 struct hda_jack_tbl *gated =
534 snd_hda_jack_tbl_get(codec, jack->gated_jack);
536 for (cb = gated->callback; cb; cb = cb->next)
543 * snd_hda_jack_unsol_event - Handle an unsolicited event
544 * @codec: the HDA codec
545 * @res: the unsolicited event data
547 void snd_hda_jack_unsol_event(struct hda_codec *codec, unsigned int res)
549 struct hda_jack_tbl *event;
550 int tag = (res >> AC_UNSOL_RES_TAG_SHIFT) & 0x7f;
552 event = snd_hda_jack_tbl_get_from_tag(codec, tag);
555 event->jack_dirty = 1;
557 call_jack_callback(codec, event);
558 snd_hda_jack_report_sync(codec);
560 EXPORT_SYMBOL_GPL(snd_hda_jack_unsol_event);
563 * snd_hda_jack_poll_all - Poll all jacks
564 * @codec: the HDA codec
566 * Poll all detectable jacks with dirty flag, update the status, call
567 * callbacks and call snd_hda_jack_report_sync() if any changes are found.
569 void snd_hda_jack_poll_all(struct hda_codec *codec)
571 struct hda_jack_tbl *jack = codec->jacktbl.list;
574 for (i = 0; i < codec->jacktbl.used; i++, jack++) {
575 unsigned int old_sense;
576 if (!jack->nid || !jack->jack_dirty || jack->phantom_jack)
578 old_sense = get_jack_plug_state(jack->pin_sense);
579 jack_detect_update(codec, jack);
580 if (old_sense == get_jack_plug_state(jack->pin_sense))
583 call_jack_callback(codec, jack);
586 snd_hda_jack_report_sync(codec);
588 EXPORT_SYMBOL_GPL(snd_hda_jack_poll_all);