[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_urb_ctx {
	struct urb *urb;
	unsigned int buffer_size;	/* size of data buffer, if data URB */
	struct snd_usb_substream *subs;
	int index;	/* index for urb array */
	int packets;	/* number of packets per urb */
};

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_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;
	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) */
e11b4e0e	59	unsigned int altset_idx; /* USB data format: index of alternate setting */
e5779998 DM	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 */
89e1e66d	66	int freqshift; /* how much to shift the feedback value to get Q16.16 */
e5779998 DM	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) */
89e1e66d	73	unsigned int syncmaxsize; /* sync endpoint packet size */
e5779998 DM	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) */
294c4fb8 PLB	98	int last_frame_number; /* stored frame number */
294c4fb8 PLB	99	int last_delay; /* stored delay */
e5779998 DM	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 */