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         err = amdtp_stream_set_parameters(&bebob->tx_stream, rate,
 431                                           pcm_channels, midi_channels * 8,
 432                                           false);
 433         if (err < 0)
 434                 goto end;
 435
 436         pcm_channels = bebob->rx_stream_formations[index].pcm;
 437         midi_channels = bebob->rx_stream_formations[index].midi;
 438         err = amdtp_stream_set_parameters(&bebob->rx_stream, rate,
 439                                           pcm_channels, midi_channels * 8,
 440                                           false);
 441         if (err < 0)
 442                 goto end;
 443
 444         /* establish connections for both streams */
 445         err = cmp_connection_establish(&bebob->out_conn,
 446                         amdtp_stream_get_max_payload(&bebob->tx_stream));
 447         if (err < 0)
 448                 goto end;
 449         err = cmp_connection_establish(&bebob->in_conn,
 450                         amdtp_stream_get_max_payload(&bebob->rx_stream));
 451         if (err < 0) {
 452                 cmp_connection_break(&bebob->out_conn);
 453                 goto end;
 454         }
 455
 456         bebob->connected = true;
 457 end:
 458         return err;
 459 }
 460
 461 static void
 462 break_both_connections(struct snd_bebob *bebob)
 463 {
 464         cmp_connection_break(&bebob->in_conn);
 465         cmp_connection_break(&bebob->out_conn);
 466
 467         bebob->connected = false;
 468
 469         /* These models seems to be in transition state for a longer time. */
 470         if (bebob->maudio_special_quirk != NULL)
 471                 msleep(200);
 472 }
 473
 474 static void
 475 destroy_both_connections(struct snd_bebob *bebob)
 476 {
 477         cmp_connection_destroy(&bebob->in_conn);
 478         cmp_connection_destroy(&bebob->out_conn);
 479 }
 480
 481 static int
 482 get_sync_mode(struct snd_bebob *bebob, enum cip_flags *sync_mode)
 483 {
 484         enum snd_bebob_clock_type src;
 485         int err;
 486
 487         err = snd_bebob_stream_get_clock_src(bebob, &src);
 488         if (err < 0)
 489                 return err;
 490
 491         switch (src) {
 492         case SND_BEBOB_CLOCK_TYPE_INTERNAL:
 493         case SND_BEBOB_CLOCK_TYPE_EXTERNAL:
 494                 *sync_mode = CIP_SYNC_TO_DEVICE;
 495                 break;
 496         default:
 497         case SND_BEBOB_CLOCK_TYPE_SYT:
 498                 *sync_mode = 0;
 499                 break;
 500         }
 501
 502         return 0;
 503 }
 504
 505 static int
 506 start_stream(struct snd_bebob *bebob, struct amdtp_stream *stream,
 507              unsigned int rate)
 508 {
 509         struct cmp_connection *conn;
 510         int err = 0;
 511
 512         if (stream == &bebob->rx_stream)
 513                 conn = &bebob->in_conn;
 514         else
 515                 conn = &bebob->out_conn;
 516
 517         /* channel mapping */
 518         if (bebob->maudio_special_quirk == NULL) {
 519                 err = map_data_channels(bebob, stream);
 520                 if (err < 0)
 521                         goto end;
 522         }
 523
 524         /* start amdtp stream */
 525         err = amdtp_stream_start(stream,
 526                                  conn->resources.channel,
 527                                  conn->speed);
 528 end:
 529         return err;
 530 }
 531
 532 int snd_bebob_stream_init_duplex(struct snd_bebob *bebob)
 533 {
 534         int err;
 535
 536         err = init_both_connections(bebob);
 537         if (err < 0)
 538                 goto end;
 539
 540         err = amdtp_stream_init(&bebob->tx_stream, bebob->unit,
 541                                 AMDTP_IN_STREAM, CIP_BLOCKING);
 542         if (err < 0) {
 543                 amdtp_stream_destroy(&bebob->tx_stream);
 544                 destroy_both_connections(bebob);
 545                 goto end;
 546         }
 547         /* See comments in next function */
 548         init_completion(&bebob->bus_reset);
 549         bebob->tx_stream.flags |= CIP_SKIP_INIT_DBC_CHECK;
 550
 551         /*
 552          * BeBoB v3 transfers packets with these qurks:
 553          *  - In the beginning of streaming, the value of dbc is incremented
 554          *    even if no data blocks are transferred.
 555          *  - The value of dbc is reset suddenly.
 556          */
 557         if (bebob->version > 2)
 558                 bebob->tx_stream.flags |= CIP_EMPTY_HAS_WRONG_DBC |
 559                                           CIP_SKIP_DBC_ZERO_CHECK;
 560
 561         /*
 562          * At high sampling rate, M-Audio special firmware transmits empty
 563          * packet with the value of dbc incremented by 8 but the others are
 564          * valid to IEC 61883-1.
 565          */
 566         if (bebob->maudio_special_quirk)
 567                 bebob->tx_stream.flags |= CIP_EMPTY_HAS_WRONG_DBC;
 568
 569         err = amdtp_stream_init(&bebob->rx_stream, bebob->unit,
 570                                 AMDTP_OUT_STREAM, CIP_BLOCKING);
 571         if (err < 0) {
 572                 amdtp_stream_destroy(&bebob->tx_stream);
 573                 amdtp_stream_destroy(&bebob->rx_stream);
 574                 destroy_both_connections(bebob);
 575         }
 576 end:
 577         return err;
 578 }
 579
 580 int snd_bebob_stream_start_duplex(struct snd_bebob *bebob, unsigned int rate)
 581 {
 582         struct snd_bebob_rate_spec *rate_spec = bebob->spec->rate;
 583         struct amdtp_stream *master, *slave;
 584         enum cip_flags sync_mode;
 585         unsigned int curr_rate;
 586         bool updated = false;
 587         int err = 0;
 588
 589         /*
 590          * Normal BeBoB firmware has a quirk at bus reset to transmits packets
 591          * with discontinuous value in dbc field.
 592          *
 593          * This 'struct completion' is used to call .update() at first to update
 594          * connections/streams. Next following codes handle streaming error.
 595          */
 596         if (amdtp_streaming_error(&bebob->tx_stream)) {
 597                 if (completion_done(&bebob->bus_reset))
 598                         reinit_completion(&bebob->bus_reset);
 599
 600                 updated = (wait_for_completion_interruptible_timeout(
 601                                 &bebob->bus_reset,
 602                                 msecs_to_jiffies(FW_ISO_RESOURCE_DELAY)) > 0);
 603         }
 604
 605         mutex_lock(&bebob->mutex);
 606
 607         /* Need no substreams */
 608         if (atomic_read(&bebob->substreams_counter) == 0)
 609                 goto end;
 610
 611         err = get_sync_mode(bebob, &sync_mode);
 612         if (err < 0)
 613                 goto end;
 614         if (sync_mode == CIP_SYNC_TO_DEVICE) {
 615                 master = &bebob->tx_stream;
 616                 slave  = &bebob->rx_stream;
 617         } else {
 618                 master = &bebob->rx_stream;
 619                 slave  = &bebob->tx_stream;
 620         }
 621
 622         /*
 623          * Considering JACK/FFADO streaming:
 624          * TODO: This can be removed hwdep functionality becomes popular.
 625          */
 626         err = check_connection_used_by_others(bebob, master);
 627         if (err < 0)
 628                 goto end;
 629
 630         /*
 631          * packet queueing error or detecting discontinuity
 632          *
 633          * At bus reset, connections should not be broken here. So streams need
 634          * to be re-started. This is a reason to use SKIP_INIT_DBC_CHECK flag.
 635          */
 636         if (amdtp_streaming_error(master))
 637                 amdtp_stream_stop(master);
 638         if (amdtp_streaming_error(slave))
 639                 amdtp_stream_stop(slave);
 640         if (!updated &&
 641             !amdtp_stream_running(master) && !amdtp_stream_running(slave))
 642                 break_both_connections(bebob);
 643
 644         /* stop streams if rate is different */
 645         err = rate_spec->get(bebob, &curr_rate);
 646         if (err < 0) {
 647                 dev_err(&bebob->unit->device,
 648                         "fail to get sampling rate: %d\n", err);
 649                 goto end;
 650         }
 651         if (rate == 0)
 652                 rate = curr_rate;
 653         if (rate != curr_rate) {
 654                 amdtp_stream_stop(master);
 655                 amdtp_stream_stop(slave);
 656                 break_both_connections(bebob);
 657         }
 658
 659         /* master should be always running */
 660         if (!amdtp_stream_running(master)) {
 661                 amdtp_stream_set_sync(sync_mode, master, slave);
 662                 bebob->master = master;
 663
 664                 /*
 665                  * NOTE:
 666                  * If establishing connections at first, Yamaha GO46
 667                  * (and maybe Terratec X24) don't generate sound.
 668                  *
 669                  * For firmware customized by M-Audio, refer to next NOTE.
 670                  */
 671                 if (bebob->maudio_special_quirk == NULL) {
 672                         err = rate_spec->set(bebob, rate);
 673                         if (err < 0) {
 674                                 dev_err(&bebob->unit->device,
 675                                         "fail to set sampling rate: %d\n",
 676                                         err);
 677                                 goto end;
 678                         }
 679                 }
 680
 681                 err = make_both_connections(bebob, rate);
 682                 if (err < 0)
 683                         goto end;
 684
 685                 err = start_stream(bebob, master, rate);
 686                 if (err < 0) {
 687                         dev_err(&bebob->unit->device,
 688                                 "fail to run AMDTP master stream:%d\n", err);
 689                         break_both_connections(bebob);
 690                         goto end;
 691                 }
 692
 693                 /*
 694                  * NOTE:
 695                  * The firmware customized by M-Audio uses these commands to
 696                  * start transmitting stream. This is not usual way.
 697                  */
 698                 if (bebob->maudio_special_quirk != NULL) {
 699                         err = rate_spec->set(bebob, rate);
 700                         if (err < 0) {
 701                                 dev_err(&bebob->unit->device,
 702                                         "fail to ensure sampling rate: %d\n",
 703                                         err);
 704                                 amdtp_stream_stop(master);
 705                                 break_both_connections(bebob);
 706                                 goto end;
 707                         }
 708                 }
 709
 710                 /* wait first callback */
 711                 if (!amdtp_stream_wait_callback(master, CALLBACK_TIMEOUT)) {
 712                         amdtp_stream_stop(master);
 713                         break_both_connections(bebob);
 714                         err = -ETIMEDOUT;
 715                         goto end;
 716                 }
 717         }
 718
 719         /* start slave if needed */
 720         if (!amdtp_stream_running(slave)) {
 721                 err = start_stream(bebob, slave, rate);
 722                 if (err < 0) {
 723                         dev_err(&bebob->unit->device,
 724                                 "fail to run AMDTP slave stream:%d\n", err);
 725                         amdtp_stream_stop(master);
 726                         break_both_connections(bebob);
 727                         goto end;
 728                 }
 729
 730                 /* wait first callback */
 731                 if (!amdtp_stream_wait_callback(slave, CALLBACK_TIMEOUT)) {
 732                         amdtp_stream_stop(slave);
 733                         amdtp_stream_stop(master);
 734                         break_both_connections(bebob);
 735                         err = -ETIMEDOUT;
 736                 }
 737         }
 738 end:
 739         mutex_unlock(&bebob->mutex);
 740         return err;
 741 }
 742
 743 void snd_bebob_stream_stop_duplex(struct snd_bebob *bebob)
 744 {
 745         struct amdtp_stream *master, *slave;
 746
 747         if (bebob->master == &bebob->rx_stream) {
 748                 slave  = &bebob->tx_stream;
 749                 master = &bebob->rx_stream;
 750         } else {
 751                 slave  = &bebob->rx_stream;
 752                 master = &bebob->tx_stream;
 753         }
 754
 755         mutex_lock(&bebob->mutex);
 756
 757         if (atomic_read(&bebob->substreams_counter) == 0) {
 758                 amdtp_stream_pcm_abort(master);
 759                 amdtp_stream_stop(master);
 760
 761                 amdtp_stream_pcm_abort(slave);
 762                 amdtp_stream_stop(slave);
 763
 764                 break_both_connections(bebob);
 765         }
 766
 767         mutex_unlock(&bebob->mutex);
 768 }
 769
 770 void snd_bebob_stream_update_duplex(struct snd_bebob *bebob)
 771 {
 772         /* vs. XRUN recovery due to discontinuity at bus reset */
 773         mutex_lock(&bebob->mutex);
 774
 775         if ((cmp_connection_update(&bebob->in_conn) < 0) ||
 776             (cmp_connection_update(&bebob->out_conn) < 0)) {
 777                 amdtp_stream_pcm_abort(&bebob->rx_stream);
 778                 amdtp_stream_pcm_abort(&bebob->tx_stream);
 779                 amdtp_stream_stop(&bebob->rx_stream);
 780                 amdtp_stream_stop(&bebob->tx_stream);
 781                 break_both_connections(bebob);
 782         } else {
 783                 amdtp_stream_update(&bebob->rx_stream);
 784                 amdtp_stream_update(&bebob->tx_stream);
 785         }
 786
 787         /* wake up stream_start_duplex() */
 788         if (!completion_done(&bebob->bus_reset))
 789                 complete_all(&bebob->bus_reset);
 790
 791         mutex_unlock(&bebob->mutex);
 792 }
 793
 794 /*
 795  * This function should be called before starting streams or after stopping
 796  * streams.
 797  */
 798 void snd_bebob_stream_destroy_duplex(struct snd_bebob *bebob)
 799 {
 800         amdtp_stream_destroy(&bebob->rx_stream);
 801         amdtp_stream_destroy(&bebob->tx_stream);
 802
 803         destroy_both_connections(bebob);
 804 }
 805
 806 /*
 807  * See: Table 50: Extended Stream Format Info Format Hierarchy Level 2’
 808  * in Additional AVC commands (Nov 2003, BridgeCo)
 809  * Also 'Clause 12 AM824 sequence adaption layers' in IEC 61883-6:2005
 810  */
 811 static int
 812 parse_stream_formation(u8 *buf, unsigned int len,
 813                        struct snd_bebob_stream_formation *formation)
 814 {
 815         unsigned int i, e, channels, format;
 816
 817         /*
 818          * this module can support a hierarchy combination that:
 819          *  Root:       Audio and Music (0x90)
 820          *  Level 1:    AM824 Compound  (0x40)
 821          */
 822         if ((buf[0] != 0x90) || (buf[1] != 0x40))
 823                 return -ENOSYS;
 824
 825         /* check sampling rate */
 826         for (i = 0; i < ARRAY_SIZE(bridgeco_freq_table); i++) {
 827                 if (buf[2] == bridgeco_freq_table[i])
 828                         break;
 829         }
 830         if (i == ARRAY_SIZE(bridgeco_freq_table))
 831                 return -ENOSYS;
 832
 833         /* Avoid double count by different entries for the same rate. */
 834         memset(&formation[i], 0, sizeof(struct snd_bebob_stream_formation));
 835
 836         for (e = 0; e < buf[4]; e++) {
 837                 channels = buf[5 + e * 2];
 838                 format = buf[6 + e * 2];
 839
 840                 switch (format) {
 841                 /* IEC 60958 Conformant, currently handled as MBLA */
 842                 case 0x00:
 843                 /* Multi bit linear audio */
 844                 case 0x06:      /* Raw */
 845                         formation[i].pcm += channels;
 846                         break;
 847                 /* MIDI Conformant */
 848                 case 0x0d:
 849                         formation[i].midi += channels;
 850                         break;
 851                 /* IEC 61937-3 to 7 */
 852                 case 0x01:
 853                 case 0x02:
 854                 case 0x03:
 855                 case 0x04:
 856                 case 0x05:
 857                 /* Multi bit linear audio */
 858                 case 0x07:      /* DVD-Audio */
 859                 case 0x0c:      /* High Precision */
 860                 /* One Bit Audio */
 861                 case 0x08:      /* (Plain) Raw */
 862                 case 0x09:      /* (Plain) SACD */
 863                 case 0x0a:      /* (Encoded) Raw */
 864                 case 0x0b:      /* (Encoded) SACD */
 865                 /* Synchronization Stream (Stereo Raw audio) */
 866                 case 0x40:
 867                 /* Don't care */
 868                 case 0xff:
 869                 default:
 870                         return -ENOSYS; /* not supported */
 871                 }
 872         }
 873
 874         if (formation[i].pcm  > AMDTP_MAX_CHANNELS_FOR_PCM ||
 875             formation[i].midi > AMDTP_MAX_CHANNELS_FOR_MIDI)
 876                 return -ENOSYS;
 877
 878         return 0;
 879 }
 880
 881 static int
 882 fill_stream_formations(struct snd_bebob *bebob, enum avc_bridgeco_plug_dir dir,
 883                        unsigned short pid)
 884 {
 885         u8 *buf;
 886         struct snd_bebob_stream_formation *formations;
 887         unsigned int len, eid;
 888         u8 addr[AVC_BRIDGECO_ADDR_BYTES];
 889         int err;
 890
 891         buf = kmalloc(FORMAT_MAXIMUM_LENGTH, GFP_KERNEL);
 892         if (buf == NULL)
 893                 return -ENOMEM;
 894
 895         if (dir == AVC_BRIDGECO_PLUG_DIR_IN)
 896                 formations = bebob->rx_stream_formations;
 897         else
 898                 formations = bebob->tx_stream_formations;
 899
 900         for (eid = 0; eid < SND_BEBOB_STRM_FMT_ENTRIES; eid++) {
 901                 len = FORMAT_MAXIMUM_LENGTH;
 902                 avc_bridgeco_fill_unit_addr(addr, dir,
 903                                             AVC_BRIDGECO_PLUG_UNIT_ISOC, pid);
 904                 err = avc_bridgeco_get_plug_strm_fmt(bebob->unit, addr, buf,
 905                                                      &len, eid);
 906                 /* No entries remained. */
 907                 if (err == -EINVAL && eid > 0) {
 908                         err = 0;
 909                         break;
 910                 } else if (err < 0) {
 911                         dev_err(&bebob->unit->device,
 912                         "fail to get stream format %d for isoc %s plug %d:%d\n",
 913                                 eid,
 914                                 (dir == AVC_BRIDGECO_PLUG_DIR_IN) ? "in" :
 915                                                                     "out",
 916                                 pid, err);
 917                         break;
 918                 }
 919
 920                 err = parse_stream_formation(buf, len, formations);
 921                 if (err < 0)
 922                         break;
 923         }
 924
 925         kfree(buf);
 926         return err;
 927 }
 928
 929 static int
 930 seek_msu_sync_input_plug(struct snd_bebob *bebob)
 931 {
 932         u8 plugs[AVC_PLUG_INFO_BUF_BYTES], addr[AVC_BRIDGECO_ADDR_BYTES];
 933         unsigned int i;
 934         enum avc_bridgeco_plug_type type;
 935         int err;
 936
 937         /* Get the number of Music Sub Unit for both direction. */
 938         err = avc_general_get_plug_info(bebob->unit, 0x0c, 0x00, 0x00, plugs);
 939         if (err < 0) {
 940                 dev_err(&bebob->unit->device,
 941                         "fail to get info for MSU in/out plugs: %d\n",
 942                         err);
 943                 goto end;
 944         }
 945
 946         /* seek destination plugs for 'MSU sync input' */
 947         bebob->sync_input_plug = -1;
 948         for (i = 0; i < plugs[0]; i++) {
 949                 avc_bridgeco_fill_msu_addr(addr, AVC_BRIDGECO_PLUG_DIR_IN, i);
 950                 err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
 951                 if (err < 0) {
 952                         dev_err(&bebob->unit->device,
 953                                 "fail to get type for MSU in plug %d: %d\n",
 954                                 i, err);
 955                         goto end;
 956                 }
 957
 958                 if (type == AVC_BRIDGECO_PLUG_TYPE_SYNC) {
 959                         bebob->sync_input_plug = i;
 960                         break;
 961                 }
 962         }
 963 end:
 964         return err;
 965 }
 966
 967 int snd_bebob_stream_discover(struct snd_bebob *bebob)
 968 {
 969         struct snd_bebob_clock_spec *clk_spec = bebob->spec->clock;
 970         u8 plugs[AVC_PLUG_INFO_BUF_BYTES], addr[AVC_BRIDGECO_ADDR_BYTES];
 971         enum avc_bridgeco_plug_type type;
 972         unsigned int i;
 973         int err;
 974
 975         /* the number of plugs for isoc in/out, ext in/out  */
 976         err = avc_general_get_plug_info(bebob->unit, 0x1f, 0x07, 0x00, plugs);
 977         if (err < 0) {
 978                 dev_err(&bebob->unit->device,
 979                 "fail to get info for isoc/external in/out plugs: %d\n",
 980                         err);
 981                 goto end;
 982         }
 983
 984         /*
 985          * This module supports at least one isoc input plug and one isoc
 986          * output plug.
 987          */
 988         if ((plugs[0] == 0) || (plugs[1] == 0)) {
 989                 err = -ENOSYS;
 990                 goto end;
 991         }
 992
 993         avc_bridgeco_fill_unit_addr(addr, AVC_BRIDGECO_PLUG_DIR_IN,
 994                                     AVC_BRIDGECO_PLUG_UNIT_ISOC, 0);
 995         err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
 996         if (err < 0) {
 997                 dev_err(&bebob->unit->device,
 998                         "fail to get type for isoc in plug 0: %d\n", err);
 999                 goto end;
1000         } else if (type != AVC_BRIDGECO_PLUG_TYPE_ISOC) {
1001                 err = -ENOSYS;
1002                 goto end;
1003         }
1004         err = fill_stream_formations(bebob, AVC_BRIDGECO_PLUG_DIR_IN, 0);
1005         if (err < 0)
1006                 goto end;
1007
1008         avc_bridgeco_fill_unit_addr(addr, AVC_BRIDGECO_PLUG_DIR_OUT,
1009                                     AVC_BRIDGECO_PLUG_UNIT_ISOC, 0);
1010         err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
1011         if (err < 0) {
1012                 dev_err(&bebob->unit->device,
1013                         "fail to get type for isoc out plug 0: %d\n", err);
1014                 goto end;
1015         } else if (type != AVC_BRIDGECO_PLUG_TYPE_ISOC) {
1016                 err = -ENOSYS;
1017                 goto end;
1018         }
1019         err = fill_stream_formations(bebob, AVC_BRIDGECO_PLUG_DIR_OUT, 0);
1020         if (err < 0)
1021                 goto end;
1022
1023         /* count external input plugs for MIDI */
1024         bebob->midi_input_ports = 0;
1025         for (i = 0; i < plugs[2]; i++) {
1026                 avc_bridgeco_fill_unit_addr(addr, AVC_BRIDGECO_PLUG_DIR_IN,
1027                                             AVC_BRIDGECO_PLUG_UNIT_EXT, i);
1028                 err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
1029                 if (err < 0) {
1030                         dev_err(&bebob->unit->device,
1031                         "fail to get type for external in plug %d: %d\n",
1032                                 i, err);
1033                         goto end;
1034                 } else if (type == AVC_BRIDGECO_PLUG_TYPE_MIDI) {
1035                         bebob->midi_input_ports++;
1036                 }
1037         }
1038
1039         /* count external output plugs for MIDI */
1040         bebob->midi_output_ports = 0;
1041         for (i = 0; i < plugs[3]; i++) {
1042                 avc_bridgeco_fill_unit_addr(addr, AVC_BRIDGECO_PLUG_DIR_OUT,
1043                                             AVC_BRIDGECO_PLUG_UNIT_EXT, i);
1044                 err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
1045                 if (err < 0) {
1046                         dev_err(&bebob->unit->device,
1047                         "fail to get type for external out plug %d: %d\n",
1048                                 i, err);
1049                         goto end;
1050                 } else if (type == AVC_BRIDGECO_PLUG_TYPE_MIDI) {
1051                         bebob->midi_output_ports++;
1052                 }
1053         }
1054
1055         /* for check source of clock later */
1056         if (!clk_spec)
1057                 err = seek_msu_sync_input_plug(bebob);
1058 end:
1059         return err;
1060 }
1061
1062 void snd_bebob_stream_lock_changed(struct snd_bebob *bebob)
1063 {
1064         bebob->dev_lock_changed = true;
1065         wake_up(&bebob->hwdep_wait);
1066 }
1067
1068 int snd_bebob_stream_lock_try(struct snd_bebob *bebob)
1069 {
1070         int err;
1071
1072         spin_lock_irq(&bebob->lock);
1073
1074         /* user land lock this */
1075         if (bebob->dev_lock_count < 0) {
1076                 err = -EBUSY;
1077                 goto end;
1078         }
1079
1080         /* this is the first time */
1081         if (bebob->dev_lock_count++ == 0)
1082                 snd_bebob_stream_lock_changed(bebob);
1083         err = 0;
1084 end:
1085         spin_unlock_irq(&bebob->lock);
1086         return err;
1087 }
1088
1089 void snd_bebob_stream_lock_release(struct snd_bebob *bebob)
1090 {
1091         spin_lock_irq(&bebob->lock);
1092
1093         if (WARN_ON(bebob->dev_lock_count <= 0))
1094                 goto end;
1095         if (--bebob->dev_lock_count == 0)
1096                 snd_bebob_stream_lock_changed(bebob);
1097 end:
1098         spin_unlock_irq(&bebob->lock);
1099 }