amdtp.h 9.4 KB
Newer Older
1 2 3
#ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED
#define SOUND_FIREWIRE_AMDTP_H_INCLUDED

4
#include <linux/err.h>
5
#include <linux/interrupt.h>
6
#include <linux/mutex.h>
7
#include <sound/asound.h>
8 9 10
#include "packets-buffer.h"

/**
11
 * enum cip_flags - describes details of the streaming protocol
12 13 14 15
 * @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.
16 17 18
 * @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.
19 20
 * @CIP_SYNC_TO_DEVICE: In sync to device mode, time stamp in out packets is
 *	generated by in packets. Defaultly this driver generates timestamp.
21
 * @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0.
22 23
 * @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.
24 25
 * @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.
26
 * @CIP_SKIP_DBC_ZERO_CHECK: Only for in-stream.  Packets with zero in dbc is
27
 *	skipped for detecting discontinuity.
28 29
 * @CIP_SKIP_INIT_DBC_CHECK: Only for in-stream. The value of dbc in first
 *	packet is not continuous from an initial value.
30 31
 * @CIP_EMPTY_HAS_WRONG_DBC: Only for in-stream. The value of dbc in empty
 *	packet is wrong but the others are correct.
32 33 34
 * @CIP_JUMBO_PAYLOAD: Only for in-stream. The number of data blocks in an
 *	packet is larger than IEC 61883-6 defines. Current implementation
 *	allows 5 times as large as IEC 61883-6 defines.
35
 */
36
enum cip_flags {
37 38
	CIP_NONBLOCKING		= 0x00,
	CIP_BLOCKING		= 0x01,
39
	CIP_SYNC_TO_DEVICE	= 0x02,
40
	CIP_EMPTY_WITH_TAG0	= 0x04,
41
	CIP_DBC_IS_END_EVENT	= 0x08,
42
	CIP_WRONG_DBS		= 0x10,
43
	CIP_SKIP_DBC_ZERO_CHECK	= 0x20,
44
	CIP_SKIP_INIT_DBC_CHECK	= 0x40,
45
	CIP_EMPTY_HAS_WRONG_DBC	= 0x80,
46
	CIP_JUMBO_PAYLOAD	= 0x100,
47 48 49
};

/**
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
 * enum cip_sfc - supported Sampling Frequency Codes (SFCs)
 * @CIP_SFC_32000:   32,000 data blocks
 * @CIP_SFC_44100:   44,100 data blocks
 * @CIP_SFC_48000:   48,000 data blocks
 * @CIP_SFC_88200:   88,200 data blocks
 * @CIP_SFC_96000:   96,000 data blocks
 * @CIP_SFC_176400: 176,400 data blocks
 * @CIP_SFC_192000: 192,000 data blocks
 * @CIP_SFC_COUNT: the number of supported SFCs
 *
 * These values are used to show nominal Sampling Frequency Code in
 * Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002,
 * this code means the number of events per second. Actually the code
 * represents the number of data blocks transferred per second in an AMDTP
 * stream.
 *
 * In IEC 61883-6:2005, some extensions were added to support more types of
 * data such as 'One Bit LInear Audio', therefore the meaning of SFC became
 * different depending on the types.
 *
 * Currently our implementation is compatible with IEC 61883-6:2002.
71 72 73 74 75 76 77 78 79
 */
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,
80
	CIP_SFC_COUNT
81 82
};

83 84
#define AMDTP_IN_PCM_FORMAT_BITS	SNDRV_PCM_FMTBIT_S32

85 86 87
#define AMDTP_OUT_PCM_FORMAT_BITS	(SNDRV_PCM_FMTBIT_S16 | \
					 SNDRV_PCM_FMTBIT_S32)

88

89 90 91 92 93 94
/*
 * This module supports maximum 64 PCM channels for one PCM stream
 * This is for our convenience.
 */
#define AMDTP_MAX_CHANNELS_FOR_PCM	64

95 96 97 98 99 100 101 102 103 104
/*
 * 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

105 106 107
struct fw_unit;
struct fw_iso_context;
struct snd_pcm_substream;
108
struct snd_pcm_runtime;
109
struct snd_rawmidi_substream;
110

111 112 113 114 115
enum amdtp_stream_direction {
	AMDTP_OUT_STREAM = 0,
	AMDTP_IN_STREAM
};

116
struct amdtp_stream {
117
	struct fw_unit *unit;
118
	enum cip_flags flags;
119
	enum amdtp_stream_direction direction;
120 121
	struct mutex mutex;

122 123
	/* For packet processing. */
	struct fw_iso_context *context;
124
	struct iso_packets_buffer buffer;
125
	int packet_index;
126 127 128 129

	/* For CIP headers. */
	unsigned int source_node_id_field;
	unsigned int data_block_quadlets;
130
	unsigned int data_block_counter;
131 132 133 134
	/* quirk: fixed interval of dbc between previos/current packets. */
	unsigned int tx_dbc_interval;
	/* quirk: indicate the value of dbc field in a first packet. */
	unsigned int tx_first_dbc;
135

136 137 138 139
	/* Internal flags. */
	enum cip_sfc sfc;
	unsigned int syt_interval;
	unsigned int transfer_delay;
140 141 142 143
	unsigned int data_block_state;
	unsigned int last_syt_offset;
	unsigned int syt_offset_state;

144 145 146
	/* For a PCM substream processing. */
	struct snd_pcm_substream *pcm;
	struct tasklet_struct period_tasklet;
147 148
	unsigned int pcm_buffer_pointer;
	unsigned int pcm_period_pointer;
149
	bool pointer_flush;
150

151 152 153 154 155 156
	/* To wait for first packet. */
	bool callbacked;
	wait_queue_head_t callback_wait;
	struct amdtp_stream *sync_slave;

	/* For AM824 processing. */
157
	struct snd_rawmidi_substream *midi[AMDTP_MAX_CHANNELS_FOR_MIDI * 8];
158 159
	int midi_fifo_limit;
	int midi_fifo_used[AMDTP_MAX_CHANNELS_FOR_MIDI * 8];
160 161
	unsigned int pcm_channels;
	unsigned int midi_ports;
162

163 164 165
	u8 pcm_positions[AMDTP_MAX_CHANNELS_FOR_PCM];
	u8 midi_position;
	bool double_pcm_frames;
166

167 168 169
	void (*transfer_samples)(struct amdtp_stream *s,
				 struct snd_pcm_substream *pcm,
				 __be32 *buffer, unsigned int frames);
170 171
};

172
int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit,
173
		      enum amdtp_stream_direction dir,
174 175
		      enum cip_flags flags);
void amdtp_stream_destroy(struct amdtp_stream *s);
176

177 178 179 180
int amdtp_stream_set_parameters(struct amdtp_stream *s,
				unsigned int rate,
				unsigned int pcm_channels,
				unsigned int midi_ports);
181
unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);
182

183 184 185
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);
186

187 188
int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s,
					struct snd_pcm_runtime *runtime);
189 190 191 192 193
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);
194

195
extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
196
extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT];
197

198 199 200 201 202 203 204
/**
 * 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)
205 206 207 208
{
	return !IS_ERR(s->context);
}

209
/**
210 211
 * amdtp_streaming_error - check for streaming error
 * @s: the AMDTP stream
212 213 214 215
 *
 * If this function returns true, the stream's packet queue has stopped due to
 * an asynchronous error.
 */
216
static inline bool amdtp_streaming_error(struct amdtp_stream *s)
217 218 219 220
{
	return s->packet_index < 0;
}

221 222 223 224 225 226 227 228 229 230 231
/**
 * 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;
}

232
/**
233 234
 * amdtp_stream_pcm_trigger - start/stop playback from a PCM device
 * @s: the AMDTP stream
235 236 237 238 239 240
 * @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.
 */
241 242
static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
					    struct snd_pcm_substream *pcm)
243 244 245 246
{
	ACCESS_ONCE(s->pcm) = pcm;
}

247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
/**
 * 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;
}

265 266 267 268 269
static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
{
	return sfc & 1;
}

270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
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;
}

302
#endif