ALSA: usb-audio - Add support for USB X-Fi S51 Pro
[linux-2.6.git] / sound / usb / card.h
1 #ifndef __USBAUDIO_CARD_H
2 #define __USBAUDIO_CARD_H
3
4 #define MAX_PACKS       20
5 #define MAX_PACKS_HS    (MAX_PACKS * 8) /* in high speed mode */
6 #define MAX_URBS        8
7 #define SYNC_URBS       4       /* always four urbs for sync */
8 #define MAX_QUEUE       24      /* try not to exceed this queue length, in ms */
9
10 struct audioformat {
11         struct list_head list;
12         u64 formats;                    /* ALSA format bits */
13         unsigned int channels;          /* # channels */
14         unsigned int fmt_type;          /* USB audio format type (1-3) */
15         unsigned int frame_size;        /* samples per frame for non-audio */
16         int iface;                      /* interface number */
17         unsigned char altsetting;       /* corresponding alternate setting */
18         unsigned char altset_idx;       /* array index of altenate setting */
19         unsigned char attributes;       /* corresponding attributes of cs endpoint */
20         unsigned char endpoint;         /* endpoint */
21         unsigned char ep_attr;          /* endpoint attributes */
22         unsigned char datainterval;     /* log_2 of data packet interval */
23         unsigned int maxpacksize;       /* max. packet size */
24         unsigned int rates;             /* rate bitmasks */
25         unsigned int rate_min, rate_max;        /* min/max rates */
26         unsigned int nr_rates;          /* number of rate table entries */
27         unsigned int *rate_table;       /* rate table */
28         unsigned char clock;            /* associated clock */
29 };
30
31 struct snd_usb_substream;
32
33 struct snd_urb_ctx {
34         struct urb *urb;
35         unsigned int buffer_size;       /* size of data buffer, if data URB */
36         struct snd_usb_substream *subs;
37         int index;      /* index for urb array */
38         int packets;    /* number of packets per urb */
39 };
40
41 struct snd_urb_ops {
42         int (*prepare)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
43         int (*retire)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
44         int (*prepare_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
45         int (*retire_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
46 };
47
48 struct snd_usb_substream {
49         struct snd_usb_stream *stream;
50         struct usb_device *dev;
51         struct snd_pcm_substream *pcm_substream;
52         int direction;  /* playback or capture */
53         int interface;  /* current interface */
54         int endpoint;   /* assigned endpoint */
55         struct audioformat *cur_audiofmt;       /* current audioformat pointer (for hw_params callback) */
56         unsigned int cur_rate;          /* current rate (for hw_params callback) */
57         unsigned int period_bytes;      /* current period bytes (for hw_params callback) */
58         unsigned int altset_idx;     /* USB data format: index of alternate setting */
59         unsigned int datapipe;   /* the data i/o pipe */
60         unsigned int syncpipe;   /* 1 - async out or adaptive in */
61         unsigned int datainterval;      /* log_2 of data packet interval */
62         unsigned int syncinterval;  /* P for adaptive mode, 0 otherwise */
63         unsigned int freqn;      /* nominal sampling rate in fs/fps in Q16.16 format */
64         unsigned int freqm;      /* momentary sampling rate in fs/fps in Q16.16 format */
65         int          freqshift;  /* how much to shift the feedback value to get Q16.16 */
66         unsigned int freqmax;    /* maximum sampling rate, used for buffer management */
67         unsigned int phase;      /* phase accumulator */
68         unsigned int maxpacksize;       /* max packet size in bytes */
69         unsigned int maxframesize;      /* max packet size in frames */
70         unsigned int curpacksize;       /* current packet size in bytes (for capture) */
71         unsigned int curframesize;      /* current packet size in frames (for capture) */
72         unsigned int syncmaxsize;       /* sync endpoint packet size */
73         unsigned int fill_max: 1;       /* fill max packet size always */
74         unsigned int txfr_quirk:1;      /* allow sub-frame alignment */
75         unsigned int fmt_type;          /* USB audio format type (1-3) */
76
77         unsigned int running: 1;        /* running status */
78
79         unsigned int hwptr_done;        /* processed byte position in the buffer */
80         unsigned int transfer_done;             /* processed frames since last period update */
81         unsigned long active_mask;      /* bitmask of active urbs */
82         unsigned long unlink_mask;      /* bitmask of unlinked urbs */
83
84         unsigned int nurbs;                     /* # urbs */
85         struct snd_urb_ctx dataurb[MAX_URBS];   /* data urb table */
86         struct snd_urb_ctx syncurb[SYNC_URBS];  /* sync urb table */
87         char *syncbuf;                          /* sync buffer for all sync URBs */
88         dma_addr_t sync_dma;                    /* DMA address of syncbuf */
89
90         u64 formats;                    /* format bitmasks (all or'ed) */
91         unsigned int num_formats;               /* number of supported audio formats (list) */
92         struct list_head fmt_list;      /* format list */
93         struct snd_pcm_hw_constraint_list rate_list;    /* limited rates */
94         spinlock_t lock;
95
96         struct snd_urb_ops ops;         /* callbacks (must be filled at init) */
97 };
98
99 struct snd_usb_stream {
100         struct snd_usb_audio *chip;
101         struct snd_pcm *pcm;
102         int pcm_index;
103         unsigned int fmt_type;          /* USB audio format type (1-3) */
104         struct snd_usb_substream substream[2];
105         struct list_head list;
106 };
107
108 #endif /* __USBAUDIO_CARD_H */