Commit | Line | Data |
---|---|---|
31ef9134 CL |
1 | /* |
2 | * Audio and Music Data Transmission Protocol (IEC 61883-6) streams | |
3 | * with Common Isochronous Packet (IEC 61883-1) headers | |
4 | * | |
5 | * Copyright (c) Clemens Ladisch <clemens@ladisch.de> | |
6 | * Licensed under the terms of the GNU General Public License, version 2. | |
7 | */ | |
8 | ||
9 | #include <linux/device.h> | |
10 | #include <linux/err.h> | |
11 | #include <linux/firewire.h> | |
12 | #include <linux/module.h> | |
13 | #include <linux/slab.h> | |
14 | #include <sound/pcm.h> | |
7b2d99fa | 15 | #include <sound/pcm_params.h> |
d67c46b9 | 16 | #include "amdtp-stream.h" |
31ef9134 CL |
17 | |
18 | #define TICKS_PER_CYCLE 3072 | |
19 | #define CYCLES_PER_SECOND 8000 | |
20 | #define TICKS_PER_SECOND (TICKS_PER_CYCLE * CYCLES_PER_SECOND) | |
21 | ||
ca5b5050 | 22 | #define TRANSFER_DELAY_TICKS 0x2e00 /* 479.17 microseconds */ |
31ef9134 | 23 | |
b445db44 TS |
24 | /* isochronous header parameters */ |
25 | #define ISO_DATA_LENGTH_SHIFT 16 | |
31ef9134 CL |
26 | #define TAG_CIP 1 |
27 | ||
b445db44 | 28 | /* common isochronous packet header parameters */ |
9a2820c1 TS |
29 | #define CIP_EOH_SHIFT 31 |
30 | #define CIP_EOH (1u << CIP_EOH_SHIFT) | |
b445db44 | 31 | #define CIP_EOH_MASK 0x80000000 |
9a2820c1 TS |
32 | #define CIP_SID_SHIFT 24 |
33 | #define CIP_SID_MASK 0x3f000000 | |
34 | #define CIP_DBS_MASK 0x00ff0000 | |
35 | #define CIP_DBS_SHIFT 16 | |
36 | #define CIP_DBC_MASK 0x000000ff | |
37 | #define CIP_FMT_SHIFT 24 | |
b445db44 | 38 | #define CIP_FMT_MASK 0x3f000000 |
9a2820c1 TS |
39 | #define CIP_FDF_MASK 0x00ff0000 |
40 | #define CIP_FDF_SHIFT 16 | |
b445db44 TS |
41 | #define CIP_SYT_MASK 0x0000ffff |
42 | #define CIP_SYT_NO_INFO 0xffff | |
b445db44 | 43 | |
51c29fd2 | 44 | /* Audio and Music transfer protocol specific parameters */ |
414ba022 | 45 | #define CIP_FMT_AM 0x10 |
2b3fc456 | 46 | #define AMDTP_FDF_NO_DATA 0xff |
31ef9134 CL |
47 | |
48 | /* TODO: make these configurable */ | |
49 | #define INTERRUPT_INTERVAL 16 | |
50 | #define QUEUE_LENGTH 48 | |
51 | ||
2b3fc456 | 52 | #define IN_PACKET_HEADER_SIZE 4 |
4b7da117 TS |
53 | #define OUT_PACKET_HEADER_SIZE 0 |
54 | ||
76fb8789 CL |
55 | static void pcm_period_tasklet(unsigned long data); |
56 | ||
31ef9134 | 57 | /** |
be4a2894 TS |
58 | * amdtp_stream_init - initialize an AMDTP stream structure |
59 | * @s: the AMDTP stream to initialize | |
31ef9134 | 60 | * @unit: the target of the stream |
3ff7e8f0 | 61 | * @dir: the direction of stream |
31ef9134 | 62 | * @flags: the packet transmission method to use |
5955815e | 63 | * @fmt: the value of fmt field in CIP header |
df075fee TS |
64 | * @process_data_blocks: callback handler to process data blocks |
65 | * @protocol_size: the size to allocate newly for protocol | |
31ef9134 | 66 | */ |
be4a2894 | 67 | int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit, |
5955815e | 68 | enum amdtp_stream_direction dir, enum cip_flags flags, |
df075fee TS |
69 | unsigned int fmt, |
70 | amdtp_stream_process_data_blocks_t process_data_blocks, | |
71 | unsigned int protocol_size) | |
31ef9134 | 72 | { |
df075fee TS |
73 | if (process_data_blocks == NULL) |
74 | return -EINVAL; | |
75 | ||
76 | s->protocol = kzalloc(protocol_size, GFP_KERNEL); | |
77 | if (!s->protocol) | |
78 | return -ENOMEM; | |
79 | ||
c6f224dc | 80 | s->unit = unit; |
3ff7e8f0 | 81 | s->direction = dir; |
31ef9134 CL |
82 | s->flags = flags; |
83 | s->context = ERR_PTR(-1); | |
84 | mutex_init(&s->mutex); | |
76fb8789 | 85 | tasklet_init(&s->period_tasklet, pcm_period_tasklet, (unsigned long)s); |
ec00f5e4 | 86 | s->packet_index = 0; |
31ef9134 | 87 | |
7b3b0d85 TS |
88 | init_waitqueue_head(&s->callback_wait); |
89 | s->callbacked = false; | |
90 | s->sync_slave = NULL; | |
91 | ||
5955815e | 92 | s->fmt = fmt; |
df075fee | 93 | s->process_data_blocks = process_data_blocks; |
414ba022 | 94 | |
31ef9134 CL |
95 | return 0; |
96 | } | |
be4a2894 | 97 | EXPORT_SYMBOL(amdtp_stream_init); |
31ef9134 CL |
98 | |
99 | /** | |
be4a2894 TS |
100 | * amdtp_stream_destroy - free stream resources |
101 | * @s: the AMDTP stream to destroy | |
31ef9134 | 102 | */ |
be4a2894 | 103 | void amdtp_stream_destroy(struct amdtp_stream *s) |
31ef9134 | 104 | { |
be4a2894 | 105 | WARN_ON(amdtp_stream_running(s)); |
df075fee | 106 | kfree(s->protocol); |
31ef9134 | 107 | mutex_destroy(&s->mutex); |
31ef9134 | 108 | } |
be4a2894 | 109 | EXPORT_SYMBOL(amdtp_stream_destroy); |
31ef9134 | 110 | |
c5280e99 | 111 | const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT] = { |
a7304e3b CL |
112 | [CIP_SFC_32000] = 8, |
113 | [CIP_SFC_44100] = 8, | |
114 | [CIP_SFC_48000] = 8, | |
115 | [CIP_SFC_88200] = 16, | |
116 | [CIP_SFC_96000] = 16, | |
117 | [CIP_SFC_176400] = 32, | |
118 | [CIP_SFC_192000] = 32, | |
119 | }; | |
120 | EXPORT_SYMBOL(amdtp_syt_intervals); | |
121 | ||
f9503a68 | 122 | const unsigned int amdtp_rate_table[CIP_SFC_COUNT] = { |
1017abed TS |
123 | [CIP_SFC_32000] = 32000, |
124 | [CIP_SFC_44100] = 44100, | |
125 | [CIP_SFC_48000] = 48000, | |
126 | [CIP_SFC_88200] = 88200, | |
127 | [CIP_SFC_96000] = 96000, | |
128 | [CIP_SFC_176400] = 176400, | |
129 | [CIP_SFC_192000] = 192000, | |
130 | }; | |
131 | EXPORT_SYMBOL(amdtp_rate_table); | |
132 | ||
7b2d99fa TS |
133 | /** |
134 | * amdtp_stream_add_pcm_hw_constraints - add hw constraints for PCM substream | |
135 | * @s: the AMDTP stream, which must be initialized. | |
136 | * @runtime: the PCM substream runtime | |
137 | */ | |
138 | int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s, | |
139 | struct snd_pcm_runtime *runtime) | |
140 | { | |
141 | int err; | |
142 | ||
7b2d99fa TS |
143 | /* |
144 | * Currently firewire-lib processes 16 packets in one software | |
145 | * interrupt callback. This equals to 2msec but actually the | |
146 | * interval of the interrupts has a jitter. | |
147 | * Additionally, even if adding a constraint to fit period size to | |
148 | * 2msec, actual calculated frames per period doesn't equal to 2msec, | |
149 | * depending on sampling rate. | |
150 | * Anyway, the interval to call snd_pcm_period_elapsed() cannot 2msec. | |
151 | * Here let us use 5msec for safe period interrupt. | |
152 | */ | |
153 | err = snd_pcm_hw_constraint_minmax(runtime, | |
154 | SNDRV_PCM_HW_PARAM_PERIOD_TIME, | |
155 | 5000, UINT_MAX); | |
156 | if (err < 0) | |
157 | goto end; | |
158 | ||
159 | /* Non-Blocking stream has no more constraints */ | |
160 | if (!(s->flags & CIP_BLOCKING)) | |
161 | goto end; | |
162 | ||
163 | /* | |
164 | * One AMDTP packet can include some frames. In blocking mode, the | |
165 | * number equals to SYT_INTERVAL. So the number is 8, 16 or 32, | |
166 | * depending on its sampling rate. For accurate period interrupt, it's | |
ce991981 | 167 | * preferrable to align period/buffer sizes to current SYT_INTERVAL. |
7b2d99fa | 168 | * |
ce991981 YG |
169 | * TODO: These constraints can be improved with proper rules. |
170 | * Currently apply LCM of SYT_INTERVALs. | |
7b2d99fa TS |
171 | */ |
172 | err = snd_pcm_hw_constraint_step(runtime, 0, | |
173 | SNDRV_PCM_HW_PARAM_PERIOD_SIZE, 32); | |
174 | if (err < 0) | |
175 | goto end; | |
176 | err = snd_pcm_hw_constraint_step(runtime, 0, | |
177 | SNDRV_PCM_HW_PARAM_BUFFER_SIZE, 32); | |
178 | end: | |
179 | return err; | |
180 | } | |
181 | EXPORT_SYMBOL(amdtp_stream_add_pcm_hw_constraints); | |
182 | ||
31ef9134 | 183 | /** |
be4a2894 TS |
184 | * amdtp_stream_set_parameters - set stream parameters |
185 | * @s: the AMDTP stream to configure | |
31ef9134 | 186 | * @rate: the sample rate |
df075fee | 187 | * @data_block_quadlets: the size of a data block in quadlet unit |
31ef9134 | 188 | * |
a7304e3b | 189 | * The parameters must be set before the stream is started, and must not be |
31ef9134 CL |
190 | * changed while the stream is running. |
191 | */ | |
df075fee TS |
192 | int amdtp_stream_set_parameters(struct amdtp_stream *s, unsigned int rate, |
193 | unsigned int data_block_quadlets) | |
31ef9134 | 194 | { |
df075fee | 195 | unsigned int sfc; |
31ef9134 | 196 | |
547e631c | 197 | for (sfc = 0; sfc < ARRAY_SIZE(amdtp_rate_table); ++sfc) { |
1017abed | 198 | if (amdtp_rate_table[sfc] == rate) |
547e631c TS |
199 | break; |
200 | } | |
201 | if (sfc == ARRAY_SIZE(amdtp_rate_table)) | |
202 | return -EINVAL; | |
e84d15f6 | 203 | |
e84d15f6 | 204 | s->sfc = sfc; |
df075fee | 205 | s->data_block_quadlets = data_block_quadlets; |
a7304e3b | 206 | s->syt_interval = amdtp_syt_intervals[sfc]; |
e84d15f6 CL |
207 | |
208 | /* default buffering in the device */ | |
209 | s->transfer_delay = TRANSFER_DELAY_TICKS - TICKS_PER_CYCLE; | |
210 | if (s->flags & CIP_BLOCKING) | |
211 | /* additional buffering needed to adjust for no-data packets */ | |
212 | s->transfer_delay += TICKS_PER_SECOND * s->syt_interval / rate; | |
77d2a8a4 | 213 | |
547e631c | 214 | return 0; |
31ef9134 | 215 | } |
be4a2894 | 216 | EXPORT_SYMBOL(amdtp_stream_set_parameters); |
31ef9134 CL |
217 | |
218 | /** | |
be4a2894 TS |
219 | * amdtp_stream_get_max_payload - get the stream's packet size |
220 | * @s: the AMDTP stream | |
31ef9134 CL |
221 | * |
222 | * This function must not be called before the stream has been configured | |
be4a2894 | 223 | * with amdtp_stream_set_parameters(). |
31ef9134 | 224 | */ |
be4a2894 | 225 | unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s) |
31ef9134 | 226 | { |
a2064710 TS |
227 | unsigned int multiplier = 1; |
228 | ||
229 | if (s->flags & CIP_JUMBO_PAYLOAD) | |
230 | multiplier = 5; | |
231 | ||
232 | return 8 + s->syt_interval * s->data_block_quadlets * 4 * multiplier; | |
31ef9134 | 233 | } |
be4a2894 | 234 | EXPORT_SYMBOL(amdtp_stream_get_max_payload); |
31ef9134 | 235 | |
76fb8789 | 236 | /** |
be4a2894 TS |
237 | * amdtp_stream_pcm_prepare - prepare PCM device for running |
238 | * @s: the AMDTP stream | |
76fb8789 CL |
239 | * |
240 | * This function should be called from the PCM device's .prepare callback. | |
241 | */ | |
be4a2894 | 242 | void amdtp_stream_pcm_prepare(struct amdtp_stream *s) |
76fb8789 CL |
243 | { |
244 | tasklet_kill(&s->period_tasklet); | |
245 | s->pcm_buffer_pointer = 0; | |
246 | s->pcm_period_pointer = 0; | |
92b862c7 | 247 | s->pointer_flush = true; |
76fb8789 | 248 | } |
be4a2894 | 249 | EXPORT_SYMBOL(amdtp_stream_pcm_prepare); |
76fb8789 | 250 | |
875be091 TS |
251 | static unsigned int calculate_data_blocks(struct amdtp_stream *s, |
252 | unsigned int syt) | |
31ef9134 CL |
253 | { |
254 | unsigned int phase, data_blocks; | |
255 | ||
875be091 TS |
256 | /* Blocking mode. */ |
257 | if (s->flags & CIP_BLOCKING) { | |
258 | /* This module generate empty packet for 'no data'. */ | |
259 | if (syt == CIP_SYT_NO_INFO) | |
260 | data_blocks = 0; | |
261 | else | |
262 | data_blocks = s->syt_interval; | |
263 | /* Non-blocking mode. */ | |
31ef9134 | 264 | } else { |
875be091 TS |
265 | if (!cip_sfc_is_base_44100(s->sfc)) { |
266 | /* Sample_rate / 8000 is an integer, and precomputed. */ | |
267 | data_blocks = s->data_block_state; | |
268 | } else { | |
269 | phase = s->data_block_state; | |
31ef9134 CL |
270 | |
271 | /* | |
272 | * This calculates the number of data blocks per packet so that | |
273 | * 1) the overall rate is correct and exactly synchronized to | |
274 | * the bus clock, and | |
275 | * 2) packets with a rounded-up number of blocks occur as early | |
276 | * as possible in the sequence (to prevent underruns of the | |
277 | * device's buffer). | |
278 | */ | |
875be091 TS |
279 | if (s->sfc == CIP_SFC_44100) |
280 | /* 6 6 5 6 5 6 5 ... */ | |
281 | data_blocks = 5 + ((phase & 1) ^ | |
282 | (phase == 0 || phase >= 40)); | |
283 | else | |
284 | /* 12 11 11 11 11 ... or 23 22 22 22 22 ... */ | |
285 | data_blocks = 11 * (s->sfc >> 1) + (phase == 0); | |
286 | if (++phase >= (80 >> (s->sfc >> 1))) | |
287 | phase = 0; | |
288 | s->data_block_state = phase; | |
289 | } | |
31ef9134 CL |
290 | } |
291 | ||
292 | return data_blocks; | |
293 | } | |
294 | ||
be4a2894 | 295 | static unsigned int calculate_syt(struct amdtp_stream *s, |
31ef9134 CL |
296 | unsigned int cycle) |
297 | { | |
298 | unsigned int syt_offset, phase, index, syt; | |
299 | ||
300 | if (s->last_syt_offset < TICKS_PER_CYCLE) { | |
301 | if (!cip_sfc_is_base_44100(s->sfc)) | |
302 | syt_offset = s->last_syt_offset + s->syt_offset_state; | |
303 | else { | |
304 | /* | |
305 | * The time, in ticks, of the n'th SYT_INTERVAL sample is: | |
306 | * n * SYT_INTERVAL * 24576000 / sample_rate | |
307 | * Modulo TICKS_PER_CYCLE, the difference between successive | |
308 | * elements is about 1386.23. Rounding the results of this | |
309 | * formula to the SYT precision results in a sequence of | |
310 | * differences that begins with: | |
311 | * 1386 1386 1387 1386 1386 1386 1387 1386 1386 1386 1387 ... | |
312 | * This code generates _exactly_ the same sequence. | |
313 | */ | |
314 | phase = s->syt_offset_state; | |
315 | index = phase % 13; | |
316 | syt_offset = s->last_syt_offset; | |
317 | syt_offset += 1386 + ((index && !(index & 3)) || | |
318 | phase == 146); | |
319 | if (++phase >= 147) | |
320 | phase = 0; | |
321 | s->syt_offset_state = phase; | |
322 | } | |
323 | } else | |
324 | syt_offset = s->last_syt_offset - TICKS_PER_CYCLE; | |
325 | s->last_syt_offset = syt_offset; | |
326 | ||
be454366 | 327 | if (syt_offset < TICKS_PER_CYCLE) { |
e84d15f6 | 328 | syt_offset += s->transfer_delay; |
be454366 CL |
329 | syt = (cycle + syt_offset / TICKS_PER_CYCLE) << 12; |
330 | syt += syt_offset % TICKS_PER_CYCLE; | |
31ef9134 | 331 | |
b445db44 | 332 | return syt & CIP_SYT_MASK; |
be454366 | 333 | } else { |
b445db44 | 334 | return CIP_SYT_NO_INFO; |
be454366 | 335 | } |
31ef9134 CL |
336 | } |
337 | ||
4b7da117 TS |
338 | static void update_pcm_pointers(struct amdtp_stream *s, |
339 | struct snd_pcm_substream *pcm, | |
340 | unsigned int frames) | |
65845f29 TS |
341 | { |
342 | unsigned int ptr; | |
343 | ||
4b7da117 TS |
344 | ptr = s->pcm_buffer_pointer + frames; |
345 | if (ptr >= pcm->runtime->buffer_size) | |
346 | ptr -= pcm->runtime->buffer_size; | |
347 | ACCESS_ONCE(s->pcm_buffer_pointer) = ptr; | |
348 | ||
349 | s->pcm_period_pointer += frames; | |
350 | if (s->pcm_period_pointer >= pcm->runtime->period_size) { | |
351 | s->pcm_period_pointer -= pcm->runtime->period_size; | |
352 | s->pointer_flush = false; | |
353 | tasklet_hi_schedule(&s->period_tasklet); | |
354 | } | |
355 | } | |
356 | ||
357 | static void pcm_period_tasklet(unsigned long data) | |
358 | { | |
359 | struct amdtp_stream *s = (void *)data; | |
360 | struct snd_pcm_substream *pcm = ACCESS_ONCE(s->pcm); | |
361 | ||
362 | if (pcm) | |
363 | snd_pcm_period_elapsed(pcm); | |
364 | } | |
365 | ||
366 | static int queue_packet(struct amdtp_stream *s, | |
367 | unsigned int header_length, | |
368 | unsigned int payload_length, bool skip) | |
369 | { | |
370 | struct fw_iso_packet p = {0}; | |
7b3b0d85 TS |
371 | int err = 0; |
372 | ||
373 | if (IS_ERR(s->context)) | |
374 | goto end; | |
4b7da117 TS |
375 | |
376 | p.interrupt = IS_ALIGNED(s->packet_index + 1, INTERRUPT_INTERVAL); | |
377 | p.tag = TAG_CIP; | |
378 | p.header_length = header_length; | |
379 | p.payload_length = (!skip) ? payload_length : 0; | |
380 | p.skip = skip; | |
381 | err = fw_iso_context_queue(s->context, &p, &s->buffer.iso_buffer, | |
382 | s->buffer.packets[s->packet_index].offset); | |
383 | if (err < 0) { | |
384 | dev_err(&s->unit->device, "queueing error: %d\n", err); | |
385 | goto end; | |
386 | } | |
387 | ||
388 | if (++s->packet_index >= QUEUE_LENGTH) | |
389 | s->packet_index = 0; | |
390 | end: | |
391 | return err; | |
392 | } | |
393 | ||
394 | static inline int queue_out_packet(struct amdtp_stream *s, | |
395 | unsigned int payload_length, bool skip) | |
396 | { | |
397 | return queue_packet(s, OUT_PACKET_HEADER_SIZE, | |
398 | payload_length, skip); | |
399 | } | |
400 | ||
2b3fc456 TS |
401 | static inline int queue_in_packet(struct amdtp_stream *s) |
402 | { | |
403 | return queue_packet(s, IN_PACKET_HEADER_SIZE, | |
404 | amdtp_stream_get_max_payload(s), false); | |
405 | } | |
406 | ||
a4103bd7 TS |
407 | static int handle_out_packet(struct amdtp_stream *s, unsigned int data_blocks, |
408 | unsigned int syt) | |
31ef9134 CL |
409 | { |
410 | __be32 *buffer; | |
6fc6b9ce | 411 | unsigned int payload_length; |
20e44577 | 412 | unsigned int pcm_frames; |
31ef9134 | 413 | struct snd_pcm_substream *pcm; |
31ef9134 | 414 | |
ccccad86 | 415 | buffer = s->buffer.packets[s->packet_index].buffer; |
df075fee | 416 | pcm_frames = s->process_data_blocks(s, buffer + 2, data_blocks, &syt); |
20e44577 | 417 | |
31ef9134 | 418 | buffer[0] = cpu_to_be32(ACCESS_ONCE(s->source_node_id_field) | |
9a2820c1 | 419 | (s->data_block_quadlets << CIP_DBS_SHIFT) | |
31ef9134 | 420 | s->data_block_counter); |
414ba022 TS |
421 | buffer[1] = cpu_to_be32(CIP_EOH | |
422 | ((s->fmt << CIP_FMT_SHIFT) & CIP_FMT_MASK) | | |
423 | ((s->fdf << CIP_FDF_SHIFT) & CIP_FDF_MASK) | | |
424 | (syt & CIP_SYT_MASK)); | |
31ef9134 CL |
425 | |
426 | s->data_block_counter = (s->data_block_counter + data_blocks) & 0xff; | |
427 | ||
4b7da117 | 428 | payload_length = 8 + data_blocks * 4 * s->data_block_quadlets; |
a4103bd7 TS |
429 | if (queue_out_packet(s, payload_length, false) < 0) |
430 | return -EIO; | |
31ef9134 | 431 | |
20e44577 TS |
432 | pcm = ACCESS_ONCE(s->pcm); |
433 | if (pcm && pcm_frames > 0) | |
434 | update_pcm_pointers(s, pcm, pcm_frames); | |
a4103bd7 TS |
435 | |
436 | /* No need to return the number of handled data blocks. */ | |
437 | return 0; | |
76fb8789 CL |
438 | } |
439 | ||
6fc6b9ce | 440 | static int handle_in_packet(struct amdtp_stream *s, |
31ea49ba | 441 | unsigned int payload_quadlets, __be32 *buffer, |
20e44577 | 442 | unsigned int *data_blocks, unsigned int syt) |
2b3fc456 TS |
443 | { |
444 | u32 cip_header[2]; | |
414ba022 | 445 | unsigned int fmt, fdf; |
6fc6b9ce | 446 | unsigned int data_block_quadlets, data_block_counter, dbc_interval; |
20e44577 TS |
447 | struct snd_pcm_substream *pcm; |
448 | unsigned int pcm_frames; | |
c8bdf49b | 449 | bool lost; |
2b3fc456 TS |
450 | |
451 | cip_header[0] = be32_to_cpu(buffer[0]); | |
452 | cip_header[1] = be32_to_cpu(buffer[1]); | |
453 | ||
454 | /* | |
455 | * This module supports 'Two-quadlet CIP header with SYT field'. | |
77d2a8a4 | 456 | * For convenience, also check FMT field is AM824 or not. |
2b3fc456 TS |
457 | */ |
458 | if (((cip_header[0] & CIP_EOH_MASK) == CIP_EOH) || | |
414ba022 | 459 | ((cip_header[1] & CIP_EOH_MASK) != CIP_EOH)) { |
2b3fc456 TS |
460 | dev_info_ratelimited(&s->unit->device, |
461 | "Invalid CIP header for AMDTP: %08X:%08X\n", | |
462 | cip_header[0], cip_header[1]); | |
31ea49ba | 463 | *data_blocks = 0; |
20e44577 | 464 | pcm_frames = 0; |
2b3fc456 TS |
465 | goto end; |
466 | } | |
467 | ||
414ba022 TS |
468 | /* Check valid protocol or not. */ |
469 | fmt = (cip_header[1] & CIP_FMT_MASK) >> CIP_FMT_SHIFT; | |
470 | if (fmt != s->fmt) { | |
2a7e1713 TS |
471 | dev_info_ratelimited(&s->unit->device, |
472 | "Detect unexpected protocol: %08x %08x\n", | |
473 | cip_header[0], cip_header[1]); | |
474 | *data_blocks = 0; | |
475 | pcm_frames = 0; | |
476 | goto end; | |
414ba022 TS |
477 | } |
478 | ||
2b3fc456 | 479 | /* Calculate data blocks */ |
414ba022 | 480 | fdf = (cip_header[1] & CIP_FDF_MASK) >> CIP_FDF_SHIFT; |
2b3fc456 | 481 | if (payload_quadlets < 3 || |
414ba022 | 482 | (fmt == CIP_FMT_AM && fdf == AMDTP_FDF_NO_DATA)) { |
31ea49ba | 483 | *data_blocks = 0; |
2b3fc456 TS |
484 | } else { |
485 | data_block_quadlets = | |
9a2820c1 | 486 | (cip_header[0] & CIP_DBS_MASK) >> CIP_DBS_SHIFT; |
2b3fc456 TS |
487 | /* avoid division by zero */ |
488 | if (data_block_quadlets == 0) { | |
12e0f438 | 489 | dev_err(&s->unit->device, |
2b3fc456 TS |
490 | "Detect invalid value in dbs field: %08X\n", |
491 | cip_header[0]); | |
a9007054 | 492 | return -EPROTO; |
2b3fc456 | 493 | } |
69702239 TS |
494 | if (s->flags & CIP_WRONG_DBS) |
495 | data_block_quadlets = s->data_block_quadlets; | |
2b3fc456 | 496 | |
31ea49ba | 497 | *data_blocks = (payload_quadlets - 2) / data_block_quadlets; |
2b3fc456 TS |
498 | } |
499 | ||
500 | /* Check data block counter continuity */ | |
9a2820c1 | 501 | data_block_counter = cip_header[0] & CIP_DBC_MASK; |
31ea49ba | 502 | if (*data_blocks == 0 && (s->flags & CIP_EMPTY_HAS_WRONG_DBC) && |
9d59124c TS |
503 | s->data_block_counter != UINT_MAX) |
504 | data_block_counter = s->data_block_counter; | |
505 | ||
18f5ed36 TS |
506 | if (((s->flags & CIP_SKIP_DBC_ZERO_CHECK) && |
507 | data_block_counter == s->tx_first_dbc) || | |
508 | s->data_block_counter == UINT_MAX) { | |
b84b1a27 TS |
509 | lost = false; |
510 | } else if (!(s->flags & CIP_DBC_IS_END_EVENT)) { | |
c8bdf49b | 511 | lost = data_block_counter != s->data_block_counter; |
d9cd0065 | 512 | } else { |
31ea49ba | 513 | if ((*data_blocks > 0) && (s->tx_dbc_interval > 0)) |
d9cd0065 TS |
514 | dbc_interval = s->tx_dbc_interval; |
515 | else | |
31ea49ba | 516 | dbc_interval = *data_blocks; |
d9cd0065 | 517 | |
c8bdf49b | 518 | lost = data_block_counter != |
d9cd0065 TS |
519 | ((s->data_block_counter + dbc_interval) & 0xff); |
520 | } | |
c8bdf49b TS |
521 | |
522 | if (lost) { | |
12e0f438 TS |
523 | dev_err(&s->unit->device, |
524 | "Detect discontinuity of CIP: %02X %02X\n", | |
525 | s->data_block_counter, data_block_counter); | |
6fc6b9ce | 526 | return -EIO; |
2b3fc456 TS |
527 | } |
528 | ||
df075fee | 529 | pcm_frames = s->process_data_blocks(s, buffer + 2, *data_blocks, &syt); |
2b3fc456 | 530 | |
c8bdf49b TS |
531 | if (s->flags & CIP_DBC_IS_END_EVENT) |
532 | s->data_block_counter = data_block_counter; | |
533 | else | |
534 | s->data_block_counter = | |
31ea49ba | 535 | (data_block_counter + *data_blocks) & 0xff; |
2b3fc456 TS |
536 | end: |
537 | if (queue_in_packet(s) < 0) | |
6fc6b9ce | 538 | return -EIO; |
2b3fc456 | 539 | |
20e44577 TS |
540 | pcm = ACCESS_ONCE(s->pcm); |
541 | if (pcm && pcm_frames > 0) | |
542 | update_pcm_pointers(s, pcm, pcm_frames); | |
2b3fc456 | 543 | |
31ea49ba | 544 | return 0; |
2b3fc456 TS |
545 | } |
546 | ||
4b7da117 TS |
547 | static void out_stream_callback(struct fw_iso_context *context, u32 cycle, |
548 | size_t header_length, void *header, | |
549 | void *private_data) | |
31ef9134 | 550 | { |
be4a2894 | 551 | struct amdtp_stream *s = private_data; |
ccccad86 | 552 | unsigned int i, syt, packets = header_length / 4; |
6fc6b9ce | 553 | unsigned int data_blocks; |
31ef9134 | 554 | |
a4103bd7 TS |
555 | if (s->packet_index < 0) |
556 | return; | |
557 | ||
31ef9134 CL |
558 | /* |
559 | * Compute the cycle of the last queued packet. | |
560 | * (We need only the four lowest bits for the SYT, so we can ignore | |
561 | * that bits 0-11 must wrap around at 3072.) | |
562 | */ | |
563 | cycle += QUEUE_LENGTH - packets; | |
564 | ||
ccccad86 TS |
565 | for (i = 0; i < packets; ++i) { |
566 | syt = calculate_syt(s, ++cycle); | |
6fc6b9ce TS |
567 | data_blocks = calculate_data_blocks(s, syt); |
568 | ||
a4103bd7 TS |
569 | if (handle_out_packet(s, data_blocks, syt) < 0) { |
570 | s->packet_index = -1; | |
571 | amdtp_stream_pcm_abort(s); | |
572 | return; | |
573 | } | |
ccccad86 | 574 | } |
a4103bd7 | 575 | |
13882a82 | 576 | fw_iso_context_queue_flush(s->context); |
31ef9134 CL |
577 | } |
578 | ||
2b3fc456 TS |
579 | static void in_stream_callback(struct fw_iso_context *context, u32 cycle, |
580 | size_t header_length, void *header, | |
581 | void *private_data) | |
582 | { | |
583 | struct amdtp_stream *s = private_data; | |
a2064710 TS |
584 | unsigned int p, syt, packets; |
585 | unsigned int payload_quadlets, max_payload_quadlets; | |
6fc6b9ce | 586 | unsigned int data_blocks; |
2b3fc456 TS |
587 | __be32 *buffer, *headers = header; |
588 | ||
a4103bd7 TS |
589 | if (s->packet_index < 0) |
590 | return; | |
591 | ||
2b3fc456 TS |
592 | /* The number of packets in buffer */ |
593 | packets = header_length / IN_PACKET_HEADER_SIZE; | |
594 | ||
a2064710 TS |
595 | /* For buffer-over-run prevention. */ |
596 | max_payload_quadlets = amdtp_stream_get_max_payload(s) / 4; | |
597 | ||
2b3fc456 | 598 | for (p = 0; p < packets; p++) { |
2b3fc456 TS |
599 | buffer = s->buffer.packets[s->packet_index].buffer; |
600 | ||
601 | /* The number of quadlets in this packet */ | |
602 | payload_quadlets = | |
603 | (be32_to_cpu(headers[p]) >> ISO_DATA_LENGTH_SHIFT) / 4; | |
a2064710 TS |
604 | if (payload_quadlets > max_payload_quadlets) { |
605 | dev_err(&s->unit->device, | |
606 | "Detect jumbo payload: %02x %02x\n", | |
607 | payload_quadlets, max_payload_quadlets); | |
608 | s->packet_index = -1; | |
609 | break; | |
610 | } | |
611 | ||
20e44577 | 612 | syt = be32_to_cpu(buffer[1]) & CIP_SYT_MASK; |
31ea49ba | 613 | if (handle_in_packet(s, payload_quadlets, buffer, |
20e44577 | 614 | &data_blocks, syt) < 0) { |
6fc6b9ce TS |
615 | s->packet_index = -1; |
616 | break; | |
617 | } | |
618 | ||
619 | /* Process sync slave stream */ | |
620 | if (s->sync_slave && s->sync_slave->callbacked) { | |
a4103bd7 TS |
621 | if (handle_out_packet(s->sync_slave, |
622 | data_blocks, syt) < 0) { | |
623 | s->packet_index = -1; | |
624 | break; | |
625 | } | |
6fc6b9ce | 626 | } |
2b3fc456 TS |
627 | } |
628 | ||
7b3b0d85 TS |
629 | /* Queueing error or detecting discontinuity */ |
630 | if (s->packet_index < 0) { | |
6fc6b9ce TS |
631 | amdtp_stream_pcm_abort(s); |
632 | ||
7b3b0d85 TS |
633 | /* Abort sync slave. */ |
634 | if (s->sync_slave) { | |
635 | s->sync_slave->packet_index = -1; | |
636 | amdtp_stream_pcm_abort(s->sync_slave); | |
637 | } | |
638 | return; | |
639 | } | |
640 | ||
641 | /* when sync to device, flush the packets for slave stream */ | |
642 | if (s->sync_slave && s->sync_slave->callbacked) | |
643 | fw_iso_context_queue_flush(s->sync_slave->context); | |
644 | ||
2b3fc456 TS |
645 | fw_iso_context_queue_flush(s->context); |
646 | } | |
647 | ||
7b3b0d85 TS |
648 | /* processing is done by master callback */ |
649 | static void slave_stream_callback(struct fw_iso_context *context, u32 cycle, | |
650 | size_t header_length, void *header, | |
651 | void *private_data) | |
652 | { | |
653 | return; | |
654 | } | |
655 | ||
656 | /* this is executed one time */ | |
657 | static void amdtp_stream_first_callback(struct fw_iso_context *context, | |
658 | u32 cycle, size_t header_length, | |
659 | void *header, void *private_data) | |
660 | { | |
661 | struct amdtp_stream *s = private_data; | |
662 | ||
663 | /* | |
664 | * For in-stream, first packet has come. | |
665 | * For out-stream, prepared to transmit first packet | |
666 | */ | |
667 | s->callbacked = true; | |
668 | wake_up(&s->callback_wait); | |
669 | ||
670 | if (s->direction == AMDTP_IN_STREAM) | |
671 | context->callback.sc = in_stream_callback; | |
727d3a0b | 672 | else if (s->flags & CIP_SYNC_TO_DEVICE) |
7b3b0d85 TS |
673 | context->callback.sc = slave_stream_callback; |
674 | else | |
675 | context->callback.sc = out_stream_callback; | |
676 | ||
677 | context->callback.sc(context, cycle, header_length, header, s); | |
678 | } | |
679 | ||
31ef9134 | 680 | /** |
be4a2894 TS |
681 | * amdtp_stream_start - start transferring packets |
682 | * @s: the AMDTP stream to start | |
31ef9134 CL |
683 | * @channel: the isochronous channel on the bus |
684 | * @speed: firewire speed code | |
685 | * | |
686 | * The stream cannot be started until it has been configured with | |
be4a2894 TS |
687 | * amdtp_stream_set_parameters() and it must be started before any PCM or MIDI |
688 | * device can be started. | |
31ef9134 | 689 | */ |
be4a2894 | 690 | int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed) |
31ef9134 CL |
691 | { |
692 | static const struct { | |
693 | unsigned int data_block; | |
694 | unsigned int syt_offset; | |
695 | } initial_state[] = { | |
696 | [CIP_SFC_32000] = { 4, 3072 }, | |
697 | [CIP_SFC_48000] = { 6, 1024 }, | |
698 | [CIP_SFC_96000] = { 12, 1024 }, | |
699 | [CIP_SFC_192000] = { 24, 1024 }, | |
700 | [CIP_SFC_44100] = { 0, 67 }, | |
701 | [CIP_SFC_88200] = { 0, 67 }, | |
702 | [CIP_SFC_176400] = { 0, 67 }, | |
703 | }; | |
2b3fc456 TS |
704 | unsigned int header_size; |
705 | enum dma_data_direction dir; | |
7ab56645 | 706 | int type, tag, err; |
31ef9134 CL |
707 | |
708 | mutex_lock(&s->mutex); | |
709 | ||
be4a2894 | 710 | if (WARN_ON(amdtp_stream_running(s) || |
4b7da117 | 711 | (s->data_block_quadlets < 1))) { |
31ef9134 CL |
712 | err = -EBADFD; |
713 | goto err_unlock; | |
714 | } | |
715 | ||
b6bc8123 TS |
716 | if (s->direction == AMDTP_IN_STREAM && |
717 | s->flags & CIP_SKIP_INIT_DBC_CHECK) | |
718 | s->data_block_counter = UINT_MAX; | |
719 | else | |
720 | s->data_block_counter = 0; | |
31ef9134 CL |
721 | s->data_block_state = initial_state[s->sfc].data_block; |
722 | s->syt_offset_state = initial_state[s->sfc].syt_offset; | |
723 | s->last_syt_offset = TICKS_PER_CYCLE; | |
724 | ||
2b3fc456 TS |
725 | /* initialize packet buffer */ |
726 | if (s->direction == AMDTP_IN_STREAM) { | |
727 | dir = DMA_FROM_DEVICE; | |
728 | type = FW_ISO_CONTEXT_RECEIVE; | |
729 | header_size = IN_PACKET_HEADER_SIZE; | |
2b3fc456 TS |
730 | } else { |
731 | dir = DMA_TO_DEVICE; | |
732 | type = FW_ISO_CONTEXT_TRANSMIT; | |
733 | header_size = OUT_PACKET_HEADER_SIZE; | |
2b3fc456 | 734 | } |
31ef9134 | 735 | err = iso_packets_buffer_init(&s->buffer, s->unit, QUEUE_LENGTH, |
2b3fc456 | 736 | amdtp_stream_get_max_payload(s), dir); |
31ef9134 CL |
737 | if (err < 0) |
738 | goto err_unlock; | |
739 | ||
740 | s->context = fw_iso_context_create(fw_parent_device(s->unit)->card, | |
2b3fc456 | 741 | type, channel, speed, header_size, |
7b3b0d85 | 742 | amdtp_stream_first_callback, s); |
31ef9134 CL |
743 | if (IS_ERR(s->context)) { |
744 | err = PTR_ERR(s->context); | |
745 | if (err == -EBUSY) | |
746 | dev_err(&s->unit->device, | |
be4a2894 | 747 | "no free stream on this controller\n"); |
31ef9134 CL |
748 | goto err_buffer; |
749 | } | |
750 | ||
be4a2894 | 751 | amdtp_stream_update(s); |
31ef9134 | 752 | |
ec00f5e4 | 753 | s->packet_index = 0; |
4b7da117 | 754 | do { |
2b3fc456 TS |
755 | if (s->direction == AMDTP_IN_STREAM) |
756 | err = queue_in_packet(s); | |
757 | else | |
758 | err = queue_out_packet(s, 0, true); | |
4b7da117 TS |
759 | if (err < 0) |
760 | goto err_context; | |
761 | } while (s->packet_index > 0); | |
31ef9134 | 762 | |
2b3fc456 | 763 | /* NOTE: TAG1 matches CIP. This just affects in stream. */ |
7ab56645 TS |
764 | tag = FW_ISO_CONTEXT_MATCH_TAG1; |
765 | if (s->flags & CIP_EMPTY_WITH_TAG0) | |
766 | tag |= FW_ISO_CONTEXT_MATCH_TAG0; | |
767 | ||
7b3b0d85 | 768 | s->callbacked = false; |
7ab56645 | 769 | err = fw_iso_context_start(s->context, -1, 0, tag); |
31ef9134 CL |
770 | if (err < 0) |
771 | goto err_context; | |
772 | ||
773 | mutex_unlock(&s->mutex); | |
774 | ||
775 | return 0; | |
776 | ||
777 | err_context: | |
778 | fw_iso_context_destroy(s->context); | |
779 | s->context = ERR_PTR(-1); | |
780 | err_buffer: | |
781 | iso_packets_buffer_destroy(&s->buffer, s->unit); | |
782 | err_unlock: | |
783 | mutex_unlock(&s->mutex); | |
784 | ||
785 | return err; | |
786 | } | |
be4a2894 | 787 | EXPORT_SYMBOL(amdtp_stream_start); |
31ef9134 | 788 | |
e9148ddd | 789 | /** |
be4a2894 TS |
790 | * amdtp_stream_pcm_pointer - get the PCM buffer position |
791 | * @s: the AMDTP stream that transports the PCM data | |
e9148ddd CL |
792 | * |
793 | * Returns the current buffer position, in frames. | |
794 | */ | |
be4a2894 | 795 | unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s) |
e9148ddd | 796 | { |
92b862c7 | 797 | /* this optimization is allowed to be racy */ |
c8de6dbb | 798 | if (s->pointer_flush && amdtp_stream_running(s)) |
92b862c7 CL |
799 | fw_iso_context_flush_completions(s->context); |
800 | else | |
801 | s->pointer_flush = true; | |
e9148ddd CL |
802 | |
803 | return ACCESS_ONCE(s->pcm_buffer_pointer); | |
804 | } | |
be4a2894 | 805 | EXPORT_SYMBOL(amdtp_stream_pcm_pointer); |
e9148ddd | 806 | |
31ef9134 | 807 | /** |
be4a2894 TS |
808 | * amdtp_stream_update - update the stream after a bus reset |
809 | * @s: the AMDTP stream | |
31ef9134 | 810 | */ |
be4a2894 | 811 | void amdtp_stream_update(struct amdtp_stream *s) |
31ef9134 | 812 | { |
9a2820c1 | 813 | /* Precomputing. */ |
31ef9134 | 814 | ACCESS_ONCE(s->source_node_id_field) = |
9a2820c1 TS |
815 | (fw_parent_device(s->unit)->card->node_id << CIP_SID_SHIFT) & |
816 | CIP_SID_MASK; | |
31ef9134 | 817 | } |
be4a2894 | 818 | EXPORT_SYMBOL(amdtp_stream_update); |
31ef9134 CL |
819 | |
820 | /** | |
be4a2894 TS |
821 | * amdtp_stream_stop - stop sending packets |
822 | * @s: the AMDTP stream to stop | |
31ef9134 CL |
823 | * |
824 | * All PCM and MIDI devices of the stream must be stopped before the stream | |
825 | * itself can be stopped. | |
826 | */ | |
be4a2894 | 827 | void amdtp_stream_stop(struct amdtp_stream *s) |
31ef9134 CL |
828 | { |
829 | mutex_lock(&s->mutex); | |
830 | ||
be4a2894 | 831 | if (!amdtp_stream_running(s)) { |
31ef9134 CL |
832 | mutex_unlock(&s->mutex); |
833 | return; | |
834 | } | |
835 | ||
76fb8789 | 836 | tasklet_kill(&s->period_tasklet); |
31ef9134 CL |
837 | fw_iso_context_stop(s->context); |
838 | fw_iso_context_destroy(s->context); | |
839 | s->context = ERR_PTR(-1); | |
840 | iso_packets_buffer_destroy(&s->buffer, s->unit); | |
841 | ||
7b3b0d85 TS |
842 | s->callbacked = false; |
843 | ||
31ef9134 CL |
844 | mutex_unlock(&s->mutex); |
845 | } | |
be4a2894 | 846 | EXPORT_SYMBOL(amdtp_stream_stop); |
31ef9134 CL |
847 | |
848 | /** | |
be4a2894 | 849 | * amdtp_stream_pcm_abort - abort the running PCM device |
31ef9134 CL |
850 | * @s: the AMDTP stream about to be stopped |
851 | * | |
852 | * If the isochronous stream needs to be stopped asynchronously, call this | |
853 | * function first to stop the PCM device. | |
854 | */ | |
be4a2894 | 855 | void amdtp_stream_pcm_abort(struct amdtp_stream *s) |
31ef9134 CL |
856 | { |
857 | struct snd_pcm_substream *pcm; | |
858 | ||
859 | pcm = ACCESS_ONCE(s->pcm); | |
1fb8510c TI |
860 | if (pcm) |
861 | snd_pcm_stop_xrun(pcm); | |
31ef9134 | 862 | } |
be4a2894 | 863 | EXPORT_SYMBOL(amdtp_stream_pcm_abort); |