[linux-2.6-block.git] / sound / firewire / motu / motu.h

/* 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 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;
	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_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_HAS_AESEBU_IFACE	= 0x0020,
	SND_MOTU_SPEC_HAS_OPT_IFACE_A	= 0x0040,
	SND_MOTU_SPEC_HAS_OPT_IFACE_B	= 0x0080,
	SND_MOTU_SPEC_RX_MIDI_2ND_Q	= 0x0100,
	SND_MOTU_SPEC_RX_MIDI_3RD_Q	= 0x0200,
	SND_MOTU_SPEC_TX_MIDI_2ND_Q	= 0x0400,
	SND_MOTU_SPEC_TX_MIDI_3RD_Q	= 0x0800,
	SND_MOTU_SPEC_RX_SEPARETED_MAIN	= 0x1000,
};

#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;
};

extern const struct snd_motu_protocol snd_motu_protocol_v2;
extern const struct snd_motu_protocol snd_motu_protocol_v3;

extern const struct snd_motu_spec snd_motu_spec_traveler;
extern const struct snd_motu_spec snd_motu_spec_8pre;

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,
			      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);
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);
#endif
Commit	Line	Data
da607e19	1	/* SPDX-License-Identifier: GPL-2.0-only */
6c3cef48 TS	2	/*
	3	* motu.h - a part of driver for MOTU FireWire series
	4	*
	5	* Copyright (c) 2015-2017 Takashi Sakamoto <o-takashi@sakamocchi.jp>
6c3cef48 TS	6	*/
	7
	8	#ifndef SOUND_FIREWIRE_MOTU_H_INCLUDED
	9	#define SOUND_FIREWIRE_MOTU_H_INCLUDED
	10
	11	#include <linux/device.h>
	12	#include <linux/firewire.h>
	13	#include <linux/firewire-constants.h>
	14	#include <linux/module.h>
	15	#include <linux/mod_devicetable.h>
	16	#include <linux/mutex.h>
	17	#include <linux/slab.h>
71c37977 TS	18	#include <linux/compat.h>
71c37977 TS	19	#include <linux/sched/signal.h>
6c3cef48 TS	20
	21	#include <sound/control.h>
	22	#include <sound/core.h>
4641c939	23	#include <sound/pcm.h>
4638ec6e	24	#include <sound/info.h>
9e796e7d	25	#include <sound/rawmidi.h>
71c37977 TS	26	#include <sound/firewire.h>
71c37977 TS	27	#include <sound/hwdep.h>
6c3cef48	28
8865a31e	29	#include "../lib.h"
4641c939	30	#include "../amdtp-stream.h"
9b2bb4f2	31	#include "../iso-resources.h"
8865a31e	32
59f6482c	33	struct snd_motu_packet_format {
9e796e7d TS	34	unsigned char midi_flag_offset;
9e796e7d TS	35	unsigned char midi_byte_offset;
59f6482c TS	36	unsigned char pcm_byte_offset;
	37
	38	unsigned char msg_chunks;
	39	unsigned char fixed_part_pcm_chunks[3];
	40	unsigned char differed_part_pcm_chunks[3];
	41	};
	42
6c3cef48 TS	43	struct snd_motu {
	44	struct snd_card *card;
	45	struct fw_unit *unit;
	46	struct mutex mutex;
9e796e7d	47	spinlock_t lock;
8865a31e TS	48
	49	bool registered;
	50	struct delayed_work dwork;
5e03c33e TS	51
	52	/* Model dependent information. */
	53	const struct snd_motu_spec *spec;
59f6482c TS	54
	55	/* For packet streaming */
	56	struct snd_motu_packet_format tx_packet_formats;
	57	struct snd_motu_packet_format rx_packet_formats;
4641c939 TS	58	struct amdtp_stream tx_stream;
4641c939 TS	59	struct amdtp_stream rx_stream;
9b2bb4f2 TS	60	struct fw_iso_resources tx_resources;
9b2bb4f2 TS	61	struct fw_iso_resources rx_resources;
18f26034	62	unsigned int substreams_counter;
2e76701b TS	63
	64	/* For notification. */
	65	struct fw_address_handler async_handler;
	66	u32 msg;
71c37977 TS	67
	68	/* For uapi */
	69	int dev_lock_count;
	70	bool dev_lock_changed;
	71	wait_queue_head_t hwdep_wait;
ccc6c1b0 TS	72
ccc6c1b0 TS	73	struct amdtp_domain domain;
5e03c33e TS	74	};
	75
	76	enum snd_motu_spec_flags {
	77	SND_MOTU_SPEC_SUPPORT_CLOCK_X2 = 0x0001,
	78	SND_MOTU_SPEC_SUPPORT_CLOCK_X4 = 0x0002,
	79	SND_MOTU_SPEC_TX_MICINST_CHUNK = 0x0004,
	80	SND_MOTU_SPEC_TX_RETURN_CHUNK = 0x0008,
	81	SND_MOTU_SPEC_TX_REVERB_CHUNK = 0x0010,
06ac0b6f	82	SND_MOTU_SPEC_HAS_AESEBU_IFACE = 0x0020,
5e03c33e TS	83	SND_MOTU_SPEC_HAS_OPT_IFACE_A = 0x0040,
5e03c33e TS	84	SND_MOTU_SPEC_HAS_OPT_IFACE_B = 0x0080,
8b460c76 TS	85	SND_MOTU_SPEC_RX_MIDI_2ND_Q = 0x0100,
	86	SND_MOTU_SPEC_RX_MIDI_3RD_Q = 0x0200,
	87	SND_MOTU_SPEC_TX_MIDI_2ND_Q = 0x0400,
	88	SND_MOTU_SPEC_TX_MIDI_3RD_Q = 0x0800,
81720c6d	89	SND_MOTU_SPEC_RX_SEPARETED_MAIN = 0x1000,
5e03c33e TS	90	};
5e03c33e TS	91
59f6482c TS	92	#define SND_MOTU_CLOCK_RATE_COUNT 6
	93	extern const unsigned int snd_motu_clock_rates[SND_MOTU_CLOCK_RATE_COUNT];
	94
	95	enum snd_motu_clock_source {
	96	SND_MOTU_CLOCK_SOURCE_INTERNAL,
	97	SND_MOTU_CLOCK_SOURCE_ADAT_ON_DSUB,
	98	SND_MOTU_CLOCK_SOURCE_ADAT_ON_OPT,
	99	SND_MOTU_CLOCK_SOURCE_ADAT_ON_OPT_A,
	100	SND_MOTU_CLOCK_SOURCE_ADAT_ON_OPT_B,
	101	SND_MOTU_CLOCK_SOURCE_SPDIF_ON_OPT,
	102	SND_MOTU_CLOCK_SOURCE_SPDIF_ON_OPT_A,
	103	SND_MOTU_CLOCK_SOURCE_SPDIF_ON_OPT_B,
	104	SND_MOTU_CLOCK_SOURCE_SPDIF_ON_COAX,
	105	SND_MOTU_CLOCK_SOURCE_AESEBU_ON_XLR,
	106	SND_MOTU_CLOCK_SOURCE_WORD_ON_BNC,
	107	SND_MOTU_CLOCK_SOURCE_UNKNOWN,
	108	};
	109
	110	struct snd_motu_protocol {
	111	int (get_clock_rate)(struct snd_motu motu, unsigned int *rate);
	112	int (set_clock_rate)(struct snd_motu motu, unsigned int rate);
	113	int (get_clock_source)(struct snd_motu motu,
	114	enum snd_motu_clock_source *source);
	115	int (switch_fetching_mode)(struct snd_motu motu, bool enable);
	116	int (cache_packet_formats)(struct snd_motu motu);
	117	};
	118
5e03c33e TS	119	struct snd_motu_spec {
	120	const char *const name;
	121	enum snd_motu_spec_flags flags;
	122
	123	unsigned char analog_in_ports;
	124	unsigned char analog_out_ports;
59f6482c TS	125
59f6482c TS	126	const struct snd_motu_protocol *const protocol;
6c3cef48 TS	127	};
6c3cef48 TS	128
949613e3	129	extern const struct snd_motu_protocol snd_motu_protocol_v2;
5992e300	130	extern const struct snd_motu_protocol snd_motu_protocol_v3;
949613e3	131
6c5e1ac0	132	extern const struct snd_motu_spec snd_motu_spec_traveler;
35033d8c	133	extern const struct snd_motu_spec snd_motu_spec_8pre;
6c5e1ac0	134
4641c939 TS	135	int amdtp_motu_init(struct amdtp_stream s, struct fw_unit unit,
	136	enum amdtp_stream_direction dir,
	137	const struct snd_motu_protocol *const protocol);
	138	int amdtp_motu_set_parameters(struct amdtp_stream *s, unsigned int rate,
9e796e7d	139	unsigned int midi_ports,
4641c939 TS	140	struct snd_motu_packet_format *formats);
	141	int amdtp_motu_add_pcm_hw_constraints(struct amdtp_stream *s,
	142	struct snd_pcm_runtime *runtime);
9e796e7d TS	143	void amdtp_motu_midi_trigger(struct amdtp_stream *s, unsigned int port,
9e796e7d TS	144	struct snd_rawmidi_substream *midi);
2e76701b TS	145
	146	int snd_motu_transaction_read(struct snd_motu motu, u32 offset, __be32 reg,
	147	size_t size);
	148	int snd_motu_transaction_write(struct snd_motu motu, u32 offset, __be32 reg,
	149	size_t size);
	150	int snd_motu_transaction_register(struct snd_motu *motu);
	151	int snd_motu_transaction_reregister(struct snd_motu *motu);
	152	void snd_motu_transaction_unregister(struct snd_motu *motu);
9b2bb4f2 TS	153
	154	int snd_motu_stream_init_duplex(struct snd_motu *motu);
	155	void snd_motu_stream_destroy_duplex(struct snd_motu *motu);
8b460c76	156	int snd_motu_stream_cache_packet_formats(struct snd_motu *motu);
0d39cd0e TS	157	int snd_motu_stream_reserve_duplex(struct snd_motu *motu, unsigned int rate,
0d39cd0e TS	158	unsigned int frames_per_period);
8edc56ec	159	int snd_motu_stream_start_duplex(struct snd_motu *motu);
9b2bb4f2	160	void snd_motu_stream_stop_duplex(struct snd_motu *motu);
71c37977 TS	161	int snd_motu_stream_lock_try(struct snd_motu *motu);
71c37977 TS	162	void snd_motu_stream_lock_release(struct snd_motu *motu);
4638ec6e TS	163
4638ec6e TS	164	void snd_motu_proc_init(struct snd_motu *motu);
dd49b2d1 TS	165
dd49b2d1 TS	166	int snd_motu_create_pcm_devices(struct snd_motu *motu);
9e796e7d TS	167
9e796e7d TS	168	int snd_motu_create_midi_devices(struct snd_motu *motu);
71c37977 TS	169
71c37977 TS	170	int snd_motu_create_hwdep_device(struct snd_motu *motu);
6c3cef48	171	#endif