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

/*
 * fireworks.h - a part of driver for Fireworks based devices
 *
 * Copyright (c) 2009-2010 Clemens Ladisch
 * Copyright (c) 2013-2014 Takashi Sakamoto
 *
 * Licensed under the terms of the GNU General Public License, version 2.
 */
#ifndef SOUND_FIREWORKS_H_INCLUDED
#define SOUND_FIREWORKS_H_INCLUDED

#include <linux/compat.h>
#include <linux/device.h>
#include <linux/firewire.h>
#include <linux/firewire-constants.h>
#include <linux/module.h>
#include <linux/mod_devicetable.h>
#include <linux/delay.h>
#include <linux/slab.h>

#include <sound/core.h>
#include <sound/initval.h>
#include <sound/pcm.h>
#include <sound/info.h>
#include <sound/rawmidi.h>
#include <sound/pcm_params.h>
#include <sound/firewire.h>
#include <sound/hwdep.h>

#include "../packets-buffer.h"
#include "../iso-resources.h"
#include "../amdtp.h"
#include "../cmp.h"
#include "../lib.h"

#define SND_EFW_MAX_MIDI_OUT_PORTS	2
#define SND_EFW_MAX_MIDI_IN_PORTS	2

#define SND_EFW_MULTIPLIER_MODES	3
#define HWINFO_NAME_SIZE_BYTES		32
#define HWINFO_MAX_CAPS_GROUPS		8

/*
 * This should be greater than maximum bytes for EFW response content.
 * Currently response against command for isochronous channel mapping is
 * confirmed to be the maximum one. But for flexibility, use maximum data
 * payload for asynchronous primary packets at S100 (Cable base rate) in
 * IEEE Std 1394-1995.
 */
#define SND_EFW_RESPONSE_MAXIMUM_BYTES	0x200U

extern unsigned int snd_efw_resp_buf_size;
extern bool snd_efw_resp_buf_debug;

struct snd_efw_phys_grp {
	u8 type;	/* see enum snd_efw_grp_type */
	u8 count;
} __packed;

struct snd_efw {
	struct snd_card *card;
	struct fw_unit *unit;
	int card_index;

	struct mutex mutex;
	spinlock_t lock;

	/* for transaction */
	u32 seqnum;
	bool resp_addr_changable;

	/* for quirks */
	bool is_af9;
	u32 firmware_version;

	unsigned int midi_in_ports;
	unsigned int midi_out_ports;

	unsigned int supported_sampling_rate;
	unsigned int pcm_capture_channels[SND_EFW_MULTIPLIER_MODES];
	unsigned int pcm_playback_channels[SND_EFW_MULTIPLIER_MODES];

	struct amdtp_stream *master;
	struct amdtp_stream tx_stream;
	struct amdtp_stream rx_stream;
	struct cmp_connection out_conn;
	struct cmp_connection in_conn;
	atomic_t capture_substreams;
	atomic_t playback_substreams;

	/* hardware metering parameters */
	unsigned int phys_out;
	unsigned int phys_in;
	unsigned int phys_out_grp_count;
	unsigned int phys_in_grp_count;
	struct snd_efw_phys_grp phys_out_grps[HWINFO_MAX_CAPS_GROUPS];
	struct snd_efw_phys_grp phys_in_grps[HWINFO_MAX_CAPS_GROUPS];

	/* for uapi */
	int dev_lock_count;
	bool dev_lock_changed;
	wait_queue_head_t hwdep_wait;

	/* response queue */
	u8 *resp_buf;
	u8 *pull_ptr;
	u8 *push_ptr;
	unsigned int resp_queues;
};

int snd_efw_transaction_cmd(struct fw_unit *unit,
			    const void *cmd, unsigned int size);
int snd_efw_transaction_run(struct fw_unit *unit,
			    const void *cmd, unsigned int cmd_size,
			    void *resp, unsigned int resp_size);
int snd_efw_transaction_register(void);
void snd_efw_transaction_unregister(void);
void snd_efw_transaction_bus_reset(struct fw_unit *unit);
void snd_efw_transaction_add_instance(struct snd_efw *efw);
void snd_efw_transaction_remove_instance(struct snd_efw *efw);

struct snd_efw_hwinfo {
	u32 flags;
	u32 guid_hi;
	u32 guid_lo;
	u32 type;
	u32 version;
	char vendor_name[HWINFO_NAME_SIZE_BYTES];
	char model_name[HWINFO_NAME_SIZE_BYTES];
	u32 supported_clocks;
	u32 amdtp_rx_pcm_channels;
	u32 amdtp_tx_pcm_channels;
	u32 phys_out;
	u32 phys_in;
	u32 phys_out_grp_count;
	struct snd_efw_phys_grp phys_out_grps[HWINFO_MAX_CAPS_GROUPS];
	u32 phys_in_grp_count;
	struct snd_efw_phys_grp phys_in_grps[HWINFO_MAX_CAPS_GROUPS];
	u32 midi_out_ports;
	u32 midi_in_ports;
	u32 max_sample_rate;
	u32 min_sample_rate;
	u32 dsp_version;
	u32 arm_version;
	u32 mixer_playback_channels;
	u32 mixer_capture_channels;
	u32 fpga_version;
	u32 amdtp_rx_pcm_channels_2x;
	u32 amdtp_tx_pcm_channels_2x;
	u32 amdtp_rx_pcm_channels_4x;
	u32 amdtp_tx_pcm_channels_4x;
	u32 reserved[16];
} __packed;
enum snd_efw_grp_type {
	SND_EFW_CH_TYPE_ANALOG			= 0,
	SND_EFW_CH_TYPE_SPDIF			= 1,
	SND_EFW_CH_TYPE_ADAT			= 2,
	SND_EFW_CH_TYPE_SPDIF_OR_ADAT		= 3,
	SND_EFW_CH_TYPE_ANALOG_MIRRORING	= 4,
	SND_EFW_CH_TYPE_HEADPHONES		= 5,
	SND_EFW_CH_TYPE_I2S			= 6,
	SND_EFW_CH_TYPE_GUITAR			= 7,
	SND_EFW_CH_TYPE_PIEZO_GUITAR		= 8,
	SND_EFW_CH_TYPE_GUITAR_STRING		= 9,
	SND_EFW_CH_TYPE_DUMMY
};
struct snd_efw_phys_meters {
	u32 status;	/* guitar state/midi signal/clock input detect */
	u32 reserved0;
	u32 reserved1;
	u32 reserved2;
	u32 reserved3;
	u32 out_meters;
	u32 in_meters;
	u32 reserved4;
	u32 reserved5;
	u32 values[0];
} __packed;
enum snd_efw_clock_source {
	SND_EFW_CLOCK_SOURCE_INTERNAL	= 0,
	SND_EFW_CLOCK_SOURCE_SYTMATCH	= 1,
	SND_EFW_CLOCK_SOURCE_WORDCLOCK	= 2,
	SND_EFW_CLOCK_SOURCE_SPDIF	= 3,
	SND_EFW_CLOCK_SOURCE_ADAT_1	= 4,
	SND_EFW_CLOCK_SOURCE_ADAT_2	= 5,
	SND_EFW_CLOCK_SOURCE_CONTINUOUS	= 6	/* internal variable clock */
};
enum snd_efw_transport_mode {
	SND_EFW_TRANSPORT_MODE_WINDOWS	= 0,
	SND_EFW_TRANSPORT_MODE_IEC61883	= 1,
};
int snd_efw_command_set_resp_addr(struct snd_efw *efw,
				  u16 addr_high, u32 addr_low);
int snd_efw_command_set_tx_mode(struct snd_efw *efw,
				enum snd_efw_transport_mode mode);
int snd_efw_command_get_hwinfo(struct snd_efw *efw,
			       struct snd_efw_hwinfo *hwinfo);
int snd_efw_command_get_phys_meters(struct snd_efw *efw,
				    struct snd_efw_phys_meters *meters,
				    unsigned int len);
int snd_efw_command_get_clock_source(struct snd_efw *efw,
				     enum snd_efw_clock_source *source);
int snd_efw_command_get_sampling_rate(struct snd_efw *efw, unsigned int *rate);
int snd_efw_command_set_sampling_rate(struct snd_efw *efw, unsigned int rate);

int snd_efw_stream_init_duplex(struct snd_efw *efw);
int snd_efw_stream_start_duplex(struct snd_efw *efw, unsigned int rate);
void snd_efw_stream_stop_duplex(struct snd_efw *efw);
void snd_efw_stream_update_duplex(struct snd_efw *efw);
void snd_efw_stream_destroy_duplex(struct snd_efw *efw);
void snd_efw_stream_lock_changed(struct snd_efw *efw);
int snd_efw_stream_lock_try(struct snd_efw *efw);
void snd_efw_stream_lock_release(struct snd_efw *efw);

void snd_efw_proc_init(struct snd_efw *efw);

int snd_efw_create_midi_devices(struct snd_efw *efw);

int snd_efw_create_pcm_devices(struct snd_efw *efw);
int snd_efw_get_multiplier_mode(unsigned int sampling_rate, unsigned int *mode);

int snd_efw_create_hwdep_device(struct snd_efw *efw);

#define SND_EFW_DEV_ENTRY(vendor, model) \
{ \
	.match_flags	= IEEE1394_MATCH_VENDOR_ID | \
			  IEEE1394_MATCH_MODEL_ID, \
	.vendor_id	= vendor,\
	.model_id	= model \
}

#endif
Commit	Line	Data
b5b04336 TS	1	/*
	2	* fireworks.h - a part of driver for Fireworks based devices
	3	*
	4	* Copyright (c) 2009-2010 Clemens Ladisch
	5	* Copyright (c) 2013-2014 Takashi Sakamoto
	6	*
	7	* Licensed under the terms of the GNU General Public License, version 2.
	8	*/
	9	#ifndef SOUND_FIREWORKS_H_INCLUDED
	10	#define SOUND_FIREWORKS_H_INCLUDED
	11
	12	#include <linux/compat.h>
	13	#include <linux/device.h>
	14	#include <linux/firewire.h>
	15	#include <linux/firewire-constants.h>
	16	#include <linux/module.h>
	17	#include <linux/mod_devicetable.h>
	18	#include <linux/delay.h>
	19	#include <linux/slab.h>
	20
	21	#include <sound/core.h>
	22	#include <sound/initval.h>
bde8a8f2	23	#include <sound/pcm.h>
6a22683e	24	#include <sound/info.h>
a63d3ff1	25	#include <sound/rawmidi.h>
aa02bb6e	26	#include <sound/pcm_params.h>
594ddced TS	27	#include <sound/firewire.h>
594ddced TS	28	#include <sound/hwdep.h>
bde8a8f2	29
315fd41f TS	30	#include "../packets-buffer.h"
	31	#include "../iso-resources.h"
	32	#include "../amdtp.h"
bde8a8f2 TS	33	#include "../cmp.h"
	34	#include "../lib.h"
	35
315fd41f TS	36	#define SND_EFW_MAX_MIDI_OUT_PORTS 2
	37	#define SND_EFW_MAX_MIDI_IN_PORTS 2
	38
bde8a8f2 TS	39	#define SND_EFW_MULTIPLIER_MODES 3
	40	#define HWINFO_NAME_SIZE_BYTES 32
	41	#define HWINFO_MAX_CAPS_GROUPS 8
	42
	43	/*
	44	* This should be greater than maximum bytes for EFW response content.
	45	* Currently response against command for isochronous channel mapping is
	46	* confirmed to be the maximum one. But for flexibility, use maximum data
	47	* payload for asynchronous primary packets at S100 (Cable base rate) in
	48	* IEEE Std 1394-1995.
	49	*/
	50	#define SND_EFW_RESPONSE_MAXIMUM_BYTES 0x200U
	51
555e8a8f TS	52	extern unsigned int snd_efw_resp_buf_size;
	53	extern bool snd_efw_resp_buf_debug;
	54
bde8a8f2 TS	55	struct snd_efw_phys_grp {
	56	u8 type; /* see enum snd_efw_grp_type */
	57	u8 count;
	58	} __packed;
b5b04336 TS	59
	60	struct snd_efw {
	61	struct snd_card *card;
	62	struct fw_unit *unit;
	63	int card_index;
	64
	65	struct mutex mutex;
	66	spinlock_t lock;
bde8a8f2 TS	67
	68	/* for transaction */
	69	u32 seqnum;
	70	bool resp_addr_changable;
315fd41f	71
69702239 TS	72	/* for quirks */
69702239 TS	73	bool is_af9;
d9cd0065	74	u32 firmware_version;
69702239	75
315fd41f TS	76	unsigned int midi_in_ports;
	77	unsigned int midi_out_ports;
	78
	79	unsigned int supported_sampling_rate;
	80	unsigned int pcm_capture_channels[SND_EFW_MULTIPLIER_MODES];
	81	unsigned int pcm_playback_channels[SND_EFW_MULTIPLIER_MODES];
	82
	83	struct amdtp_stream *master;
	84	struct amdtp_stream tx_stream;
	85	struct amdtp_stream rx_stream;
	86	struct cmp_connection out_conn;
	87	struct cmp_connection in_conn;
	88	atomic_t capture_substreams;
	89	atomic_t playback_substreams;
6a22683e TS	90
	91	/* hardware metering parameters */
	92	unsigned int phys_out;
	93	unsigned int phys_in;
	94	unsigned int phys_out_grp_count;
	95	unsigned int phys_in_grp_count;
	96	struct snd_efw_phys_grp phys_out_grps[HWINFO_MAX_CAPS_GROUPS];
	97	struct snd_efw_phys_grp phys_in_grps[HWINFO_MAX_CAPS_GROUPS];
594ddced TS	98
	99	/* for uapi */
	100	int dev_lock_count;
	101	bool dev_lock_changed;
	102	wait_queue_head_t hwdep_wait;
bde8a8f2	103
555e8a8f TS	104	/* response queue */
	105	u8 *resp_buf;
	106	u8 *pull_ptr;
	107	u8 *push_ptr;
	108	unsigned int resp_queues;
bde8a8f2	109	};
555e8a8f TS	110
	111	int snd_efw_transaction_cmd(struct fw_unit *unit,
	112	const void *cmd, unsigned int size);
bde8a8f2 TS	113	int snd_efw_transaction_run(struct fw_unit *unit,
	114	const void *cmd, unsigned int cmd_size,
	115	void *resp, unsigned int resp_size);
	116	int snd_efw_transaction_register(void);
	117	void snd_efw_transaction_unregister(void);
	118	void snd_efw_transaction_bus_reset(struct fw_unit *unit);
555e8a8f TS	119	void snd_efw_transaction_add_instance(struct snd_efw *efw);
555e8a8f TS	120	void snd_efw_transaction_remove_instance(struct snd_efw *efw);
bde8a8f2 TS	121
	122	struct snd_efw_hwinfo {
	123	u32 flags;
	124	u32 guid_hi;
	125	u32 guid_lo;
	126	u32 type;
	127	u32 version;
	128	char vendor_name[HWINFO_NAME_SIZE_BYTES];
	129	char model_name[HWINFO_NAME_SIZE_BYTES];
	130	u32 supported_clocks;
	131	u32 amdtp_rx_pcm_channels;
	132	u32 amdtp_tx_pcm_channels;
	133	u32 phys_out;
	134	u32 phys_in;
	135	u32 phys_out_grp_count;
	136	struct snd_efw_phys_grp phys_out_grps[HWINFO_MAX_CAPS_GROUPS];
	137	u32 phys_in_grp_count;
	138	struct snd_efw_phys_grp phys_in_grps[HWINFO_MAX_CAPS_GROUPS];
	139	u32 midi_out_ports;
	140	u32 midi_in_ports;
	141	u32 max_sample_rate;
	142	u32 min_sample_rate;
	143	u32 dsp_version;
	144	u32 arm_version;
	145	u32 mixer_playback_channels;
	146	u32 mixer_capture_channels;
	147	u32 fpga_version;
	148	u32 amdtp_rx_pcm_channels_2x;
	149	u32 amdtp_tx_pcm_channels_2x;
	150	u32 amdtp_rx_pcm_channels_4x;
	151	u32 amdtp_tx_pcm_channels_4x;
	152	u32 reserved[16];
	153	} __packed;
	154	enum snd_efw_grp_type {
	155	SND_EFW_CH_TYPE_ANALOG = 0,
	156	SND_EFW_CH_TYPE_SPDIF = 1,
	157	SND_EFW_CH_TYPE_ADAT = 2,
	158	SND_EFW_CH_TYPE_SPDIF_OR_ADAT = 3,
	159	SND_EFW_CH_TYPE_ANALOG_MIRRORING = 4,
	160	SND_EFW_CH_TYPE_HEADPHONES = 5,
	161	SND_EFW_CH_TYPE_I2S = 6,
	162	SND_EFW_CH_TYPE_GUITAR = 7,
	163	SND_EFW_CH_TYPE_PIEZO_GUITAR = 8,
	164	SND_EFW_CH_TYPE_GUITAR_STRING = 9,
bde8a8f2 TS	165	SND_EFW_CH_TYPE_DUMMY
	166	};
	167	struct snd_efw_phys_meters {
	168	u32 status; /* guitar state/midi signal/clock input detect */
	169	u32 reserved0;
	170	u32 reserved1;
	171	u32 reserved2;
	172	u32 reserved3;
	173	u32 out_meters;
	174	u32 in_meters;
	175	u32 reserved4;
	176	u32 reserved5;
	177	u32 values[0];
	178	} __packed;
	179	enum snd_efw_clock_source {
	180	SND_EFW_CLOCK_SOURCE_INTERNAL = 0,
	181	SND_EFW_CLOCK_SOURCE_SYTMATCH = 1,
	182	SND_EFW_CLOCK_SOURCE_WORDCLOCK = 2,
	183	SND_EFW_CLOCK_SOURCE_SPDIF = 3,
	184	SND_EFW_CLOCK_SOURCE_ADAT_1 = 4,
	185	SND_EFW_CLOCK_SOURCE_ADAT_2 = 5,
	186	SND_EFW_CLOCK_SOURCE_CONTINUOUS = 6 /* internal variable clock */
	187	};
	188	enum snd_efw_transport_mode {
	189	SND_EFW_TRANSPORT_MODE_WINDOWS = 0,
	190	SND_EFW_TRANSPORT_MODE_IEC61883 = 1,
b5b04336	191	};
bde8a8f2 TS	192	int snd_efw_command_set_resp_addr(struct snd_efw *efw,
bde8a8f2 TS	193	u16 addr_high, u32 addr_low);
93219d06 TS	194	int snd_efw_command_set_tx_mode(struct snd_efw *efw,
93219d06 TS	195	enum snd_efw_transport_mode mode);
bde8a8f2 TS	196	int snd_efw_command_get_hwinfo(struct snd_efw *efw,
	197	struct snd_efw_hwinfo *hwinfo);
	198	int snd_efw_command_get_phys_meters(struct snd_efw *efw,
	199	struct snd_efw_phys_meters *meters,
	200	unsigned int len);
	201	int snd_efw_command_get_clock_source(struct snd_efw *efw,
	202	enum snd_efw_clock_source *source);
	203	int snd_efw_command_get_sampling_rate(struct snd_efw efw, unsigned int rate);
	204	int snd_efw_command_set_sampling_rate(struct snd_efw *efw, unsigned int rate);
b5b04336	205
315fd41f	206	int snd_efw_stream_init_duplex(struct snd_efw *efw);
4a286d55	207	int snd_efw_stream_start_duplex(struct snd_efw *efw, unsigned int rate);
315fd41f TS	208	void snd_efw_stream_stop_duplex(struct snd_efw *efw);
	209	void snd_efw_stream_update_duplex(struct snd_efw *efw);
	210	void snd_efw_stream_destroy_duplex(struct snd_efw *efw);
594ddced TS	211	void snd_efw_stream_lock_changed(struct snd_efw *efw);
	212	int snd_efw_stream_lock_try(struct snd_efw *efw);
	213	void snd_efw_stream_lock_release(struct snd_efw *efw);
315fd41f	214
6a22683e TS	215	void snd_efw_proc_init(struct snd_efw *efw);
6a22683e TS	216
a63d3ff1 TS	217	int snd_efw_create_midi_devices(struct snd_efw *efw);
a63d3ff1 TS	218
aa02bb6e TS	219	int snd_efw_create_pcm_devices(struct snd_efw *efw);
	220	int snd_efw_get_multiplier_mode(unsigned int sampling_rate, unsigned int *mode);
	221
594ddced TS	222	int snd_efw_create_hwdep_device(struct snd_efw *efw);
594ddced TS	223
b5b04336 TS	224	#define SND_EFW_DEV_ENTRY(vendor, model) \
	225	{ \
	226	.match_flags = IEEE1394_MATCH_VENDOR_ID \| \
	227	IEEE1394_MATCH_MODEL_ID, \
	228	.vendor_id = vendor,\
	229	.model_id = model \
	230	}
	231
	232	#endif