Thomas Gleixner | a10e763 | 2019-05-31 01:09:32 -0700 | [diff] [blame] | 1 | // SPDX-License-Identifier: GPL-2.0-only |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 2 | /* |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 3 | * Virtual master and follower controls |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 4 | * |
| 5 | * Copyright (c) 2008 by Takashi Iwai <tiwai@suse.de> |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 6 | */ |
| 7 | |
| 8 | #include <linux/slab.h> |
Paul Gortmaker | d81a6d7 | 2011-09-22 09:34:58 -0400 | [diff] [blame] | 9 | #include <linux/export.h> |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 10 | #include <sound/core.h> |
| 11 | #include <sound/control.h> |
Takashi Iwai | 1c82ed1b | 2008-02-18 13:05:50 +0100 | [diff] [blame] | 12 | #include <sound/tlv.h> |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 13 | |
| 14 | /* |
| 15 | * a subset of information returned via ctl info callback |
| 16 | */ |
| 17 | struct link_ctl_info { |
Clemens Ladisch | fea952e | 2011-02-14 11:00:47 +0100 | [diff] [blame] | 18 | snd_ctl_elem_type_t type; /* value type */ |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 19 | int count; /* item count */ |
| 20 | int min_val, max_val; /* min, max values */ |
| 21 | }; |
| 22 | |
| 23 | /* |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 24 | * link master - this contains a list of follower controls that are |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 25 | * identical types, i.e. info returns the same value type and value |
| 26 | * ranges, but may have different number of counts. |
| 27 | * |
| 28 | * The master control is so far only mono volume/switch for simplicity. |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 29 | * The same value will be applied to all followers. |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 30 | */ |
| 31 | struct link_master { |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 32 | struct list_head followers; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 33 | struct link_ctl_info info; |
| 34 | int val; /* the master value */ |
Takashi Iwai | 1c82ed1b | 2008-02-18 13:05:50 +0100 | [diff] [blame] | 35 | unsigned int tlv[4]; |
Takashi Iwai | 2ad787e | 2012-03-12 12:18:37 +0100 | [diff] [blame] | 36 | void (*hook)(void *private_data, int); |
| 37 | void *hook_private_data; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 38 | }; |
| 39 | |
| 40 | /* |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 41 | * link follower - this contains a follower control element |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 42 | * |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 43 | * It fakes the control callbacks with additional attenuation by the |
| 44 | * master control. A follower may have either one or two channels. |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 45 | */ |
| 46 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 47 | struct link_follower { |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 48 | struct list_head list; |
| 49 | struct link_master *master; |
| 50 | struct link_ctl_info info; |
| 51 | int vals[2]; /* current values */ |
Takashi Iwai | f5b1db6 | 2009-01-16 18:15:22 +0100 | [diff] [blame] | 52 | unsigned int flags; |
Takashi Iwai | 9e226b4 | 2011-11-10 12:34:24 +0100 | [diff] [blame] | 53 | struct snd_kcontrol *kctl; /* original kcontrol pointer */ |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 54 | struct snd_kcontrol follower; /* the copy of original control entry */ |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 55 | }; |
| 56 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 57 | static int follower_update(struct link_follower *follower) |
Takashi Iwai | f5b1db6 | 2009-01-16 18:15:22 +0100 | [diff] [blame] | 58 | { |
| 59 | struct snd_ctl_elem_value *uctl; |
| 60 | int err, ch; |
| 61 | |
Takashi Iwai | 7a33a02 | 2018-03-08 08:32:41 +0100 | [diff] [blame] | 62 | uctl = kzalloc(sizeof(*uctl), GFP_KERNEL); |
Takashi Iwai | f5b1db6 | 2009-01-16 18:15:22 +0100 | [diff] [blame] | 63 | if (!uctl) |
| 64 | return -ENOMEM; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 65 | uctl->id = follower->follower.id; |
| 66 | err = follower->follower.get(&follower->follower, uctl); |
Takashi Iwai | 2e2c177 | 2018-03-08 08:26:48 +0100 | [diff] [blame] | 67 | if (err < 0) |
| 68 | goto error; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 69 | for (ch = 0; ch < follower->info.count; ch++) |
| 70 | follower->vals[ch] = uctl->value.integer.value[ch]; |
Takashi Iwai | 2e2c177 | 2018-03-08 08:26:48 +0100 | [diff] [blame] | 71 | error: |
Takashi Iwai | f5b1db6 | 2009-01-16 18:15:22 +0100 | [diff] [blame] | 72 | kfree(uctl); |
Takashi Iwai | 2e2c177 | 2018-03-08 08:26:48 +0100 | [diff] [blame] | 73 | return err < 0 ? err : 0; |
Takashi Iwai | f5b1db6 | 2009-01-16 18:15:22 +0100 | [diff] [blame] | 74 | } |
| 75 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 76 | /* get the follower ctl info and save the initial values */ |
| 77 | static int follower_init(struct link_follower *follower) |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 78 | { |
| 79 | struct snd_ctl_elem_info *uinfo; |
Takashi Iwai | f5b1db6 | 2009-01-16 18:15:22 +0100 | [diff] [blame] | 80 | int err; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 81 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 82 | if (follower->info.count) { |
Takashi Iwai | f5b1db6 | 2009-01-16 18:15:22 +0100 | [diff] [blame] | 83 | /* already initialized */ |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 84 | if (follower->flags & SND_CTL_FOLLOWER_NEED_UPDATE) |
| 85 | return follower_update(follower); |
Takashi Iwai | f5b1db6 | 2009-01-16 18:15:22 +0100 | [diff] [blame] | 86 | return 0; |
| 87 | } |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 88 | |
| 89 | uinfo = kmalloc(sizeof(*uinfo), GFP_KERNEL); |
| 90 | if (!uinfo) |
| 91 | return -ENOMEM; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 92 | uinfo->id = follower->follower.id; |
| 93 | err = follower->follower.info(&follower->follower, uinfo); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 94 | if (err < 0) { |
| 95 | kfree(uinfo); |
| 96 | return err; |
| 97 | } |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 98 | follower->info.type = uinfo->type; |
| 99 | follower->info.count = uinfo->count; |
| 100 | if (follower->info.count > 2 || |
| 101 | (follower->info.type != SNDRV_CTL_ELEM_TYPE_INTEGER && |
| 102 | follower->info.type != SNDRV_CTL_ELEM_TYPE_BOOLEAN)) { |
| 103 | pr_err("ALSA: vmaster: invalid follower element\n"); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 104 | kfree(uinfo); |
| 105 | return -EINVAL; |
| 106 | } |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 107 | follower->info.min_val = uinfo->value.integer.min; |
| 108 | follower->info.max_val = uinfo->value.integer.max; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 109 | kfree(uinfo); |
| 110 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 111 | return follower_update(follower); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 112 | } |
| 113 | |
| 114 | /* initialize master volume */ |
| 115 | static int master_init(struct link_master *master) |
| 116 | { |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 117 | struct link_follower *follower; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 118 | |
| 119 | if (master->info.count) |
| 120 | return 0; /* already initialized */ |
| 121 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 122 | list_for_each_entry(follower, &master->followers, list) { |
| 123 | int err = follower_init(follower); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 124 | if (err < 0) |
| 125 | return err; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 126 | master->info = follower->info; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 127 | master->info.count = 1; /* always mono */ |
| 128 | /* set full volume as default (= no attenuation) */ |
| 129 | master->val = master->info.max_val; |
Takashi Iwai | 2ad787e | 2012-03-12 12:18:37 +0100 | [diff] [blame] | 130 | if (master->hook) |
| 131 | master->hook(master->hook_private_data, master->val); |
| 132 | return 1; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 133 | } |
| 134 | return -ENOENT; |
| 135 | } |
| 136 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 137 | static int follower_get_val(struct link_follower *follower, |
| 138 | struct snd_ctl_elem_value *ucontrol) |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 139 | { |
| 140 | int err, ch; |
| 141 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 142 | err = follower_init(follower); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 143 | if (err < 0) |
| 144 | return err; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 145 | for (ch = 0; ch < follower->info.count; ch++) |
| 146 | ucontrol->value.integer.value[ch] = follower->vals[ch]; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 147 | return 0; |
| 148 | } |
| 149 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 150 | static int follower_put_val(struct link_follower *follower, |
| 151 | struct snd_ctl_elem_value *ucontrol) |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 152 | { |
| 153 | int err, ch, vol; |
| 154 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 155 | err = master_init(follower->master); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 156 | if (err < 0) |
| 157 | return err; |
| 158 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 159 | switch (follower->info.type) { |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 160 | case SNDRV_CTL_ELEM_TYPE_BOOLEAN: |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 161 | for (ch = 0; ch < follower->info.count; ch++) |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 162 | ucontrol->value.integer.value[ch] &= |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 163 | !!follower->master->val; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 164 | break; |
| 165 | case SNDRV_CTL_ELEM_TYPE_INTEGER: |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 166 | for (ch = 0; ch < follower->info.count; ch++) { |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 167 | /* max master volume is supposed to be 0 dB */ |
| 168 | vol = ucontrol->value.integer.value[ch]; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 169 | vol += follower->master->val - follower->master->info.max_val; |
| 170 | if (vol < follower->info.min_val) |
| 171 | vol = follower->info.min_val; |
| 172 | else if (vol > follower->info.max_val) |
| 173 | vol = follower->info.max_val; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 174 | ucontrol->value.integer.value[ch] = vol; |
| 175 | } |
| 176 | break; |
| 177 | } |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 178 | return follower->follower.put(&follower->follower, ucontrol); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 179 | } |
| 180 | |
| 181 | /* |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 182 | * ctl callbacks for followers |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 183 | */ |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 184 | static int follower_info(struct snd_kcontrol *kcontrol, |
| 185 | struct snd_ctl_elem_info *uinfo) |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 186 | { |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 187 | struct link_follower *follower = snd_kcontrol_chip(kcontrol); |
| 188 | return follower->follower.info(&follower->follower, uinfo); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 189 | } |
| 190 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 191 | static int follower_get(struct snd_kcontrol *kcontrol, |
| 192 | struct snd_ctl_elem_value *ucontrol) |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 193 | { |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 194 | struct link_follower *follower = snd_kcontrol_chip(kcontrol); |
| 195 | return follower_get_val(follower, ucontrol); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 196 | } |
| 197 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 198 | static int follower_put(struct snd_kcontrol *kcontrol, |
| 199 | struct snd_ctl_elem_value *ucontrol) |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 200 | { |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 201 | struct link_follower *follower = snd_kcontrol_chip(kcontrol); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 202 | int err, ch, changed = 0; |
| 203 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 204 | err = follower_init(follower); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 205 | if (err < 0) |
| 206 | return err; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 207 | for (ch = 0; ch < follower->info.count; ch++) { |
| 208 | if (follower->vals[ch] != ucontrol->value.integer.value[ch]) { |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 209 | changed = 1; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 210 | follower->vals[ch] = ucontrol->value.integer.value[ch]; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 211 | } |
| 212 | } |
| 213 | if (!changed) |
| 214 | return 0; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 215 | err = follower_put_val(follower, ucontrol); |
Takashi Iwai | 2069d48 | 2013-03-05 15:43:39 +0100 | [diff] [blame] | 216 | if (err < 0) |
| 217 | return err; |
| 218 | return 1; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 219 | } |
| 220 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 221 | static int follower_tlv_cmd(struct snd_kcontrol *kcontrol, |
| 222 | int op_flag, unsigned int size, |
| 223 | unsigned int __user *tlv) |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 224 | { |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 225 | struct link_follower *follower = snd_kcontrol_chip(kcontrol); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 226 | /* FIXME: this assumes that the max volume is 0 dB */ |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 227 | return follower->follower.tlv.c(&follower->follower, op_flag, size, tlv); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 228 | } |
| 229 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 230 | static void follower_free(struct snd_kcontrol *kcontrol) |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 231 | { |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 232 | struct link_follower *follower = snd_kcontrol_chip(kcontrol); |
| 233 | if (follower->follower.private_free) |
| 234 | follower->follower.private_free(&follower->follower); |
| 235 | if (follower->master) |
| 236 | list_del(&follower->list); |
| 237 | kfree(follower); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 238 | } |
| 239 | |
| 240 | /* |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 241 | * Add a follower control to the group with the given master control |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 242 | * |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 243 | * All followers must be the same type (returning the same information |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 244 | * via info callback). The function doesn't check it, so it's your |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 245 | * responsibility. |
| 246 | * |
| 247 | * Also, some additional limitations: |
| 248 | * - at most two channels |
| 249 | * - logarithmic volume control (dB level), no linear volume |
| 250 | * - master can only attenuate the volume, no gain |
| 251 | */ |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 252 | int _snd_ctl_add_follower(struct snd_kcontrol *master, |
| 253 | struct snd_kcontrol *follower, |
| 254 | unsigned int flags) |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 255 | { |
| 256 | struct link_master *master_link = snd_kcontrol_chip(master); |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 257 | struct link_follower *srec; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 258 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 259 | srec = kzalloc(struct_size(srec, follower.vd, follower->count), |
Kees Cook | acafe7e | 2018-05-08 13:45:50 -0700 | [diff] [blame] | 260 | GFP_KERNEL); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 261 | if (!srec) |
| 262 | return -ENOMEM; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 263 | srec->kctl = follower; |
| 264 | srec->follower = *follower; |
| 265 | memcpy(srec->follower.vd, follower->vd, follower->count * sizeof(*follower->vd)); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 266 | srec->master = master_link; |
Takashi Iwai | f5b1db6 | 2009-01-16 18:15:22 +0100 | [diff] [blame] | 267 | srec->flags = flags; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 268 | |
| 269 | /* override callbacks */ |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 270 | follower->info = follower_info; |
| 271 | follower->get = follower_get; |
| 272 | follower->put = follower_put; |
| 273 | if (follower->vd[0].access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) |
| 274 | follower->tlv.c = follower_tlv_cmd; |
| 275 | follower->private_data = srec; |
| 276 | follower->private_free = follower_free; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 277 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 278 | list_add_tail(&srec->list, &master_link->followers); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 279 | return 0; |
| 280 | } |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 281 | EXPORT_SYMBOL(_snd_ctl_add_follower); |
Takashi Iwai | e922b00 | 2008-02-18 13:03:13 +0100 | [diff] [blame] | 282 | |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 283 | /* |
| 284 | * ctl callbacks for master controls |
| 285 | */ |
| 286 | static int master_info(struct snd_kcontrol *kcontrol, |
| 287 | struct snd_ctl_elem_info *uinfo) |
| 288 | { |
| 289 | struct link_master *master = snd_kcontrol_chip(kcontrol); |
| 290 | int ret; |
| 291 | |
| 292 | ret = master_init(master); |
| 293 | if (ret < 0) |
| 294 | return ret; |
| 295 | uinfo->type = master->info.type; |
| 296 | uinfo->count = master->info.count; |
| 297 | uinfo->value.integer.min = master->info.min_val; |
| 298 | uinfo->value.integer.max = master->info.max_val; |
| 299 | return 0; |
| 300 | } |
| 301 | |
| 302 | static int master_get(struct snd_kcontrol *kcontrol, |
| 303 | struct snd_ctl_elem_value *ucontrol) |
| 304 | { |
| 305 | struct link_master *master = snd_kcontrol_chip(kcontrol); |
| 306 | int err = master_init(master); |
| 307 | if (err < 0) |
| 308 | return err; |
| 309 | ucontrol->value.integer.value[0] = master->val; |
| 310 | return 0; |
| 311 | } |
| 312 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 313 | static int sync_followers(struct link_master *master, int old_val, int new_val) |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 314 | { |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 315 | struct link_follower *follower; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 316 | struct snd_ctl_elem_value *uval; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 317 | |
| 318 | uval = kmalloc(sizeof(*uval), GFP_KERNEL); |
| 319 | if (!uval) |
| 320 | return -ENOMEM; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 321 | list_for_each_entry(follower, &master->followers, list) { |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 322 | master->val = old_val; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 323 | uval->id = follower->follower.id; |
| 324 | follower_get_val(follower, uval); |
Takashi Iwai | 1ca2f2e | 2013-06-24 15:51:54 +0200 | [diff] [blame] | 325 | master->val = new_val; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 326 | follower_put_val(follower, uval); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 327 | } |
| 328 | kfree(uval); |
Takashi Iwai | 1ca2f2e | 2013-06-24 15:51:54 +0200 | [diff] [blame] | 329 | return 0; |
| 330 | } |
| 331 | |
| 332 | static int master_put(struct snd_kcontrol *kcontrol, |
| 333 | struct snd_ctl_elem_value *ucontrol) |
| 334 | { |
| 335 | struct link_master *master = snd_kcontrol_chip(kcontrol); |
| 336 | int err, new_val, old_val; |
| 337 | bool first_init; |
| 338 | |
| 339 | err = master_init(master); |
| 340 | if (err < 0) |
| 341 | return err; |
| 342 | first_init = err; |
| 343 | old_val = master->val; |
| 344 | new_val = ucontrol->value.integer.value[0]; |
| 345 | if (new_val == old_val) |
| 346 | return 0; |
| 347 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 348 | err = sync_followers(master, old_val, new_val); |
Takashi Iwai | 1ca2f2e | 2013-06-24 15:51:54 +0200 | [diff] [blame] | 349 | if (err < 0) |
| 350 | return err; |
Takashi Iwai | 1ba65ae | 2013-07-03 14:01:32 +0200 | [diff] [blame] | 351 | if (master->hook && !first_init) |
Takashi Iwai | 2ad787e | 2012-03-12 12:18:37 +0100 | [diff] [blame] | 352 | master->hook(master->hook_private_data, master->val); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 353 | return 1; |
| 354 | } |
| 355 | |
| 356 | static void master_free(struct snd_kcontrol *kcontrol) |
| 357 | { |
| 358 | struct link_master *master = snd_kcontrol_chip(kcontrol); |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 359 | struct link_follower *follower, *n; |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 360 | |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 361 | /* free all follower links and retore the original follower kctls */ |
| 362 | list_for_each_entry_safe(follower, n, &master->followers, list) { |
| 363 | struct snd_kcontrol *sctl = follower->kctl; |
Takashi Iwai | 9e226b4 | 2011-11-10 12:34:24 +0100 | [diff] [blame] | 364 | struct list_head olist = sctl->list; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 365 | memcpy(sctl, &follower->follower, sizeof(*sctl)); |
| 366 | memcpy(sctl->vd, follower->follower.vd, |
Takashi Iwai | 9e226b4 | 2011-11-10 12:34:24 +0100 | [diff] [blame] | 367 | sctl->count * sizeof(*sctl->vd)); |
| 368 | sctl->list = olist; /* keep the current linked-list */ |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 369 | kfree(follower); |
Takashi Iwai | 9e226b4 | 2011-11-10 12:34:24 +0100 | [diff] [blame] | 370 | } |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 371 | kfree(master); |
| 372 | } |
| 373 | |
| 374 | |
Takashi Iwai | 79c7cdd | 2009-02-09 14:47:19 +0100 | [diff] [blame] | 375 | /** |
| 376 | * snd_ctl_make_virtual_master - Create a virtual master control |
| 377 | * @name: name string of the control element to create |
| 378 | * @tlv: optional TLV int array for dB information |
| 379 | * |
Yacine Belkadi | eb7c06e | 2013-03-11 22:05:14 +0100 | [diff] [blame] | 380 | * Creates a virtual master control with the given name string. |
Takashi Iwai | 79c7cdd | 2009-02-09 14:47:19 +0100 | [diff] [blame] | 381 | * |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 382 | * After creating a vmaster element, you can add the follower controls |
| 383 | * via snd_ctl_add_follower() or snd_ctl_add_follower_uncached(). |
Takashi Iwai | 79c7cdd | 2009-02-09 14:47:19 +0100 | [diff] [blame] | 384 | * |
| 385 | * The optional argument @tlv can be used to specify the TLV information |
| 386 | * for dB scale of the master control. It should be a single element |
Takashi Iwai | 085f306 | 2009-06-16 13:57:07 +0200 | [diff] [blame] | 387 | * with #SNDRV_CTL_TLVT_DB_SCALE, #SNDRV_CTL_TLV_DB_MINMAX or |
| 388 | * #SNDRV_CTL_TLVT_DB_MINMAX_MUTE type, and should be the max 0dB. |
Yacine Belkadi | eb7c06e | 2013-03-11 22:05:14 +0100 | [diff] [blame] | 389 | * |
| 390 | * Return: The created control element, or %NULL for errors (ENOMEM). |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 391 | */ |
| 392 | struct snd_kcontrol *snd_ctl_make_virtual_master(char *name, |
| 393 | const unsigned int *tlv) |
| 394 | { |
| 395 | struct link_master *master; |
| 396 | struct snd_kcontrol *kctl; |
| 397 | struct snd_kcontrol_new knew; |
| 398 | |
| 399 | memset(&knew, 0, sizeof(knew)); |
| 400 | knew.iface = SNDRV_CTL_ELEM_IFACE_MIXER; |
| 401 | knew.name = name; |
| 402 | knew.info = master_info; |
| 403 | |
| 404 | master = kzalloc(sizeof(*master), GFP_KERNEL); |
| 405 | if (!master) |
| 406 | return NULL; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 407 | INIT_LIST_HEAD(&master->followers); |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 408 | |
| 409 | kctl = snd_ctl_new1(&knew, master); |
| 410 | if (!kctl) { |
| 411 | kfree(master); |
| 412 | return NULL; |
| 413 | } |
| 414 | /* override some callbacks */ |
| 415 | kctl->info = master_info; |
| 416 | kctl->get = master_get; |
| 417 | kctl->put = master_put; |
| 418 | kctl->private_free = master_free; |
| 419 | |
| 420 | /* additional (constant) TLV read */ |
Takashi Sakamoto | 841bdb7 | 2018-05-14 07:09:51 +0900 | [diff] [blame] | 421 | if (tlv) { |
| 422 | unsigned int type = tlv[SNDRV_CTL_TLVO_TYPE]; |
| 423 | if (type == SNDRV_CTL_TLVT_DB_SCALE || |
| 424 | type == SNDRV_CTL_TLVT_DB_MINMAX || |
| 425 | type == SNDRV_CTL_TLVT_DB_MINMAX_MUTE) { |
| 426 | kctl->vd[0].access |= SNDRV_CTL_ELEM_ACCESS_TLV_READ; |
| 427 | memcpy(master->tlv, tlv, sizeof(master->tlv)); |
| 428 | kctl->tlv.p = master->tlv; |
| 429 | } |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 430 | } |
Takashi Iwai | 1c82ed1b | 2008-02-18 13:05:50 +0100 | [diff] [blame] | 431 | |
Takashi Iwai | 3b0a5f2 | 2008-01-10 16:52:42 +0100 | [diff] [blame] | 432 | return kctl; |
| 433 | } |
Takashi Iwai | e922b00 | 2008-02-18 13:03:13 +0100 | [diff] [blame] | 434 | EXPORT_SYMBOL(snd_ctl_make_virtual_master); |
Takashi Iwai | 2ad787e | 2012-03-12 12:18:37 +0100 | [diff] [blame] | 435 | |
| 436 | /** |
| 437 | * snd_ctl_add_vmaster_hook - Add a hook to a vmaster control |
| 438 | * @kcontrol: vmaster kctl element |
| 439 | * @hook: the hook function |
Randy Dunlap | f2ec52d | 2012-04-17 17:03:42 -0700 | [diff] [blame] | 440 | * @private_data: the private_data pointer to be saved |
Takashi Iwai | 2ad787e | 2012-03-12 12:18:37 +0100 | [diff] [blame] | 441 | * |
| 442 | * Adds the given hook to the vmaster control element so that it's called |
| 443 | * at each time when the value is changed. |
Yacine Belkadi | eb7c06e | 2013-03-11 22:05:14 +0100 | [diff] [blame] | 444 | * |
| 445 | * Return: Zero. |
Takashi Iwai | 2ad787e | 2012-03-12 12:18:37 +0100 | [diff] [blame] | 446 | */ |
| 447 | int snd_ctl_add_vmaster_hook(struct snd_kcontrol *kcontrol, |
| 448 | void (*hook)(void *private_data, int), |
| 449 | void *private_data) |
| 450 | { |
| 451 | struct link_master *master = snd_kcontrol_chip(kcontrol); |
| 452 | master->hook = hook; |
| 453 | master->hook_private_data = private_data; |
| 454 | return 0; |
| 455 | } |
| 456 | EXPORT_SYMBOL_GPL(snd_ctl_add_vmaster_hook); |
| 457 | |
| 458 | /** |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 459 | * snd_ctl_sync_vmaster - Sync the vmaster followers and hook |
Takashi Iwai | 2ad787e | 2012-03-12 12:18:37 +0100 | [diff] [blame] | 460 | * @kcontrol: vmaster kctl element |
Takashi Iwai | 1ca2f2e | 2013-06-24 15:51:54 +0200 | [diff] [blame] | 461 | * @hook_only: sync only the hook |
Takashi Iwai | 2ad787e | 2012-03-12 12:18:37 +0100 | [diff] [blame] | 462 | * |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 463 | * Forcibly call the put callback of each follower and call the hook function |
Takashi Iwai | 1ca2f2e | 2013-06-24 15:51:54 +0200 | [diff] [blame] | 464 | * to synchronize with the current value of the given vmaster element. |
| 465 | * NOP when NULL is passed to @kcontrol. |
Takashi Iwai | 2ad787e | 2012-03-12 12:18:37 +0100 | [diff] [blame] | 466 | */ |
Takashi Iwai | 1ca2f2e | 2013-06-24 15:51:54 +0200 | [diff] [blame] | 467 | void snd_ctl_sync_vmaster(struct snd_kcontrol *kcontrol, bool hook_only) |
Takashi Iwai | 2ad787e | 2012-03-12 12:18:37 +0100 | [diff] [blame] | 468 | { |
| 469 | struct link_master *master; |
Takashi Iwai | 1ca2f2e | 2013-06-24 15:51:54 +0200 | [diff] [blame] | 470 | bool first_init = false; |
| 471 | |
Takashi Iwai | 2ad787e | 2012-03-12 12:18:37 +0100 | [diff] [blame] | 472 | if (!kcontrol) |
| 473 | return; |
| 474 | master = snd_kcontrol_chip(kcontrol); |
Takashi Iwai | 1ca2f2e | 2013-06-24 15:51:54 +0200 | [diff] [blame] | 475 | if (!hook_only) { |
| 476 | int err = master_init(master); |
| 477 | if (err < 0) |
| 478 | return; |
| 479 | first_init = err; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 480 | err = sync_followers(master, master->val, master->val); |
Takashi Iwai | 1ca2f2e | 2013-06-24 15:51:54 +0200 | [diff] [blame] | 481 | if (err < 0) |
| 482 | return; |
| 483 | } |
| 484 | |
| 485 | if (master->hook && !first_init) |
Takashi Iwai | 2ad787e | 2012-03-12 12:18:37 +0100 | [diff] [blame] | 486 | master->hook(master->hook_private_data, master->val); |
| 487 | } |
Takashi Iwai | 1ca2f2e | 2013-06-24 15:51:54 +0200 | [diff] [blame] | 488 | EXPORT_SYMBOL_GPL(snd_ctl_sync_vmaster); |
Takashi Iwai | a91d661 | 2017-10-16 11:39:28 +0200 | [diff] [blame] | 489 | |
| 490 | /** |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 491 | * snd_ctl_apply_vmaster_followers - Apply function to each vmaster follower |
Takashi Iwai | a91d661 | 2017-10-16 11:39:28 +0200 | [diff] [blame] | 492 | * @kctl: vmaster kctl element |
| 493 | * @func: function to apply |
| 494 | * @arg: optional function argument |
| 495 | * |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 496 | * Apply the function @func to each follower kctl of the given vmaster kctl. |
Takashi Iwai | 281dee6 | 2022-07-13 12:47:59 +0200 | [diff] [blame] | 497 | * |
| 498 | * Return: 0 if successful, or a negative error code |
Takashi Iwai | a91d661 | 2017-10-16 11:39:28 +0200 | [diff] [blame] | 499 | */ |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 500 | int snd_ctl_apply_vmaster_followers(struct snd_kcontrol *kctl, |
| 501 | int (*func)(struct snd_kcontrol *vfollower, |
| 502 | struct snd_kcontrol *follower, |
| 503 | void *arg), |
| 504 | void *arg) |
Takashi Iwai | a91d661 | 2017-10-16 11:39:28 +0200 | [diff] [blame] | 505 | { |
| 506 | struct link_master *master; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 507 | struct link_follower *follower; |
Takashi Iwai | a91d661 | 2017-10-16 11:39:28 +0200 | [diff] [blame] | 508 | int err; |
| 509 | |
| 510 | master = snd_kcontrol_chip(kctl); |
| 511 | err = master_init(master); |
| 512 | if (err < 0) |
| 513 | return err; |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 514 | list_for_each_entry(follower, &master->followers, list) { |
| 515 | err = func(follower->kctl, &follower->follower, arg); |
Takashi Iwai | a91d661 | 2017-10-16 11:39:28 +0200 | [diff] [blame] | 516 | if (err < 0) |
| 517 | return err; |
| 518 | } |
| 519 | |
| 520 | return 0; |
| 521 | } |
Takashi Iwai | 9ab0cb3 | 2020-07-17 17:45:17 +0200 | [diff] [blame] | 522 | EXPORT_SYMBOL_GPL(snd_ctl_apply_vmaster_followers); |