Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | #ifndef __SOUND_CONTROL_H |
| 2 | #define __SOUND_CONTROL_H |
| 3 | |
| 4 | /* |
| 5 | * Header file for control interface |
Jaroslav Kysela | c1017a4 | 2007-10-15 09:50:19 +0200 | [diff] [blame] | 6 | * Copyright (c) by Jaroslav Kysela <perex@perex.cz> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Ingo Molnar | b69339b | 2017-02-05 16:15:03 +0100 | [diff] [blame] | 25 | #include <linux/wait.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 26 | #include <sound/asound.h> |
| 27 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 28 | #define snd_kcontrol_chip(kcontrol) ((kcontrol)->private_data) |
| 29 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 30 | struct snd_kcontrol; |
| 31 | typedef int (snd_kcontrol_info_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_info * uinfo); |
| 32 | typedef int (snd_kcontrol_get_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol); |
| 33 | typedef int (snd_kcontrol_put_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol); |
Jaroslav Kysela | 8aa9b58 | 2006-07-05 17:34:51 +0200 | [diff] [blame] | 34 | typedef int (snd_kcontrol_tlv_rw_t)(struct snd_kcontrol *kcontrol, |
Takashi Iwai | 0cea76f | 2014-07-15 16:31:01 +0200 | [diff] [blame] | 35 | int op_flag, /* SNDRV_CTL_TLV_OP_XXX */ |
Jaroslav Kysela | 8aa9b58 | 2006-07-05 17:34:51 +0200 | [diff] [blame] | 36 | unsigned int size, |
| 37 | unsigned int __user *tlv); |
| 38 | |
Takashi Iwai | 0cea76f | 2014-07-15 16:31:01 +0200 | [diff] [blame] | 39 | enum { |
| 40 | SNDRV_CTL_TLV_OP_READ = 0, |
| 41 | SNDRV_CTL_TLV_OP_WRITE = 1, |
| 42 | SNDRV_CTL_TLV_OP_CMD = -1, |
| 43 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 44 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 45 | struct snd_kcontrol_new { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 46 | snd_ctl_elem_iface_t iface; /* interface identifier */ |
| 47 | unsigned int device; /* device/client number */ |
| 48 | unsigned int subdevice; /* subdevice (substream) number */ |
Mark Brown | 5ac2ba9 | 2012-02-16 17:08:13 -0800 | [diff] [blame] | 49 | const unsigned char *name; /* ASCII name of item */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | unsigned int index; /* index of item */ |
| 51 | unsigned int access; /* access rights */ |
| 52 | unsigned int count; /* count of same elements */ |
| 53 | snd_kcontrol_info_t *info; |
| 54 | snd_kcontrol_get_t *get; |
| 55 | snd_kcontrol_put_t *put; |
Jaroslav Kysela | 8aa9b58 | 2006-07-05 17:34:51 +0200 | [diff] [blame] | 56 | union { |
| 57 | snd_kcontrol_tlv_rw_t *c; |
Takashi Iwai | 0cb29ea | 2007-01-29 15:33:49 +0100 | [diff] [blame] | 58 | const unsigned int *p; |
Jaroslav Kysela | 8aa9b58 | 2006-07-05 17:34:51 +0200 | [diff] [blame] | 59 | } tlv; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 60 | unsigned long private_value; |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 61 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 62 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 63 | struct snd_kcontrol_volatile { |
| 64 | struct snd_ctl_file *owner; /* locked */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 65 | unsigned int access; /* access rights */ |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 66 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 67 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 68 | struct snd_kcontrol { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 69 | struct list_head list; /* list of controls */ |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 70 | struct snd_ctl_elem_id id; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 71 | unsigned int count; /* count of same elements */ |
| 72 | snd_kcontrol_info_t *info; |
| 73 | snd_kcontrol_get_t *get; |
| 74 | snd_kcontrol_put_t *put; |
Jaroslav Kysela | 8aa9b58 | 2006-07-05 17:34:51 +0200 | [diff] [blame] | 75 | union { |
| 76 | snd_kcontrol_tlv_rw_t *c; |
Takashi Iwai | 0cb29ea | 2007-01-29 15:33:49 +0100 | [diff] [blame] | 77 | const unsigned int *p; |
Jaroslav Kysela | 8aa9b58 | 2006-07-05 17:34:51 +0200 | [diff] [blame] | 78 | } tlv; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 79 | unsigned long private_value; |
| 80 | void *private_data; |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 81 | void (*private_free)(struct snd_kcontrol *kcontrol); |
| 82 | struct snd_kcontrol_volatile vd[0]; /* volatile data */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 83 | }; |
| 84 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 85 | #define snd_kcontrol(n) list_entry(n, struct snd_kcontrol, list) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 86 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 87 | struct snd_kctl_event { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 88 | struct list_head list; /* list of events */ |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 89 | struct snd_ctl_elem_id id; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 90 | unsigned int mask; |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 91 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 92 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 93 | #define snd_kctl_event(n) list_entry(n, struct snd_kctl_event, list) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 94 | |
Clemens Ladisch | 25d27ed | 2009-11-02 09:35:44 +0100 | [diff] [blame] | 95 | struct pid; |
| 96 | |
Takashi Iwai | 23c18d4 | 2014-02-19 14:30:29 +0100 | [diff] [blame] | 97 | enum { |
| 98 | SND_CTL_SUBDEV_PCM, |
| 99 | SND_CTL_SUBDEV_RAWMIDI, |
| 100 | SND_CTL_SUBDEV_ITEMS, |
| 101 | }; |
| 102 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 103 | struct snd_ctl_file { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 104 | struct list_head list; /* list of all control files */ |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 105 | struct snd_card *card; |
Clemens Ladisch | 25d27ed | 2009-11-02 09:35:44 +0100 | [diff] [blame] | 106 | struct pid *pid; |
Takashi Iwai | 23c18d4 | 2014-02-19 14:30:29 +0100 | [diff] [blame] | 107 | int preferred_subdevice[SND_CTL_SUBDEV_ITEMS]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 108 | wait_queue_head_t change_sleep; |
| 109 | spinlock_t read_lock; |
| 110 | struct fasync_struct *fasync; |
| 111 | int subscribed; /* read interface is activated */ |
| 112 | struct list_head events; /* waiting events for read */ |
| 113 | }; |
| 114 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 115 | #define snd_ctl_file(n) list_entry(n, struct snd_ctl_file, list) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 116 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 117 | typedef int (*snd_kctl_ioctl_func_t) (struct snd_card * card, |
| 118 | struct snd_ctl_file * control, |
| 119 | unsigned int cmd, unsigned long arg); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 120 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 121 | void snd_ctl_notify(struct snd_card * card, unsigned int mask, struct snd_ctl_elem_id * id); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 122 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 123 | struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new * kcontrolnew, void * private_data); |
| 124 | void snd_ctl_free_one(struct snd_kcontrol * kcontrol); |
| 125 | int snd_ctl_add(struct snd_card * card, struct snd_kcontrol * kcontrol); |
| 126 | int snd_ctl_remove(struct snd_card * card, struct snd_kcontrol * kcontrol); |
Dimitris Papastamos | 66b5b97 | 2011-03-16 12:16:39 +0000 | [diff] [blame] | 127 | int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol, bool add_on_replace); |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 128 | int snd_ctl_remove_id(struct snd_card * card, struct snd_ctl_elem_id *id); |
| 129 | int snd_ctl_rename_id(struct snd_card * card, struct snd_ctl_elem_id *src_id, struct snd_ctl_elem_id *dst_id); |
Takashi Iwai | 3cbdd75 | 2008-08-29 16:09:01 +0200 | [diff] [blame] | 130 | int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id, |
| 131 | int active); |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 132 | struct snd_kcontrol *snd_ctl_find_numid(struct snd_card * card, unsigned int numid); |
| 133 | struct snd_kcontrol *snd_ctl_find_id(struct snd_card * card, struct snd_ctl_elem_id *id); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 134 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 135 | int snd_ctl_create(struct snd_card *card); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 136 | |
| 137 | int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn); |
| 138 | int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn); |
| 139 | #ifdef CONFIG_COMPAT |
| 140 | int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn); |
| 141 | int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn); |
| 142 | #else |
| 143 | #define snd_ctl_register_ioctl_compat(fcn) |
| 144 | #define snd_ctl_unregister_ioctl_compat(fcn) |
| 145 | #endif |
| 146 | |
Takashi Iwai | 23c18d4 | 2014-02-19 14:30:29 +0100 | [diff] [blame] | 147 | int snd_ctl_get_preferred_subdevice(struct snd_card *card, int type); |
| 148 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 149 | static inline unsigned int snd_ctl_get_ioffnum(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 150 | { |
| 151 | return id->numid - kctl->id.numid; |
| 152 | } |
| 153 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 154 | static inline unsigned int snd_ctl_get_ioffidx(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 155 | { |
| 156 | return id->index - kctl->id.index; |
| 157 | } |
| 158 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 159 | static inline unsigned int snd_ctl_get_ioff(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 160 | { |
| 161 | if (id->numid) { |
| 162 | return snd_ctl_get_ioffnum(kctl, id); |
| 163 | } else { |
| 164 | return snd_ctl_get_ioffidx(kctl, id); |
| 165 | } |
| 166 | } |
| 167 | |
Takashi Iwai | 82e9bae | 2005-11-17 13:53:23 +0100 | [diff] [blame] | 168 | static inline struct snd_ctl_elem_id *snd_ctl_build_ioff(struct snd_ctl_elem_id *dst_id, |
| 169 | struct snd_kcontrol *src_kctl, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 170 | unsigned int offset) |
| 171 | { |
| 172 | *dst_id = src_kctl->id; |
| 173 | dst_id->index += offset; |
| 174 | dst_id->numid += offset; |
| 175 | return dst_id; |
| 176 | } |
| 177 | |
Takashi Iwai | b9ed4f2 | 2007-07-23 15:41:34 +0200 | [diff] [blame] | 178 | /* |
Clemens Ladisch | 9600732 | 2011-01-10 16:25:44 +0100 | [diff] [blame] | 179 | * Frequently used control callbacks/helpers |
Takashi Iwai | b9ed4f2 | 2007-07-23 15:41:34 +0200 | [diff] [blame] | 180 | */ |
| 181 | int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol, |
| 182 | struct snd_ctl_elem_info *uinfo); |
| 183 | int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol, |
| 184 | struct snd_ctl_elem_info *uinfo); |
Clemens Ladisch | 9600732 | 2011-01-10 16:25:44 +0100 | [diff] [blame] | 185 | int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels, |
| 186 | unsigned int items, const char *const names[]); |
Takashi Iwai | b9ed4f2 | 2007-07-23 15:41:34 +0200 | [diff] [blame] | 187 | |
Takashi Iwai | e922b00 | 2008-02-18 13:03:13 +0100 | [diff] [blame] | 188 | /* |
| 189 | * virtual master control |
| 190 | */ |
| 191 | struct snd_kcontrol *snd_ctl_make_virtual_master(char *name, |
| 192 | const unsigned int *tlv); |
Takashi Iwai | f5b1db6 | 2009-01-16 18:15:22 +0100 | [diff] [blame] | 193 | int _snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave, |
| 194 | unsigned int flags); |
| 195 | /* optional flags for slave */ |
| 196 | #define SND_CTL_SLAVE_NEED_UPDATE (1 << 0) |
| 197 | |
Takashi Iwai | 79c7cdd | 2009-02-09 14:47:19 +0100 | [diff] [blame] | 198 | /** |
| 199 | * snd_ctl_add_slave - Add a virtual slave control |
| 200 | * @master: vmaster element |
| 201 | * @slave: slave element to add |
| 202 | * |
| 203 | * Add a virtual slave control to the given master element created via |
| 204 | * snd_ctl_create_virtual_master() beforehand. |
Takashi Iwai | 79c7cdd | 2009-02-09 14:47:19 +0100 | [diff] [blame] | 205 | * |
| 206 | * All slaves must be the same type (returning the same information |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 207 | * via info callback). The function doesn't check it, so it's your |
Takashi Iwai | 79c7cdd | 2009-02-09 14:47:19 +0100 | [diff] [blame] | 208 | * responsibility. |
| 209 | * |
| 210 | * Also, some additional limitations: |
| 211 | * at most two channels, |
| 212 | * logarithmic volume control (dB level) thus no linear volume, |
| 213 | * master can only attenuate the volume without gain |
Yacine Belkadi | eb7c06e | 2013-03-11 22:05:14 +0100 | [diff] [blame] | 214 | * |
| 215 | * Return: Zero if successful or a negative error code. |
Takashi Iwai | 79c7cdd | 2009-02-09 14:47:19 +0100 | [diff] [blame] | 216 | */ |
Takashi Iwai | f5b1db6 | 2009-01-16 18:15:22 +0100 | [diff] [blame] | 217 | static inline int |
| 218 | snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave) |
| 219 | { |
| 220 | return _snd_ctl_add_slave(master, slave, 0); |
| 221 | } |
| 222 | |
Takashi Iwai | 79c7cdd | 2009-02-09 14:47:19 +0100 | [diff] [blame] | 223 | /** |
| 224 | * snd_ctl_add_slave_uncached - Add a virtual slave control |
| 225 | * @master: vmaster element |
| 226 | * @slave: slave element to add |
| 227 | * |
| 228 | * Add a virtual slave control to the given master. |
| 229 | * Unlike snd_ctl_add_slave(), the element added via this function |
| 230 | * is supposed to have volatile values, and get callback is called |
Masanari Iida | 1a6ab46 | 2015-03-04 10:56:13 +0900 | [diff] [blame] | 231 | * at each time queried from the master. |
Takashi Iwai | 79c7cdd | 2009-02-09 14:47:19 +0100 | [diff] [blame] | 232 | * |
| 233 | * When the control peeks the hardware values directly and the value |
| 234 | * can be changed by other means than the put callback of the element, |
| 235 | * this function should be used to keep the value always up-to-date. |
Yacine Belkadi | eb7c06e | 2013-03-11 22:05:14 +0100 | [diff] [blame] | 236 | * |
| 237 | * Return: Zero if successful or a negative error code. |
Takashi Iwai | 79c7cdd | 2009-02-09 14:47:19 +0100 | [diff] [blame] | 238 | */ |
Takashi Iwai | f5b1db6 | 2009-01-16 18:15:22 +0100 | [diff] [blame] | 239 | static inline int |
| 240 | snd_ctl_add_slave_uncached(struct snd_kcontrol *master, |
| 241 | struct snd_kcontrol *slave) |
| 242 | { |
| 243 | return _snd_ctl_add_slave(master, slave, SND_CTL_SLAVE_NEED_UPDATE); |
| 244 | } |
| 245 | |
Takashi Iwai | 2ad787e | 2012-03-12 12:18:37 +0100 | [diff] [blame] | 246 | int snd_ctl_add_vmaster_hook(struct snd_kcontrol *kctl, |
| 247 | void (*hook)(void *private_data, int), |
| 248 | void *private_data); |
Takashi Iwai | 1ca2f2e | 2013-06-24 15:51:54 +0200 | [diff] [blame] | 249 | void snd_ctl_sync_vmaster(struct snd_kcontrol *kctl, bool hook_only); |
| 250 | #define snd_ctl_sync_vmaster_hook(kctl) snd_ctl_sync_vmaster(kctl, true) |
Takashi Iwai | 2ad787e | 2012-03-12 12:18:37 +0100 | [diff] [blame] | 251 | |
Takashi Iwai | 35be544 | 2011-11-02 08:36:06 +0100 | [diff] [blame] | 252 | /* |
| 253 | * Helper functions for jack-detection controls |
| 254 | */ |
| 255 | struct snd_kcontrol * |
Jie Yang | 2ba2dfa | 2015-04-27 21:20:59 +0800 | [diff] [blame] | 256 | snd_kctl_jack_new(const char *name, struct snd_card *card); |
Takashi Iwai | 35be544 | 2011-11-02 08:36:06 +0100 | [diff] [blame] | 257 | void snd_kctl_jack_report(struct snd_card *card, |
| 258 | struct snd_kcontrol *kctl, bool status); |
| 259 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 260 | #endif /* __SOUND_CONTROL_H */ |