[linux-block.git] / sound / firewire / amdtp-stream.h

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

#include <linux/err.h>
#include <linux/interrupt.h>
#include <linux/mutex.h>
#include <linux/sched.h>
#include <sound/asound.h>
#include "packets-buffer.h"

/**
 * enum cip_flags - describes details of the streaming protocol
 * @CIP_NONBLOCKING: In non-blocking mode, each packet contains
 *	sample_rate/8000 samples, with rounding up or down to adjust
 *	for clock skew and left-over fractional samples.  This should
 *	be used if supported by the device.
 * @CIP_BLOCKING: In blocking mode, each packet contains either zero or
 *	SYT_INTERVAL samples, with these two types alternating so that
 *	the overall sample rate comes out right.
 * @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0.
 * @CIP_DBC_IS_END_EVENT: The value of dbc in an packet corresponds to the end
 * of event in the packet. Out of IEC 61883.
 * @CIP_WRONG_DBS: Only for in-stream. The value of dbs is wrong in in-packets.
 *	The value of data_block_quadlets is used instead of reported value.
 * @CIP_SKIP_DBC_ZERO_CHECK: Only for in-stream.  Packets with zero in dbc is
 *	skipped for detecting discontinuity.
 * @CIP_EMPTY_HAS_WRONG_DBC: Only for in-stream. The value of dbc in empty
 *	packet is wrong but the others are correct.
 * @CIP_JUMBO_PAYLOAD: Only for in-stream. The number of data blocks in an
 *	packet is larger than IEC 61883-6 defines. Current implementation
 *	allows 5 times as large as IEC 61883-6 defines.
 * @CIP_HEADER_WITHOUT_EOH: Only for in-stream. CIP Header doesn't include
 *	valid EOH.
 * @CIP_NO_HEADERS: a lack of headers in packets
 * @CIP_UNALIGHED_DBC: Only for in-stream. The value of dbc is not alighed to
 *	the value of current SYT_INTERVAL; e.g. initial value is not zero.
 * @CIP_UNAWARE_SYT: For outgoing packet, the value in SYT field of CIP is 0xffff.
 *	For incoming packet, the value in SYT field of CIP is not handled.
 */
enum cip_flags {
	CIP_NONBLOCKING		= 0x00,
	CIP_BLOCKING		= 0x01,
	CIP_EMPTY_WITH_TAG0	= 0x02,
	CIP_DBC_IS_END_EVENT	= 0x04,
	CIP_WRONG_DBS		= 0x08,
	CIP_SKIP_DBC_ZERO_CHECK	= 0x10,
	CIP_EMPTY_HAS_WRONG_DBC	= 0x20,
	CIP_JUMBO_PAYLOAD	= 0x40,
	CIP_HEADER_WITHOUT_EOH	= 0x80,
	CIP_NO_HEADER		= 0x100,
	CIP_UNALIGHED_DBC	= 0x200,
	CIP_UNAWARE_SYT		= 0x400,
};

/**
 * enum cip_sfc - supported Sampling Frequency Codes (SFCs)
 * @CIP_SFC_32000:   32,000 data blocks
 * @CIP_SFC_44100:   44,100 data blocks
 * @CIP_SFC_48000:   48,000 data blocks
 * @CIP_SFC_88200:   88,200 data blocks
 * @CIP_SFC_96000:   96,000 data blocks
 * @CIP_SFC_176400: 176,400 data blocks
 * @CIP_SFC_192000: 192,000 data blocks
 * @CIP_SFC_COUNT: the number of supported SFCs
 *
 * These values are used to show nominal Sampling Frequency Code in
 * Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002,
 * this code means the number of events per second. Actually the code
 * represents the number of data blocks transferred per second in an AMDTP
 * stream.
 *
 * In IEC 61883-6:2005, some extensions were added to support more types of
 * data such as 'One Bit LInear Audio', therefore the meaning of SFC became
 * different depending on the types.
 *
 * Currently our implementation is compatible with IEC 61883-6:2002.
 */
enum cip_sfc {
	CIP_SFC_32000  = 0,
	CIP_SFC_44100  = 1,
	CIP_SFC_48000  = 2,
	CIP_SFC_88200  = 3,
	CIP_SFC_96000  = 4,
	CIP_SFC_176400 = 5,
	CIP_SFC_192000 = 6,
	CIP_SFC_COUNT
};

struct fw_unit;
struct fw_iso_context;
struct snd_pcm_substream;
struct snd_pcm_runtime;

enum amdtp_stream_direction {
	AMDTP_OUT_STREAM = 0,
	AMDTP_IN_STREAM
};

struct pkt_desc {
	u32 cycle;
	u32 syt;
	unsigned int data_blocks;
	unsigned int data_block_counter;
	__be32 *ctx_payload;
	struct list_head link;
};

struct amdtp_stream;
typedef void (*amdtp_stream_process_ctx_payloads_t)(struct amdtp_stream *s,
						    const struct pkt_desc *desc,
						    unsigned int count,
						    struct snd_pcm_substream *pcm);

struct amdtp_domain;
struct amdtp_stream {
	struct fw_unit *unit;
	// The combination of cip_flags enumeration-constants.
	unsigned int flags;
	enum amdtp_stream_direction direction;
	struct mutex mutex;

	/* For packet processing. */
	struct fw_iso_context *context;
	struct iso_packets_buffer buffer;
	unsigned int queue_size;
	int packet_index;
	struct pkt_desc *packet_descs;
	struct list_head packet_descs_list;
	struct pkt_desc *packet_descs_cursor;
	int tag;
	union {
		struct {
			unsigned int ctx_header_size;

			// limit for payload of iso packet.
			unsigned int max_ctx_payload_length;

			// For quirks of CIP headers.
			// Fixed interval of dbc between previos/current
			// packets.
			unsigned int dbc_interval;

			// The device starts multiplexing events to the packet.
			bool event_starts;

			struct {
				struct seq_desc *descs;
				unsigned int size;
				unsigned int pos;
			} cache;
		} tx;
		struct {
			// To generate CIP header.
			unsigned int fdf;

			// To generate constant hardware IRQ.
			unsigned int event_count;

			// To calculate CIP data blocks and tstamp.
			struct {
				struct seq_desc *descs;
				unsigned int size;
				unsigned int pos;
			} seq;

			unsigned int data_block_state;
			unsigned int syt_offset_state;
			unsigned int last_syt_offset;

			struct amdtp_stream *replay_target;
			unsigned int cache_pos;
		} rx;
	} ctx_data;

	/* For CIP headers. */
	unsigned int source_node_id_field;
	unsigned int data_block_quadlets;
	unsigned int data_block_counter;
	unsigned int sph;
	unsigned int fmt;

	// Internal flags.
	unsigned int transfer_delay;
	enum cip_sfc sfc;
	unsigned int syt_interval;

	/* For a PCM substream processing. */
	struct snd_pcm_substream *pcm;
	snd_pcm_uframes_t pcm_buffer_pointer;
	unsigned int pcm_period_pointer;
	unsigned int pcm_frame_multiplier;

	// To start processing content of packets at the same cycle in several contexts for
	// each direction.
	bool ready_processing;
	wait_queue_head_t ready_wait;
	unsigned int next_cycle;

	/* For backends to process data blocks. */
	void *protocol;
	amdtp_stream_process_ctx_payloads_t process_ctx_payloads;

	// For domain.
	int channel;
	int speed;
	struct list_head list;
	struct amdtp_domain *domain;
};

int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit,
		      enum amdtp_stream_direction dir, unsigned int flags,
		      unsigned int fmt,
		      amdtp_stream_process_ctx_payloads_t process_ctx_payloads,
		      unsigned int protocol_size);
void amdtp_stream_destroy(struct amdtp_stream *s);

int amdtp_stream_set_parameters(struct amdtp_stream *s, unsigned int rate,
				unsigned int data_block_quadlets, unsigned int pcm_frame_multiplier);
unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);

void amdtp_stream_update(struct amdtp_stream *s);

int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s,
					struct snd_pcm_runtime *runtime);

void amdtp_stream_pcm_prepare(struct amdtp_stream *s);
void amdtp_stream_pcm_abort(struct amdtp_stream *s);

extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT];

/**
 * amdtp_stream_running - check stream is running or not
 * @s: the AMDTP stream
 *
 * If this function returns true, the stream is running.
 */
static inline bool amdtp_stream_running(struct amdtp_stream *s)
{
	return !IS_ERR(s->context);
}

/**
 * amdtp_streaming_error - check for streaming error
 * @s: the AMDTP stream
 *
 * If this function returns true, the stream's packet queue has stopped due to
 * an asynchronous error.
 */
static inline bool amdtp_streaming_error(struct amdtp_stream *s)
{
	return s->packet_index < 0;
}

/**
 * amdtp_stream_pcm_running - check PCM substream is running or not
 * @s: the AMDTP stream
 *
 * If this function returns true, PCM substream in the AMDTP stream is running.
 */
static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s)
{
	return !!s->pcm;
}

/**
 * amdtp_stream_pcm_trigger - start/stop playback from a PCM device
 * @s: the AMDTP stream
 * @pcm: the PCM device to be started, or %NULL to stop the current device
 *
 * Call this function on a running isochronous stream to enable the actual
 * transmission of PCM data.  This function should be called from the PCM
 * device's .trigger callback.
 */
static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
					    struct snd_pcm_substream *pcm)
{
	WRITE_ONCE(s->pcm, pcm);
}

/**
 * amdtp_stream_next_packet_desc - retrieve next descriptor for amdtp packet.
 * @s: the AMDTP stream
 * @desc: the descriptor of packet
 *
 * This macro computes next descriptor so that the list of descriptors behaves circular queue.
 */
#define amdtp_stream_next_packet_desc(s, desc) \
	list_next_entry_circular(desc, &s->packet_descs_list, link)

static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
{
	return sfc & 1;
}

struct seq_desc {
	unsigned int syt_offset;
	unsigned int data_blocks;
};

struct amdtp_domain {
	struct list_head streams;

	unsigned int events_per_period;
	unsigned int events_per_buffer;

	struct amdtp_stream *irq_target;

	struct {
		unsigned int tx_init_skip;
		unsigned int tx_start;
		unsigned int rx_start;
	} processing_cycle;

	struct {
		bool enable:1;
		bool on_the_fly:1;
	} replay;
};

int amdtp_domain_init(struct amdtp_domain *d);
void amdtp_domain_destroy(struct amdtp_domain *d);

int amdtp_domain_add_stream(struct amdtp_domain *d, struct amdtp_stream *s,
			    int channel, int speed);

int amdtp_domain_start(struct amdtp_domain *d, unsigned int tx_init_skip_cycles, bool replay_seq,
		       bool replay_on_the_fly);
void amdtp_domain_stop(struct amdtp_domain *d);

static inline int amdtp_domain_set_events_per_period(struct amdtp_domain *d,
						unsigned int events_per_period,
						unsigned int events_per_buffer)
{
	d->events_per_period = events_per_period;
	d->events_per_buffer = events_per_buffer;

	return 0;
}

unsigned long amdtp_domain_stream_pcm_pointer(struct amdtp_domain *d,
					      struct amdtp_stream *s);
int amdtp_domain_stream_pcm_ack(struct amdtp_domain *d, struct amdtp_stream *s);

/**
 * amdtp_domain_wait_ready - sleep till being ready to process packets or timeout
 * @d: the AMDTP domain
 * @timeout_ms: msec till timeout
 *
 * If this function return false, the AMDTP domain should be stopped.
 */
static inline bool amdtp_domain_wait_ready(struct amdtp_domain *d, unsigned int timeout_ms)
{
	struct amdtp_stream *s;

	list_for_each_entry(s, &d->streams, list) {
		unsigned int j = msecs_to_jiffies(timeout_ms);

		if (wait_event_interruptible_timeout(s->ready_wait, s->ready_processing, j) <= 0)
			return false;
	}

	return true;
}

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
31ef9134 CL	2	#ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED
	3	#define SOUND_FIREWIRE_AMDTP_H_INCLUDED
	4
20b65dd0	5	#include <linux/err.h>
76fb8789	6	#include <linux/interrupt.h>
31ef9134	7	#include <linux/mutex.h>
5955815e	8	#include <linux/sched.h>
777fb574	9	#include <sound/asound.h>
31ef9134 CL	10	#include "packets-buffer.h"
	11
	12	/**
be4a2894	13	* enum cip_flags - describes details of the streaming protocol
31ef9134 CL	14	* @CIP_NONBLOCKING: In non-blocking mode, each packet contains
	15	* sample_rate/8000 samples, with rounding up or down to adjust
	16	* for clock skew and left-over fractional samples. This should
	17	* be used if supported by the device.
e84d15f6 CL	18	* @CIP_BLOCKING: In blocking mode, each packet contains either zero or
	19	* SYT_INTERVAL samples, with these two types alternating so that
	20	* the overall sample rate comes out right.
7ab56645	21	* @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0.
9dae017b TS	22	* @CIP_DBC_IS_END_EVENT: The value of dbc in an packet corresponds to the end
9dae017b TS	23	* of event in the packet. Out of IEC 61883.
69702239 TS	24	* @CIP_WRONG_DBS: Only for in-stream. The value of dbs is wrong in in-packets.
69702239 TS	25	* The value of data_block_quadlets is used instead of reported value.
5f217f90	26	* @CIP_SKIP_DBC_ZERO_CHECK: Only for in-stream. Packets with zero in dbc is
b84b1a27	27	* skipped for detecting discontinuity.
9d59124c TS	28	* @CIP_EMPTY_HAS_WRONG_DBC: Only for in-stream. The value of dbc in empty
9d59124c TS	29	* packet is wrong but the others are correct.
a2064710 TS	30	* @CIP_JUMBO_PAYLOAD: Only for in-stream. The number of data blocks in an
	31	* packet is larger than IEC 61883-6 defines. Current implementation
	32	* allows 5 times as large as IEC 61883-6 defines.
2128f78f TS	33	* @CIP_HEADER_WITHOUT_EOH: Only for in-stream. CIP Header doesn't include
2128f78f TS	34	* valid EOH.
3b196c39	35	* @CIP_NO_HEADERS: a lack of headers in packets
588f2e2c TS	36	* @CIP_UNALIGHED_DBC: Only for in-stream. The value of dbc is not alighed to
588f2e2c TS	37	* the value of current SYT_INTERVAL; e.g. initial value is not zero.
8070d265 TS	38	* @CIP_UNAWARE_SYT: For outgoing packet, the value in SYT field of CIP is 0xffff.
8070d265 TS	39	* For incoming packet, the value in SYT field of CIP is not handled.
31ef9134	40	*/
be4a2894	41	enum cip_flags {
7b3b0d85 TS	42	CIP_NONBLOCKING = 0x00,
7b3b0d85 TS	43	CIP_BLOCKING = 0x01,
dec63cc8 TS	44	CIP_EMPTY_WITH_TAG0 = 0x02,
	45	CIP_DBC_IS_END_EVENT = 0x04,
	46	CIP_WRONG_DBS = 0x08,
	47	CIP_SKIP_DBC_ZERO_CHECK = 0x10,
62f00e40 TS	48	CIP_EMPTY_HAS_WRONG_DBC = 0x20,
62f00e40 TS	49	CIP_JUMBO_PAYLOAD = 0x40,
2128f78f	50	CIP_HEADER_WITHOUT_EOH = 0x80,
3b196c39	51	CIP_NO_HEADER = 0x100,
588f2e2c	52	CIP_UNALIGHED_DBC = 0x200,
8070d265	53	CIP_UNAWARE_SYT = 0x400,
31ef9134 CL	54	};
	55
	56	/**
5f217f90 TS	57	* enum cip_sfc - supported Sampling Frequency Codes (SFCs)
	58	* @CIP_SFC_32000: 32,000 data blocks
	59	* @CIP_SFC_44100: 44,100 data blocks
	60	* @CIP_SFC_48000: 48,000 data blocks
	61	* @CIP_SFC_88200: 88,200 data blocks
	62	* @CIP_SFC_96000: 96,000 data blocks
	63	* @CIP_SFC_176400: 176,400 data blocks
	64	* @CIP_SFC_192000: 192,000 data blocks
	65	* @CIP_SFC_COUNT: the number of supported SFCs
	66	*
	67	* These values are used to show nominal Sampling Frequency Code in
	68	* Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002,
	69	* this code means the number of events per second. Actually the code
	70	* represents the number of data blocks transferred per second in an AMDTP
	71	* stream.
	72	*
	73	* In IEC 61883-6:2005, some extensions were added to support more types of
	74	* data such as 'One Bit LInear Audio', therefore the meaning of SFC became
	75	* different depending on the types.
	76	*
	77	* Currently our implementation is compatible with IEC 61883-6:2002.
31ef9134 CL	78	*/
	79	enum cip_sfc {
	80	CIP_SFC_32000 = 0,
	81	CIP_SFC_44100 = 1,
	82	CIP_SFC_48000 = 2,
	83	CIP_SFC_88200 = 3,
	84	CIP_SFC_96000 = 4,
	85	CIP_SFC_176400 = 5,
	86	CIP_SFC_192000 = 6,
a7304e3b	87	CIP_SFC_COUNT
31ef9134 CL	88	};
31ef9134 CL	89
31ef9134 CL	90	struct fw_unit;
	91	struct fw_iso_context;
	92	struct snd_pcm_substream;
7b2d99fa	93	struct snd_pcm_runtime;
31ef9134	94
3ff7e8f0 TS	95	enum amdtp_stream_direction {
	96	AMDTP_OUT_STREAM = 0,
	97	AMDTP_IN_STREAM
	98	};
	99
04130cf8 TS	100	struct pkt_desc {
	101	u32 cycle;
	102	u32 syt;
	103	unsigned int data_blocks;
	104	unsigned int data_block_counter;
	105	__be32 *ctx_payload;
cec371ff	106	struct list_head link;
04130cf8 TS	107	};
04130cf8 TS	108
df075fee	109	struct amdtp_stream;
7fc693e4 TS	110	typedef void (amdtp_stream_process_ctx_payloads_t)(struct amdtp_stream s,
	111	const struct pkt_desc *desc,
	112	unsigned int count,
	113	struct snd_pcm_substream *pcm);
2472cfb3 TS	114
2472cfb3 TS	115	struct amdtp_domain;
be4a2894	116	struct amdtp_stream {
31ef9134	117	struct fw_unit *unit;
ffe66bbe TS	118	// The combination of cip_flags enumeration-constants.
ffe66bbe TS	119	unsigned int flags;
3ff7e8f0	120	enum amdtp_stream_direction direction;
31ef9134 CL	121	struct mutex mutex;
31ef9134 CL	122
10b2b6dc TS	123	/* For packet processing. */
10b2b6dc TS	124	struct fw_iso_context *context;
31ef9134	125	struct iso_packets_buffer buffer;
a0e02331	126	unsigned int queue_size;
ec00f5e4	127	int packet_index;
f0117128	128	struct pkt_desc *packet_descs;
cec371ff	129	struct list_head packet_descs_list;
f0117128	130	struct pkt_desc *packet_descs_cursor;
3b196c39	131	int tag;
d3d10a4a TS	132	union {
	133	struct {
	134	unsigned int ctx_header_size;
	135
	136	// limit for payload of iso packet.
f11453c7	137	unsigned int max_ctx_payload_length;
d3d10a4a TS	138
	139	// For quirks of CIP headers.
	140	// Fixed interval of dbc between previos/current
	141	// packets.
	142	unsigned int dbc_interval;
fb25dcc8 TS	143
	144	// The device starts multiplexing events to the packet.
	145	bool event_starts;
f9e5ecdf TS	146
	147	struct {
	148	struct seq_desc *descs;
	149	unsigned int size;
cccddec4	150	unsigned int pos;
f9e5ecdf	151	} cache;
d3d10a4a TS	152	} tx;
d3d10a4a TS	153	struct {
d3d10a4a TS	154	// To generate CIP header.
d3d10a4a TS	155	unsigned int fdf;
60dd4929 TS	156
	157	// To generate constant hardware IRQ.
	158	unsigned int event_count;
6f24bb8a	159
13d11f14	160	// To calculate CIP data blocks and tstamp.
6f24bb8a TS	161	struct {
	162	struct seq_desc *descs;
	163	unsigned int size;
119c446a	164	unsigned int pos;
6f24bb8a TS	165	} seq;
	166
	167	unsigned int data_block_state;
	168	unsigned int syt_offset_state;
	169	unsigned int last_syt_offset;
39c2649c TS	170
39c2649c TS	171	struct amdtp_stream *replay_target;
c38d8cff	172	unsigned int cache_pos;
d3d10a4a TS	173	} rx;
d3d10a4a TS	174	} ctx_data;
10b2b6dc TS	175
	176	/* For CIP headers. */
	177	unsigned int source_node_id_field;
	178	unsigned int data_block_quadlets;
31ef9134	179	unsigned int data_block_counter;
9863874f	180	unsigned int sph;
414ba022	181	unsigned int fmt;
31ef9134	182
13d11f14 TS	183	// Internal flags.
13d11f14 TS	184	unsigned int transfer_delay;
10b2b6dc TS	185	enum cip_sfc sfc;
10b2b6dc TS	186	unsigned int syt_interval;
31ef9134	187
10b2b6dc TS	188	/* For a PCM substream processing. */
10b2b6dc TS	189	struct snd_pcm_substream *pcm;
4a9bfafc	190	snd_pcm_uframes_t pcm_buffer_pointer;
31ef9134	191	unsigned int pcm_period_pointer;
a36183f6	192	unsigned int pcm_frame_multiplier;
83d8d72d	193
bdaedca7 TS	194	// To start processing content of packets at the same cycle in several contexts for
bdaedca7 TS	195	// each direction.
b7c7699b	196	bool ready_processing;
bdaedca7	197	wait_queue_head_t ready_wait;
705794c5	198	unsigned int next_cycle;
10b2b6dc	199
df075fee TS	200	/* For backends to process data blocks. */
df075fee TS	201	void *protocol;
9a738ad1	202	amdtp_stream_process_ctx_payloads_t process_ctx_payloads;
6261f90b TS	203
6261f90b TS	204	// For domain.
157a53ee TS	205	int channel;
157a53ee TS	206	int speed;
6261f90b	207	struct list_head list;
2472cfb3	208	struct amdtp_domain *domain;
31ef9134 CL	209	};
31ef9134 CL	210
be4a2894	211	int amdtp_stream_init(struct amdtp_stream s, struct fw_unit unit,
ffe66bbe	212	enum amdtp_stream_direction dir, unsigned int flags,
df075fee	213	unsigned int fmt,
9a738ad1	214	amdtp_stream_process_ctx_payloads_t process_ctx_payloads,
df075fee	215	unsigned int protocol_size);
be4a2894	216	void amdtp_stream_destroy(struct amdtp_stream *s);
31ef9134	217
df075fee	218	int amdtp_stream_set_parameters(struct amdtp_stream *s, unsigned int rate,
a36183f6	219	unsigned int data_block_quadlets, unsigned int pcm_frame_multiplier);
be4a2894	220	unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);
31ef9134	221
be4a2894	222	void amdtp_stream_update(struct amdtp_stream *s);
31ef9134	223
7b2d99fa TS	224	int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s,
7b2d99fa TS	225	struct snd_pcm_runtime *runtime);
df075fee	226
be4a2894	227	void amdtp_stream_pcm_prepare(struct amdtp_stream *s);
be4a2894	228	void amdtp_stream_pcm_abort(struct amdtp_stream *s);
31ef9134	229
c5280e99	230	extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
1017abed	231	extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT];
a7304e3b	232
be4a2894 TS	233	/**
	234	* amdtp_stream_running - check stream is running or not
	235	* @s: the AMDTP stream
	236	*
	237	* If this function returns true, the stream is running.
	238	*/
	239	static inline bool amdtp_stream_running(struct amdtp_stream *s)
20b65dd0 CL	240	{
	241	return !IS_ERR(s->context);
	242	}
	243
ec00f5e4	244	/**
be4a2894 TS	245	* amdtp_streaming_error - check for streaming error
be4a2894 TS	246	* @s: the AMDTP stream
ec00f5e4 CL	247	*
	248	* If this function returns true, the stream's packet queue has stopped due to
	249	* an asynchronous error.
	250	*/
be4a2894	251	static inline bool amdtp_streaming_error(struct amdtp_stream *s)
ec00f5e4 CL	252	{
	253	return s->packet_index < 0;
	254	}
	255
83d8d72d TS	256	/**
	257	* amdtp_stream_pcm_running - check PCM substream is running or not
	258	* @s: the AMDTP stream
	259	*
	260	* If this function returns true, PCM substream in the AMDTP stream is running.
	261	*/
	262	static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s)
	263	{
	264	return !!s->pcm;
	265	}
	266
31ef9134	267	/**
be4a2894 TS	268	* amdtp_stream_pcm_trigger - start/stop playback from a PCM device
be4a2894 TS	269	* @s: the AMDTP stream
31ef9134 CL	270	* @pcm: the PCM device to be started, or %NULL to stop the current device
	271	*
	272	* Call this function on a running isochronous stream to enable the actual
	273	* transmission of PCM data. This function should be called from the PCM
	274	* device's .trigger callback.
	275	*/
be4a2894 TS	276	static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
be4a2894 TS	277	struct snd_pcm_substream *pcm)
31ef9134	278	{
6aa7de05	279	WRITE_ONCE(s->pcm, pcm);
31ef9134 CL	280	}
31ef9134 CL	281
cec371ff TS	282	/**
	283	* amdtp_stream_next_packet_desc - retrieve next descriptor for amdtp packet.
	284	* @s: the AMDTP stream
	285	* @desc: the descriptor of packet
	286	*
	287	* This macro computes next descriptor so that the list of descriptors behaves circular queue.
	288	*/
	289	#define amdtp_stream_next_packet_desc(s, desc) \
	290	list_next_entry_circular(desc, &s->packet_descs_list, link)
	291
31ef9134 CL	292	static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
	293	{
	294	return sfc & 1;
	295	}
	296
25babf29 TS	297	struct seq_desc {
	298	unsigned int syt_offset;
	299	unsigned int data_blocks;
	300	};
	301
3ec3d7a3 TS	302	struct amdtp_domain {
3ec3d7a3 TS	303	struct list_head streams;
d68c3123 TS	304
d68c3123 TS	305	unsigned int events_per_period;
a0e02331	306	unsigned int events_per_buffer;
03b4816d TS	307
03b4816d TS	308	struct amdtp_stream *irq_target;
25babf29	309
da3623ab	310	struct {
26541cb1	311	unsigned int tx_init_skip;
da3623ab	312	unsigned int tx_start;
9b1fcd9b	313	unsigned int rx_start;
da3623ab	314	} processing_cycle;
f9e5ecdf TS	315
f9e5ecdf TS	316	struct {
2f21a177 TS	317	bool enable:1;
2f21a177 TS	318	bool on_the_fly:1;
f9e5ecdf	319	} replay;
3ec3d7a3 TS	320	};
	321
	322	int amdtp_domain_init(struct amdtp_domain *d);
	323	void amdtp_domain_destroy(struct amdtp_domain *d);
	324
157a53ee TS	325	int amdtp_domain_add_stream(struct amdtp_domain d, struct amdtp_stream s,
	326	int channel, int speed);
	327
2f21a177 TS	328	int amdtp_domain_start(struct amdtp_domain *d, unsigned int tx_init_skip_cycles, bool replay_seq,
2f21a177 TS	329	bool replay_on_the_fly);
6261f90b TS	330	void amdtp_domain_stop(struct amdtp_domain *d);
6261f90b TS	331
d68c3123	332	static inline int amdtp_domain_set_events_per_period(struct amdtp_domain *d,
a0e02331 TS	333	unsigned int events_per_period,
a0e02331 TS	334	unsigned int events_per_buffer)
d68c3123 TS	335	{
d68c3123 TS	336	d->events_per_period = events_per_period;
a0e02331	337	d->events_per_buffer = events_per_buffer;
d68c3123 TS	338
	339	return 0;
	340	}
	341
f890f9a0 TS	342	unsigned long amdtp_domain_stream_pcm_pointer(struct amdtp_domain *d,
f890f9a0 TS	343	struct amdtp_stream *s);
e6dcc92f TS	344	int amdtp_domain_stream_pcm_ack(struct amdtp_domain d, struct amdtp_stream s);
e6dcc92f TS	345
bdaedca7 TS	346	/**
	347	* amdtp_domain_wait_ready - sleep till being ready to process packets or timeout
	348	* @d: the AMDTP domain
	349	* @timeout_ms: msec till timeout
	350	*
	351	* If this function return false, the AMDTP domain should be stopped.
	352	*/
	353	static inline bool amdtp_domain_wait_ready(struct amdtp_domain *d, unsigned int timeout_ms)
	354	{
	355	struct amdtp_stream *s;
	356
	357	list_for_each_entry(s, &d->streams, list) {
	358	unsigned int j = msecs_to_jiffies(timeout_ms);
	359
	360	if (wait_event_interruptible_timeout(s->ready_wait, s->ready_processing, j) <= 0)
	361	return false;
	362	}
	363
	364	return true;
	365	}
	366
31ef9134	367	#endif