sound/usb/usbaudio.h

   1 #ifndef __USBAUDIO_H
   2 #define __USBAUDIO_H
   3 /*
   4  *   (Tentative) USB Audio Driver for ALSA
   5  *
   6  *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
   7  *
   8  *
   9  *   This program is free software; you can redistribute it and/or modify
  10  *   it under the terms of the GNU General Public License as published by
  11  *   the Free Software Foundation; either version 2 of the License, or
  12  *   (at your option) any later version.
  13  *
  14  *   This program is distributed in the hope that it will be useful,
  15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *   GNU General Public License for more details.
  18  *
  19  *   You should have received a copy of the GNU General Public License
  20  *   along with this program; if not, write to the Free Software
  21  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  22  */
  23
  24 /* handling of USB vendor/product ID pairs as 32-bit numbers */
  25 #define USB_ID(vendor, product) (((vendor) << 16) | (product))
  26 #define USB_ID_VENDOR(id) ((id) >> 16)
  27 #define USB_ID_PRODUCT(id) ((u16)(id))
  28
  29 /*
  30  *
  31  */
  32
  33 struct media_device;
  34 struct media_intf_devnode;
  35
  36 struct snd_usb_audio {
  37         int index;
  38         struct usb_device *dev;
  39         struct snd_card *card;
  40         struct usb_interface *pm_intf;
  41         u32 usb_id;
  42         struct mutex mutex;
  43         unsigned int autosuspended:1;
  44         atomic_t active;
  45         atomic_t shutdown;
  46         atomic_t usage_count;
  47         wait_queue_head_t shutdown_wait;
  48         unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
  49         unsigned int tx_length_quirk:1; /* Put length specifier in transfers */
  50
  51         int num_interfaces;
  52         int num_suspended_intf;
  53         int sample_rate_read_error;
  54
  55         int badd_profile;               /* UAC3 BADD profile */
  56
  57         struct list_head pcm_list;      /* list of pcm streams */
  58         struct list_head ep_list;       /* list of audio-related endpoints */
  59         int pcm_devs;
  60
  61         struct list_head midi_list;     /* list of midi interfaces */
  62
  63         struct list_head mixer_list;    /* list of mixer interfaces */
  64
  65         int setup;                      /* from the 'device_setup' module param */
  66         bool autoclock;                 /* from the 'autoclock' module param */
  67         bool keep_iface;                /* keep interface/altset after closing
  68                                          * or parameter change
  69                                          */
  70
  71         struct usb_host_interface *ctrl_intf;   /* the audio control interface */
  72         struct media_device *media_dev;
  73         struct media_intf_devnode *ctl_intf_media_devnode;
  74 };
  75
  76 #define usb_audio_err(chip, fmt, args...) \
  77         dev_err(&(chip)->dev->dev, fmt, ##args)
  78 #define usb_audio_warn(chip, fmt, args...) \
  79         dev_warn(&(chip)->dev->dev, fmt, ##args)
  80 #define usb_audio_info(chip, fmt, args...) \
  81         dev_info(&(chip)->dev->dev, fmt, ##args)
  82 #define usb_audio_dbg(chip, fmt, args...) \
  83         dev_dbg(&(chip)->dev->dev, fmt, ##args)
  84
  85 /*
  86  * Information about devices with broken descriptors
  87  */
  88
  89 /* special values for .ifnum */
  90 #define QUIRK_NO_INTERFACE              -2
  91 #define QUIRK_ANY_INTERFACE             -1
  92
  93 enum quirk_type {
  94         QUIRK_IGNORE_INTERFACE,
  95         QUIRK_COMPOSITE,
  96         QUIRK_AUTODETECT,
  97         QUIRK_MIDI_STANDARD_INTERFACE,
  98         QUIRK_MIDI_FIXED_ENDPOINT,
  99         QUIRK_MIDI_YAMAHA,
 100         QUIRK_MIDI_ROLAND,
 101         QUIRK_MIDI_MIDIMAN,
 102         QUIRK_MIDI_NOVATION,
 103         QUIRK_MIDI_RAW_BYTES,
 104         QUIRK_MIDI_EMAGIC,
 105         QUIRK_MIDI_CME,
 106         QUIRK_MIDI_AKAI,
 107         QUIRK_MIDI_US122L,
 108         QUIRK_MIDI_FTDI,
 109         QUIRK_MIDI_CH345,
 110         QUIRK_AUDIO_STANDARD_INTERFACE,
 111         QUIRK_AUDIO_FIXED_ENDPOINT,
 112         QUIRK_AUDIO_EDIROL_UAXX,
 113         QUIRK_AUDIO_ALIGN_TRANSFER,
 114         QUIRK_AUDIO_STANDARD_MIXER,
 115
 116         QUIRK_TYPE_COUNT
 117 };
 118
 119 struct snd_usb_audio_quirk {
 120         const char *vendor_name;
 121         const char *product_name;
 122         const char *profile_name;       /* override the card->longname */
 123         int16_t ifnum;
 124         uint16_t type;
 125         bool shares_media_device;
 126         const void *data;
 127 };
 128
 129 #define combine_word(s)    ((*(s)) | ((unsigned int)(s)[1] << 8))
 130 #define combine_triple(s)  (combine_word(s) | ((unsigned int)(s)[2] << 16))
 131 #define combine_quad(s)    (combine_triple(s) | ((unsigned int)(s)[3] << 24))
 132
 133 int snd_usb_lock_shutdown(struct snd_usb_audio *chip);
 134 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip);
 135
 136 extern bool snd_usb_use_vmalloc;
 137
 138 #endif /* __USBAUDIO_H */