control.h 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
  1. #ifndef __SOUND_CONTROL_H
  2. #define __SOUND_CONTROL_H
  3. /*
  4. * Header file for control interface
  5. * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
  6. *
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation; either version 2 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program; if not, write to the Free Software
  20. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  21. *
  22. */
  23. #include <linux/nospec.h>
  24. #include <sound/asound.h>
  25. #define snd_kcontrol_chip(kcontrol) ((kcontrol)->private_data)
  26. struct snd_kcontrol;
  27. typedef int (snd_kcontrol_info_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_info * uinfo);
  28. typedef int (snd_kcontrol_get_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol);
  29. typedef int (snd_kcontrol_put_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol);
  30. typedef int (snd_kcontrol_tlv_rw_t)(struct snd_kcontrol *kcontrol,
  31. int op_flag, /* SNDRV_CTL_TLV_OP_XXX */
  32. unsigned int size,
  33. unsigned int __user *tlv);
  34. enum {
  35. SNDRV_CTL_TLV_OP_READ = 0,
  36. SNDRV_CTL_TLV_OP_WRITE = 1,
  37. SNDRV_CTL_TLV_OP_CMD = -1,
  38. };
  39. struct snd_kcontrol_new {
  40. snd_ctl_elem_iface_t iface; /* interface identifier */
  41. unsigned int device; /* device/client number */
  42. unsigned int subdevice; /* subdevice (substream) number */
  43. const unsigned char *name; /* ASCII name of item */
  44. unsigned int index; /* index of item */
  45. unsigned int access; /* access rights */
  46. unsigned int count; /* count of same elements */
  47. snd_kcontrol_info_t *info;
  48. snd_kcontrol_get_t *get;
  49. snd_kcontrol_put_t *put;
  50. union {
  51. snd_kcontrol_tlv_rw_t *c;
  52. const unsigned int *p;
  53. } tlv;
  54. unsigned long private_value;
  55. };
  56. struct snd_kcontrol_volatile {
  57. struct snd_ctl_file *owner; /* locked */
  58. unsigned int access; /* access rights */
  59. };
  60. struct snd_kcontrol {
  61. struct list_head list; /* list of controls */
  62. struct snd_ctl_elem_id id;
  63. unsigned int count; /* count of same elements */
  64. snd_kcontrol_info_t *info;
  65. snd_kcontrol_get_t *get;
  66. snd_kcontrol_put_t *put;
  67. union {
  68. snd_kcontrol_tlv_rw_t *c;
  69. const unsigned int *p;
  70. } tlv;
  71. unsigned long private_value;
  72. void *private_data;
  73. void (*private_free)(struct snd_kcontrol *kcontrol);
  74. struct snd_kcontrol_volatile vd[0]; /* volatile data */
  75. };
  76. #define snd_kcontrol(n) list_entry(n, struct snd_kcontrol, list)
  77. struct snd_kctl_event {
  78. struct list_head list; /* list of events */
  79. struct snd_ctl_elem_id id;
  80. unsigned int mask;
  81. };
  82. #define snd_kctl_event(n) list_entry(n, struct snd_kctl_event, list)
  83. struct pid;
  84. enum {
  85. SND_CTL_SUBDEV_PCM,
  86. SND_CTL_SUBDEV_RAWMIDI,
  87. SND_CTL_SUBDEV_ITEMS,
  88. };
  89. struct snd_ctl_file {
  90. struct list_head list; /* list of all control files */
  91. struct snd_card *card;
  92. struct pid *pid;
  93. int preferred_subdevice[SND_CTL_SUBDEV_ITEMS];
  94. wait_queue_head_t change_sleep;
  95. spinlock_t read_lock;
  96. struct fasync_struct *fasync;
  97. int subscribed; /* read interface is activated */
  98. struct list_head events; /* waiting events for read */
  99. };
  100. #define snd_ctl_file(n) list_entry(n, struct snd_ctl_file, list)
  101. typedef int (*snd_kctl_ioctl_func_t) (struct snd_card * card,
  102. struct snd_ctl_file * control,
  103. unsigned int cmd, unsigned long arg);
  104. void snd_ctl_notify(struct snd_card * card, unsigned int mask, struct snd_ctl_elem_id * id);
  105. struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new * kcontrolnew, void * private_data);
  106. void snd_ctl_free_one(struct snd_kcontrol * kcontrol);
  107. int snd_ctl_add(struct snd_card * card, struct snd_kcontrol * kcontrol);
  108. int snd_ctl_remove(struct snd_card * card, struct snd_kcontrol * kcontrol);
  109. int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol, bool add_on_replace);
  110. int snd_ctl_remove_id(struct snd_card * card, struct snd_ctl_elem_id *id);
  111. int snd_ctl_rename_id(struct snd_card * card, struct snd_ctl_elem_id *src_id, struct snd_ctl_elem_id *dst_id);
  112. int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id,
  113. int active);
  114. struct snd_kcontrol *snd_ctl_find_numid(struct snd_card * card, unsigned int numid);
  115. struct snd_kcontrol *snd_ctl_find_id(struct snd_card * card, struct snd_ctl_elem_id *id);
  116. int snd_ctl_create(struct snd_card *card);
  117. int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn);
  118. int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn);
  119. #ifdef CONFIG_COMPAT
  120. int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn);
  121. int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn);
  122. #else
  123. #define snd_ctl_register_ioctl_compat(fcn)
  124. #define snd_ctl_unregister_ioctl_compat(fcn)
  125. #endif
  126. int snd_ctl_get_preferred_subdevice(struct snd_card *card, int type);
  127. static inline unsigned int snd_ctl_get_ioffnum(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
  128. {
  129. unsigned int ioff = id->numid - kctl->id.numid;
  130. return array_index_nospec(ioff, kctl->count);
  131. }
  132. static inline unsigned int snd_ctl_get_ioffidx(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
  133. {
  134. unsigned int ioff = id->index - kctl->id.index;
  135. return array_index_nospec(ioff, kctl->count);
  136. }
  137. static inline unsigned int snd_ctl_get_ioff(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
  138. {
  139. if (id->numid) {
  140. return snd_ctl_get_ioffnum(kctl, id);
  141. } else {
  142. return snd_ctl_get_ioffidx(kctl, id);
  143. }
  144. }
  145. static inline struct snd_ctl_elem_id *snd_ctl_build_ioff(struct snd_ctl_elem_id *dst_id,
  146. struct snd_kcontrol *src_kctl,
  147. unsigned int offset)
  148. {
  149. *dst_id = src_kctl->id;
  150. dst_id->index += offset;
  151. dst_id->numid += offset;
  152. return dst_id;
  153. }
  154. /*
  155. * Frequently used control callbacks/helpers
  156. */
  157. int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
  158. struct snd_ctl_elem_info *uinfo);
  159. int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
  160. struct snd_ctl_elem_info *uinfo);
  161. int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
  162. unsigned int items, const char *const names[]);
  163. /*
  164. * virtual master control
  165. */
  166. struct snd_kcontrol *snd_ctl_make_virtual_master(char *name,
  167. const unsigned int *tlv);
  168. int _snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave,
  169. unsigned int flags);
  170. /* optional flags for slave */
  171. #define SND_CTL_SLAVE_NEED_UPDATE (1 << 0)
  172. /**
  173. * snd_ctl_add_slave - Add a virtual slave control
  174. * @master: vmaster element
  175. * @slave: slave element to add
  176. *
  177. * Add a virtual slave control to the given master element created via
  178. * snd_ctl_create_virtual_master() beforehand.
  179. *
  180. * All slaves must be the same type (returning the same information
  181. * via info callback). The function doesn't check it, so it's your
  182. * responsibility.
  183. *
  184. * Also, some additional limitations:
  185. * at most two channels,
  186. * logarithmic volume control (dB level) thus no linear volume,
  187. * master can only attenuate the volume without gain
  188. *
  189. * Return: Zero if successful or a negative error code.
  190. */
  191. static inline int
  192. snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave)
  193. {
  194. return _snd_ctl_add_slave(master, slave, 0);
  195. }
  196. /**
  197. * snd_ctl_add_slave_uncached - Add a virtual slave control
  198. * @master: vmaster element
  199. * @slave: slave element to add
  200. *
  201. * Add a virtual slave control to the given master.
  202. * Unlike snd_ctl_add_slave(), the element added via this function
  203. * is supposed to have volatile values, and get callback is called
  204. * at each time queried from the master.
  205. *
  206. * When the control peeks the hardware values directly and the value
  207. * can be changed by other means than the put callback of the element,
  208. * this function should be used to keep the value always up-to-date.
  209. *
  210. * Return: Zero if successful or a negative error code.
  211. */
  212. static inline int
  213. snd_ctl_add_slave_uncached(struct snd_kcontrol *master,
  214. struct snd_kcontrol *slave)
  215. {
  216. return _snd_ctl_add_slave(master, slave, SND_CTL_SLAVE_NEED_UPDATE);
  217. }
  218. int snd_ctl_add_vmaster_hook(struct snd_kcontrol *kctl,
  219. void (*hook)(void *private_data, int),
  220. void *private_data);
  221. void snd_ctl_sync_vmaster(struct snd_kcontrol *kctl, bool hook_only);
  222. #define snd_ctl_sync_vmaster_hook(kctl) snd_ctl_sync_vmaster(kctl, true)
  223. /*
  224. * Helper functions for jack-detection controls
  225. */
  226. struct snd_kcontrol *
  227. snd_kctl_jack_new(const char *name, struct snd_card *card);
  228. void snd_kctl_jack_report(struct snd_card *card,
  229. struct snd_kcontrol *kctl, bool status);
  230. #endif /* __SOUND_CONTROL_H */