sound/usb/mixer.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __USBMIXER_H
   3 #define __USBMIXER_H
   4
   5 #include <sound/info.h>
   6
   7 struct usb_mixer_interface {
   8         struct snd_usb_audio *chip;
   9         struct usb_host_interface *hostif;
  10         struct list_head list;
  11         unsigned int ignore_ctl_error;
  12         struct urb *urb;
  13         /* array[MAX_ID_ELEMS], indexed by unit id */
  14         struct usb_mixer_elem_list **id_elems;
  15
  16         /* the usb audio specification version this interface complies to */
  17         int protocol;
  18
  19         /* Sound Blaster remote control stuff */
  20         const struct rc_config *rc_cfg;
  21         u32 rc_code;
  22         wait_queue_head_t rc_waitq;
  23         struct urb *rc_urb;
  24         struct usb_ctrlrequest *rc_setup_packet;
  25         u8 rc_buffer[6];
  26
  27         bool disconnected;
  28 };
  29
  30 #define MAX_CHANNELS    16      /* max logical channels */
  31
  32 enum {
  33         USB_MIXER_BOOLEAN,
  34         USB_MIXER_INV_BOOLEAN,
  35         USB_MIXER_S8,
  36         USB_MIXER_U8,
  37         USB_MIXER_S16,
  38         USB_MIXER_U16,
  39         USB_MIXER_S32,
  40         USB_MIXER_U32,
  41 };
  42
  43 typedef void (*usb_mixer_elem_dump_func_t)(struct snd_info_buffer *buffer,
  44                                          struct usb_mixer_elem_list *list);
  45 typedef int (*usb_mixer_elem_resume_func_t)(struct usb_mixer_elem_list *elem);
  46
  47 struct usb_mixer_elem_list {
  48         struct usb_mixer_interface *mixer;
  49         struct usb_mixer_elem_list *next_id_elem; /* list of controls with same id */
  50         struct snd_kcontrol *kctl;
  51         unsigned int id;
  52         usb_mixer_elem_dump_func_t dump;
  53         usb_mixer_elem_resume_func_t resume;
  54 };
  55
  56 /* iterate over mixer element list of the given unit id */
  57 #define for_each_mixer_elem(list, mixer, id)    \
  58         for ((list) = (mixer)->id_elems[id]; (list); (list) = (list)->next_id_elem)
  59 #define mixer_elem_list_to_info(list) \
  60         container_of(list, struct usb_mixer_elem_info, head)
  61
  62 struct usb_mixer_elem_info {
  63         struct usb_mixer_elem_list head;
  64         unsigned int control;   /* CS or ICN (high byte) */
  65         unsigned int cmask; /* channel mask bitmap: 0 = master */
  66         unsigned int idx_off; /* Control index offset */
  67         unsigned int ch_readonly;
  68         unsigned int master_readonly;
  69         int channels;
  70         int val_type;
  71         int min, max, res;
  72         int dBmin, dBmax;
  73         int cached;
  74         int cache_val[MAX_CHANNELS];
  75         u8 initialized;
  76         u8 min_mute;
  77         void *private_data;
  78 };
  79
  80 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
  81                          int ignore_error);
  82 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer);
  83
  84 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid);
  85
  86 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
  87                                 int request, int validx, int value_set);
  88
  89 int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
  90                               struct snd_kcontrol *kctl);
  91
  92 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
  93                                  struct usb_mixer_interface *mixer,
  94                                  int unitid);
  95
  96 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
  97                           unsigned int size, unsigned int __user *_tlv);
  98
  99 #ifdef CONFIG_PM
 100 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer);
 101 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume);
 102 #endif
 103
 104 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
 105                              int index, int value);
 106
 107 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
 108                              int channel, int index, int *value);
 109
 110 extern void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl);
 111
 112 extern struct snd_kcontrol_new *snd_usb_feature_unit_ctl;
 113
 114 #endif /* __USBMIXER_H */