Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #ifndef __SOUND_CONTROL_H |
2 | #define __SOUND_CONTROL_H | |
3 | ||
4 | /* | |
5 | * Header file for control interface | |
c1017a4c | 6 | * Copyright (c) by Jaroslav Kysela <perex@perex.cz> |
1da177e4 LT |
7 | * |
8 | * | |
9 | * This program is free software; you can redistribute it and/or modify | |
10 | * it under the terms of the GNU General Public License as published by | |
11 | * the Free Software Foundation; either version 2 of the License, or | |
12 | * (at your option) any later version. | |
13 | * | |
14 | * This program is distributed in the hope that it will be useful, | |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | * GNU General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU General Public License | |
20 | * along with this program; if not, write to the Free Software | |
21 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
22 | * | |
23 | */ | |
24 | ||
25 | #include <sound/asound.h> | |
26 | ||
1da177e4 LT |
27 | #define snd_kcontrol_chip(kcontrol) ((kcontrol)->private_data) |
28 | ||
82e9bae6 TI |
29 | struct snd_kcontrol; |
30 | typedef int (snd_kcontrol_info_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_info * uinfo); | |
31 | typedef int (snd_kcontrol_get_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol); | |
32 | typedef int (snd_kcontrol_put_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol); | |
8aa9b586 | 33 | typedef int (snd_kcontrol_tlv_rw_t)(struct snd_kcontrol *kcontrol, |
0cea76f3 | 34 | int op_flag, /* SNDRV_CTL_TLV_OP_XXX */ |
8aa9b586 JK |
35 | unsigned int size, |
36 | unsigned int __user *tlv); | |
37 | ||
0cea76f3 TI |
38 | enum { |
39 | SNDRV_CTL_TLV_OP_READ = 0, | |
40 | SNDRV_CTL_TLV_OP_WRITE = 1, | |
41 | SNDRV_CTL_TLV_OP_CMD = -1, | |
42 | }; | |
1da177e4 | 43 | |
82e9bae6 | 44 | struct snd_kcontrol_new { |
1da177e4 LT |
45 | snd_ctl_elem_iface_t iface; /* interface identifier */ |
46 | unsigned int device; /* device/client number */ | |
47 | unsigned int subdevice; /* subdevice (substream) number */ | |
5ac2ba94 | 48 | const unsigned char *name; /* ASCII name of item */ |
1da177e4 LT |
49 | unsigned int index; /* index of item */ |
50 | unsigned int access; /* access rights */ | |
51 | unsigned int count; /* count of same elements */ | |
52 | snd_kcontrol_info_t *info; | |
53 | snd_kcontrol_get_t *get; | |
54 | snd_kcontrol_put_t *put; | |
8aa9b586 JK |
55 | union { |
56 | snd_kcontrol_tlv_rw_t *c; | |
0cb29ea0 | 57 | const unsigned int *p; |
8aa9b586 | 58 | } tlv; |
1da177e4 | 59 | unsigned long private_value; |
82e9bae6 | 60 | }; |
1da177e4 | 61 | |
82e9bae6 TI |
62 | struct snd_kcontrol_volatile { |
63 | struct snd_ctl_file *owner; /* locked */ | |
1da177e4 | 64 | unsigned int access; /* access rights */ |
82e9bae6 | 65 | }; |
1da177e4 | 66 | |
82e9bae6 | 67 | struct snd_kcontrol { |
1da177e4 | 68 | struct list_head list; /* list of controls */ |
82e9bae6 | 69 | struct snd_ctl_elem_id id; |
1da177e4 LT |
70 | unsigned int count; /* count of same elements */ |
71 | snd_kcontrol_info_t *info; | |
72 | snd_kcontrol_get_t *get; | |
73 | snd_kcontrol_put_t *put; | |
8aa9b586 JK |
74 | union { |
75 | snd_kcontrol_tlv_rw_t *c; | |
0cb29ea0 | 76 | const unsigned int *p; |
8aa9b586 | 77 | } tlv; |
1da177e4 LT |
78 | unsigned long private_value; |
79 | void *private_data; | |
82e9bae6 TI |
80 | void (*private_free)(struct snd_kcontrol *kcontrol); |
81 | struct snd_kcontrol_volatile vd[0]; /* volatile data */ | |
1da177e4 LT |
82 | }; |
83 | ||
82e9bae6 | 84 | #define snd_kcontrol(n) list_entry(n, struct snd_kcontrol, list) |
1da177e4 | 85 | |
82e9bae6 | 86 | struct snd_kctl_event { |
1da177e4 | 87 | struct list_head list; /* list of events */ |
82e9bae6 | 88 | struct snd_ctl_elem_id id; |
1da177e4 | 89 | unsigned int mask; |
82e9bae6 | 90 | }; |
1da177e4 | 91 | |
82e9bae6 | 92 | #define snd_kctl_event(n) list_entry(n, struct snd_kctl_event, list) |
1da177e4 | 93 | |
25d27ede CL |
94 | struct pid; |
95 | ||
23c18d4b TI |
96 | enum { |
97 | SND_CTL_SUBDEV_PCM, | |
98 | SND_CTL_SUBDEV_RAWMIDI, | |
99 | SND_CTL_SUBDEV_ITEMS, | |
100 | }; | |
101 | ||
82e9bae6 | 102 | struct snd_ctl_file { |
1da177e4 | 103 | struct list_head list; /* list of all control files */ |
82e9bae6 | 104 | struct snd_card *card; |
25d27ede | 105 | struct pid *pid; |
23c18d4b | 106 | int preferred_subdevice[SND_CTL_SUBDEV_ITEMS]; |
1da177e4 LT |
107 | wait_queue_head_t change_sleep; |
108 | spinlock_t read_lock; | |
109 | struct fasync_struct *fasync; | |
110 | int subscribed; /* read interface is activated */ | |
111 | struct list_head events; /* waiting events for read */ | |
112 | }; | |
113 | ||
82e9bae6 | 114 | #define snd_ctl_file(n) list_entry(n, struct snd_ctl_file, list) |
1da177e4 | 115 | |
82e9bae6 TI |
116 | typedef int (*snd_kctl_ioctl_func_t) (struct snd_card * card, |
117 | struct snd_ctl_file * control, | |
118 | unsigned int cmd, unsigned long arg); | |
1da177e4 | 119 | |
82e9bae6 | 120 | void snd_ctl_notify(struct snd_card * card, unsigned int mask, struct snd_ctl_elem_id * id); |
1da177e4 | 121 | |
82e9bae6 TI |
122 | struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new * kcontrolnew, void * private_data); |
123 | void snd_ctl_free_one(struct snd_kcontrol * kcontrol); | |
124 | int snd_ctl_add(struct snd_card * card, struct snd_kcontrol * kcontrol); | |
125 | int snd_ctl_remove(struct snd_card * card, struct snd_kcontrol * kcontrol); | |
66b5b972 | 126 | int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol, bool add_on_replace); |
82e9bae6 TI |
127 | int snd_ctl_remove_id(struct snd_card * card, struct snd_ctl_elem_id *id); |
128 | int snd_ctl_rename_id(struct snd_card * card, struct snd_ctl_elem_id *src_id, struct snd_ctl_elem_id *dst_id); | |
3cbdd753 TI |
129 | int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id, |
130 | int active); | |
82e9bae6 TI |
131 | struct snd_kcontrol *snd_ctl_find_numid(struct snd_card * card, unsigned int numid); |
132 | struct snd_kcontrol *snd_ctl_find_id(struct snd_card * card, struct snd_ctl_elem_id *id); | |
1da177e4 | 133 | |
82e9bae6 | 134 | int snd_ctl_create(struct snd_card *card); |
1da177e4 LT |
135 | |
136 | int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn); | |
137 | int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn); | |
138 | #ifdef CONFIG_COMPAT | |
139 | int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn); | |
140 | int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn); | |
141 | #else | |
142 | #define snd_ctl_register_ioctl_compat(fcn) | |
143 | #define snd_ctl_unregister_ioctl_compat(fcn) | |
144 | #endif | |
145 | ||
23c18d4b TI |
146 | int snd_ctl_get_preferred_subdevice(struct snd_card *card, int type); |
147 | ||
82e9bae6 | 148 | static inline unsigned int snd_ctl_get_ioffnum(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id) |
1da177e4 LT |
149 | { |
150 | return id->numid - kctl->id.numid; | |
151 | } | |
152 | ||
82e9bae6 | 153 | static inline unsigned int snd_ctl_get_ioffidx(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id) |
1da177e4 LT |
154 | { |
155 | return id->index - kctl->id.index; | |
156 | } | |
157 | ||
82e9bae6 | 158 | static inline unsigned int snd_ctl_get_ioff(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id) |
1da177e4 LT |
159 | { |
160 | if (id->numid) { | |
161 | return snd_ctl_get_ioffnum(kctl, id); | |
162 | } else { | |
163 | return snd_ctl_get_ioffidx(kctl, id); | |
164 | } | |
165 | } | |
166 | ||
82e9bae6 TI |
167 | static inline struct snd_ctl_elem_id *snd_ctl_build_ioff(struct snd_ctl_elem_id *dst_id, |
168 | struct snd_kcontrol *src_kctl, | |
1da177e4 LT |
169 | unsigned int offset) |
170 | { | |
171 | *dst_id = src_kctl->id; | |
172 | dst_id->index += offset; | |
173 | dst_id->numid += offset; | |
174 | return dst_id; | |
175 | } | |
176 | ||
b9ed4f2b | 177 | /* |
9600732b | 178 | * Frequently used control callbacks/helpers |
b9ed4f2b TI |
179 | */ |
180 | int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol, | |
181 | struct snd_ctl_elem_info *uinfo); | |
182 | int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol, | |
183 | struct snd_ctl_elem_info *uinfo); | |
9600732b CL |
184 | int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels, |
185 | unsigned int items, const char *const names[]); | |
b9ed4f2b | 186 | |
e922b002 TI |
187 | /* |
188 | * virtual master control | |
189 | */ | |
190 | struct snd_kcontrol *snd_ctl_make_virtual_master(char *name, | |
191 | const unsigned int *tlv); | |
f5b1db63 TI |
192 | int _snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave, |
193 | unsigned int flags); | |
194 | /* optional flags for slave */ | |
195 | #define SND_CTL_SLAVE_NEED_UPDATE (1 << 0) | |
196 | ||
79c7cdd5 TI |
197 | /** |
198 | * snd_ctl_add_slave - Add a virtual slave control | |
199 | * @master: vmaster element | |
200 | * @slave: slave element to add | |
201 | * | |
202 | * Add a virtual slave control to the given master element created via | |
203 | * snd_ctl_create_virtual_master() beforehand. | |
79c7cdd5 TI |
204 | * |
205 | * All slaves must be the same type (returning the same information | |
25985edc | 206 | * via info callback). The function doesn't check it, so it's your |
79c7cdd5 TI |
207 | * responsibility. |
208 | * | |
209 | * Also, some additional limitations: | |
210 | * at most two channels, | |
211 | * logarithmic volume control (dB level) thus no linear volume, | |
212 | * master can only attenuate the volume without gain | |
eb7c06e8 YB |
213 | * |
214 | * Return: Zero if successful or a negative error code. | |
79c7cdd5 | 215 | */ |
f5b1db63 TI |
216 | static inline int |
217 | snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave) | |
218 | { | |
219 | return _snd_ctl_add_slave(master, slave, 0); | |
220 | } | |
221 | ||
79c7cdd5 TI |
222 | /** |
223 | * snd_ctl_add_slave_uncached - Add a virtual slave control | |
224 | * @master: vmaster element | |
225 | * @slave: slave element to add | |
226 | * | |
227 | * Add a virtual slave control to the given master. | |
228 | * Unlike snd_ctl_add_slave(), the element added via this function | |
229 | * is supposed to have volatile values, and get callback is called | |
230 | * at each time quried from the master. | |
231 | * | |
232 | * When the control peeks the hardware values directly and the value | |
233 | * can be changed by other means than the put callback of the element, | |
234 | * this function should be used to keep the value always up-to-date. | |
eb7c06e8 YB |
235 | * |
236 | * Return: Zero if successful or a negative error code. | |
79c7cdd5 | 237 | */ |
f5b1db63 TI |
238 | static inline int |
239 | snd_ctl_add_slave_uncached(struct snd_kcontrol *master, | |
240 | struct snd_kcontrol *slave) | |
241 | { | |
242 | return _snd_ctl_add_slave(master, slave, SND_CTL_SLAVE_NEED_UPDATE); | |
243 | } | |
244 | ||
2ad787e9 TI |
245 | int snd_ctl_add_vmaster_hook(struct snd_kcontrol *kctl, |
246 | void (*hook)(void *private_data, int), | |
247 | void *private_data); | |
1ca2f2ec TI |
248 | void snd_ctl_sync_vmaster(struct snd_kcontrol *kctl, bool hook_only); |
249 | #define snd_ctl_sync_vmaster_hook(kctl) snd_ctl_sync_vmaster(kctl, true) | |
2ad787e9 | 250 | |
35be544a TI |
251 | /* |
252 | * Helper functions for jack-detection controls | |
253 | */ | |
254 | struct snd_kcontrol * | |
255 | snd_kctl_jack_new(const char *name, int idx, void *private_data); | |
256 | void snd_kctl_jack_report(struct snd_card *card, | |
257 | struct snd_kcontrol *kctl, bool status); | |
258 | ||
1da177e4 | 259 | #endif /* __SOUND_CONTROL_H */ |