LXR linux/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) (((vendor) << 16) | (product))
  12#define USB_ID_VENDOR(id) ((id) >> 16)
  13#define USB_ID_PRODUCT(id) ((u16)(id))
  14
  15/*
  16 *
  17 */
  18
  19struct media_device;
  20struct media_intf_devnode;
  21
  22#define MAX_CARD_INTERFACES     16
  23
  24struct 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        struct mutex mutex;
  31        unsigned int system_suspend;
  32        atomic_t active;
  33        atomic_t shutdown;
  34        atomic_t usage_count;
  35        wait_queue_head_t shutdown_wait;
  36        unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
  37        unsigned int tx_length_quirk:1; /* Put length specifier in transfers */
  38        unsigned int need_delayed_register:1; /* warn for delayed registration */
  39        int num_interfaces;
  40        int num_suspended_intf;
  41        int sample_rate_read_error;
  42
  43        int badd_profile;               /* UAC3 BADD profile */
  44
  45        struct list_head pcm_list;      /* list of pcm streams */
  46        struct list_head ep_list;       /* list of audio-related endpoints */
  47        struct list_head iface_ref_list; /* list of interface refcounts */
  48        int pcm_devs;
  49
  50        struct list_head midi_list;     /* list of midi interfaces */
  51
  52        struct list_head mixer_list;    /* list of mixer interfaces */
  53
  54        int setup;                      /* from the 'device_setup' module param */
  55        bool generic_implicit_fb;       /* from the 'implicit_fb' module param */
  56        bool autoclock;                 /* from the 'autoclock' module param */
  57
  58        struct usb_host_interface *ctrl_intf;   /* the audio control interface */
  59        struct media_device *media_dev;
  60        struct media_intf_devnode *ctl_intf_media_devnode;
  61};
  62
  63#define usb_audio_err(chip, fmt, args...) \
  64        dev_err(&(chip)->dev->dev, fmt, ##args)
  65#define usb_audio_warn(chip, fmt, args...) \
  66        dev_warn(&(chip)->dev->dev, fmt, ##args)
  67#define usb_audio_info(chip, fmt, args...) \
  68        dev_info(&(chip)->dev->dev, fmt, ##args)
  69#define usb_audio_dbg(chip, fmt, args...) \
  70        dev_dbg(&(chip)->dev->dev, fmt, ##args)
  71
  72/*
  73 * Information about devices with broken descriptors
  74 */
  75
  76/* special values for .ifnum */
  77#define QUIRK_NO_INTERFACE              -2
  78#define QUIRK_ANY_INTERFACE             -1
  79
  80enum quirk_type {
  81        QUIRK_IGNORE_INTERFACE,
  82        QUIRK_COMPOSITE,
  83        QUIRK_AUTODETECT,
  84        QUIRK_MIDI_STANDARD_INTERFACE,
  85        QUIRK_MIDI_FIXED_ENDPOINT,
  86        QUIRK_MIDI_YAMAHA,
  87        QUIRK_MIDI_ROLAND,
  88        QUIRK_MIDI_MIDIMAN,
  89        QUIRK_MIDI_NOVATION,
  90        QUIRK_MIDI_RAW_BYTES,
  91        QUIRK_MIDI_EMAGIC,
  92        QUIRK_MIDI_CME,
  93        QUIRK_MIDI_AKAI,
  94        QUIRK_MIDI_US122L,
  95        QUIRK_MIDI_FTDI,
  96        QUIRK_MIDI_CH345,
  97        QUIRK_AUDIO_STANDARD_INTERFACE,
  98        QUIRK_AUDIO_FIXED_ENDPOINT,
  99        QUIRK_AUDIO_EDIROL_UAXX,
 100        QUIRK_AUDIO_ALIGN_TRANSFER,
 101        QUIRK_AUDIO_STANDARD_MIXER,
 102        QUIRK_SETUP_FMT_AFTER_RESUME,
 103        QUIRK_SETUP_DISABLE_AUTOSUSPEND,
 104
 105        QUIRK_TYPE_COUNT
 106};
 107
 108struct snd_usb_audio_quirk {
 109        const char *vendor_name;
 110        const char *product_name;
 111        int16_t ifnum;
 112        uint16_t type;
 113        bool shares_media_device;
 114        const void *data;
 115};
 116
 117#define combine_word(s)    ((*(s)) | ((unsigned int)(s)[1] << 8))
 118#define combine_triple(s)  (combine_word(s) | ((unsigned int)(s)[2] << 16))
 119#define combine_quad(s)    (combine_triple(s) | ((unsigned int)(s)[3] << 24))
 120
 121int snd_usb_lock_shutdown(struct snd_usb_audio *chip);
 122void snd_usb_unlock_shutdown(struct snd_usb_audio *chip);
 123
 124extern bool snd_usb_use_vmalloc;
 125extern bool snd_usb_skip_validation;
 126
 127#endif /* __USBAUDIO_H */
 128