sound/firewire/bebob/bebob_stream.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * bebob_stream.c - a part of driver for BeBoB based devices
   4  *
   5  * Copyright (c) 2013-2014 Takashi Sakamoto
   6  */
   7
   8 #include "./bebob.h"
   9
  10 #define CALLBACK_TIMEOUT        2000
  11 #define FW_ISO_RESOURCE_DELAY   1000
  12
  13 /*
  14  * NOTE;
  15  * For BeBoB streams, Both of input and output CMP connection are important.
  16  *
  17  * For most devices, each CMP connection starts to transmit/receive a
  18  * corresponding stream. But for a few devices, both of CMP connection needs
  19  * to start transmitting stream. An example is 'M-Audio Firewire 410'.
  20  */
  21
  22 /* 128 is an arbitrary length but it seems to be enough */
  23 #define FORMAT_MAXIMUM_LENGTH 128
  24
  25 const unsigned int snd_bebob_rate_table[SND_BEBOB_STRM_FMT_ENTRIES] = {
  26         [0] = 32000,
  27         [1] = 44100,
  28         [2] = 48000,
  29         [3] = 88200,
  30         [4] = 96000,
  31         [5] = 176400,
  32         [6] = 192000,
  33 };
  34
  35 /*
  36  * See: Table 51: Extended Stream Format Info ‘Sampling Frequency’
  37  * in Additional AVC commands (Nov 2003, BridgeCo)
  38  */
  39 static const unsigned int bridgeco_freq_table[] = {
  40         [0] = 0x02,
  41         [1] = 0x03,
  42         [2] = 0x04,
  43         [3] = 0x0a,
  44         [4] = 0x05,
  45         [5] = 0x06,
  46         [6] = 0x07,
  47 };
  48
  49 static int
  50 get_formation_index(unsigned int rate, unsigned int *index)
  51 {
  52         unsigned int i;
  53
  54         for (i = 0; i < ARRAY_SIZE(snd_bebob_rate_table); i++) {
  55                 if (snd_bebob_rate_table[i] == rate) {
  56                         *index = i;
  57                         return 0;
  58                 }
  59         }
  60         return -EINVAL;
  61 }
  62
  63 int
  64 snd_bebob_stream_get_rate(struct snd_bebob *bebob, unsigned int *curr_rate)
  65 {
  66         unsigned int tx_rate, rx_rate, trials;
  67         int err;
  68
  69         trials = 0;
  70         do {
  71                 err = avc_general_get_sig_fmt(bebob->unit, &tx_rate,
  72                                               AVC_GENERAL_PLUG_DIR_OUT, 0);
  73         } while (err == -EAGAIN && ++trials < 3);
  74         if (err < 0)
  75                 goto end;
  76
  77         trials = 0;
  78         do {
  79                 err = avc_general_get_sig_fmt(bebob->unit, &rx_rate,
  80                                               AVC_GENERAL_PLUG_DIR_IN, 0);
  81         } while (err == -EAGAIN && ++trials < 3);
  82         if (err < 0)
  83                 goto end;
  84
  85         *curr_rate = rx_rate;
  86         if (rx_rate == tx_rate)
  87                 goto end;
  88
  89         /* synchronize receive stream rate to transmit stream rate */
  90         err = avc_general_set_sig_fmt(bebob->unit, rx_rate,
  91                                       AVC_GENERAL_PLUG_DIR_IN, 0);
  92 end:
  93         return err;
  94 }
  95
  96 int
  97 snd_bebob_stream_set_rate(struct snd_bebob *bebob, unsigned int rate)
  98 {
  99         int err;
 100
 101         err = avc_general_set_sig_fmt(bebob->unit, rate,
 102                                       AVC_GENERAL_PLUG_DIR_OUT, 0);
 103         if (err < 0)
 104                 goto end;
 105
 106         err = avc_general_set_sig_fmt(bebob->unit, rate,
 107                                       AVC_GENERAL_PLUG_DIR_IN, 0);
 108         if (err < 0)
 109                 goto end;
 110
 111         /*
 112          * Some devices need a bit time for transition.
 113          * 300msec is got by some experiments.
 114          */
 115         msleep(300);
 116 end:
 117         return err;
 118 }
 119
 120 int snd_bebob_stream_get_clock_src(struct snd_bebob *bebob,
 121                                    enum snd_bebob_clock_type *src)
 122 {
 123         const struct snd_bebob_clock_spec *clk_spec = bebob->spec->clock;
 124         u8 addr[AVC_BRIDGECO_ADDR_BYTES], input[7];
 125         unsigned int id;
 126         enum avc_bridgeco_plug_type type;
 127         int err = 0;
 128
 129         /* 1.The device has its own operation to switch source of clock */
 130         if (clk_spec) {
 131                 err = clk_spec->get(bebob, &id);
 132                 if (err < 0) {
 133                         dev_err(&bebob->unit->device,
 134                                 "fail to get clock source: %d\n", err);
 135                         goto end;
 136                 }
 137
 138                 if (id >= clk_spec->num) {
 139                         dev_err(&bebob->unit->device,
 140                                 "clock source %d out of range 0..%d\n",
 141                                 id, clk_spec->num - 1);
 142                         err = -EIO;
 143                         goto end;
 144                 }
 145
 146                 *src = clk_spec->types[id];
 147                 goto end;
 148         }
 149
 150         /*
 151          * 2.The device don't support to switch source of clock then assumed
 152          *   to use internal clock always
 153          */
 154         if (bebob->sync_input_plug < 0) {
 155                 *src = SND_BEBOB_CLOCK_TYPE_INTERNAL;
 156                 goto end;
 157         }
 158
 159         /*
 160          * 3.The device supports to switch source of clock by an usual way.
 161          *   Let's check input for 'Music Sub Unit Sync Input' plug.
 162          */
 163         avc_bridgeco_fill_msu_addr(addr, AVC_BRIDGECO_PLUG_DIR_IN,
 164                                    bebob->sync_input_plug);
 165         err = avc_bridgeco_get_plug_input(bebob->unit, addr, input);
 166         if (err < 0) {
 167                 dev_err(&bebob->unit->device,
 168                         "fail to get an input for MSU in plug %d: %d\n",
 169                         bebob->sync_input_plug, err);
 170                 goto end;
 171         }
 172
 173         /*
 174          * If there are no input plugs, all of fields are 0xff.
 175          * Here check the first field. This field is used for direction.
 176          */
 177         if (input[0] == 0xff) {
 178                 *src = SND_BEBOB_CLOCK_TYPE_INTERNAL;
 179                 goto end;
 180         }
 181
 182         /* The source from any output plugs is for one purpose only. */
 183         if (input[0] == AVC_BRIDGECO_PLUG_DIR_OUT) {
 184                 /*
 185                  * In BeBoB architecture, the source from music subunit may
 186                  * bypass from oPCR[0]. This means that this source gives
 187                  * synchronization to IEEE 1394 cycle start packet.
 188                  */
 189                 if (input[1] == AVC_BRIDGECO_PLUG_MODE_SUBUNIT &&
 190                     input[2] == 0x0c) {
 191                         *src = SND_BEBOB_CLOCK_TYPE_INTERNAL;
 192                         goto end;
 193                 }
 194         /* The source from any input units is for several purposes. */
 195         } else if (input[1] == AVC_BRIDGECO_PLUG_MODE_UNIT) {
 196                 if (input[2] == AVC_BRIDGECO_PLUG_UNIT_ISOC) {
 197                         if (input[3] == 0x00) {
 198                                 /*
 199                                  * This source comes from iPCR[0]. This means
 200                                  * that presentation timestamp calculated by
 201                                  * SYT series of the received packets. In
 202                                  * short, this driver is the master of
 203                                  * synchronization.
 204                                  */
 205                                 *src = SND_BEBOB_CLOCK_TYPE_SYT;
 206                                 goto end;
 207                         } else {
 208                                 /*
 209                                  * This source comes from iPCR[1-29]. This
 210                                  * means that the synchronization stream is not
 211                                  * the Audio/MIDI compound stream.
 212                                  */
 213                                 *src = SND_BEBOB_CLOCK_TYPE_EXTERNAL;
 214                                 goto end;
 215                         }
 216                 } else if (input[2] == AVC_BRIDGECO_PLUG_UNIT_EXT) {
 217                         /* Check type of this plug.  */
 218                         avc_bridgeco_fill_unit_addr(addr,
 219                                                     AVC_BRIDGECO_PLUG_DIR_IN,
 220                                                     AVC_BRIDGECO_PLUG_UNIT_EXT,
 221                                                     input[3]);
 222                         err = avc_bridgeco_get_plug_type(bebob->unit, addr,
 223                                                          &type);
 224                         if (err < 0)
 225                                 goto end;
 226
 227                         if (type == AVC_BRIDGECO_PLUG_TYPE_DIG) {
 228                                 /*
 229                                  * SPDIF/ADAT or sometimes (not always) word
 230                                  * clock.
 231                                  */
 232                                 *src = SND_BEBOB_CLOCK_TYPE_EXTERNAL;
 233                                 goto end;
 234                         } else if (type == AVC_BRIDGECO_PLUG_TYPE_SYNC) {
 235                                 /* Often word clock. */
 236                                 *src = SND_BEBOB_CLOCK_TYPE_EXTERNAL;
 237                                 goto end;
 238                         } else if (type == AVC_BRIDGECO_PLUG_TYPE_ADDITION) {
 239                                 /*
 240                                  * Not standard.
 241                                  * Mostly, additional internal clock.
 242                                  */
 243                                 *src = SND_BEBOB_CLOCK_TYPE_INTERNAL;
 244                                 goto end;
 245                         }
 246                 }
 247         }
 248
 249         /* Not supported. */
 250         err = -EIO;
 251 end:
 252         return err;
 253 }
 254
 255 static unsigned int
 256 map_data_channels(struct snd_bebob *bebob, struct amdtp_stream *s)
 257 {
 258         unsigned int sec, sections, ch, channels;
 259         unsigned int pcm, midi, location;
 260         unsigned int stm_pos, sec_loc, pos;
 261         u8 *buf, addr[AVC_BRIDGECO_ADDR_BYTES], type;
 262         enum avc_bridgeco_plug_dir dir;
 263         int err;
 264
 265         /*
 266          * The length of return value of this command cannot be expected. Here
 267          * use the maximum length of FCP.
 268          */
 269         buf = kzalloc(256, GFP_KERNEL);
 270         if (buf == NULL)
 271                 return -ENOMEM;
 272
 273         if (s == &bebob->tx_stream)
 274                 dir = AVC_BRIDGECO_PLUG_DIR_OUT;
 275         else
 276                 dir = AVC_BRIDGECO_PLUG_DIR_IN;
 277
 278         avc_bridgeco_fill_unit_addr(addr, dir, AVC_BRIDGECO_PLUG_UNIT_ISOC, 0);
 279         err = avc_bridgeco_get_plug_ch_pos(bebob->unit, addr, buf, 256);
 280         if (err < 0) {
 281                 dev_err(&bebob->unit->device,
 282                         "fail to get channel position for isoc %s plug 0: %d\n",
 283                         (dir == AVC_BRIDGECO_PLUG_DIR_IN) ? "in" : "out",
 284                         err);
 285                 goto end;
 286         }
 287         pos = 0;
 288
 289         /* positions in I/O buffer */
 290         pcm = 0;
 291         midi = 0;
 292
 293         /* the number of sections in AMDTP packet */
 294         sections = buf[pos++];
 295
 296         for (sec = 0; sec < sections; sec++) {
 297                 /* type of this section */
 298                 avc_bridgeco_fill_unit_addr(addr, dir,
 299                                             AVC_BRIDGECO_PLUG_UNIT_ISOC, 0);
 300                 err = avc_bridgeco_get_plug_section_type(bebob->unit, addr,
 301                                                          sec, &type);
 302                 if (err < 0) {
 303                         dev_err(&bebob->unit->device,
 304                         "fail to get section type for isoc %s plug 0: %d\n",
 305                                 (dir == AVC_BRIDGECO_PLUG_DIR_IN) ? "in" :
 306                                                                     "out",
 307                                 err);
 308                         goto end;
 309                 }
 310                 /* NoType */
 311                 if (type == 0xff) {
 312                         err = -ENOSYS;
 313                         goto end;
 314                 }
 315
 316                 /* the number of channels in this section */
 317                 channels = buf[pos++];
 318
 319                 for (ch = 0; ch < channels; ch++) {
 320                         /* position of this channel in AMDTP packet */
 321                         stm_pos = buf[pos++] - 1;
 322                         /* location of this channel in this section */
 323                         sec_loc = buf[pos++] - 1;
 324
 325                         /*
 326                          * Basically the number of location is within the
 327                          * number of channels in this section. But some models
 328                          * of M-Audio don't follow this. Its location for MIDI
 329                          * is the position of MIDI channels in AMDTP packet.
 330                          */
 331                         if (sec_loc >= channels)
 332                                 sec_loc = ch;
 333
 334                         switch (type) {
 335                         /* for MIDI conformant data channel */
 336                         case 0x0a:
 337                                 /* AMDTP_MAX_CHANNELS_FOR_MIDI is 1. */
 338                                 if ((midi > 0) && (stm_pos != midi)) {
 339                                         err = -ENOSYS;
 340                                         goto end;
 341                                 }
 342                                 amdtp_am824_set_midi_position(s, stm_pos);
 343                                 midi = stm_pos;
 344                                 break;
 345                         /* for PCM data channel */
 346                         case 0x01:      /* Headphone */
 347                         case 0x02:      /* Microphone */
 348                         case 0x03:      /* Line */
 349                         case 0x04:      /* SPDIF */
 350                         case 0x05:      /* ADAT */
 351                         case 0x06:      /* TDIF */
 352                         case 0x07:      /* MADI */
 353                         /* for undefined/changeable signal  */
 354                         case 0x08:      /* Analog */
 355                         case 0x09:      /* Digital */
 356                         default:
 357                                 location = pcm + sec_loc;
 358                                 if (location >= AM824_MAX_CHANNELS_FOR_PCM) {
 359                                         err = -ENOSYS;
 360                                         goto end;
 361                                 }
 362                                 amdtp_am824_set_pcm_position(s, location,
 363                                                              stm_pos);
 364                                 break;
 365                         }
 366                 }
 367
 368                 if (type != 0x0a)
 369                         pcm += channels;
 370                 else
 371                         midi += channels;
 372         }
 373 end:
 374         kfree(buf);
 375         return err;
 376 }
 377
 378 static int
 379 check_connection_used_by_others(struct snd_bebob *bebob, struct amdtp_stream *s)
 380 {
 381         struct cmp_connection *conn;
 382         bool used;
 383         int err;
 384
 385         if (s == &bebob->tx_stream)
 386                 conn = &bebob->out_conn;
 387         else
 388                 conn = &bebob->in_conn;
 389
 390         err = cmp_connection_check_used(conn, &used);
 391         if ((err >= 0) && used && !amdtp_stream_running(s)) {
 392                 dev_err(&bebob->unit->device,
 393                         "Connection established by others: %cPCR[%d]\n",
 394                         (conn->direction == CMP_OUTPUT) ? 'o' : 'i',
 395                         conn->pcr_index);
 396                 err = -EBUSY;
 397         }
 398
 399         return err;
 400 }
 401
 402 static int make_both_connections(struct snd_bebob *bebob)
 403 {
 404         int err = 0;
 405
 406         err = cmp_connection_establish(&bebob->out_conn);
 407         if (err < 0)
 408                 return err;
 409
 410         err = cmp_connection_establish(&bebob->in_conn);
 411         if (err < 0) {
 412                 cmp_connection_break(&bebob->out_conn);
 413                 return err;
 414         }
 415
 416         return 0;
 417 }
 418
 419 static void
 420 break_both_connections(struct snd_bebob *bebob)
 421 {
 422         cmp_connection_break(&bebob->in_conn);
 423         cmp_connection_break(&bebob->out_conn);
 424
 425         /* These models seems to be in transition state for a longer time. */
 426         if (bebob->maudio_special_quirk != NULL)
 427                 msleep(200);
 428 }
 429
 430 static int
 431 start_stream(struct snd_bebob *bebob, struct amdtp_stream *stream)
 432 {
 433         struct cmp_connection *conn;
 434         int err = 0;
 435
 436         if (stream == &bebob->rx_stream)
 437                 conn = &bebob->in_conn;
 438         else
 439                 conn = &bebob->out_conn;
 440
 441         /* channel mapping */
 442         if (bebob->maudio_special_quirk == NULL) {
 443                 err = map_data_channels(bebob, stream);
 444                 if (err < 0)
 445                         goto end;
 446         }
 447
 448         // start amdtp stream.
 449         err = amdtp_domain_add_stream(&bebob->domain, stream,
 450                                       conn->resources.channel, conn->speed);
 451 end:
 452         return err;
 453 }
 454
 455 static int init_stream(struct snd_bebob *bebob, struct amdtp_stream *stream)
 456 {
 457         enum amdtp_stream_direction dir_stream;
 458         struct cmp_connection *conn;
 459         enum cmp_direction dir_conn;
 460         int err;
 461
 462         if (stream == &bebob->tx_stream) {
 463                 dir_stream = AMDTP_IN_STREAM;
 464                 conn = &bebob->out_conn;
 465                 dir_conn = CMP_OUTPUT;
 466         } else {
 467                 dir_stream = AMDTP_OUT_STREAM;
 468                 conn = &bebob->in_conn;
 469                 dir_conn = CMP_INPUT;
 470         }
 471
 472         err = cmp_connection_init(conn, bebob->unit, dir_conn, 0);
 473         if (err < 0)
 474                 return err;
 475
 476         err = amdtp_am824_init(stream, bebob->unit, dir_stream, CIP_BLOCKING);
 477         if (err < 0) {
 478                 cmp_connection_destroy(conn);
 479                 return err;
 480         }
 481
 482         if (stream == &bebob->tx_stream) {
 483                 // BeBoB v3 transfers packets with these qurks:
 484                 //  - In the beginning of streaming, the value of dbc is
 485                 //    incremented even if no data blocks are transferred.
 486                 //  - The value of dbc is reset suddenly.
 487                 if (bebob->version > 2)
 488                         bebob->tx_stream.flags |= CIP_EMPTY_HAS_WRONG_DBC |
 489                                                   CIP_SKIP_DBC_ZERO_CHECK;
 490
 491                 // At high sampling rate, M-Audio special firmware transmits
 492                 // empty packet with the value of dbc incremented by 8 but the
 493                 // others are valid to IEC 61883-1.
 494                 if (bebob->maudio_special_quirk)
 495                         bebob->tx_stream.flags |= CIP_EMPTY_HAS_WRONG_DBC;
 496         }
 497
 498         return 0;
 499 }
 500
 501 static void destroy_stream(struct snd_bebob *bebob, struct amdtp_stream *stream)
 502 {
 503         amdtp_stream_destroy(stream);
 504
 505         if (stream == &bebob->tx_stream)
 506                 cmp_connection_destroy(&bebob->out_conn);
 507         else
 508                 cmp_connection_destroy(&bebob->in_conn);
 509 }
 510
 511 int snd_bebob_stream_init_duplex(struct snd_bebob *bebob)
 512 {
 513         int err;
 514
 515         err = init_stream(bebob, &bebob->tx_stream);
 516         if (err < 0)
 517                 return err;
 518
 519         err = init_stream(bebob, &bebob->rx_stream);
 520         if (err < 0) {
 521                 destroy_stream(bebob, &bebob->tx_stream);
 522                 return err;
 523         }
 524
 525         err = amdtp_domain_init(&bebob->domain);
 526         if (err < 0) {
 527                 destroy_stream(bebob, &bebob->tx_stream);
 528                 destroy_stream(bebob, &bebob->rx_stream);
 529         }
 530
 531         return err;
 532 }
 533
 534 static int keep_resources(struct snd_bebob *bebob, struct amdtp_stream *stream,
 535                           unsigned int rate, unsigned int index)
 536 {
 537         struct snd_bebob_stream_formation *formation;
 538         struct cmp_connection *conn;
 539         int err;
 540
 541         if (stream == &bebob->tx_stream) {
 542                 formation = bebob->tx_stream_formations + index;
 543                 conn = &bebob->out_conn;
 544         } else {
 545                 formation = bebob->rx_stream_formations + index;
 546                 conn = &bebob->in_conn;
 547         }
 548
 549         err = amdtp_am824_set_parameters(stream, rate, formation->pcm,
 550                                          formation->midi, false);
 551         if (err < 0)
 552                 return err;
 553
 554         return cmp_connection_reserve(conn, amdtp_stream_get_max_payload(stream));
 555 }
 556
 557 int snd_bebob_stream_reserve_duplex(struct snd_bebob *bebob, unsigned int rate,
 558                                     unsigned int frames_per_period,
 559                                     unsigned int frames_per_buffer)
 560 {
 561         unsigned int curr_rate;
 562         int err;
 563
 564         // Considering JACK/FFADO streaming:
 565         // TODO: This can be removed hwdep functionality becomes popular.
 566         err = check_connection_used_by_others(bebob, &bebob->rx_stream);
 567         if (err < 0)
 568                 return err;
 569
 570         err = bebob->spec->rate->get(bebob, &curr_rate);
 571         if (err < 0)
 572                 return err;
 573         if (rate == 0)
 574                 rate = curr_rate;
 575         if (curr_rate != rate) {
 576                 amdtp_domain_stop(&bebob->domain);
 577                 break_both_connections(bebob);
 578
 579                 cmp_connection_release(&bebob->out_conn);
 580                 cmp_connection_release(&bebob->in_conn);
 581         }
 582
 583         if (bebob->substreams_counter == 0 || curr_rate != rate) {
 584                 unsigned int index;
 585
 586                 // NOTE:
 587                 // If establishing connections at first, Yamaha GO46
 588                 // (and maybe Terratec X24) don't generate sound.
 589                 //
 590                 // For firmware customized by M-Audio, refer to next NOTE.
 591                 err = bebob->spec->rate->set(bebob, rate);
 592                 if (err < 0) {
 593                         dev_err(&bebob->unit->device,
 594                                 "fail to set sampling rate: %d\n",
 595                                 err);
 596                         return err;
 597                 }
 598
 599                 err = get_formation_index(rate, &index);
 600                 if (err < 0)
 601                         return err;
 602
 603                 err = keep_resources(bebob, &bebob->tx_stream, rate, index);
 604                 if (err < 0)
 605                         return err;
 606
 607                 err = keep_resources(bebob, &bebob->rx_stream, rate, index);
 608                 if (err < 0) {
 609                         cmp_connection_release(&bebob->out_conn);
 610                         return err;
 611                 }
 612
 613                 err = amdtp_domain_set_events_per_period(&bebob->domain,
 614                                         frames_per_period, frames_per_buffer);
 615                 if (err < 0) {
 616                         cmp_connection_release(&bebob->out_conn);
 617                         cmp_connection_release(&bebob->in_conn);
 618                         return err;
 619                 }
 620         }
 621
 622         return 0;
 623 }
 624
 625 int snd_bebob_stream_start_duplex(struct snd_bebob *bebob)
 626 {
 627         int err;
 628
 629         // Need no substreams.
 630         if (bebob->substreams_counter == 0)
 631                 return -EIO;
 632
 633         // packet queueing error or detecting discontinuity
 634         if (amdtp_streaming_error(&bebob->rx_stream) ||
 635             amdtp_streaming_error(&bebob->tx_stream)) {
 636                 amdtp_domain_stop(&bebob->domain);
 637                 break_both_connections(bebob);
 638         }
 639
 640         if (!amdtp_stream_running(&bebob->rx_stream)) {
 641                 unsigned int curr_rate;
 642
 643                 if (bebob->maudio_special_quirk) {
 644                         err = bebob->spec->rate->get(bebob, &curr_rate);
 645                         if (err < 0)
 646                                 return err;
 647                 }
 648
 649                 err = make_both_connections(bebob);
 650                 if (err < 0)
 651                         return err;
 652
 653                 err = start_stream(bebob, &bebob->rx_stream);
 654                 if (err < 0)
 655                         goto error;
 656
 657                 err = start_stream(bebob, &bebob->tx_stream);
 658                 if (err < 0)
 659                         goto error;
 660
 661                 // The device postpones start of transmission mostly for 1 sec
 662                 // after receives packets firstly. For safe, IR context starts
 663                 // 1.5 sec (=12000 cycles) later. This is within 2.0 sec
 664                 // (=CALLBACK_TIMEOUT).
 665                 // Furthermore, some devices transfer isoc packets with
 666                 // discontinuous counter in the beginning of packet streaming.
 667                 // The delay has an effect to avoid detection of this
 668                 // discontinuity.
 669                 err = amdtp_domain_start(&bebob->domain, 12000);
 670                 if (err < 0)
 671                         goto error;
 672
 673                 // NOTE:
 674                 // The firmware customized by M-Audio uses these commands to
 675                 // start transmitting stream. This is not usual way.
 676                 if (bebob->maudio_special_quirk) {
 677                         err = bebob->spec->rate->set(bebob, curr_rate);
 678                         if (err < 0) {
 679                                 dev_err(&bebob->unit->device,
 680                                         "fail to ensure sampling rate: %d\n",
 681                                         err);
 682                                 goto error;
 683                         }
 684                 }
 685
 686                 if (!amdtp_stream_wait_callback(&bebob->rx_stream,
 687                                                 CALLBACK_TIMEOUT) ||
 688                     !amdtp_stream_wait_callback(&bebob->tx_stream,
 689                                                 CALLBACK_TIMEOUT)) {
 690                         err = -ETIMEDOUT;
 691                         goto error;
 692                 }
 693         }
 694
 695         return 0;
 696 error:
 697         amdtp_domain_stop(&bebob->domain);
 698         break_both_connections(bebob);
 699         return err;
 700 }
 701
 702 void snd_bebob_stream_stop_duplex(struct snd_bebob *bebob)
 703 {
 704         if (bebob->substreams_counter == 0) {
 705                 amdtp_domain_stop(&bebob->domain);
 706                 break_both_connections(bebob);
 707
 708                 cmp_connection_release(&bebob->out_conn);
 709                 cmp_connection_release(&bebob->in_conn);
 710         }
 711 }
 712
 713 /*
 714  * This function should be called before starting streams or after stopping
 715  * streams.
 716  */
 717 void snd_bebob_stream_destroy_duplex(struct snd_bebob *bebob)
 718 {
 719         amdtp_domain_destroy(&bebob->domain);
 720
 721         destroy_stream(bebob, &bebob->tx_stream);
 722         destroy_stream(bebob, &bebob->rx_stream);
 723 }
 724
 725 /*
 726  * See: Table 50: Extended Stream Format Info Format Hierarchy Level 2’
 727  * in Additional AVC commands (Nov 2003, BridgeCo)
 728  * Also 'Clause 12 AM824 sequence adaption layers' in IEC 61883-6:2005
 729  */
 730 static int
 731 parse_stream_formation(u8 *buf, unsigned int len,
 732                        struct snd_bebob_stream_formation *formation)
 733 {
 734         unsigned int i, e, channels, format;
 735
 736         /*
 737          * this module can support a hierarchy combination that:
 738          *  Root:       Audio and Music (0x90)
 739          *  Level 1:    AM824 Compound  (0x40)
 740          */
 741         if ((buf[0] != 0x90) || (buf[1] != 0x40))
 742                 return -ENOSYS;
 743
 744         /* check sampling rate */
 745         for (i = 0; i < ARRAY_SIZE(bridgeco_freq_table); i++) {
 746                 if (buf[2] == bridgeco_freq_table[i])
 747                         break;
 748         }
 749         if (i == ARRAY_SIZE(bridgeco_freq_table))
 750                 return -ENOSYS;
 751
 752         /* Avoid double count by different entries for the same rate. */
 753         memset(&formation[i], 0, sizeof(struct snd_bebob_stream_formation));
 754
 755         for (e = 0; e < buf[4]; e++) {
 756                 channels = buf[5 + e * 2];
 757                 format = buf[6 + e * 2];
 758
 759                 switch (format) {
 760                 /* IEC 60958 Conformant, currently handled as MBLA */
 761                 case 0x00:
 762                 /* Multi bit linear audio */
 763                 case 0x06:      /* Raw */
 764                         formation[i].pcm += channels;
 765                         break;
 766                 /* MIDI Conformant */
 767                 case 0x0d:
 768                         formation[i].midi += channels;
 769                         break;
 770                 /* IEC 61937-3 to 7 */
 771                 case 0x01:
 772                 case 0x02:
 773                 case 0x03:
 774                 case 0x04:
 775                 case 0x05:
 776                 /* Multi bit linear audio */
 777                 case 0x07:      /* DVD-Audio */
 778                 case 0x0c:      /* High Precision */
 779                 /* One Bit Audio */
 780                 case 0x08:      /* (Plain) Raw */
 781                 case 0x09:      /* (Plain) SACD */
 782                 case 0x0a:      /* (Encoded) Raw */
 783                 case 0x0b:      /* (Encoded) SACD */
 784                 /* Synchronization Stream (Stereo Raw audio) */
 785                 case 0x40:
 786                 /* Don't care */
 787                 case 0xff:
 788                 default:
 789                         return -ENOSYS; /* not supported */
 790                 }
 791         }
 792
 793         if (formation[i].pcm  > AM824_MAX_CHANNELS_FOR_PCM ||
 794             formation[i].midi > AM824_MAX_CHANNELS_FOR_MIDI)
 795                 return -ENOSYS;
 796
 797         return 0;
 798 }
 799
 800 static int
 801 fill_stream_formations(struct snd_bebob *bebob, enum avc_bridgeco_plug_dir dir,
 802                        unsigned short pid)
 803 {
 804         u8 *buf;
 805         struct snd_bebob_stream_formation *formations;
 806         unsigned int len, eid;
 807         u8 addr[AVC_BRIDGECO_ADDR_BYTES];
 808         int err;
 809
 810         buf = kmalloc(FORMAT_MAXIMUM_LENGTH, GFP_KERNEL);
 811         if (buf == NULL)
 812                 return -ENOMEM;
 813
 814         if (dir == AVC_BRIDGECO_PLUG_DIR_IN)
 815                 formations = bebob->rx_stream_formations;
 816         else
 817                 formations = bebob->tx_stream_formations;
 818
 819         for (eid = 0; eid < SND_BEBOB_STRM_FMT_ENTRIES; eid++) {
 820                 len = FORMAT_MAXIMUM_LENGTH;
 821                 avc_bridgeco_fill_unit_addr(addr, dir,
 822                                             AVC_BRIDGECO_PLUG_UNIT_ISOC, pid);
 823                 err = avc_bridgeco_get_plug_strm_fmt(bebob->unit, addr, buf,
 824                                                      &len, eid);
 825                 /* No entries remained. */
 826                 if (err == -EINVAL && eid > 0) {
 827                         err = 0;
 828                         break;
 829                 } else if (err < 0) {
 830                         dev_err(&bebob->unit->device,
 831                         "fail to get stream format %d for isoc %s plug %d:%d\n",
 832                                 eid,
 833                                 (dir == AVC_BRIDGECO_PLUG_DIR_IN) ? "in" :
 834                                                                     "out",
 835                                 pid, err);
 836                         break;
 837                 }
 838
 839                 err = parse_stream_formation(buf, len, formations);
 840                 if (err < 0)
 841                         break;
 842         }
 843
 844         kfree(buf);
 845         return err;
 846 }
 847
 848 static int
 849 seek_msu_sync_input_plug(struct snd_bebob *bebob)
 850 {
 851         u8 plugs[AVC_PLUG_INFO_BUF_BYTES], addr[AVC_BRIDGECO_ADDR_BYTES];
 852         unsigned int i;
 853         enum avc_bridgeco_plug_type type;
 854         int err;
 855
 856         /* Get the number of Music Sub Unit for both direction. */
 857         err = avc_general_get_plug_info(bebob->unit, 0x0c, 0x00, 0x00, plugs);
 858         if (err < 0) {
 859                 dev_err(&bebob->unit->device,
 860                         "fail to get info for MSU in/out plugs: %d\n",
 861                         err);
 862                 goto end;
 863         }
 864
 865         /* seek destination plugs for 'MSU sync input' */
 866         bebob->sync_input_plug = -1;
 867         for (i = 0; i < plugs[0]; i++) {
 868                 avc_bridgeco_fill_msu_addr(addr, AVC_BRIDGECO_PLUG_DIR_IN, i);
 869                 err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
 870                 if (err < 0) {
 871                         dev_err(&bebob->unit->device,
 872                                 "fail to get type for MSU in plug %d: %d\n",
 873                                 i, err);
 874                         goto end;
 875                 }
 876
 877                 if (type == AVC_BRIDGECO_PLUG_TYPE_SYNC) {
 878                         bebob->sync_input_plug = i;
 879                         break;
 880                 }
 881         }
 882 end:
 883         return err;
 884 }
 885
 886 int snd_bebob_stream_discover(struct snd_bebob *bebob)
 887 {
 888         const struct snd_bebob_clock_spec *clk_spec = bebob->spec->clock;
 889         u8 plugs[AVC_PLUG_INFO_BUF_BYTES], addr[AVC_BRIDGECO_ADDR_BYTES];
 890         enum avc_bridgeco_plug_type type;
 891         unsigned int i;
 892         int err;
 893
 894         /* the number of plugs for isoc in/out, ext in/out  */
 895         err = avc_general_get_plug_info(bebob->unit, 0x1f, 0x07, 0x00, plugs);
 896         if (err < 0) {
 897                 dev_err(&bebob->unit->device,
 898                 "fail to get info for isoc/external in/out plugs: %d\n",
 899                         err);
 900                 goto end;
 901         }
 902
 903         /*
 904          * This module supports at least one isoc input plug and one isoc
 905          * output plug.
 906          */
 907         if ((plugs[0] == 0) || (plugs[1] == 0)) {
 908                 err = -ENOSYS;
 909                 goto end;
 910         }
 911
 912         avc_bridgeco_fill_unit_addr(addr, AVC_BRIDGECO_PLUG_DIR_IN,
 913                                     AVC_BRIDGECO_PLUG_UNIT_ISOC, 0);
 914         err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
 915         if (err < 0) {
 916                 dev_err(&bebob->unit->device,
 917                         "fail to get type for isoc in plug 0: %d\n", err);
 918                 goto end;
 919         } else if (type != AVC_BRIDGECO_PLUG_TYPE_ISOC) {
 920                 err = -ENOSYS;
 921                 goto end;
 922         }
 923         err = fill_stream_formations(bebob, AVC_BRIDGECO_PLUG_DIR_IN, 0);
 924         if (err < 0)
 925                 goto end;
 926
 927         avc_bridgeco_fill_unit_addr(addr, AVC_BRIDGECO_PLUG_DIR_OUT,
 928                                     AVC_BRIDGECO_PLUG_UNIT_ISOC, 0);
 929         err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
 930         if (err < 0) {
 931                 dev_err(&bebob->unit->device,
 932                         "fail to get type for isoc out plug 0: %d\n", err);
 933                 goto end;
 934         } else if (type != AVC_BRIDGECO_PLUG_TYPE_ISOC) {
 935                 err = -ENOSYS;
 936                 goto end;
 937         }
 938         err = fill_stream_formations(bebob, AVC_BRIDGECO_PLUG_DIR_OUT, 0);
 939         if (err < 0)
 940                 goto end;
 941
 942         /* count external input plugs for MIDI */
 943         bebob->midi_input_ports = 0;
 944         for (i = 0; i < plugs[2]; i++) {
 945                 avc_bridgeco_fill_unit_addr(addr, AVC_BRIDGECO_PLUG_DIR_IN,
 946                                             AVC_BRIDGECO_PLUG_UNIT_EXT, i);
 947                 err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
 948                 if (err < 0) {
 949                         dev_err(&bebob->unit->device,
 950                         "fail to get type for external in plug %d: %d\n",
 951                                 i, err);
 952                         goto end;
 953                 } else if (type == AVC_BRIDGECO_PLUG_TYPE_MIDI) {
 954                         bebob->midi_input_ports++;
 955                 }
 956         }
 957
 958         /* count external output plugs for MIDI */
 959         bebob->midi_output_ports = 0;
 960         for (i = 0; i < plugs[3]; i++) {
 961                 avc_bridgeco_fill_unit_addr(addr, AVC_BRIDGECO_PLUG_DIR_OUT,
 962                                             AVC_BRIDGECO_PLUG_UNIT_EXT, i);
 963                 err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
 964                 if (err < 0) {
 965                         dev_err(&bebob->unit->device,
 966                         "fail to get type for external out plug %d: %d\n",
 967                                 i, err);
 968                         goto end;
 969                 } else if (type == AVC_BRIDGECO_PLUG_TYPE_MIDI) {
 970                         bebob->midi_output_ports++;
 971                 }
 972         }
 973
 974         /* for check source of clock later */
 975         if (!clk_spec)
 976                 err = seek_msu_sync_input_plug(bebob);
 977 end:
 978         return err;
 979 }
 980
 981 void snd_bebob_stream_lock_changed(struct snd_bebob *bebob)
 982 {
 983         bebob->dev_lock_changed = true;
 984         wake_up(&bebob->hwdep_wait);
 985 }
 986
 987 int snd_bebob_stream_lock_try(struct snd_bebob *bebob)
 988 {
 989         int err;
 990
 991         spin_lock_irq(&bebob->lock);
 992
 993         /* user land lock this */
 994         if (bebob->dev_lock_count < 0) {
 995                 err = -EBUSY;
 996                 goto end;
 997         }
 998
 999         /* this is the first time */
1000         if (bebob->dev_lock_count++ == 0)
1001                 snd_bebob_stream_lock_changed(bebob);
1002         err = 0;
1003 end:
1004         spin_unlock_irq(&bebob->lock);
1005         return err;
1006 }
1007
1008 void snd_bebob_stream_lock_release(struct snd_bebob *bebob)
1009 {
1010         spin_lock_irq(&bebob->lock);
1011
1012         if (WARN_ON(bebob->dev_lock_count <= 0))
1013                 goto end;
1014         if (--bebob->dev_lock_count == 0)
1015                 snd_bebob_stream_lock_changed(bebob);
1016 end:
1017         spin_unlock_irq(&bebob->lock);
1018 }