xref: /openbmc/linux/sound/usb/usbaudio.h (revision a5b2c10c)
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 #define MAX_CARD_INTERFACES	16
23 
24 struct snd_usb_audio {
25 	int index;
26 	struct usb_device *dev;
27 	struct snd_card *card;
28 	struct usb_interface *intf[MAX_CARD_INTERFACES];
29 	u32 usb_id;
30 	struct mutex mutex;
31 	unsigned int system_suspend;
32 	atomic_t active;
33 	atomic_t shutdown;
34 	atomic_t usage_count;
35 	wait_queue_head_t shutdown_wait;
36 	unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
37 	unsigned int tx_length_quirk:1; /* Put length specifier in transfers */
38 	unsigned int setup_fmt_after_resume_quirk:1; /* setup the format to interface after resume */
39 	unsigned int need_delayed_register:1; /* warn for delayed registration */
40 	int num_interfaces;
41 	int num_suspended_intf;
42 	int sample_rate_read_error;
43 
44 	int badd_profile;		/* UAC3 BADD profile */
45 
46 	struct list_head pcm_list;	/* list of pcm streams */
47 	struct list_head ep_list;	/* list of audio-related endpoints */
48 	int pcm_devs;
49 
50 	struct list_head midi_list;	/* list of midi interfaces */
51 
52 	struct list_head mixer_list;	/* list of mixer interfaces */
53 
54 	int setup;			/* from the 'device_setup' module param */
55 	bool autoclock;			/* from the 'autoclock' module param */
56 	bool keep_iface;		/* keep interface/altset after closing
57 					 * or parameter change
58 					 */
59 
60 	struct usb_host_interface *ctrl_intf;	/* the audio control interface */
61 	struct media_device *media_dev;
62 	struct media_intf_devnode *ctl_intf_media_devnode;
63 };
64 
65 #define usb_audio_err(chip, fmt, args...) \
66 	dev_err(&(chip)->dev->dev, fmt, ##args)
67 #define usb_audio_warn(chip, fmt, args...) \
68 	dev_warn(&(chip)->dev->dev, fmt, ##args)
69 #define usb_audio_info(chip, fmt, args...) \
70 	dev_info(&(chip)->dev->dev, fmt, ##args)
71 #define usb_audio_dbg(chip, fmt, args...) \
72 	dev_dbg(&(chip)->dev->dev, fmt, ##args)
73 
74 /*
75  * Information about devices with broken descriptors
76  */
77 
78 /* special values for .ifnum */
79 #define QUIRK_NO_INTERFACE		-2
80 #define QUIRK_ANY_INTERFACE		-1
81 
82 enum quirk_type {
83 	QUIRK_IGNORE_INTERFACE,
84 	QUIRK_COMPOSITE,
85 	QUIRK_AUTODETECT,
86 	QUIRK_MIDI_STANDARD_INTERFACE,
87 	QUIRK_MIDI_FIXED_ENDPOINT,
88 	QUIRK_MIDI_YAMAHA,
89 	QUIRK_MIDI_ROLAND,
90 	QUIRK_MIDI_MIDIMAN,
91 	QUIRK_MIDI_NOVATION,
92 	QUIRK_MIDI_RAW_BYTES,
93 	QUIRK_MIDI_EMAGIC,
94 	QUIRK_MIDI_CME,
95 	QUIRK_MIDI_AKAI,
96 	QUIRK_MIDI_US122L,
97 	QUIRK_MIDI_FTDI,
98 	QUIRK_MIDI_CH345,
99 	QUIRK_AUDIO_STANDARD_INTERFACE,
100 	QUIRK_AUDIO_FIXED_ENDPOINT,
101 	QUIRK_AUDIO_EDIROL_UAXX,
102 	QUIRK_AUDIO_ALIGN_TRANSFER,
103 	QUIRK_AUDIO_STANDARD_MIXER,
104 	QUIRK_SETUP_FMT_AFTER_RESUME,
105 	QUIRK_SETUP_DISABLE_AUTOSUSPEND,
106 
107 	QUIRK_TYPE_COUNT
108 };
109 
110 struct snd_usb_audio_quirk {
111 	const char *vendor_name;
112 	const char *product_name;
113 	const char *profile_name;	/* override the card->longname */
114 	int16_t ifnum;
115 	uint16_t type;
116 	bool shares_media_device;
117 	const void *data;
118 };
119 
120 #define combine_word(s)    ((*(s)) | ((unsigned int)(s)[1] << 8))
121 #define combine_triple(s)  (combine_word(s) | ((unsigned int)(s)[2] << 16))
122 #define combine_quad(s)    (combine_triple(s) | ((unsigned int)(s)[3] << 24))
123 
124 int snd_usb_lock_shutdown(struct snd_usb_audio *chip);
125 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip);
126 
127 extern bool snd_usb_use_vmalloc;
128 extern bool snd_usb_skip_validation;
129 
130 #endif /* __USBAUDIO_H */
131