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         bool is_std_info;
  53         usb_mixer_elem_dump_func_t dump;
  54         usb_mixer_elem_resume_func_t resume;
  55 };
  56
  57 /* iterate over mixer element list of the given unit id */
  58 #define for_each_mixer_elem(list, mixer, id)    \
  59         for ((list) = (mixer)->id_elems[id]; (list); (list) = (list)->next_id_elem)
  60 #define mixer_elem_list_to_info(list) \
  61         container_of(list, struct usb_mixer_elem_info, head)
  62
  63 struct usb_mixer_elem_info {
  64         struct usb_mixer_elem_list head;
  65         unsigned int control;   /* CS or ICN (high byte) */
  66         unsigned int cmask; /* channel mask bitmap: 0 = master */
  67         unsigned int idx_off; /* Control index offset */
  68         unsigned int ch_readonly;
  69         unsigned int master_readonly;
  70         int channels;
  71         int val_type;
  72         int min, max, res;
  73         int dBmin, dBmax;
  74         int cached;
  75         int cache_val[MAX_CHANNELS];
  76         u8 initialized;
  77         u8 min_mute;
  78         void *private_data;
  79 };
  80
  81 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
  82                          int ignore_error);
  83 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer);
  84
  85 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid);
  86
  87 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
  88                                 int request, int validx, int value_set);
  89
  90 int snd_usb_mixer_add_list(struct usb_mixer_elem_list *list,
  91                            struct snd_kcontrol *kctl,
  92                            bool is_std_info);
  93
  94 #define snd_usb_mixer_add_control(list, kctl) \
  95         snd_usb_mixer_add_list(list, kctl, true)
  96
  97 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
  98                                  struct usb_mixer_interface *mixer,
  99                                  int unitid);
 100
 101 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
 102                           unsigned int size, unsigned int __user *_tlv);
 103
 104 #ifdef CONFIG_PM
 105 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer);
 106 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume);
 107 #endif
 108
 109 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
 110                              int index, int value);
 111
 112 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
 113                              int channel, int index, int *value);
 114
 115 extern void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl);
 116
 117 #endif /* __USBMIXER_H */