[deliverable/linux.git] / sound / firewire / amdtp.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 <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.
 */
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,
};

/**
 * enum cip_sfc - a stream's sample rate
 */
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
};

#define AMDTP_IN_PCM_FORMAT_BITS	SNDRV_PCM_FMTBIT_S32

#define AMDTP_OUT_PCM_FORMAT_BITS	(SNDRV_PCM_FMTBIT_S16 | \
					 SNDRV_PCM_FMTBIT_S32)


/*
 * This module supports maximum 64 PCM channels for one PCM stream
 * This is for our convenience.
 */
#define AMDTP_MAX_CHANNELS_FOR_PCM	64

/*
 * AMDTP packet can include channels for MIDI conformant data.
 * Each MIDI conformant data channel includes 8 MPX-MIDI data stream.
 * Each MPX-MIDI data stream includes one data stream from/to MIDI ports.
 *
 * This module supports maximum 1 MIDI conformant data channels.
 * Then this AMDTP packets can transfer maximum 8 MIDI data streams.
 */
#define AMDTP_MAX_CHANNELS_FOR_MIDI	1

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

enum amdtp_stream_direction {
	AMDTP_OUT_STREAM = 0,
	AMDTP_IN_STREAM
};

struct amdtp_stream {
	struct fw_unit *unit;
	enum cip_flags flags;
	enum amdtp_stream_direction direction;
	struct fw_iso_context *context;
	struct mutex mutex;

	enum cip_sfc sfc;
	unsigned int data_block_quadlets;
	unsigned int pcm_channels;
	unsigned int midi_ports;
	void (*transfer_samples)(struct amdtp_stream *s,
				 struct snd_pcm_substream *pcm,
				 __be32 *buffer, unsigned int frames);
	u8 pcm_positions[AMDTP_MAX_CHANNELS_FOR_PCM];
	u8 midi_position;

	unsigned int syt_interval;
	unsigned int transfer_delay;
	unsigned int source_node_id_field;
	struct iso_packets_buffer buffer;

	struct snd_pcm_substream *pcm;
	struct tasklet_struct period_tasklet;

	int packet_index;
	unsigned int data_block_counter;

	unsigned int data_block_state;

	unsigned int last_syt_offset;
	unsigned int syt_offset_state;

	unsigned int pcm_buffer_pointer;
	unsigned int pcm_period_pointer;
	bool pointer_flush;

	struct snd_rawmidi_substream *midi[AMDTP_MAX_CHANNELS_FOR_MIDI * 8];

	/* quirk: fixed interval of dbc between previos/current packets. */
	unsigned int tx_dbc_interval;

	bool callbacked;
	wait_queue_head_t callback_wait;
	struct amdtp_stream *sync_slave;
};

int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit,
		      enum amdtp_stream_direction dir,
		      enum cip_flags flags);
void amdtp_stream_destroy(struct amdtp_stream *s);

void amdtp_stream_set_parameters(struct amdtp_stream *s,
				 unsigned int rate,
				 unsigned int pcm_channels,
				 unsigned int midi_ports);
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_set_pcm_format(struct amdtp_stream *s,
				 snd_pcm_format_t format);
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;
}

/**
 * amdtp_stream_midi_trigger - start/stop playback/capture with a MIDI device
 * @s: the AMDTP stream
 * @port: index of MIDI port
 * @midi: the MIDI 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 MIDI data.  This function should be called from the MIDI
 * device's .trigger callback.
 */
static inline void amdtp_stream_midi_trigger(struct amdtp_stream *s,
					     unsigned int port,
					     struct snd_rawmidi_substream *midi)
{
	if (port < s->midi_ports)
		ACCESS_ONCE(s->midi[port]) = midi;
}

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>
777fb574	7	#include <sound/asound.h>
31ef9134 CL	8	#include "packets-buffer.h"
	9
	10	/**
be4a2894	11	* enum cip_flags - describes details of the streaming protocol
31ef9134 CL	12	* @CIP_NONBLOCKING: In non-blocking mode, each packet contains
	13	* sample_rate/8000 samples, with rounding up or down to adjust
	14	* for clock skew and left-over fractional samples. This should
	15	* be used if supported by the device.
e84d15f6 CL	16	* @CIP_BLOCKING: In blocking mode, each packet contains either zero or
	17	* SYT_INTERVAL samples, with these two types alternating so that
	18	* the overall sample rate comes out right.
7b3b0d85 TS	19	* @CIP_SYNC_TO_DEVICE: In sync to device mode, time stamp in out packets is
7b3b0d85 TS	20	* generated by in packets. Defaultly this driver generates timestamp.
7ab56645	21	* @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0.
c8bdf49b TS	22	* @CIP_DBC_IS_END_EVENT: Only for in-stream. The value of dbc in an in-packet
c8bdf49b TS	23	* corresponds to the end 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.
31ef9134	26	*/
be4a2894	27	enum cip_flags {
7b3b0d85 TS	28	CIP_NONBLOCKING = 0x00,
7b3b0d85 TS	29	CIP_BLOCKING = 0x01,
10550bea	30	CIP_SYNC_TO_DEVICE = 0x02,
7ab56645	31	CIP_EMPTY_WITH_TAG0 = 0x04,
c8bdf49b	32	CIP_DBC_IS_END_EVENT = 0x08,
69702239	33	CIP_WRONG_DBS = 0x10,
31ef9134 CL	34	};
	35
	36	/**
	37	* enum cip_sfc - a stream's sample rate
	38	*/
	39	enum cip_sfc {
	40	CIP_SFC_32000 = 0,
	41	CIP_SFC_44100 = 1,
	42	CIP_SFC_48000 = 2,
	43	CIP_SFC_88200 = 3,
	44	CIP_SFC_96000 = 4,
	45	CIP_SFC_176400 = 5,
	46	CIP_SFC_192000 = 6,
a7304e3b	47	CIP_SFC_COUNT
31ef9134 CL	48	};
31ef9134 CL	49
2b3fc456 TS	50	#define AMDTP_IN_PCM_FORMAT_BITS SNDRV_PCM_FMTBIT_S32
2b3fc456 TS	51
31ef9134 CL	52	#define AMDTP_OUT_PCM_FORMAT_BITS (SNDRV_PCM_FMTBIT_S16 \| \
	53	SNDRV_PCM_FMTBIT_S32)
	54
83d8d72d	55
77d2a8a4 TS	56	/*
	57	* This module supports maximum 64 PCM channels for one PCM stream
	58	* This is for our convenience.
	59	*/
	60	#define AMDTP_MAX_CHANNELS_FOR_PCM 64
	61
83d8d72d TS	62	/*
	63	* AMDTP packet can include channels for MIDI conformant data.
	64	* Each MIDI conformant data channel includes 8 MPX-MIDI data stream.
	65	* Each MPX-MIDI data stream includes one data stream from/to MIDI ports.
	66	*
	67	* This module supports maximum 1 MIDI conformant data channels.
	68	* Then this AMDTP packets can transfer maximum 8 MIDI data streams.
	69	*/
	70	#define AMDTP_MAX_CHANNELS_FOR_MIDI 1
	71
31ef9134 CL	72	struct fw_unit;
	73	struct fw_iso_context;
	74	struct snd_pcm_substream;
7b2d99fa	75	struct snd_pcm_runtime;
83d8d72d	76	struct snd_rawmidi_substream;
31ef9134	77
3ff7e8f0 TS	78	enum amdtp_stream_direction {
	79	AMDTP_OUT_STREAM = 0,
	80	AMDTP_IN_STREAM
	81	};
	82
be4a2894	83	struct amdtp_stream {
31ef9134	84	struct fw_unit *unit;
be4a2894	85	enum cip_flags flags;
3ff7e8f0	86	enum amdtp_stream_direction direction;
31ef9134 CL	87	struct fw_iso_context *context;
	88	struct mutex mutex;
	89
	90	enum cip_sfc sfc;
	91	unsigned int data_block_quadlets;
	92	unsigned int pcm_channels;
	93	unsigned int midi_ports;
be4a2894	94	void (transfer_samples)(struct amdtp_stream s,
31ef9134 CL	95	struct snd_pcm_substream *pcm,
31ef9134 CL	96	__be32 *buffer, unsigned int frames);
77d2a8a4 TS	97	u8 pcm_positions[AMDTP_MAX_CHANNELS_FOR_PCM];
77d2a8a4 TS	98	u8 midi_position;
31ef9134 CL	99
31ef9134 CL	100	unsigned int syt_interval;
e84d15f6	101	unsigned int transfer_delay;
31ef9134 CL	102	unsigned int source_node_id_field;
	103	struct iso_packets_buffer buffer;
	104
	105	struct snd_pcm_substream *pcm;
76fb8789	106	struct tasklet_struct period_tasklet;
31ef9134	107
ec00f5e4	108	int packet_index;
31ef9134 CL	109	unsigned int data_block_counter;
	110
	111	unsigned int data_block_state;
	112
	113	unsigned int last_syt_offset;
	114	unsigned int syt_offset_state;
	115
	116	unsigned int pcm_buffer_pointer;
	117	unsigned int pcm_period_pointer;
92b862c7	118	bool pointer_flush;
83d8d72d TS	119
83d8d72d TS	120	struct snd_rawmidi_substream midi[AMDTP_MAX_CHANNELS_FOR_MIDI 8];
7b3b0d85	121
d9cd0065 TS	122	/* quirk: fixed interval of dbc between previos/current packets. */
	123	unsigned int tx_dbc_interval;
	124
7b3b0d85 TS	125	bool callbacked;
	126	wait_queue_head_t callback_wait;
	127	struct amdtp_stream *sync_slave;
31ef9134 CL	128	};
31ef9134 CL	129
be4a2894	130	int amdtp_stream_init(struct amdtp_stream s, struct fw_unit unit,
3ff7e8f0	131	enum amdtp_stream_direction dir,
be4a2894 TS	132	enum cip_flags flags);
be4a2894 TS	133	void amdtp_stream_destroy(struct amdtp_stream *s);
31ef9134	134
be4a2894 TS	135	void amdtp_stream_set_parameters(struct amdtp_stream *s,
	136	unsigned int rate,
	137	unsigned int pcm_channels,
	138	unsigned int midi_ports);
	139	unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);
31ef9134	140
be4a2894 TS	141	int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed);
	142	void amdtp_stream_update(struct amdtp_stream *s);
	143	void amdtp_stream_stop(struct amdtp_stream *s);
31ef9134	144
7b2d99fa TS	145	int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s,
7b2d99fa TS	146	struct snd_pcm_runtime *runtime);
be4a2894 TS	147	void amdtp_stream_set_pcm_format(struct amdtp_stream *s,
	148	snd_pcm_format_t format);
	149	void amdtp_stream_pcm_prepare(struct amdtp_stream *s);
	150	unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s);
	151	void amdtp_stream_pcm_abort(struct amdtp_stream *s);
31ef9134	152
c5280e99	153	extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
1017abed	154	extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT];
a7304e3b	155
be4a2894 TS	156	/**
	157	* amdtp_stream_running - check stream is running or not
	158	* @s: the AMDTP stream
	159	*
	160	* If this function returns true, the stream is running.
	161	*/
	162	static inline bool amdtp_stream_running(struct amdtp_stream *s)
20b65dd0 CL	163	{
	164	return !IS_ERR(s->context);
	165	}
	166
ec00f5e4	167	/**
be4a2894 TS	168	* amdtp_streaming_error - check for streaming error
be4a2894 TS	169	* @s: the AMDTP stream
ec00f5e4 CL	170	*
	171	* If this function returns true, the stream's packet queue has stopped due to
	172	* an asynchronous error.
	173	*/
be4a2894	174	static inline bool amdtp_streaming_error(struct amdtp_stream *s)
ec00f5e4 CL	175	{
	176	return s->packet_index < 0;
	177	}
	178
83d8d72d TS	179	/**
	180	* amdtp_stream_pcm_running - check PCM substream is running or not
	181	* @s: the AMDTP stream
	182	*
	183	* If this function returns true, PCM substream in the AMDTP stream is running.
	184	*/
	185	static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s)
	186	{
	187	return !!s->pcm;
	188	}
	189
31ef9134	190	/**
be4a2894 TS	191	* amdtp_stream_pcm_trigger - start/stop playback from a PCM device
be4a2894 TS	192	* @s: the AMDTP stream
31ef9134 CL	193	* @pcm: the PCM device to be started, or %NULL to stop the current device
	194	*
	195	* Call this function on a running isochronous stream to enable the actual
	196	* transmission of PCM data. This function should be called from the PCM
	197	* device's .trigger callback.
	198	*/
be4a2894 TS	199	static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
be4a2894 TS	200	struct snd_pcm_substream *pcm)
31ef9134 CL	201	{
	202	ACCESS_ONCE(s->pcm) = pcm;
	203	}
	204
83d8d72d TS	205	/**
	206	* amdtp_stream_midi_trigger - start/stop playback/capture with a MIDI device
	207	* @s: the AMDTP stream
	208	* @port: index of MIDI port
	209	* @midi: the MIDI 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 MIDI data. This function should be called from the MIDI
	213	* device's .trigger callback.
	214	*/
	215	static inline void amdtp_stream_midi_trigger(struct amdtp_stream *s,
	216	unsigned int port,
	217	struct snd_rawmidi_substream *midi)
	218	{
	219	if (port < s->midi_ports)
	220	ACCESS_ONCE(s->midi[port]) = midi;
	221	}
	222
31ef9134 CL	223	static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
	224	{
	225	return sfc & 1;
	226	}
	227
7b3b0d85 TS	228	static inline void amdtp_stream_set_sync(enum cip_flags sync_mode,
	229	struct amdtp_stream *master,
	230	struct amdtp_stream *slave)
	231	{
	232	if (sync_mode == CIP_SYNC_TO_DEVICE) {
	233	master->flags \|= CIP_SYNC_TO_DEVICE;
	234	slave->flags \|= CIP_SYNC_TO_DEVICE;
	235	master->sync_slave = slave;
	236	} else {
	237	master->flags &= ~CIP_SYNC_TO_DEVICE;
	238	slave->flags &= ~CIP_SYNC_TO_DEVICE;
	239	master->sync_slave = NULL;
	240	}
	241
	242	slave->sync_slave = NULL;
	243	}
	244
	245	/**
	246	* amdtp_stream_wait_callback - sleep till callbacked or timeout
	247	* @s: the AMDTP stream
	248	* @timeout: msec till timeout
	249	*
	250	* If this function return false, the AMDTP stream should be stopped.
	251	*/
	252	static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s,
	253	unsigned int timeout)
	254	{
	255	return wait_event_timeout(s->callback_wait,
	256	s->callbacked == true,
	257	msecs_to_jiffies(timeout)) > 0;
	258	}
	259
31ef9134	260	#endif