2005-04-16 16:20:36 -06:00
|
|
|
#ifndef __SOUND_CONTROL_H
|
|
|
|
#define __SOUND_CONTROL_H
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Header file for control interface
|
2007-10-15 01:50:19 -06:00
|
|
|
* Copyright (c) by Jaroslav Kysela <perex@perex.cz>
|
2005-04-16 16:20:36 -06:00
|
|
|
*
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2017-02-05 08:15:03 -07:00
|
|
|
#include <linux/wait.h>
|
2005-04-16 16:20:36 -06:00
|
|
|
#include <sound/asound.h>
|
|
|
|
|
|
|
|
#define snd_kcontrol_chip(kcontrol) ((kcontrol)->private_data)
|
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
struct snd_kcontrol;
|
|
|
|
typedef int (snd_kcontrol_info_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_info * uinfo);
|
|
|
|
typedef int (snd_kcontrol_get_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol);
|
|
|
|
typedef int (snd_kcontrol_put_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol);
|
2006-07-05 09:34:51 -06:00
|
|
|
typedef int (snd_kcontrol_tlv_rw_t)(struct snd_kcontrol *kcontrol,
|
2014-07-15 08:31:01 -06:00
|
|
|
int op_flag, /* SNDRV_CTL_TLV_OP_XXX */
|
2006-07-05 09:34:51 -06:00
|
|
|
unsigned int size,
|
|
|
|
unsigned int __user *tlv);
|
|
|
|
|
2014-07-15 08:31:01 -06:00
|
|
|
enum {
|
|
|
|
SNDRV_CTL_TLV_OP_READ = 0,
|
|
|
|
SNDRV_CTL_TLV_OP_WRITE = 1,
|
|
|
|
SNDRV_CTL_TLV_OP_CMD = -1,
|
|
|
|
};
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
struct snd_kcontrol_new {
|
2005-04-16 16:20:36 -06:00
|
|
|
snd_ctl_elem_iface_t iface; /* interface identifier */
|
|
|
|
unsigned int device; /* device/client number */
|
|
|
|
unsigned int subdevice; /* subdevice (substream) number */
|
2012-02-16 18:08:13 -07:00
|
|
|
const unsigned char *name; /* ASCII name of item */
|
2005-04-16 16:20:36 -06:00
|
|
|
unsigned int index; /* index of item */
|
|
|
|
unsigned int access; /* access rights */
|
|
|
|
unsigned int count; /* count of same elements */
|
|
|
|
snd_kcontrol_info_t *info;
|
|
|
|
snd_kcontrol_get_t *get;
|
|
|
|
snd_kcontrol_put_t *put;
|
2006-07-05 09:34:51 -06:00
|
|
|
union {
|
|
|
|
snd_kcontrol_tlv_rw_t *c;
|
2007-01-29 07:33:49 -07:00
|
|
|
const unsigned int *p;
|
2006-07-05 09:34:51 -06:00
|
|
|
} tlv;
|
2005-04-16 16:20:36 -06:00
|
|
|
unsigned long private_value;
|
2005-11-17 05:53:23 -07:00
|
|
|
};
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
struct snd_kcontrol_volatile {
|
|
|
|
struct snd_ctl_file *owner; /* locked */
|
2005-04-16 16:20:36 -06:00
|
|
|
unsigned int access; /* access rights */
|
2005-11-17 05:53:23 -07:00
|
|
|
};
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
struct snd_kcontrol {
|
2005-04-16 16:20:36 -06:00
|
|
|
struct list_head list; /* list of controls */
|
2005-11-17 05:53:23 -07:00
|
|
|
struct snd_ctl_elem_id id;
|
2005-04-16 16:20:36 -06:00
|
|
|
unsigned int count; /* count of same elements */
|
|
|
|
snd_kcontrol_info_t *info;
|
|
|
|
snd_kcontrol_get_t *get;
|
|
|
|
snd_kcontrol_put_t *put;
|
2006-07-05 09:34:51 -06:00
|
|
|
union {
|
|
|
|
snd_kcontrol_tlv_rw_t *c;
|
2007-01-29 07:33:49 -07:00
|
|
|
const unsigned int *p;
|
2006-07-05 09:34:51 -06:00
|
|
|
} tlv;
|
2005-04-16 16:20:36 -06:00
|
|
|
unsigned long private_value;
|
|
|
|
void *private_data;
|
2005-11-17 05:53:23 -07:00
|
|
|
void (*private_free)(struct snd_kcontrol *kcontrol);
|
|
|
|
struct snd_kcontrol_volatile vd[0]; /* volatile data */
|
2005-04-16 16:20:36 -06:00
|
|
|
};
|
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
#define snd_kcontrol(n) list_entry(n, struct snd_kcontrol, list)
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
struct snd_kctl_event {
|
2005-04-16 16:20:36 -06:00
|
|
|
struct list_head list; /* list of events */
|
2005-11-17 05:53:23 -07:00
|
|
|
struct snd_ctl_elem_id id;
|
2005-04-16 16:20:36 -06:00
|
|
|
unsigned int mask;
|
2005-11-17 05:53:23 -07:00
|
|
|
};
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
#define snd_kctl_event(n) list_entry(n, struct snd_kctl_event, list)
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2009-11-02 01:35:44 -07:00
|
|
|
struct pid;
|
|
|
|
|
2014-02-19 06:30:29 -07:00
|
|
|
enum {
|
|
|
|
SND_CTL_SUBDEV_PCM,
|
|
|
|
SND_CTL_SUBDEV_RAWMIDI,
|
|
|
|
SND_CTL_SUBDEV_ITEMS,
|
|
|
|
};
|
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
struct snd_ctl_file {
|
2005-04-16 16:20:36 -06:00
|
|
|
struct list_head list; /* list of all control files */
|
2005-11-17 05:53:23 -07:00
|
|
|
struct snd_card *card;
|
2009-11-02 01:35:44 -07:00
|
|
|
struct pid *pid;
|
2014-02-19 06:30:29 -07:00
|
|
|
int preferred_subdevice[SND_CTL_SUBDEV_ITEMS];
|
2005-04-16 16:20:36 -06:00
|
|
|
wait_queue_head_t change_sleep;
|
|
|
|
spinlock_t read_lock;
|
|
|
|
struct fasync_struct *fasync;
|
|
|
|
int subscribed; /* read interface is activated */
|
|
|
|
struct list_head events; /* waiting events for read */
|
|
|
|
};
|
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
#define snd_ctl_file(n) list_entry(n, struct snd_ctl_file, list)
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
typedef int (*snd_kctl_ioctl_func_t) (struct snd_card * card,
|
|
|
|
struct snd_ctl_file * control,
|
|
|
|
unsigned int cmd, unsigned long arg);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
void snd_ctl_notify(struct snd_card * card, unsigned int mask, struct snd_ctl_elem_id * id);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new * kcontrolnew, void * private_data);
|
|
|
|
void snd_ctl_free_one(struct snd_kcontrol * kcontrol);
|
|
|
|
int snd_ctl_add(struct snd_card * card, struct snd_kcontrol * kcontrol);
|
|
|
|
int snd_ctl_remove(struct snd_card * card, struct snd_kcontrol * kcontrol);
|
2011-03-16 06:16:39 -06:00
|
|
|
int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol, bool add_on_replace);
|
2005-11-17 05:53:23 -07:00
|
|
|
int snd_ctl_remove_id(struct snd_card * card, struct snd_ctl_elem_id *id);
|
|
|
|
int snd_ctl_rename_id(struct snd_card * card, struct snd_ctl_elem_id *src_id, struct snd_ctl_elem_id *dst_id);
|
2008-08-29 08:09:01 -06:00
|
|
|
int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id,
|
|
|
|
int active);
|
2005-11-17 05:53:23 -07:00
|
|
|
struct snd_kcontrol *snd_ctl_find_numid(struct snd_card * card, unsigned int numid);
|
|
|
|
struct snd_kcontrol *snd_ctl_find_id(struct snd_card * card, struct snd_ctl_elem_id *id);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
int snd_ctl_create(struct snd_card *card);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
|
|
|
int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn);
|
|
|
|
int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn);
|
|
|
|
#ifdef CONFIG_COMPAT
|
|
|
|
int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn);
|
|
|
|
int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn);
|
|
|
|
#else
|
|
|
|
#define snd_ctl_register_ioctl_compat(fcn)
|
|
|
|
#define snd_ctl_unregister_ioctl_compat(fcn)
|
|
|
|
#endif
|
|
|
|
|
2014-02-19 06:30:29 -07:00
|
|
|
int snd_ctl_get_preferred_subdevice(struct snd_card *card, int type);
|
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
static inline unsigned int snd_ctl_get_ioffnum(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
|
|
|
return id->numid - kctl->id.numid;
|
|
|
|
}
|
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
static inline unsigned int snd_ctl_get_ioffidx(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
|
|
|
return id->index - kctl->id.index;
|
|
|
|
}
|
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
static inline unsigned int snd_ctl_get_ioff(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
|
|
|
if (id->numid) {
|
|
|
|
return snd_ctl_get_ioffnum(kctl, id);
|
|
|
|
} else {
|
|
|
|
return snd_ctl_get_ioffidx(kctl, id);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2005-11-17 05:53:23 -07:00
|
|
|
static inline struct snd_ctl_elem_id *snd_ctl_build_ioff(struct snd_ctl_elem_id *dst_id,
|
|
|
|
struct snd_kcontrol *src_kctl,
|
2005-04-16 16:20:36 -06:00
|
|
|
unsigned int offset)
|
|
|
|
{
|
|
|
|
*dst_id = src_kctl->id;
|
|
|
|
dst_id->index += offset;
|
|
|
|
dst_id->numid += offset;
|
|
|
|
return dst_id;
|
|
|
|
}
|
|
|
|
|
2007-07-23 07:41:34 -06:00
|
|
|
/*
|
2011-01-10 08:25:44 -07:00
|
|
|
* Frequently used control callbacks/helpers
|
2007-07-23 07:41:34 -06:00
|
|
|
*/
|
|
|
|
int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
|
|
|
|
struct snd_ctl_elem_info *uinfo);
|
|
|
|
int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
|
|
|
|
struct snd_ctl_elem_info *uinfo);
|
2011-01-10 08:25:44 -07:00
|
|
|
int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
|
|
|
|
unsigned int items, const char *const names[]);
|
2007-07-23 07:41:34 -06:00
|
|
|
|
2008-02-18 05:03:13 -07:00
|
|
|
/*
|
|
|
|
* virtual master control
|
|
|
|
*/
|
|
|
|
struct snd_kcontrol *snd_ctl_make_virtual_master(char *name,
|
|
|
|
const unsigned int *tlv);
|
2009-01-16 10:15:22 -07:00
|
|
|
int _snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave,
|
|
|
|
unsigned int flags);
|
|
|
|
/* optional flags for slave */
|
|
|
|
#define SND_CTL_SLAVE_NEED_UPDATE (1 << 0)
|
|
|
|
|
2009-02-09 06:47:19 -07:00
|
|
|
/**
|
|
|
|
* snd_ctl_add_slave - Add a virtual slave control
|
|
|
|
* @master: vmaster element
|
|
|
|
* @slave: slave element to add
|
|
|
|
*
|
|
|
|
* Add a virtual slave control to the given master element created via
|
|
|
|
* snd_ctl_create_virtual_master() beforehand.
|
|
|
|
*
|
|
|
|
* All slaves must be the same type (returning the same information
|
2011-03-30 19:57:33 -06:00
|
|
|
* via info callback). The function doesn't check it, so it's your
|
2009-02-09 06:47:19 -07:00
|
|
|
* responsibility.
|
|
|
|
*
|
|
|
|
* Also, some additional limitations:
|
|
|
|
* at most two channels,
|
|
|
|
* logarithmic volume control (dB level) thus no linear volume,
|
|
|
|
* master can only attenuate the volume without gain
|
2013-03-11 15:05:14 -06:00
|
|
|
*
|
|
|
|
* Return: Zero if successful or a negative error code.
|
2009-02-09 06:47:19 -07:00
|
|
|
*/
|
2009-01-16 10:15:22 -07:00
|
|
|
static inline int
|
|
|
|
snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave)
|
|
|
|
{
|
|
|
|
return _snd_ctl_add_slave(master, slave, 0);
|
|
|
|
}
|
|
|
|
|
2009-02-09 06:47:19 -07:00
|
|
|
/**
|
|
|
|
* snd_ctl_add_slave_uncached - Add a virtual slave control
|
|
|
|
* @master: vmaster element
|
|
|
|
* @slave: slave element to add
|
|
|
|
*
|
|
|
|
* Add a virtual slave control to the given master.
|
|
|
|
* Unlike snd_ctl_add_slave(), the element added via this function
|
|
|
|
* is supposed to have volatile values, and get callback is called
|
2015-03-03 18:56:13 -07:00
|
|
|
* at each time queried from the master.
|
2009-02-09 06:47:19 -07:00
|
|
|
*
|
|
|
|
* When the control peeks the hardware values directly and the value
|
|
|
|
* can be changed by other means than the put callback of the element,
|
|
|
|
* this function should be used to keep the value always up-to-date.
|
2013-03-11 15:05:14 -06:00
|
|
|
*
|
|
|
|
* Return: Zero if successful or a negative error code.
|
2009-02-09 06:47:19 -07:00
|
|
|
*/
|
2009-01-16 10:15:22 -07:00
|
|
|
static inline int
|
|
|
|
snd_ctl_add_slave_uncached(struct snd_kcontrol *master,
|
|
|
|
struct snd_kcontrol *slave)
|
|
|
|
{
|
|
|
|
return _snd_ctl_add_slave(master, slave, SND_CTL_SLAVE_NEED_UPDATE);
|
|
|
|
}
|
|
|
|
|
2012-03-12 05:18:37 -06:00
|
|
|
int snd_ctl_add_vmaster_hook(struct snd_kcontrol *kctl,
|
|
|
|
void (*hook)(void *private_data, int),
|
|
|
|
void *private_data);
|
2013-06-24 07:51:54 -06:00
|
|
|
void snd_ctl_sync_vmaster(struct snd_kcontrol *kctl, bool hook_only);
|
|
|
|
#define snd_ctl_sync_vmaster_hook(kctl) snd_ctl_sync_vmaster(kctl, true)
|
ALSA: hda - Fix incorrect TLV callback check introduced during set_fs() removal
The commit 99b5c5bb9a54 ("ALSA: hda - Remove the use of set_fs()")
converted the get_kctl_0dB_offset() call for killing set_fs() usage in
HD-audio codec code. The conversion assumed that the TLV callback
used in HD-audio code is only snd_hda_mixer_amp() and applies the TLV
calculation locally.
Although this assumption is correct, and all slave kctls are actually
with that callback, the current code is still utterly buggy; it
doesn't hit this condition and falls back to the next check. It's
because the function gets called after adding slave kctls to vmaster.
By assigning a slave kctl, the slave kctl object is faked inside
vmaster code, and the whole kctl ops are overridden. Thus the
callback op points to a different value from what we've assumed.
More badly, as reported by the KERNEXEC and UDEREF features of PaX,
the code flow turns into the unexpected pitfall. The next fallback
check is SNDRV_CTL_ELEM_ACCESS_TLV_READ access bit, and this always
hits for each kctl with TLV. Then it evaluates the callback function
pointer wrongly as if it were a TLV array. Although currently its
side-effect is fairly limited, this incorrect reference may lead to an
unpleasant result.
For addressing the regression, this patch introduces a new helper to
vmaster code, snd_ctl_apply_vmaster_slaves(). This works similarly
like the existing map_slaves() in hda_codec.c: it loops over the slave
list of the given master, and applies the given function to each
slave. Then the initializer function receives the right kctl object
and we can compare the correct pointer instead of the faked one.
Also, for catching the similar breakage in future, give an error
message when the unexpected TLV callback is found and bail out
immediately.
Fixes: 99b5c5bb9a54 ("ALSA: hda - Remove the use of set_fs()")
Reported-by: PaX Team <pageexec@freemail.hu>
Cc: <stable@vger.kernel.org> # v4.13
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2017-10-16 03:39:28 -06:00
|
|
|
int snd_ctl_apply_vmaster_slaves(struct snd_kcontrol *kctl,
|
2017-11-22 04:34:56 -07:00
|
|
|
int (*func)(struct snd_kcontrol *vslave,
|
|
|
|
struct snd_kcontrol *slave,
|
|
|
|
void *arg),
|
ALSA: hda - Fix incorrect TLV callback check introduced during set_fs() removal
The commit 99b5c5bb9a54 ("ALSA: hda - Remove the use of set_fs()")
converted the get_kctl_0dB_offset() call for killing set_fs() usage in
HD-audio codec code. The conversion assumed that the TLV callback
used in HD-audio code is only snd_hda_mixer_amp() and applies the TLV
calculation locally.
Although this assumption is correct, and all slave kctls are actually
with that callback, the current code is still utterly buggy; it
doesn't hit this condition and falls back to the next check. It's
because the function gets called after adding slave kctls to vmaster.
By assigning a slave kctl, the slave kctl object is faked inside
vmaster code, and the whole kctl ops are overridden. Thus the
callback op points to a different value from what we've assumed.
More badly, as reported by the KERNEXEC and UDEREF features of PaX,
the code flow turns into the unexpected pitfall. The next fallback
check is SNDRV_CTL_ELEM_ACCESS_TLV_READ access bit, and this always
hits for each kctl with TLV. Then it evaluates the callback function
pointer wrongly as if it were a TLV array. Although currently its
side-effect is fairly limited, this incorrect reference may lead to an
unpleasant result.
For addressing the regression, this patch introduces a new helper to
vmaster code, snd_ctl_apply_vmaster_slaves(). This works similarly
like the existing map_slaves() in hda_codec.c: it loops over the slave
list of the given master, and applies the given function to each
slave. Then the initializer function receives the right kctl object
and we can compare the correct pointer instead of the faked one.
Also, for catching the similar breakage in future, give an error
message when the unexpected TLV callback is found and bail out
immediately.
Fixes: 99b5c5bb9a54 ("ALSA: hda - Remove the use of set_fs()")
Reported-by: PaX Team <pageexec@freemail.hu>
Cc: <stable@vger.kernel.org> # v4.13
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2017-10-16 03:39:28 -06:00
|
|
|
void *arg);
|
2012-03-12 05:18:37 -06:00
|
|
|
|
2011-11-02 01:36:06 -06:00
|
|
|
/*
|
|
|
|
* Helper functions for jack-detection controls
|
|
|
|
*/
|
|
|
|
struct snd_kcontrol *
|
2015-04-27 07:20:59 -06:00
|
|
|
snd_kctl_jack_new(const char *name, struct snd_card *card);
|
2011-11-02 01:36:06 -06:00
|
|
|
void snd_kctl_jack_report(struct snd_card *card,
|
|
|
|
struct snd_kcontrol *kctl, bool status);
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
#endif /* __SOUND_CONTROL_H */
|