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) (((unsigned int)(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 /* 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 33 struct snd_usb_audio { 34 int index; 35 struct usb_device *dev; 36 struct snd_card *card; 37 struct usb_interface *intf[MAX_CARD_INTERFACES]; 38 u32 usb_id; 39 uint16_t quirk_type; 40 struct mutex mutex; 41 unsigned int system_suspend; 42 atomic_t active; 43 atomic_t shutdown; 44 atomic_t usage_count; 45 wait_queue_head_t shutdown_wait; 46 unsigned int quirk_flags; 47 unsigned int need_delayed_register:1; /* warn for delayed registration */ 48 int num_interfaces; 49 int last_iface; 50 int num_suspended_intf; 51 int sample_rate_read_error; 52 53 int badd_profile; /* UAC3 BADD profile */ 54 55 struct list_head pcm_list; /* list of pcm streams */ 56 struct list_head ep_list; /* list of audio-related endpoints */ 57 struct list_head iface_ref_list; /* list of interface refcounts */ 58 struct list_head clock_ref_list; /* list of clock refcounts */ 59 int pcm_devs; 60 61 unsigned int num_rawmidis; /* number of created rawmidi devices */ 62 struct list_head midi_list; /* list of midi interfaces */ 63 struct list_head midi_v2_list; /* list of MIDI 2 interfaces */ 64 65 struct list_head mixer_list; /* list of mixer interfaces */ 66 67 int setup; /* from the 'device_setup' module param */ 68 bool generic_implicit_fb; /* from the 'implicit_fb' module param */ 69 bool autoclock; /* from the 'autoclock' module param */ 70 71 bool lowlatency; /* from the 'lowlatency' module param */ 72 struct usb_host_interface *ctrl_intf; /* the audio control interface */ 73 struct media_device *media_dev; 74 struct media_intf_devnode *ctl_intf_media_devnode; 75 76 unsigned int num_intf_to_ctrl; 77 struct snd_intf_to_ctrl intf_to_ctrl[MAX_CARD_INTERFACES]; 78 }; 79 80 #define USB_AUDIO_IFACE_UNUSED ((void *)-1L) 81 82 #define usb_audio_err(chip, fmt, args...) \ 83 dev_err(&(chip)->dev->dev, fmt, ##args) 84 #define usb_audio_err_ratelimited(chip, fmt, args...) \ 85 dev_err_ratelimited(&(chip)->dev->dev, fmt, ##args) 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 93 /* 94 * Information about devices with broken descriptors 95 */ 96 97 /* special values for .ifnum */ 98 #define QUIRK_NODEV_INTERFACE -3 /* return -ENODEV */ 99 #define QUIRK_NO_INTERFACE -2 100 #define QUIRK_ANY_INTERFACE -1 101 102 enum quirk_type { 103 QUIRK_IGNORE_INTERFACE, 104 QUIRK_COMPOSITE, 105 QUIRK_AUTODETECT, 106 QUIRK_MIDI_STANDARD_INTERFACE, 107 QUIRK_MIDI_FIXED_ENDPOINT, 108 QUIRK_MIDI_YAMAHA, 109 QUIRK_MIDI_ROLAND, 110 QUIRK_MIDI_MIDIMAN, 111 QUIRK_MIDI_NOVATION, 112 QUIRK_MIDI_RAW_BYTES, 113 QUIRK_MIDI_EMAGIC, 114 QUIRK_MIDI_CME, 115 QUIRK_MIDI_AKAI, 116 QUIRK_MIDI_US122L, 117 QUIRK_MIDI_FTDI, 118 QUIRK_MIDI_CH345, 119 QUIRK_AUDIO_STANDARD_INTERFACE, 120 QUIRK_AUDIO_FIXED_ENDPOINT, 121 QUIRK_AUDIO_EDIROL_UAXX, 122 QUIRK_AUDIO_STANDARD_MIXER, 123 124 QUIRK_TYPE_COUNT 125 }; 126 127 struct snd_usb_audio_quirk { 128 const char *vendor_name; 129 const char *product_name; 130 int16_t ifnum; 131 uint16_t type; 132 const void *data; 133 }; 134 135 #define combine_word(s) ((*(s)) | ((unsigned int)(s)[1] << 8)) 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 139 int snd_usb_lock_shutdown(struct snd_usb_audio *chip); 140 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip); 141 142 extern bool snd_usb_use_vmalloc; 143 extern bool snd_usb_skip_validation; 144 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 151 * QUIRK_FLAG_SHARE_MEDIA_DEVICE: 152 * Create Media Controller API entries 153 * QUIRK_FLAG_ALIGN_TRANSFER: 154 * Allow alignment on audio sub-slot (channel samples) rather than on audio 155 * slots (audio frames) 156 * QUIRK_TX_LENGTH: 157 * Add length specifier to transfers 158 * QUIRK_FLAG_PLAYBACK_FIRST: 159 * Start playback stream at first even in implement feedback mode 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 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 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 173 * QUIRK_FLAG_IFACE_DELAY: 174 * Add a delay of 50ms at each interface setup 175 * QUIRK_FLAG_VALIDATE_RATES: 176 * Perform sample rate validations at probe 177 * QUIRK_FLAG_DISABLE_AUTOSUSPEND: 178 * Disable runtime PM autosuspend 179 * QUIRK_FLAG_IGNORE_CTL_ERROR: 180 * Ignore errors for mixer access 181 * QUIRK_FLAG_DSD_RAW: 182 * Support generic DSD raw U32_BE format 183 * QUIRK_FLAG_SET_IFACE_FIRST: 184 * Set up the interface at first like UAC1 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 189 * QUIRK_FLAG_IFACE_SKIP_CLOSE 190 * Don't closed interface during setting sample rate 191 * QUIRK_FLAG_FORCE_IFACE_RESET 192 * Force an interface reset whenever stopping & restarting a stream 193 * (e.g. after xrun) 194 * QUIRK_FLAG_FIXED_RATE 195 * Do not set PCM rate (frequency) when only one rate is available 196 * for the given endpoint. 197 */ 198 199 #define QUIRK_FLAG_GET_SAMPLE_RATE (1U << 0) 200 #define QUIRK_FLAG_SHARE_MEDIA_DEVICE (1U << 1) 201 #define QUIRK_FLAG_ALIGN_TRANSFER (1U << 2) 202 #define QUIRK_FLAG_TX_LENGTH (1U << 3) 203 #define QUIRK_FLAG_PLAYBACK_FIRST (1U << 4) 204 #define QUIRK_FLAG_SKIP_CLOCK_SELECTOR (1U << 5) 205 #define QUIRK_FLAG_IGNORE_CLOCK_SOURCE (1U << 6) 206 #define QUIRK_FLAG_ITF_USB_DSD_DAC (1U << 7) 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) 210 #define QUIRK_FLAG_IFACE_DELAY (1U << 11) 211 #define QUIRK_FLAG_VALIDATE_RATES (1U << 12) 212 #define QUIRK_FLAG_DISABLE_AUTOSUSPEND (1U << 13) 213 #define QUIRK_FLAG_IGNORE_CTL_ERROR (1U << 14) 214 #define QUIRK_FLAG_DSD_RAW (1U << 15) 215 #define QUIRK_FLAG_SET_IFACE_FIRST (1U << 16) 216 #define QUIRK_FLAG_GENERIC_IMPLICIT_FB (1U << 17) 217 #define QUIRK_FLAG_SKIP_IMPLICIT_FB (1U << 18) 218 #define QUIRK_FLAG_IFACE_SKIP_CLOSE (1U << 19) 219 #define QUIRK_FLAG_FORCE_IFACE_RESET (1U << 20) 220 #define QUIRK_FLAG_FIXED_RATE (1U << 21) 221 222 #endif /* __USBAUDIO_H */ 223