include/sound/control.h

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