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 (!codec->ignore_misc_bit &&
30 (get_defcfg_misc(snd_hda_codec_get_pincfg(codec, nid)) &
31 AC_DEFCFG_MISC_NO_PRESENCE))
33 if (!(get_wcaps(codec, nid) & AC_WCAP_UNSOL_CAP))
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)
44 if (!codec->no_trigger_sense) {
45 pincap = snd_hda_query_pin_caps(codec, nid);
46 if (pincap & AC_PINCAP_TRIG_REQ) /* need trigger? */
47 snd_hda_codec_read(codec, nid, 0,
48 AC_VERB_SET_PIN_SENSE, 0);
50 return snd_hda_codec_read(codec, nid, 0,
51 AC_VERB_GET_PIN_SENSE, 0);
55 * snd_hda_jack_tbl_get - query the jack-table entry for the given NID
58 snd_hda_jack_tbl_get(struct hda_codec *codec, hda_nid_t nid)
60 struct hda_jack_tbl *jack = codec->jacktbl.list;
65 for (i = 0; i < codec->jacktbl.used; i++, jack++)
70 EXPORT_SYMBOL_HDA(snd_hda_jack_tbl_get);
73 * snd_hda_jack_tbl_get_from_tag - query the jack-table entry for the given tag
76 snd_hda_jack_tbl_get_from_tag(struct hda_codec *codec, unsigned char tag)
78 struct hda_jack_tbl *jack = codec->jacktbl.list;
83 for (i = 0; i < codec->jacktbl.used; i++, jack++)
88 EXPORT_SYMBOL_HDA(snd_hda_jack_tbl_get_from_tag);
91 * snd_hda_jack_tbl_new - create a jack-table entry for the given NID
94 snd_hda_jack_tbl_new(struct hda_codec *codec, hda_nid_t nid)
96 struct hda_jack_tbl *jack = snd_hda_jack_tbl_get(codec, nid);
99 snd_array_init(&codec->jacktbl, sizeof(*jack), 16);
100 jack = snd_array_new(&codec->jacktbl);
104 jack->jack_dirty = 1;
105 jack->tag = codec->jacktbl.used;
108 EXPORT_SYMBOL_HDA(snd_hda_jack_tbl_new);
110 void snd_hda_jack_tbl_clear(struct hda_codec *codec)
112 #ifdef CONFIG_SND_HDA_INPUT_JACK
113 /* free jack instances manually when clearing/reconfiguring */
114 if (!codec->bus->shutdown && codec->jacktbl.list) {
115 struct hda_jack_tbl *jack = codec->jacktbl.list;
117 for (i = 0; i < codec->jacktbl.used; i++, jack++) {
119 snd_device_free(codec->bus->card, jack->jack);
123 snd_array_free(&codec->jacktbl);
126 /* update the cached value and notification flag if needed */
127 static void jack_detect_update(struct hda_codec *codec,
128 struct hda_jack_tbl *jack)
130 if (!jack->jack_dirty)
133 if (jack->phantom_jack)
134 jack->pin_sense = AC_PINSENSE_PRESENCE;
136 jack->pin_sense = read_pin_sense(codec, jack->nid);
138 jack->jack_dirty = 0;
142 * snd_hda_set_dirty_all - Mark all the cached as dirty
144 * This function sets the dirty flag to all entries of jack table.
145 * It's called from the resume path in hda_codec.c.
147 void snd_hda_jack_set_dirty_all(struct hda_codec *codec)
149 struct hda_jack_tbl *jack = codec->jacktbl.list;
152 for (i = 0; i < codec->jacktbl.used; i++, jack++)
154 jack->jack_dirty = 1;
156 EXPORT_SYMBOL_HDA(snd_hda_jack_set_dirty_all);
159 * snd_hda_pin_sense - execute pin sense measurement
160 * @codec: the CODEC to sense
161 * @nid: the pin NID to sense
163 * Execute necessary pin sense measurement and return its Presence Detect,
164 * Impedance, ELD Valid etc. status bits.
166 u32 snd_hda_pin_sense(struct hda_codec *codec, hda_nid_t nid)
168 struct hda_jack_tbl *jack = snd_hda_jack_tbl_get(codec, nid);
170 jack_detect_update(codec, jack);
171 return jack->pin_sense;
173 return read_pin_sense(codec, nid);
175 EXPORT_SYMBOL_HDA(snd_hda_pin_sense);
177 #define get_jack_plug_state(sense) !!(sense & AC_PINSENSE_PRESENCE)
180 * snd_hda_jack_detect - query pin Presence Detect status
181 * @codec: the CODEC to sense
182 * @nid: the pin NID to sense
184 * Query and return the pin's Presence Detect status.
186 int snd_hda_jack_detect(struct hda_codec *codec, hda_nid_t nid)
188 u32 sense = snd_hda_pin_sense(codec, nid);
189 return get_jack_plug_state(sense);
191 EXPORT_SYMBOL_HDA(snd_hda_jack_detect);
194 * snd_hda_jack_detect_enable - enable the jack-detection
196 int snd_hda_jack_detect_enable(struct hda_codec *codec, hda_nid_t nid,
197 unsigned char action)
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;
207 return snd_hda_codec_write_cache(codec, nid, 0,
208 AC_VERB_SET_UNSOLICITED_ENABLE,
209 AC_USRSP_EN | jack->tag);
211 EXPORT_SYMBOL_HDA(snd_hda_jack_detect_enable);
214 * snd_hda_jack_report_sync - sync the states of all jacks and report if changed
216 void snd_hda_jack_report_sync(struct hda_codec *codec)
218 struct hda_jack_tbl *jack = codec->jacktbl.list;
221 for (i = 0; i < codec->jacktbl.used; i++, jack++)
223 jack_detect_update(codec, jack);
226 state = get_jack_plug_state(jack->pin_sense);
227 snd_kctl_jack_report(codec->bus->card, jack->kctl, state);
228 #ifdef CONFIG_SND_HDA_INPUT_JACK
230 snd_jack_report(jack->jack,
231 state ? jack->type : 0);
235 EXPORT_SYMBOL_HDA(snd_hda_jack_report_sync);
237 #ifdef CONFIG_SND_HDA_INPUT_JACK
238 /* guess the jack type from the pin-config */
239 static int get_input_jack_type(struct hda_codec *codec, hda_nid_t nid)
241 unsigned int def_conf = snd_hda_codec_get_pincfg(codec, nid);
242 switch (get_defcfg_device(def_conf)) {
243 case AC_JACK_LINE_OUT:
244 case AC_JACK_SPEAKER:
245 return SND_JACK_LINEOUT;
247 return SND_JACK_HEADPHONE;
248 case AC_JACK_SPDIF_OUT:
249 case AC_JACK_DIG_OTHER_OUT:
250 return SND_JACK_AVOUT;
252 return SND_JACK_MICROPHONE;
254 return SND_JACK_LINEIN;
258 static void hda_free_jack_priv(struct snd_jack *jack)
260 struct hda_jack_tbl *jacks = jack->private_data;
267 * snd_hda_jack_add_kctl - Add a kctl for the given pin
269 * This assigns a jack-detection kctl to the given pin. The kcontrol
270 * will have the given name and index.
272 static int __snd_hda_jack_add_kctl(struct hda_codec *codec, hda_nid_t nid,
273 const char *name, int idx, bool phantom_jack)
275 struct hda_jack_tbl *jack;
276 struct snd_kcontrol *kctl;
279 jack = snd_hda_jack_tbl_new(codec, nid);
283 return 0; /* already created */
284 kctl = snd_kctl_jack_new(name, idx, codec);
287 err = snd_hda_ctl_add(codec, nid, kctl);
291 jack->phantom_jack = !!phantom_jack;
293 state = snd_hda_jack_detect(codec, nid);
294 snd_kctl_jack_report(codec->bus->card, kctl, state);
295 #ifdef CONFIG_SND_HDA_INPUT_JACK
297 jack->type = get_input_jack_type(codec, nid);
298 err = snd_jack_new(codec->bus->card, name, jack->type,
302 jack->jack->private_data = jack;
303 jack->jack->private_free = hda_free_jack_priv;
304 snd_jack_report(jack->jack, state ? jack->type : 0);
310 int snd_hda_jack_add_kctl(struct hda_codec *codec, hda_nid_t nid,
311 const char *name, int idx)
313 return __snd_hda_jack_add_kctl(codec, nid, name, idx, false);
315 EXPORT_SYMBOL_HDA(snd_hda_jack_add_kctl);
317 /* get the unique index number for the given kctl name */
318 static int get_unique_index(struct hda_codec *codec, const char *name, int idx)
320 struct hda_jack_tbl *jack;
321 int i, len = strlen(name);
323 jack = codec->jacktbl.list;
324 for (i = 0; i < codec->jacktbl.used; i++, jack++) {
325 /* jack->kctl.id contains "XXX Jack" name string with index */
327 !strncmp(name, jack->kctl->id.name, len) &&
328 !strcmp(" Jack", jack->kctl->id.name + len) &&
329 jack->kctl->id.index == idx) {
337 static int add_jack_kctl(struct hda_codec *codec, hda_nid_t nid,
338 const struct auto_pin_cfg *cfg)
340 unsigned int def_conf, conn;
347 def_conf = snd_hda_codec_get_pincfg(codec, nid);
348 conn = get_defcfg_connect(def_conf);
349 if (conn == AC_JACK_PORT_NONE)
351 phantom_jack = (conn != AC_JACK_PORT_COMPLEX) ||
352 !is_jack_detectable(codec, nid);
354 snd_hda_get_pin_label(codec, nid, cfg, name, sizeof(name), &idx);
356 /* Example final name: "Internal Mic Phantom Jack" */
357 strncat(name, " Phantom", sizeof(name) - strlen(name) - 1);
358 idx = get_unique_index(codec, name, idx);
359 err = __snd_hda_jack_add_kctl(codec, nid, name, idx, phantom_jack);
364 return snd_hda_jack_detect_enable(codec, nid, 0);
369 * snd_hda_jack_add_kctls - Add kctls for all pins included in the given pincfg
371 int snd_hda_jack_add_kctls(struct hda_codec *codec,
372 const struct auto_pin_cfg *cfg)
377 for (i = 0, p = cfg->line_out_pins; i < cfg->line_outs; i++, p++) {
378 err = add_jack_kctl(codec, *p, cfg);
382 for (i = 0, p = cfg->hp_pins; i < cfg->hp_outs; i++, p++) {
383 if (*p == *cfg->line_out_pins) /* might be duplicated */
385 err = add_jack_kctl(codec, *p, cfg);
389 for (i = 0, p = cfg->speaker_pins; i < cfg->speaker_outs; i++, p++) {
390 if (*p == *cfg->line_out_pins) /* might be duplicated */
392 err = add_jack_kctl(codec, *p, cfg);
396 for (i = 0; i < cfg->num_inputs; i++) {
397 err = add_jack_kctl(codec, cfg->inputs[i].pin, cfg);
401 for (i = 0, p = cfg->dig_out_pins; i < cfg->dig_outs; i++, p++) {
402 err = add_jack_kctl(codec, *p, cfg);
406 err = add_jack_kctl(codec, cfg->dig_in_pin, cfg);
409 err = add_jack_kctl(codec, cfg->mono_out_pin, cfg);
414 EXPORT_SYMBOL_HDA(snd_hda_jack_add_kctls);