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 JK |
33 | typedef int (snd_kcontrol_tlv_rw_t)(struct snd_kcontrol *kcontrol, |
34 | int op_flag, /* 0=read,1=write,-1=command */ | |
35 | unsigned int size, | |
36 | unsigned int __user *tlv); | |
37 | ||
1da177e4 | 38 | |
82e9bae6 | 39 | struct snd_kcontrol_new { |
1da177e4 LT |
40 | snd_ctl_elem_iface_t iface; /* interface identifier */ |
41 | unsigned int device; /* device/client number */ | |
42 | unsigned int subdevice; /* subdevice (substream) number */ | |
43 | unsigned char *name; /* ASCII name of item */ | |
44 | unsigned int index; /* index of item */ | |
45 | unsigned int access; /* access rights */ | |
46 | unsigned int count; /* count of same elements */ | |
47 | snd_kcontrol_info_t *info; | |
48 | snd_kcontrol_get_t *get; | |
49 | snd_kcontrol_put_t *put; | |
8aa9b586 JK |
50 | union { |
51 | snd_kcontrol_tlv_rw_t *c; | |
0cb29ea0 | 52 | const unsigned int *p; |
8aa9b586 | 53 | } tlv; |
1da177e4 | 54 | unsigned long private_value; |
82e9bae6 | 55 | }; |
1da177e4 | 56 | |
82e9bae6 TI |
57 | struct snd_kcontrol_volatile { |
58 | struct snd_ctl_file *owner; /* locked */ | |
1da177e4 | 59 | unsigned int access; /* access rights */ |
82e9bae6 | 60 | }; |
1da177e4 | 61 | |
82e9bae6 | 62 | struct snd_kcontrol { |
1da177e4 | 63 | struct list_head list; /* list of controls */ |
82e9bae6 | 64 | struct snd_ctl_elem_id id; |
1da177e4 LT |
65 | unsigned int count; /* count of same elements */ |
66 | snd_kcontrol_info_t *info; | |
67 | snd_kcontrol_get_t *get; | |
68 | snd_kcontrol_put_t *put; | |
8aa9b586 JK |
69 | union { |
70 | snd_kcontrol_tlv_rw_t *c; | |
0cb29ea0 | 71 | const unsigned int *p; |
8aa9b586 | 72 | } tlv; |
1da177e4 LT |
73 | unsigned long private_value; |
74 | void *private_data; | |
82e9bae6 TI |
75 | void (*private_free)(struct snd_kcontrol *kcontrol); |
76 | struct snd_kcontrol_volatile vd[0]; /* volatile data */ | |
1da177e4 LT |
77 | }; |
78 | ||
82e9bae6 | 79 | #define snd_kcontrol(n) list_entry(n, struct snd_kcontrol, list) |
1da177e4 | 80 | |
82e9bae6 | 81 | struct snd_kctl_event { |
1da177e4 | 82 | struct list_head list; /* list of events */ |
82e9bae6 | 83 | struct snd_ctl_elem_id id; |
1da177e4 | 84 | unsigned int mask; |
82e9bae6 | 85 | }; |
1da177e4 | 86 | |
82e9bae6 | 87 | #define snd_kctl_event(n) list_entry(n, struct snd_kctl_event, list) |
1da177e4 | 88 | |
25d27ede CL |
89 | struct pid; |
90 | ||
82e9bae6 | 91 | struct snd_ctl_file { |
1da177e4 | 92 | struct list_head list; /* list of all control files */ |
82e9bae6 | 93 | struct snd_card *card; |
25d27ede | 94 | struct pid *pid; |
1da177e4 LT |
95 | int prefer_pcm_subdevice; |
96 | int prefer_rawmidi_subdevice; | |
97 | wait_queue_head_t change_sleep; | |
98 | spinlock_t read_lock; | |
99 | struct fasync_struct *fasync; | |
100 | int subscribed; /* read interface is activated */ | |
101 | struct list_head events; /* waiting events for read */ | |
102 | }; | |
103 | ||
82e9bae6 | 104 | #define snd_ctl_file(n) list_entry(n, struct snd_ctl_file, list) |
1da177e4 | 105 | |
82e9bae6 TI |
106 | typedef int (*snd_kctl_ioctl_func_t) (struct snd_card * card, |
107 | struct snd_ctl_file * control, | |
108 | unsigned int cmd, unsigned long arg); | |
1da177e4 | 109 | |
82e9bae6 | 110 | void snd_ctl_notify(struct snd_card * card, unsigned int mask, struct snd_ctl_elem_id * id); |
1da177e4 | 111 | |
82e9bae6 TI |
112 | struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new * kcontrolnew, void * private_data); |
113 | void snd_ctl_free_one(struct snd_kcontrol * kcontrol); | |
114 | int snd_ctl_add(struct snd_card * card, struct snd_kcontrol * kcontrol); | |
115 | int snd_ctl_remove(struct snd_card * card, struct snd_kcontrol * kcontrol); | |
116 | int snd_ctl_remove_id(struct snd_card * card, struct snd_ctl_elem_id *id); | |
117 | int snd_ctl_rename_id(struct snd_card * card, struct snd_ctl_elem_id *src_id, struct snd_ctl_elem_id *dst_id); | |
118 | struct snd_kcontrol *snd_ctl_find_numid(struct snd_card * card, unsigned int numid); | |
119 | struct snd_kcontrol *snd_ctl_find_id(struct snd_card * card, struct snd_ctl_elem_id *id); | |
1da177e4 | 120 | |
82e9bae6 | 121 | int snd_ctl_create(struct snd_card *card); |
1da177e4 LT |
122 | |
123 | int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn); | |
124 | int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn); | |
125 | #ifdef CONFIG_COMPAT | |
126 | int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn); | |
127 | int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn); | |
128 | #else | |
129 | #define snd_ctl_register_ioctl_compat(fcn) | |
130 | #define snd_ctl_unregister_ioctl_compat(fcn) | |
131 | #endif | |
132 | ||
82e9bae6 | 133 | static inline unsigned int snd_ctl_get_ioffnum(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id) |
1da177e4 LT |
134 | { |
135 | return id->numid - kctl->id.numid; | |
136 | } | |
137 | ||
82e9bae6 | 138 | static inline unsigned int snd_ctl_get_ioffidx(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id) |
1da177e4 LT |
139 | { |
140 | return id->index - kctl->id.index; | |
141 | } | |
142 | ||
82e9bae6 | 143 | static inline unsigned int snd_ctl_get_ioff(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id) |
1da177e4 LT |
144 | { |
145 | if (id->numid) { | |
146 | return snd_ctl_get_ioffnum(kctl, id); | |
147 | } else { | |
148 | return snd_ctl_get_ioffidx(kctl, id); | |
149 | } | |
150 | } | |
151 | ||
82e9bae6 TI |
152 | static inline struct snd_ctl_elem_id *snd_ctl_build_ioff(struct snd_ctl_elem_id *dst_id, |
153 | struct snd_kcontrol *src_kctl, | |
1da177e4 LT |
154 | unsigned int offset) |
155 | { | |
156 | *dst_id = src_kctl->id; | |
157 | dst_id->index += offset; | |
158 | dst_id->numid += offset; | |
159 | return dst_id; | |
160 | } | |
161 | ||
b9ed4f2b | 162 | /* |
9600732b | 163 | * Frequently used control callbacks/helpers |
b9ed4f2b TI |
164 | */ |
165 | int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol, | |
166 | struct snd_ctl_elem_info *uinfo); | |
167 | int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol, | |
168 | struct snd_ctl_elem_info *uinfo); | |
9600732b CL |
169 | int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels, |
170 | unsigned int items, const char *const names[]); | |
b9ed4f2b | 171 | |
e922b002 TI |
172 | /* |
173 | * virtual master control | |
174 | */ | |
175 | struct snd_kcontrol *snd_ctl_make_virtual_master(char *name, | |
176 | const unsigned int *tlv); | |
f5b1db63 TI |
177 | int _snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave, |
178 | unsigned int flags); | |
179 | /* optional flags for slave */ | |
180 | #define SND_CTL_SLAVE_NEED_UPDATE (1 << 0) | |
181 | ||
79c7cdd5 TI |
182 | /** |
183 | * snd_ctl_add_slave - Add a virtual slave control | |
184 | * @master: vmaster element | |
185 | * @slave: slave element to add | |
186 | * | |
187 | * Add a virtual slave control to the given master element created via | |
188 | * snd_ctl_create_virtual_master() beforehand. | |
189 | * Returns zero if successful or a negative error code. | |
190 | * | |
191 | * All slaves must be the same type (returning the same information | |
192 | * via info callback). The fucntion doesn't check it, so it's your | |
193 | * responsibility. | |
194 | * | |
195 | * Also, some additional limitations: | |
196 | * at most two channels, | |
197 | * logarithmic volume control (dB level) thus no linear volume, | |
198 | * master can only attenuate the volume without gain | |
199 | */ | |
f5b1db63 TI |
200 | static inline int |
201 | snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave) | |
202 | { | |
203 | return _snd_ctl_add_slave(master, slave, 0); | |
204 | } | |
205 | ||
79c7cdd5 TI |
206 | /** |
207 | * snd_ctl_add_slave_uncached - Add a virtual slave control | |
208 | * @master: vmaster element | |
209 | * @slave: slave element to add | |
210 | * | |
211 | * Add a virtual slave control to the given master. | |
212 | * Unlike snd_ctl_add_slave(), the element added via this function | |
213 | * is supposed to have volatile values, and get callback is called | |
214 | * at each time quried from the master. | |
215 | * | |
216 | * When the control peeks the hardware values directly and the value | |
217 | * can be changed by other means than the put callback of the element, | |
218 | * this function should be used to keep the value always up-to-date. | |
219 | */ | |
f5b1db63 TI |
220 | static inline int |
221 | snd_ctl_add_slave_uncached(struct snd_kcontrol *master, | |
222 | struct snd_kcontrol *slave) | |
223 | { | |
224 | return _snd_ctl_add_slave(master, slave, SND_CTL_SLAVE_NEED_UPDATE); | |
225 | } | |
226 | ||
1da177e4 | 227 | #endif /* __SOUND_CONTROL_H */ |