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