blob: ef580b43f1e3b1e71dcc4ed0f6a16f11928e071e [file] [log] [blame]
Daniel Macke5779992010-03-04 19:46:13 +01001#ifndef __USBAUDIO_CARD_H
2#define __USBAUDIO_CARD_H
3
Xi Wang8866f402012-02-14 05:18:48 -05004#define MAX_NR_RATES 1024
Alan Stern976b6c02013-09-24 15:51:58 -04005#define MAX_PACKS 6 /* per URB */
Daniel Macke5779992010-03-04 19:46:13 +01006#define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
Alan Stern976b6c02013-09-24 15:51:58 -04007#define MAX_URBS 12
Daniel Macke5779992010-03-04 19:46:13 +01008#define SYNC_URBS 4 /* always four urbs for sync */
Alan Stern976b6c02013-09-24 15:51:58 -04009#define MAX_QUEUE 18 /* try not to exceed this queue length, in ms */
Daniel Macke5779992010-03-04 19:46:13 +010010
11struct audioformat {
12 struct list_head list;
Clemens Ladisch015eb0b2010-03-04 19:46:15 +010013 u64 formats; /* ALSA format bits */
Daniel Macke5779992010-03-04 19:46:13 +010014 unsigned int channels; /* # channels */
15 unsigned int fmt_type; /* USB audio format type (1-3) */
16 unsigned int frame_size; /* samples per frame for non-audio */
17 int iface; /* interface number */
18 unsigned char altsetting; /* corresponding alternate setting */
19 unsigned char altset_idx; /* array index of altenate setting */
20 unsigned char attributes; /* corresponding attributes of cs endpoint */
21 unsigned char endpoint; /* endpoint */
22 unsigned char ep_attr; /* endpoint attributes */
23 unsigned char datainterval; /* log_2 of data packet interval */
Clemens Ladisch8f898e92013-01-31 21:39:17 +010024 unsigned char protocol; /* UAC_VERSION_1/2 */
Daniel Macke5779992010-03-04 19:46:13 +010025 unsigned int maxpacksize; /* max. packet size */
26 unsigned int rates; /* rate bitmasks */
27 unsigned int rate_min, rate_max; /* min/max rates */
28 unsigned int nr_rates; /* number of rate table entries */
29 unsigned int *rate_table; /* rate table */
Daniel Mack79f920f2010-05-31 14:51:31 +020030 unsigned char clock; /* associated clock */
Takashi Iwai04324cc2012-11-26 16:24:02 +010031 struct snd_pcm_chmap_elem *chmap; /* (optional) channel map */
Daniel Mackd24f5062013-04-17 00:01:38 +080032 bool dsd_dop; /* add DOP headers in case of DSD samples */
Daniel Mack44dcbbb2013-04-17 00:01:39 +080033 bool dsd_bitrev; /* reverse the bits of each DSD sample */
Daniel Macke5779992010-03-04 19:46:13 +010034};
35
36struct snd_usb_substream;
Daniel Mack8fdff6a2012-04-12 13:51:11 +020037struct snd_usb_endpoint;
Daniel Macke5779992010-03-04 19:46:13 +010038
39struct snd_urb_ctx {
40 struct urb *urb;
41 unsigned int buffer_size; /* size of data buffer, if data URB */
42 struct snd_usb_substream *subs;
Daniel Mack8fdff6a2012-04-12 13:51:11 +020043 struct snd_usb_endpoint *ep;
Daniel Macke5779992010-03-04 19:46:13 +010044 int index; /* index for urb array */
45 int packets; /* number of packets per urb */
Daniel Mack8fdff6a2012-04-12 13:51:11 +020046 int packet_size[MAX_PACKS_HS]; /* size of packets for next submission */
47 struct list_head ready_list;
Daniel Macke5779992010-03-04 19:46:13 +010048};
49
Daniel Mack8fdff6a2012-04-12 13:51:11 +020050struct snd_usb_endpoint {
51 struct snd_usb_audio *chip;
52
53 int use_count;
54 int ep_num; /* the referenced endpoint number */
55 int type; /* SND_USB_ENDPOINT_TYPE_* */
56 unsigned long flags;
57
58 void (*prepare_data_urb) (struct snd_usb_substream *subs,
59 struct urb *urb);
60 void (*retire_data_urb) (struct snd_usb_substream *subs,
61 struct urb *urb);
62
63 struct snd_usb_substream *data_subs;
64 struct snd_usb_endpoint *sync_master;
65 struct snd_usb_endpoint *sync_slave;
66
67 struct snd_urb_ctx urb[MAX_URBS];
68
69 struct snd_usb_packet_info {
70 uint32_t packet_size[MAX_PACKS_HS];
71 int packets;
72 } next_packet[MAX_URBS];
73 int next_packet_read_pos, next_packet_write_pos;
74 struct list_head ready_playback_urbs;
75
76 unsigned int nurbs; /* # urbs */
77 unsigned long active_mask; /* bitmask of active urbs */
78 unsigned long unlink_mask; /* bitmask of unlinked urbs */
79 char *syncbuf; /* sync buffer for all sync URBs */
80 dma_addr_t sync_dma; /* DMA address of syncbuf */
81
82 unsigned int pipe; /* the data i/o pipe */
83 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
84 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
85 int freqshift; /* how much to shift the feedback value to get Q16.16 */
86 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
87 unsigned int phase; /* phase accumulator */
88 unsigned int maxpacksize; /* max packet size in bytes */
89 unsigned int maxframesize; /* max packet size in frames */
Alan Stern976b6c02013-09-24 15:51:58 -040090 unsigned int max_urb_frames; /* max URB size in frames */
Daniel Mack8fdff6a2012-04-12 13:51:11 +020091 unsigned int curpacksize; /* current packet size in bytes (for capture) */
92 unsigned int curframesize; /* current packet size in frames (for capture) */
93 unsigned int syncmaxsize; /* sync endpoint packet size */
94 unsigned int fill_max:1; /* fill max packet size always */
Clemens Ladisch7040b6d2014-05-01 12:20:22 +020095 unsigned int udh01_fb_quirk:1; /* corrupted feedback data */
Daniel Mack8fdff6a2012-04-12 13:51:11 +020096 unsigned int datainterval; /* log_2 of data packet interval */
97 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
98 unsigned char silence_value;
99 unsigned int stride;
Eldad Zackdf23a242013-10-06 22:31:13 +0200100 int iface, altsetting;
Daniel Mack2b58fd52012-09-04 10:23:07 +0200101 int skip_packets; /* quirks for devices to ignore the first n packets
102 in a stream */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200103
104 spinlock_t lock;
105 struct list_head list;
106};
107
Daniel Macke5779992010-03-04 19:46:13 +0100108struct snd_usb_substream {
109 struct snd_usb_stream *stream;
110 struct usb_device *dev;
111 struct snd_pcm_substream *pcm_substream;
112 int direction; /* playback or capture */
113 int interface; /* current interface */
114 int endpoint; /* assigned endpoint */
115 struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
Dylan Reid61a70952012-09-18 09:49:48 -0700116 snd_pcm_format_t pcm_format; /* current audio format (for hw_params callback) */
117 unsigned int channels; /* current number of channels (for hw_params callback) */
Takashi Iwai04324cc2012-11-26 16:24:02 +0100118 unsigned int channels_max; /* max channels in the all audiofmts */
Daniel Macke5779992010-03-04 19:46:13 +0100119 unsigned int cur_rate; /* current rate (for hw_params callback) */
120 unsigned int period_bytes; /* current period bytes (for hw_params callback) */
Alan Stern976b6c02013-09-24 15:51:58 -0400121 unsigned int period_frames; /* current frames per period */
122 unsigned int buffer_periods; /* current periods per buffer */
Clemens Ladische11b4e02010-03-04 19:46:14 +0100123 unsigned int altset_idx; /* USB data format: index of alternate setting */
Daniel Macke5779992010-03-04 19:46:13 +0100124 unsigned int txfr_quirk:1; /* allow sub-frame alignment */
125 unsigned int fmt_type; /* USB audio format type (1-3) */
Calvin Owens1539d4f2013-04-12 22:33:59 -0500126 unsigned int pkt_offset_adj; /* Bytes to drop from beginning of packets (for non-compliant devices) */
Daniel Macke5779992010-03-04 19:46:13 +0100127
128 unsigned int running: 1; /* running status */
129
130 unsigned int hwptr_done; /* processed byte position in the buffer */
131 unsigned int transfer_done; /* processed frames since last period update */
Alan Stern976b6c02013-09-24 15:51:58 -0400132 unsigned int frame_limit; /* limits number of packets in URB */
Daniel Macke5779992010-03-04 19:46:13 +0100133
Daniel Mackedcd3632012-04-12 13:51:12 +0200134 /* data and sync endpoints for this stream */
Takashi Iwai8260ef02012-06-08 09:01:37 +0200135 unsigned int ep_num; /* the endpoint number */
Daniel Mackedcd3632012-04-12 13:51:12 +0200136 struct snd_usb_endpoint *data_endpoint;
137 struct snd_usb_endpoint *sync_endpoint;
138 unsigned long flags;
Takashi Iwai384dc0852012-09-18 14:49:31 +0200139 bool need_setup_ep; /* (re)configure EP at prepare? */
Takashi Iwai978520b2012-10-12 15:12:55 +0200140 unsigned int speed; /* USB_SPEED_XXX */
Daniel Macke5779992010-03-04 19:46:13 +0100141
142 u64 formats; /* format bitmasks (all or'ed) */
143 unsigned int num_formats; /* number of supported audio formats (list) */
144 struct list_head fmt_list; /* format list */
145 struct snd_pcm_hw_constraint_list rate_list; /* limited rates */
146 spinlock_t lock;
147
Pierre-Louis Bossart294c4fb2011-09-06 19:15:34 -0500148 int last_frame_number; /* stored frame number */
149 int last_delay; /* stored delay */
Daniel Mackd24f5062013-04-17 00:01:38 +0800150
151 struct {
152 int marker;
153 int channel;
154 int byte_idx;
155 } dsd_dop;
Pierre-Louis Bossartea33d352015-02-06 15:55:53 -0600156
157 bool trigger_tstamp_pending_update; /* trigger timestamp being updated from initial estimate */
Daniel Macke5779992010-03-04 19:46:13 +0100158};
159
160struct snd_usb_stream {
161 struct snd_usb_audio *chip;
162 struct snd_pcm *pcm;
163 int pcm_index;
164 unsigned int fmt_type; /* USB audio format type (1-3) */
165 struct snd_usb_substream substream[2];
166 struct list_head list;
167};
168
169#endif /* __USBAUDIO_CARD_H */