xref: /openbmc/linux/include/sound/jack.h (revision cfbb9be8)
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  * @SND_JACK_HEADPHONE: Headphone
33  * @SND_JACK_MICROPHONE: Microphone
34  * @SND_JACK_HEADSET: Headset
35  * @SND_JACK_LINEOUT: Line out
36  * @SND_JACK_MECHANICAL: Mechanical switch
37  * @SND_JACK_VIDEOOUT: Video out
38  * @SND_JACK_AVOUT: AV (Audio Video) out
39  * @SND_JACK_LINEIN:  Line in
40  * @SND_JACK_BTN_0: Button 0
41  * @SND_JACK_BTN_1: Button 1
42  * @SND_JACK_BTN_2: Button 2
43  * @SND_JACK_BTN_3: Button 3
44  * @SND_JACK_BTN_4: Button 4
45  * @SND_JACK_BTN_5: Button 5
46  *
47  * These values are used as a bitmask.
48  *
49  * Note that this must be kept in sync with the lookup table in
50  * sound/core/jack.c.
51  */
52 enum snd_jack_types {
53 	SND_JACK_HEADPHONE	= 0x0001,
54 	SND_JACK_MICROPHONE	= 0x0002,
55 	SND_JACK_HEADSET	= SND_JACK_HEADPHONE | SND_JACK_MICROPHONE,
56 	SND_JACK_LINEOUT	= 0x0004,
57 	SND_JACK_MECHANICAL	= 0x0008, /* If detected separately */
58 	SND_JACK_VIDEOOUT	= 0x0010,
59 	SND_JACK_AVOUT		= SND_JACK_LINEOUT | SND_JACK_VIDEOOUT,
60 	SND_JACK_LINEIN		= 0x0020,
61 
62 	/* Kept separate from switches to facilitate implementation */
63 	SND_JACK_BTN_0		= 0x4000,
64 	SND_JACK_BTN_1		= 0x2000,
65 	SND_JACK_BTN_2		= 0x1000,
66 	SND_JACK_BTN_3		= 0x0800,
67 	SND_JACK_BTN_4		= 0x0400,
68 	SND_JACK_BTN_5		= 0x0200,
69 };
70 
71 /* Keep in sync with definitions above */
72 #define SND_JACK_SWITCH_TYPES 6
73 
74 struct snd_jack {
75 	struct list_head kctl_list;
76 	struct snd_card *card;
77 	const char *id;
78 #ifdef CONFIG_SND_JACK_INPUT_DEV
79 	struct input_dev *input_dev;
80 	int registered;
81 	int type;
82 	char name[100];
83 	unsigned int key[6];   /* Keep in sync with definitions above */
84 #endif /* CONFIG_SND_JACK_INPUT_DEV */
85 	void *private_data;
86 	void (*private_free)(struct snd_jack *);
87 };
88 
89 #ifdef CONFIG_SND_JACK
90 
91 int snd_jack_new(struct snd_card *card, const char *id, int type,
92 		 struct snd_jack **jack, bool initial_kctl, bool phantom_jack);
93 int snd_jack_add_new_kctl(struct snd_jack *jack, const char * name, int mask);
94 #ifdef CONFIG_SND_JACK_INPUT_DEV
95 void snd_jack_set_parent(struct snd_jack *jack, struct device *parent);
96 int snd_jack_set_key(struct snd_jack *jack, enum snd_jack_types type,
97 		     int keytype);
98 #endif
99 void snd_jack_report(struct snd_jack *jack, int status);
100 
101 #else
102 static inline int snd_jack_new(struct snd_card *card, const char *id, int type,
103 			       struct snd_jack **jack, bool initial_kctl, bool phantom_jack)
104 {
105 	return 0;
106 }
107 
108 static inline int snd_jack_add_new_kctl(struct snd_jack *jack, const char * name, int mask)
109 {
110 	return 0;
111 }
112 
113 static inline void snd_jack_report(struct snd_jack *jack, int status)
114 {
115 }
116 
117 #endif
118 
119 #if !defined(CONFIG_SND_JACK) || !defined(CONFIG_SND_JACK_INPUT_DEV)
120 static inline void snd_jack_set_parent(struct snd_jack *jack,
121 				       struct device *parent)
122 {
123 }
124 
125 static inline int snd_jack_set_key(struct snd_jack *jack,
126 				   enum snd_jack_types type,
127 				   int keytype)
128 {
129 	return 0;
130 }
131 #endif /* !CONFIG_SND_JACK || !CONFIG_SND_JACK_INPUT_DEV */
132 
133 #endif
134