sound/usb/mixer.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 #ifndef __USBMIXER_H
0003 #define __USBMIXER_H
0004
0005 #include <sound/info.h>
0006
0007 struct media_mixer_ctl;
0008
0009 struct usbmix_connector_map {
0010     u8 id;
0011     u8 delegated_id;
0012     u8 control;
0013     u8 channel;
0014 };
0015
0016 struct usb_mixer_interface {
0017     struct snd_usb_audio *chip;
0018     struct usb_host_interface *hostif;
0019     struct list_head list;
0020     unsigned int ignore_ctl_error;
0021     struct urb *urb;
0022     /* array[MAX_ID_ELEMS], indexed by unit id */
0023     struct usb_mixer_elem_list **id_elems;
0024
0025     /* the usb audio specification version this interface complies to */
0026     int protocol;
0027
0028     /* optional connector delegation map */
0029     const struct usbmix_connector_map *connector_map;
0030
0031     /* Sound Blaster remote control stuff */
0032     const struct rc_config *rc_cfg;
0033     u32 rc_code;
0034     wait_queue_head_t rc_waitq;
0035     struct urb *rc_urb;
0036     struct usb_ctrlrequest *rc_setup_packet;
0037     u8 rc_buffer[6];
0038     struct media_mixer_ctl *media_mixer_ctl;
0039
0040     bool disconnected;
0041
0042     void *private_data;
0043     void (*private_free)(struct usb_mixer_interface *mixer);
0044     void (*private_suspend)(struct usb_mixer_interface *mixer);
0045 };
0046
0047 #define MAX_CHANNELS    16  /* max logical channels */
0048
0049 enum {
0050     USB_MIXER_BOOLEAN,
0051     USB_MIXER_INV_BOOLEAN,
0052     USB_MIXER_S8,
0053     USB_MIXER_U8,
0054     USB_MIXER_S16,
0055     USB_MIXER_U16,
0056     USB_MIXER_S32,
0057     USB_MIXER_U32,
0058     USB_MIXER_BESPOKEN, /* non-standard type */
0059 };
0060
0061 typedef void (*usb_mixer_elem_dump_func_t)(struct snd_info_buffer *buffer,
0062                      struct usb_mixer_elem_list *list);
0063 typedef int (*usb_mixer_elem_resume_func_t)(struct usb_mixer_elem_list *elem);
0064
0065 struct usb_mixer_elem_list {
0066     struct usb_mixer_interface *mixer;
0067     struct usb_mixer_elem_list *next_id_elem; /* list of controls with same id */
0068     struct snd_kcontrol *kctl;
0069     unsigned int id;
0070     bool is_std_info;
0071     usb_mixer_elem_dump_func_t dump;
0072     usb_mixer_elem_resume_func_t resume;
0073 };
0074
0075 /* iterate over mixer element list of the given unit id */
0076 #define for_each_mixer_elem(list, mixer, id)    \
0077     for ((list) = (mixer)->id_elems[id]; (list); (list) = (list)->next_id_elem)
0078 #define mixer_elem_list_to_info(list) \
0079     container_of(list, struct usb_mixer_elem_info, head)
0080
0081 struct usb_mixer_elem_info {
0082     struct usb_mixer_elem_list head;
0083     unsigned int control;   /* CS or ICN (high byte) */
0084     unsigned int cmask; /* channel mask bitmap: 0 = master */
0085     unsigned int idx_off; /* Control index offset */
0086     unsigned int ch_readonly;
0087     unsigned int master_readonly;
0088     int channels;
0089     int val_type;
0090     int min, max, res;
0091     int dBmin, dBmax;
0092     int cached;
0093     int cache_val[MAX_CHANNELS];
0094     u8 initialized;
0095     u8 min_mute;
0096     void *private_data;
0097 };
0098
0099 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif);
0100 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer);
0101
0102 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid);
0103
0104 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
0105                 int request, int validx, int value_set);
0106
0107 int snd_usb_mixer_add_list(struct usb_mixer_elem_list *list,
0108                struct snd_kcontrol *kctl,
0109                bool is_std_info);
0110
0111 #define snd_usb_mixer_add_control(list, kctl) \
0112     snd_usb_mixer_add_list(list, kctl, true)
0113
0114 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
0115                  struct usb_mixer_interface *mixer,
0116                  int unitid);
0117
0118 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
0119               unsigned int size, unsigned int __user *_tlv);
0120
0121 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer);
0122 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer);
0123
0124 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
0125                              int index, int value);
0126
0127 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
0128                              int channel, int index, int *value);
0129
0130 extern void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl);
0131
0132 extern const struct snd_kcontrol_new *snd_usb_feature_unit_ctl;
0133
0134 #endif /* __USBMIXER_H */