xref: /openbmc/linux/sound/pci/hda/hda_jack.h (revision ca79522c)
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 struct hda_jack_tbl;
17 
18 typedef void (*hda_jack_callback) (struct hda_codec *, struct hda_jack_tbl *);
19 
20 struct hda_jack_tbl {
21 	hda_nid_t nid;
22 	unsigned char action;		/* event action (0 = none) */
23 	unsigned char tag;		/* unsol event tag */
24 	unsigned int private_data;	/* arbitrary data */
25 	hda_jack_callback callback;
26 	/* jack-detection stuff */
27 	unsigned int pin_sense;		/* cached pin-sense value */
28 	unsigned int jack_detect:1;	/* capable of jack-detection? */
29 	unsigned int jack_dirty:1;	/* needs to update? */
30 	unsigned int phantom_jack:1;    /* a fixed, always present port? */
31 	hda_nid_t gating_jack;		/* valid when gating jack plugged */
32 	hda_nid_t gated_jack;		/* gated is dependent on this jack */
33 	struct snd_kcontrol *kctl;	/* assigned kctl for jack-detection */
34 #ifdef CONFIG_SND_HDA_INPUT_JACK
35 	int type;
36 	struct snd_jack *jack;
37 #endif
38 };
39 
40 struct hda_jack_tbl *
41 snd_hda_jack_tbl_get(struct hda_codec *codec, hda_nid_t nid);
42 struct hda_jack_tbl *
43 snd_hda_jack_tbl_get_from_tag(struct hda_codec *codec, unsigned char tag);
44 
45 struct hda_jack_tbl *
46 snd_hda_jack_tbl_new(struct hda_codec *codec, hda_nid_t nid);
47 void snd_hda_jack_tbl_clear(struct hda_codec *codec);
48 
49 /**
50  * snd_hda_jack_get_action - get jack-tbl entry for the tag
51  *
52  * Call this from the unsol event handler to get the assigned action for the
53  * event.  This will mark the dirty flag for the later reporting, too.
54  */
55 static inline unsigned char
56 snd_hda_jack_get_action(struct hda_codec *codec, unsigned int tag)
57 {
58 	struct hda_jack_tbl *jack = snd_hda_jack_tbl_get_from_tag(codec, tag);
59 	if (jack) {
60 		jack->jack_dirty = 1;
61 		return jack->action;
62 	}
63 	return 0;
64 }
65 
66 void snd_hda_jack_set_dirty_all(struct hda_codec *codec);
67 
68 int snd_hda_jack_detect_enable(struct hda_codec *codec, hda_nid_t nid,
69 			       unsigned char action);
70 int snd_hda_jack_detect_enable_callback(struct hda_codec *codec, hda_nid_t nid,
71 					unsigned char action,
72 					hda_jack_callback cb);
73 
74 int snd_hda_jack_set_gating_jack(struct hda_codec *codec, hda_nid_t gated_nid,
75 				 hda_nid_t gating_nid);
76 
77 u32 snd_hda_pin_sense(struct hda_codec *codec, hda_nid_t nid);
78 int snd_hda_jack_detect(struct hda_codec *codec, hda_nid_t nid);
79 
80 bool is_jack_detectable(struct hda_codec *codec, hda_nid_t nid);
81 
82 int snd_hda_jack_add_kctl(struct hda_codec *codec, hda_nid_t nid,
83 			  const char *name, int idx);
84 int snd_hda_jack_add_kctls(struct hda_codec *codec,
85 			   const struct auto_pin_cfg *cfg);
86 
87 void snd_hda_jack_report_sync(struct hda_codec *codec);
88 
89 void snd_hda_jack_unsol_event(struct hda_codec *codec, unsigned int res);
90 
91 void snd_hda_jack_poll_all(struct hda_codec *codec);
92 
93 #endif /* __SOUND_HDA_JACK_H */
94