[linux-2.6-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.
 */
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,
};

/**
 * 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 amdtp_stream;
typedef unsigned int (*amdtp_stream_process_ctx_payloads_t)(
						struct amdtp_stream *s,
						const struct pkt_desc *desc,
						unsigned int packets,
						struct snd_pcm_substream *pcm);
struct amdtp_stream {
	struct fw_unit *unit;
	enum cip_flags flags;
	enum amdtp_stream_direction direction;
	struct mutex mutex;

	/* For packet processing. */
	struct fw_iso_context *context;
	struct iso_packets_buffer buffer;
	int packet_index;
	struct pkt_desc *pkt_descs;
	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;
		} tx;
		struct {
			// To calculate CIP data blocks and tstamp.
			unsigned int transfer_delay;
			unsigned int data_block_state;
			unsigned int last_syt_offset;
			unsigned int syt_offset_state;

			// To generate CIP header.
			unsigned int fdf;
			int syt_override;
		} 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. */
	enum cip_sfc sfc;
	unsigned int syt_interval;

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

	/* To wait for first packet. */
	bool callbacked;
	wait_queue_head_t callback_wait;
	u32 start_cycle;

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

int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit,
		      enum amdtp_stream_direction dir, enum cip_flags 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 amdtp_stream_get_max_payload(struct amdtp_stream *s);

int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed);
void amdtp_stream_update(struct amdtp_stream *s);
void amdtp_stream_stop(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);
unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s);
int amdtp_stream_pcm_ack(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);
}

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

/**
 * amdtp_stream_wait_callback - sleep till callbacked or timeout
 * @s: the AMDTP stream
 * @timeout: msec till timeout
 *
 * If this function return false, the AMDTP stream should be stopped.
 */
static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s,
					      unsigned int timeout)
{
	return wait_event_timeout(s->callback_wait,
				  s->callbacked == true,
				  msecs_to_jiffies(timeout)) > 0;
}

#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.
31ef9134	38	*/
be4a2894	39	enum cip_flags {
7b3b0d85 TS	40	CIP_NONBLOCKING = 0x00,
7b3b0d85 TS	41	CIP_BLOCKING = 0x01,
dec63cc8 TS	42	CIP_EMPTY_WITH_TAG0 = 0x02,
	43	CIP_DBC_IS_END_EVENT = 0x04,
	44	CIP_WRONG_DBS = 0x08,
	45	CIP_SKIP_DBC_ZERO_CHECK = 0x10,
62f00e40 TS	46	CIP_EMPTY_HAS_WRONG_DBC = 0x20,
62f00e40 TS	47	CIP_JUMBO_PAYLOAD = 0x40,
2128f78f	48	CIP_HEADER_WITHOUT_EOH = 0x80,
3b196c39	49	CIP_NO_HEADER = 0x100,
588f2e2c	50	CIP_UNALIGHED_DBC = 0x200,
31ef9134 CL	51	};
	52
	53	/**
5f217f90 TS	54	* enum cip_sfc - supported Sampling Frequency Codes (SFCs)
	55	* @CIP_SFC_32000: 32,000 data blocks
	56	* @CIP_SFC_44100: 44,100 data blocks
	57	* @CIP_SFC_48000: 48,000 data blocks
	58	* @CIP_SFC_88200: 88,200 data blocks
	59	* @CIP_SFC_96000: 96,000 data blocks
	60	* @CIP_SFC_176400: 176,400 data blocks
	61	* @CIP_SFC_192000: 192,000 data blocks
	62	* @CIP_SFC_COUNT: the number of supported SFCs
	63	*
	64	* These values are used to show nominal Sampling Frequency Code in
	65	* Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002,
	66	* this code means the number of events per second. Actually the code
	67	* represents the number of data blocks transferred per second in an AMDTP
	68	* stream.
	69	*
	70	* In IEC 61883-6:2005, some extensions were added to support more types of
	71	* data such as 'One Bit LInear Audio', therefore the meaning of SFC became
	72	* different depending on the types.
	73	*
	74	* Currently our implementation is compatible with IEC 61883-6:2002.
31ef9134 CL	75	*/
	76	enum cip_sfc {
	77	CIP_SFC_32000 = 0,
	78	CIP_SFC_44100 = 1,
	79	CIP_SFC_48000 = 2,
	80	CIP_SFC_88200 = 3,
	81	CIP_SFC_96000 = 4,
	82	CIP_SFC_176400 = 5,
	83	CIP_SFC_192000 = 6,
a7304e3b	84	CIP_SFC_COUNT
31ef9134 CL	85	};
31ef9134 CL	86
31ef9134 CL	87	struct fw_unit;
	88	struct fw_iso_context;
	89	struct snd_pcm_substream;
7b2d99fa	90	struct snd_pcm_runtime;
31ef9134	91
3ff7e8f0 TS	92	enum amdtp_stream_direction {
	93	AMDTP_OUT_STREAM = 0,
	94	AMDTP_IN_STREAM
	95	};
	96
04130cf8 TS	97	struct pkt_desc {
	98	u32 cycle;
	99	u32 syt;
	100	unsigned int data_blocks;
	101	unsigned int data_block_counter;
	102	__be32 *ctx_payload;
	103	};
	104
df075fee	105	struct amdtp_stream;
9a738ad1	106	typedef unsigned int (*amdtp_stream_process_ctx_payloads_t)(
df075fee	107	struct amdtp_stream *s,
d2c104a3	108	const struct pkt_desc *desc,
9a738ad1	109	unsigned int packets,
d2c104a3	110	struct snd_pcm_substream *pcm);
be4a2894	111	struct amdtp_stream {
31ef9134	112	struct fw_unit *unit;
be4a2894	113	enum cip_flags flags;
3ff7e8f0	114	enum amdtp_stream_direction direction;
31ef9134 CL	115	struct mutex mutex;
31ef9134 CL	116
10b2b6dc TS	117	/* For packet processing. */
10b2b6dc TS	118	struct fw_iso_context *context;
31ef9134	119	struct iso_packets_buffer buffer;
ec00f5e4	120	int packet_index;
04130cf8	121	struct pkt_desc *pkt_descs;
3b196c39	122	int tag;
d3d10a4a TS	123	union {
	124	struct {
	125	unsigned int ctx_header_size;
	126
	127	// limit for payload of iso packet.
f11453c7	128	unsigned int max_ctx_payload_length;
d3d10a4a TS	129
	130	// For quirks of CIP headers.
	131	// Fixed interval of dbc between previos/current
	132	// packets.
	133	unsigned int dbc_interval;
d3d10a4a TS	134	} tx;
	135	struct {
	136	// To calculate CIP data blocks and tstamp.
	137	unsigned int transfer_delay;
	138	unsigned int data_block_state;
	139	unsigned int last_syt_offset;
	140	unsigned int syt_offset_state;
	141
	142	// To generate CIP header.
	143	unsigned int fdf;
3baf3053	144	int syt_override;
d3d10a4a TS	145	} rx;
d3d10a4a TS	146	} ctx_data;
10b2b6dc TS	147
	148	/* For CIP headers. */
	149	unsigned int source_node_id_field;
	150	unsigned int data_block_quadlets;
31ef9134	151	unsigned int data_block_counter;
9863874f	152	unsigned int sph;
414ba022	153	unsigned int fmt;
31ef9134	154
10b2b6dc TS	155	/* Internal flags. */
	156	enum cip_sfc sfc;
	157	unsigned int syt_interval;
31ef9134	158
10b2b6dc TS	159	/* For a PCM substream processing. */
	160	struct snd_pcm_substream *pcm;
	161	struct tasklet_struct period_tasklet;
4a9bfafc	162	snd_pcm_uframes_t pcm_buffer_pointer;
31ef9134	163	unsigned int pcm_period_pointer;
83d8d72d	164
10b2b6dc TS	165	/* To wait for first packet. */
	166	bool callbacked;
	167	wait_queue_head_t callback_wait;
a04513f8	168	u32 start_cycle;
10b2b6dc	169
df075fee TS	170	/* For backends to process data blocks. */
df075fee TS	171	void *protocol;
9a738ad1	172	amdtp_stream_process_ctx_payloads_t process_ctx_payloads;
31ef9134 CL	173	};
31ef9134 CL	174
be4a2894	175	int amdtp_stream_init(struct amdtp_stream s, struct fw_unit unit,
df075fee TS	176	enum amdtp_stream_direction dir, enum cip_flags flags,
df075fee TS	177	unsigned int fmt,
9a738ad1	178	amdtp_stream_process_ctx_payloads_t process_ctx_payloads,
df075fee	179	unsigned int protocol_size);
be4a2894	180	void amdtp_stream_destroy(struct amdtp_stream *s);
31ef9134	181
df075fee TS	182	int amdtp_stream_set_parameters(struct amdtp_stream *s, unsigned int rate,
df075fee TS	183	unsigned int data_block_quadlets);
be4a2894	184	unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);
31ef9134	185
be4a2894 TS	186	int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed);
	187	void amdtp_stream_update(struct amdtp_stream *s);
	188	void amdtp_stream_stop(struct amdtp_stream *s);
31ef9134	189
7b2d99fa TS	190	int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s,
7b2d99fa TS	191	struct snd_pcm_runtime *runtime);
df075fee	192
be4a2894 TS	193	void amdtp_stream_pcm_prepare(struct amdtp_stream *s);
be4a2894 TS	194	unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s);
875becf8	195	int amdtp_stream_pcm_ack(struct amdtp_stream *s);
be4a2894	196	void amdtp_stream_pcm_abort(struct amdtp_stream *s);
31ef9134	197
c5280e99	198	extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
1017abed	199	extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT];
a7304e3b	200
be4a2894 TS	201	/**
	202	* amdtp_stream_running - check stream is running or not
	203	* @s: the AMDTP stream
	204	*
	205	* If this function returns true, the stream is running.
	206	*/
	207	static inline bool amdtp_stream_running(struct amdtp_stream *s)
20b65dd0 CL	208	{
	209	return !IS_ERR(s->context);
	210	}
	211
ec00f5e4	212	/**
be4a2894 TS	213	* amdtp_streaming_error - check for streaming error
be4a2894 TS	214	* @s: the AMDTP stream
ec00f5e4 CL	215	*
	216	* If this function returns true, the stream's packet queue has stopped due to
	217	* an asynchronous error.
	218	*/
be4a2894	219	static inline bool amdtp_streaming_error(struct amdtp_stream *s)
ec00f5e4 CL	220	{
	221	return s->packet_index < 0;
	222	}
	223
83d8d72d TS	224	/**
	225	* amdtp_stream_pcm_running - check PCM substream is running or not
	226	* @s: the AMDTP stream
	227	*
	228	* If this function returns true, PCM substream in the AMDTP stream is running.
	229	*/
	230	static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s)
	231	{
	232	return !!s->pcm;
	233	}
	234
31ef9134	235	/**
be4a2894 TS	236	* amdtp_stream_pcm_trigger - start/stop playback from a PCM device
be4a2894 TS	237	* @s: the AMDTP stream
31ef9134 CL	238	* @pcm: the PCM device to be started, or %NULL to stop the current device
	239	*
	240	* Call this function on a running isochronous stream to enable the actual
	241	* transmission of PCM data. This function should be called from the PCM
	242	* device's .trigger callback.
	243	*/
be4a2894 TS	244	static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
be4a2894 TS	245	struct snd_pcm_substream *pcm)
31ef9134	246	{
6aa7de05	247	WRITE_ONCE(s->pcm, pcm);
31ef9134 CL	248	}
31ef9134 CL	249
31ef9134 CL	250	static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
	251	{
	252	return sfc & 1;
	253	}
	254
7b3b0d85 TS	255	/**
	256	* amdtp_stream_wait_callback - sleep till callbacked or timeout
	257	* @s: the AMDTP stream
	258	* @timeout: msec till timeout
	259	*
	260	* If this function return false, the AMDTP stream should be stopped.
	261	*/
	262	static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s,
	263	unsigned int timeout)
	264	{
	265	return wait_event_timeout(s->callback_wait,
	266	s->callbacked == true,
	267	msecs_to_jiffies(timeout)) > 0;
	268	}
	269
31ef9134	270	#endif