xref: /linux-6.15/include/sound/jack.h (revision 7b366d5f)
1 #ifndef __SOUND_JACK_H
2 #define __SOUND_JACK_H
3 
4 /*
5  *  Jack abstraction layer
6  *
7  *  Copyright 2008 Wolfson Microelectronics plc
8  *
9  *
10  *   This program is free software; you can redistribute it and/or modify
11  *   it under the terms of the GNU General Public License as published by
12  *   the Free Software Foundation; either version 2 of the License, or
13  *   (at your option) any later version.
14  *
15  *   This program is distributed in the hope that it will be useful,
16  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
17  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  *   GNU General Public License for more details.
19  *
20  *   You should have received a copy of the GNU General Public License
21  *   along with this program; if not, write to the Free Software
22  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
23  *
24  */
25 
26 #include <sound/core.h>
27 
28 struct input_dev;
29 
30 /**
31  * enum snd_jack_types: Jack types which can be reported
32  *
33  * These values are used as a bitmask.
34  *
35  * Note that this must be kept in sync with the lookup table in
36  * sound/core/jack.c.
37  */
38 enum snd_jack_types {
39 	SND_JACK_HEADPHONE	= 0x0001,
40 	SND_JACK_MICROPHONE	= 0x0002,
41 	SND_JACK_HEADSET	= SND_JACK_HEADPHONE | SND_JACK_MICROPHONE,
42 	SND_JACK_LINEOUT	= 0x0004,
43 	SND_JACK_MECHANICAL	= 0x0008, /* If detected separately */
44 	SND_JACK_VIDEOOUT	= 0x0010,
45 	SND_JACK_AVOUT		= SND_JACK_LINEOUT | SND_JACK_VIDEOOUT,
46 	SND_JACK_LINEIN		= 0x0020,
47 
48 	/* Kept separate from switches to facilitate implementation */
49 	SND_JACK_BTN_0		= 0x4000,
50 	SND_JACK_BTN_1		= 0x2000,
51 	SND_JACK_BTN_2		= 0x1000,
52 	SND_JACK_BTN_3		= 0x0800,
53 	SND_JACK_BTN_4		= 0x0400,
54 	SND_JACK_BTN_5		= 0x0200,
55 };
56 
57 /* Keep in sync with definitions above */
58 #define SND_JACK_SWITCH_TYPES 6
59 
60 struct snd_jack {
61 	struct input_dev *input_dev;
62 	int registered;
63 	int type;
64 	const char *id;
65 	char name[100];
66 	unsigned int key[6];   /* Keep in sync with definitions above */
67 	void *private_data;
68 	void (*private_free)(struct snd_jack *);
69 };
70 
71 #ifdef CONFIG_SND_JACK
72 
73 int snd_jack_new(struct snd_card *card, const char *id, int type,
74 		 struct snd_jack **jack);
75 void snd_jack_set_parent(struct snd_jack *jack, struct device *parent);
76 int snd_jack_set_key(struct snd_jack *jack, enum snd_jack_types type,
77 		     int keytype);
78 
79 void snd_jack_report(struct snd_jack *jack, int status);
80 
81 #else
82 
83 static inline int snd_jack_new(struct snd_card *card, const char *id, int type,
84 			       struct snd_jack **jack)
85 {
86 	return 0;
87 }
88 
89 static inline void snd_jack_set_parent(struct snd_jack *jack,
90 				       struct device *parent)
91 {
92 }
93 
94 static inline void snd_jack_report(struct snd_jack *jack, int status)
95 {
96 }
97 
98 #endif
99 
100 #endif
101