[linux-2.6-block.git] / sound / usb / mixer.h

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

#include <sound/info.h>

struct media_mixer_ctl;

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];
	struct media_mixer_ctl *media_mixer_ctl;

	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;
};

/* iterate over mixer element list of the given unit id */
#define for_each_mixer_elem(list, mixer, id)	\
	for ((list) = (mixer)->id_elems[id]; (list); (list) = (list)->next_id_elem)
#define mixer_elem_list_to_info(list) \
	container_of(list, struct usb_mixer_elem_info, head)

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);

extern struct snd_kcontrol_new *snd_usb_feature_unit_ctl;

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