sound/firewire/bebob/bebob_stream.c

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