mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-12 21:57:43 +00:00
4641c93940
MOTU FireWire series uses blocking transmission for AMDTP packet streaming. They transmit/receive 8,000 packets per second, to handle the same number of data blocks as current sampling transmission frequency. Thus, IEC 61883-1/6 packet streaming engine of ALSA firewire stack is available for them. However, the sequence of packet and data blocks includes some quirks. Below sample is a sequence of CIP headers of packets received by 828mk2, at 44.1kHz of sampling transmission frequency. quads CIP1 CIP2 488 0x020F04E8 0x8222FFFF 8 0x020F04F8 0x8222FFFF 488 0x020F0400 0x8222FFFF 488 0x020F0408 0x8222FFFF 8 0x020F04E8 0x8222FFFF 488 0x020F04F0 0x8222FFFF 488 0x020F04F8 0x8222FFFF The SID (source node ID), DBS (data block size), SPH (source packet header), FMT (format ID), FDF (format dependent field) and SYT (time stamp) fields are in IEC 61883-1. Especially, FMT is 0x02, FDF is 0x22 and SYT is 0xffff to define MOTU specific protocol. In an aspect of dbc field, the value represents accumulated number of data blocks included the packet. This is against IEC 61883-1, because according to the specification this value should be the number of data blocks already transferred. In ALSA IEC 61883-1/6 engine, this quirk is already supported by CIP_DBC_IS_END_EVENT flag, because Echo Audio Fireworks has. Each data block includes SPH as its first quadlet field, to represent its presentation time stamp. Actual value of SPH is compliant to IEC 61883-1; lower 25 bits of 32 bits width consists of 13 bits cycle count and 12 bits cycle offset. The rest of each data block consists of 24 bit chunks. All of PCM samples, MIDI messages, status and control messages are transferred by the chunks. This is similar to '24-bit * 4 Audio Pack' in IEC 61883-6. The position of each kind of data depends on generations of each model. The number of whole chunks in a data block is a multiple of 4, to consists of quadlet-aligned packets. This commit adds data block processing layer specific for the MOTU protocol. The remarkable point is the way to generate SPH header. Time stamps for each data blocks are generated by below calculation: * Using pre-computed table for the number of ticks per event * 44,1kHz: (557 + 123/441) * 48.0kHz: (512 + 0/441) * 88.2kHz: (278 + 282/441) * 96.0kHz: (256 + 0/441) * 176.4kHz: (139 + 141/441) * 192.0kHz: (128 + 0/441) * Accumulate the ticks and set the value to SPH for every events. * This way makes sense only for blocking transmission because this mode transfers fixed number or none of events. This calculation assumes that each data block has a PCM frame which is sampled according to event timing clock. Current packet streaming layer has the same assumption. Although this sequence works fine for MOTU FireWire series at sampling transmission frequency based on 48.0kHz, it is not enough at the frequency based on 44.1kHz. The units generate choppy noise every few seconds. Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp> Signed-off-by: Takashi Iwai <tiwai@suse.de>
109 lines
3.1 KiB
C
109 lines
3.1 KiB
C
/*
|
|
* motu.h - a part of driver for MOTU FireWire series
|
|
*
|
|
* Copyright (c) 2015-2017 Takashi Sakamoto <o-takashi@sakamocchi.jp>
|
|
*
|
|
* Licensed under the terms of the GNU General Public License, version 2.
|
|
*/
|
|
|
|
#ifndef SOUND_FIREWIRE_MOTU_H_INCLUDED
|
|
#define SOUND_FIREWIRE_MOTU_H_INCLUDED
|
|
|
|
#include <linux/device.h>
|
|
#include <linux/firewire.h>
|
|
#include <linux/firewire-constants.h>
|
|
#include <linux/module.h>
|
|
#include <linux/mod_devicetable.h>
|
|
#include <linux/mutex.h>
|
|
#include <linux/slab.h>
|
|
|
|
#include <sound/control.h>
|
|
#include <sound/core.h>
|
|
#include <sound/pcm.h>
|
|
|
|
#include "../lib.h"
|
|
#include "../amdtp-stream.h"
|
|
|
|
struct snd_motu_packet_format {
|
|
unsigned char pcm_byte_offset;
|
|
|
|
unsigned char msg_chunks;
|
|
unsigned char fixed_part_pcm_chunks[3];
|
|
unsigned char differed_part_pcm_chunks[3];
|
|
};
|
|
|
|
struct snd_motu {
|
|
struct snd_card *card;
|
|
struct fw_unit *unit;
|
|
struct mutex mutex;
|
|
|
|
bool registered;
|
|
struct delayed_work dwork;
|
|
|
|
/* Model dependent information. */
|
|
const struct snd_motu_spec *spec;
|
|
|
|
/* For packet streaming */
|
|
struct snd_motu_packet_format tx_packet_formats;
|
|
struct snd_motu_packet_format rx_packet_formats;
|
|
struct amdtp_stream tx_stream;
|
|
struct amdtp_stream rx_stream;
|
|
};
|
|
|
|
enum snd_motu_spec_flags {
|
|
SND_MOTU_SPEC_SUPPORT_CLOCK_X2 = 0x0001,
|
|
SND_MOTU_SPEC_SUPPORT_CLOCK_X4 = 0x0002,
|
|
SND_MOTU_SPEC_TX_MICINST_CHUNK = 0x0004,
|
|
SND_MOTU_SPEC_TX_RETURN_CHUNK = 0x0008,
|
|
SND_MOTU_SPEC_TX_REVERB_CHUNK = 0x0010,
|
|
SND_MOTU_SPEC_TX_AESEBU_CHUNK = 0x0020,
|
|
SND_MOTU_SPEC_HAS_OPT_IFACE_A = 0x0040,
|
|
SND_MOTU_SPEC_HAS_OPT_IFACE_B = 0x0080,
|
|
SND_MOTU_SPEC_HAS_MIDI = 0x0100,
|
|
};
|
|
|
|
#define SND_MOTU_CLOCK_RATE_COUNT 6
|
|
extern const unsigned int snd_motu_clock_rates[SND_MOTU_CLOCK_RATE_COUNT];
|
|
|
|
enum snd_motu_clock_source {
|
|
SND_MOTU_CLOCK_SOURCE_INTERNAL,
|
|
SND_MOTU_CLOCK_SOURCE_ADAT_ON_DSUB,
|
|
SND_MOTU_CLOCK_SOURCE_ADAT_ON_OPT,
|
|
SND_MOTU_CLOCK_SOURCE_ADAT_ON_OPT_A,
|
|
SND_MOTU_CLOCK_SOURCE_ADAT_ON_OPT_B,
|
|
SND_MOTU_CLOCK_SOURCE_SPDIF_ON_OPT,
|
|
SND_MOTU_CLOCK_SOURCE_SPDIF_ON_OPT_A,
|
|
SND_MOTU_CLOCK_SOURCE_SPDIF_ON_OPT_B,
|
|
SND_MOTU_CLOCK_SOURCE_SPDIF_ON_COAX,
|
|
SND_MOTU_CLOCK_SOURCE_AESEBU_ON_XLR,
|
|
SND_MOTU_CLOCK_SOURCE_WORD_ON_BNC,
|
|
SND_MOTU_CLOCK_SOURCE_UNKNOWN,
|
|
};
|
|
|
|
struct snd_motu_protocol {
|
|
int (*get_clock_rate)(struct snd_motu *motu, unsigned int *rate);
|
|
int (*set_clock_rate)(struct snd_motu *motu, unsigned int rate);
|
|
int (*get_clock_source)(struct snd_motu *motu,
|
|
enum snd_motu_clock_source *source);
|
|
int (*switch_fetching_mode)(struct snd_motu *motu, bool enable);
|
|
int (*cache_packet_formats)(struct snd_motu *motu);
|
|
};
|
|
|
|
struct snd_motu_spec {
|
|
const char *const name;
|
|
enum snd_motu_spec_flags flags;
|
|
|
|
unsigned char analog_in_ports;
|
|
unsigned char analog_out_ports;
|
|
|
|
const struct snd_motu_protocol *const protocol;
|
|
};
|
|
|
|
int amdtp_motu_init(struct amdtp_stream *s, struct fw_unit *unit,
|
|
enum amdtp_stream_direction dir,
|
|
const struct snd_motu_protocol *const protocol);
|
|
int amdtp_motu_set_parameters(struct amdtp_stream *s, unsigned int rate,
|
|
struct snd_motu_packet_format *formats);
|
|
int amdtp_motu_add_pcm_hw_constraints(struct amdtp_stream *s,
|
|
struct snd_pcm_runtime *runtime);
|
|
#endif
|