xref: /openbmc/linux/sound/pci/hda/hda_jack.h (revision 94cdda6b)
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 #include <linux/err.h>
16 
17 struct auto_pin_cfg;
18 struct hda_jack_tbl;
19 struct hda_jack_callback;
20 
21 typedef void (*hda_jack_callback_fn) (struct hda_codec *, struct hda_jack_callback *);
22 
23 struct hda_jack_callback {
24 	struct hda_jack_tbl *tbl;
25 	hda_jack_callback_fn func;
26 	unsigned int private_data;	/* arbitrary data */
27 	struct hda_jack_callback *next;
28 };
29 
30 struct hda_jack_tbl {
31 	hda_nid_t nid;
32 	unsigned char tag;		/* unsol event tag */
33 	struct hda_jack_callback *callback;
34 	/* jack-detection stuff */
35 	unsigned int pin_sense;		/* cached pin-sense value */
36 	unsigned int jack_detect:1;	/* capable of jack-detection? */
37 	unsigned int jack_dirty:1;	/* needs to update? */
38 	unsigned int phantom_jack:1;    /* a fixed, always present port? */
39 	unsigned int block_report:1;    /* in a transitional state - do not report to userspace */
40 	hda_nid_t gating_jack;		/* valid when gating jack plugged */
41 	hda_nid_t gated_jack;		/* gated is dependent on this jack */
42 	struct snd_kcontrol *kctl;	/* assigned kctl for jack-detection */
43 #ifdef CONFIG_SND_HDA_INPUT_JACK
44 	int type;
45 	struct snd_jack *jack;
46 #endif
47 };
48 
49 struct hda_jack_tbl *
50 snd_hda_jack_tbl_get(struct hda_codec *codec, hda_nid_t nid);
51 struct hda_jack_tbl *
52 snd_hda_jack_tbl_get_from_tag(struct hda_codec *codec, unsigned char tag);
53 
54 void snd_hda_jack_tbl_clear(struct hda_codec *codec);
55 
56 void snd_hda_jack_set_dirty_all(struct hda_codec *codec);
57 
58 int snd_hda_jack_detect_enable(struct hda_codec *codec, hda_nid_t nid);
59 struct hda_jack_callback *
60 snd_hda_jack_detect_enable_callback(struct hda_codec *codec, hda_nid_t nid,
61 				    hda_jack_callback_fn cb);
62 
63 int snd_hda_jack_set_gating_jack(struct hda_codec *codec, hda_nid_t gated_nid,
64 				 hda_nid_t gating_nid);
65 
66 u32 snd_hda_pin_sense(struct hda_codec *codec, hda_nid_t nid);
67 
68 /* the jack state returned from snd_hda_jack_detect_state() */
69 enum {
70 	HDA_JACK_NOT_PRESENT, HDA_JACK_PRESENT, HDA_JACK_PHANTOM,
71 };
72 
73 int snd_hda_jack_detect_state(struct hda_codec *codec, hda_nid_t nid);
74 
75 /**
76  * snd_hda_jack_detect - Detect the jack
77  * @codec: the HDA codec
78  * @nid: pin NID to check jack detection
79  */
80 static inline bool snd_hda_jack_detect(struct hda_codec *codec, hda_nid_t nid)
81 {
82 	return snd_hda_jack_detect_state(codec, nid) != HDA_JACK_NOT_PRESENT;
83 }
84 
85 bool is_jack_detectable(struct hda_codec *codec, hda_nid_t nid);
86 
87 int snd_hda_jack_add_kctl(struct hda_codec *codec, hda_nid_t nid,
88 			  const char *name, int idx);
89 int snd_hda_jack_add_kctls(struct hda_codec *codec,
90 			   const struct auto_pin_cfg *cfg);
91 
92 void snd_hda_jack_report_sync(struct hda_codec *codec);
93 
94 void snd_hda_jack_unsol_event(struct hda_codec *codec, unsigned int res);
95 
96 void snd_hda_jack_poll_all(struct hda_codec *codec);
97 
98 #endif /* __SOUND_HDA_JACK_H */
99