ff3cbf653de80df519891866969db4615a27e70e
[muen/linux.git] / sound / usb / usbaudio.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 #ifndef __USBAUDIO_H
3 #define __USBAUDIO_H
4 /*
5  *   (Tentative) USB Audio Driver for ALSA
6  *
7  *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
8  */
9
10 /* handling of USB vendor/product ID pairs as 32-bit numbers */
11 #define USB_ID(vendor, product) (((vendor) << 16) | (product))
12 #define USB_ID_VENDOR(id) ((id) >> 16)
13 #define USB_ID_PRODUCT(id) ((u16)(id))
14
15 /*
16  *
17  */
18
19 struct media_device;
20 struct media_intf_devnode;
21
22 struct snd_usb_audio {
23         int index;
24         struct usb_device *dev;
25         struct snd_card *card;
26         struct usb_interface *pm_intf;
27         u32 usb_id;
28         struct mutex mutex;
29         unsigned int autosuspended:1;   
30         atomic_t active;
31         atomic_t shutdown;
32         atomic_t usage_count;
33         wait_queue_head_t shutdown_wait;
34         unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
35         unsigned int tx_length_quirk:1; /* Put length specifier in transfers */
36         
37         int num_interfaces;
38         int num_suspended_intf;
39         int sample_rate_read_error;
40
41         int badd_profile;               /* UAC3 BADD profile */
42
43         struct list_head pcm_list;      /* list of pcm streams */
44         struct list_head ep_list;       /* list of audio-related endpoints */
45         int pcm_devs;
46
47         struct list_head midi_list;     /* list of midi interfaces */
48
49         struct list_head mixer_list;    /* list of mixer interfaces */
50
51         int setup;                      /* from the 'device_setup' module param */
52         bool autoclock;                 /* from the 'autoclock' module param */
53         bool keep_iface;                /* keep interface/altset after closing
54                                          * or parameter change
55                                          */
56
57         struct usb_host_interface *ctrl_intf;   /* the audio control interface */
58         struct media_device *media_dev;
59         struct media_intf_devnode *ctl_intf_media_devnode;
60 };
61
62 #define usb_audio_err(chip, fmt, args...) \
63         dev_err(&(chip)->dev->dev, fmt, ##args)
64 #define usb_audio_warn(chip, fmt, args...) \
65         dev_warn(&(chip)->dev->dev, fmt, ##args)
66 #define usb_audio_info(chip, fmt, args...) \
67         dev_info(&(chip)->dev->dev, fmt, ##args)
68 #define usb_audio_dbg(chip, fmt, args...) \
69         dev_dbg(&(chip)->dev->dev, fmt, ##args)
70
71 /*
72  * Information about devices with broken descriptors
73  */
74
75 /* special values for .ifnum */
76 #define QUIRK_NO_INTERFACE              -2
77 #define QUIRK_ANY_INTERFACE             -1
78
79 enum quirk_type {
80         QUIRK_IGNORE_INTERFACE,
81         QUIRK_COMPOSITE,
82         QUIRK_AUTODETECT,
83         QUIRK_MIDI_STANDARD_INTERFACE,
84         QUIRK_MIDI_FIXED_ENDPOINT,
85         QUIRK_MIDI_YAMAHA,
86         QUIRK_MIDI_ROLAND,
87         QUIRK_MIDI_MIDIMAN,
88         QUIRK_MIDI_NOVATION,
89         QUIRK_MIDI_RAW_BYTES,
90         QUIRK_MIDI_EMAGIC,
91         QUIRK_MIDI_CME,
92         QUIRK_MIDI_AKAI,
93         QUIRK_MIDI_US122L,
94         QUIRK_MIDI_FTDI,
95         QUIRK_MIDI_CH345,
96         QUIRK_AUDIO_STANDARD_INTERFACE,
97         QUIRK_AUDIO_FIXED_ENDPOINT,
98         QUIRK_AUDIO_EDIROL_UAXX,
99         QUIRK_AUDIO_ALIGN_TRANSFER,
100         QUIRK_AUDIO_STANDARD_MIXER,
101
102         QUIRK_TYPE_COUNT
103 };
104
105 struct snd_usb_audio_quirk {
106         const char *vendor_name;
107         const char *product_name;
108         const char *profile_name;       /* override the card->longname */
109         int16_t ifnum;
110         uint16_t type;
111         bool shares_media_device;
112         const void *data;
113 };
114
115 #define combine_word(s)    ((*(s)) | ((unsigned int)(s)[1] << 8))
116 #define combine_triple(s)  (combine_word(s) | ((unsigned int)(s)[2] << 16))
117 #define combine_quad(s)    (combine_triple(s) | ((unsigned int)(s)[3] << 24))
118
119 int snd_usb_lock_shutdown(struct snd_usb_audio *chip);
120 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip);
121
122 extern bool snd_usb_use_vmalloc;
123 extern bool snd_usb_skip_validation;
124
125 #endif /* __USBAUDIO_H */