[mirror_ubuntu-bionic-kernel.git] / sound / usb / mixer.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __USBMIXER_H
#define __USBMIXER_H

#include <sound/info.h>

struct usb_mixer_interface {
	struct snd_usb_audio *chip;
	struct usb_host_interface *hostif;
	struct list_head list;
	unsigned int ignore_ctl_error;
	struct urb *urb;
	/* array[MAX_ID_ELEMS], indexed by unit id */
	struct usb_mixer_elem_list **id_elems;

	/* the usb audio specification version this interface complies to */
	int protocol;

	/* Sound Blaster remote control stuff */
	const struct rc_config *rc_cfg;
	u32 rc_code;
	wait_queue_head_t rc_waitq;
	struct urb *rc_urb;
	struct usb_ctrlrequest *rc_setup_packet;
	u8 rc_buffer[6];

	bool disconnected;
};

#define MAX_CHANNELS	16	/* max logical channels */

enum {
	USB_MIXER_BOOLEAN,
	USB_MIXER_INV_BOOLEAN,
	USB_MIXER_S8,
	USB_MIXER_U8,
	USB_MIXER_S16,
	USB_MIXER_U16,
	USB_MIXER_S32,
	USB_MIXER_U32,
};

typedef void (*usb_mixer_elem_dump_func_t)(struct snd_info_buffer *buffer,
					 struct usb_mixer_elem_list *list);
typedef int (*usb_mixer_elem_resume_func_t)(struct usb_mixer_elem_list *elem);

struct usb_mixer_elem_list {
	struct usb_mixer_interface *mixer;
	struct usb_mixer_elem_list *next_id_elem; /* list of controls with same id */
	struct snd_kcontrol *kctl;
	unsigned int id;
	usb_mixer_elem_dump_func_t dump;
	usb_mixer_elem_resume_func_t resume;
};

struct usb_mixer_elem_info {
	struct usb_mixer_elem_list head;
	unsigned int control;	/* CS or ICN (high byte) */
	unsigned int cmask; /* channel mask bitmap: 0 = master */
	unsigned int idx_off; /* Control index offset */
	unsigned int ch_readonly;
	unsigned int master_readonly;
	int channels;
	int val_type;
	int min, max, res;
	int dBmin, dBmax;
	int cached;
	int cache_val[MAX_CHANNELS];
	u8 initialized;
	u8 min_mute;
	void *private_data;
};

int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
			 int ignore_error);
void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer);

void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid);

int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
				int request, int validx, int value_set);

int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
			      struct snd_kcontrol *kctl);

void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
				 struct usb_mixer_interface *mixer,
				 int unitid);

int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
			  unsigned int size, unsigned int __user *_tlv);

#ifdef CONFIG_PM
int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer);
int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume);
#endif

int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
                             int index, int value);

int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
                             int channel, int index, int *value);

extern void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl);

#endif /* __USBMIXER_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
3e1aebef DM	2	#ifndef __USBMIXER_H
	3	#define __USBMIXER_H
	4
3360b84b TI	5	#include <sound/info.h>
3360b84b TI	6
7b1eda22 DM	7	struct usb_mixer_interface {
7b1eda22 DM	8	struct snd_usb_audio *chip;
1faa5d07	9	struct usb_host_interface *hostif;
7b1eda22 DM	10	struct list_head list;
	11	unsigned int ignore_ctl_error;
	12	struct urb *urb;
	13	/* array[MAX_ID_ELEMS], indexed by unit id */
3360b84b	14	struct usb_mixer_elem_list **id_elems;
7b1eda22	15
23caaf19 DM	16	/* the usb audio specification version this interface complies to */
	17	int protocol;
	18
7b1eda22 DM	19	/* Sound Blaster remote control stuff */
	20	const struct rc_config *rc_cfg;
	21	u32 rc_code;
	22	wait_queue_head_t rc_waitq;
	23	struct urb *rc_urb;
	24	struct usb_ctrlrequest *rc_setup_packet;
	25	u8 rc_buffer[6];
124751d5 TI	26
124751d5 TI	27	bool disconnected;
7b1eda22 DM	28	};
7b1eda22 DM	29
9e38658f DM	30	#define MAX_CHANNELS 16 /* max logical channels */
	31
	32	enum {
	33	USB_MIXER_BOOLEAN,
	34	USB_MIXER_INV_BOOLEAN,
	35	USB_MIXER_S8,
	36	USB_MIXER_U8,
	37	USB_MIXER_S16,
	38	USB_MIXER_U16,
bc18e31c JS	39	USB_MIXER_S32,
bc18e31c JS	40	USB_MIXER_U32,
9e38658f	41	};
7b1eda22	42
3360b84b TI	43	typedef void (usb_mixer_elem_dump_func_t)(struct snd_info_buffer buffer,
	44	struct usb_mixer_elem_list *list);
	45	typedef int (usb_mixer_elem_resume_func_t)(struct usb_mixer_elem_list elem);
	46
	47	struct usb_mixer_elem_list {
7b1eda22	48	struct usb_mixer_interface *mixer;
3360b84b TI	49	struct usb_mixer_elem_list next_id_elem; / list of controls with same id */
3360b84b TI	50	struct snd_kcontrol *kctl;
7b1eda22	51	unsigned int id;
3360b84b TI	52	usb_mixer_elem_dump_func_t dump;
	53	usb_mixer_elem_resume_func_t resume;
	54	};
	55
	56	struct usb_mixer_elem_info {
	57	struct usb_mixer_elem_list head;
7b1eda22 DM	58	unsigned int control; /* CS or ICN (high byte) */
7b1eda22 DM	59	unsigned int cmask; /* channel mask bitmap: 0 = master */
9f814105	60	unsigned int idx_off; /* Control index offset */
a6a33259 DM	61	unsigned int ch_readonly;
a6a33259 DM	62	unsigned int master_readonly;
7b1eda22 DM	63	int channels;
	64	int val_type;
	65	int min, max, res;
	66	int dBmin, dBmax;
	67	int cached;
	68	int cache_val[MAX_CHANNELS];
	69	u8 initialized;
0f174b35	70	u8 min_mute;
f41d6049	71	void *private_data;
7b1eda22 DM	72	};
7b1eda22 DM	73
3e1aebef DM	74	int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
3e1aebef DM	75	int ignore_error);
a6cece9d	76	void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer);
3e1aebef	77
7b1eda22 DM	78	void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid);
	79
	80	int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
	81	int request, int validx, int value_set);
3e1aebef	82
3360b84b	83	int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
ef9d5970 DM	84	struct snd_kcontrol *kctl);
ef9d5970 DM	85
3360b84b TI	86	void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
	87	struct usb_mixer_interface *mixer,
	88	int unitid);
	89
285de9c0 FH	90	int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
	91	unsigned int size, unsigned int __user *_tlv);
	92
400362f1 TI	93	#ifdef CONFIG_PM
	94	int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer);
	95	int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume);
	96	#endif
	97
eef90451 CA	98	int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
	99	int index, int value);
	100
	101	int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
	102	int channel, int index, int *value);
	103
	104	extern void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl);
	105
3e1aebef	106	#endif /* __USBMIXER_H */