xref: /linux/sound/usb/usbaudio.h (revision 8137a49e1567726eb10fcf55ad141ac19804ca6b)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 #ifndef __USBAUDIO_H
3 #define __USBAUDIO_H
4 /*
5  *   (Tentative) USB Audio Driver for ALSA
6  *
7  *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
8  */
9 
10 /* handling of USB vendor/product ID pairs as 32-bit numbers */
11 #define USB_ID(vendor, product) (((vendor) << 16) | (product))
12 #define USB_ID_VENDOR(id) ((id) >> 16)
13 #define USB_ID_PRODUCT(id) ((u16)(id))
14 
15 /*
16  *
17  */
18 
19 struct media_device;
20 struct media_intf_devnode;
21 
22 #define MAX_CARD_INTERFACES	16
23 
24 struct snd_usb_audio {
25 	int index;
26 	struct usb_device *dev;
27 	struct snd_card *card;
28 	struct usb_interface *intf[MAX_CARD_INTERFACES];
29 	u32 usb_id;
30 	uint16_t quirk_type;
31 	struct mutex mutex;
32 	unsigned int system_suspend;
33 	atomic_t active;
34 	atomic_t shutdown;
35 	atomic_t usage_count;
36 	wait_queue_head_t shutdown_wait;
37 	unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
38 	unsigned int tx_length_quirk:1; /* Put length specifier in transfers */
39 	unsigned int need_delayed_register:1; /* warn for delayed registration */
40 	unsigned int playback_first:1;	/* for implicit fb: don't wait for the first capture URBs */
41 	int num_interfaces;
42 	int num_suspended_intf;
43 	int sample_rate_read_error;
44 
45 	int badd_profile;		/* UAC3 BADD profile */
46 
47 	struct list_head pcm_list;	/* list of pcm streams */
48 	struct list_head ep_list;	/* list of audio-related endpoints */
49 	struct list_head iface_ref_list; /* list of interface refcounts */
50 	int pcm_devs;
51 
52 	struct list_head midi_list;	/* list of midi interfaces */
53 
54 	struct list_head mixer_list;	/* list of mixer interfaces */
55 
56 	int setup;			/* from the 'device_setup' module param */
57 	bool generic_implicit_fb;	/* from the 'implicit_fb' module param */
58 	bool autoclock;			/* from the 'autoclock' module param */
59 
60 	struct usb_host_interface *ctrl_intf;	/* the audio control interface */
61 	struct media_device *media_dev;
62 	struct media_intf_devnode *ctl_intf_media_devnode;
63 };
64 
65 #define USB_AUDIO_IFACE_UNUSED	((void *)-1L)
66 
67 #define usb_audio_err(chip, fmt, args...) \
68 	dev_err(&(chip)->dev->dev, fmt, ##args)
69 #define usb_audio_warn(chip, fmt, args...) \
70 	dev_warn(&(chip)->dev->dev, fmt, ##args)
71 #define usb_audio_info(chip, fmt, args...) \
72 	dev_info(&(chip)->dev->dev, fmt, ##args)
73 #define usb_audio_dbg(chip, fmt, args...) \
74 	dev_dbg(&(chip)->dev->dev, fmt, ##args)
75 
76 /*
77  * Information about devices with broken descriptors
78  */
79 
80 /* special values for .ifnum */
81 #define QUIRK_NODEV_INTERFACE		-3	/* return -ENODEV */
82 #define QUIRK_NO_INTERFACE		-2
83 #define QUIRK_ANY_INTERFACE		-1
84 
85 enum quirk_type {
86 	QUIRK_IGNORE_INTERFACE,
87 	QUIRK_COMPOSITE,
88 	QUIRK_AUTODETECT,
89 	QUIRK_MIDI_STANDARD_INTERFACE,
90 	QUIRK_MIDI_FIXED_ENDPOINT,
91 	QUIRK_MIDI_YAMAHA,
92 	QUIRK_MIDI_ROLAND,
93 	QUIRK_MIDI_MIDIMAN,
94 	QUIRK_MIDI_NOVATION,
95 	QUIRK_MIDI_RAW_BYTES,
96 	QUIRK_MIDI_EMAGIC,
97 	QUIRK_MIDI_CME,
98 	QUIRK_MIDI_AKAI,
99 	QUIRK_MIDI_US122L,
100 	QUIRK_MIDI_FTDI,
101 	QUIRK_MIDI_CH345,
102 	QUIRK_AUDIO_STANDARD_INTERFACE,
103 	QUIRK_AUDIO_FIXED_ENDPOINT,
104 	QUIRK_AUDIO_EDIROL_UAXX,
105 	QUIRK_AUDIO_ALIGN_TRANSFER,
106 	QUIRK_AUDIO_STANDARD_MIXER,
107 	QUIRK_SETUP_FMT_AFTER_RESUME,
108 	QUIRK_SETUP_DISABLE_AUTOSUSPEND,
109 
110 	QUIRK_TYPE_COUNT
111 };
112 
113 struct snd_usb_audio_quirk {
114 	const char *vendor_name;
115 	const char *product_name;
116 	int16_t ifnum;
117 	uint16_t type;
118 	bool shares_media_device;
119 	const void *data;
120 };
121 
122 #define combine_word(s)    ((*(s)) | ((unsigned int)(s)[1] << 8))
123 #define combine_triple(s)  (combine_word(s) | ((unsigned int)(s)[2] << 16))
124 #define combine_quad(s)    (combine_triple(s) | ((unsigned int)(s)[3] << 24))
125 
126 int snd_usb_lock_shutdown(struct snd_usb_audio *chip);
127 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip);
128 
129 extern bool snd_usb_use_vmalloc;
130 extern bool snd_usb_skip_validation;
131 
132 #endif /* __USBAUDIO_H */
133