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