xref: /openbmc/linux/sound/pci/hda/hda_jack.h (revision 600a711c)
1 /*
2  * Jack-detection handling for HD-audio
3  *
4  * Copyright (c) 2011 Takashi Iwai <tiwai@suse.de>
5  *
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.
10  */
11 
12 #ifndef __SOUND_HDA_JACK_H
13 #define __SOUND_HDA_JACK_H
14 
15 struct auto_pin_cfg;
16 
17 struct hda_jack_tbl {
18 	hda_nid_t nid;
19 	unsigned char action;		/* event action (0 = none) */
20 	unsigned char tag;		/* unsol event tag */
21 	unsigned int private_data;	/* arbitrary data */
22 	/* jack-detection stuff */
23 	unsigned int pin_sense;		/* cached pin-sense value */
24 	unsigned int jack_detect:1;	/* capable of jack-detection? */
25 	unsigned int jack_dirty:1;	/* needs to update? */
26 	unsigned int phantom_jack:1;    /* a fixed, always present port? */
27 	struct snd_kcontrol *kctl;	/* assigned kctl for jack-detection */
28 #ifdef CONFIG_SND_HDA_INPUT_JACK
29 	int type;
30 	struct snd_jack *jack;
31 #endif
32 };
33 
34 struct hda_jack_tbl *
35 snd_hda_jack_tbl_get(struct hda_codec *codec, hda_nid_t nid);
36 struct hda_jack_tbl *
37 snd_hda_jack_tbl_get_from_tag(struct hda_codec *codec, unsigned char tag);
38 
39 struct hda_jack_tbl *
40 snd_hda_jack_tbl_new(struct hda_codec *codec, hda_nid_t nid);
41 void snd_hda_jack_tbl_clear(struct hda_codec *codec);
42 
43 /**
44  * snd_hda_jack_get_action - get jack-tbl entry for the tag
45  *
46  * Call this from the unsol event handler to get the assigned action for the
47  * event.  This will mark the dirty flag for the later reporting, too.
48  */
49 static inline unsigned char
50 snd_hda_jack_get_action(struct hda_codec *codec, unsigned int tag)
51 {
52 	struct hda_jack_tbl *jack = snd_hda_jack_tbl_get_from_tag(codec, tag);
53 	if (jack) {
54 		jack->jack_dirty = 1;
55 		return jack->action;
56 	}
57 	return 0;
58 }
59 
60 void snd_hda_jack_set_dirty_all(struct hda_codec *codec);
61 
62 int snd_hda_jack_detect_enable(struct hda_codec *codec, hda_nid_t nid,
63 			       unsigned char action);
64 
65 u32 snd_hda_pin_sense(struct hda_codec *codec, hda_nid_t nid);
66 int snd_hda_jack_detect(struct hda_codec *codec, hda_nid_t nid);
67 
68 bool is_jack_detectable(struct hda_codec *codec, hda_nid_t nid);
69 
70 int snd_hda_jack_add_kctl(struct hda_codec *codec, hda_nid_t nid,
71 			  const char *name, int idx);
72 int snd_hda_jack_add_kctls(struct hda_codec *codec,
73 			   const struct auto_pin_cfg *cfg);
74 
75 void snd_hda_jack_report_sync(struct hda_codec *codec);
76 
77 
78 #endif /* __SOUND_HDA_JACK_H */
79