xref: /openbmc/linux/sound/usb/usbaudio.h (revision 3e1aebef6fb55e35668d2d7cf608cf03f30c904f)
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 struct snd_usb_audio {
33 	int index;
34 	struct usb_device *dev;
35 	struct snd_card *card;
36 	u32 usb_id;
37 	int shutdown;
38 	unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
39 	int num_interfaces;
40 	int num_suspended_intf;
41 
42 	/* for audio class v2 */
43 	int clock_id;
44 
45 	struct list_head pcm_list;	/* list of pcm streams */
46 	int pcm_devs;
47 
48 	struct list_head midi_list;	/* list of midi interfaces */
49 
50 	struct list_head mixer_list;	/* list of mixer interfaces */
51 };
52 
53 /*
54  * Information about devices with broken descriptors
55  */
56 
57 /* special values for .ifnum */
58 #define QUIRK_NO_INTERFACE		-2
59 #define QUIRK_ANY_INTERFACE		-1
60 
61 enum quirk_type {
62 	QUIRK_IGNORE_INTERFACE,
63 	QUIRK_COMPOSITE,
64 	QUIRK_MIDI_STANDARD_INTERFACE,
65 	QUIRK_MIDI_FIXED_ENDPOINT,
66 	QUIRK_MIDI_YAMAHA,
67 	QUIRK_MIDI_MIDIMAN,
68 	QUIRK_MIDI_NOVATION,
69 	QUIRK_MIDI_FASTLANE,
70 	QUIRK_MIDI_EMAGIC,
71 	QUIRK_MIDI_CME,
72 	QUIRK_MIDI_US122L,
73 	QUIRK_AUDIO_STANDARD_INTERFACE,
74 	QUIRK_AUDIO_FIXED_ENDPOINT,
75 	QUIRK_AUDIO_EDIROL_UAXX,
76 	QUIRK_AUDIO_ALIGN_TRANSFER,
77 
78 	QUIRK_TYPE_COUNT
79 };
80 
81 struct snd_usb_audio_quirk {
82 	const char *vendor_name;
83 	const char *product_name;
84 	int16_t ifnum;
85 	uint16_t type;
86 	const void *data;
87 };
88 
89 /*
90  */
91 
92 /*E-mu USB samplerate control quirk*/
93 enum {
94 	EMU_QUIRK_SR_44100HZ = 0,
95 	EMU_QUIRK_SR_48000HZ,
96 	EMU_QUIRK_SR_88200HZ,
97 	EMU_QUIRK_SR_96000HZ,
98 	EMU_QUIRK_SR_176400HZ,
99 	EMU_QUIRK_SR_192000HZ
100 };
101 
102 #define combine_word(s)    ((*(s)) | ((unsigned int)(s)[1] << 8))
103 #define combine_triple(s)  (combine_word(s) | ((unsigned int)(s)[2] << 16))
104 #define combine_quad(s)    (combine_triple(s) | ((unsigned int)(s)[3] << 24))
105 
106 unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size);
107 
108 void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype);
109 void *snd_usb_find_csint_desc(void *descstart, int desclen, void *after, u8 dsubtype);
110 
111 int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe,
112 		    __u8 request, __u8 requesttype, __u16 value, __u16 index,
113 		    void *data, __u16 size, int timeout);
114 
115 /*
116  * retrieve usb_interface descriptor from the host interface
117  * (conditional for compatibility with the older API)
118  */
119 #ifndef get_iface_desc
120 #define get_iface_desc(iface)	(&(iface)->desc)
121 #define get_endpoint(alt,ep)	(&(alt)->endpoint[ep].desc)
122 #define get_ep_desc(ep)		(&(ep)->desc)
123 #define get_cfg_desc(cfg)	(&(cfg)->desc)
124 #endif
125 
126 #ifndef snd_usb_get_speed
127 #define snd_usb_get_speed(dev) ((dev)->speed)
128 #endif
129 
130 #endif /* __USBAUDIO_H */
131