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