ALSA: firewire-motu: refactoring protocol v2 for clock source getter
[linux-2.6-microblaze.git] / sound / firewire / motu / motu-protocol-v2.c
index 619b6ae..2e6c3cc 100644 (file)
@@ -35,7 +35,8 @@ static int get_clock_rate(u32 data, unsigned int *rate)
        return 0;
 }
 
-static int v2_get_clock_rate(struct snd_motu *motu, unsigned int *rate)
+int snd_motu_protocol_v2_get_clock_rate(struct snd_motu *motu,
+                                       unsigned int *rate)
 {
        __be32 reg;
        int err;
@@ -48,7 +49,8 @@ static int v2_get_clock_rate(struct snd_motu *motu, unsigned int *rate)
        return get_clock_rate(be32_to_cpu(reg), rate);
 }
 
-static int v2_set_clock_rate(struct snd_motu *motu, unsigned int rate)
+int snd_motu_protocol_v2_set_clock_rate(struct snd_motu *motu,
+                                       unsigned int rate)
 {
        __be32 reg;
        u32 data;
@@ -76,14 +78,10 @@ static int v2_set_clock_rate(struct snd_motu *motu, unsigned int rate)
                                          sizeof(reg));
 }
 
-static int get_clock_source(struct snd_motu *motu, u32 data,
-                           enum snd_motu_clock_source *src)
+static int detect_clock_source_optical_model(struct snd_motu *motu, u32 data,
+                                            enum snd_motu_clock_source *src)
 {
-       unsigned int index = data & V2_CLOCK_SRC_MASK;
-       if (index > 5)
-               return -EIO;
-
-       switch (index) {
+       switch (data) {
        case 0:
                *src = SND_MOTU_CLOCK_SOURCE_INTERNAL;
                break;
@@ -116,14 +114,50 @@ static int get_clock_source(struct snd_motu *motu, u32 data,
                *src = SND_MOTU_CLOCK_SOURCE_ADAT_ON_DSUB;
                break;
        default:
-               return -EIO;
+               *src = SND_MOTU_CLOCK_SOURCE_UNKNOWN;
+               break;
+       }
+
+       return 0;
+}
+
+static int v2_detect_clock_source(struct snd_motu *motu, u32 data,
+                                 enum snd_motu_clock_source *src)
+{
+       switch (data) {
+       case 0:
+               *src = SND_MOTU_CLOCK_SOURCE_INTERNAL;
+               break;
+       case 2:
+               *src = SND_MOTU_CLOCK_SOURCE_SPDIF_ON_COAX;
+               break;
+       case 3:
+               *src = SND_MOTU_CLOCK_SOURCE_SPH;
+               break;
+       case 4:
+               *src = SND_MOTU_CLOCK_SOURCE_WORD_ON_BNC;
+               break;
+       default:
+               *src = SND_MOTU_CLOCK_SOURCE_UNKNOWN;
+               break;
        }
 
        return 0;
 }
 
-static int v2_get_clock_source(struct snd_motu *motu,
-                              enum snd_motu_clock_source *src)
+static int get_clock_source(struct snd_motu *motu, u32 data,
+                           enum snd_motu_clock_source *src)
+{
+       data &= V2_CLOCK_SRC_MASK;
+       if (motu->spec == &snd_motu_spec_828mk2 ||
+           motu->spec == &snd_motu_spec_traveler)
+               return detect_clock_source_optical_model(motu, data, src);
+       else
+               return v2_detect_clock_source(motu, data, src);
+}
+
+int snd_motu_protocol_v2_get_clock_source(struct snd_motu *motu,
+                                         enum snd_motu_clock_source *src)
 {
        __be32 reg;
        int err;
@@ -136,7 +170,8 @@ static int v2_get_clock_source(struct snd_motu *motu,
        return get_clock_source(motu, be32_to_cpu(reg), src);
 }
 
-static int v2_switch_fetching_mode(struct snd_motu *motu, bool enable)
+int snd_motu_protocol_v2_switch_fetching_mode(struct snd_motu *motu,
+                                             bool enable)
 {
        enum snd_motu_clock_source src;
        __be32 reg;
@@ -161,7 +196,7 @@ static int v2_switch_fetching_mode(struct snd_motu *motu, bool enable)
        if (enable)
                data |= V2_CLOCK_FETCH_ENABLE;
 
-       if (motu->spec->flags & SND_MOTU_SPEC_SUPPORT_CLOCK_X4) {
+       if (motu->spec == &snd_motu_spec_traveler) {
                // Expected for Traveler and 896HD, which implements Altera
                // Cyclone EP1C3.
                data |= V2_CLOCK_MODEL_SPECIFIC;
@@ -183,120 +218,124 @@ static int v2_switch_fetching_mode(struct snd_motu *motu, bool enable)
                                          sizeof(reg));
 }
 
-static void calculate_fixed_part(struct snd_motu_packet_format *formats,
-                                enum amdtp_stream_direction dir,
-                                enum snd_motu_spec_flags flags,
-                                unsigned char analog_ports)
+static int detect_packet_formats_828mk2(struct snd_motu *motu, u32 data)
 {
-       unsigned char pcm_chunks[3] = {0, 0, 0};
-
-       formats->msg_chunks = 2;
-
-       pcm_chunks[0] = analog_ports;
-       pcm_chunks[1] = analog_ports;
-       if (flags & SND_MOTU_SPEC_SUPPORT_CLOCK_X4)
-               pcm_chunks[2] = analog_ports;
-
-       if (dir == AMDTP_IN_STREAM) {
-               if (flags & SND_MOTU_SPEC_TX_MICINST_CHUNK) {
-                       pcm_chunks[0] += 2;
-                       pcm_chunks[1] += 2;
-               }
-               if (flags & SND_MOTU_SPEC_TX_RETURN_CHUNK) {
-                       pcm_chunks[0] += 2;
-                       pcm_chunks[1] += 2;
-               }
-       } else {
-               if (flags & SND_MOTU_SPEC_RX_SEPARATED_MAIN) {
-                       pcm_chunks[0] += 2;
-                       pcm_chunks[1] += 2;
-               }
-
-               // Packets to v2 units include 2 chunks for phone 1/2, except
-               // for 176.4/192.0 kHz.
-               pcm_chunks[0] += 2;
-               pcm_chunks[1] += 2;
+       if (((data & V2_OPT_IN_IFACE_MASK) >> V2_OPT_IN_IFACE_SHIFT) ==
+           V2_OPT_IFACE_MODE_ADAT) {
+               motu->tx_packet_formats.pcm_chunks[0] += 8;
+               motu->tx_packet_formats.pcm_chunks[1] += 4;
        }
 
-       if (flags & SND_MOTU_SPEC_HAS_AESEBU_IFACE) {
-               pcm_chunks[0] += 2;
-               pcm_chunks[1] += 2;
+       if (((data & V2_OPT_OUT_IFACE_MASK) >> V2_OPT_OUT_IFACE_SHIFT) ==
+           V2_OPT_IFACE_MODE_ADAT) {
+               motu->rx_packet_formats.pcm_chunks[0] += 8;
+               motu->rx_packet_formats.pcm_chunks[1] += 4;
        }
 
-       /*
-        * All of v2 models have a pair of coaxial interfaces for digital in/out
-        * port. At 44.1/48.0/88.2/96.0 kHz, packets includes PCM from these
-        * ports.
-        */
-       pcm_chunks[0] += 2;
-       pcm_chunks[1] += 2;
-
-       formats->fixed_part_pcm_chunks[0] = pcm_chunks[0];
-       formats->fixed_part_pcm_chunks[1] = pcm_chunks[1];
-       formats->fixed_part_pcm_chunks[2] = pcm_chunks[2];
+       return 0;
 }
 
-static void calculate_differed_part(struct snd_motu_packet_format *formats,
-                                   enum snd_motu_spec_flags flags,
-                                   u32 data, u32 mask, u32 shift)
+static int detect_packet_formats_traveler(struct snd_motu *motu, u32 data)
 {
-       unsigned char pcm_chunks[2] = {0, 0};
-
-       /*
-        * When optical interfaces are configured for S/PDIF (TOSLINK),
-        * the above PCM frames come from them, instead of coaxial
-        * interfaces.
-        */
-       data = (data & mask) >> shift;
-       if (data == V2_OPT_IFACE_MODE_ADAT) {
-               if (flags & SND_MOTU_SPEC_HAS_OPT_IFACE_A) {
-                       pcm_chunks[0] += 8;
-                       pcm_chunks[1] += 4;
-               }
-               // 8pre has two sets of optical interface and doesn't reduce
-               // chunks for ADAT signals.
-               if (flags & SND_MOTU_SPEC_HAS_OPT_IFACE_B) {
-                       pcm_chunks[1] += 4;
-               }
+       if (((data & V2_OPT_IN_IFACE_MASK) >> V2_OPT_IN_IFACE_SHIFT) ==
+           V2_OPT_IFACE_MODE_ADAT) {
+               motu->tx_packet_formats.pcm_chunks[0] += 8;
+               motu->tx_packet_formats.pcm_chunks[1] += 4;
+       }
+
+       if (((data & V2_OPT_OUT_IFACE_MASK) >> V2_OPT_OUT_IFACE_SHIFT) ==
+           V2_OPT_IFACE_MODE_ADAT) {
+               motu->rx_packet_formats.pcm_chunks[0] += 8;
+               motu->rx_packet_formats.pcm_chunks[1] += 4;
        }
 
-       /* At mode x4, no data chunks are supported in this part. */
-       formats->differed_part_pcm_chunks[0] = pcm_chunks[0];
-       formats->differed_part_pcm_chunks[1] = pcm_chunks[1];
+       return 0;
 }
 
-static int v2_cache_packet_formats(struct snd_motu *motu)
+static int detect_packet_formats_8pre(struct snd_motu *motu, u32 data)
+{
+       if (((data & V2_OPT_IN_IFACE_MASK) >> V2_OPT_IN_IFACE_SHIFT) ==
+           V2_OPT_IFACE_MODE_ADAT) {
+               motu->tx_packet_formats.pcm_chunks[0] += 8;
+               motu->tx_packet_formats.pcm_chunks[1] += 8;
+       }
+
+       if (((data & V2_OPT_OUT_IFACE_MASK) >> V2_OPT_OUT_IFACE_SHIFT) ==
+           V2_OPT_IFACE_MODE_ADAT) {
+               motu->rx_packet_formats.pcm_chunks[0] += 8;
+               motu->rx_packet_formats.pcm_chunks[1] += 8;
+       }
+
+       return 0;
+}
+
+int snd_motu_protocol_v2_cache_packet_formats(struct snd_motu *motu)
 {
        __be32 reg;
        u32 data;
        int err;
 
+       motu->tx_packet_formats.pcm_byte_offset = 10;
+       motu->rx_packet_formats.pcm_byte_offset = 10;
+
+       motu->tx_packet_formats.msg_chunks = 2;
+       motu->rx_packet_formats.msg_chunks = 2;
+
        err = snd_motu_transaction_read(motu, V2_IN_OUT_CONF_OFFSET, &reg,
                                        sizeof(reg));
        if (err < 0)
                return err;
        data = be32_to_cpu(reg);
 
-       calculate_fixed_part(&motu->tx_packet_formats, AMDTP_IN_STREAM,
-                            motu->spec->flags, motu->spec->analog_in_ports);
-       calculate_differed_part(&motu->tx_packet_formats, motu->spec->flags,
-                       data, V2_OPT_IN_IFACE_MASK, V2_OPT_IN_IFACE_SHIFT);
+       memcpy(motu->tx_packet_formats.pcm_chunks,
+              motu->spec->tx_fixed_pcm_chunks,
+              sizeof(motu->tx_packet_formats.pcm_chunks));
+       memcpy(motu->rx_packet_formats.pcm_chunks,
+              motu->spec->rx_fixed_pcm_chunks,
+              sizeof(motu->rx_packet_formats.pcm_chunks));
 
-       calculate_fixed_part(&motu->rx_packet_formats, AMDTP_OUT_STREAM,
-                            motu->spec->flags, motu->spec->analog_out_ports);
-       calculate_differed_part(&motu->rx_packet_formats, motu->spec->flags,
-                       data, V2_OPT_OUT_IFACE_MASK, V2_OPT_OUT_IFACE_SHIFT);
+       if (motu->spec == &snd_motu_spec_828mk2)
+               return detect_packet_formats_828mk2(motu, data);
+       else if (motu->spec == &snd_motu_spec_traveler)
+               return detect_packet_formats_traveler(motu, data);
+       else if (motu->spec == &snd_motu_spec_8pre)
+               return detect_packet_formats_8pre(motu, data);
+       else
+               return 0;
+}
 
-       motu->tx_packet_formats.pcm_byte_offset = 10;
-       motu->rx_packet_formats.pcm_byte_offset = 10;
+const struct snd_motu_spec snd_motu_spec_828mk2 = {
+       .name = "828mk2",
+       .protocol_version = SND_MOTU_PROTOCOL_V2,
+       .flags = SND_MOTU_SPEC_RX_MIDI_2ND_Q |
+                SND_MOTU_SPEC_TX_MIDI_2ND_Q,
+       .tx_fixed_pcm_chunks = {14, 14, 0},
+       .rx_fixed_pcm_chunks = {14, 14, 0},
+};
 
-       return 0;
-}
+const struct snd_motu_spec snd_motu_spec_traveler = {
+       .name = "Traveler",
+       .protocol_version = SND_MOTU_PROTOCOL_V2,
+       .flags = SND_MOTU_SPEC_RX_MIDI_2ND_Q |
+                SND_MOTU_SPEC_TX_MIDI_2ND_Q,
+       .tx_fixed_pcm_chunks = {14, 14, 8},
+       .rx_fixed_pcm_chunks = {14, 14, 8},
+};
+
+const struct snd_motu_spec snd_motu_spec_ultralite = {
+       .name = "UltraLite",
+       .protocol_version = SND_MOTU_PROTOCOL_V2,
+       .flags = SND_MOTU_SPEC_RX_MIDI_2ND_Q |
+                SND_MOTU_SPEC_TX_MIDI_2ND_Q,
+       .tx_fixed_pcm_chunks = {14, 14, 0},
+       .rx_fixed_pcm_chunks = {14, 14, 0},
+};
 
-const struct snd_motu_protocol snd_motu_protocol_v2 = {
-       .get_clock_rate         = v2_get_clock_rate,
-       .set_clock_rate         = v2_set_clock_rate,
-       .get_clock_source       = v2_get_clock_source,
-       .switch_fetching_mode   = v2_switch_fetching_mode,
-       .cache_packet_formats   = v2_cache_packet_formats,
+const struct snd_motu_spec snd_motu_spec_8pre = {
+       .name = "8pre",
+       .protocol_version = SND_MOTU_PROTOCOL_V2,
+       .flags = SND_MOTU_SPEC_RX_MIDI_2ND_Q |
+                SND_MOTU_SPEC_TX_MIDI_2ND_Q,
+       .tx_fixed_pcm_chunks = {10, 6, 0},
+       .rx_fixed_pcm_chunks = {10, 6, 0},
 };