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