blob: 34bc93d80d55eec9370909aad3dde8f4d26521f3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __SOUND_CONTROL_H
2#define __SOUND_CONTROL_H
3
4/*
5 * Header file for control interface
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02006 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#define snd_kcontrol_chip(kcontrol) ((kcontrol)->private_data)
28
Takashi Iwai82e9bae2005-11-17 13:53:23 +010029struct snd_kcontrol;
30typedef int (snd_kcontrol_info_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_info * uinfo);
31typedef int (snd_kcontrol_get_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol);
32typedef int (snd_kcontrol_put_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +020033typedef 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Takashi Iwai82e9bae2005-11-17 13:53:23 +010039struct snd_kcontrol_new {
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 snd_ctl_elem_iface_t iface; /* interface identifier */
41 unsigned int device; /* device/client number */
42 unsigned int subdevice; /* subdevice (substream) number */
Mark Brown5ac2ba92012-02-16 17:08:13 -080043 const unsigned char *name; /* ASCII name of item */
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 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;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +020050 union {
51 snd_kcontrol_tlv_rw_t *c;
Takashi Iwai0cb29ea2007-01-29 15:33:49 +010052 const unsigned int *p;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +020053 } tlv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 unsigned long private_value;
Takashi Iwai82e9bae2005-11-17 13:53:23 +010055};
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Takashi Iwai82e9bae2005-11-17 13:53:23 +010057struct snd_kcontrol_volatile {
58 struct snd_ctl_file *owner; /* locked */
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 unsigned int access; /* access rights */
Takashi Iwai82e9bae2005-11-17 13:53:23 +010060};
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Takashi Iwai82e9bae2005-11-17 13:53:23 +010062struct snd_kcontrol {
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 struct list_head list; /* list of controls */
Takashi Iwai82e9bae2005-11-17 13:53:23 +010064 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 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;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +020069 union {
70 snd_kcontrol_tlv_rw_t *c;
Takashi Iwai0cb29ea2007-01-29 15:33:49 +010071 const unsigned int *p;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +020072 } tlv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 unsigned long private_value;
74 void *private_data;
Takashi Iwai82e9bae2005-11-17 13:53:23 +010075 void (*private_free)(struct snd_kcontrol *kcontrol);
76 struct snd_kcontrol_volatile vd[0]; /* volatile data */
Linus Torvalds1da177e2005-04-16 15:20:36 -070077};
78
Takashi Iwai82e9bae2005-11-17 13:53:23 +010079#define snd_kcontrol(n) list_entry(n, struct snd_kcontrol, list)
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Takashi Iwai82e9bae2005-11-17 13:53:23 +010081struct snd_kctl_event {
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 struct list_head list; /* list of events */
Takashi Iwai82e9bae2005-11-17 13:53:23 +010083 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 unsigned int mask;
Takashi Iwai82e9bae2005-11-17 13:53:23 +010085};
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Takashi Iwai82e9bae2005-11-17 13:53:23 +010087#define snd_kctl_event(n) list_entry(n, struct snd_kctl_event, list)
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Clemens Ladisch25d27ed2009-11-02 09:35:44 +010089struct pid;
90
Takashi Iwai82e9bae2005-11-17 13:53:23 +010091struct snd_ctl_file {
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 struct list_head list; /* list of all control files */
Takashi Iwai82e9bae2005-11-17 13:53:23 +010093 struct snd_card *card;
Clemens Ladisch25d27ed2009-11-02 09:35:44 +010094 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 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
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100104#define snd_ctl_file(n) list_entry(n, struct snd_ctl_file, list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100106typedef int (*snd_kctl_ioctl_func_t) (struct snd_card * card,
107 struct snd_ctl_file * control,
108 unsigned int cmd, unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100110void snd_ctl_notify(struct snd_card * card, unsigned int mask, struct snd_ctl_elem_id * id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100112struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new * kcontrolnew, void * private_data);
113void snd_ctl_free_one(struct snd_kcontrol * kcontrol);
114int snd_ctl_add(struct snd_card * card, struct snd_kcontrol * kcontrol);
115int snd_ctl_remove(struct snd_card * card, struct snd_kcontrol * kcontrol);
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000116int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol, bool add_on_replace);
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100117int snd_ctl_remove_id(struct snd_card * card, struct snd_ctl_elem_id *id);
118int snd_ctl_rename_id(struct snd_card * card, struct snd_ctl_elem_id *src_id, struct snd_ctl_elem_id *dst_id);
Takashi Iwai3cbdd752008-08-29 16:09:01 +0200119int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id,
120 int active);
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100121struct snd_kcontrol *snd_ctl_find_numid(struct snd_card * card, unsigned int numid);
122struct snd_kcontrol *snd_ctl_find_id(struct snd_card * card, struct snd_ctl_elem_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100124int snd_ctl_create(struct snd_card *card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
126int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn);
127int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn);
128#ifdef CONFIG_COMPAT
129int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn);
130int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn);
131#else
132#define snd_ctl_register_ioctl_compat(fcn)
133#define snd_ctl_unregister_ioctl_compat(fcn)
134#endif
135
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100136static inline unsigned int snd_ctl_get_ioffnum(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137{
138 return id->numid - kctl->id.numid;
139}
140
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100141static inline unsigned int snd_ctl_get_ioffidx(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142{
143 return id->index - kctl->id.index;
144}
145
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100146static inline unsigned int snd_ctl_get_ioff(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147{
148 if (id->numid) {
149 return snd_ctl_get_ioffnum(kctl, id);
150 } else {
151 return snd_ctl_get_ioffidx(kctl, id);
152 }
153}
154
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100155static inline struct snd_ctl_elem_id *snd_ctl_build_ioff(struct snd_ctl_elem_id *dst_id,
156 struct snd_kcontrol *src_kctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 unsigned int offset)
158{
159 *dst_id = src_kctl->id;
160 dst_id->index += offset;
161 dst_id->numid += offset;
162 return dst_id;
163}
164
Takashi Iwaib9ed4f22007-07-23 15:41:34 +0200165/*
Clemens Ladisch96007322011-01-10 16:25:44 +0100166 * Frequently used control callbacks/helpers
Takashi Iwaib9ed4f22007-07-23 15:41:34 +0200167 */
168int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
169 struct snd_ctl_elem_info *uinfo);
170int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
171 struct snd_ctl_elem_info *uinfo);
Clemens Ladisch96007322011-01-10 16:25:44 +0100172int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
173 unsigned int items, const char *const names[]);
Takashi Iwaib9ed4f22007-07-23 15:41:34 +0200174
Takashi Iwaie922b002008-02-18 13:03:13 +0100175/*
176 * virtual master control
177 */
178struct snd_kcontrol *snd_ctl_make_virtual_master(char *name,
179 const unsigned int *tlv);
Takashi Iwaif5b1db62009-01-16 18:15:22 +0100180int _snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave,
181 unsigned int flags);
182/* optional flags for slave */
183#define SND_CTL_SLAVE_NEED_UPDATE (1 << 0)
184
Takashi Iwai79c7cdd2009-02-09 14:47:19 +0100185/**
186 * snd_ctl_add_slave - Add a virtual slave control
187 * @master: vmaster element
188 * @slave: slave element to add
189 *
190 * Add a virtual slave control to the given master element created via
191 * snd_ctl_create_virtual_master() beforehand.
Takashi Iwai79c7cdd2009-02-09 14:47:19 +0100192 *
193 * All slaves must be the same type (returning the same information
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300194 * via info callback). The function doesn't check it, so it's your
Takashi Iwai79c7cdd2009-02-09 14:47:19 +0100195 * responsibility.
196 *
197 * Also, some additional limitations:
198 * at most two channels,
199 * logarithmic volume control (dB level) thus no linear volume,
200 * master can only attenuate the volume without gain
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100201 *
202 * Return: Zero if successful or a negative error code.
Takashi Iwai79c7cdd2009-02-09 14:47:19 +0100203 */
Takashi Iwaif5b1db62009-01-16 18:15:22 +0100204static inline int
205snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave)
206{
207 return _snd_ctl_add_slave(master, slave, 0);
208}
209
Takashi Iwai79c7cdd2009-02-09 14:47:19 +0100210/**
211 * snd_ctl_add_slave_uncached - Add a virtual slave control
212 * @master: vmaster element
213 * @slave: slave element to add
214 *
215 * Add a virtual slave control to the given master.
216 * Unlike snd_ctl_add_slave(), the element added via this function
217 * is supposed to have volatile values, and get callback is called
218 * at each time quried from the master.
219 *
220 * When the control peeks the hardware values directly and the value
221 * can be changed by other means than the put callback of the element,
222 * this function should be used to keep the value always up-to-date.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100223 *
224 * Return: Zero if successful or a negative error code.
Takashi Iwai79c7cdd2009-02-09 14:47:19 +0100225 */
Takashi Iwaif5b1db62009-01-16 18:15:22 +0100226static inline int
227snd_ctl_add_slave_uncached(struct snd_kcontrol *master,
228 struct snd_kcontrol *slave)
229{
230 return _snd_ctl_add_slave(master, slave, SND_CTL_SLAVE_NEED_UPDATE);
231}
232
Takashi Iwai2ad787e2012-03-12 12:18:37 +0100233int snd_ctl_add_vmaster_hook(struct snd_kcontrol *kctl,
234 void (*hook)(void *private_data, int),
235 void *private_data);
236void snd_ctl_sync_vmaster_hook(struct snd_kcontrol *kctl);
237
Takashi Iwai35be5442011-11-02 08:36:06 +0100238/*
239 * Helper functions for jack-detection controls
240 */
241struct snd_kcontrol *
242snd_kctl_jack_new(const char *name, int idx, void *private_data);
243void snd_kctl_jack_report(struct snd_card *card,
244 struct snd_kcontrol *kctl, bool status);
245
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246#endif /* __SOUND_CONTROL_H */