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