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