xref: /linux/sound/usb/card.h (revision 7034228792cc561e79ff8600f02884bd4c80e287)
1 #ifndef __USBAUDIO_CARD_H
2 #define __USBAUDIO_CARD_H
3 
4 #define MAX_NR_RATES	1024
5 #define MAX_PACKS	20
6 #define MAX_PACKS_HS	(MAX_PACKS * 8)	/* in high speed mode */
7 #define MAX_URBS	8
8 #define SYNC_URBS	4	/* always four urbs for sync */
9 #define MAX_QUEUE	24	/* try not to exceed this queue length, in ms */
10 
11 struct audioformat {
12 	struct list_head list;
13 	u64 formats;			/* ALSA format bits */
14 	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 */
24 	unsigned int maxpacksize;	/* max. packet size */
25 	unsigned int rates;		/* rate bitmasks */
26 	unsigned int rate_min, rate_max;	/* min/max rates */
27 	unsigned int nr_rates;		/* number of rate table entries */
28 	unsigned int *rate_table;	/* rate table */
29 	unsigned char clock;		/* associated clock */
30 	struct snd_pcm_chmap_elem *chmap; /* (optional) channel map */
31 };
32 
33 struct snd_usb_substream;
34 struct snd_usb_endpoint;
35 
36 struct snd_urb_ctx {
37 	struct urb *urb;
38 	unsigned int buffer_size;	/* size of data buffer, if data URB */
39 	struct snd_usb_substream *subs;
40 	struct snd_usb_endpoint *ep;
41 	int index;	/* index for urb array */
42 	int packets;	/* number of packets per urb */
43 	int packet_size[MAX_PACKS_HS]; /* size of packets for next submission */
44 	struct list_head ready_list;
45 };
46 
47 struct snd_usb_endpoint {
48 	struct snd_usb_audio *chip;
49 
50 	int use_count;
51 	int ep_num;		/* the referenced endpoint number */
52 	int type;		/* SND_USB_ENDPOINT_TYPE_* */
53 	unsigned long flags;
54 
55 	void (*prepare_data_urb) (struct snd_usb_substream *subs,
56 				  struct urb *urb);
57 	void (*retire_data_urb) (struct snd_usb_substream *subs,
58 				 struct urb *urb);
59 
60 	struct snd_usb_substream *data_subs;
61 	struct snd_usb_endpoint *sync_master;
62 	struct snd_usb_endpoint *sync_slave;
63 
64 	struct snd_urb_ctx urb[MAX_URBS];
65 
66 	struct snd_usb_packet_info {
67 		uint32_t packet_size[MAX_PACKS_HS];
68 		int packets;
69 	} next_packet[MAX_URBS];
70 	int next_packet_read_pos, next_packet_write_pos;
71 	struct list_head ready_playback_urbs;
72 
73 	unsigned int nurbs;		/* # urbs */
74 	unsigned long active_mask;	/* bitmask of active urbs */
75 	unsigned long unlink_mask;	/* bitmask of unlinked urbs */
76 	char *syncbuf;			/* sync buffer for all sync URBs */
77 	dma_addr_t sync_dma;		/* DMA address of syncbuf */
78 
79 	unsigned int pipe;		/* the data i/o pipe */
80 	unsigned int freqn;		/* nominal sampling rate in fs/fps in Q16.16 format */
81 	unsigned int freqm;		/* momentary sampling rate in fs/fps in Q16.16 format */
82 	int	   freqshift;		/* how much to shift the feedback value to get Q16.16 */
83 	unsigned int freqmax;		/* maximum sampling rate, used for buffer management */
84 	unsigned int phase;		/* phase accumulator */
85 	unsigned int maxpacksize;	/* max packet size in bytes */
86 	unsigned int maxframesize;      /* max packet size in frames */
87 	unsigned int curpacksize;	/* current packet size in bytes (for capture) */
88 	unsigned int curframesize;      /* current packet size in frames (for capture) */
89 	unsigned int syncmaxsize;	/* sync endpoint packet size */
90 	unsigned int fill_max:1;	/* fill max packet size always */
91 	unsigned int datainterval;      /* log_2 of data packet interval */
92 	unsigned int syncinterval;	/* P for adaptive mode, 0 otherwise */
93 	unsigned char silence_value;
94 	unsigned int stride;
95 	int iface, alt_idx;
96 	int skip_packets;		/* quirks for devices to ignore the first n packets
97 					   in a stream */
98 
99 	spinlock_t lock;
100 	struct list_head list;
101 };
102 
103 struct snd_usb_substream {
104 	struct snd_usb_stream *stream;
105 	struct usb_device *dev;
106 	struct snd_pcm_substream *pcm_substream;
107 	int direction;	/* playback or capture */
108 	int interface;	/* current interface */
109 	int endpoint;	/* assigned endpoint */
110 	struct audioformat *cur_audiofmt;	/* current audioformat pointer (for hw_params callback) */
111 	snd_pcm_format_t pcm_format;	/* current audio format (for hw_params callback) */
112 	unsigned int channels;		/* current number of channels (for hw_params callback) */
113 	unsigned int channels_max;	/* max channels in the all audiofmts */
114 	unsigned int cur_rate;		/* current rate (for hw_params callback) */
115 	unsigned int period_bytes;	/* current period bytes (for hw_params callback) */
116 	unsigned int altset_idx;     /* USB data format: index of alternate setting */
117 	unsigned int txfr_quirk:1;	/* allow sub-frame alignment */
118 	unsigned int fmt_type;		/* USB audio format type (1-3) */
119 
120 	unsigned int running: 1;	/* running status */
121 
122 	unsigned int hwptr_done;	/* processed byte position in the buffer */
123 	unsigned int transfer_done;		/* processed frames since last period update */
124 
125 	/* data and sync endpoints for this stream */
126 	unsigned int ep_num;		/* the endpoint number */
127 	struct snd_usb_endpoint *data_endpoint;
128 	struct snd_usb_endpoint *sync_endpoint;
129 	unsigned long flags;
130 	bool need_setup_ep;		/* (re)configure EP at prepare? */
131 	unsigned int speed;		/* USB_SPEED_XXX */
132 
133 	u64 formats;			/* format bitmasks (all or'ed) */
134 	unsigned int num_formats;		/* number of supported audio formats (list) */
135 	struct list_head fmt_list;	/* format list */
136 	struct snd_pcm_hw_constraint_list rate_list;	/* limited rates */
137 	spinlock_t lock;
138 
139 	int last_frame_number;          /* stored frame number */
140 	int last_delay;                 /* stored delay */
141 };
142 
143 struct snd_usb_stream {
144 	struct snd_usb_audio *chip;
145 	struct snd_pcm *pcm;
146 	int pcm_index;
147 	unsigned int fmt_type;		/* USB audio format type (1-3) */
148 	struct snd_usb_substream substream[2];
149 	struct list_head list;
150 };
151 
152 #endif /* __USBAUDIO_CARD_H */
153