Linux Audio

Check our new training course

Loading...
v3.1
 
  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
 10struct 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
 31struct snd_usb_substream;
 
 32
 33struct 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
 41struct 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
 48struct 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
 99struct 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 */
v4.17
  1/* SPDX-License-Identifier: GPL-2.0 */
  2#ifndef __USBAUDIO_CARD_H
  3#define __USBAUDIO_CARD_H
  4
  5#define MAX_NR_RATES	1024
  6#define MAX_PACKS	6		/* per URB */
  7#define MAX_PACKS_HS	(MAX_PACKS * 8)	/* in high speed mode */
  8#define MAX_URBS	12
  9#define SYNC_URBS	4	/* always four urbs for sync */
 10#define MAX_QUEUE	18	/* try not to exceed this queue length, in ms */
 11
 12struct audioformat {
 13	struct list_head list;
 14	u64 formats;			/* ALSA format bits */
 15	unsigned int channels;		/* # channels */
 16	unsigned int fmt_type;		/* USB audio format type (1-3) */
 17	unsigned int frame_size;	/* samples per frame for non-audio */
 18	int iface;			/* interface number */
 19	unsigned char altsetting;	/* corresponding alternate setting */
 20	unsigned char altset_idx;	/* array index of altenate setting */
 21	unsigned char attributes;	/* corresponding attributes of cs endpoint */
 22	unsigned char endpoint;		/* endpoint */
 23	unsigned char ep_attr;		/* endpoint attributes */
 24	unsigned char datainterval;	/* log_2 of data packet interval */
 25	unsigned char protocol;		/* UAC_VERSION_1/2/3 */
 26	unsigned int maxpacksize;	/* max. packet size */
 27	unsigned int rates;		/* rate bitmasks */
 28	unsigned int rate_min, rate_max;	/* min/max rates */
 29	unsigned int nr_rates;		/* number of rate table entries */
 30	unsigned int *rate_table;	/* rate table */
 31	unsigned char clock;		/* associated clock */
 32	struct snd_pcm_chmap_elem *chmap; /* (optional) channel map */
 33	bool dsd_dop;			/* add DOP headers in case of DSD samples */
 34	bool dsd_bitrev;		/* reverse the bits of each DSD sample */
 35};
 36
 37struct snd_usb_substream;
 38struct snd_usb_endpoint;
 39
 40struct snd_urb_ctx {
 41	struct urb *urb;
 42	unsigned int buffer_size;	/* size of data buffer, if data URB */
 43	struct snd_usb_substream *subs;
 44	struct snd_usb_endpoint *ep;
 45	int index;	/* index for urb array */
 46	int packets;	/* number of packets per urb */
 47	int packet_size[MAX_PACKS_HS]; /* size of packets for next submission */
 48	struct list_head ready_list;
 49};
 50
 51struct snd_usb_endpoint {
 52	struct snd_usb_audio *chip;
 53
 54	int use_count;
 55	int ep_num;		/* the referenced endpoint number */
 56	int type;		/* SND_USB_ENDPOINT_TYPE_* */
 57	unsigned long flags;
 58
 59	void (*prepare_data_urb) (struct snd_usb_substream *subs,
 60				  struct urb *urb);
 61	void (*retire_data_urb) (struct snd_usb_substream *subs,
 62				 struct urb *urb);
 63
 64	struct snd_usb_substream *data_subs;
 65	struct snd_usb_endpoint *sync_master;
 66	struct snd_usb_endpoint *sync_slave;
 67
 68	struct snd_urb_ctx urb[MAX_URBS];
 69
 70	struct snd_usb_packet_info {
 71		uint32_t packet_size[MAX_PACKS_HS];
 72		int packets;
 73	} next_packet[MAX_URBS];
 74	int next_packet_read_pos, next_packet_write_pos;
 75	struct list_head ready_playback_urbs;
 76
 77	unsigned int nurbs;		/* # urbs */
 78	unsigned long active_mask;	/* bitmask of active urbs */
 79	unsigned long unlink_mask;	/* bitmask of unlinked urbs */
 80	char *syncbuf;			/* sync buffer for all sync URBs */
 81	dma_addr_t sync_dma;		/* DMA address of syncbuf */
 82
 83	unsigned int pipe;		/* the data i/o pipe */
 84	unsigned int freqn;		/* nominal sampling rate in fs/fps in Q16.16 format */
 85	unsigned int freqm;		/* momentary sampling rate in fs/fps in Q16.16 format */
 86	int	   freqshift;		/* how much to shift the feedback value to get Q16.16 */
 87	unsigned int freqmax;		/* maximum sampling rate, used for buffer management */
 88	unsigned int phase;		/* phase accumulator */
 89	unsigned int maxpacksize;	/* max packet size in bytes */
 90	unsigned int maxframesize;      /* max packet size in frames */
 91	unsigned int max_urb_frames;	/* max URB size in frames */
 92	unsigned int curpacksize;	/* current packet size in bytes (for capture) */
 93	unsigned int curframesize;      /* current packet size in frames (for capture) */
 94	unsigned int syncmaxsize;	/* sync endpoint packet size */
 95	unsigned int fill_max:1;	/* fill max packet size always */
 96	unsigned int tenor_fb_quirk:1;	/* corrupted feedback data */
 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, altsetting;
102	int skip_packets;		/* quirks for devices to ignore the first n packets
103					   in a stream */
104
105	spinlock_t lock;
106	struct list_head list;
107};
108
109struct snd_usb_substream {
110	struct snd_usb_stream *stream;
111	struct usb_device *dev;
112	struct snd_pcm_substream *pcm_substream;
113	int direction;	/* playback or capture */
114	int interface;	/* current interface */
115	int endpoint;	/* assigned endpoint */
116	struct audioformat *cur_audiofmt;	/* current audioformat pointer (for hw_params callback) */
117	snd_pcm_format_t pcm_format;	/* current audio format (for hw_params callback) */
118	unsigned int channels;		/* current number of channels (for hw_params callback) */
119	unsigned int channels_max;	/* max channels in the all audiofmts */
120	unsigned int cur_rate;		/* current rate (for hw_params callback) */
121	unsigned int period_bytes;	/* current period bytes (for hw_params callback) */
122	unsigned int period_frames;	/* current frames per period */
123	unsigned int buffer_periods;	/* current periods per buffer */
124	unsigned int altset_idx;     /* USB data format: index of alternate setting */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
125	unsigned int txfr_quirk:1;	/* allow sub-frame alignment */
126	unsigned int tx_length_quirk:1;	/* add length specifier to transfers */
127	unsigned int fmt_type;		/* USB audio format type (1-3) */
128	unsigned int pkt_offset_adj;	/* Bytes to drop from beginning of packets (for non-compliant devices) */
129
130	unsigned int running: 1;	/* running status */
131
132	unsigned int hwptr_done;	/* processed byte position in the buffer */
133	unsigned int transfer_done;		/* processed frames since last period update */
134	unsigned int frame_limit;	/* limits number of packets in URB */
 
135
136	/* data and sync endpoints for this stream */
137	unsigned int ep_num;		/* the endpoint number */
138	struct snd_usb_endpoint *data_endpoint;
139	struct snd_usb_endpoint *sync_endpoint;
140	unsigned long flags;
141	bool need_setup_ep;		/* (re)configure EP at prepare? */
142	unsigned int speed;		/* USB_SPEED_XXX */
143
144	u64 formats;			/* format bitmasks (all or'ed) */
145	unsigned int num_formats;		/* number of supported audio formats (list) */
146	struct list_head fmt_list;	/* format list */
147	struct snd_pcm_hw_constraint_list rate_list;	/* limited rates */
148	spinlock_t lock;
149
150	int last_frame_number;          /* stored frame number */
151	int last_delay;                 /* stored delay */
152
153	struct {
154		int marker;
155		int channel;
156		int byte_idx;
157	} dsd_dop;
158
159	bool trigger_tstamp_pending_update; /* trigger timestamp being updated from initial estimate */
160};
161
162struct snd_usb_stream {
163	struct snd_usb_audio *chip;
164	struct snd_pcm *pcm;
165	int pcm_index;
166	unsigned int fmt_type;		/* USB audio format type (1-3) */
167	struct snd_usb_substream substream[2];
168	struct list_head list;
169};
170
171#endif /* __USBAUDIO_CARD_H */