sound/usb/usbaudio.h

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