1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 #ifndef __SOUND_JACK_H
3 #define __SOUND_JACK_H
4 
5 /*
6  *  Jack abstraction layer
7  *
8  *  Copyright 2008 Wolfson Microelectronics plc
9  */
10 
11 #include <sound/core.h>
12 
13 struct input_dev;
14 
15 /**
16  * enum snd_jack_types - Jack types which can be reported
17  * @SND_JACK_HEADPHONE: Headphone
18  * @SND_JACK_MICROPHONE: Microphone
19  * @SND_JACK_HEADSET: Headset
20  * @SND_JACK_LINEOUT: Line out
21  * @SND_JACK_MECHANICAL: Mechanical switch
22  * @SND_JACK_VIDEOOUT: Video out
23  * @SND_JACK_AVOUT: AV (Audio Video) out
24  * @SND_JACK_LINEIN:  Line in
25  * @SND_JACK_BTN_0: Button 0
26  * @SND_JACK_BTN_1: Button 1
27  * @SND_JACK_BTN_2: Button 2
28  * @SND_JACK_BTN_3: Button 3
29  * @SND_JACK_BTN_4: Button 4
30  * @SND_JACK_BTN_5: Button 5
31  *
32  * These values are used as a bitmask.
33  *
34  * Note that this must be kept in sync with the lookup table in
35  * sound/core/jack.c.
36  */
37 enum snd_jack_types {
38 	SND_JACK_HEADPHONE	= 0x0001,
39 	SND_JACK_MICROPHONE	= 0x0002,
40 	SND_JACK_HEADSET	= SND_JACK_HEADPHONE | SND_JACK_MICROPHONE,
41 	SND_JACK_LINEOUT	= 0x0004,
42 	SND_JACK_MECHANICAL	= 0x0008, /* If detected separately */
43 	SND_JACK_VIDEOOUT	= 0x0010,
44 	SND_JACK_AVOUT		= SND_JACK_LINEOUT | SND_JACK_VIDEOOUT,
45 	SND_JACK_LINEIN		= 0x0020,
46 
47 	/* Kept separate from switches to facilitate implementation */
48 	SND_JACK_BTN_0		= 0x4000,
49 	SND_JACK_BTN_1		= 0x2000,
50 	SND_JACK_BTN_2		= 0x1000,
51 	SND_JACK_BTN_3		= 0x0800,
52 	SND_JACK_BTN_4		= 0x0400,
53 	SND_JACK_BTN_5		= 0x0200,
54 };
55 
56 /* Keep in sync with definitions above */
57 #define SND_JACK_SWITCH_TYPES 6
58 
59 struct snd_jack {
60 	struct list_head kctl_list;
61 	struct snd_card *card;
62 	const char *id;
63 #ifdef CONFIG_SND_JACK_INPUT_DEV
64 	struct input_dev *input_dev;
65 	struct mutex input_dev_lock;
66 	int registered;
67 	int type;
68 	char name[100];
69 	unsigned int key[6];   /* Keep in sync with definitions above */
70 #endif /* CONFIG_SND_JACK_INPUT_DEV */
71 	int hw_status_cache;
72 	void *private_data;
73 	void (*private_free)(struct snd_jack *);
74 };
75 
76 #ifdef CONFIG_SND_JACK
77 
78 int snd_jack_new(struct snd_card *card, const char *id, int type,
79 		 struct snd_jack **jack, bool initial_kctl, bool phantom_jack);
80 int snd_jack_add_new_kctl(struct snd_jack *jack, const char * name, int mask);
81 #ifdef CONFIG_SND_JACK_INPUT_DEV
82 void snd_jack_set_parent(struct snd_jack *jack, struct device *parent);
83 int snd_jack_set_key(struct snd_jack *jack, enum snd_jack_types type,
84 		     int keytype);
85 #endif
86 void snd_jack_report(struct snd_jack *jack, int status);
87 
88 #else
snd_jack_new(struct snd_card * card,const char * id,int type,struct snd_jack ** jack,bool initial_kctl,bool phantom_jack)89 static inline int snd_jack_new(struct snd_card *card, const char *id, int type,
90 			       struct snd_jack **jack, bool initial_kctl, bool phantom_jack)
91 {
92 	return 0;
93 }
94 
snd_jack_add_new_kctl(struct snd_jack * jack,const char * name,int mask)95 static inline int snd_jack_add_new_kctl(struct snd_jack *jack, const char * name, int mask)
96 {
97 	return 0;
98 }
99 
snd_jack_report(struct snd_jack * jack,int status)100 static inline void snd_jack_report(struct snd_jack *jack, int status)
101 {
102 }
103 
104 #endif
105 
106 #if !defined(CONFIG_SND_JACK) || !defined(CONFIG_SND_JACK_INPUT_DEV)
snd_jack_set_parent(struct snd_jack * jack,struct device * parent)107 static inline void snd_jack_set_parent(struct snd_jack *jack,
108 				       struct device *parent)
109 {
110 }
111 
snd_jack_set_key(struct snd_jack * jack,enum snd_jack_types type,int keytype)112 static inline int snd_jack_set_key(struct snd_jack *jack,
113 				   enum snd_jack_types type,
114 				   int keytype)
115 {
116 	return 0;
117 }
118 #endif /* !CONFIG_SND_JACK || !CONFIG_SND_JACK_INPUT_DEV */
119 
120 #endif
121