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