sound/firewire/amdtp-stream.c

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