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