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

/**
 * 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;
	bool double_pcm_frames;

	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;

	/* quirk: the first count of data blocks in an rx packet for MIDI */
	unsigned int rx_blocks_for_midi;

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