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 fmt_sz; /* overall audio sub frame/slot size */ 19 unsigned int frame_size; /* samples per frame for non-audio */ 20 unsigned char iface; /* interface number */ 21 unsigned char altsetting; /* corresponding alternate setting */ 22 unsigned char ep_idx; /* endpoint array index */ 23 unsigned char altset_idx; /* array index of alternate setting */ 24 unsigned char attributes; /* corresponding attributes of cs endpoint */ 25 unsigned char endpoint; /* endpoint */ 26 unsigned char ep_attr; /* endpoint attributes */ 27 bool implicit_fb; /* implicit feedback endpoint */ 28 unsigned char sync_ep; /* sync endpoint number */ 29 unsigned char sync_iface; /* sync EP interface */ 30 unsigned char sync_altsetting; /* sync EP alternate setting */ 31 unsigned char sync_ep_idx; /* sync EP array index */ 32 unsigned char datainterval; /* log_2 of data packet interval */ 33 unsigned char protocol; /* UAC_VERSION_1/2/3 */ 34 unsigned int maxpacksize; /* max. packet size */ 35 unsigned int rates; /* rate bitmasks */ 36 unsigned int rate_min, rate_max; /* min/max rates */ 37 unsigned int nr_rates; /* number of rate table entries */ 38 unsigned int *rate_table; /* rate table */ 39 unsigned char clock; /* associated clock */ 40 struct snd_pcm_chmap_elem *chmap; /* (optional) channel map */ 41 bool dsd_dop; /* add DOP headers in case of DSD samples */ 42 bool dsd_bitrev; /* reverse the bits of each DSD sample */ 43 bool dsd_raw; /* altsetting is raw DSD */ 44 }; 45 46 struct snd_usb_substream; 47 struct snd_usb_iface_ref; 48 struct snd_usb_clock_ref; 49 struct snd_usb_endpoint; 50 struct snd_usb_power_domain; 51 52 struct snd_urb_ctx { 53 struct urb *urb; 54 unsigned int buffer_size; /* size of data buffer, if data URB */ 55 struct snd_usb_substream *subs; 56 struct snd_usb_endpoint *ep; 57 int index; /* index for urb array */ 58 int packets; /* number of packets per urb */ 59 int queued; /* queued data bytes by this urb */ 60 int packet_size[MAX_PACKS_HS]; /* size of packets for next submission */ 61 struct list_head ready_list; 62 }; 63 64 struct snd_usb_endpoint { 65 struct snd_usb_audio *chip; 66 struct snd_usb_iface_ref *iface_ref; 67 struct snd_usb_clock_ref *clock_ref; 68 69 int opened; /* open refcount; protect with chip->mutex */ 70 atomic_t running; /* running status */ 71 int ep_num; /* the referenced endpoint number */ 72 int type; /* SND_USB_ENDPOINT_TYPE_* */ 73 74 unsigned char iface; /* interface number */ 75 unsigned char altsetting; /* corresponding alternate setting */ 76 unsigned char ep_idx; /* endpoint array index */ 77 78 atomic_t state; /* running state */ 79 80 int (*prepare_data_urb) (struct snd_usb_substream *subs, 81 struct urb *urb, 82 bool in_stream_lock); 83 void (*retire_data_urb) (struct snd_usb_substream *subs, 84 struct urb *urb); 85 86 struct snd_usb_substream *data_subs; 87 struct snd_usb_endpoint *sync_source; 88 struct snd_usb_endpoint *sync_sink; 89 90 struct snd_urb_ctx urb[MAX_URBS]; 91 92 struct snd_usb_packet_info { 93 int packet_size[MAX_PACKS_HS]; 94 int packets; 95 } next_packet[MAX_URBS]; 96 unsigned int next_packet_head; /* ring buffer offset to read */ 97 unsigned int next_packet_queued; /* queued items in the ring buffer */ 98 struct list_head ready_playback_urbs; /* playback URB FIFO for implicit fb */ 99 100 unsigned int nurbs; /* # urbs */ 101 unsigned long active_mask; /* bitmask of active urbs */ 102 unsigned long unlink_mask; /* bitmask of unlinked urbs */ 103 atomic_t submitted_urbs; /* currently submitted urbs */ 104 char *syncbuf; /* sync buffer for all sync URBs */ 105 dma_addr_t sync_dma; /* DMA address of syncbuf */ 106 107 unsigned int pipe; /* the data i/o pipe */ 108 unsigned int packsize[2]; /* small/large packet sizes in samples */ 109 unsigned int sample_rem; /* remainder from division fs/pps */ 110 unsigned int sample_accum; /* sample accumulator */ 111 unsigned int pps; /* packets per second */ 112 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */ 113 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */ 114 int freqshift; /* how much to shift the feedback value to get Q16.16 */ 115 unsigned int freqmax; /* maximum sampling rate, used for buffer management */ 116 unsigned int phase; /* phase accumulator */ 117 unsigned int maxpacksize; /* max packet size in bytes */ 118 unsigned int maxframesize; /* max packet size in frames */ 119 unsigned int max_urb_packs; /* packets allocated per data URB */ 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 152 struct media_ctl; 153 154 struct snd_usb_substream { 155 struct snd_usb_stream *stream; 156 struct usb_device *dev; 157 struct snd_pcm_substream *pcm_substream; 158 int direction; /* playback or capture */ 159 int endpoint; /* assigned endpoint */ 160 const struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */ 161 struct snd_usb_power_domain *str_pd; /* UAC3 Power Domain for streaming path */ 162 unsigned int channels_max; /* max channels in the all audiofmts */ 163 unsigned int txfr_quirk:1; /* allow sub-frame alignment */ 164 unsigned int tx_length_quirk:1; /* add length specifier to transfers */ 165 unsigned int fmt_type; /* USB audio format type (1-3) */ 166 unsigned int pkt_offset_adj; /* Bytes to drop from beginning of packets (for non-compliant devices) */ 167 unsigned int stream_offset_adj; /* Bytes to drop from beginning of stream (for non-compliant devices) */ 168 169 unsigned int opened:1; /* pcm device opened */ 170 unsigned int running: 1; /* running status */ 171 unsigned int period_elapsed_pending; /* delay period handling */ 172 173 unsigned int buffer_bytes; /* buffer size in bytes */ 174 unsigned int inflight_bytes; /* in-flight data bytes on buffer (for playback) */ 175 unsigned int hwptr_done; /* processed byte position in the buffer */ 176 unsigned int transfer_done; /* processed frames since last period update */ 177 unsigned int frame_limit; /* limits number of packets in URB */ 178 179 /* data and sync endpoints for this stream */ 180 unsigned int ep_num; /* the endpoint number */ 181 struct snd_usb_endpoint *data_endpoint; 182 struct snd_usb_endpoint *sync_endpoint; 183 unsigned long flags; 184 unsigned int speed; /* USB_SPEED_XXX */ 185 186 u64 formats; /* format bitmasks (all or'ed) */ 187 unsigned int num_formats; /* number of supported audio formats (list) */ 188 struct list_head fmt_list; /* format list */ 189 spinlock_t lock; 190 191 unsigned int last_frame_number; /* stored frame number */ 192 193 struct { 194 int marker; 195 int channel; 196 int byte_idx; 197 } dsd_dop; 198 199 bool trigger_tstamp_pending_update; /* trigger timestamp being updated from initial estimate */ 200 bool lowlatency_playback; /* low-latency playback mode */ 201 struct media_ctl *media_ctl; 202 }; 203 204 struct snd_usb_stream { 205 struct snd_usb_audio *chip; 206 struct snd_pcm *pcm; 207 int pcm_index; 208 unsigned int fmt_type; /* USB audio format type (1-3) */ 209 struct snd_usb_substream substream[2]; 210 struct list_head list; 211 }; 212 213 struct snd_usb_platform_ops { 214 void (*connect_cb)(struct snd_usb_audio *chip); 215 void (*disconnect_cb)(struct snd_usb_audio *chip); 216 void (*suspend_cb)(struct usb_interface *intf, pm_message_t message); 217 void (*resume_cb)(struct usb_interface *intf); 218 }; 219 220 struct snd_usb_stream * 221 snd_usb_find_suppported_substream(int card_idx, struct snd_pcm_hw_params *params, 222 int direction); 223 224 int snd_usb_register_platform_ops(struct snd_usb_platform_ops *ops); 225 int snd_usb_unregister_platform_ops(void); 226 227 void snd_usb_rediscover_devices(void); 228 #endif /* __USBAUDIO_CARD_H */ 229