1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __USBAUDIO_CARD_H 3 #define __USBAUDIO_CARD_H 4 5 #include <linux/android_kabi.h> 6 7 #define MAX_NR_RATES 1024 8 #define MAX_PACKS 6 /* per URB */ 9 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */ 10 #define MAX_URBS 12 11 #define SYNC_URBS 4 /* always four urbs for sync */ 12 #define MAX_QUEUE 18 /* try not to exceed this queue length, in ms */ 13 14 struct audioformat { 15 struct list_head list; 16 u64 formats; /* ALSA format bits */ 17 unsigned int channels; /* # channels */ 18 unsigned int fmt_type; /* USB audio format type (1-3) */ 19 unsigned int fmt_bits; /* number of significant bits */ 20 unsigned int frame_size; /* samples per frame for non-audio */ 21 unsigned char iface; /* interface number */ 22 unsigned char altsetting; /* corresponding alternate setting */ 23 unsigned char ep_idx; /* endpoint array index */ 24 unsigned char altset_idx; /* array index of alternate setting */ 25 unsigned char attributes; /* corresponding attributes of cs endpoint */ 26 unsigned char endpoint; /* endpoint */ 27 unsigned char ep_attr; /* endpoint attributes */ 28 bool implicit_fb; /* implicit feedback endpoint */ 29 unsigned char sync_ep; /* sync endpoint number */ 30 unsigned char sync_iface; /* sync EP interface */ 31 unsigned char sync_altsetting; /* sync EP alternate setting */ 32 unsigned char sync_ep_idx; /* sync EP array index */ 33 unsigned char datainterval; /* log_2 of data packet interval */ 34 unsigned char protocol; /* UAC_VERSION_1/2/3 */ 35 unsigned int maxpacksize; /* max. packet size */ 36 unsigned int rates; /* rate bitmasks */ 37 unsigned int rate_min, rate_max; /* min/max rates */ 38 unsigned int nr_rates; /* number of rate table entries */ 39 unsigned int *rate_table; /* rate table */ 40 unsigned char clock; /* associated clock */ 41 struct snd_pcm_chmap_elem *chmap; /* (optional) channel map */ 42 bool dsd_dop; /* add DOP headers in case of DSD samples */ 43 bool dsd_bitrev; /* reverse the bits of each DSD sample */ 44 bool dsd_raw; /* altsetting is raw DSD */ 45 }; 46 47 struct snd_usb_substream; 48 struct snd_usb_iface_ref; 49 struct snd_usb_clock_ref; 50 struct snd_usb_endpoint; 51 struct snd_usb_power_domain; 52 53 struct snd_urb_ctx { 54 struct urb *urb; 55 unsigned int buffer_size; /* size of data buffer, if data URB */ 56 struct snd_usb_substream *subs; 57 struct snd_usb_endpoint *ep; 58 int index; /* index for urb array */ 59 int packets; /* number of packets per urb */ 60 int queued; /* queued data bytes by this urb */ 61 int packet_size[MAX_PACKS_HS]; /* size of packets for next submission */ 62 struct list_head ready_list; 63 }; 64 65 struct snd_usb_endpoint { 66 struct snd_usb_audio *chip; 67 struct snd_usb_iface_ref *iface_ref; 68 struct snd_usb_clock_ref *clock_ref; 69 70 int opened; /* open refcount; protect with chip->mutex */ 71 atomic_t running; /* running status */ 72 int ep_num; /* the referenced endpoint number */ 73 int type; /* SND_USB_ENDPOINT_TYPE_* */ 74 75 unsigned char iface; /* interface number */ 76 unsigned char altsetting; /* corresponding alternate setting */ 77 unsigned char ep_idx; /* endpoint array index */ 78 79 atomic_t state; /* running state */ 80 81 int (*prepare_data_urb) (struct snd_usb_substream *subs, 82 struct urb *urb, 83 bool in_stream_lock); 84 void (*retire_data_urb) (struct snd_usb_substream *subs, 85 struct urb *urb); 86 87 struct snd_usb_substream *data_subs; 88 struct snd_usb_endpoint *sync_source; 89 struct snd_usb_endpoint *sync_sink; 90 91 struct snd_urb_ctx urb[MAX_URBS]; 92 93 struct snd_usb_packet_info { 94 uint32_t packet_size[MAX_PACKS_HS]; 95 int packets; 96 } next_packet[MAX_URBS]; 97 unsigned int next_packet_head; /* ring buffer offset to read */ 98 unsigned int next_packet_queued; /* queued items in the ring buffer */ 99 struct list_head ready_playback_urbs; /* playback URB FIFO for implicit fb */ 100 101 unsigned int nurbs; /* # urbs */ 102 unsigned long active_mask; /* bitmask of active urbs */ 103 unsigned long unlink_mask; /* bitmask of unlinked urbs */ 104 atomic_t submitted_urbs; /* currently submitted urbs */ 105 char *syncbuf; /* sync buffer for all sync URBs */ 106 dma_addr_t sync_dma; /* DMA address of syncbuf */ 107 108 unsigned int pipe; /* the data i/o pipe */ 109 unsigned int packsize[2]; /* small/large packet sizes in samples */ 110 unsigned int sample_rem; /* remainder from division fs/pps */ 111 unsigned int sample_accum; /* sample accumulator */ 112 unsigned int pps; /* packets per second */ 113 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */ 114 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */ 115 int freqshift; /* how much to shift the feedback value to get Q16.16 */ 116 unsigned int freqmax; /* maximum sampling rate, used for buffer management */ 117 unsigned int phase; /* phase accumulator */ 118 unsigned int maxpacksize; /* max packet size in bytes */ 119 unsigned int maxframesize; /* max packet size in frames */ 120 unsigned int max_urb_frames; /* max URB size in frames */ 121 unsigned int curpacksize; /* current packet size in bytes (for capture) */ 122 unsigned int curframesize; /* current packet size in frames (for capture) */ 123 unsigned int syncmaxsize; /* sync endpoint packet size */ 124 unsigned int fill_max:1; /* fill max packet size always */ 125 unsigned int tenor_fb_quirk:1; /* corrupted feedback data */ 126 unsigned int datainterval; /* log_2 of data packet interval */ 127 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */ 128 unsigned char silence_value; 129 unsigned int stride; 130 int skip_packets; /* quirks for devices to ignore the first n packets 131 in a stream */ 132 bool implicit_fb_sync; /* syncs with implicit feedback */ 133 bool lowlatency_playback; /* low-latency playback mode */ 134 bool need_setup; /* (re-)need for hw_params? */ 135 bool need_prepare; /* (re-)need for prepare? */ 136 bool fixed_rate; /* skip rate setup */ 137 138 /* for hw constraints */ 139 const struct audioformat *cur_audiofmt; 140 unsigned int cur_rate; 141 snd_pcm_format_t cur_format; 142 unsigned int cur_channels; 143 unsigned int cur_frame_bytes; 144 unsigned int cur_period_frames; 145 unsigned int cur_period_bytes; 146 unsigned int cur_buffer_periods; 147 148 spinlock_t lock; 149 struct list_head list; 150 151 ANDROID_KABI_RESERVE(1); 152 ANDROID_KABI_RESERVE(2); 153 ANDROID_KABI_RESERVE(3); 154 ANDROID_KABI_RESERVE(4); 155 }; 156 157 struct media_ctl; 158 159 struct snd_usb_substream { 160 struct snd_usb_stream *stream; 161 struct usb_device *dev; 162 struct snd_pcm_substream *pcm_substream; 163 int direction; /* playback or capture */ 164 int endpoint; /* assigned endpoint */ 165 const struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */ 166 struct snd_usb_power_domain *str_pd; /* UAC3 Power Domain for streaming path */ 167 unsigned int channels_max; /* max channels in the all audiofmts */ 168 unsigned int txfr_quirk:1; /* allow sub-frame alignment */ 169 unsigned int tx_length_quirk:1; /* add length specifier to transfers */ 170 unsigned int fmt_type; /* USB audio format type (1-3) */ 171 unsigned int pkt_offset_adj; /* Bytes to drop from beginning of packets (for non-compliant devices) */ 172 unsigned int stream_offset_adj; /* Bytes to drop from beginning of stream (for non-compliant devices) */ 173 174 unsigned int running: 1; /* running status */ 175 unsigned int period_elapsed_pending; /* delay period handling */ 176 177 unsigned int buffer_bytes; /* buffer size in bytes */ 178 unsigned int inflight_bytes; /* in-flight data bytes on buffer (for playback) */ 179 unsigned int hwptr_done; /* processed byte position in the buffer */ 180 unsigned int transfer_done; /* processed frames since last period update */ 181 unsigned int frame_limit; /* limits number of packets in URB */ 182 183 /* data and sync endpoints for this stream */ 184 unsigned int ep_num; /* the endpoint number */ 185 struct snd_usb_endpoint *data_endpoint; 186 struct snd_usb_endpoint *sync_endpoint; 187 unsigned long flags; 188 unsigned int speed; /* USB_SPEED_XXX */ 189 190 u64 formats; /* format bitmasks (all or'ed) */ 191 unsigned int num_formats; /* number of supported audio formats (list) */ 192 struct list_head fmt_list; /* format list */ 193 spinlock_t lock; 194 195 unsigned int last_frame_number; /* stored frame number */ 196 197 struct { 198 int marker; 199 int channel; 200 int byte_idx; 201 } dsd_dop; 202 203 bool trigger_tstamp_pending_update; /* trigger timestamp being updated from initial estimate */ 204 bool lowlatency_playback; /* low-latency playback mode */ 205 struct media_ctl *media_ctl; 206 207 ANDROID_KABI_RESERVE(1); 208 }; 209 210 struct snd_usb_stream { 211 struct snd_usb_audio *chip; 212 struct snd_pcm *pcm; 213 int pcm_index; 214 unsigned int fmt_type; /* USB audio format type (1-3) */ 215 struct snd_usb_substream substream[2]; 216 struct list_head list; 217 }; 218 219 int snd_vendor_set_ops(struct snd_usb_audio_vendor_ops *vendor_ops); 220 struct snd_usb_audio_vendor_ops *snd_vendor_get_ops(void); 221 int snd_vendor_set_interface(struct usb_device *udev, 222 struct usb_host_interface *alts, 223 int iface, int alt); 224 int snd_vendor_set_rate(int iface, int rate, int alt); 225 int snd_vendor_set_pcm_intf(struct usb_interface *intf, int iface, int alt, 226 int direction, struct snd_usb_substream *subs); 227 int snd_vendor_set_pcm_connection(struct usb_device *udev, 228 enum snd_vendor_pcm_open_close onoff, 229 int direction); 230 int snd_vendor_set_pcm_binterval(const struct audioformat *fp, 231 const struct audioformat *found, 232 int *cur_attr, int *attr); 233 234 #endif /* __USBAUDIO_CARD_H */ 235