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

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __USBAUDIO_CARD_H
#define __USBAUDIO_CARD_H

#define MAX_NR_RATES	1024
#define MAX_PACKS	6		/* per URB */
#define MAX_PACKS_HS	(MAX_PACKS * 8)	/* in high speed mode */
#define MAX_URBS	12
#define SYNC_URBS	4	/* always four urbs for sync */
#define MAX_QUEUE	18	/* 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 fmt_bits;		/* number of significant bits */
	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 char protocol;		/* UAC_VERSION_1/2/3 */
	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_pcm_chmap_elem *chmap; /* (optional) channel map */
	bool dsd_dop;			/* add DOP headers in case of DSD samples */
	bool dsd_bitrev;		/* reverse the bits of each DSD sample */
	bool dsd_raw;			/* altsetting is raw DSD */
};

struct snd_usb_substream;
struct snd_usb_endpoint;
struct snd_usb_power_domain;

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_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 framesize[2];	/* small/large frame sizes in samples */
	unsigned int sample_rem;	/* remainder from division fs/fps */
	unsigned int sample_accum;	/* sample accumulator */
	unsigned int fps;		/* frames per second */
	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 max_urb_frames;	/* max URB 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 tenor_fb_quirk:1;	/* corrupted feedback data */
	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, altsetting;
	int skip_packets;		/* quirks for devices to ignore the first n packets
					   in a stream */
	bool is_implicit_feedback;      /* This endpoint is used as implicit feedback */

	spinlock_t lock;
	struct list_head list;
};

struct media_ctl;

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) */
	struct snd_usb_power_domain *str_pd;	/* UAC3 Power Domain for streaming path */
	snd_pcm_format_t pcm_format;	/* current audio format (for hw_params callback) */
	unsigned int channels;		/* current number of channels (for hw_params callback) */
	unsigned int channels_max;	/* max channels in the all audiofmts */
	unsigned int cur_rate;		/* current rate (for hw_params callback) */
	unsigned int period_bytes;	/* current period bytes (for hw_params callback) */
	unsigned int period_frames;	/* current frames per period */
	unsigned int buffer_periods;	/* current periods per buffer */
	unsigned int altset_idx;     /* USB data format: index of alternate setting */
	unsigned int txfr_quirk:1;	/* allow sub-frame alignment */
	unsigned int tx_length_quirk:1;	/* add length specifier to transfers */
	unsigned int fmt_type;		/* USB audio format type (1-3) */
	unsigned int pkt_offset_adj;	/* Bytes to drop from beginning of packets (for non-compliant devices) */

	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 int frame_limit;	/* limits number of packets in URB */

	/* data and sync endpoints for this stream */
	unsigned int ep_num;		/* the endpoint number */
	struct snd_usb_endpoint *data_endpoint;
	struct snd_usb_endpoint *sync_endpoint;
	unsigned long flags;
	bool need_setup_ep;		/* (re)configure EP at prepare? */
	bool need_setup_fmt;		/* (re)configure fmt after resume? */
	unsigned int speed;		/* USB_SPEED_XXX */

	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;

	int last_frame_number;          /* stored frame number */
	int last_delay;                 /* stored delay */

	struct {
		int marker;
		int channel;
		int byte_idx;
	} dsd_dop;

	bool trigger_tstamp_pending_update; /* trigger timestamp being updated from initial estimate */
	struct media_ctl *media_ctl;
};

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