1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Jack-detection handling for HD-audio
5 * Copyright (c) 2011 Takashi Iwai <tiwai@suse.de>
8 #include <linux/init.h>
9 #include <linux/slab.h>
10 #include <linux/export.h>
11 #include <sound/core.h>
12 #include <sound/control.h>
13 #include <sound/jack.h>
14 #include <sound/hda_codec.h>
15 #include "hda_local.h"
16 #include "hda_auto_parser.h"
20 * is_jack_detectable - Check whether the given pin is jack-detectable
21 * @codec: the HDA codec
24 * Check whether the given pin is capable to report the jack detection.
25 * The jack detection might not work by various reasons, e.g. the jack
26 * detection is prohibited in the codec level, the pin config has
27 * AC_DEFCFG_MISC_NO_PRESENCE bit, no unsol support, etc.
29 bool is_jack_detectable(struct hda_codec *codec, hda_nid_t nid)
31 if (codec->no_jack_detect)
33 if (!(snd_hda_query_pin_caps(codec, nid) & AC_PINCAP_PRES_DETECT))
35 if (get_defcfg_misc(snd_hda_codec_get_pincfg(codec, nid)) &
36 AC_DEFCFG_MISC_NO_PRESENCE)
38 if (!(get_wcaps(codec, nid) & AC_WCAP_UNSOL_CAP) &&
39 !codec->jackpoll_interval)
43 EXPORT_SYMBOL_GPL(is_jack_detectable);
45 /* execute pin sense measurement */
46 static u32 read_pin_sense(struct hda_codec *codec, hda_nid_t nid, int dev_id)
51 if (!codec->no_trigger_sense) {
52 pincap = snd_hda_query_pin_caps(codec, nid);
53 if (pincap & AC_PINCAP_TRIG_REQ) /* need trigger? */
54 snd_hda_codec_read(codec, nid, 0,
55 AC_VERB_SET_PIN_SENSE, 0);
57 val = snd_hda_codec_read(codec, nid, 0,
58 AC_VERB_GET_PIN_SENSE, dev_id);
59 if (codec->inv_jack_detect)
60 val ^= AC_PINSENSE_PRESENCE;
65 * snd_hda_jack_tbl_get_mst - query the jack-table entry for the given NID
66 * @codec: the HDA codec
67 * @nid: pin NID to refer to
68 * @dev_id: pin device entry id
71 snd_hda_jack_tbl_get_mst(struct hda_codec *codec, hda_nid_t nid, int dev_id)
73 struct hda_jack_tbl *jack = codec->jacktbl.list;
78 for (i = 0; i < codec->jacktbl.used; i++, jack++)
79 if (jack->nid == nid && jack->dev_id == dev_id)
83 EXPORT_SYMBOL_GPL(snd_hda_jack_tbl_get_mst);
86 * snd_hda_jack_tbl_get_from_tag - query the jack-table entry for the given tag
87 * @codec: the HDA codec
88 * @tag: tag value to refer to
89 * @dev_id: pin device entry id
92 snd_hda_jack_tbl_get_from_tag(struct hda_codec *codec,
93 unsigned char tag, int dev_id)
95 struct hda_jack_tbl *jack = codec->jacktbl.list;
100 for (i = 0; i < codec->jacktbl.used; i++, jack++)
101 if (jack->tag == tag && jack->dev_id == dev_id)
105 EXPORT_SYMBOL_GPL(snd_hda_jack_tbl_get_from_tag);
107 static struct hda_jack_tbl *
108 any_jack_tbl_get_from_nid(struct hda_codec *codec, hda_nid_t nid)
110 struct hda_jack_tbl *jack = codec->jacktbl.list;
115 for (i = 0; i < codec->jacktbl.used; i++, jack++)
116 if (jack->nid == nid)
122 * snd_hda_jack_tbl_new - create a jack-table entry for the given NID
123 * @codec: the HDA codec
124 * @nid: pin NID to assign
126 static struct hda_jack_tbl *
127 snd_hda_jack_tbl_new(struct hda_codec *codec, hda_nid_t nid, int dev_id)
129 struct hda_jack_tbl *jack =
130 snd_hda_jack_tbl_get_mst(codec, nid, dev_id);
131 struct hda_jack_tbl *existing_nid_jack =
132 any_jack_tbl_get_from_nid(codec, nid);
134 WARN_ON(dev_id != 0 && !codec->dp_mst);
138 jack = snd_array_new(&codec->jacktbl);
142 jack->dev_id = dev_id;
143 jack->jack_dirty = 1;
144 if (existing_nid_jack) {
145 jack->tag = existing_nid_jack->tag;
148 * Copy jack_detect from existing_nid_jack to avoid
149 * snd_hda_jack_detect_enable_callback_mst() making multiple
150 * SET_UNSOLICITED_ENABLE calls on the same pin.
152 jack->jack_detect = existing_nid_jack->jack_detect;
154 jack->tag = codec->jacktbl.used;
160 void snd_hda_jack_tbl_clear(struct hda_codec *codec)
162 struct hda_jack_tbl *jack = codec->jacktbl.list;
165 for (i = 0; i < codec->jacktbl.used; i++, jack++) {
166 struct hda_jack_callback *cb, *next;
168 /* free jack instances manually when clearing/reconfiguring */
169 if (!codec->bus->shutdown && jack->jack)
170 snd_device_free(codec->card, jack->jack);
172 for (cb = jack->callback; cb; cb = next) {
177 snd_array_free(&codec->jacktbl);
180 #define get_jack_plug_state(sense) !!(sense & AC_PINSENSE_PRESENCE)
182 /* update the cached value and notification flag if needed */
183 static void jack_detect_update(struct hda_codec *codec,
184 struct hda_jack_tbl *jack)
186 if (!jack->jack_dirty)
189 if (jack->phantom_jack)
190 jack->pin_sense = AC_PINSENSE_PRESENCE;
192 jack->pin_sense = read_pin_sense(codec, jack->nid,
195 /* A gating jack indicates the jack is invalid if gating is unplugged */
196 if (jack->gating_jack &&
197 !snd_hda_jack_detect_mst(codec, jack->gating_jack, jack->dev_id))
198 jack->pin_sense &= ~AC_PINSENSE_PRESENCE;
200 jack->jack_dirty = 0;
202 /* If a jack is gated by this one update it. */
203 if (jack->gated_jack) {
204 struct hda_jack_tbl *gated =
205 snd_hda_jack_tbl_get_mst(codec, jack->gated_jack,
208 gated->jack_dirty = 1;
209 jack_detect_update(codec, gated);
215 * snd_hda_set_dirty_all - Mark all the cached as dirty
216 * @codec: the HDA codec
218 * This function sets the dirty flag to all entries of jack table.
219 * It's called from the resume path in hda_codec.c.
221 void snd_hda_jack_set_dirty_all(struct hda_codec *codec)
223 struct hda_jack_tbl *jack = codec->jacktbl.list;
226 for (i = 0; i < codec->jacktbl.used; i++, jack++)
228 jack->jack_dirty = 1;
230 EXPORT_SYMBOL_GPL(snd_hda_jack_set_dirty_all);
233 * snd_hda_jack_pin_sense - execute pin sense measurement
234 * @codec: the CODEC to sense
235 * @nid: the pin NID to sense
237 * Execute necessary pin sense measurement and return its Presence Detect,
238 * Impedance, ELD Valid etc. status bits.
240 u32 snd_hda_jack_pin_sense(struct hda_codec *codec, hda_nid_t nid, int dev_id)
242 struct hda_jack_tbl *jack =
243 snd_hda_jack_tbl_get_mst(codec, nid, dev_id);
245 jack_detect_update(codec, jack);
246 return jack->pin_sense;
248 return read_pin_sense(codec, nid, dev_id);
250 EXPORT_SYMBOL_GPL(snd_hda_jack_pin_sense);
253 * snd_hda_jack_detect_state_mst - query pin Presence Detect status
254 * @codec: the CODEC to sense
255 * @nid: the pin NID to sense
256 * @dev_id: pin device entry id
258 * Query and return the pin's Presence Detect status, as either
259 * HDA_JACK_NOT_PRESENT, HDA_JACK_PRESENT or HDA_JACK_PHANTOM.
261 int snd_hda_jack_detect_state_mst(struct hda_codec *codec,
262 hda_nid_t nid, int dev_id)
264 struct hda_jack_tbl *jack =
265 snd_hda_jack_tbl_get_mst(codec, nid, dev_id);
266 if (jack && jack->phantom_jack)
267 return HDA_JACK_PHANTOM;
268 else if (snd_hda_jack_pin_sense(codec, nid, dev_id) &
269 AC_PINSENSE_PRESENCE)
270 return HDA_JACK_PRESENT;
272 return HDA_JACK_NOT_PRESENT;
274 EXPORT_SYMBOL_GPL(snd_hda_jack_detect_state_mst);
277 * snd_hda_jack_detect_enable_mst - enable the jack-detection
278 * @codec: the HDA codec
279 * @nid: pin NID to enable
280 * @func: callback function to register
281 * @dev_id: pin device entry id
283 * In the case of error, the return value will be a pointer embedded with
284 * errno. Check and handle the return value appropriately with standard
285 * macros such as @IS_ERR() and @PTR_ERR().
287 struct hda_jack_callback *
288 snd_hda_jack_detect_enable_callback_mst(struct hda_codec *codec, hda_nid_t nid,
289 int dev_id, hda_jack_callback_fn func)
291 struct hda_jack_tbl *jack;
292 struct hda_jack_callback *callback = NULL;
295 jack = snd_hda_jack_tbl_new(codec, nid, dev_id);
297 return ERR_PTR(-ENOMEM);
299 callback = kzalloc(sizeof(*callback), GFP_KERNEL);
301 return ERR_PTR(-ENOMEM);
302 callback->func = func;
303 callback->nid = jack->nid;
304 callback->dev_id = jack->dev_id;
305 callback->next = jack->callback;
306 jack->callback = callback;
309 if (jack->jack_detect)
310 return callback; /* already registered */
311 jack->jack_detect = 1;
312 if (codec->jackpoll_interval > 0)
313 return callback; /* No unsol if we're polling instead */
314 err = snd_hda_codec_write_cache(codec, nid, 0,
315 AC_VERB_SET_UNSOLICITED_ENABLE,
316 AC_USRSP_EN | jack->tag);
321 EXPORT_SYMBOL_GPL(snd_hda_jack_detect_enable_callback_mst);
324 * snd_hda_jack_detect_enable - Enable the jack detection on the given pin
325 * @codec: the HDA codec
326 * @nid: pin NID to enable jack detection
327 * @dev_id: pin device entry id
329 * Enable the jack detection with the default callback. Returns zero if
330 * successful or a negative error code.
332 int snd_hda_jack_detect_enable(struct hda_codec *codec, hda_nid_t nid,
335 return PTR_ERR_OR_ZERO(snd_hda_jack_detect_enable_callback_mst(codec,
340 EXPORT_SYMBOL_GPL(snd_hda_jack_detect_enable);
343 * snd_hda_jack_set_gating_jack - Set gating jack.
344 * @codec: the HDA codec
345 * @gated_nid: gated pin NID
346 * @gating_nid: gating pin NID
348 * Indicates the gated jack is only valid when the gating jack is plugged.
350 int snd_hda_jack_set_gating_jack(struct hda_codec *codec, hda_nid_t gated_nid,
351 hda_nid_t gating_nid)
353 struct hda_jack_tbl *gated = snd_hda_jack_tbl_new(codec, gated_nid, 0);
354 struct hda_jack_tbl *gating =
355 snd_hda_jack_tbl_new(codec, gating_nid, 0);
357 WARN_ON(codec->dp_mst);
359 if (!gated || !gating)
362 gated->gating_jack = gating_nid;
363 gating->gated_jack = gated_nid;
367 EXPORT_SYMBOL_GPL(snd_hda_jack_set_gating_jack);
370 * snd_hda_jack_report_sync - sync the states of all jacks and report if changed
371 * @codec: the HDA codec
373 void snd_hda_jack_report_sync(struct hda_codec *codec)
375 struct hda_jack_tbl *jack;
378 /* update all jacks at first */
379 jack = codec->jacktbl.list;
380 for (i = 0; i < codec->jacktbl.used; i++, jack++)
382 jack_detect_update(codec, jack);
384 /* report the updated jacks; it's done after updating all jacks
385 * to make sure that all gating jacks properly have been set
387 jack = codec->jacktbl.list;
388 for (i = 0; i < codec->jacktbl.used; i++, jack++)
390 if (!jack->jack || jack->block_report)
392 state = jack->button_state;
393 if (get_jack_plug_state(jack->pin_sense))
395 snd_jack_report(jack->jack, state);
396 if (jack->button_state) {
397 snd_jack_report(jack->jack,
398 state & ~jack->button_state);
399 jack->button_state = 0; /* button released */
403 EXPORT_SYMBOL_GPL(snd_hda_jack_report_sync);
405 /* guess the jack type from the pin-config */
406 static int get_input_jack_type(struct hda_codec *codec, hda_nid_t nid)
408 unsigned int def_conf = snd_hda_codec_get_pincfg(codec, nid);
409 switch (get_defcfg_device(def_conf)) {
410 case AC_JACK_LINE_OUT:
411 case AC_JACK_SPEAKER:
412 return SND_JACK_LINEOUT;
414 return SND_JACK_HEADPHONE;
415 case AC_JACK_SPDIF_OUT:
416 case AC_JACK_DIG_OTHER_OUT:
417 return SND_JACK_AVOUT;
419 return SND_JACK_MICROPHONE;
421 return SND_JACK_LINEIN;
425 static void hda_free_jack_priv(struct snd_jack *jack)
427 struct hda_jack_tbl *jacks = jack->private_data;
433 * snd_hda_jack_add_kctl_mst - Add a kctl for the given pin
434 * @codec: the HDA codec
435 * @nid: pin NID to assign
436 * @dev_id : pin device entry id
437 * @name: string name for the jack
438 * @phantom_jack: flag to deal as a phantom jack
439 * @type: jack type bits to be reported, 0 for guessing from pincfg
440 * @keymap: optional jack / key mapping
442 * This assigns a jack-detection kctl to the given pin. The kcontrol
443 * will have the given name and index.
445 int snd_hda_jack_add_kctl_mst(struct hda_codec *codec, hda_nid_t nid,
446 int dev_id, const char *name, bool phantom_jack,
447 int type, const struct hda_jack_keymap *keymap)
449 struct hda_jack_tbl *jack;
450 const struct hda_jack_keymap *map;
451 int err, state, buttons;
453 jack = snd_hda_jack_tbl_new(codec, nid, dev_id);
457 return 0; /* already created */
460 type = get_input_jack_type(codec, nid);
464 for (map = keymap; map->type; map++)
465 buttons |= map->type;
468 err = snd_jack_new(codec->card, name, type | buttons,
469 &jack->jack, true, phantom_jack);
473 jack->phantom_jack = !!phantom_jack;
475 jack->button_state = 0;
476 jack->jack->private_data = jack;
477 jack->jack->private_free = hda_free_jack_priv;
479 for (map = keymap; map->type; map++)
480 snd_jack_set_key(jack->jack, map->type, map->key);
483 state = snd_hda_jack_detect_mst(codec, nid, dev_id);
484 snd_jack_report(jack->jack, state ? jack->type : 0);
488 EXPORT_SYMBOL_GPL(snd_hda_jack_add_kctl_mst);
490 static int add_jack_kctl(struct hda_codec *codec, hda_nid_t nid,
491 const struct auto_pin_cfg *cfg,
492 const char *base_name)
494 unsigned int def_conf, conn;
495 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
499 WARN_ON(codec->dp_mst);
503 def_conf = snd_hda_codec_get_pincfg(codec, nid);
504 conn = get_defcfg_connect(def_conf);
505 if (conn == AC_JACK_PORT_NONE)
507 phantom_jack = (conn != AC_JACK_PORT_COMPLEX) ||
508 !is_jack_detectable(codec, nid);
511 strlcpy(name, base_name, sizeof(name));
513 snd_hda_get_pin_label(codec, nid, cfg, name, sizeof(name), NULL);
515 /* Example final name: "Internal Mic Phantom Jack" */
516 strncat(name, " Phantom", sizeof(name) - strlen(name) - 1);
517 err = snd_hda_jack_add_kctl(codec, nid, name, phantom_jack, 0, NULL);
522 return snd_hda_jack_detect_enable(codec, nid, 0);
527 * snd_hda_jack_add_kctls - Add kctls for all pins included in the given pincfg
528 * @codec: the HDA codec
529 * @cfg: pin config table to parse
531 int snd_hda_jack_add_kctls(struct hda_codec *codec,
532 const struct auto_pin_cfg *cfg)
537 for (i = 0; i < cfg->num_inputs; i++) {
538 /* If we have headphone mics; make sure they get the right name
539 before grabbed by output pins */
540 if (cfg->inputs[i].is_headphone_mic) {
541 if (auto_cfg_hp_outs(cfg) == 1)
542 err = add_jack_kctl(codec, auto_cfg_hp_pins(cfg)[0],
543 cfg, "Headphone Mic");
545 err = add_jack_kctl(codec, cfg->inputs[i].pin,
546 cfg, "Headphone Mic");
548 err = add_jack_kctl(codec, cfg->inputs[i].pin, cfg,
554 for (i = 0, p = cfg->line_out_pins; i < cfg->line_outs; i++, p++) {
555 err = add_jack_kctl(codec, *p, cfg, NULL);
559 for (i = 0, p = cfg->hp_pins; i < cfg->hp_outs; i++, p++) {
560 if (*p == *cfg->line_out_pins) /* might be duplicated */
562 err = add_jack_kctl(codec, *p, cfg, NULL);
566 for (i = 0, p = cfg->speaker_pins; i < cfg->speaker_outs; i++, p++) {
567 if (*p == *cfg->line_out_pins) /* might be duplicated */
569 err = add_jack_kctl(codec, *p, cfg, NULL);
573 for (i = 0, p = cfg->dig_out_pins; i < cfg->dig_outs; i++, p++) {
574 err = add_jack_kctl(codec, *p, cfg, NULL);
578 err = add_jack_kctl(codec, cfg->dig_in_pin, cfg, NULL);
581 err = add_jack_kctl(codec, cfg->mono_out_pin, cfg, NULL);
586 EXPORT_SYMBOL_GPL(snd_hda_jack_add_kctls);
588 static void call_jack_callback(struct hda_codec *codec, unsigned int res,
589 struct hda_jack_tbl *jack)
591 struct hda_jack_callback *cb;
593 for (cb = jack->callback; cb; cb = cb->next) {
598 if (jack->gated_jack) {
599 struct hda_jack_tbl *gated =
600 snd_hda_jack_tbl_get_mst(codec, jack->gated_jack,
603 for (cb = gated->callback; cb; cb = cb->next) {
613 * snd_hda_jack_unsol_event - Handle an unsolicited event
614 * @codec: the HDA codec
615 * @res: the unsolicited event data
617 void snd_hda_jack_unsol_event(struct hda_codec *codec, unsigned int res)
619 struct hda_jack_tbl *event;
620 int tag = (res & AC_UNSOL_RES_TAG) >> AC_UNSOL_RES_TAG_SHIFT;
624 (res & AC_UNSOL_RES_DE) >> AC_UNSOL_RES_DE_SHIFT;
626 event = snd_hda_jack_tbl_get_from_tag(codec, tag, dev_entry);
628 event = snd_hda_jack_tbl_get_from_tag(codec, tag, 0);
632 event->jack_dirty = 1;
634 call_jack_callback(codec, res, event);
635 snd_hda_jack_report_sync(codec);
637 EXPORT_SYMBOL_GPL(snd_hda_jack_unsol_event);
640 * snd_hda_jack_poll_all - Poll all jacks
641 * @codec: the HDA codec
643 * Poll all detectable jacks with dirty flag, update the status, call
644 * callbacks and call snd_hda_jack_report_sync() if any changes are found.
646 void snd_hda_jack_poll_all(struct hda_codec *codec)
648 struct hda_jack_tbl *jack = codec->jacktbl.list;
651 for (i = 0; i < codec->jacktbl.used; i++, jack++) {
652 unsigned int old_sense;
653 if (!jack->nid || !jack->jack_dirty || jack->phantom_jack)
655 old_sense = get_jack_plug_state(jack->pin_sense);
656 jack_detect_update(codec, jack);
657 if (old_sense == get_jack_plug_state(jack->pin_sense))
660 call_jack_callback(codec, 0, jack);
663 snd_hda_jack_report_sync(codec);
665 EXPORT_SYMBOL_GPL(snd_hda_jack_poll_all);