Loading...
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 unsigned char iface; /* interface number */
20 unsigned char altsetting; /* corresponding alternate setting */
21 unsigned char ep_idx; /* endpoint array index */
22 unsigned char altset_idx; /* array index of alternate setting */
23 unsigned char attributes; /* corresponding attributes of cs endpoint */
24 unsigned char endpoint; /* endpoint */
25 unsigned char ep_attr; /* endpoint attributes */
26 bool implicit_fb; /* implicit feedback endpoint */
27 unsigned char sync_ep; /* sync endpoint number */
28 unsigned char sync_iface; /* sync EP interface */
29 unsigned char sync_altsetting; /* sync EP alternate setting */
30 unsigned char sync_ep_idx; /* sync EP array index */
31 unsigned char datainterval; /* log_2 of data packet interval */
32 unsigned char protocol; /* UAC_VERSION_1/2/3 */
33 unsigned int maxpacksize; /* max. packet size */
34 unsigned int rates; /* rate bitmasks */
35 unsigned int rate_min, rate_max; /* min/max rates */
36 unsigned int nr_rates; /* number of rate table entries */
37 unsigned int *rate_table; /* rate table */
38 unsigned char clock; /* associated clock */
39 struct snd_pcm_chmap_elem *chmap; /* (optional) channel map */
40 bool dsd_dop; /* add DOP headers in case of DSD samples */
41 bool dsd_bitrev; /* reverse the bits of each DSD sample */
42 bool dsd_raw; /* altsetting is raw DSD */
43};
44
45struct snd_usb_substream;
46struct snd_usb_iface_ref;
47struct snd_usb_endpoint;
48struct snd_usb_power_domain;
49
50struct snd_urb_ctx {
51 struct urb *urb;
52 unsigned int buffer_size; /* size of data buffer, if data URB */
53 struct snd_usb_substream *subs;
54 struct snd_usb_endpoint *ep;
55 int index; /* index for urb array */
56 int packets; /* number of packets per urb */
57 int queued; /* queued data bytes by this urb */
58 int packet_size[MAX_PACKS_HS]; /* size of packets for next submission */
59 struct list_head ready_list;
60};
61
62struct snd_usb_endpoint {
63 struct snd_usb_audio *chip;
64 struct snd_usb_iface_ref *iface_ref;
65
66 int opened; /* open refcount; protect with chip->mutex */
67 atomic_t running; /* running status */
68 int ep_num; /* the referenced endpoint number */
69 int type; /* SND_USB_ENDPOINT_TYPE_* */
70
71 unsigned char iface; /* interface number */
72 unsigned char altsetting; /* corresponding alternate setting */
73 unsigned char ep_idx; /* endpoint array index */
74
75 atomic_t state; /* running state */
76
77 void (*prepare_data_urb) (struct snd_usb_substream *subs,
78 struct urb *urb);
79 void (*retire_data_urb) (struct snd_usb_substream *subs,
80 struct urb *urb);
81
82 struct snd_usb_substream *data_subs;
83 struct snd_usb_endpoint *sync_source;
84 struct snd_usb_endpoint *sync_sink;
85
86 struct snd_urb_ctx urb[MAX_URBS];
87
88 struct snd_usb_packet_info {
89 uint32_t packet_size[MAX_PACKS_HS];
90 int packets;
91 } next_packet[MAX_URBS];
92 unsigned int next_packet_head; /* ring buffer offset to read */
93 unsigned int next_packet_queued; /* queued items in the ring buffer */
94 struct list_head ready_playback_urbs; /* playback URB FIFO for implicit fb */
95
96 unsigned int nurbs; /* # urbs */
97 unsigned int nominal_queue_size; /* total buffer sizes in URBs */
98 unsigned long active_mask; /* bitmask of active urbs */
99 unsigned long unlink_mask; /* bitmask of unlinked urbs */
100 char *syncbuf; /* sync buffer for all sync URBs */
101 dma_addr_t sync_dma; /* DMA address of syncbuf */
102
103 unsigned int pipe; /* the data i/o pipe */
104 unsigned int packsize[2]; /* small/large packet sizes in samples */
105 unsigned int sample_rem; /* remainder from division fs/pps */
106 unsigned int sample_accum; /* sample accumulator */
107 unsigned int pps; /* packets per second */
108 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
109 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
110 int freqshift; /* how much to shift the feedback value to get Q16.16 */
111 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
112 unsigned int phase; /* phase accumulator */
113 unsigned int maxpacksize; /* max packet size in bytes */
114 unsigned int maxframesize; /* max packet size in frames */
115 unsigned int max_urb_frames; /* max URB size in frames */
116 unsigned int curpacksize; /* current packet size in bytes (for capture) */
117 unsigned int curframesize; /* current packet size in frames (for capture) */
118 unsigned int syncmaxsize; /* sync endpoint packet size */
119 unsigned int fill_max:1; /* fill max packet size always */
120 unsigned int tenor_fb_quirk:1; /* corrupted feedback data */
121 unsigned int datainterval; /* log_2 of data packet interval */
122 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
123 unsigned char silence_value;
124 unsigned int stride;
125 int skip_packets; /* quirks for devices to ignore the first n packets
126 in a stream */
127 bool implicit_fb_sync; /* syncs with implicit feedback */
128 bool need_setup; /* (re-)need for configure? */
129
130 /* for hw constraints */
131 const struct audioformat *cur_audiofmt;
132 unsigned int cur_rate;
133 snd_pcm_format_t cur_format;
134 unsigned int cur_channels;
135 unsigned int cur_frame_bytes;
136 unsigned int cur_period_frames;
137 unsigned int cur_period_bytes;
138 unsigned int cur_buffer_periods;
139
140 spinlock_t lock;
141 struct list_head list;
142};
143
144struct media_ctl;
145
146struct snd_usb_substream {
147 struct snd_usb_stream *stream;
148 struct usb_device *dev;
149 struct snd_pcm_substream *pcm_substream;
150 int direction; /* playback or capture */
151 int endpoint; /* assigned endpoint */
152 const struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
153 struct snd_usb_power_domain *str_pd; /* UAC3 Power Domain for streaming path */
154 unsigned int channels_max; /* max channels in the all audiofmts */
155 unsigned int txfr_quirk:1; /* allow sub-frame alignment */
156 unsigned int tx_length_quirk:1; /* add length specifier to transfers */
157 unsigned int fmt_type; /* USB audio format type (1-3) */
158 unsigned int pkt_offset_adj; /* Bytes to drop from beginning of packets (for non-compliant devices) */
159 unsigned int stream_offset_adj; /* Bytes to drop from beginning of stream (for non-compliant devices) */
160
161 unsigned int running: 1; /* running status */
162 unsigned int period_elapsed_pending; /* delay period handling */
163
164 unsigned int buffer_bytes; /* buffer size in bytes */
165 unsigned int inflight_bytes; /* in-flight data bytes on buffer (for playback) */
166 unsigned int hwptr_done; /* processed byte position in the buffer */
167 unsigned int transfer_done; /* processed frames since last period update */
168 unsigned int frame_limit; /* limits number of packets in URB */
169
170 /* data and sync endpoints for this stream */
171 unsigned int ep_num; /* the endpoint number */
172 struct snd_usb_endpoint *data_endpoint;
173 struct snd_usb_endpoint *sync_endpoint;
174 unsigned long flags;
175 unsigned int speed; /* USB_SPEED_XXX */
176
177 u64 formats; /* format bitmasks (all or'ed) */
178 unsigned int num_formats; /* number of supported audio formats (list) */
179 struct list_head fmt_list; /* format list */
180 spinlock_t lock;
181
182 unsigned int last_frame_number; /* stored frame number */
183
184 struct {
185 int marker;
186 int channel;
187 int byte_idx;
188 } dsd_dop;
189
190 bool trigger_tstamp_pending_update; /* trigger timestamp being updated from initial estimate */
191 bool early_playback_start; /* early start needed for playback? */
192 struct media_ctl *media_ctl;
193};
194
195struct snd_usb_stream {
196 struct snd_usb_audio *chip;
197 struct snd_pcm *pcm;
198 int pcm_index;
199 unsigned int fmt_type; /* USB audio format type (1-3) */
200 struct snd_usb_substream substream[2];
201 struct list_head list;
202};
203
204#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 20
6#define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
7#define MAX_URBS 8
8#define SYNC_URBS 4 /* always four urbs for sync */
9#define MAX_QUEUE 24 /* 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 int maxpacksize; /* max. packet size */
25 unsigned int rates; /* rate bitmasks */
26 unsigned int rate_min, rate_max; /* min/max rates */
27 unsigned int nr_rates; /* number of rate table entries */
28 unsigned int *rate_table; /* rate table */
29 unsigned char clock; /* associated clock */
30};
31
32struct snd_usb_substream;
33struct snd_usb_endpoint;
34
35struct snd_urb_ctx {
36 struct urb *urb;
37 unsigned int buffer_size; /* size of data buffer, if data URB */
38 struct snd_usb_substream *subs;
39 struct snd_usb_endpoint *ep;
40 int index; /* index for urb array */
41 int packets; /* number of packets per urb */
42 int packet_size[MAX_PACKS_HS]; /* size of packets for next submission */
43 struct list_head ready_list;
44};
45
46struct snd_usb_endpoint {
47 struct snd_usb_audio *chip;
48
49 int use_count;
50 int ep_num; /* the referenced endpoint number */
51 int type; /* SND_USB_ENDPOINT_TYPE_* */
52 unsigned long flags;
53
54 void (*prepare_data_urb) (struct snd_usb_substream *subs,
55 struct urb *urb);
56 void (*retire_data_urb) (struct snd_usb_substream *subs,
57 struct urb *urb);
58
59 struct snd_usb_substream *data_subs;
60 struct snd_usb_endpoint *sync_master;
61 struct snd_usb_endpoint *sync_slave;
62
63 struct snd_urb_ctx urb[MAX_URBS];
64
65 struct snd_usb_packet_info {
66 uint32_t packet_size[MAX_PACKS_HS];
67 int packets;
68 } next_packet[MAX_URBS];
69 int next_packet_read_pos, next_packet_write_pos;
70 struct list_head ready_playback_urbs;
71
72 unsigned int nurbs; /* # urbs */
73 unsigned long active_mask; /* bitmask of active urbs */
74 unsigned long unlink_mask; /* bitmask of unlinked urbs */
75 char *syncbuf; /* sync buffer for all sync URBs */
76 dma_addr_t sync_dma; /* DMA address of syncbuf */
77
78 unsigned int pipe; /* the data i/o pipe */
79 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
80 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
81 int freqshift; /* how much to shift the feedback value to get Q16.16 */
82 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
83 unsigned int phase; /* phase accumulator */
84 unsigned int maxpacksize; /* max packet size in bytes */
85 unsigned int maxframesize; /* max packet size in frames */
86 unsigned int curpacksize; /* current packet size in bytes (for capture) */
87 unsigned int curframesize; /* current packet size in frames (for capture) */
88 unsigned int syncmaxsize; /* sync endpoint packet size */
89 unsigned int fill_max:1; /* fill max packet size always */
90 unsigned int datainterval; /* log_2 of data packet interval */
91 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
92 unsigned char silence_value;
93 unsigned int stride;
94 int iface, alt_idx;
95
96 spinlock_t lock;
97 struct list_head list;
98};
99
100struct snd_usb_substream {
101 struct snd_usb_stream *stream;
102 struct usb_device *dev;
103 struct snd_pcm_substream *pcm_substream;
104 int direction; /* playback or capture */
105 int interface; /* current interface */
106 int endpoint; /* assigned endpoint */
107 struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
108 unsigned int cur_rate; /* current rate (for hw_params callback) */
109 unsigned int period_bytes; /* current period bytes (for hw_params callback) */
110 unsigned int altset_idx; /* USB data format: index of alternate setting */
111 unsigned int txfr_quirk:1; /* allow sub-frame alignment */
112 unsigned int fmt_type; /* USB audio format type (1-3) */
113
114 unsigned int running: 1; /* running status */
115
116 unsigned int hwptr_done; /* processed byte position in the buffer */
117 unsigned int transfer_done; /* processed frames since last period update */
118 unsigned long active_mask; /* bitmask of active urbs */
119 unsigned long unlink_mask; /* bitmask of unlinked urbs */
120
121 /* data and sync endpoints for this stream */
122 unsigned int ep_num; /* the endpoint number */
123 struct snd_usb_endpoint *data_endpoint;
124 struct snd_usb_endpoint *sync_endpoint;
125 unsigned long flags;
126
127 u64 formats; /* format bitmasks (all or'ed) */
128 unsigned int num_formats; /* number of supported audio formats (list) */
129 struct list_head fmt_list; /* format list */
130 struct snd_pcm_hw_constraint_list rate_list; /* limited rates */
131 spinlock_t lock;
132
133 int last_frame_number; /* stored frame number */
134 int last_delay; /* stored delay */
135};
136
137struct snd_usb_stream {
138 struct snd_usb_audio *chip;
139 struct snd_pcm *pcm;
140 int pcm_index;
141 unsigned int fmt_type; /* USB audio format type (1-3) */
142 struct snd_usb_substream substream[2];
143 struct list_head list;
144};
145
146#endif /* __USBAUDIO_CARD_H */