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