[PATCH] pmac: save master volume on sleep
[linux-2.6.git] / 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
25 /*
26  */
27
28 #define USB_SUBCLASS_AUDIO_CONTROL      0x01
29 #define USB_SUBCLASS_AUDIO_STREAMING    0x02
30 #define USB_SUBCLASS_MIDI_STREAMING     0x03
31 #define USB_SUBCLASS_VENDOR_SPEC        0xff
32
33 #define CS_AUDIO_UNDEFINED              0x20
34 #define CS_AUDIO_DEVICE                 0x21
35 #define CS_AUDIO_CONFIGURATION          0x22
36 #define CS_AUDIO_STRING                 0x23
37 #define CS_AUDIO_INTERFACE              0x24
38 #define CS_AUDIO_ENDPOINT               0x25
39
40 #define HEADER                          0x01
41 #define INPUT_TERMINAL                  0x02
42 #define OUTPUT_TERMINAL                 0x03
43 #define MIXER_UNIT                      0x04
44 #define SELECTOR_UNIT                   0x05
45 #define FEATURE_UNIT                    0x06
46 #define PROCESSING_UNIT                 0x07
47 #define EXTENSION_UNIT                  0x08
48
49 #define AS_GENERAL                      0x01
50 #define FORMAT_TYPE                     0x02
51 #define FORMAT_SPECIFIC                 0x03
52
53 #define EP_GENERAL                      0x01
54
55 #define MS_GENERAL                      0x01
56 #define MIDI_IN_JACK                    0x02
57 #define MIDI_OUT_JACK                   0x03
58
59 /* endpoint attributes */
60 #define EP_ATTR_MASK                    0x0c
61 #define EP_ATTR_ASYNC                   0x04
62 #define EP_ATTR_ADAPTIVE                0x08
63 #define EP_ATTR_SYNC                    0x0c
64
65 /* cs endpoint attributes */
66 #define EP_CS_ATTR_SAMPLE_RATE          0x01
67 #define EP_CS_ATTR_PITCH_CONTROL        0x02
68 #define EP_CS_ATTR_FILL_MAX             0x80
69
70 /* Audio Class specific Request Codes */
71
72 #define SET_CUR    0x01
73 #define GET_CUR    0x81
74 #define SET_MIN    0x02
75 #define GET_MIN    0x82
76 #define SET_MAX    0x03
77 #define GET_MAX    0x83
78 #define SET_RES    0x04
79 #define GET_RES    0x84
80 #define SET_MEM    0x05
81 #define GET_MEM    0x85
82 #define GET_STAT   0xff
83
84 /* Terminal Control Selectors */
85
86 #define COPY_PROTECT_CONTROL       0x01
87
88 /* Endpoint Control Selectors */
89
90 #define SAMPLING_FREQ_CONTROL      0x01
91 #define PITCH_CONTROL              0x02
92
93 /* Format Types */
94 #define USB_FORMAT_TYPE_I       0x01
95 #define USB_FORMAT_TYPE_II      0x02
96 #define USB_FORMAT_TYPE_III     0x03
97
98 /* type I */
99 #define USB_AUDIO_FORMAT_PCM    0x01
100 #define USB_AUDIO_FORMAT_PCM8   0x02
101 #define USB_AUDIO_FORMAT_IEEE_FLOAT     0x03
102 #define USB_AUDIO_FORMAT_ALAW   0x04
103 #define USB_AUDIO_FORMAT_MU_LAW 0x05
104
105 /* type II */
106 #define USB_AUDIO_FORMAT_MPEG   0x1001
107 #define USB_AUDIO_FORMAT_AC3    0x1002
108
109 /* type III */
110 #define USB_AUDIO_FORMAT_IEC1937_AC3    0x2001
111 #define USB_AUDIO_FORMAT_IEC1937_MPEG1_LAYER1   0x2002
112 #define USB_AUDIO_FORMAT_IEC1937_MPEG2_NOEXT    0x2003
113 #define USB_AUDIO_FORMAT_IEC1937_MPEG2_EXT      0x2004
114 #define USB_AUDIO_FORMAT_IEC1937_MPEG2_LAYER1_LS        0x2005
115 #define USB_AUDIO_FORMAT_IEC1937_MPEG2_LAYER23_LS       0x2006
116
117
118 /* maximum number of endpoints per interface */
119 #define MIDI_MAX_ENDPOINTS 2
120
121 /*
122  */
123
124 typedef struct snd_usb_audio snd_usb_audio_t;
125
126 struct snd_usb_audio {
127         int index;
128         struct usb_device *dev;
129         snd_card_t *card;
130         int shutdown;
131         int num_interfaces;
132
133         struct list_head pcm_list;      /* list of pcm streams */
134         int pcm_devs;
135
136         struct list_head midi_list;     /* list of midi interfaces */
137         int next_midi_device;
138
139         unsigned int ignore_ctl_error;  /* for mixer */
140 };
141
142 /*
143  * Information about devices with broken descriptors
144  */
145
146 /* special values for .ifnum */
147 #define QUIRK_NO_INTERFACE              -2
148 #define QUIRK_ANY_INTERFACE             -1
149
150 /* quirk type */
151 #define QUIRK_MIDI_FIXED_ENDPOINT       0
152 #define QUIRK_MIDI_YAMAHA               1
153 #define QUIRK_MIDI_MIDIMAN              2
154 #define QUIRK_COMPOSITE                 3
155 #define QUIRK_AUDIO_FIXED_ENDPOINT      4
156 #define QUIRK_AUDIO_STANDARD_INTERFACE  5
157 #define QUIRK_MIDI_STANDARD_INTERFACE   6
158 #define QUIRK_AUDIO_EDIROL_UA700_UA25   7
159 #define QUIRK_AUDIO_EDIROL_UA1000       8
160 #define QUIRK_IGNORE_INTERFACE          9
161 #define QUIRK_MIDI_NOVATION             10
162 #define QUIRK_MIDI_MOTU                 11
163 #define QUIRK_MIDI_EMAGIC               12
164
165 typedef struct snd_usb_audio_quirk snd_usb_audio_quirk_t;
166 typedef struct snd_usb_midi_endpoint_info snd_usb_midi_endpoint_info_t;
167
168 struct snd_usb_audio_quirk {
169         const char *vendor_name;
170         const char *product_name;
171         int16_t ifnum;
172         int16_t type;
173         const void *data;
174 };
175
176 /* data for QUIRK_MIDI_FIXED_ENDPOINT */
177 struct snd_usb_midi_endpoint_info {
178         int8_t   out_ep;        /* ep number, 0 autodetect */
179         uint8_t  out_interval;  /* interval for interrupt endpoints */
180         int8_t   in_ep; 
181         uint8_t  in_interval;
182         uint16_t out_cables;    /* bitmask */
183         uint16_t in_cables;     /* bitmask */
184 };
185
186 /* for QUIRK_MIDI_YAMAHA, data is NULL */
187
188 /* for QUIRK_MIDI_MIDIMAN, data points to a snd_usb_midi_endpoint_info
189  * structure (out_cables and in_cables only) */
190
191 /* for QUIRK_COMPOSITE, data points to an array of snd_usb_audio_quirk
192  * structures, terminated with .ifnum = -1 */
193
194 /* for QUIRK_AUDIO_FIXED_ENDPOINT, data points to an audioformat structure */
195
196 /* for QUIRK_AUDIO/MIDI_STANDARD_INTERFACE, data is NULL */
197
198 /* for QUIRK_AUDIO_EDIROL_UA700_UA25/UA1000, data is NULL */
199
200 /* for QUIRK_IGNORE_INTERFACE, data is NULL */
201
202 /* for QUIRK_MIDI_NOVATION and _MOTU, data is NULL */
203
204 /* for QUIRK_MIDI_EMAGIC, data points to a snd_usb_midi_endpoint_info
205  * structure (out_cables and in_cables only) */
206
207 /*
208  */
209
210 #define combine_word(s)    ((*s) | ((unsigned int)(s)[1] << 8))
211 #define combine_triple(s)  (combine_word(s) | ((unsigned int)(s)[2] << 16))
212 #define combine_quad(s)    (combine_triple(s) | ((unsigned int)(s)[3] << 24))
213
214 unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size);
215
216 void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype);
217 void *snd_usb_find_csint_desc(void *descstart, int desclen, void *after, u8 dsubtype);
218
219 int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe, __u8 request, __u8 requesttype, __u16 value, __u16 index, void *data, __u16 size, int timeout);
220
221 int snd_usb_create_mixer(snd_usb_audio_t *chip, int ctrlif);
222
223 int snd_usb_create_midi_interface(snd_usb_audio_t *chip, struct usb_interface *iface, const snd_usb_audio_quirk_t *quirk);
224 void snd_usbmidi_input_stop(struct list_head* p);
225 void snd_usbmidi_input_start(struct list_head* p);
226 void snd_usbmidi_disconnect(struct list_head *p, struct usb_driver *driver);
227
228 /*
229  * retrieve usb_interface descriptor from the host interface
230  * (conditional for compatibility with the older API)
231  */
232 #ifndef get_iface_desc
233 #define get_iface_desc(iface)   (&(iface)->desc)
234 #define get_endpoint(alt,ep)    (&(alt)->endpoint[ep].desc)
235 #define get_ep_desc(ep)         (&(ep)->desc)
236 #define get_cfg_desc(cfg)       (&(cfg)->desc)
237 #endif
238
239 #ifndef usb_pipe_needs_resubmit
240 #define usb_pipe_needs_resubmit(pipe) 1
241 #endif
242
243 #ifndef snd_usb_complete_callback
244 #define snd_usb_complete_callback(x) (x)
245 #endif
246
247 #ifndef snd_usb_get_speed
248 #define snd_usb_get_speed(dev) ((dev)->speed)
249 #endif
250
251 #endif /* __USBAUDIO_H */