[mirror_ubuntu-jammy-kernel.git] / sound / firewire / fireface / ff.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * ff.h - a part of driver for RME Fireface series
 *
 * Copyright (c) 2015-2017 Takashi Sakamoto
 */

#ifndef SOUND_FIREFACE_H_INCLUDED
#define SOUND_FIREFACE_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/core.h>
#include <sound/info.h>
#include <sound/rawmidi.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/hwdep.h>
#include <sound/firewire.h>

#include "../lib.h"
#include "../amdtp-stream.h"
#include "../iso-resources.h"

#define SND_FF_MAXIMIM_MIDI_QUADS	9
#define SND_FF_IN_MIDI_PORTS		2
#define SND_FF_OUT_MIDI_PORTS		2

enum snd_ff_stream_mode {
	SND_FF_STREAM_MODE_LOW = 0,
	SND_FF_STREAM_MODE_MID,
	SND_FF_STREAM_MODE_HIGH,
	SND_FF_STREAM_MODE_COUNT,
};

struct snd_ff_protocol;
struct snd_ff_spec {
	const char *const name;

	const unsigned int pcm_capture_channels[SND_FF_STREAM_MODE_COUNT];
	const unsigned int pcm_playback_channels[SND_FF_STREAM_MODE_COUNT];

	unsigned int midi_in_ports;
	unsigned int midi_out_ports;

	const struct snd_ff_protocol *protocol;
	u64 midi_high_addr;
	u8 midi_addr_range;
	u64 midi_rx_addrs[SND_FF_OUT_MIDI_PORTS];
};

struct snd_ff {
	struct snd_card *card;
	struct fw_unit *unit;
	struct mutex mutex;
	spinlock_t lock;

	bool registered;
	struct delayed_work dwork;

	const struct snd_ff_spec *spec;

	/* To handle MIDI tx. */
	struct snd_rawmidi_substream *tx_midi_substreams[SND_FF_IN_MIDI_PORTS];
	struct fw_address_handler async_handler;

	/* TO handle MIDI rx. */
	struct snd_rawmidi_substream *rx_midi_substreams[SND_FF_OUT_MIDI_PORTS];
	bool on_sysex[SND_FF_OUT_MIDI_PORTS];
	__le32 msg_buf[SND_FF_OUT_MIDI_PORTS][SND_FF_MAXIMIM_MIDI_QUADS];
	struct work_struct rx_midi_work[SND_FF_OUT_MIDI_PORTS];
	struct fw_transaction transactions[SND_FF_OUT_MIDI_PORTS];
	ktime_t next_ktime[SND_FF_OUT_MIDI_PORTS];
	bool rx_midi_error[SND_FF_OUT_MIDI_PORTS];
	unsigned int rx_bytes[SND_FF_OUT_MIDI_PORTS];

	unsigned int substreams_counter;
	struct amdtp_stream tx_stream;
	struct amdtp_stream rx_stream;
	struct fw_iso_resources tx_resources;
	struct fw_iso_resources rx_resources;

	int dev_lock_count;
	bool dev_lock_changed;
	wait_queue_head_t hwdep_wait;
};

enum snd_ff_clock_src {
	SND_FF_CLOCK_SRC_INTERNAL,
	SND_FF_CLOCK_SRC_SPDIF,
	SND_FF_CLOCK_SRC_ADAT1,
	SND_FF_CLOCK_SRC_ADAT2,
	SND_FF_CLOCK_SRC_WORD,
	SND_FF_CLOCK_SRC_LTC,
	/* TODO: perhaps TCO exists. */
};

struct snd_ff_protocol {
	void (*handle_midi_msg)(struct snd_ff *ff, unsigned int offset,
				__le32 *buf, size_t length);
	int (*fill_midi_msg)(struct snd_ff *ff,
			     struct snd_rawmidi_substream *substream,
			     unsigned int port);
	int (*get_clock)(struct snd_ff *ff, unsigned int *rate,
			 enum snd_ff_clock_src *src);
	int (*switch_fetching_mode)(struct snd_ff *ff, bool enable);
	int (*begin_session)(struct snd_ff *ff, unsigned int rate);
	void (*finish_session)(struct snd_ff *ff);
	void (*dump_status)(struct snd_ff *ff, struct snd_info_buffer *buffer);
};

extern const struct snd_ff_protocol snd_ff_protocol_ff800;
extern const struct snd_ff_protocol snd_ff_protocol_ff400;
extern const struct snd_ff_protocol snd_ff_protocol_latter;

int snd_ff_transaction_register(struct snd_ff *ff);
int snd_ff_transaction_reregister(struct snd_ff *ff);
void snd_ff_transaction_unregister(struct snd_ff *ff);

int amdtp_ff_set_parameters(struct amdtp_stream *s, unsigned int rate,
			    unsigned int pcm_channels);
int amdtp_ff_add_pcm_hw_constraints(struct amdtp_stream *s,
				    struct snd_pcm_runtime *runtime);
int amdtp_ff_init(struct amdtp_stream *s, struct fw_unit *unit,
		  enum amdtp_stream_direction dir);

int snd_ff_stream_get_multiplier_mode(enum cip_sfc sfc,
				      enum snd_ff_stream_mode *mode);
int snd_ff_stream_init_duplex(struct snd_ff *ff);
void snd_ff_stream_destroy_duplex(struct snd_ff *ff);
int snd_ff_stream_start_duplex(struct snd_ff *ff, unsigned int rate);
void snd_ff_stream_stop_duplex(struct snd_ff *ff);
void snd_ff_stream_update_duplex(struct snd_ff *ff);

void snd_ff_stream_lock_changed(struct snd_ff *ff);
int snd_ff_stream_lock_try(struct snd_ff *ff);
void snd_ff_stream_lock_release(struct snd_ff *ff);

void snd_ff_proc_init(struct snd_ff *ff);
const char *snd_ff_proc_get_clk_label(enum snd_ff_clock_src src);

int snd_ff_create_midi_devices(struct snd_ff *ff);

int snd_ff_create_pcm_devices(struct snd_ff *ff);

int snd_ff_create_hwdep_devices(struct snd_ff *ff);

#endif
Commit	Line	Data
da607e19	1	/* SPDX-License-Identifier: GPL-2.0-only */
17c4e5ea TS	2	/*
	3	* ff.h - a part of driver for RME Fireface series
	4	*
	5	* Copyright (c) 2015-2017 Takashi Sakamoto
17c4e5ea TS	6	*/
	7
	8	#ifndef SOUND_FIREFACE_H_INCLUDED
	9	#define SOUND_FIREFACE_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>
	18	#include <linux/compat.h>
f656edd5	19	#include <linux/sched/signal.h>
17c4e5ea TS	20
17c4e5ea TS	21	#include <sound/core.h>
53eb0867	22	#include <sound/info.h>
19174295	23	#include <sound/rawmidi.h>
4b316436 TS	24	#include <sound/pcm.h>
4b316436 TS	25	#include <sound/pcm_params.h>
f656edd5 TS	26	#include <sound/hwdep.h>
f656edd5 TS	27	#include <sound/firewire.h>
17c4e5ea	28
324540c4	29	#include "../lib.h"
6fb7db90	30	#include "../amdtp-stream.h"
75d6d898	31	#include "../iso-resources.h"
324540c4	32
19174295 TS	33	#define SND_FF_MAXIMIM_MIDI_QUADS 9
	34	#define SND_FF_IN_MIDI_PORTS 2
	35	#define SND_FF_OUT_MIDI_PORTS 2
	36
76ea4688 TS	37	enum snd_ff_stream_mode {
	38	SND_FF_STREAM_MODE_LOW = 0,
	39	SND_FF_STREAM_MODE_MID,
	40	SND_FF_STREAM_MODE_HIGH,
	41	SND_FF_STREAM_MODE_COUNT,
	42	};
	43
53eb0867	44	struct snd_ff_protocol;
ed90f91a TS	45	struct snd_ff_spec {
	46	const char *const name;
	47
76ea4688 TS	48	const unsigned int pcm_capture_channels[SND_FF_STREAM_MODE_COUNT];
76ea4688 TS	49	const unsigned int pcm_playback_channels[SND_FF_STREAM_MODE_COUNT];
ed90f91a TS	50
	51	unsigned int midi_in_ports;
	52	unsigned int midi_out_ports;
53eb0867	53
782fbec7	54	const struct snd_ff_protocol *protocol;
6d1ef1bb	55	u64 midi_high_addr;
90089677	56	u8 midi_addr_range;
481e09ac	57	u64 midi_rx_addrs[SND_FF_OUT_MIDI_PORTS];
ed90f91a TS	58	};
ed90f91a TS	59
17c4e5ea TS	60	struct snd_ff {
	61	struct snd_card *card;
	62	struct fw_unit *unit;
	63	struct mutex mutex;
ff2c293e	64	spinlock_t lock;
324540c4 TS	65
	66	bool registered;
	67	struct delayed_work dwork;
ed90f91a TS	68
ed90f91a TS	69	const struct snd_ff_spec *spec;
19174295 TS	70
	71	/* To handle MIDI tx. */
	72	struct snd_rawmidi_substream *tx_midi_substreams[SND_FF_IN_MIDI_PORTS];
	73	struct fw_address_handler async_handler;
	74
	75	/* TO handle MIDI rx. */
	76	struct snd_rawmidi_substream *rx_midi_substreams[SND_FF_OUT_MIDI_PORTS];
f0f9f497	77	bool on_sysex[SND_FF_OUT_MIDI_PORTS];
19174295 TS	78	__le32 msg_buf[SND_FF_OUT_MIDI_PORTS][SND_FF_MAXIMIM_MIDI_QUADS];
	79	struct work_struct rx_midi_work[SND_FF_OUT_MIDI_PORTS];
	80	struct fw_transaction transactions[SND_FF_OUT_MIDI_PORTS];
	81	ktime_t next_ktime[SND_FF_OUT_MIDI_PORTS];
	82	bool rx_midi_error[SND_FF_OUT_MIDI_PORTS];
	83	unsigned int rx_bytes[SND_FF_OUT_MIDI_PORTS];
75d6d898 TS	84
	85	unsigned int substreams_counter;
	86	struct amdtp_stream tx_stream;
	87	struct amdtp_stream rx_stream;
	88	struct fw_iso_resources tx_resources;
	89	struct fw_iso_resources rx_resources;
f656edd5 TS	90
	91	int dev_lock_count;
	92	bool dev_lock_changed;
	93	wait_queue_head_t hwdep_wait;
17c4e5ea	94	};
53eb0867 TS	95
	96	enum snd_ff_clock_src {
	97	SND_FF_CLOCK_SRC_INTERNAL,
	98	SND_FF_CLOCK_SRC_SPDIF,
5bfb841e TS	99	SND_FF_CLOCK_SRC_ADAT1,
5bfb841e TS	100	SND_FF_CLOCK_SRC_ADAT2,
53eb0867 TS	101	SND_FF_CLOCK_SRC_WORD,
53eb0867 TS	102	SND_FF_CLOCK_SRC_LTC,
5bfb841e	103	/* TODO: perhaps TCO exists. */
53eb0867 TS	104	};
	105
	106	struct snd_ff_protocol {
6c644e4e TS	107	void (handle_midi_msg)(struct snd_ff ff, unsigned int offset,
6c644e4e TS	108	__le32 *buf, size_t length);
82b6297b TS	109	int (fill_midi_msg)(struct snd_ff ff,
	110	struct snd_rawmidi_substream *substream,
	111	unsigned int port);
b1d0cb0a TS	112	int (get_clock)(struct snd_ff ff, unsigned int *rate,
b1d0cb0a TS	113	enum snd_ff_clock_src *src);
ae3053c2	114	int (switch_fetching_mode)(struct snd_ff ff, bool enable);
53eb0867 TS	115	int (begin_session)(struct snd_ff ff, unsigned int rate);
53eb0867 TS	116	void (finish_session)(struct snd_ff ff);
e9e29cf8	117	void (dump_status)(struct snd_ff ff, struct snd_info_buffer *buffer);
53eb0867 TS	118	};
53eb0867 TS	119
a91f6760	120	extern const struct snd_ff_protocol snd_ff_protocol_ff800;
782fbec7	121	extern const struct snd_ff_protocol snd_ff_protocol_ff400;
fd1cc9de	122	extern const struct snd_ff_protocol snd_ff_protocol_latter;
76fdb3a9	123
19174295 TS	124	int snd_ff_transaction_register(struct snd_ff *ff);
	125	int snd_ff_transaction_reregister(struct snd_ff *ff);
	126	void snd_ff_transaction_unregister(struct snd_ff *ff);
	127
6fb7db90 TS	128	int amdtp_ff_set_parameters(struct amdtp_stream *s, unsigned int rate,
	129	unsigned int pcm_channels);
	130	int amdtp_ff_add_pcm_hw_constraints(struct amdtp_stream *s,
	131	struct snd_pcm_runtime *runtime);
	132	int amdtp_ff_init(struct amdtp_stream s, struct fw_unit unit,
	133	enum amdtp_stream_direction dir);
	134
76ea4688 TS	135	int snd_ff_stream_get_multiplier_mode(enum cip_sfc sfc,
76ea4688 TS	136	enum snd_ff_stream_mode *mode);
75d6d898 TS	137	int snd_ff_stream_init_duplex(struct snd_ff *ff);
	138	void snd_ff_stream_destroy_duplex(struct snd_ff *ff);
	139	int snd_ff_stream_start_duplex(struct snd_ff *ff, unsigned int rate);
	140	void snd_ff_stream_stop_duplex(struct snd_ff *ff);
	141	void snd_ff_stream_update_duplex(struct snd_ff *ff);
	142
f656edd5 TS	143	void snd_ff_stream_lock_changed(struct snd_ff *ff);
	144	int snd_ff_stream_lock_try(struct snd_ff *ff);
	145	void snd_ff_stream_lock_release(struct snd_ff *ff);
	146
d3fc7aac	147	void snd_ff_proc_init(struct snd_ff *ff);
4c4871a8	148	const char *snd_ff_proc_get_clk_label(enum snd_ff_clock_src src);
d3fc7aac	149
ff2c293e TS	150	int snd_ff_create_midi_devices(struct snd_ff *ff);
ff2c293e TS	151
4b316436 TS	152	int snd_ff_create_pcm_devices(struct snd_ff *ff);
4b316436 TS	153
f656edd5 TS	154	int snd_ff_create_hwdep_devices(struct snd_ff *ff);
f656edd5 TS	155
17c4e5ea	156	#endif