GNU Linux-libre 4.9.337-gnu1
[releases.git] / sound / usb / mixer.h
1 #ifndef __USBMIXER_H
2 #define __USBMIXER_H
3
4 #include <sound/info.h>
5
6 struct usb_mixer_interface {
7         struct snd_usb_audio *chip;
8         struct usb_host_interface *hostif;
9         struct list_head list;
10         unsigned int ignore_ctl_error;
11         struct urb *urb;
12         /* array[MAX_ID_ELEMS], indexed by unit id */
13         struct usb_mixer_elem_list **id_elems;
14
15         /* the usb audio specification version this interface complies to */
16         int protocol;
17
18         /* Sound Blaster remote control stuff */
19         const struct rc_config *rc_cfg;
20         u32 rc_code;
21         wait_queue_head_t rc_waitq;
22         struct urb *rc_urb;
23         struct usb_ctrlrequest *rc_setup_packet;
24         u8 rc_buffer[6];
25
26         bool disconnected;
27 };
28
29 #define MAX_CHANNELS    16      /* max logical channels */
30
31 enum {
32         USB_MIXER_BOOLEAN,
33         USB_MIXER_INV_BOOLEAN,
34         USB_MIXER_S8,
35         USB_MIXER_U8,
36         USB_MIXER_S16,
37         USB_MIXER_U16,
38         USB_MIXER_S32,
39         USB_MIXER_U32,
40 };
41
42 typedef void (*usb_mixer_elem_dump_func_t)(struct snd_info_buffer *buffer,
43                                          struct usb_mixer_elem_list *list);
44 typedef int (*usb_mixer_elem_resume_func_t)(struct usb_mixer_elem_list *elem);
45
46 struct usb_mixer_elem_list {
47         struct usb_mixer_interface *mixer;
48         struct usb_mixer_elem_list *next_id_elem; /* list of controls with same id */
49         struct snd_kcontrol *kctl;
50         unsigned int id;
51         bool is_std_info;
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_list(struct usb_mixer_elem_list *list,
90                            struct snd_kcontrol *kctl,
91                            bool is_std_info);
92
93 #define snd_usb_mixer_add_control(list, kctl) \
94         snd_usb_mixer_add_list(list, kctl, true)
95
96 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
97                                  struct usb_mixer_interface *mixer,
98                                  int unitid);
99
100 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
101                           unsigned int size, unsigned int __user *_tlv);
102
103 #ifdef CONFIG_PM
104 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer);
105 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume);
106 #endif
107
108 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
109                              int index, int value);
110
111 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
112                              int channel, int index, int *value);
113
114 extern void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl);
115
116 #endif /* __USBMIXER_H */