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