UltraLite-mk3 was shipped 2008 by MOTU. This model has two lineups;
FireWire-only and FireWire/USB2.0 Hybrid model. Additionally, the latter
has two variants in respect of the type of IEEE 1394 connector; alpha
and beta connector.
This commit adds support for the FireWire-only model, which is already
discontinued.
$ python3 crpp < /sys/bus/firewire/devices/fw1/config_rom
               ROM header and bus information block
               -----------------------------------------------------------------
400  0410353a  bus_info_length 4, crc_length 16, crc 13626
404  31333934  bus_name "1394"
408  20ff7000  irmc 0, cmc 0, isc 1, bmc 0, cyc_clk_acc 255, max_rec 7 (256)
40c  0001f200  company_id 0001f2     |
410  000902c7  device_id 00000902c7  | EUI-64 0001f200000902c7
               root directory
               -----------------------------------------------------------------
414  0004ef04  directory_length 4, crc 61188
418  030001f2  vendor
41c  0c0083c0  node capabilities per IEEE 1394
420  d1000002  --> unit directory at 428
424  8d000005  --> eui-64 leaf at 438
               unit directory at 428
               -----------------------------------------------------------------
428  00035556  directory_length 3, crc 21846
42c  120001f2  specifier id
430  13000019  version
434  17100800  model
               eui-64 leaf at 438
               -----------------------------------------------------------------
438  0002f3c5  leaf_length 2, crc 62405
43c  0001f200  company_id 0001f2     |
440  000902c7  device_id 00000902c7  | EUI-64 0001f200000902c7
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Link: https://lore.kernel.org/r/20200523071733.170129-1-o-takashi@sakamocchi.jp
Signed-off-by: Takashi Iwai <tiwai@suse.de>
		
	
			
		
			
				
	
	
		
			238 lines
		
	
	
		
			7.5 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			238 lines
		
	
	
		
			7.5 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /* SPDX-License-Identifier: GPL-2.0-only */
 | |
| /*
 | |
|  * motu.h - a part of driver for MOTU FireWire series
 | |
|  *
 | |
|  * Copyright (c) 2015-2017 Takashi Sakamoto <o-takashi@sakamocchi.jp>
 | |
|  */
 | |
| 
 | |
| #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 <linux/compat.h>
 | |
| #include <linux/sched/signal.h>
 | |
| 
 | |
| #include <sound/control.h>
 | |
| #include <sound/core.h>
 | |
| #include <sound/pcm.h>
 | |
| #include <sound/info.h>
 | |
| #include <sound/rawmidi.h>
 | |
| #include <sound/firewire.h>
 | |
| #include <sound/hwdep.h>
 | |
| 
 | |
| #include "../lib.h"
 | |
| #include "../amdtp-stream.h"
 | |
| #include "../iso-resources.h"
 | |
| 
 | |
| struct snd_motu_packet_format {
 | |
| 	unsigned char midi_flag_offset;
 | |
| 	unsigned char midi_byte_offset;
 | |
| 	unsigned char pcm_byte_offset;
 | |
| 
 | |
| 	unsigned char msg_chunks;
 | |
| 	unsigned char pcm_chunks[3];
 | |
| };
 | |
| 
 | |
| struct snd_motu {
 | |
| 	struct snd_card *card;
 | |
| 	struct fw_unit *unit;
 | |
| 	struct mutex mutex;
 | |
| 	spinlock_t lock;
 | |
| 
 | |
| 	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;
 | |
| 	struct fw_iso_resources tx_resources;
 | |
| 	struct fw_iso_resources rx_resources;
 | |
| 	unsigned int substreams_counter;
 | |
| 
 | |
| 	/* For notification. */
 | |
| 	struct fw_address_handler async_handler;
 | |
| 	u32 msg;
 | |
| 
 | |
| 	/* For uapi */
 | |
| 	int dev_lock_count;
 | |
| 	bool dev_lock_changed;
 | |
| 	wait_queue_head_t hwdep_wait;
 | |
| 
 | |
| 	struct amdtp_domain domain;
 | |
| };
 | |
| 
 | |
| enum snd_motu_spec_flags {
 | |
| 	SND_MOTU_SPEC_RX_MIDI_2ND_Q	= 0x0001,
 | |
| 	SND_MOTU_SPEC_RX_MIDI_3RD_Q	= 0x0002,
 | |
| 	SND_MOTU_SPEC_TX_MIDI_2ND_Q	= 0x0004,
 | |
| 	SND_MOTU_SPEC_TX_MIDI_3RD_Q	= 0x0008,
 | |
| };
 | |
| 
 | |
| #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_SPH,
 | |
| 	SND_MOTU_CLOCK_SOURCE_UNKNOWN,
 | |
| };
 | |
| 
 | |
| enum snd_motu_protocol_version {
 | |
| 	SND_MOTU_PROTOCOL_V2,
 | |
| 	SND_MOTU_PROTOCOL_V3,
 | |
| };
 | |
| 
 | |
| struct snd_motu_spec {
 | |
| 	const char *const name;
 | |
| 	enum snd_motu_protocol_version protocol_version;
 | |
| 	enum snd_motu_spec_flags flags;
 | |
| 
 | |
| 	unsigned char tx_fixed_pcm_chunks[3];
 | |
| 	unsigned char rx_fixed_pcm_chunks[3];
 | |
| };
 | |
| 
 | |
| extern const struct snd_motu_spec snd_motu_spec_828mk2;
 | |
| extern const struct snd_motu_spec snd_motu_spec_traveler;
 | |
| extern const struct snd_motu_spec snd_motu_spec_ultralite;
 | |
| extern const struct snd_motu_spec snd_motu_spec_8pre;
 | |
| 
 | |
| extern const struct snd_motu_spec snd_motu_spec_828mk3;
 | |
| extern const struct snd_motu_spec snd_motu_spec_ultralite_mk3;
 | |
| extern const struct snd_motu_spec snd_motu_spec_audio_express;
 | |
| extern const struct snd_motu_spec snd_motu_spec_4pre;
 | |
| 
 | |
| int amdtp_motu_init(struct amdtp_stream *s, struct fw_unit *unit,
 | |
| 		    enum amdtp_stream_direction dir,
 | |
| 		    const struct snd_motu_spec *spec);
 | |
| int amdtp_motu_set_parameters(struct amdtp_stream *s, unsigned int rate,
 | |
| 			      unsigned int midi_ports,
 | |
| 			      struct snd_motu_packet_format *formats);
 | |
| int amdtp_motu_add_pcm_hw_constraints(struct amdtp_stream *s,
 | |
| 				      struct snd_pcm_runtime *runtime);
 | |
| void amdtp_motu_midi_trigger(struct amdtp_stream *s, unsigned int port,
 | |
| 			     struct snd_rawmidi_substream *midi);
 | |
| 
 | |
| int snd_motu_transaction_read(struct snd_motu *motu, u32 offset, __be32 *reg,
 | |
| 			      size_t size);
 | |
| int snd_motu_transaction_write(struct snd_motu *motu, u32 offset, __be32 *reg,
 | |
| 			       size_t size);
 | |
| int snd_motu_transaction_register(struct snd_motu *motu);
 | |
| int snd_motu_transaction_reregister(struct snd_motu *motu);
 | |
| void snd_motu_transaction_unregister(struct snd_motu *motu);
 | |
| 
 | |
| int snd_motu_stream_init_duplex(struct snd_motu *motu);
 | |
| void snd_motu_stream_destroy_duplex(struct snd_motu *motu);
 | |
| int snd_motu_stream_cache_packet_formats(struct snd_motu *motu);
 | |
| int snd_motu_stream_reserve_duplex(struct snd_motu *motu, unsigned int rate,
 | |
| 				   unsigned int frames_per_period,
 | |
| 				   unsigned int frames_per_buffer);
 | |
| int snd_motu_stream_start_duplex(struct snd_motu *motu);
 | |
| void snd_motu_stream_stop_duplex(struct snd_motu *motu);
 | |
| int snd_motu_stream_lock_try(struct snd_motu *motu);
 | |
| void snd_motu_stream_lock_release(struct snd_motu *motu);
 | |
| 
 | |
| void snd_motu_proc_init(struct snd_motu *motu);
 | |
| 
 | |
| int snd_motu_create_pcm_devices(struct snd_motu *motu);
 | |
| 
 | |
| int snd_motu_create_midi_devices(struct snd_motu *motu);
 | |
| 
 | |
| int snd_motu_create_hwdep_device(struct snd_motu *motu);
 | |
| 
 | |
| int snd_motu_protocol_v2_get_clock_rate(struct snd_motu *motu,
 | |
| 					unsigned int *rate);
 | |
| int snd_motu_protocol_v2_set_clock_rate(struct snd_motu *motu,
 | |
| 					unsigned int rate);
 | |
| int snd_motu_protocol_v2_get_clock_source(struct snd_motu *motu,
 | |
| 					  enum snd_motu_clock_source *src);
 | |
| int snd_motu_protocol_v2_switch_fetching_mode(struct snd_motu *motu,
 | |
| 					      bool enable);
 | |
| int snd_motu_protocol_v2_cache_packet_formats(struct snd_motu *motu);
 | |
| 
 | |
| int snd_motu_protocol_v3_get_clock_rate(struct snd_motu *motu,
 | |
| 					unsigned int *rate);
 | |
| int snd_motu_protocol_v3_set_clock_rate(struct snd_motu *motu,
 | |
| 					unsigned int rate);
 | |
| int snd_motu_protocol_v3_get_clock_source(struct snd_motu *motu,
 | |
| 					  enum snd_motu_clock_source *src);
 | |
| int snd_motu_protocol_v3_switch_fetching_mode(struct snd_motu *motu,
 | |
| 					      bool enable);
 | |
| int snd_motu_protocol_v3_cache_packet_formats(struct snd_motu *motu);
 | |
| 
 | |
| static inline int snd_motu_protocol_get_clock_rate(struct snd_motu *motu,
 | |
| 						   unsigned int *rate)
 | |
| {
 | |
| 	if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V2)
 | |
| 		return snd_motu_protocol_v2_get_clock_rate(motu, rate);
 | |
| 	else if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V3)
 | |
| 		return snd_motu_protocol_v3_get_clock_rate(motu, rate);
 | |
| 	else
 | |
| 		return -ENXIO;
 | |
| }
 | |
| 
 | |
| static inline int snd_motu_protocol_set_clock_rate(struct snd_motu *motu,
 | |
| 						   unsigned int rate)
 | |
| {
 | |
| 	if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V2)
 | |
| 		return snd_motu_protocol_v2_set_clock_rate(motu, rate);
 | |
| 	else if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V3)
 | |
| 		return snd_motu_protocol_v3_set_clock_rate(motu, rate);
 | |
| 	else
 | |
| 		return -ENXIO;
 | |
| }
 | |
| 
 | |
| static inline int snd_motu_protocol_get_clock_source(struct snd_motu *motu,
 | |
| 					enum snd_motu_clock_source *source)
 | |
| {
 | |
| 	if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V2)
 | |
| 		return snd_motu_protocol_v2_get_clock_source(motu, source);
 | |
| 	else if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V3)
 | |
| 		return snd_motu_protocol_v3_get_clock_source(motu, source);
 | |
| 	else
 | |
| 		return -ENXIO;
 | |
| }
 | |
| 
 | |
| static inline int snd_motu_protocol_switch_fetching_mode(struct snd_motu *motu,
 | |
| 							 bool enable)
 | |
| {
 | |
| 	if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V2)
 | |
| 		return snd_motu_protocol_v2_switch_fetching_mode(motu, enable);
 | |
| 	else if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V3)
 | |
| 		return snd_motu_protocol_v3_switch_fetching_mode(motu, enable);
 | |
| 	else
 | |
| 		return -ENXIO;
 | |
| }
 | |
| 
 | |
| static inline int snd_motu_protocol_cache_packet_formats(struct snd_motu *motu)
 | |
| {
 | |
| 	if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V2)
 | |
| 		return snd_motu_protocol_v2_cache_packet_formats(motu);
 | |
| 	else if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V3)
 | |
| 		return snd_motu_protocol_v3_cache_packet_formats(motu);
 | |
| 	else
 | |
| 		return -ENXIO;
 | |
| }
 | |
| 
 | |
| #endif
 |