[deliverable/linux.git] / sound / firewire / tascam / tascam.h

/*
 * tascam.h - a part of driver for TASCAM FireWire series
 *
 * Copyright (c) 2015 Takashi Sakamoto
 *
 * Licensed under the terms of the GNU General Public License, version 2.
 */

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

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

struct snd_tscm_spec {
	const char *const name;
	bool has_adat;
	bool has_spdif;
	unsigned int pcm_capture_analog_channels;
	unsigned int pcm_playback_analog_channels;
	unsigned int midi_capture_ports;
	unsigned int midi_playback_ports;
};

#define TSCM_MIDI_IN_PORT_MAX	4
#define TSCM_MIDI_OUT_PORT_MAX	4

struct snd_tscm {
	struct snd_card *card;
	struct fw_unit *unit;

	struct mutex mutex;
	spinlock_t lock;

	bool registered;
	struct delayed_work dwork;
	const struct snd_tscm_spec *spec;

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

	int dev_lock_count;
	bool dev_lock_changed;
	wait_queue_head_t hwdep_wait;

	/* For MIDI message incoming transactions. */
	struct fw_address_handler async_handler;
	struct snd_rawmidi_substream *tx_midi_substreams[TSCM_MIDI_IN_PORT_MAX];

	/* For MIDI message outgoing transactions. */
	struct snd_fw_async_midi_port out_ports[TSCM_MIDI_OUT_PORT_MAX];
	u8 running_status[TSCM_MIDI_OUT_PORT_MAX];
	bool on_sysex[TSCM_MIDI_OUT_PORT_MAX];
};

#define TSCM_ADDR_BASE			0xffff00000000ull

#define TSCM_OFFSET_FIRMWARE_REGISTER	0x0000
#define TSCM_OFFSET_FIRMWARE_FPGA	0x0004
#define TSCM_OFFSET_FIRMWARE_ARM	0x0008
#define TSCM_OFFSET_FIRMWARE_HW		0x000c

#define TSCM_OFFSET_ISOC_TX_CH		0x0200
#define TSCM_OFFSET_UNKNOWN		0x0204
#define TSCM_OFFSET_START_STREAMING	0x0208
#define TSCM_OFFSET_ISOC_RX_CH		0x020c
#define TSCM_OFFSET_ISOC_RX_ON		0x0210	/* Little conviction. */
#define TSCM_OFFSET_TX_PCM_CHANNELS	0x0214
#define TSCM_OFFSET_RX_PCM_CHANNELS	0x0218
#define TSCM_OFFSET_MULTIPLEX_MODE	0x021c
#define TSCM_OFFSET_ISOC_TX_ON		0x0220
/* Unknown				0x0224 */
#define TSCM_OFFSET_CLOCK_STATUS	0x0228
#define TSCM_OFFSET_SET_OPTION		0x022c

#define TSCM_OFFSET_MIDI_TX_ON		0x0300
#define TSCM_OFFSET_MIDI_TX_ADDR_HI	0x0304
#define TSCM_OFFSET_MIDI_TX_ADDR_LO	0x0308

#define TSCM_OFFSET_LED_POWER		0x0404

#define TSCM_OFFSET_MIDI_RX_QUAD	0x4000

enum snd_tscm_clock {
	SND_TSCM_CLOCK_INTERNAL = 0,
	SND_TSCM_CLOCK_WORD	= 1,
	SND_TSCM_CLOCK_SPDIF	= 2,
	SND_TSCM_CLOCK_ADAT	= 3,
};

int amdtp_tscm_init(struct amdtp_stream *s, struct fw_unit *unit,
		  enum amdtp_stream_direction dir, unsigned int pcm_channels);
int amdtp_tscm_set_parameters(struct amdtp_stream *s, unsigned int rate);
int amdtp_tscm_add_pcm_hw_constraints(struct amdtp_stream *s,
				      struct snd_pcm_runtime *runtime);
void amdtp_tscm_set_pcm_format(struct amdtp_stream *s, snd_pcm_format_t format);

int snd_tscm_stream_get_rate(struct snd_tscm *tscm, unsigned int *rate);
int snd_tscm_stream_get_clock(struct snd_tscm *tscm,
			      enum snd_tscm_clock *clock);
int snd_tscm_stream_init_duplex(struct snd_tscm *tscm);
void snd_tscm_stream_update_duplex(struct snd_tscm *tscm);
void snd_tscm_stream_destroy_duplex(struct snd_tscm *tscm);
int snd_tscm_stream_start_duplex(struct snd_tscm *tscm, unsigned int rate);
void snd_tscm_stream_stop_duplex(struct snd_tscm *tscm);

void snd_tscm_stream_lock_changed(struct snd_tscm *tscm);
int snd_tscm_stream_lock_try(struct snd_tscm *tscm);
void snd_tscm_stream_lock_release(struct snd_tscm *tscm);

int snd_tscm_transaction_register(struct snd_tscm *tscm);
int snd_tscm_transaction_reregister(struct snd_tscm *tscm);
void snd_tscm_transaction_unregister(struct snd_tscm *tscm);

void snd_tscm_proc_init(struct snd_tscm *tscm);

int snd_tscm_create_pcm_devices(struct snd_tscm *tscm);

int snd_tscm_create_midi_devices(struct snd_tscm *tscm);

int snd_tscm_create_hwdep_device(struct snd_tscm *tscm);

#endif
Commit	Line	Data
c0949b27 TS	1	/*
	2	* tascam.h - a part of driver for TASCAM FireWire series
	3	*
	4	* Copyright (c) 2015 Takashi Sakamoto
	5	*
	6	* Licensed under the terms of the GNU General Public License, version 2.
	7	*/
	8
	9	#ifndef SOUND_TASCAM_H_INCLUDED
	10	#define SOUND_TASCAM_H_INCLUDED
	11
	12	#include <linux/device.h>
	13	#include <linux/firewire.h>
	14	#include <linux/firewire-constants.h>
	15	#include <linux/module.h>
	16	#include <linux/mod_devicetable.h>
	17	#include <linux/mutex.h>
	18	#include <linux/slab.h>
	19	#include <linux/compat.h>
	20
	21	#include <sound/core.h>
	22	#include <sound/initval.h>
96e5fbb0	23	#include <sound/info.h>
47faeea2 TS	24	#include <sound/pcm.h>
47faeea2 TS	25	#include <sound/pcm_params.h>
e5e0c3dd TS	26	#include <sound/firewire.h>
e5e0c3dd TS	27	#include <sound/hwdep.h>
107cc012	28	#include <sound/rawmidi.h>
c0949b27 TS	29
c0949b27 TS	30	#include "../lib.h"
47faeea2	31	#include "../amdtp-stream.h"
35efa5c4	32	#include "../iso-resources.h"
c0949b27	33
6f81ba19 TS	34	struct snd_tscm_spec {
	35	const char *const name;
	36	bool has_adat;
	37	bool has_spdif;
	38	unsigned int pcm_capture_analog_channels;
	39	unsigned int pcm_playback_analog_channels;
	40	unsigned int midi_capture_ports;
	41	unsigned int midi_playback_ports;
6f81ba19 TS	42	};
6f81ba19 TS	43
107cc012 TS	44	#define TSCM_MIDI_IN_PORT_MAX 4
	45	#define TSCM_MIDI_OUT_PORT_MAX 4
	46
c0949b27 TS	47	struct snd_tscm {
	48	struct snd_card *card;
	49	struct fw_unit *unit;
	50
	51	struct mutex mutex;
e5e0c3dd	52	spinlock_t lock;
6f81ba19	53
b610386c TS	54	bool registered;
b610386c TS	55	struct delayed_work dwork;
6f81ba19	56	const struct snd_tscm_spec *spec;
35efa5c4 TS	57
	58	struct fw_iso_resources tx_resources;
	59	struct fw_iso_resources rx_resources;
	60	struct amdtp_stream tx_stream;
	61	struct amdtp_stream rx_stream;
	62	unsigned int substreams_counter;
e5e0c3dd TS	63
	64	int dev_lock_count;
	65	bool dev_lock_changed;
	66	wait_queue_head_t hwdep_wait;
107cc012 TS	67
	68	/* For MIDI message incoming transactions. */
	69	struct fw_address_handler async_handler;
	70	struct snd_rawmidi_substream *tx_midi_substreams[TSCM_MIDI_IN_PORT_MAX];
3beab0f8 TS	71
	72	/* For MIDI message outgoing transactions. */
	73	struct snd_fw_async_midi_port out_ports[TSCM_MIDI_OUT_PORT_MAX];
	74	u8 running_status[TSCM_MIDI_OUT_PORT_MAX];
	75	bool on_sysex[TSCM_MIDI_OUT_PORT_MAX];
c0949b27 TS	76	};
c0949b27 TS	77
96e5fbb0 TS	78	#define TSCM_ADDR_BASE 0xffff00000000ull
	79
	80	#define TSCM_OFFSET_FIRMWARE_REGISTER 0x0000
	81	#define TSCM_OFFSET_FIRMWARE_FPGA 0x0004
	82	#define TSCM_OFFSET_FIRMWARE_ARM 0x0008
	83	#define TSCM_OFFSET_FIRMWARE_HW 0x000c
	84
35efa5c4 TS	85	#define TSCM_OFFSET_ISOC_TX_CH 0x0200
	86	#define TSCM_OFFSET_UNKNOWN 0x0204
	87	#define TSCM_OFFSET_START_STREAMING 0x0208
	88	#define TSCM_OFFSET_ISOC_RX_CH 0x020c
	89	#define TSCM_OFFSET_ISOC_RX_ON 0x0210 /* Little conviction. */
	90	#define TSCM_OFFSET_TX_PCM_CHANNELS 0x0214
	91	#define TSCM_OFFSET_RX_PCM_CHANNELS 0x0218
	92	#define TSCM_OFFSET_MULTIPLEX_MODE 0x021c
	93	#define TSCM_OFFSET_ISOC_TX_ON 0x0220
	94	/* Unknown 0x0224 */
	95	#define TSCM_OFFSET_CLOCK_STATUS 0x0228
	96	#define TSCM_OFFSET_SET_OPTION 0x022c
	97
107cc012 TS	98	#define TSCM_OFFSET_MIDI_TX_ON 0x0300
	99	#define TSCM_OFFSET_MIDI_TX_ADDR_HI 0x0304
	100	#define TSCM_OFFSET_MIDI_TX_ADDR_LO 0x0308
	101
e65e2cb9 TS	102	#define TSCM_OFFSET_LED_POWER 0x0404
e65e2cb9 TS	103
107cc012 TS	104	#define TSCM_OFFSET_MIDI_RX_QUAD 0x4000
107cc012 TS	105
35efa5c4 TS	106	enum snd_tscm_clock {
	107	SND_TSCM_CLOCK_INTERNAL = 0,
	108	SND_TSCM_CLOCK_WORD = 1,
	109	SND_TSCM_CLOCK_SPDIF = 2,
	110	SND_TSCM_CLOCK_ADAT = 3,
	111	};
	112
47faeea2 TS	113	int amdtp_tscm_init(struct amdtp_stream s, struct fw_unit unit,
	114	enum amdtp_stream_direction dir, unsigned int pcm_channels);
	115	int amdtp_tscm_set_parameters(struct amdtp_stream *s, unsigned int rate);
	116	int amdtp_tscm_add_pcm_hw_constraints(struct amdtp_stream *s,
	117	struct snd_pcm_runtime *runtime);
	118	void amdtp_tscm_set_pcm_format(struct amdtp_stream *s, snd_pcm_format_t format);
	119
35efa5c4 TS	120	int snd_tscm_stream_get_rate(struct snd_tscm tscm, unsigned int rate);
	121	int snd_tscm_stream_get_clock(struct snd_tscm *tscm,
	122	enum snd_tscm_clock *clock);
	123	int snd_tscm_stream_init_duplex(struct snd_tscm *tscm);
	124	void snd_tscm_stream_update_duplex(struct snd_tscm *tscm);
	125	void snd_tscm_stream_destroy_duplex(struct snd_tscm *tscm);
	126	int snd_tscm_stream_start_duplex(struct snd_tscm *tscm, unsigned int rate);
	127	void snd_tscm_stream_stop_duplex(struct snd_tscm *tscm);
	128
e5e0c3dd TS	129	void snd_tscm_stream_lock_changed(struct snd_tscm *tscm);
	130	int snd_tscm_stream_lock_try(struct snd_tscm *tscm);
	131	void snd_tscm_stream_lock_release(struct snd_tscm *tscm);
	132
107cc012 TS	133	int snd_tscm_transaction_register(struct snd_tscm *tscm);
	134	int snd_tscm_transaction_reregister(struct snd_tscm *tscm);
	135	void snd_tscm_transaction_unregister(struct snd_tscm *tscm);
	136
96e5fbb0 TS	137	void snd_tscm_proc_init(struct snd_tscm *tscm);
96e5fbb0 TS	138
e453df44 TS	139	int snd_tscm_create_pcm_devices(struct snd_tscm *tscm);
e453df44 TS	140
0db18e7e TS	141	int snd_tscm_create_midi_devices(struct snd_tscm *tscm);
0db18e7e TS	142
e5e0c3dd TS	143	int snd_tscm_create_hwdep_device(struct snd_tscm *tscm);
e5e0c3dd TS	144
c0949b27	145	#endif