xref: /openbmc/linux/sound/usb/card.h (revision 95c96174)
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 };
31 
32 struct snd_usb_substream;
33 
34 struct snd_urb_ctx {
35 	struct urb *urb;
36 	unsigned int buffer_size;	/* size of data buffer, if data URB */
37 	struct snd_usb_substream *subs;
38 	int index;	/* index for urb array */
39 	int packets;	/* number of packets per urb */
40 };
41 
42 struct snd_urb_ops {
43 	int (*prepare)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
44 	int (*retire)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
45 	int (*prepare_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
46 	int (*retire_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
47 };
48 
49 struct snd_usb_substream {
50 	struct snd_usb_stream *stream;
51 	struct usb_device *dev;
52 	struct snd_pcm_substream *pcm_substream;
53 	int direction;	/* playback or capture */
54 	int interface;	/* current interface */
55 	int endpoint;	/* assigned endpoint */
56 	struct audioformat *cur_audiofmt;	/* current audioformat pointer (for hw_params callback) */
57 	unsigned int cur_rate;		/* current rate (for hw_params callback) */
58 	unsigned int period_bytes;	/* current period bytes (for hw_params callback) */
59 	unsigned int altset_idx;     /* USB data format: index of alternate setting */
60 	unsigned int datapipe;   /* the data i/o pipe */
61 	unsigned int syncpipe;   /* 1 - async out or adaptive in */
62 	unsigned int datainterval;	/* log_2 of data packet interval */
63 	unsigned int syncinterval;  /* P for adaptive mode, 0 otherwise */
64 	unsigned int freqn;      /* nominal sampling rate in fs/fps in Q16.16 format */
65 	unsigned int freqm;      /* momentary sampling rate in fs/fps in Q16.16 format */
66 	int          freqshift;  /* how much to shift the feedback value to get Q16.16 */
67 	unsigned int freqmax;    /* maximum sampling rate, used for buffer management */
68 	unsigned int phase;      /* phase accumulator */
69 	unsigned int maxpacksize;	/* max packet size in bytes */
70 	unsigned int maxframesize;	/* max packet size in frames */
71 	unsigned int curpacksize;	/* current packet size in bytes (for capture) */
72 	unsigned int curframesize;	/* current packet size in frames (for capture) */
73 	unsigned int syncmaxsize;	/* sync endpoint packet size */
74 	unsigned int fill_max: 1;	/* fill max packet size always */
75 	unsigned int txfr_quirk:1;	/* allow sub-frame alignment */
76 	unsigned int fmt_type;		/* USB audio format type (1-3) */
77 
78 	unsigned int running: 1;	/* running status */
79 
80 	unsigned int hwptr_done;	/* processed byte position in the buffer */
81 	unsigned int transfer_done;		/* processed frames since last period update */
82 	unsigned long active_mask;	/* bitmask of active urbs */
83 	unsigned long unlink_mask;	/* bitmask of unlinked urbs */
84 
85 	unsigned int nurbs;			/* # urbs */
86 	struct snd_urb_ctx dataurb[MAX_URBS];	/* data urb table */
87 	struct snd_urb_ctx syncurb[SYNC_URBS];	/* sync urb table */
88 	char *syncbuf;				/* sync buffer for all sync URBs */
89 	dma_addr_t sync_dma;			/* DMA address of syncbuf */
90 
91 	u64 formats;			/* format bitmasks (all or'ed) */
92 	unsigned int num_formats;		/* number of supported audio formats (list) */
93 	struct list_head fmt_list;	/* format list */
94 	struct snd_pcm_hw_constraint_list rate_list;	/* limited rates */
95 	spinlock_t lock;
96 
97 	struct snd_urb_ops ops;		/* callbacks (must be filled at init) */
98 	int last_frame_number;          /* stored frame number */
99 	int last_delay;                 /* stored delay */
100 };
101 
102 struct snd_usb_stream {
103 	struct snd_usb_audio *chip;
104 	struct snd_pcm *pcm;
105 	int pcm_index;
106 	unsigned int fmt_type;		/* USB audio format type (1-3) */
107 	struct snd_usb_substream substream[2];
108 	struct list_head list;
109 };
110 
111 #endif /* __USBAUDIO_CARD_H */
112