blob: 0968a45c8925b5eede2ccf0f62970fac48ff74ea [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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
Clemens Ladisch27d10f52005-05-02 08:51:26 +020024/* 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070029/*
Daniel Macke5779992010-03-04 19:46:13 +010030 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 */
32
Shuah Khan66354f12019-04-01 20:40:22 -040033struct media_device;
34struct media_intf_devnode;
35
Linus Torvalds1da177e2005-04-16 15:20:36 -070036struct snd_usb_audio {
37 int index;
38 struct usb_device *dev;
Takashi Iwai86e07d32005-11-17 15:08:02 +010039 struct snd_card *card;
Oliver Neukum88a85162011-03-11 14:51:12 +010040 struct usb_interface *pm_intf;
Clemens Ladisch27d10f52005-05-02 08:51:26 +020041 u32 usb_id;
Daniel Mack596580d2012-04-12 13:51:10 +020042 struct mutex mutex;
Oliver Neukum88a85162011-03-11 14:51:12 +010043 unsigned int autosuspended:1;
Takashi Iwai47ab1542015-08-25 16:09:00 +020044 atomic_t active;
45 atomic_t shutdown;
46 atomic_t usage_count;
47 wait_queue_head_t shutdown_wait;
John S. Gruber98e89f62009-12-27 12:19:58 -050048 unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
Ricard Wanderlofe0570442015-10-19 08:52:53 +020049 unsigned int tx_length_quirk:1; /* Put length specifier in transfers */
Oliver Neukum88a85162011-03-11 14:51:12 +010050
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 int num_interfaces;
Oliver Neukumf85bf292007-12-14 14:42:41 +010052 int num_suspended_intf;
Takashi Iwai57dd5412016-04-29 11:49:04 +020053 int sample_rate_read_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Ruslan Bilovol17156f22018-05-04 04:24:04 +030055 int badd_profile; /* UAC3 BADD profile */
56
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 struct list_head pcm_list; /* list of pcm streams */
Daniel Mack8fdff6a2012-04-12 13:51:11 +020058 struct list_head ep_list; /* list of audio-related endpoints */
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 int pcm_devs;
60
61 struct list_head midi_list; /* list of midi interfaces */
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
Clemens Ladisch84957a82005-04-29 16:23:13 +020063 struct list_head mixer_list; /* list of mixer interfaces */
Daniel Macke5779992010-03-04 19:46:13 +010064
65 int setup; /* from the 'device_setup' module param */
Eldad Zackef02e292013-04-03 23:18:56 +020066 bool autoclock; /* from the 'autoclock' module param */
Takashi Iwai8a463222018-05-02 10:04:27 +020067 bool keep_iface; /* keep interface/altset after closing
68 * or parameter change
69 */
Daniel Mack79f920f2010-05-31 14:51:31 +020070
71 struct usb_host_interface *ctrl_intf; /* the audio control interface */
Shuah Khan66354f12019-04-01 20:40:22 -040072 struct media_device *media_dev;
73 struct media_intf_devnode *ctl_intf_media_devnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -070074};
75
Takashi Iwai0ba41d92014-02-26 13:02:17 +010076#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
Linus Torvalds1da177e2005-04-16 15:20:36 -070085/*
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
Clemens Ladisch854af952005-07-25 16:19:10 +020093enum quirk_type {
94 QUIRK_IGNORE_INTERFACE,
95 QUIRK_COMPOSITE,
Clemens Ladischaafe77c2013-03-31 23:43:12 +020096 QUIRK_AUTODETECT,
Clemens Ladisch854af952005-07-25 16:19:10 +020097 QUIRK_MIDI_STANDARD_INTERFACE,
98 QUIRK_MIDI_FIXED_ENDPOINT,
99 QUIRK_MIDI_YAMAHA,
Clemens Ladischaafe77c2013-03-31 23:43:12 +0200100 QUIRK_MIDI_ROLAND,
Clemens Ladisch854af952005-07-25 16:19:10 +0200101 QUIRK_MIDI_MIDIMAN,
102 QUIRK_MIDI_NOVATION,
Clemens Ladischc7f57212010-10-22 18:20:48 +0200103 QUIRK_MIDI_RAW_BYTES,
Clemens Ladisch854af952005-07-25 16:19:10 +0200104 QUIRK_MIDI_EMAGIC,
Clemens Ladischcc7a59b2006-02-07 17:11:06 +0100105 QUIRK_MIDI_CME,
Krzysztof Foltman4434ade2010-05-20 20:31:10 +0100106 QUIRK_MIDI_AKAI,
Karsten Wiese030a07e42008-07-30 15:13:29 +0200107 QUIRK_MIDI_US122L,
Kristian Amlie1ef0e0a2011-08-26 13:19:49 +0200108 QUIRK_MIDI_FTDI,
Clemens Ladisch1ca8b202015-11-15 22:38:29 +0100109 QUIRK_MIDI_CH345,
Clemens Ladisch854af952005-07-25 16:19:10 +0200110 QUIRK_AUDIO_STANDARD_INTERFACE,
111 QUIRK_AUDIO_FIXED_ENDPOINT,
Pedro Lopez-Cabanillas310e0dc2008-10-04 16:27:36 +0200112 QUIRK_AUDIO_EDIROL_UAXX,
John S. Gruber52a7a582009-12-27 12:19:59 -0500113 QUIRK_AUDIO_ALIGN_TRANSFER,
Daniel Mack014950b2011-05-25 09:09:02 +0200114 QUIRK_AUDIO_STANDARD_MIXER,
Clemens Ladisch854af952005-07-25 16:19:10 +0200115
116 QUIRK_TYPE_COUNT
117};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119struct snd_usb_audio_quirk {
120 const char *vendor_name;
121 const char *product_name;
Takashi Iwai07eca5f2018-05-02 14:45:37 +0200122 const char *profile_name; /* override the card->longname */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 int16_t ifnum;
Clemens Ladisch854af952005-07-25 16:19:10 +0200124 uint16_t type;
Shuah Khan66354f12019-04-01 20:40:22 -0400125 bool shares_media_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 const void *data;
127};
128
Julian Anastasovf4950882009-11-06 23:44:53 +0200129#define combine_word(s) ((*(s)) | ((unsigned int)(s)[1] << 8))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130#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
Takashi Iwai47ab1542015-08-25 16:09:00 +0200133int snd_usb_lock_shutdown(struct snd_usb_audio *chip);
134void snd_usb_unlock_shutdown(struct snd_usb_audio *chip);
135
Takashi Iwaif274baa2018-05-27 13:01:17 +0200136extern bool snd_usb_use_vmalloc;
137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138#endif /* __USBAUDIO_H */