Commit | Line | Data |
---|---|---|
1a59d1b8 | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
1da177e4 LT |
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> | |
1da177e4 LT |
8 | */ |
9 | ||
27d10f56 | 10 | /* handling of USB vendor/product ID pairs as 32-bit numbers */ |
1ef87159 | 11 | #define USB_ID(vendor, product) (((unsigned int)(vendor) << 16) | (product)) |
27d10f56 CL |
12 | #define USB_ID_VENDOR(id) ((id) >> 16) |
13 | #define USB_ID_PRODUCT(id) ((u16)(id)) | |
14 | ||
1da177e4 | 15 | /* |
e5779998 | 16 | * |
1da177e4 LT |
17 | */ |
18 | ||
66354f18 SK |
19 | struct media_device; |
20 | struct media_intf_devnode; | |
21 | ||
88d8822d TI |
22 | #define MAX_CARD_INTERFACES 16 |
23 | ||
6aa87001 KK |
24 | /* |
25 | * Structure holding assosiation between Audio Control Interface | |
26 | * and given Streaming or Midi Interface. | |
27 | */ | |
28 | struct snd_intf_to_ctrl { | |
29 | u8 interface; | |
30 | struct usb_host_interface *ctrl_intf; | |
31 | }; | |
32 | ||
1da177e4 LT |
33 | struct snd_usb_audio { |
34 | int index; | |
35 | struct usb_device *dev; | |
86e07d34 | 36 | struct snd_card *card; |
88d8822d | 37 | struct usb_interface *intf[MAX_CARD_INTERFACES]; |
27d10f56 | 38 | u32 usb_id; |
97991108 | 39 | uint16_t quirk_type; |
596580d0 | 40 | struct mutex mutex; |
862b2509 | 41 | unsigned int system_suspend; |
47ab1545 TI |
42 | atomic_t active; |
43 | atomic_t shutdown; | |
44 | atomic_t usage_count; | |
45 | wait_queue_head_t shutdown_wait; | |
4d4dee0a | 46 | unsigned int quirk_flags; |
a4aad563 | 47 | unsigned int need_delayed_register:1; /* warn for delayed registration */ |
1da177e4 | 48 | int num_interfaces; |
6392dcd1 | 49 | int last_iface; |
f85bf29c | 50 | int num_suspended_intf; |
57dd5414 | 51 | int sample_rate_read_error; |
1da177e4 | 52 | |
17156f23 RB |
53 | int badd_profile; /* UAC3 BADD profile */ |
54 | ||
1da177e4 | 55 | struct list_head pcm_list; /* list of pcm streams */ |
8fdff6a3 | 56 | struct list_head ep_list; /* list of audio-related endpoints */ |
00272c61 | 57 | struct list_head iface_ref_list; /* list of interface refcounts */ |
c11117b6 | 58 | struct list_head clock_ref_list; /* list of clock refcounts */ |
1da177e4 LT |
59 | int pcm_devs; |
60 | ||
bb1bf4fa | 61 | unsigned int num_rawmidis; /* number of created rawmidi devices */ |
1da177e4 | 62 | struct list_head midi_list; /* list of midi interfaces */ |
ff49d1df | 63 | struct list_head midi_v2_list; /* list of MIDI 2 interfaces */ |
1da177e4 | 64 | |
84957a8a | 65 | struct list_head mixer_list; /* list of mixer interfaces */ |
e5779998 DM |
66 | |
67 | int setup; /* from the 'device_setup' module param */ | |
62abd092 | 68 | bool generic_implicit_fb; /* from the 'implicit_fb' module param */ |
ef02e29b | 69 | bool autoclock; /* from the 'autoclock' module param */ |
79f920fb | 70 | |
4801bee7 | 71 | bool lowlatency; /* from the 'lowlatency' module param */ |
79f920fb | 72 | struct usb_host_interface *ctrl_intf; /* the audio control interface */ |
66354f18 SK |
73 | struct media_device *media_dev; |
74 | struct media_intf_devnode *ctl_intf_media_devnode; | |
6aa87001 KK |
75 | |
76 | unsigned int num_intf_to_ctrl; | |
77 | struct snd_intf_to_ctrl intf_to_ctrl[MAX_CARD_INTERFACES]; | |
1da177e4 LT |
78 | }; |
79 | ||
5fb45414 TI |
80 | #define USB_AUDIO_IFACE_UNUSED ((void *)-1L) |
81 | ||
0ba41d91 TI |
82 | #define usb_audio_err(chip, fmt, args...) \ |
83 | dev_err(&(chip)->dev->dev, fmt, ##args) | |
2db2be56 CD |
84 | #define usb_audio_err_ratelimited(chip, fmt, args...) \ |
85 | dev_err_ratelimited(&(chip)->dev->dev, fmt, ##args) | |
0ba41d91 TI |
86 | #define usb_audio_warn(chip, fmt, args...) \ |
87 | dev_warn(&(chip)->dev->dev, fmt, ##args) | |
88 | #define usb_audio_info(chip, fmt, args...) \ | |
89 | dev_info(&(chip)->dev->dev, fmt, ##args) | |
90 | #define usb_audio_dbg(chip, fmt, args...) \ | |
91 | dev_dbg(&(chip)->dev->dev, fmt, ##args) | |
92 | ||
1da177e4 LT |
93 | /* |
94 | * Information about devices with broken descriptors | |
95 | */ | |
96 | ||
97 | /* special values for .ifnum */ | |
d7631453 | 98 | #define QUIRK_NODEV_INTERFACE -3 /* return -ENODEV */ |
1da177e4 LT |
99 | #define QUIRK_NO_INTERFACE -2 |
100 | #define QUIRK_ANY_INTERFACE -1 | |
101 | ||
854af957 CL |
102 | enum quirk_type { |
103 | QUIRK_IGNORE_INTERFACE, | |
104 | QUIRK_COMPOSITE, | |
aafe77cc | 105 | QUIRK_AUTODETECT, |
854af957 CL |
106 | QUIRK_MIDI_STANDARD_INTERFACE, |
107 | QUIRK_MIDI_FIXED_ENDPOINT, | |
108 | QUIRK_MIDI_YAMAHA, | |
aafe77cc | 109 | QUIRK_MIDI_ROLAND, |
854af957 CL |
110 | QUIRK_MIDI_MIDIMAN, |
111 | QUIRK_MIDI_NOVATION, | |
c7f57216 | 112 | QUIRK_MIDI_RAW_BYTES, |
854af957 | 113 | QUIRK_MIDI_EMAGIC, |
cc7a59bd | 114 | QUIRK_MIDI_CME, |
4434ade8 | 115 | QUIRK_MIDI_AKAI, |
030a07e4 | 116 | QUIRK_MIDI_US122L, |
1ef0e0a0 | 117 | QUIRK_MIDI_FTDI, |
1ca8b201 | 118 | QUIRK_MIDI_CH345, |
854af957 CL |
119 | QUIRK_AUDIO_STANDARD_INTERFACE, |
120 | QUIRK_AUDIO_FIXED_ENDPOINT, | |
310e0dc0 | 121 | QUIRK_AUDIO_EDIROL_UAXX, |
014950b0 | 122 | QUIRK_AUDIO_STANDARD_MIXER, |
854af957 CL |
123 | |
124 | QUIRK_TYPE_COUNT | |
125 | }; | |
1da177e4 | 126 | |
1da177e4 LT |
127 | struct snd_usb_audio_quirk { |
128 | const char *vendor_name; | |
129 | const char *product_name; | |
130 | int16_t ifnum; | |
854af957 | 131 | uint16_t type; |
1da177e4 LT |
132 | const void *data; |
133 | }; | |
134 | ||
f4950882 | 135 | #define combine_word(s) ((*(s)) | ((unsigned int)(s)[1] << 8)) |
1da177e4 LT |
136 | #define combine_triple(s) (combine_word(s) | ((unsigned int)(s)[2] << 16)) |
137 | #define combine_quad(s) (combine_triple(s) | ((unsigned int)(s)[3] << 24)) | |
138 | ||
47ab1545 TI |
139 | int snd_usb_lock_shutdown(struct snd_usb_audio *chip); |
140 | void snd_usb_unlock_shutdown(struct snd_usb_audio *chip); | |
141 | ||
f274baa4 | 142 | extern bool snd_usb_use_vmalloc; |
f35ef592 | 143 | extern bool snd_usb_skip_validation; |
f274baa4 | 144 | |
4d4dee0a TI |
145 | /* |
146 | * Driver behavior quirk flags, stored in chip->quirk_flags | |
147 | * | |
148 | * QUIRK_FLAG_GET_SAMPLE_RATE: | |
149 | * Skip reading sample rate for devices, as some devices behave inconsistently | |
150 | * or return error | |
ce47d47e TI |
151 | * QUIRK_FLAG_SHARE_MEDIA_DEVICE: |
152 | * Create Media Controller API entries | |
af158a7f TI |
153 | * QUIRK_FLAG_ALIGN_TRANSFER: |
154 | * Allow alignment on audio sub-slot (channel samples) rather than on audio | |
155 | * slots (audio frames) | |
c1b034a4 TI |
156 | * QUIRK_TX_LENGTH: |
157 | * Add length specifier to transfers | |
019c7f91 TI |
158 | * QUIRK_FLAG_PLAYBACK_FIRST: |
159 | * Start playback stream at first even in implement feedback mode | |
f21dca85 TI |
160 | * QUIRK_FLAG_SKIP_CLOCK_SELECTOR: |
161 | * Skip clock selector setup; the device may reset to invalid state | |
162 | * QUIRK_FLAG_IGNORE_CLOCK_SOURCE: | |
163 | * Ignore errors from clock source search; i.e. hardcoded clock | |
2de00d5a TI |
164 | * QUIRK_FLAG_ITF_USB_DSD_DAC: |
165 | * Indicates the device is for ITF-USB DSD based DACs that need a vendor cmd | |
166 | * to switch between PCM and native DSD mode | |
f7483854 TI |
167 | * QUIRK_FLAG_CTL_MSG_DELAY: |
168 | * Add a delay of 20ms at each control message handling | |
169 | * QUIRK_FLAG_CTL_MSG_DELAY_1M: | |
170 | * Add a delay of 1-2ms at each control message handling | |
171 | * QUIRK_FLAG_CTL_MSG_DELAY_5M: | |
172 | * Add a delay of 5-6ms at each control message handling | |
1f074fe5 TI |
173 | * QUIRK_FLAG_IFACE_DELAY: |
174 | * Add a delay of 50ms at each interface setup | |
8bfe17ad TI |
175 | * QUIRK_FLAG_VALIDATE_RATES: |
176 | * Perform sample rate validations at probe | |
44e6fc64 TI |
177 | * QUIRK_FLAG_DISABLE_AUTOSUSPEND: |
178 | * Disable runtime PM autosuspend | |
3c69dc91 TI |
179 | * QUIRK_FLAG_IGNORE_CTL_ERROR: |
180 | * Ignore errors for mixer access | |
68e851ee TI |
181 | * QUIRK_FLAG_DSD_RAW: |
182 | * Support generic DSD raw U32_BE format | |
6e413409 TI |
183 | * QUIRK_FLAG_SET_IFACE_FIRST: |
184 | * Set up the interface at first like UAC1 | |
0f1f7a66 TI |
185 | * QUIRK_FLAG_GENERIC_IMPLICIT_FB |
186 | * Apply the generic implicit feedback sync mode (same as implicit_fb=1 option) | |
187 | * QUIRK_FLAG_SKIP_IMPLICIT_FB | |
188 | * Don't apply implicit feedback sync mode | |
bf990c10 AC |
189 | * QUIRK_FLAG_IFACE_SKIP_CLOSE |
190 | * Don't closed interface during setting sample rate | |
67df411d JK |
191 | * QUIRK_FLAG_FORCE_IFACE_RESET |
192 | * Force an interface reset whenever stopping & restarting a stream | |
193 | * (e.g. after xrun) | |
fd28941c JK |
194 | * QUIRK_FLAG_FIXED_RATE |
195 | * Do not set PCM rate (frequency) when only one rate is available | |
196 | * for the given endpoint. | |
4d4dee0a TI |
197 | */ |
198 | ||
199 | #define QUIRK_FLAG_GET_SAMPLE_RATE (1U << 0) | |
ce47d47e | 200 | #define QUIRK_FLAG_SHARE_MEDIA_DEVICE (1U << 1) |
af158a7f | 201 | #define QUIRK_FLAG_ALIGN_TRANSFER (1U << 2) |
c1b034a4 | 202 | #define QUIRK_FLAG_TX_LENGTH (1U << 3) |
019c7f91 | 203 | #define QUIRK_FLAG_PLAYBACK_FIRST (1U << 4) |
f21dca85 TI |
204 | #define QUIRK_FLAG_SKIP_CLOCK_SELECTOR (1U << 5) |
205 | #define QUIRK_FLAG_IGNORE_CLOCK_SOURCE (1U << 6) | |
2de00d5a | 206 | #define QUIRK_FLAG_ITF_USB_DSD_DAC (1U << 7) |
f7483854 TI |
207 | #define QUIRK_FLAG_CTL_MSG_DELAY (1U << 8) |
208 | #define QUIRK_FLAG_CTL_MSG_DELAY_1M (1U << 9) | |
209 | #define QUIRK_FLAG_CTL_MSG_DELAY_5M (1U << 10) | |
1f074fe5 | 210 | #define QUIRK_FLAG_IFACE_DELAY (1U << 11) |
8bfe17ad | 211 | #define QUIRK_FLAG_VALIDATE_RATES (1U << 12) |
44e6fc64 | 212 | #define QUIRK_FLAG_DISABLE_AUTOSUSPEND (1U << 13) |
3c69dc91 | 213 | #define QUIRK_FLAG_IGNORE_CTL_ERROR (1U << 14) |
68e851ee | 214 | #define QUIRK_FLAG_DSD_RAW (1U << 15) |
6e413409 | 215 | #define QUIRK_FLAG_SET_IFACE_FIRST (1U << 16) |
0f1f7a66 TI |
216 | #define QUIRK_FLAG_GENERIC_IMPLICIT_FB (1U << 17) |
217 | #define QUIRK_FLAG_SKIP_IMPLICIT_FB (1U << 18) | |
bf990c10 | 218 | #define QUIRK_FLAG_IFACE_SKIP_CLOSE (1U << 19) |
67df411d | 219 | #define QUIRK_FLAG_FORCE_IFACE_RESET (1U << 20) |
fd28941c | 220 | #define QUIRK_FLAG_FIXED_RATE (1U << 21) |
4d4dee0a | 221 | |
1da177e4 | 222 | #endif /* __USBAUDIO_H */ |