1/* SPDX-License-Identifier: GPL-2.0 */
  2#ifndef __USBAUDIO_CARD_H
  3#define __USBAUDIO_CARD_H
  4
  5#define MAX_NR_RATES	1024
  6#define MAX_PACKS	6		/* per URB */
  7#define MAX_PACKS_HS	(MAX_PACKS * 8)	/* in high speed mode */
  8#define MAX_URBS	12
  9#define SYNC_URBS	4	/* always four urbs for sync */
 10#define MAX_QUEUE	18	/* try not to exceed this queue length, in ms */
 11
 12struct audioformat {
 13	struct list_head list;
 14	u64 formats;			/* ALSA format bits */
 15	unsigned int channels;		/* # channels */
 16	unsigned int fmt_type;		/* USB audio format type (1-3) */
 17	unsigned int fmt_bits;		/* number of significant bits */
 18	unsigned int frame_size;	/* samples per frame for non-audio */
 19	int iface;			/* interface number */
 20	unsigned char altsetting;	/* corresponding alternate setting */
 21	unsigned char altset_idx;	/* array index of altenate setting */
 22	unsigned char attributes;	/* corresponding attributes of cs endpoint */
 23	unsigned char endpoint;		/* endpoint */
 24	unsigned char ep_attr;		/* endpoint attributes */
 25	unsigned char datainterval;	/* log_2 of data packet interval */
 26	unsigned char protocol;		/* UAC_VERSION_1/2/3 */
 27	unsigned int maxpacksize;	/* max. packet size */
 28	unsigned int rates;		/* rate bitmasks */
 29	unsigned int rate_min, rate_max;	/* min/max rates */
 30	unsigned int nr_rates;		/* number of rate table entries */
 31	unsigned int *rate_table;	/* rate table */
 32	unsigned char clock;		/* associated clock */
 33	struct snd_pcm_chmap_elem *chmap; /* (optional) channel map */
 34	bool dsd_dop;			/* add DOP headers in case of DSD samples */
 35	bool dsd_bitrev;		/* reverse the bits of each DSD sample */
 36	bool dsd_raw;			/* altsetting is raw DSD */
 37};
 38
 39struct snd_usb_substream;
 40struct snd_usb_endpoint;
 41struct snd_usb_power_domain;
 42
 43struct snd_urb_ctx {
 44	struct urb *urb;
 45	unsigned int buffer_size;	/* size of data buffer, if data URB */
 46	struct snd_usb_substream *subs;
 47	struct snd_usb_endpoint *ep;
 48	int index;	/* index for urb array */
 49	int packets;	/* number of packets per urb */
 50	int packet_size[MAX_PACKS_HS]; /* size of packets for next submission */
 51	struct list_head ready_list;
 52};
 53
 54struct snd_usb_endpoint {
 55	struct snd_usb_audio *chip;
 56
 57	int use_count;
 58	int ep_num;		/* the referenced endpoint number */
 59	int type;		/* SND_USB_ENDPOINT_TYPE_* */
 60	unsigned long flags;
 61
 62	void (*prepare_data_urb) (struct snd_usb_substream *subs,
 63				  struct urb *urb);
 64	void (*retire_data_urb) (struct snd_usb_substream *subs,
 65				 struct urb *urb);
 66
 67	struct snd_usb_substream *data_subs;
 68	struct snd_usb_endpoint *sync_master;
 69	struct snd_usb_endpoint *sync_slave;
 70
 71	struct snd_urb_ctx urb[MAX_URBS];
 72
 73	struct snd_usb_packet_info {
 74		uint32_t packet_size[MAX_PACKS_HS];
 75		int packets;
 76	} next_packet[MAX_URBS];
 77	int next_packet_read_pos, next_packet_write_pos;
 78	struct list_head ready_playback_urbs;
 79
 80	unsigned int nurbs;		/* # urbs */
 81	unsigned long active_mask;	/* bitmask of active urbs */
 82	unsigned long unlink_mask;	/* bitmask of unlinked urbs */
 83	char *syncbuf;			/* sync buffer for all sync URBs */
 84	dma_addr_t sync_dma;		/* DMA address of syncbuf */
 85
 86	unsigned int pipe;		/* the data i/o pipe */
 87	unsigned int packsize[2];	/* small/large packet sizes in samples */
 88	unsigned int sample_rem;	/* remainder from division fs/pps */
 89	unsigned int sample_accum;	/* sample accumulator */
 90	unsigned int pps;		/* packets per second */
 91	unsigned int freqn;		/* nominal sampling rate in fs/fps in Q16.16 format */
 92	unsigned int freqm;		/* momentary sampling rate in fs/fps in Q16.16 format */
 93	int	   freqshift;		/* how much to shift the feedback value to get Q16.16 */
 94	unsigned int freqmax;		/* maximum sampling rate, used for buffer management */
 95	unsigned int phase;		/* phase accumulator */
 96	unsigned int maxpacksize;	/* max packet size in bytes */
 97	unsigned int maxframesize;      /* max packet size in frames */
 98	unsigned int max_urb_frames;	/* max URB size in frames */
 99	unsigned int curpacksize;	/* current packet size in bytes (for capture) */
100	unsigned int curframesize;      /* current packet size in frames (for capture) */
101	unsigned int syncmaxsize;	/* sync endpoint packet size */
102	unsigned int fill_max:1;	/* fill max packet size always */
103	unsigned int tenor_fb_quirk:1;	/* corrupted feedback data */
104	unsigned int datainterval;      /* log_2 of data packet interval */
105	unsigned int syncinterval;	/* P for adaptive mode, 0 otherwise */
106	unsigned char silence_value;
107	unsigned int stride;
108	int iface, altsetting;
109	int skip_packets;		/* quirks for devices to ignore the first n packets
110					   in a stream */
111	bool is_implicit_feedback;      /* This endpoint is used as implicit feedback */
112
113	spinlock_t lock;
114	struct list_head list;
115};
116
117struct media_ctl;
118
119struct snd_usb_substream {
120	struct snd_usb_stream *stream;
121	struct usb_device *dev;
122	struct snd_pcm_substream *pcm_substream;
123	int direction;	/* playback or capture */
124	int interface;	/* current interface */
125	int endpoint;	/* assigned endpoint */
126	struct audioformat *cur_audiofmt;	/* current audioformat pointer (for hw_params callback) */
127	struct snd_usb_power_domain *str_pd;	/* UAC3 Power Domain for streaming path */
128	snd_pcm_format_t pcm_format;	/* current audio format (for hw_params callback) */
129	unsigned int channels;		/* current number of channels (for hw_params callback) */
130	unsigned int channels_max;	/* max channels in the all audiofmts */
131	unsigned int cur_rate;		/* current rate (for hw_params callback) */
132	unsigned int period_bytes;	/* current period bytes (for hw_params callback) */
133	unsigned int period_frames;	/* current frames per period */
134	unsigned int buffer_periods;	/* current periods per buffer */
135	unsigned int altset_idx;     /* USB data format: index of alternate setting */
136	unsigned int txfr_quirk:1;	/* allow sub-frame alignment */
137	unsigned int tx_length_quirk:1;	/* add length specifier to transfers */
138	unsigned int fmt_type;		/* USB audio format type (1-3) */
139	unsigned int pkt_offset_adj;	/* Bytes to drop from beginning of packets (for non-compliant devices) */
140	unsigned int stream_offset_adj;	/* Bytes to drop from beginning of stream (for non-compliant devices) */
141
142	unsigned int running: 1;	/* running status */
143
144	unsigned int hwptr_done;	/* processed byte position in the buffer */
145	unsigned int transfer_done;		/* processed frames since last period update */
146	unsigned int frame_limit;	/* limits number of packets in URB */
147
148	/* data and sync endpoints for this stream */
149	unsigned int ep_num;		/* the endpoint number */
150	struct snd_usb_endpoint *data_endpoint;
151	struct snd_usb_endpoint *sync_endpoint;
152	unsigned long flags;
153	bool need_setup_ep;		/* (re)configure EP at prepare? */
154	bool need_setup_fmt;		/* (re)configure fmt after resume? */
155	unsigned int speed;		/* USB_SPEED_XXX */
156
157	u64 formats;			/* format bitmasks (all or'ed) */
158	unsigned int num_formats;		/* number of supported audio formats (list) */
159	struct list_head fmt_list;	/* format list */
160	struct snd_pcm_hw_constraint_list rate_list;	/* limited rates */
161	spinlock_t lock;
162
163	int last_frame_number;          /* stored frame number */
164	int last_delay;                 /* stored delay */
165
166	struct {
167		int marker;
168		int channel;
169		int byte_idx;
170	} dsd_dop;
171
172	bool trigger_tstamp_pending_update; /* trigger timestamp being updated from initial estimate */
173	struct media_ctl *media_ctl;
174};
175
176struct snd_usb_stream {
177	struct snd_usb_audio *chip;
178	struct snd_pcm *pcm;
179	int pcm_index;
180	unsigned int fmt_type;		/* USB audio format type (1-3) */
181	struct snd_usb_substream substream[2];
182	struct list_head list;
183};
184
185#endif /* __USBAUDIO_CARD_H */

 
  1#ifndef __USBAUDIO_CARD_H
  2#define __USBAUDIO_CARD_H
  3
  4#define MAX_NR_RATES	1024
  5#define MAX_PACKS	6		/* per URB */
  6#define MAX_PACKS_HS	(MAX_PACKS * 8)	/* in high speed mode */
  7#define MAX_URBS	12
  8#define SYNC_URBS	4	/* always four urbs for sync */
  9#define MAX_QUEUE	18	/* try not to exceed this queue length, in ms */
 10
 11struct audioformat {
 12	struct list_head list;
 13	u64 formats;			/* ALSA format bits */
 14	unsigned int channels;		/* # channels */
 15	unsigned int fmt_type;		/* USB audio format type (1-3) */
 
 16	unsigned int frame_size;	/* samples per frame for non-audio */
 17	int iface;			/* interface number */
 18	unsigned char altsetting;	/* corresponding alternate setting */
 19	unsigned char altset_idx;	/* array index of altenate setting */
 20	unsigned char attributes;	/* corresponding attributes of cs endpoint */
 21	unsigned char endpoint;		/* endpoint */
 22	unsigned char ep_attr;		/* endpoint attributes */
 23	unsigned char datainterval;	/* log_2 of data packet interval */
 24	unsigned char protocol;		/* UAC_VERSION_1/2 */
 25	unsigned int maxpacksize;	/* max. packet size */
 26	unsigned int rates;		/* rate bitmasks */
 27	unsigned int rate_min, rate_max;	/* min/max rates */
 28	unsigned int nr_rates;		/* number of rate table entries */
 29	unsigned int *rate_table;	/* rate table */
 30	unsigned char clock;		/* associated clock */
 31	struct snd_pcm_chmap_elem *chmap; /* (optional) channel map */
 32	bool dsd_dop;			/* add DOP headers in case of DSD samples */
 33	bool dsd_bitrev;		/* reverse the bits of each DSD sample */
 
 34};
 35
 36struct snd_usb_substream;
 37struct snd_usb_endpoint;
 
 38
 39struct snd_urb_ctx {
 40	struct urb *urb;
 41	unsigned int buffer_size;	/* size of data buffer, if data URB */
 42	struct snd_usb_substream *subs;
 43	struct snd_usb_endpoint *ep;
 44	int index;	/* index for urb array */
 45	int packets;	/* number of packets per urb */
 46	int packet_size[MAX_PACKS_HS]; /* size of packets for next submission */
 47	struct list_head ready_list;
 48};
 49
 50struct snd_usb_endpoint {
 51	struct snd_usb_audio *chip;
 52
 53	int use_count;
 54	int ep_num;		/* the referenced endpoint number */
 55	int type;		/* SND_USB_ENDPOINT_TYPE_* */
 56	unsigned long flags;
 57
 58	void (*prepare_data_urb) (struct snd_usb_substream *subs,
 59				  struct urb *urb);
 60	void (*retire_data_urb) (struct snd_usb_substream *subs,
 61				 struct urb *urb);
 62
 63	struct snd_usb_substream *data_subs;
 64	struct snd_usb_endpoint *sync_master;
 65	struct snd_usb_endpoint *sync_slave;
 66
 67	struct snd_urb_ctx urb[MAX_URBS];
 68
 69	struct snd_usb_packet_info {
 70		uint32_t packet_size[MAX_PACKS_HS];
 71		int packets;
 72	} next_packet[MAX_URBS];
 73	int next_packet_read_pos, next_packet_write_pos;
 74	struct list_head ready_playback_urbs;
 75
 76	unsigned int nurbs;		/* # urbs */
 77	unsigned long active_mask;	/* bitmask of active urbs */
 78	unsigned long unlink_mask;	/* bitmask of unlinked urbs */
 79	char *syncbuf;			/* sync buffer for all sync URBs */
 80	dma_addr_t sync_dma;		/* DMA address of syncbuf */
 81
 82	unsigned int pipe;		/* the data i/o pipe */
 
 
 
 
 83	unsigned int freqn;		/* nominal sampling rate in fs/fps in Q16.16 format */
 84	unsigned int freqm;		/* momentary sampling rate in fs/fps in Q16.16 format */
 85	int	   freqshift;		/* how much to shift the feedback value to get Q16.16 */
 86	unsigned int freqmax;		/* maximum sampling rate, used for buffer management */
 87	unsigned int phase;		/* phase accumulator */
 88	unsigned int maxpacksize;	/* max packet size in bytes */
 89	unsigned int maxframesize;      /* max packet size in frames */
 90	unsigned int max_urb_frames;	/* max URB size in frames */
 91	unsigned int curpacksize;	/* current packet size in bytes (for capture) */
 92	unsigned int curframesize;      /* current packet size in frames (for capture) */
 93	unsigned int syncmaxsize;	/* sync endpoint packet size */
 94	unsigned int fill_max:1;	/* fill max packet size always */
 95	unsigned int udh01_fb_quirk:1;	/* corrupted feedback data */
 96	unsigned int datainterval;      /* log_2 of data packet interval */
 97	unsigned int syncinterval;	/* P for adaptive mode, 0 otherwise */
 98	unsigned char silence_value;
 99	unsigned int stride;
100	int iface, altsetting;
101	int skip_packets;		/* quirks for devices to ignore the first n packets
102					   in a stream */
 
103
104	spinlock_t lock;
105	struct list_head list;
106};
107
 
 
108struct snd_usb_substream {
109	struct snd_usb_stream *stream;
110	struct usb_device *dev;
111	struct snd_pcm_substream *pcm_substream;
112	int direction;	/* playback or capture */
113	int interface;	/* current interface */
114	int endpoint;	/* assigned endpoint */
115	struct audioformat *cur_audiofmt;	/* current audioformat pointer (for hw_params callback) */
 
116	snd_pcm_format_t pcm_format;	/* current audio format (for hw_params callback) */
117	unsigned int channels;		/* current number of channels (for hw_params callback) */
118	unsigned int channels_max;	/* max channels in the all audiofmts */
119	unsigned int cur_rate;		/* current rate (for hw_params callback) */
120	unsigned int period_bytes;	/* current period bytes (for hw_params callback) */
121	unsigned int period_frames;	/* current frames per period */
122	unsigned int buffer_periods;	/* current periods per buffer */
123	unsigned int altset_idx;     /* USB data format: index of alternate setting */
124	unsigned int txfr_quirk:1;	/* allow sub-frame alignment */
 
125	unsigned int fmt_type;		/* USB audio format type (1-3) */
126	unsigned int pkt_offset_adj;	/* Bytes to drop from beginning of packets (for non-compliant devices) */
 
127
128	unsigned int running: 1;	/* running status */
129
130	unsigned int hwptr_done;	/* processed byte position in the buffer */
131	unsigned int transfer_done;		/* processed frames since last period update */
132	unsigned int frame_limit;	/* limits number of packets in URB */
133
134	/* data and sync endpoints for this stream */
135	unsigned int ep_num;		/* the endpoint number */
136	struct snd_usb_endpoint *data_endpoint;
137	struct snd_usb_endpoint *sync_endpoint;
138	unsigned long flags;
139	bool need_setup_ep;		/* (re)configure EP at prepare? */
 
140	unsigned int speed;		/* USB_SPEED_XXX */
141
142	u64 formats;			/* format bitmasks (all or'ed) */
143	unsigned int num_formats;		/* number of supported audio formats (list) */
144	struct list_head fmt_list;	/* format list */
145	struct snd_pcm_hw_constraint_list rate_list;	/* limited rates */
146	spinlock_t lock;
147
148	int last_frame_number;          /* stored frame number */
149	int last_delay;                 /* stored delay */
150
151	struct {
152		int marker;
153		int channel;
154		int byte_idx;
155	} dsd_dop;
 
 
 
156};
157
158struct snd_usb_stream {
159	struct snd_usb_audio *chip;
160	struct snd_pcm *pcm;
161	int pcm_index;
162	unsigned int fmt_type;		/* USB audio format type (1-3) */
163	struct snd_usb_substream substream[2];
164	struct list_head list;
165};
166
167#endif /* __USBAUDIO_CARD_H */