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
125 * @dev_id: pin device entry id
127 static struct hda_jack_tbl *
128 snd_hda_jack_tbl_new(struct hda_codec *codec, hda_nid_t nid, int dev_id)
130 struct hda_jack_tbl *jack =
131 snd_hda_jack_tbl_get_mst(codec, nid, dev_id);
132 struct hda_jack_tbl *existing_nid_jack =
133 any_jack_tbl_get_from_nid(codec, nid);
135 WARN_ON(dev_id != 0 && !codec->dp_mst);
139 jack = snd_array_new(&codec->jacktbl);
143 jack->dev_id = dev_id;
144 jack->jack_dirty = 1;
145 if (existing_nid_jack) {
146 jack->tag = existing_nid_jack->tag;
149 * Copy jack_detect from existing_nid_jack to avoid
150 * snd_hda_jack_detect_enable_callback_mst() making multiple
151 * SET_UNSOLICITED_ENABLE calls on the same pin.
153 jack->jack_detect = existing_nid_jack->jack_detect;
155 jack->tag = codec->jacktbl.used;
161 void snd_hda_jack_tbl_clear(struct hda_codec *codec)
163 struct hda_jack_tbl *jack = codec->jacktbl.list;
166 for (i = 0; i < codec->jacktbl.used; i++, jack++) {
167 struct hda_jack_callback *cb, *next;
169 /* free jack instances manually when clearing/reconfiguring */
170 if (!codec->bus->shutdown && jack->jack)
171 snd_device_free(codec->card, jack->jack);
173 for (cb = jack->callback; cb; cb = next) {
178 snd_array_free(&codec->jacktbl);
181 #define get_jack_plug_state(sense) !!(sense & AC_PINSENSE_PRESENCE)
183 /* update the cached value and notification flag if needed */
184 static void jack_detect_update(struct hda_codec *codec,
185 struct hda_jack_tbl *jack)
187 if (!jack->jack_dirty)
190 if (jack->phantom_jack)
191 jack->pin_sense = AC_PINSENSE_PRESENCE;
193 jack->pin_sense = read_pin_sense(codec, jack->nid,
196 /* A gating jack indicates the jack is invalid if gating is unplugged */
197 if (jack->gating_jack &&
198 !snd_hda_jack_detect_mst(codec, jack->gating_jack, jack->dev_id))
199 jack->pin_sense &= ~AC_PINSENSE_PRESENCE;
201 jack->jack_dirty = 0;
203 /* If a jack is gated by this one update it. */
204 if (jack->gated_jack) {
205 struct hda_jack_tbl *gated =
206 snd_hda_jack_tbl_get_mst(codec, jack->gated_jack,
209 gated->jack_dirty = 1;
210 jack_detect_update(codec, gated);
216 * snd_hda_set_dirty_all - Mark all the cached as dirty
217 * @codec: the HDA codec
219 * This function sets the dirty flag to all entries of jack table.
220 * It's called from the resume path in hda_codec.c.
222 void snd_hda_jack_set_dirty_all(struct hda_codec *codec)
224 struct hda_jack_tbl *jack = codec->jacktbl.list;
227 for (i = 0; i < codec->jacktbl.used; i++, jack++)
229 jack->jack_dirty = 1;
231 EXPORT_SYMBOL_GPL(snd_hda_jack_set_dirty_all);
234 * snd_hda_jack_pin_sense - execute pin sense measurement
235 * @codec: the CODEC to sense
236 * @nid: the pin NID to sense
237 * @dev_id: pin device entry id
239 * Execute necessary pin sense measurement and return its Presence Detect,
240 * Impedance, ELD Valid etc. status bits.
242 u32 snd_hda_jack_pin_sense(struct hda_codec *codec, hda_nid_t nid, int dev_id)
244 struct hda_jack_tbl *jack =
245 snd_hda_jack_tbl_get_mst(codec, nid, dev_id);
247 jack_detect_update(codec, jack);
248 return jack->pin_sense;
250 return read_pin_sense(codec, nid, dev_id);
252 EXPORT_SYMBOL_GPL(snd_hda_jack_pin_sense);
255 * snd_hda_jack_detect_state_mst - query pin Presence Detect status
256 * @codec: the CODEC to sense
257 * @nid: the pin NID to sense
258 * @dev_id: pin device entry id
260 * Query and return the pin's Presence Detect status, as either
261 * HDA_JACK_NOT_PRESENT, HDA_JACK_PRESENT or HDA_JACK_PHANTOM.
263 int snd_hda_jack_detect_state_mst(struct hda_codec *codec,
264 hda_nid_t nid, int dev_id)
266 struct hda_jack_tbl *jack =
267 snd_hda_jack_tbl_get_mst(codec, nid, dev_id);
268 if (jack && jack->phantom_jack)
269 return HDA_JACK_PHANTOM;
270 else if (snd_hda_jack_pin_sense(codec, nid, dev_id) &
271 AC_PINSENSE_PRESENCE)
272 return HDA_JACK_PRESENT;
274 return HDA_JACK_NOT_PRESENT;
276 EXPORT_SYMBOL_GPL(snd_hda_jack_detect_state_mst);
279 * snd_hda_jack_detect_enable_mst - enable the jack-detection
280 * @codec: the HDA codec
281 * @nid: pin NID to enable
282 * @func: callback function to register
283 * @dev_id: pin device entry id
285 * In the case of error, the return value will be a pointer embedded with
286 * errno. Check and handle the return value appropriately with standard
287 * macros such as @IS_ERR() and @PTR_ERR().
289 struct hda_jack_callback *
290 snd_hda_jack_detect_enable_callback_mst(struct hda_codec *codec, hda_nid_t nid,
291 int dev_id, hda_jack_callback_fn func)
293 struct hda_jack_tbl *jack;
294 struct hda_jack_callback *callback = NULL;
297 jack = snd_hda_jack_tbl_new(codec, nid, dev_id);
299 return ERR_PTR(-ENOMEM);
301 callback = kzalloc(sizeof(*callback), GFP_KERNEL);
303 return ERR_PTR(-ENOMEM);
304 callback->func = func;
305 callback->nid = jack->nid;
306 callback->dev_id = jack->dev_id;
307 callback->next = jack->callback;
308 jack->callback = callback;
311 if (jack->jack_detect)
312 return callback; /* already registered */
313 jack->jack_detect = 1;
314 if (codec->jackpoll_interval > 0)
315 return callback; /* No unsol if we're polling instead */
316 err = snd_hda_codec_write_cache(codec, nid, 0,
317 AC_VERB_SET_UNSOLICITED_ENABLE,
318 AC_USRSP_EN | jack->tag);
323 EXPORT_SYMBOL_GPL(snd_hda_jack_detect_enable_callback_mst);
326 * snd_hda_jack_detect_enable - Enable the jack detection on the given pin
327 * @codec: the HDA codec
328 * @nid: pin NID to enable jack detection
329 * @dev_id: pin device entry id
331 * Enable the jack detection with the default callback. Returns zero if
332 * successful or a negative error code.
334 int snd_hda_jack_detect_enable(struct hda_codec *codec, hda_nid_t nid,
337 return PTR_ERR_OR_ZERO(snd_hda_jack_detect_enable_callback_mst(codec,
342 EXPORT_SYMBOL_GPL(snd_hda_jack_detect_enable);
345 * snd_hda_jack_set_gating_jack - Set gating jack.
346 * @codec: the HDA codec
347 * @gated_nid: gated pin NID
348 * @gating_nid: gating pin NID
350 * Indicates the gated jack is only valid when the gating jack is plugged.
352 int snd_hda_jack_set_gating_jack(struct hda_codec *codec, hda_nid_t gated_nid,
353 hda_nid_t gating_nid)
355 struct hda_jack_tbl *gated = snd_hda_jack_tbl_new(codec, gated_nid, 0);
356 struct hda_jack_tbl *gating =
357 snd_hda_jack_tbl_new(codec, gating_nid, 0);
359 WARN_ON(codec->dp_mst);
361 if (!gated || !gating)
364 gated->gating_jack = gating_nid;
365 gating->gated_jack = gated_nid;
369 EXPORT_SYMBOL_GPL(snd_hda_jack_set_gating_jack);
372 * snd_hda_jack_report_sync - sync the states of all jacks and report if changed
373 * @codec: the HDA codec
375 void snd_hda_jack_report_sync(struct hda_codec *codec)
377 struct hda_jack_tbl *jack;
380 /* update all jacks at first */
381 jack = codec->jacktbl.list;
382 for (i = 0; i < codec->jacktbl.used; i++, jack++)
384 jack_detect_update(codec, jack);
386 /* report the updated jacks; it's done after updating all jacks
387 * to make sure that all gating jacks properly have been set
389 jack = codec->jacktbl.list;
390 for (i = 0; i < codec->jacktbl.used; i++, jack++)
392 if (!jack->jack || jack->block_report)
394 state = jack->button_state;
395 if (get_jack_plug_state(jack->pin_sense))
397 snd_jack_report(jack->jack, state);
398 if (jack->button_state) {
399 snd_jack_report(jack->jack,
400 state & ~jack->button_state);
401 jack->button_state = 0; /* button released */
405 EXPORT_SYMBOL_GPL(snd_hda_jack_report_sync);
407 /* guess the jack type from the pin-config */
408 static int get_input_jack_type(struct hda_codec *codec, hda_nid_t nid)
410 unsigned int def_conf = snd_hda_codec_get_pincfg(codec, nid);
411 switch (get_defcfg_device(def_conf)) {
412 case AC_JACK_LINE_OUT:
413 case AC_JACK_SPEAKER:
414 return SND_JACK_LINEOUT;
416 return SND_JACK_HEADPHONE;
417 case AC_JACK_SPDIF_OUT:
418 case AC_JACK_DIG_OTHER_OUT:
419 return SND_JACK_AVOUT;
421 return SND_JACK_MICROPHONE;
423 return SND_JACK_LINEIN;
427 static void hda_free_jack_priv(struct snd_jack *jack)
429 struct hda_jack_tbl *jacks = jack->private_data;
435 * snd_hda_jack_add_kctl_mst - Add a kctl for the given pin
436 * @codec: the HDA codec
437 * @nid: pin NID to assign
438 * @dev_id : pin device entry id
439 * @name: string name for the jack
440 * @phantom_jack: flag to deal as a phantom jack
441 * @type: jack type bits to be reported, 0 for guessing from pincfg
442 * @keymap: optional jack / key mapping
444 * This assigns a jack-detection kctl to the given pin. The kcontrol
445 * will have the given name and index.
447 int snd_hda_jack_add_kctl_mst(struct hda_codec *codec, hda_nid_t nid,
448 int dev_id, const char *name, bool phantom_jack,
449 int type, const struct hda_jack_keymap *keymap)
451 struct hda_jack_tbl *jack;
452 const struct hda_jack_keymap *map;
453 int err, state, buttons;
455 jack = snd_hda_jack_tbl_new(codec, nid, dev_id);
459 return 0; /* already created */
462 type = get_input_jack_type(codec, nid);
466 for (map = keymap; map->type; map++)
467 buttons |= map->type;
470 err = snd_jack_new(codec->card, name, type | buttons,
471 &jack->jack, true, phantom_jack);
475 jack->phantom_jack = !!phantom_jack;
477 jack->button_state = 0;
478 jack->jack->private_data = jack;
479 jack->jack->private_free = hda_free_jack_priv;
481 for (map = keymap; map->type; map++)
482 snd_jack_set_key(jack->jack, map->type, map->key);
485 state = snd_hda_jack_detect_mst(codec, nid, dev_id);
486 snd_jack_report(jack->jack, state ? jack->type : 0);
490 EXPORT_SYMBOL_GPL(snd_hda_jack_add_kctl_mst);
492 static int add_jack_kctl(struct hda_codec *codec, hda_nid_t nid,
493 const struct auto_pin_cfg *cfg,
494 const char *base_name)
496 unsigned int def_conf, conn;
497 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
501 WARN_ON(codec->dp_mst);
505 def_conf = snd_hda_codec_get_pincfg(codec, nid);
506 conn = get_defcfg_connect(def_conf);
507 if (conn == AC_JACK_PORT_NONE)
509 phantom_jack = (conn != AC_JACK_PORT_COMPLEX) ||
510 !is_jack_detectable(codec, nid);
513 strlcpy(name, base_name, sizeof(name));
515 snd_hda_get_pin_label(codec, nid, cfg, name, sizeof(name), NULL);
517 /* Example final name: "Internal Mic Phantom Jack" */
518 strncat(name, " Phantom", sizeof(name) - strlen(name) - 1);
519 err = snd_hda_jack_add_kctl(codec, nid, name, phantom_jack, 0, NULL);
524 return snd_hda_jack_detect_enable(codec, nid, 0);
529 * snd_hda_jack_add_kctls - Add kctls for all pins included in the given pincfg
530 * @codec: the HDA codec
531 * @cfg: pin config table to parse
533 int snd_hda_jack_add_kctls(struct hda_codec *codec,
534 const struct auto_pin_cfg *cfg)
539 for (i = 0; i < cfg->num_inputs; i++) {
540 /* If we have headphone mics; make sure they get the right name
541 before grabbed by output pins */
542 if (cfg->inputs[i].is_headphone_mic) {
543 if (auto_cfg_hp_outs(cfg) == 1)
544 err = add_jack_kctl(codec, auto_cfg_hp_pins(cfg)[0],
545 cfg, "Headphone Mic");
547 err = add_jack_kctl(codec, cfg->inputs[i].pin,
548 cfg, "Headphone Mic");
550 err = add_jack_kctl(codec, cfg->inputs[i].pin, cfg,
556 for (i = 0, p = cfg->line_out_pins; i < cfg->line_outs; i++, p++) {
557 err = add_jack_kctl(codec, *p, cfg, NULL);
561 for (i = 0, p = cfg->hp_pins; i < cfg->hp_outs; i++, p++) {
562 if (*p == *cfg->line_out_pins) /* might be duplicated */
564 err = add_jack_kctl(codec, *p, cfg, NULL);
568 for (i = 0, p = cfg->speaker_pins; i < cfg->speaker_outs; i++, p++) {
569 if (*p == *cfg->line_out_pins) /* might be duplicated */
571 err = add_jack_kctl(codec, *p, cfg, NULL);
575 for (i = 0, p = cfg->dig_out_pins; i < cfg->dig_outs; i++, p++) {
576 err = add_jack_kctl(codec, *p, cfg, NULL);
580 err = add_jack_kctl(codec, cfg->dig_in_pin, cfg, NULL);
583 err = add_jack_kctl(codec, cfg->mono_out_pin, cfg, NULL);
588 EXPORT_SYMBOL_GPL(snd_hda_jack_add_kctls);
590 static void call_jack_callback(struct hda_codec *codec, unsigned int res,
591 struct hda_jack_tbl *jack)
593 struct hda_jack_callback *cb;
595 for (cb = jack->callback; cb; cb = cb->next) {
600 if (jack->gated_jack) {
601 struct hda_jack_tbl *gated =
602 snd_hda_jack_tbl_get_mst(codec, jack->gated_jack,
605 for (cb = gated->callback; cb; cb = cb->next) {
615 * snd_hda_jack_unsol_event - Handle an unsolicited event
616 * @codec: the HDA codec
617 * @res: the unsolicited event data
619 void snd_hda_jack_unsol_event(struct hda_codec *codec, unsigned int res)
621 struct hda_jack_tbl *event;
622 int tag = (res & AC_UNSOL_RES_TAG) >> AC_UNSOL_RES_TAG_SHIFT;
626 (res & AC_UNSOL_RES_DE) >> AC_UNSOL_RES_DE_SHIFT;
628 event = snd_hda_jack_tbl_get_from_tag(codec, tag, dev_entry);
630 event = snd_hda_jack_tbl_get_from_tag(codec, tag, 0);
634 event->jack_dirty = 1;
636 call_jack_callback(codec, res, event);
637 snd_hda_jack_report_sync(codec);
639 EXPORT_SYMBOL_GPL(snd_hda_jack_unsol_event);
642 * snd_hda_jack_poll_all - Poll all jacks
643 * @codec: the HDA codec
645 * Poll all detectable jacks with dirty flag, update the status, call
646 * callbacks and call snd_hda_jack_report_sync() if any changes are found.
648 void snd_hda_jack_poll_all(struct hda_codec *codec)
650 struct hda_jack_tbl *jack = codec->jacktbl.list;
653 for (i = 0; i < codec->jacktbl.used; i++, jack++) {
654 unsigned int old_sense;
655 if (!jack->nid || !jack->jack_dirty || jack->phantom_jack)
657 old_sense = get_jack_plug_state(jack->pin_sense);
658 jack_detect_update(codec, jack);
659 if (old_sense == get_jack_plug_state(jack->pin_sense))
662 call_jack_callback(codec, 0, jack);
665 snd_hda_jack_report_sync(codec);
667 EXPORT_SYMBOL_GPL(snd_hda_jack_poll_all);