[deliverable/linux.git] / sound / usb / card.h

#ifndef __USBAUDIO_CARD_H
#define __USBAUDIO_CARD_H

#define MAX_NR_RATES	1024
#define MAX_PACKS	20
#define MAX_PACKS_HS	(MAX_PACKS * 8)	/* in high speed mode */
#define MAX_URBS	8
#define SYNC_URBS	4	/* always four urbs for sync */
#define MAX_QUEUE	24	/* try not to exceed this queue length, in ms */

struct audioformat {
	struct list_head list;
	u64 formats;			/* ALSA format bits */
	unsigned int channels;		/* # channels */
	unsigned int fmt_type;		/* USB audio format type (1-3) */
	unsigned int frame_size;	/* samples per frame for non-audio */
	int iface;			/* interface number */
	unsigned char altsetting;	/* corresponding alternate setting */
	unsigned char altset_idx;	/* array index of altenate setting */
	unsigned char attributes;	/* corresponding attributes of cs endpoint */
	unsigned char endpoint;		/* endpoint */
	unsigned char ep_attr;		/* endpoint attributes */
	unsigned char datainterval;	/* log_2 of data packet interval */
	unsigned int maxpacksize;	/* max. packet size */
	unsigned int rates;		/* rate bitmasks */
	unsigned int rate_min, rate_max;	/* min/max rates */
	unsigned int nr_rates;		/* number of rate table entries */
	unsigned int *rate_table;	/* rate table */
	unsigned char clock;		/* associated clock */
};

struct snd_usb_substream;
struct snd_usb_endpoint;

struct snd_urb_ctx {
	struct urb *urb;
	unsigned int buffer_size;	/* size of data buffer, if data URB */
	struct snd_usb_substream *subs;
	struct snd_usb_endpoint *ep;
	int index;	/* index for urb array */
	int packets;	/* number of packets per urb */
	int packet_size[MAX_PACKS_HS]; /* size of packets for next submission */
	struct list_head ready_list;
};

struct snd_urb_ops {
	int (*prepare)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
	int (*retire)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
	int (*prepare_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
	int (*retire_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
};

struct snd_usb_endpoint {
	struct snd_usb_audio *chip;

	int use_count;
	int ep_num;		/* the referenced endpoint number */
	int type;		/* SND_USB_ENDPOINT_TYPE_* */
	unsigned long flags;

	void (*prepare_data_urb) (struct snd_usb_substream *subs,
				  struct urb *urb);
	void (*retire_data_urb) (struct snd_usb_substream *subs,
				 struct urb *urb);

	struct snd_usb_substream *data_subs;
	struct snd_usb_endpoint *sync_master;
	struct snd_usb_endpoint *sync_slave;

	struct snd_urb_ctx urb[MAX_URBS];

	struct snd_usb_packet_info {
		uint32_t packet_size[MAX_PACKS_HS];
		int packets;
	} next_packet[MAX_URBS];
	int next_packet_read_pos, next_packet_write_pos;
	struct list_head ready_playback_urbs;

	unsigned int nurbs;		/* # urbs */
	unsigned long active_mask;	/* bitmask of active urbs */
	unsigned long unlink_mask;	/* bitmask of unlinked urbs */
	char *syncbuf;			/* sync buffer for all sync URBs */
	dma_addr_t sync_dma;		/* DMA address of syncbuf */

	unsigned int pipe;		/* the data i/o pipe */
	unsigned int freqn;		/* nominal sampling rate in fs/fps in Q16.16 format */
	unsigned int freqm;		/* momentary sampling rate in fs/fps in Q16.16 format */
	int	   freqshift;		/* how much to shift the feedback value to get Q16.16 */
	unsigned int freqmax;		/* maximum sampling rate, used for buffer management */
	unsigned int phase;		/* phase accumulator */
	unsigned int maxpacksize;	/* max packet size in bytes */
	unsigned int maxframesize;      /* max packet size in frames */
	unsigned int curpacksize;	/* current packet size in bytes (for capture) */
	unsigned int curframesize;      /* current packet size in frames (for capture) */
	unsigned int syncmaxsize;	/* sync endpoint packet size */
	unsigned int fill_max:1;	/* fill max packet size always */
	unsigned int datainterval;      /* log_2 of data packet interval */
	unsigned int syncinterval;	/* P for adaptive mode, 0 otherwise */
	unsigned char silence_value;
	unsigned int stride;
	int iface, alt_idx;

	spinlock_t lock;
	struct list_head list;
};

struct snd_usb_substream {
	struct snd_usb_stream *stream;
	struct usb_device *dev;
	struct snd_pcm_substream *pcm_substream;
	int direction;	/* playback or capture */
	int interface;	/* current interface */
	int endpoint;	/* assigned endpoint */
	struct audioformat *cur_audiofmt;	/* current audioformat pointer (for hw_params callback) */
	unsigned int cur_rate;		/* current rate (for hw_params callback) */
	unsigned int period_bytes;	/* current period bytes (for hw_params callback) */
	unsigned int altset_idx;     /* USB data format: index of alternate setting */
	unsigned int datapipe;   /* the data i/o pipe */
	unsigned int syncpipe;   /* 1 - async out or adaptive in */
	unsigned int datainterval;	/* log_2 of data packet interval */
	unsigned int syncinterval;  /* P for adaptive mode, 0 otherwise */
	unsigned int freqn;      /* nominal sampling rate in fs/fps in Q16.16 format */
	unsigned int freqm;      /* momentary sampling rate in fs/fps in Q16.16 format */
	int          freqshift;  /* how much to shift the feedback value to get Q16.16 */
	unsigned int freqmax;    /* maximum sampling rate, used for buffer management */
	unsigned int phase;      /* phase accumulator */
	unsigned int maxpacksize;	/* max packet size in bytes */
	unsigned int maxframesize;	/* max packet size in frames */
	unsigned int curpacksize;	/* current packet size in bytes (for capture) */
	unsigned int curframesize;	/* current packet size in frames (for capture) */
	unsigned int syncmaxsize;	/* sync endpoint packet size */
	unsigned int fill_max: 1;	/* fill max packet size always */
	unsigned int txfr_quirk:1;	/* allow sub-frame alignment */
	unsigned int fmt_type;		/* USB audio format type (1-3) */

	unsigned int running: 1;	/* running status */

	unsigned int hwptr_done;	/* processed byte position in the buffer */
	unsigned int transfer_done;		/* processed frames since last period update */
	unsigned long active_mask;	/* bitmask of active urbs */
	unsigned long unlink_mask;	/* bitmask of unlinked urbs */

	unsigned int nurbs;			/* # urbs */
	struct snd_urb_ctx dataurb[MAX_URBS];	/* data urb table */
	struct snd_urb_ctx syncurb[SYNC_URBS];	/* sync urb table */
	char *syncbuf;				/* sync buffer for all sync URBs */
	dma_addr_t sync_dma;			/* DMA address of syncbuf */

	u64 formats;			/* format bitmasks (all or'ed) */
	unsigned int num_formats;		/* number of supported audio formats (list) */
	struct list_head fmt_list;	/* format list */
	struct snd_pcm_hw_constraint_list rate_list;	/* limited rates */
	spinlock_t lock;

	struct snd_urb_ops ops;		/* callbacks (must be filled at init) */
	int last_frame_number;          /* stored frame number */
	int last_delay;                 /* stored delay */
};

struct snd_usb_stream {
	struct snd_usb_audio *chip;
	struct snd_pcm *pcm;
	int pcm_index;
	unsigned int fmt_type;		/* USB audio format type (1-3) */
	struct snd_usb_substream substream[2];
	struct list_head list;
};

#endif /* __USBAUDIO_CARD_H */
Commit	Line	Data
e5779998 DM	1	#ifndef __USBAUDIO_CARD_H
	2	#define __USBAUDIO_CARD_H
	3
8866f405	4	#define MAX_NR_RATES 1024
e5779998 DM	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;
015eb0b0	13	u64 formats; /* ALSA format bits */
e5779998 DM	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 */
79f920fb	29	unsigned char clock; /* associated clock */
e5779998 DM	30	};
	31
	32	struct snd_usb_substream;
8fdff6a3	33	struct snd_usb_endpoint;
e5779998 DM	34
	35	struct snd_urb_ctx {
	36	struct urb *urb;
	37	unsigned int buffer_size; /* size of data buffer, if data URB */
	38	struct snd_usb_substream *subs;
8fdff6a3	39	struct snd_usb_endpoint *ep;
e5779998 DM	40	int index; /* index for urb array */
e5779998 DM	41	int packets; /* number of packets per urb */
8fdff6a3 DM	42	int packet_size[MAX_PACKS_HS]; /* size of packets for next submission */
8fdff6a3 DM	43	struct list_head ready_list;
e5779998 DM	44	};
	45
	46	struct snd_urb_ops {
	47	int (prepare)(struct snd_usb_substream subs, struct snd_pcm_runtime runtime, struct urb u);
	48	int (retire)(struct snd_usb_substream subs, struct snd_pcm_runtime runtime, struct urb u);
	49	int (prepare_sync)(struct snd_usb_substream subs, struct snd_pcm_runtime runtime, struct urb u);
	50	int (retire_sync)(struct snd_usb_substream subs, struct snd_pcm_runtime runtime, struct urb u);
	51	};
	52
8fdff6a3 DM	53	struct snd_usb_endpoint {
	54	struct snd_usb_audio *chip;
	55
	56	int use_count;
	57	int ep_num; /* the referenced endpoint number */
	58	int type; /* SND_USB_ENDPOINT_TYPE_* */
	59	unsigned long flags;
	60
	61	void (prepare_data_urb) (struct snd_usb_substream subs,
	62	struct urb *urb);
	63	void (retire_data_urb) (struct snd_usb_substream subs,
	64	struct urb *urb);
	65
	66	struct snd_usb_substream *data_subs;
	67	struct snd_usb_endpoint *sync_master;
	68	struct snd_usb_endpoint *sync_slave;
	69
	70	struct snd_urb_ctx urb[MAX_URBS];
	71
	72	struct snd_usb_packet_info {
	73	uint32_t packet_size[MAX_PACKS_HS];
	74	int packets;
	75	} next_packet[MAX_URBS];
	76	int next_packet_read_pos, next_packet_write_pos;
	77	struct list_head ready_playback_urbs;
	78
	79	unsigned int nurbs; /* # urbs */
	80	unsigned long active_mask; /* bitmask of active urbs */
	81	unsigned long unlink_mask; /* bitmask of unlinked urbs */
	82	char syncbuf; / sync buffer for all sync URBs */
	83	dma_addr_t sync_dma; /* DMA address of syncbuf */
	84
	85	unsigned int pipe; /* the data i/o pipe */
	86	unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
	87	unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
	88	int freqshift; /* how much to shift the feedback value to get Q16.16 */
	89	unsigned int freqmax; /* maximum sampling rate, used for buffer management */
	90	unsigned int phase; /* phase accumulator */
	91	unsigned int maxpacksize; /* max packet size in bytes */
	92	unsigned int maxframesize; /* max packet 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 datainterval; /* log_2 of data packet interval */
	98	unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
	99	unsigned char silence_value;
	100	unsigned int stride;
	101	int iface, alt_idx;
	102
	103	spinlock_t lock;
	104	struct list_head list;
	105	};
	106
e5779998 DM	107	struct snd_usb_substream {
	108	struct snd_usb_stream *stream;
	109	struct usb_device *dev;
	110	struct snd_pcm_substream *pcm_substream;
	111	int direction; /* playback or capture */
	112	int interface; /* current interface */
	113	int endpoint; /* assigned endpoint */
	114	struct audioformat cur_audiofmt; / current audioformat pointer (for hw_params callback) */
	115	unsigned int cur_rate; /* current rate (for hw_params callback) */
	116	unsigned int period_bytes; /* current period bytes (for hw_params callback) */
e11b4e0e	117	unsigned int altset_idx; /* USB data format: index of alternate setting */
e5779998 DM	118	unsigned int datapipe; /* the data i/o pipe */
	119	unsigned int syncpipe; /* 1 - async out or adaptive in */
	120	unsigned int datainterval; /* log_2 of data packet interval */
	121	unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
	122	unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
	123	unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
89e1e66d	124	int freqshift; /* how much to shift the feedback value to get Q16.16 */
e5779998 DM	125	unsigned int freqmax; /* maximum sampling rate, used for buffer management */
	126	unsigned int phase; /* phase accumulator */
	127	unsigned int maxpacksize; /* max packet size in bytes */
	128	unsigned int maxframesize; /* max packet size in frames */
	129	unsigned int curpacksize; /* current packet size in bytes (for capture) */
	130	unsigned int curframesize; /* current packet size in frames (for capture) */
89e1e66d	131	unsigned int syncmaxsize; /* sync endpoint packet size */
e5779998 DM	132	unsigned int fill_max: 1; /* fill max packet size always */
	133	unsigned int txfr_quirk:1; /* allow sub-frame alignment */
	134	unsigned int fmt_type; /* USB audio format type (1-3) */
	135
	136	unsigned int running: 1; /* running status */
	137
	138	unsigned int hwptr_done; /* processed byte position in the buffer */
	139	unsigned int transfer_done; /* processed frames since last period update */
	140	unsigned long active_mask; /* bitmask of active urbs */
	141	unsigned long unlink_mask; /* bitmask of unlinked urbs */
	142
	143	unsigned int nurbs; /* # urbs */
	144	struct snd_urb_ctx dataurb[MAX_URBS]; /* data urb table */
	145	struct snd_urb_ctx syncurb[SYNC_URBS]; /* sync urb table */
	146	char syncbuf; / sync buffer for all sync URBs */
	147	dma_addr_t sync_dma; /* DMA address of syncbuf */
	148
	149	u64 formats; /* format bitmasks (all or'ed) */
	150	unsigned int num_formats; /* number of supported audio formats (list) */
	151	struct list_head fmt_list; /* format list */
	152	struct snd_pcm_hw_constraint_list rate_list; /* limited rates */
	153	spinlock_t lock;
	154
	155	struct snd_urb_ops ops; /* callbacks (must be filled at init) */
294c4fb8 PLB	156	int last_frame_number; /* stored frame number */
294c4fb8 PLB	157	int last_delay; /* stored delay */
e5779998 DM	158	};
	159
	160	struct 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 */