1 /* SPDX-License-Identifier: GPL-2.0 */ <<
2 #ifndef __USBAUDIO_CARD_H 1 #ifndef __USBAUDIO_CARD_H
3 #define __USBAUDIO_CARD_H 2 #define __USBAUDIO_CARD_H
4 3
5 #define MAX_NR_RATES 1024 4 #define MAX_NR_RATES 1024
6 #define MAX_PACKS 6 /* per 5 #define MAX_PACKS 6 /* per URB */
7 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in 6 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
8 #define MAX_URBS 12 7 #define MAX_URBS 12
9 #define SYNC_URBS 4 /* always four 8 #define SYNC_URBS 4 /* always four urbs for sync */
10 #define MAX_QUEUE 18 /* try not to 9 #define MAX_QUEUE 18 /* try not to exceed this queue length, in ms */
11 10
12 struct audioformat { 11 struct audioformat {
13 struct list_head list; 12 struct list_head list;
14 u64 formats; /* ALS 13 u64 formats; /* ALSA format bits */
15 unsigned int channels; /* # c 14 unsigned int channels; /* # channels */
16 unsigned int fmt_type; /* USB 15 unsigned int fmt_type; /* USB audio format type (1-3) */
17 unsigned int fmt_bits; /* num <<
18 unsigned int frame_size; /* sam 16 unsigned int frame_size; /* samples per frame for non-audio */
19 unsigned char iface; /* int !! 17 int iface; /* interface number */
20 unsigned char altsetting; /* cor 18 unsigned char altsetting; /* corresponding alternate setting */
21 unsigned char ep_idx; /* end !! 19 unsigned char altset_idx; /* array index of altenate setting */
22 unsigned char altset_idx; /* arr <<
23 unsigned char attributes; /* cor 20 unsigned char attributes; /* corresponding attributes of cs endpoint */
24 unsigned char endpoint; /* end 21 unsigned char endpoint; /* endpoint */
25 unsigned char ep_attr; /* end 22 unsigned char ep_attr; /* endpoint attributes */
26 bool implicit_fb; /* imp <<
27 unsigned char sync_ep; /* syn <<
28 unsigned char sync_iface; /* syn <<
29 unsigned char sync_altsetting; /* syn <<
30 unsigned char sync_ep_idx; /* syn <<
31 unsigned char datainterval; /* log 23 unsigned char datainterval; /* log_2 of data packet interval */
32 unsigned char protocol; /* UAC !! 24 unsigned char protocol; /* UAC_VERSION_1/2 */
33 unsigned int maxpacksize; /* max 25 unsigned int maxpacksize; /* max. packet size */
34 unsigned int rates; /* rat 26 unsigned int rates; /* rate bitmasks */
35 unsigned int rate_min, rate_max; 27 unsigned int rate_min, rate_max; /* min/max rates */
36 unsigned int nr_rates; /* num 28 unsigned int nr_rates; /* number of rate table entries */
37 unsigned int *rate_table; /* rat 29 unsigned int *rate_table; /* rate table */
38 unsigned char clock; /* ass 30 unsigned char clock; /* associated clock */
39 struct snd_pcm_chmap_elem *chmap; /* ( 31 struct snd_pcm_chmap_elem *chmap; /* (optional) channel map */
40 bool dsd_dop; /* add 32 bool dsd_dop; /* add DOP headers in case of DSD samples */
41 bool dsd_bitrev; /* rev 33 bool dsd_bitrev; /* reverse the bits of each DSD sample */
42 bool dsd_raw; /* alt <<
43 }; 34 };
44 35
45 struct snd_usb_substream; 36 struct snd_usb_substream;
46 struct snd_usb_iface_ref; <<
47 struct snd_usb_clock_ref; <<
48 struct snd_usb_endpoint; 37 struct snd_usb_endpoint;
49 struct snd_usb_power_domain; <<
50 38
51 struct snd_urb_ctx { 39 struct snd_urb_ctx {
52 struct urb *urb; 40 struct urb *urb;
53 unsigned int buffer_size; /* siz 41 unsigned int buffer_size; /* size of data buffer, if data URB */
54 struct snd_usb_substream *subs; 42 struct snd_usb_substream *subs;
55 struct snd_usb_endpoint *ep; 43 struct snd_usb_endpoint *ep;
56 int index; /* index for urb array 44 int index; /* index for urb array */
57 int packets; /* number of packets p 45 int packets; /* number of packets per urb */
58 int queued; /* queued data bytes b <<
59 int packet_size[MAX_PACKS_HS]; /* size 46 int packet_size[MAX_PACKS_HS]; /* size of packets for next submission */
60 struct list_head ready_list; 47 struct list_head ready_list;
61 }; 48 };
62 49
63 struct snd_usb_endpoint { 50 struct snd_usb_endpoint {
64 struct snd_usb_audio *chip; 51 struct snd_usb_audio *chip;
65 struct snd_usb_iface_ref *iface_ref; <<
66 struct snd_usb_clock_ref *clock_ref; <<
67 52
68 int opened; /* open refcou !! 53 int use_count;
69 atomic_t running; /* running sta <<
70 int ep_num; /* the referen 54 int ep_num; /* the referenced endpoint number */
71 int type; /* SND_USB_END 55 int type; /* SND_USB_ENDPOINT_TYPE_* */
>> 56 unsigned long flags;
72 57
73 unsigned char iface; /* int !! 58 void (*prepare_data_urb) (struct snd_usb_substream *subs,
74 unsigned char altsetting; /* cor !! 59 struct urb *urb);
75 unsigned char ep_idx; /* end <<
76 <<
77 atomic_t state; /* running sta <<
78 <<
79 int (*prepare_data_urb) (struct snd_us <<
80 struct urb *u <<
81 bool in_strea <<
82 void (*retire_data_urb) (struct snd_us 60 void (*retire_data_urb) (struct snd_usb_substream *subs,
83 struct urb *u 61 struct urb *urb);
84 62
85 struct snd_usb_substream *data_subs; 63 struct snd_usb_substream *data_subs;
86 struct snd_usb_endpoint *sync_source; !! 64 struct snd_usb_endpoint *sync_master;
87 struct snd_usb_endpoint *sync_sink; !! 65 struct snd_usb_endpoint *sync_slave;
88 66
89 struct snd_urb_ctx urb[MAX_URBS]; 67 struct snd_urb_ctx urb[MAX_URBS];
90 68
91 struct snd_usb_packet_info { 69 struct snd_usb_packet_info {
92 uint32_t packet_size[MAX_PACKS 70 uint32_t packet_size[MAX_PACKS_HS];
93 int packets; 71 int packets;
94 } next_packet[MAX_URBS]; 72 } next_packet[MAX_URBS];
95 unsigned int next_packet_head; /* rin !! 73 int next_packet_read_pos, next_packet_write_pos;
96 unsigned int next_packet_queued; /* qu !! 74 struct list_head ready_playback_urbs;
97 struct list_head ready_playback_urbs; <<
98 75
99 unsigned int nurbs; /* # u 76 unsigned int nurbs; /* # urbs */
100 unsigned long active_mask; /* bit 77 unsigned long active_mask; /* bitmask of active urbs */
101 unsigned long unlink_mask; /* bit 78 unsigned long unlink_mask; /* bitmask of unlinked urbs */
102 atomic_t submitted_urbs; /* cur <<
103 char *syncbuf; /* syn 79 char *syncbuf; /* sync buffer for all sync URBs */
104 dma_addr_t sync_dma; /* DMA 80 dma_addr_t sync_dma; /* DMA address of syncbuf */
105 81
106 unsigned int pipe; /* the 82 unsigned int pipe; /* the data i/o pipe */
107 unsigned int packsize[2]; /* sma <<
108 unsigned int sample_rem; /* rem <<
109 unsigned int sample_accum; /* sam <<
110 unsigned int pps; /* pac <<
111 unsigned int freqn; /* nom 83 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
112 unsigned int freqm; /* mom 84 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
113 int freqshift; /* how 85 int freqshift; /* how much to shift the feedback value to get Q16.16 */
114 unsigned int freqmax; /* max 86 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
115 unsigned int phase; /* pha 87 unsigned int phase; /* phase accumulator */
116 unsigned int maxpacksize; /* max 88 unsigned int maxpacksize; /* max packet size in bytes */
117 unsigned int maxframesize; /* max 89 unsigned int maxframesize; /* max packet size in frames */
118 unsigned int max_urb_frames; /* max 90 unsigned int max_urb_frames; /* max URB size in frames */
119 unsigned int curpacksize; /* cur 91 unsigned int curpacksize; /* current packet size in bytes (for capture) */
120 unsigned int curframesize; /* cur 92 unsigned int curframesize; /* current packet size in frames (for capture) */
121 unsigned int syncmaxsize; /* syn 93 unsigned int syncmaxsize; /* sync endpoint packet size */
122 unsigned int fill_max:1; /* fil 94 unsigned int fill_max:1; /* fill max packet size always */
123 unsigned int tenor_fb_quirk:1; /* cor 95 unsigned int tenor_fb_quirk:1; /* corrupted feedback data */
124 unsigned int datainterval; /* log 96 unsigned int datainterval; /* log_2 of data packet interval */
125 unsigned int syncinterval; /* P f 97 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
126 unsigned char silence_value; 98 unsigned char silence_value;
127 unsigned int stride; 99 unsigned int stride;
>> 100 int iface, altsetting;
128 int skip_packets; /* qui 101 int skip_packets; /* quirks for devices to ignore the first n packets
129 in 102 in a stream */
130 bool implicit_fb_sync; /* syn <<
131 bool lowlatency_playback; /* low <<
132 bool need_setup; /* (re <<
133 bool need_prepare; /* (re <<
134 bool fixed_rate; /* ski <<
135 <<
136 /* for hw constraints */ <<
137 const struct audioformat *cur_audiofmt <<
138 unsigned int cur_rate; <<
139 snd_pcm_format_t cur_format; <<
140 unsigned int cur_channels; <<
141 unsigned int cur_frame_bytes; <<
142 unsigned int cur_period_frames; <<
143 unsigned int cur_period_bytes; <<
144 unsigned int cur_buffer_periods; <<
145 103
146 spinlock_t lock; 104 spinlock_t lock;
147 struct list_head list; 105 struct list_head list;
148 }; 106 };
149 107
150 struct media_ctl; <<
151 <<
152 struct snd_usb_substream { 108 struct snd_usb_substream {
153 struct snd_usb_stream *stream; 109 struct snd_usb_stream *stream;
154 struct usb_device *dev; 110 struct usb_device *dev;
155 struct snd_pcm_substream *pcm_substrea 111 struct snd_pcm_substream *pcm_substream;
156 int direction; /* playback or capture 112 int direction; /* playback or capture */
>> 113 int interface; /* current interface */
157 int endpoint; /* assigned endpoint * 114 int endpoint; /* assigned endpoint */
158 const struct audioformat *cur_audiofmt !! 115 struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
159 struct snd_usb_power_domain *str_pd; !! 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) */
160 unsigned int channels_max; /* max 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 */
161 unsigned int txfr_quirk:1; /* all 124 unsigned int txfr_quirk:1; /* allow sub-frame alignment */
162 unsigned int tx_length_quirk:1; /* add 125 unsigned int tx_length_quirk:1; /* add length specifier to transfers */
163 unsigned int fmt_type; /* USB 126 unsigned int fmt_type; /* USB audio format type (1-3) */
164 unsigned int pkt_offset_adj; /* Byt 127 unsigned int pkt_offset_adj; /* Bytes to drop from beginning of packets (for non-compliant devices) */
165 unsigned int stream_offset_adj; /* Byt <<
166 128
167 unsigned int running: 1; /* run 129 unsigned int running: 1; /* running status */
168 unsigned int period_elapsed_pending; <<
169 130
170 unsigned int buffer_bytes; /* buf <<
171 unsigned int inflight_bytes; /* in- <<
172 unsigned int hwptr_done; /* pro 131 unsigned int hwptr_done; /* processed byte position in the buffer */
173 unsigned int transfer_done; /* pro !! 132 unsigned int transfer_done; /* processed frames since last period update */
174 unsigned int frame_limit; /* lim 133 unsigned int frame_limit; /* limits number of packets in URB */
175 134
176 /* data and sync endpoints for this st 135 /* data and sync endpoints for this stream */
177 unsigned int ep_num; /* the 136 unsigned int ep_num; /* the endpoint number */
178 struct snd_usb_endpoint *data_endpoint 137 struct snd_usb_endpoint *data_endpoint;
179 struct snd_usb_endpoint *sync_endpoint 138 struct snd_usb_endpoint *sync_endpoint;
180 unsigned long flags; 139 unsigned long flags;
>> 140 bool need_setup_ep; /* (re)configure EP at prepare? */
181 unsigned int speed; /* USB 141 unsigned int speed; /* USB_SPEED_XXX */
182 142
183 u64 formats; /* for 143 u64 formats; /* format bitmasks (all or'ed) */
184 unsigned int num_formats; 144 unsigned int num_formats; /* number of supported audio formats (list) */
185 struct list_head fmt_list; /* for 145 struct list_head fmt_list; /* format list */
>> 146 struct snd_pcm_hw_constraint_list rate_list; /* limited rates */
186 spinlock_t lock; 147 spinlock_t lock;
187 148
188 unsigned int last_frame_number; /* sto !! 149 int last_frame_number; /* stored frame number */
>> 150 int last_delay; /* stored delay */
189 151
190 struct { 152 struct {
191 int marker; 153 int marker;
192 int channel; 154 int channel;
193 int byte_idx; 155 int byte_idx;
194 } dsd_dop; 156 } dsd_dop;
195 157
196 bool trigger_tstamp_pending_update; /* 158 bool trigger_tstamp_pending_update; /* trigger timestamp being updated from initial estimate */
197 bool lowlatency_playback; /* low <<
198 struct media_ctl *media_ctl; <<
199 }; 159 };
200 160
201 struct snd_usb_stream { 161 struct snd_usb_stream {
202 struct snd_usb_audio *chip; 162 struct snd_usb_audio *chip;
203 struct snd_pcm *pcm; 163 struct snd_pcm *pcm;
204 int pcm_index; 164 int pcm_index;
205 unsigned int fmt_type; /* USB 165 unsigned int fmt_type; /* USB audio format type (1-3) */
206 struct snd_usb_substream substream[2]; 166 struct snd_usb_substream substream[2];
207 struct list_head list; 167 struct list_head list;
208 }; 168 };
209 169
210 #endif /* __USBAUDIO_CARD_H */ 170 #endif /* __USBAUDIO_CARD_H */
211 171
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.