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

#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_SYNC_TO_DEVICE: In sync to device mode, time stamp in out packets is
 *	generated by in packets. Defaultly this driver generates timestamp.
 * @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0.
 * @CIP_DBC_IS_END_EVENT: Only for in-stream. The value of dbc in an in-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_SKIP_INIT_DBC_CHECK: Only for in-stream. The value of dbc in first
 *	packet is not continuous from an initial value.
 * @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.
 */
enum cip_flags {
	CIP_NONBLOCKING		= 0x00,
	CIP_BLOCKING		= 0x01,
	CIP_SYNC_TO_DEVICE	= 0x02,
	CIP_EMPTY_WITH_TAG0	= 0x04,
	CIP_DBC_IS_END_EVENT	= 0x08,
	CIP_WRONG_DBS		= 0x10,
	CIP_SKIP_DBC_ZERO_CHECK	= 0x20,
	CIP_SKIP_INIT_DBC_CHECK	= 0x40,
	CIP_EMPTY_HAS_WRONG_DBC	= 0x80,
	CIP_JUMBO_PAYLOAD	= 0x100,
};

/**
 * 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 amdtp_stream;
typedef unsigned int (*amdtp_stream_process_data_blocks_t)(
						struct amdtp_stream *s,
						__be32 *buffer,
						unsigned int data_blocks,
						unsigned int *syt);
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;

	/* For CIP headers. */
	unsigned int source_node_id_field;
	unsigned int data_block_quadlets;
	unsigned int data_block_counter;
	unsigned int fmt;
	unsigned int fdf;
	/* quirk: fixed interval of dbc between previos/current packets. */
	unsigned int tx_dbc_interval;
	/* quirk: indicate the value of dbc field in a first packet. */
	unsigned int tx_first_dbc;

	/* Internal flags. */
	enum cip_sfc sfc;
	unsigned int syt_interval;
	unsigned int transfer_delay;
	unsigned int data_block_state;
	unsigned int last_syt_offset;
	unsigned int syt_offset_state;

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

	/* To wait for first packet. */
	bool callbacked;
	wait_queue_head_t callback_wait;
	struct amdtp_stream *sync_slave;

	/* For backends to process data blocks. */
	void *protocol;
	amdtp_stream_process_data_blocks_t process_data_blocks;
};

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_data_blocks_t process_data_blocks,
		      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);
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)
{
	ACCESS_ONCE(s->pcm) = pcm;
}

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

static inline void amdtp_stream_set_sync(enum cip_flags sync_mode,
					 struct amdtp_stream *master,
					 struct amdtp_stream *slave)
{
	if (sync_mode == CIP_SYNC_TO_DEVICE) {
		master->flags |= CIP_SYNC_TO_DEVICE;
		slave->flags |= CIP_SYNC_TO_DEVICE;
		master->sync_slave = slave;
	} else {
		master->flags &= ~CIP_SYNC_TO_DEVICE;
		slave->flags &= ~CIP_SYNC_TO_DEVICE;
		master->sync_slave = NULL;
	}

	slave->sync_slave = NULL;
}

/**
 * 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
31ef9134 CL	1	#ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED
	2	#define SOUND_FIREWIRE_AMDTP_H_INCLUDED
	3
20b65dd0	4	#include <linux/err.h>
76fb8789	5	#include <linux/interrupt.h>
31ef9134	6	#include <linux/mutex.h>
5955815e	7	#include <linux/sched.h>
777fb574	8	#include <sound/asound.h>
31ef9134 CL	9	#include "packets-buffer.h"
	10
	11	/**
be4a2894	12	* enum cip_flags - describes details of the streaming protocol
31ef9134 CL	13	* @CIP_NONBLOCKING: In non-blocking mode, each packet contains
	14	* sample_rate/8000 samples, with rounding up or down to adjust
	15	* for clock skew and left-over fractional samples. This should
	16	* be used if supported by the device.
e84d15f6 CL	17	* @CIP_BLOCKING: In blocking mode, each packet contains either zero or
	18	* SYT_INTERVAL samples, with these two types alternating so that
	19	* the overall sample rate comes out right.
7b3b0d85 TS	20	* @CIP_SYNC_TO_DEVICE: In sync to device mode, time stamp in out packets is
7b3b0d85 TS	21	* generated by in packets. Defaultly this driver generates timestamp.
7ab56645	22	* @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0.
c8bdf49b TS	23	* @CIP_DBC_IS_END_EVENT: Only for in-stream. The value of dbc in an in-packet
c8bdf49b TS	24	* corresponds to the end of event in the packet. Out of IEC 61883.
69702239 TS	25	* @CIP_WRONG_DBS: Only for in-stream. The value of dbs is wrong in in-packets.
69702239 TS	26	* The value of data_block_quadlets is used instead of reported value.
5f217f90	27	* @CIP_SKIP_DBC_ZERO_CHECK: Only for in-stream. Packets with zero in dbc is
b84b1a27	28	* skipped for detecting discontinuity.
b6bc8123 TS	29	* @CIP_SKIP_INIT_DBC_CHECK: Only for in-stream. The value of dbc in first
b6bc8123 TS	30	* packet is not continuous from an initial value.
9d59124c TS	31	* @CIP_EMPTY_HAS_WRONG_DBC: Only for in-stream. The value of dbc in empty
9d59124c TS	32	* packet is wrong but the others are correct.
a2064710 TS	33	* @CIP_JUMBO_PAYLOAD: Only for in-stream. The number of data blocks in an
	34	* packet is larger than IEC 61883-6 defines. Current implementation
	35	* allows 5 times as large as IEC 61883-6 defines.
31ef9134	36	*/
be4a2894	37	enum cip_flags {
7b3b0d85 TS	38	CIP_NONBLOCKING = 0x00,
7b3b0d85 TS	39	CIP_BLOCKING = 0x01,
10550bea	40	CIP_SYNC_TO_DEVICE = 0x02,
7ab56645	41	CIP_EMPTY_WITH_TAG0 = 0x04,
c8bdf49b	42	CIP_DBC_IS_END_EVENT = 0x08,
69702239	43	CIP_WRONG_DBS = 0x10,
b84b1a27	44	CIP_SKIP_DBC_ZERO_CHECK = 0x20,
b6bc8123	45	CIP_SKIP_INIT_DBC_CHECK = 0x40,
9d59124c	46	CIP_EMPTY_HAS_WRONG_DBC = 0x80,
a2064710	47	CIP_JUMBO_PAYLOAD = 0x100,
31ef9134 CL	48	};
	49
	50	/**
5f217f90 TS	51	* enum cip_sfc - supported Sampling Frequency Codes (SFCs)
	52	* @CIP_SFC_32000: 32,000 data blocks
	53	* @CIP_SFC_44100: 44,100 data blocks
	54	* @CIP_SFC_48000: 48,000 data blocks
	55	* @CIP_SFC_88200: 88,200 data blocks
	56	* @CIP_SFC_96000: 96,000 data blocks
	57	* @CIP_SFC_176400: 176,400 data blocks
	58	* @CIP_SFC_192000: 192,000 data blocks
	59	* @CIP_SFC_COUNT: the number of supported SFCs
	60	*
	61	* These values are used to show nominal Sampling Frequency Code in
	62	* Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002,
	63	* this code means the number of events per second. Actually the code
	64	* represents the number of data blocks transferred per second in an AMDTP
	65	* stream.
	66	*
	67	* In IEC 61883-6:2005, some extensions were added to support more types of
	68	* data such as 'One Bit LInear Audio', therefore the meaning of SFC became
	69	* different depending on the types.
	70	*
	71	* Currently our implementation is compatible with IEC 61883-6:2002.
31ef9134 CL	72	*/
	73	enum cip_sfc {
	74	CIP_SFC_32000 = 0,
	75	CIP_SFC_44100 = 1,
	76	CIP_SFC_48000 = 2,
	77	CIP_SFC_88200 = 3,
	78	CIP_SFC_96000 = 4,
	79	CIP_SFC_176400 = 5,
	80	CIP_SFC_192000 = 6,
a7304e3b	81	CIP_SFC_COUNT
31ef9134 CL	82	};
31ef9134 CL	83
31ef9134 CL	84	struct fw_unit;
	85	struct fw_iso_context;
	86	struct snd_pcm_substream;
7b2d99fa	87	struct snd_pcm_runtime;
31ef9134	88
3ff7e8f0 TS	89	enum amdtp_stream_direction {
	90	AMDTP_OUT_STREAM = 0,
	91	AMDTP_IN_STREAM
	92	};
	93
df075fee TS	94	struct amdtp_stream;
	95	typedef unsigned int (*amdtp_stream_process_data_blocks_t)(
	96	struct amdtp_stream *s,
	97	__be32 *buffer,
	98	unsigned int data_blocks,
	99	unsigned int *syt);
be4a2894	100	struct amdtp_stream {
31ef9134	101	struct fw_unit *unit;
be4a2894	102	enum cip_flags flags;
3ff7e8f0	103	enum amdtp_stream_direction direction;
31ef9134 CL	104	struct mutex mutex;
31ef9134 CL	105
10b2b6dc TS	106	/* For packet processing. */
10b2b6dc TS	107	struct fw_iso_context *context;
31ef9134	108	struct iso_packets_buffer buffer;
ec00f5e4	109	int packet_index;
10b2b6dc TS	110
	111	/* For CIP headers. */
	112	unsigned int source_node_id_field;
	113	unsigned int data_block_quadlets;
31ef9134	114	unsigned int data_block_counter;
414ba022 TS	115	unsigned int fmt;
414ba022 TS	116	unsigned int fdf;
10b2b6dc TS	117	/* quirk: fixed interval of dbc between previos/current packets. */
	118	unsigned int tx_dbc_interval;
	119	/* quirk: indicate the value of dbc field in a first packet. */
	120	unsigned int tx_first_dbc;
31ef9134	121
10b2b6dc TS	122	/* Internal flags. */
	123	enum cip_sfc sfc;
	124	unsigned int syt_interval;
	125	unsigned int transfer_delay;
31ef9134	126	unsigned int data_block_state;
31ef9134 CL	127	unsigned int last_syt_offset;
	128	unsigned int syt_offset_state;
	129
10b2b6dc TS	130	/* For a PCM substream processing. */
	131	struct snd_pcm_substream *pcm;
	132	struct tasklet_struct period_tasklet;
31ef9134 CL	133	unsigned int pcm_buffer_pointer;
31ef9134 CL	134	unsigned int pcm_period_pointer;
92b862c7	135	bool pointer_flush;
83d8d72d	136
10b2b6dc TS	137	/* To wait for first packet. */
	138	bool callbacked;
	139	wait_queue_head_t callback_wait;
	140	struct amdtp_stream *sync_slave;
	141
df075fee TS	142	/* For backends to process data blocks. */
	143	void *protocol;
	144	amdtp_stream_process_data_blocks_t process_data_blocks;
31ef9134 CL	145	};
31ef9134 CL	146
be4a2894	147	int amdtp_stream_init(struct amdtp_stream s, struct fw_unit unit,
df075fee TS	148	enum amdtp_stream_direction dir, enum cip_flags flags,
	149	unsigned int fmt,
	150	amdtp_stream_process_data_blocks_t process_data_blocks,
	151	unsigned int protocol_size);
be4a2894	152	void amdtp_stream_destroy(struct amdtp_stream *s);
31ef9134	153
df075fee TS	154	int amdtp_stream_set_parameters(struct amdtp_stream *s, unsigned int rate,
df075fee TS	155	unsigned int data_block_quadlets);
be4a2894	156	unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);
31ef9134	157
be4a2894 TS	158	int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed);
	159	void amdtp_stream_update(struct amdtp_stream *s);
	160	void amdtp_stream_stop(struct amdtp_stream *s);
31ef9134	161
7b2d99fa TS	162	int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s,
7b2d99fa TS	163	struct snd_pcm_runtime *runtime);
df075fee	164
be4a2894 TS	165	void amdtp_stream_pcm_prepare(struct amdtp_stream *s);
	166	unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s);
	167	void amdtp_stream_pcm_abort(struct amdtp_stream *s);
31ef9134	168
c5280e99	169	extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
1017abed	170	extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT];
a7304e3b	171
be4a2894 TS	172	/**
	173	* amdtp_stream_running - check stream is running or not
	174	* @s: the AMDTP stream
	175	*
	176	* If this function returns true, the stream is running.
	177	*/
	178	static inline bool amdtp_stream_running(struct amdtp_stream *s)
20b65dd0 CL	179	{
	180	return !IS_ERR(s->context);
	181	}
	182
ec00f5e4	183	/**
be4a2894 TS	184	* amdtp_streaming_error - check for streaming error
be4a2894 TS	185	* @s: the AMDTP stream
ec00f5e4 CL	186	*
	187	* If this function returns true, the stream's packet queue has stopped due to
	188	* an asynchronous error.
	189	*/
be4a2894	190	static inline bool amdtp_streaming_error(struct amdtp_stream *s)
ec00f5e4 CL	191	{
	192	return s->packet_index < 0;
	193	}
	194
83d8d72d TS	195	/**
	196	* amdtp_stream_pcm_running - check PCM substream is running or not
	197	* @s: the AMDTP stream
	198	*
	199	* If this function returns true, PCM substream in the AMDTP stream is running.
	200	*/
	201	static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s)
	202	{
	203	return !!s->pcm;
	204	}
	205
31ef9134	206	/**
be4a2894 TS	207	* amdtp_stream_pcm_trigger - start/stop playback from a PCM device
be4a2894 TS	208	* @s: the AMDTP stream
31ef9134 CL	209	* @pcm: the PCM device to be started, or %NULL to stop the current device
	210	*
	211	* Call this function on a running isochronous stream to enable the actual
	212	* transmission of PCM data. This function should be called from the PCM
	213	* device's .trigger callback.
	214	*/
be4a2894 TS	215	static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
be4a2894 TS	216	struct snd_pcm_substream *pcm)
31ef9134 CL	217	{
	218	ACCESS_ONCE(s->pcm) = pcm;
	219	}
	220
31ef9134 CL	221	static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
	222	{
	223	return sfc & 1;
	224	}
	225
7b3b0d85 TS	226	static inline void amdtp_stream_set_sync(enum cip_flags sync_mode,
	227	struct amdtp_stream *master,
	228	struct amdtp_stream *slave)
	229	{
	230	if (sync_mode == CIP_SYNC_TO_DEVICE) {
	231	master->flags \|= CIP_SYNC_TO_DEVICE;
	232	slave->flags \|= CIP_SYNC_TO_DEVICE;
	233	master->sync_slave = slave;
	234	} else {
	235	master->flags &= ~CIP_SYNC_TO_DEVICE;
	236	slave->flags &= ~CIP_SYNC_TO_DEVICE;
	237	master->sync_slave = NULL;
	238	}
	239
	240	slave->sync_slave = NULL;
	241	}
	242
	243	/**
	244	* amdtp_stream_wait_callback - sleep till callbacked or timeout
	245	* @s: the AMDTP stream
	246	* @timeout: msec till timeout
	247	*
	248	* If this function return false, the AMDTP stream should be stopped.
	249	*/
	250	static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s,
	251	unsigned int timeout)
	252	{
	253	return wait_event_timeout(s->callback_wait,
	254	s->callbacked == true,
	255	msecs_to_jiffies(timeout)) > 0;
	256	}
	257
31ef9134	258	#endif