[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.
 */
enum cip_flags {
	CIP_NONBLOCKING		= 0x00,
	CIP_BLOCKING		= 0x01,
	CIP_SYNC_TO_DEVICE	= 0x02,
};

/**
 * 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];

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