[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_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_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_IN_PCM_FORMAT_BITS	SNDRV_PCM_FMTBIT_S32

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

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;
	bool dual_wire;
	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);

	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_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);

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

/**
 * 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_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;
}

#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.
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	23	*/
be4a2894	24	enum cip_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	};
31ef9134 CL	43
2b3fc456 TS	44	#define AMDTP_IN_PCM_FORMAT_BITS SNDRV_PCM_FMTBIT_S32
2b3fc456 TS	45
31ef9134 CL	46	#define AMDTP_OUT_PCM_FORMAT_BITS (SNDRV_PCM_FMTBIT_S16 \| \
	47	SNDRV_PCM_FMTBIT_S32)
	48
	49	struct fw_unit;
	50	struct fw_iso_context;
	51	struct snd_pcm_substream;
	52
3ff7e8f0 TS	53	enum amdtp_stream_direction {
	54	AMDTP_OUT_STREAM = 0,
	55	AMDTP_IN_STREAM
	56	};
	57
be4a2894	58	struct amdtp_stream {
31ef9134	59	struct fw_unit *unit;
be4a2894	60	enum cip_flags flags;
3ff7e8f0	61	enum amdtp_stream_direction direction;
31ef9134 CL	62	struct fw_iso_context *context;
	63	struct mutex mutex;
	64
	65	enum cip_sfc sfc;
a7304e3b	66	bool dual_wire;
31ef9134 CL	67	unsigned int data_block_quadlets;
	68	unsigned int pcm_channels;
	69	unsigned int midi_ports;
be4a2894	70	void (transfer_samples)(struct amdtp_stream s,
31ef9134 CL	71	struct snd_pcm_substream *pcm,
	72	__be32 *buffer, unsigned int frames);
	73
	74	unsigned int syt_interval;
e84d15f6	75	unsigned int transfer_delay;
31ef9134 CL	76	unsigned int source_node_id_field;
	77	struct iso_packets_buffer buffer;
	78
	79	struct snd_pcm_substream *pcm;
76fb8789	80	struct tasklet_struct period_tasklet;
31ef9134	81
ec00f5e4	82	int packet_index;
31ef9134 CL	83	unsigned int data_block_counter;
	84
	85	unsigned int data_block_state;
	86
	87	unsigned int last_syt_offset;
	88	unsigned int syt_offset_state;
	89
	90	unsigned int pcm_buffer_pointer;
	91	unsigned int pcm_period_pointer;
92b862c7	92	bool pointer_flush;
31ef9134 CL	93	};
31ef9134 CL	94
be4a2894	95	int amdtp_stream_init(struct amdtp_stream s, struct fw_unit unit,
3ff7e8f0	96	enum amdtp_stream_direction dir,
be4a2894 TS	97	enum cip_flags flags);
be4a2894 TS	98	void amdtp_stream_destroy(struct amdtp_stream *s);
31ef9134	99
be4a2894 TS	100	void amdtp_stream_set_parameters(struct amdtp_stream *s,
	101	unsigned int rate,
	102	unsigned int pcm_channels,
	103	unsigned int midi_ports);
	104	unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);
31ef9134	105
be4a2894 TS	106	int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed);
	107	void amdtp_stream_update(struct amdtp_stream *s);
	108	void amdtp_stream_stop(struct amdtp_stream *s);
31ef9134	109
be4a2894 TS	110	void amdtp_stream_set_pcm_format(struct amdtp_stream *s,
	111	snd_pcm_format_t format);
	112	void amdtp_stream_pcm_prepare(struct amdtp_stream *s);
	113	unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s);
	114	void amdtp_stream_pcm_abort(struct amdtp_stream *s);
31ef9134	115
c5280e99	116	extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
a7304e3b	117
be4a2894 TS	118	/**
	119	* amdtp_stream_running - check stream is running or not
	120	* @s: the AMDTP stream
	121	*
	122	* If this function returns true, the stream is running.
	123	*/
	124	static inline bool amdtp_stream_running(struct amdtp_stream *s)
20b65dd0 CL	125	{
	126	return !IS_ERR(s->context);
	127	}
	128
ec00f5e4	129	/**
be4a2894 TS	130	* amdtp_streaming_error - check for streaming error
be4a2894 TS	131	* @s: the AMDTP stream
ec00f5e4 CL	132	*
	133	* If this function returns true, the stream's packet queue has stopped due to
	134	* an asynchronous error.
	135	*/
be4a2894	136	static inline bool amdtp_streaming_error(struct amdtp_stream *s)
ec00f5e4 CL	137	{
	138	return s->packet_index < 0;
	139	}
	140
31ef9134	141	/**
be4a2894 TS	142	* amdtp_stream_pcm_trigger - start/stop playback from a PCM device
be4a2894 TS	143	* @s: the AMDTP stream
31ef9134 CL	144	* @pcm: the PCM device to be started, or %NULL to stop the current device
	145	*
	146	* Call this function on a running isochronous stream to enable the actual
	147	* transmission of PCM data. This function should be called from the PCM
	148	* device's .trigger callback.
	149	*/
be4a2894 TS	150	static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
be4a2894 TS	151	struct snd_pcm_substream *pcm)
31ef9134 CL	152	{
	153	ACCESS_ONCE(s->pcm) = pcm;
	154	}
	155
31ef9134 CL	156	static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
	157	{
	158	return sfc & 1;
	159	}
	160
	161	#endif