[linux-2.6-block.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_out_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_HI_DUALWIRE: At rates above 96 kHz, pretend that the stream runs
 *	at half the actual sample rate with twice the number of channels;
 *	two samples of a channel are stored consecutively in the packet.
 *	Requires blocking mode and SYT_INTERVAL-aligned PCM buffer size.
 */
enum cip_out_flags {
	CIP_NONBLOCKING	= 0x00,
	CIP_BLOCKING	= 0x01,
	CIP_HI_DUALWIRE	= 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_OUT_PCM_FORMAT_BITS	(SNDRV_PCM_FMTBIT_S16 | \
					 SNDRV_PCM_FMTBIT_S32)

struct fw_unit;
struct fw_iso_context;
struct snd_pcm_substream;

struct amdtp_out_stream {
	struct fw_unit *unit;
	enum cip_out_flags flags;
	struct fw_iso_context *context;
	struct mutex mutex;

	enum cip_sfc sfc;
	bool dual_wire;
	unsigned int data_block_quadlets;
	unsigned int pcm_channels;
	unsigned int midi_ports;
	void (*transfer_samples)(struct amdtp_out_stream *s,
				 struct snd_pcm_substream *pcm,
				 __be32 *buffer, unsigned int frames);

	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;
};

int amdtp_out_stream_init(struct amdtp_out_stream *s, struct fw_unit *unit,
			  enum cip_out_flags flags);
void amdtp_out_stream_destroy(struct amdtp_out_stream *s);

void amdtp_out_stream_set_parameters(struct amdtp_out_stream *s,
				     unsigned int rate,
				     unsigned int pcm_channels,
				     unsigned int midi_ports);
unsigned int amdtp_out_stream_get_max_payload(struct amdtp_out_stream *s);

int amdtp_out_stream_start(struct amdtp_out_stream *s, int channel, int speed);
void amdtp_out_stream_update(struct amdtp_out_stream *s);
void amdtp_out_stream_stop(struct amdtp_out_stream *s);

void amdtp_out_stream_set_pcm_format(struct amdtp_out_stream *s,
				     snd_pcm_format_t format);
void amdtp_out_stream_pcm_prepare(struct amdtp_out_stream *s);
unsigned long amdtp_out_stream_pcm_pointer(struct amdtp_out_stream *s);
void amdtp_out_stream_pcm_abort(struct amdtp_out_stream *s);

extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];

static inline bool amdtp_out_stream_running(struct amdtp_out_stream *s)
{
	return !IS_ERR(s->context);
}

/**
 * amdtp_out_streaming_error - check for streaming error
 * @s: the AMDTP output stream
 *
 * If this function returns true, the stream's packet queue has stopped due to
 * an asynchronous error.
 */
static inline bool amdtp_out_streaming_error(struct amdtp_out_stream *s)
{
	return s->packet_index < 0;
}

/**
 * amdtp_out_stream_pcm_trigger - start/stop playback from a PCM device
 * @s: the AMDTP output 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_out_stream_pcm_trigger(struct amdtp_out_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;
}

#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	/**
	11	* enum cip_out_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.
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.
a7304e3b CL	19	* @CIP_HI_DUALWIRE: At rates above 96 kHz, pretend that the stream runs
	20	* at half the actual sample rate with twice the number of channels;
	21	* two samples of a channel are stored consecutively in the packet.
	22	* Requires blocking mode and SYT_INTERVAL-aligned PCM buffer size.
31ef9134 CL	23	*/
31ef9134 CL	24	enum cip_out_flags {
e84d15f6 CL	25	CIP_NONBLOCKING = 0x00,
e84d15f6 CL	26	CIP_BLOCKING = 0x01,
a7304e3b	27	CIP_HI_DUALWIRE = 0x02,
31ef9134 CL	28	};
	29
	30	/**
	31	* enum cip_sfc - a stream's sample rate
	32	*/
	33	enum cip_sfc {
	34	CIP_SFC_32000 = 0,
	35	CIP_SFC_44100 = 1,
	36	CIP_SFC_48000 = 2,
	37	CIP_SFC_88200 = 3,
	38	CIP_SFC_96000 = 4,
	39	CIP_SFC_176400 = 5,
	40	CIP_SFC_192000 = 6,
a7304e3b	41	CIP_SFC_COUNT
31ef9134 CL	42	};
	43
	44	#define AMDTP_OUT_PCM_FORMAT_BITS (SNDRV_PCM_FMTBIT_S16 \| \
	45	SNDRV_PCM_FMTBIT_S32)
	46
	47	struct fw_unit;
	48	struct fw_iso_context;
	49	struct snd_pcm_substream;
	50
	51	struct amdtp_out_stream {
	52	struct fw_unit *unit;
	53	enum cip_out_flags flags;
	54	struct fw_iso_context *context;
	55	struct mutex mutex;
	56
	57	enum cip_sfc sfc;
a7304e3b	58	bool dual_wire;
31ef9134 CL	59	unsigned int data_block_quadlets;
	60	unsigned int pcm_channels;
	61	unsigned int midi_ports;
	62	void (transfer_samples)(struct amdtp_out_stream s,
	63	struct snd_pcm_substream *pcm,
	64	__be32 *buffer, unsigned int frames);
	65
	66	unsigned int syt_interval;
e84d15f6	67	unsigned int transfer_delay;
31ef9134 CL	68	unsigned int source_node_id_field;
	69	struct iso_packets_buffer buffer;
	70
	71	struct snd_pcm_substream *pcm;
76fb8789	72	struct tasklet_struct period_tasklet;
31ef9134	73
ec00f5e4	74	int packet_index;
31ef9134 CL	75	unsigned int data_block_counter;
	76
	77	unsigned int data_block_state;
	78
	79	unsigned int last_syt_offset;
	80	unsigned int syt_offset_state;
	81
	82	unsigned int pcm_buffer_pointer;
	83	unsigned int pcm_period_pointer;
92b862c7	84	bool pointer_flush;
31ef9134 CL	85	};
	86
	87	int amdtp_out_stream_init(struct amdtp_out_stream s, struct fw_unit unit,
	88	enum cip_out_flags flags);
	89	void amdtp_out_stream_destroy(struct amdtp_out_stream *s);
	90
a7304e3b CL	91	void amdtp_out_stream_set_parameters(struct amdtp_out_stream *s,
	92	unsigned int rate,
	93	unsigned int pcm_channels,
	94	unsigned int midi_ports);
31ef9134 CL	95	unsigned int amdtp_out_stream_get_max_payload(struct amdtp_out_stream *s);
	96
	97	int amdtp_out_stream_start(struct amdtp_out_stream *s, int channel, int speed);
	98	void amdtp_out_stream_update(struct amdtp_out_stream *s);
	99	void amdtp_out_stream_stop(struct amdtp_out_stream *s);
	100
	101	void amdtp_out_stream_set_pcm_format(struct amdtp_out_stream *s,
	102	snd_pcm_format_t format);
76fb8789	103	void amdtp_out_stream_pcm_prepare(struct amdtp_out_stream *s);
e9148ddd	104	unsigned long amdtp_out_stream_pcm_pointer(struct amdtp_out_stream *s);
31ef9134 CL	105	void amdtp_out_stream_pcm_abort(struct amdtp_out_stream *s);
31ef9134 CL	106
c5280e99	107	extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
a7304e3b	108
20b65dd0 CL	109	static inline bool amdtp_out_stream_running(struct amdtp_out_stream *s)
	110	{
	111	return !IS_ERR(s->context);
	112	}
	113
ec00f5e4 CL	114	/**
	115	* amdtp_out_streaming_error - check for streaming error
	116	* @s: the AMDTP output stream
	117	*
	118	* If this function returns true, the stream's packet queue has stopped due to
	119	* an asynchronous error.
	120	*/
	121	static inline bool amdtp_out_streaming_error(struct amdtp_out_stream *s)
	122	{
	123	return s->packet_index < 0;
	124	}
	125
31ef9134 CL	126	/**
	127	* amdtp_out_stream_pcm_trigger - start/stop playback from a PCM device
	128	* @s: the AMDTP output stream
	129	* @pcm: the PCM device to be started, or %NULL to stop the current device
	130	*
	131	* Call this function on a running isochronous stream to enable the actual
	132	* transmission of PCM data. This function should be called from the PCM
	133	* device's .trigger callback.
	134	*/
	135	static inline void amdtp_out_stream_pcm_trigger(struct amdtp_out_stream *s,
	136	struct snd_pcm_substream *pcm)
	137	{
	138	ACCESS_ONCE(s->pcm) = pcm;
	139	}
	140
31ef9134 CL	141	static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
	142	{
	143	return sfc & 1;
	144	}
	145
	146	#endif