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 #include <linux/android_kabi.h> 16 17 /* 18 * 19 */ 20 21 struct media_device; 22 struct media_intf_devnode; 23 24 #define MAX_CARD_INTERFACES 16 25 26 struct snd_usb_audio { 27 int index; 28 struct usb_device *dev; 29 struct snd_card *card; 30 struct usb_interface *intf[MAX_CARD_INTERFACES]; 31 u32 usb_id; 32 uint16_t quirk_type; 33 struct mutex mutex; 34 unsigned int system_suspend; 35 atomic_t active; 36 atomic_t shutdown; 37 atomic_t usage_count; 38 wait_queue_head_t shutdown_wait; 39 unsigned int quirk_flags; 40 unsigned int need_delayed_register:1; /* warn for delayed registration */ 41 int num_interfaces; 42 int last_iface; 43 int num_suspended_intf; 44 int sample_rate_read_error; 45 46 int badd_profile; /* UAC3 BADD profile */ 47 48 struct list_head pcm_list; /* list of pcm streams */ 49 struct list_head ep_list; /* list of audio-related endpoints */ 50 struct list_head iface_ref_list; /* list of interface refcounts */ 51 int pcm_devs; 52 53 struct list_head midi_list; /* list of midi interfaces */ 54 55 struct list_head mixer_list; /* list of mixer interfaces */ 56 57 int setup; /* from the 'device_setup' module param */ 58 bool generic_implicit_fb; /* from the 'implicit_fb' module param */ 59 bool autoclock; /* from the 'autoclock' module param */ 60 61 bool lowlatency; /* from the 'lowlatency' module param */ 62 struct usb_host_interface *ctrl_intf; /* the audio control interface */ 63 struct media_device *media_dev; 64 struct media_intf_devnode *ctl_intf_media_devnode; 65 66 ANDROID_KABI_RESERVE(1); 67 ANDROID_KABI_RESERVE(2); 68 ANDROID_KABI_RESERVE(3); 69 ANDROID_KABI_RESERVE(4); 70 }; 71 72 #define USB_AUDIO_IFACE_UNUSED ((void *)-1L) 73 74 #define usb_audio_err(chip, fmt, args...) \ 75 dev_err(&(chip)->dev->dev, fmt, ##args) 76 #define usb_audio_warn(chip, fmt, args...) \ 77 dev_warn(&(chip)->dev->dev, fmt, ##args) 78 #define usb_audio_info(chip, fmt, args...) \ 79 dev_info(&(chip)->dev->dev, fmt, ##args) 80 #define usb_audio_dbg(chip, fmt, args...) \ 81 dev_dbg(&(chip)->dev->dev, fmt, ##args) 82 83 /* 84 * Information about devices with broken descriptors 85 */ 86 87 /* special values for .ifnum */ 88 #define QUIRK_NODEV_INTERFACE -3 /* return -ENODEV */ 89 #define QUIRK_NO_INTERFACE -2 90 #define QUIRK_ANY_INTERFACE -1 91 92 enum quirk_type { 93 QUIRK_IGNORE_INTERFACE, 94 QUIRK_COMPOSITE, 95 QUIRK_AUTODETECT, 96 QUIRK_MIDI_STANDARD_INTERFACE, 97 QUIRK_MIDI_FIXED_ENDPOINT, 98 QUIRK_MIDI_YAMAHA, 99 QUIRK_MIDI_ROLAND, 100 QUIRK_MIDI_MIDIMAN, 101 QUIRK_MIDI_NOVATION, 102 QUIRK_MIDI_RAW_BYTES, 103 QUIRK_MIDI_EMAGIC, 104 QUIRK_MIDI_CME, 105 QUIRK_MIDI_AKAI, 106 QUIRK_MIDI_US122L, 107 QUIRK_MIDI_FTDI, 108 QUIRK_MIDI_CH345, 109 QUIRK_AUDIO_STANDARD_INTERFACE, 110 QUIRK_AUDIO_FIXED_ENDPOINT, 111 QUIRK_AUDIO_EDIROL_UAXX, 112 QUIRK_AUDIO_STANDARD_MIXER, 113 114 QUIRK_TYPE_COUNT 115 }; 116 117 struct snd_usb_audio_quirk { 118 const char *vendor_name; 119 const char *product_name; 120 int16_t ifnum; 121 uint16_t type; 122 const void *data; 123 }; 124 125 #define combine_word(s) ((*(s)) | ((unsigned int)(s)[1] << 8)) 126 #define combine_triple(s) (combine_word(s) | ((unsigned int)(s)[2] << 16)) 127 #define combine_quad(s) (combine_triple(s) | ((unsigned int)(s)[3] << 24)) 128 129 int snd_usb_lock_shutdown(struct snd_usb_audio *chip); 130 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip); 131 132 extern bool snd_usb_use_vmalloc; 133 extern bool snd_usb_skip_validation; 134 135 /* 136 * Driver behavior quirk flags, stored in chip->quirk_flags 137 * 138 * QUIRK_FLAG_GET_SAMPLE_RATE: 139 * Skip reading sample rate for devices, as some devices behave inconsistently 140 * or return error 141 * QUIRK_FLAG_SHARE_MEDIA_DEVICE: 142 * Create Media Controller API entries 143 * QUIRK_FLAG_ALIGN_TRANSFER: 144 * Allow alignment on audio sub-slot (channel samples) rather than on audio 145 * slots (audio frames) 146 * QUIRK_TX_LENGTH: 147 * Add length specifier to transfers 148 * QUIRK_FLAG_PLAYBACK_FIRST: 149 * Start playback stream at first even in implement feedback mode 150 * QUIRK_FLAG_SKIP_CLOCK_SELECTOR: 151 * Skip clock selector setup; the device may reset to invalid state 152 * QUIRK_FLAG_IGNORE_CLOCK_SOURCE: 153 * Ignore errors from clock source search; i.e. hardcoded clock 154 * QUIRK_FLAG_ITF_USB_DSD_DAC: 155 * Indicates the device is for ITF-USB DSD based DACs that need a vendor cmd 156 * to switch between PCM and native DSD mode 157 * QUIRK_FLAG_CTL_MSG_DELAY: 158 * Add a delay of 20ms at each control message handling 159 * QUIRK_FLAG_CTL_MSG_DELAY_1M: 160 * Add a delay of 1-2ms at each control message handling 161 * QUIRK_FLAG_CTL_MSG_DELAY_5M: 162 * Add a delay of 5-6ms at each control message handling 163 * QUIRK_FLAG_IFACE_DELAY: 164 * Add a delay of 50ms at each interface setup 165 * QUIRK_FLAG_VALIDATE_RATES: 166 * Perform sample rate validations at probe 167 * QUIRK_FLAG_DISABLE_AUTOSUSPEND: 168 * Disable runtime PM autosuspend 169 * QUIRK_FLAG_IGNORE_CTL_ERROR: 170 * Ignore errors for mixer access 171 * QUIRK_FLAG_DSD_RAW: 172 * Support generic DSD raw U32_BE format 173 * QUIRK_FLAG_SET_IFACE_FIRST: 174 * Set up the interface at first like UAC1 175 * QUIRK_FLAG_GENERIC_IMPLICIT_FB 176 * Apply the generic implicit feedback sync mode (same as implicit_fb=1 option) 177 * QUIRK_FLAG_SKIP_IMPLICIT_FB 178 * Don't apply implicit feedback sync mode 179 * QUIRK_FLAG_IFACE_SKIP_CLOSE 180 * Don't closed interface during setting sample rate 181 */ 182 183 #define QUIRK_FLAG_GET_SAMPLE_RATE (1U << 0) 184 #define QUIRK_FLAG_SHARE_MEDIA_DEVICE (1U << 1) 185 #define QUIRK_FLAG_ALIGN_TRANSFER (1U << 2) 186 #define QUIRK_FLAG_TX_LENGTH (1U << 3) 187 #define QUIRK_FLAG_PLAYBACK_FIRST (1U << 4) 188 #define QUIRK_FLAG_SKIP_CLOCK_SELECTOR (1U << 5) 189 #define QUIRK_FLAG_IGNORE_CLOCK_SOURCE (1U << 6) 190 #define QUIRK_FLAG_ITF_USB_DSD_DAC (1U << 7) 191 #define QUIRK_FLAG_CTL_MSG_DELAY (1U << 8) 192 #define QUIRK_FLAG_CTL_MSG_DELAY_1M (1U << 9) 193 #define QUIRK_FLAG_CTL_MSG_DELAY_5M (1U << 10) 194 #define QUIRK_FLAG_IFACE_DELAY (1U << 11) 195 #define QUIRK_FLAG_VALIDATE_RATES (1U << 12) 196 #define QUIRK_FLAG_DISABLE_AUTOSUSPEND (1U << 13) 197 #define QUIRK_FLAG_IGNORE_CTL_ERROR (1U << 14) 198 #define QUIRK_FLAG_DSD_RAW (1U << 15) 199 #define QUIRK_FLAG_SET_IFACE_FIRST (1U << 16) 200 #define QUIRK_FLAG_GENERIC_IMPLICIT_FB (1U << 17) 201 #define QUIRK_FLAG_SKIP_IMPLICIT_FB (1U << 18) 202 #define QUIRK_FLAG_IFACE_SKIP_CLOSE (1U << 19) 203 204 #endif /* __USBAUDIO_H */ 205