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