blob: 95aad6d3fd1a9b0765551d90719632baeea388b0 [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,
Takashi Iwai0cea76f2014-07-15 16:31:01 +020034 int op_flag, /* SNDRV_CTL_TLV_OP_XXX */
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +020035 unsigned int size,
36 unsigned int __user *tlv);
37
Takashi Iwai0cea76f2014-07-15 16:31:01 +020038enum {
39 SNDRV_CTL_TLV_OP_READ = 0,
40 SNDRV_CTL_TLV_OP_WRITE = 1,
41 SNDRV_CTL_TLV_OP_CMD = -1,
42};
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Takashi Iwai82e9bae2005-11-17 13:53:23 +010044struct snd_kcontrol_new {
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 snd_ctl_elem_iface_t iface; /* interface identifier */
46 unsigned int device; /* device/client number */
47 unsigned int subdevice; /* subdevice (substream) number */
Mark Brown5ac2ba92012-02-16 17:08:13 -080048 const unsigned char *name; /* ASCII name of item */
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 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;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +020055 union {
56 snd_kcontrol_tlv_rw_t *c;
Takashi Iwai0cb29ea2007-01-29 15:33:49 +010057 const unsigned int *p;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +020058 } tlv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 unsigned long private_value;
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_volatile {
63 struct snd_ctl_file *owner; /* locked */
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 unsigned int access; /* access rights */
Takashi Iwai82e9bae2005-11-17 13:53:23 +010065};
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Takashi Iwai82e9bae2005-11-17 13:53:23 +010067struct snd_kcontrol {
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 struct list_head list; /* list of controls */
Takashi Iwai82e9bae2005-11-17 13:53:23 +010069 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 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;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +020074 union {
75 snd_kcontrol_tlv_rw_t *c;
Takashi Iwai0cb29ea2007-01-29 15:33:49 +010076 const unsigned int *p;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +020077 } tlv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 unsigned long private_value;
79 void *private_data;
Takashi Iwai82e9bae2005-11-17 13:53:23 +010080 void (*private_free)(struct snd_kcontrol *kcontrol);
81 struct snd_kcontrol_volatile vd[0]; /* volatile data */
Linus Torvalds1da177e2005-04-16 15:20:36 -070082};
83
Takashi Iwai82e9bae2005-11-17 13:53:23 +010084#define snd_kcontrol(n) list_entry(n, struct snd_kcontrol, list)
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Takashi Iwai82e9bae2005-11-17 13:53:23 +010086struct snd_kctl_event {
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 struct list_head list; /* list of events */
Takashi Iwai82e9bae2005-11-17 13:53:23 +010088 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 unsigned int mask;
Takashi Iwai82e9bae2005-11-17 13:53:23 +010090};
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
Takashi Iwai82e9bae2005-11-17 13:53:23 +010092#define snd_kctl_event(n) list_entry(n, struct snd_kctl_event, list)
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Clemens Ladisch25d27ed2009-11-02 09:35:44 +010094struct pid;
95
Takashi Iwai23c18d42014-02-19 14:30:29 +010096enum {
97 SND_CTL_SUBDEV_PCM,
98 SND_CTL_SUBDEV_RAWMIDI,
99 SND_CTL_SUBDEV_ITEMS,
100};
101
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100102struct snd_ctl_file {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 struct list_head list; /* list of all control files */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100104 struct snd_card *card;
Clemens Ladisch25d27ed2009-11-02 09:35:44 +0100105 struct pid *pid;
Takashi Iwai23c18d42014-02-19 14:30:29 +0100106 int preferred_subdevice[SND_CTL_SUBDEV_ITEMS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 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
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100114#define snd_ctl_file(n) list_entry(n, struct snd_ctl_file, list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100116typedef int (*snd_kctl_ioctl_func_t) (struct snd_card * card,
117 struct snd_ctl_file * control,
118 unsigned int cmd, unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100120void snd_ctl_notify(struct snd_card * card, unsigned int mask, struct snd_ctl_elem_id * id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100122struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new * kcontrolnew, void * private_data);
123void snd_ctl_free_one(struct snd_kcontrol * kcontrol);
124int snd_ctl_add(struct snd_card * card, struct snd_kcontrol * kcontrol);
125int snd_ctl_remove(struct snd_card * card, struct snd_kcontrol * kcontrol);
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000126int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol, bool add_on_replace);
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100127int snd_ctl_remove_id(struct snd_card * card, struct snd_ctl_elem_id *id);
128int 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 +0200129int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id,
130 int active);
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100131struct snd_kcontrol *snd_ctl_find_numid(struct snd_card * card, unsigned int numid);
132struct snd_kcontrol *snd_ctl_find_id(struct snd_card * card, struct snd_ctl_elem_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100134int snd_ctl_create(struct snd_card *card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn);
137int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn);
138#ifdef CONFIG_COMPAT
139int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn);
140int 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
Takashi Iwai23c18d42014-02-19 14:30:29 +0100146int snd_ctl_get_preferred_subdevice(struct snd_card *card, int type);
147
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100148static inline unsigned int snd_ctl_get_ioffnum(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149{
150 return id->numid - kctl->id.numid;
151}
152
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100153static inline unsigned int snd_ctl_get_ioffidx(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154{
155 return id->index - kctl->id.index;
156}
157
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100158static inline unsigned int snd_ctl_get_ioff(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159{
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
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100167static inline struct snd_ctl_elem_id *snd_ctl_build_ioff(struct snd_ctl_elem_id *dst_id,
168 struct snd_kcontrol *src_kctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 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
Takashi Iwaib9ed4f22007-07-23 15:41:34 +0200177/*
Clemens Ladisch96007322011-01-10 16:25:44 +0100178 * Frequently used control callbacks/helpers
Takashi Iwaib9ed4f22007-07-23 15:41:34 +0200179 */
180int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
181 struct snd_ctl_elem_info *uinfo);
182int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
183 struct snd_ctl_elem_info *uinfo);
Clemens Ladisch96007322011-01-10 16:25:44 +0100184int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
185 unsigned int items, const char *const names[]);
Takashi Iwaib9ed4f22007-07-23 15:41:34 +0200186
Takashi Iwaie922b002008-02-18 13:03:13 +0100187/*
188 * virtual master control
189 */
190struct snd_kcontrol *snd_ctl_make_virtual_master(char *name,
191 const unsigned int *tlv);
Takashi Iwaif5b1db62009-01-16 18:15:22 +0100192int _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
Takashi Iwai79c7cdd2009-02-09 14:47:19 +0100197/**
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.
Takashi Iwai79c7cdd2009-02-09 14:47:19 +0100204 *
205 * All slaves must be the same type (returning the same information
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300206 * via info callback). The function doesn't check it, so it's your
Takashi Iwai79c7cdd2009-02-09 14:47:19 +0100207 * 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
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100213 *
214 * Return: Zero if successful or a negative error code.
Takashi Iwai79c7cdd2009-02-09 14:47:19 +0100215 */
Takashi Iwaif5b1db62009-01-16 18:15:22 +0100216static inline int
217snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave)
218{
219 return _snd_ctl_add_slave(master, slave, 0);
220}
221
Takashi Iwai79c7cdd2009-02-09 14:47:19 +0100222/**
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
Masanari Iida1a6ab462015-03-04 10:56:13 +0900230 * at each time queried from the master.
Takashi Iwai79c7cdd2009-02-09 14:47:19 +0100231 *
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.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100235 *
236 * Return: Zero if successful or a negative error code.
Takashi Iwai79c7cdd2009-02-09 14:47:19 +0100237 */
Takashi Iwaif5b1db62009-01-16 18:15:22 +0100238static inline int
239snd_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
Takashi Iwai2ad787e2012-03-12 12:18:37 +0100245int snd_ctl_add_vmaster_hook(struct snd_kcontrol *kctl,
246 void (*hook)(void *private_data, int),
247 void *private_data);
Takashi Iwai1ca2f2e2013-06-24 15:51:54 +0200248void 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)
Takashi Iwai2ad787e2012-03-12 12:18:37 +0100250
Takashi Iwai35be5442011-11-02 08:36:06 +0100251/*
252 * Helper functions for jack-detection controls
253 */
254struct snd_kcontrol *
255snd_kctl_jack_new(const char *name, int idx, void *private_data);
256void snd_kctl_jack_report(struct snd_card *card,
257 struct snd_kcontrol *kctl, bool status);
258
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259#endif /* __SOUND_CONTROL_H */