blob: 33a176437e2e4fc34f5064fc23984bab60b22795 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070033struct snd_usb_audio {
34 int index;
35 struct usb_device *dev;
Takashi Iwai86e07d32005-11-17 15:08:02 +010036 struct snd_card *card;
Oliver Neukum88a85162011-03-11 14:51:12 +010037 struct usb_interface *pm_intf;
Clemens Ladisch27d10f52005-05-02 08:51:26 +020038 u32 usb_id;
Daniel Mack596580d2012-04-12 13:51:10 +020039 struct mutex mutex;
Oliver Neukum88a85162011-03-11 14:51:12 +010040 unsigned int autosuspended:1;
Takashi Iwai47ab1542015-08-25 16:09:00 +020041 atomic_t active;
42 atomic_t shutdown;
43 atomic_t usage_count;
44 wait_queue_head_t shutdown_wait;
John S. Gruber98e89f62009-12-27 12:19:58 -050045 unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
Oliver Neukum88a85162011-03-11 14:51:12 +010046
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 int num_interfaces;
Oliver Neukumf85bf292007-12-14 14:42:41 +010048 int num_suspended_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50 struct list_head pcm_list; /* list of pcm streams */
Daniel Mack8fdff6a2012-04-12 13:51:11 +020051 struct list_head ep_list; /* list of audio-related endpoints */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 int pcm_devs;
53
54 struct list_head midi_list; /* list of midi interfaces */
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Clemens Ladisch84957a82005-04-29 16:23:13 +020056 struct list_head mixer_list; /* list of mixer interfaces */
Daniel Macke5779992010-03-04 19:46:13 +010057
58 int setup; /* from the 'device_setup' module param */
Eldad Zackef02e292013-04-03 23:18:56 +020059 bool autoclock; /* from the 'autoclock' module param */
Daniel Mack79f920f2010-05-31 14:51:31 +020060
61 struct usb_host_interface *ctrl_intf; /* the audio control interface */
Linus Torvalds1da177e2005-04-16 15:20:36 -070062};
63
Takashi Iwai0ba41d92014-02-26 13:02:17 +010064#define usb_audio_err(chip, fmt, args...) \
65 dev_err(&(chip)->dev->dev, fmt, ##args)
66#define usb_audio_warn(chip, fmt, args...) \
67 dev_warn(&(chip)->dev->dev, fmt, ##args)
68#define usb_audio_info(chip, fmt, args...) \
69 dev_info(&(chip)->dev->dev, fmt, ##args)
70#define usb_audio_dbg(chip, fmt, args...) \
71 dev_dbg(&(chip)->dev->dev, fmt, ##args)
72
Linus Torvalds1da177e2005-04-16 15:20:36 -070073/*
74 * Information about devices with broken descriptors
75 */
76
77/* special values for .ifnum */
78#define QUIRK_NO_INTERFACE -2
79#define QUIRK_ANY_INTERFACE -1
80
Clemens Ladisch854af952005-07-25 16:19:10 +020081enum quirk_type {
82 QUIRK_IGNORE_INTERFACE,
83 QUIRK_COMPOSITE,
Clemens Ladischaafe77c2013-03-31 23:43:12 +020084 QUIRK_AUTODETECT,
Clemens Ladisch854af952005-07-25 16:19:10 +020085 QUIRK_MIDI_STANDARD_INTERFACE,
86 QUIRK_MIDI_FIXED_ENDPOINT,
87 QUIRK_MIDI_YAMAHA,
Clemens Ladischaafe77c2013-03-31 23:43:12 +020088 QUIRK_MIDI_ROLAND,
Clemens Ladisch854af952005-07-25 16:19:10 +020089 QUIRK_MIDI_MIDIMAN,
90 QUIRK_MIDI_NOVATION,
Clemens Ladischc7f57212010-10-22 18:20:48 +020091 QUIRK_MIDI_RAW_BYTES,
Clemens Ladisch854af952005-07-25 16:19:10 +020092 QUIRK_MIDI_EMAGIC,
Clemens Ladischcc7a59b2006-02-07 17:11:06 +010093 QUIRK_MIDI_CME,
Krzysztof Foltman4434ade2010-05-20 20:31:10 +010094 QUIRK_MIDI_AKAI,
Karsten Wiese030a07e2008-07-30 15:13:29 +020095 QUIRK_MIDI_US122L,
Kristian Amlie1ef0e0a2011-08-26 13:19:49 +020096 QUIRK_MIDI_FTDI,
Clemens Ladisch854af952005-07-25 16:19:10 +020097 QUIRK_AUDIO_STANDARD_INTERFACE,
98 QUIRK_AUDIO_FIXED_ENDPOINT,
Pedro Lopez-Cabanillas310e0dc2008-10-04 16:27:36 +020099 QUIRK_AUDIO_EDIROL_UAXX,
John S. Gruber52a7a582009-12-27 12:19:59 -0500100 QUIRK_AUDIO_ALIGN_TRANSFER,
Daniel Mack014950b2011-05-25 09:09:02 +0200101 QUIRK_AUDIO_STANDARD_MIXER,
Clemens Ladisch854af952005-07-25 16:19:10 +0200102
103 QUIRK_TYPE_COUNT
104};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106struct snd_usb_audio_quirk {
107 const char *vendor_name;
108 const char *product_name;
109 int16_t ifnum;
Clemens Ladisch854af952005-07-25 16:19:10 +0200110 uint16_t type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 const void *data;
112};
113
Julian Anastasovf4950882009-11-06 23:44:53 +0200114#define combine_word(s) ((*(s)) | ((unsigned int)(s)[1] << 8))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115#define combine_triple(s) (combine_word(s) | ((unsigned int)(s)[2] << 16))
116#define combine_quad(s) (combine_triple(s) | ((unsigned int)(s)[3] << 24))
117
Takashi Iwai47ab1542015-08-25 16:09:00 +0200118int snd_usb_lock_shutdown(struct snd_usb_audio *chip);
119void snd_usb_unlock_shutdown(struct snd_usb_audio *chip);
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121#endif /* __USBAUDIO_H */