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

/*
 * bebob.h - a part of driver for BeBoB based devices
 *
 * Copyright (c) 2013-2014 Takashi Sakamoto
 *
 * Licensed under the terms of the GNU General Public License, version 2.
 */

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

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

/* basic register addresses on DM1000/DM1100/DM1500 */
#define BEBOB_ADDR_REG_INFO	0xffffc8020000ULL
#define BEBOB_ADDR_REG_REQ	0xffffc8021000ULL

struct snd_bebob;

#define SND_BEBOB_STRM_FMT_ENTRIES	7
struct snd_bebob_stream_formation {
	unsigned int pcm;
	unsigned int midi;
};
/* this is a lookup table for index of stream formations */
extern const unsigned int snd_bebob_rate_table[SND_BEBOB_STRM_FMT_ENTRIES];

/* device specific operations */
enum snd_bebob_clock_type {
	SND_BEBOB_CLOCK_TYPE_INTERNAL = 0,
	SND_BEBOB_CLOCK_TYPE_EXTERNAL,
	SND_BEBOB_CLOCK_TYPE_SYT,
};
struct snd_bebob_clock_spec {
	unsigned int num;
	const char *const *labels;
	enum snd_bebob_clock_type *types;
	int (*get)(struct snd_bebob *bebob, unsigned int *id);
};
struct snd_bebob_rate_spec {
	int (*get)(struct snd_bebob *bebob, unsigned int *rate);
	int (*set)(struct snd_bebob *bebob, unsigned int rate);
};
struct snd_bebob_meter_spec {
	unsigned int num;
	const char *const *labels;
	int (*get)(struct snd_bebob *bebob, u32 *target, unsigned int size);
};
struct snd_bebob_spec {
	struct snd_bebob_clock_spec *clock;
	struct snd_bebob_rate_spec *rate;
	struct snd_bebob_meter_spec *meter;
};

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

	struct mutex mutex;
	spinlock_t lock;

	const struct snd_bebob_spec *spec;

	unsigned int midi_input_ports;
	unsigned int midi_output_ports;

	/* for bus reset quirk */
	struct completion bus_reset;
	bool connected;

	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;

	struct snd_bebob_stream_formation
		tx_stream_formations[SND_BEBOB_STRM_FMT_ENTRIES];
	struct snd_bebob_stream_formation
		rx_stream_formations[SND_BEBOB_STRM_FMT_ENTRIES];

	int sync_input_plug;

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

	/* for M-Audio special devices */
	void *maudio_special_quirk;
	bool deferred_registration;
};

static inline int
snd_bebob_read_block(struct fw_unit *unit, u64 addr, void *buf, int size)
{
	return snd_fw_transaction(unit, TCODE_READ_BLOCK_REQUEST,
				  BEBOB_ADDR_REG_INFO + addr,
				  buf, size, 0);
}

static inline int
snd_bebob_read_quad(struct fw_unit *unit, u64 addr, u32 *buf)
{
	return snd_fw_transaction(unit, TCODE_READ_QUADLET_REQUEST,
				  BEBOB_ADDR_REG_INFO + addr,
				  (void *)buf, sizeof(u32), 0);
}

/* AV/C Audio Subunit Specification 1.0 (Oct 2000, 1394TA) */
int avc_audio_set_selector(struct fw_unit *unit, unsigned int subunit_id,
			   unsigned int fb_id, unsigned int num);
int avc_audio_get_selector(struct fw_unit *unit, unsigned  int subunit_id,
			   unsigned int fb_id, unsigned int *num);

/*
 * AVC command extensions, AV/C Unit and Subunit, Revision 17
 * (Nov 2003, BridgeCo)
 */
#define	AVC_BRIDGECO_ADDR_BYTES	6
enum avc_bridgeco_plug_dir {
	AVC_BRIDGECO_PLUG_DIR_IN	= 0x00,
	AVC_BRIDGECO_PLUG_DIR_OUT	= 0x01
};
enum avc_bridgeco_plug_mode {
	AVC_BRIDGECO_PLUG_MODE_UNIT		= 0x00,
	AVC_BRIDGECO_PLUG_MODE_SUBUNIT		= 0x01,
	AVC_BRIDGECO_PLUG_MODE_FUNCTION_BLOCK	= 0x02
};
enum avc_bridgeco_plug_unit {
	AVC_BRIDGECO_PLUG_UNIT_ISOC	= 0x00,
	AVC_BRIDGECO_PLUG_UNIT_EXT	= 0x01,
	AVC_BRIDGECO_PLUG_UNIT_ASYNC	= 0x02
};
enum avc_bridgeco_plug_type {
	AVC_BRIDGECO_PLUG_TYPE_ISOC	= 0x00,
	AVC_BRIDGECO_PLUG_TYPE_ASYNC	= 0x01,
	AVC_BRIDGECO_PLUG_TYPE_MIDI	= 0x02,
	AVC_BRIDGECO_PLUG_TYPE_SYNC	= 0x03,
	AVC_BRIDGECO_PLUG_TYPE_ANA	= 0x04,
	AVC_BRIDGECO_PLUG_TYPE_DIG	= 0x05,
	AVC_BRIDGECO_PLUG_TYPE_ADDITION	= 0x06
};
static inline void
avc_bridgeco_fill_unit_addr(u8 buf[AVC_BRIDGECO_ADDR_BYTES],
			    enum avc_bridgeco_plug_dir dir,
			    enum avc_bridgeco_plug_unit unit,
			    unsigned int pid)
{
	buf[0] = 0xff;	/* Unit */
	buf[1] = dir;
	buf[2] = AVC_BRIDGECO_PLUG_MODE_UNIT;
	buf[3] = unit;
	buf[4] = 0xff & pid;
	buf[5] = 0xff;	/* reserved */
}
static inline void
avc_bridgeco_fill_msu_addr(u8 buf[AVC_BRIDGECO_ADDR_BYTES],
			   enum avc_bridgeco_plug_dir dir,
			   unsigned int pid)
{
	buf[0] = 0x60;	/* Music subunit */
	buf[1] = dir;
	buf[2] = AVC_BRIDGECO_PLUG_MODE_SUBUNIT;
	buf[3] = 0xff & pid;
	buf[4] = 0xff;	/* reserved */
	buf[5] = 0xff;	/* reserved */
}
int avc_bridgeco_get_plug_ch_pos(struct fw_unit *unit,
				 u8 addr[AVC_BRIDGECO_ADDR_BYTES],
				 u8 *buf, unsigned int len);
int avc_bridgeco_get_plug_type(struct fw_unit *unit,
			       u8 addr[AVC_BRIDGECO_ADDR_BYTES],
			       enum avc_bridgeco_plug_type *type);
int avc_bridgeco_get_plug_section_type(struct fw_unit *unit,
				       u8 addr[AVC_BRIDGECO_ADDR_BYTES],
				       unsigned int id, u8 *type);
int avc_bridgeco_get_plug_input(struct fw_unit *unit,
				u8 addr[AVC_BRIDGECO_ADDR_BYTES],
				u8 input[7]);
int avc_bridgeco_get_plug_strm_fmt(struct fw_unit *unit,
				   u8 addr[AVC_BRIDGECO_ADDR_BYTES], u8 *buf,
				   unsigned int *len, unsigned int eid);

/* for AMDTP streaming */
int snd_bebob_stream_get_rate(struct snd_bebob *bebob, unsigned int *rate);
int snd_bebob_stream_set_rate(struct snd_bebob *bebob, unsigned int rate);
int snd_bebob_stream_get_clock_src(struct snd_bebob *bebob,
				   enum snd_bebob_clock_type *src);
int snd_bebob_stream_discover(struct snd_bebob *bebob);
int snd_bebob_stream_init_duplex(struct snd_bebob *bebob);
int snd_bebob_stream_start_duplex(struct snd_bebob *bebob, unsigned int rate);
void snd_bebob_stream_stop_duplex(struct snd_bebob *bebob);
void snd_bebob_stream_update_duplex(struct snd_bebob *bebob);
void snd_bebob_stream_destroy_duplex(struct snd_bebob *bebob);

void snd_bebob_stream_lock_changed(struct snd_bebob *bebob);
int snd_bebob_stream_lock_try(struct snd_bebob *bebob);
void snd_bebob_stream_lock_release(struct snd_bebob *bebob);

void snd_bebob_proc_init(struct snd_bebob *bebob);

int snd_bebob_create_midi_devices(struct snd_bebob *bebob);

int snd_bebob_create_pcm_devices(struct snd_bebob *bebob);

int snd_bebob_create_hwdep_device(struct snd_bebob *bebob);

/* model specific operations */
extern struct snd_bebob_spec phase88_rack_spec;
extern struct snd_bebob_spec phase24_series_spec;
extern struct snd_bebob_spec yamaha_go_spec;
extern struct snd_bebob_spec saffirepro_26_spec;
extern struct snd_bebob_spec saffirepro_10_spec;
extern struct snd_bebob_spec saffire_le_spec;
extern struct snd_bebob_spec saffire_spec;
extern struct snd_bebob_spec maudio_fw410_spec;
extern struct snd_bebob_spec maudio_audiophile_spec;
extern struct snd_bebob_spec maudio_solo_spec;
extern struct snd_bebob_spec maudio_ozonic_spec;
extern struct snd_bebob_spec maudio_nrv10_spec;
extern struct snd_bebob_spec maudio_special_spec;
int snd_bebob_maudio_special_discover(struct snd_bebob *bebob, bool is1814);
int snd_bebob_maudio_load_firmware(struct fw_unit *unit);

#define SND_BEBOB_DEV_ENTRY(vendor, model, data) \
{ \
	.match_flags	= IEEE1394_MATCH_VENDOR_ID | \
			  IEEE1394_MATCH_MODEL_ID, \
	.vendor_id	= vendor, \
	.model_id	= model, \
	.driver_data	= (kernel_ulong_t)data \
}

#endif
Commit	Line	Data
fd6f4b0d TS	1	/*
	2	* bebob.h - a part of driver for BeBoB based devices
	3	*
	4	* Copyright (c) 2013-2014 Takashi Sakamoto
	5	*
	6	* Licensed under the terms of the GNU General Public License, version 2.
	7	*/
	8
	9	#ifndef SOUND_BEBOB_H_INCLUDED
	10	#define SOUND_BEBOB_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>
ad9697ba	23	#include <sound/info.h>
248b7802	24	#include <sound/rawmidi.h>
fbbebd2c TS	25	#include <sound/pcm.h>
fbbebd2c TS	26	#include <sound/pcm_params.h>
618eabea TS	27	#include <sound/firewire.h>
618eabea TS	28	#include <sound/hwdep.h>
fd6f4b0d TS	29
	30	#include "../lib.h"
	31	#include "../fcp.h"
eb7b3a05 TS	32	#include "../packets-buffer.h"
	33	#include "../iso-resources.h"
	34	#include "../amdtp.h"
	35	#include "../cmp.h"
fd6f4b0d TS	36
fd6f4b0d TS	37	/* basic register addresses on DM1000/DM1100/DM1500 */
9b5f0edf TS	38	#define BEBOB_ADDR_REG_INFO 0xffffc8020000ULL
9b5f0edf TS	39	#define BEBOB_ADDR_REG_REQ 0xffffc8021000ULL
fd6f4b0d	40
eb7b3a05 TS	41	struct snd_bebob;
	42
	43	#define SND_BEBOB_STRM_FMT_ENTRIES 7
	44	struct snd_bebob_stream_formation {
	45	unsigned int pcm;
	46	unsigned int midi;
	47	};
	48	/* this is a lookup table for index of stream formations */
	49	extern const unsigned int snd_bebob_rate_table[SND_BEBOB_STRM_FMT_ENTRIES];
	50
1fc9522a	51	/* device specific operations */
13a4f420 TS	52	enum snd_bebob_clock_type {
	53	SND_BEBOB_CLOCK_TYPE_INTERNAL = 0,
	54	SND_BEBOB_CLOCK_TYPE_EXTERNAL,
	55	SND_BEBOB_CLOCK_TYPE_SYT,
	56	};
1fc9522a TS	57	struct snd_bebob_clock_spec {
1fc9522a TS	58	unsigned int num;
e7ced413	59	const char const labels;
13a4f420	60	enum snd_bebob_clock_type *types;
1fc9522a TS	61	int (get)(struct snd_bebob bebob, unsigned int *id);
	62	};
	63	struct snd_bebob_rate_spec {
	64	int (get)(struct snd_bebob bebob, unsigned int *rate);
	65	int (set)(struct snd_bebob bebob, unsigned int rate);
	66	};
	67	struct snd_bebob_meter_spec {
	68	unsigned int num;
e7ced413	69	const char const labels;
1fc9522a TS	70	int (get)(struct snd_bebob bebob, u32 *target, unsigned int size);
	71	};
	72	struct snd_bebob_spec {
	73	struct snd_bebob_clock_spec *clock;
	74	struct snd_bebob_rate_spec *rate;
	75	struct snd_bebob_meter_spec *meter;
	76	};
	77
fd6f4b0d TS	78	struct snd_bebob {
	79	struct snd_card *card;
	80	struct fw_unit *unit;
	81	int card_index;
	82
	83	struct mutex mutex;
	84	spinlock_t lock;
eb7b3a05	85
1fc9522a TS	86	const struct snd_bebob_spec *spec;
1fc9522a TS	87
eb7b3a05 TS	88	unsigned int midi_input_ports;
	89	unsigned int midi_output_ports;
	90
b6bc8123 TS	91	/* for bus reset quirk */
	92	struct completion bus_reset;
	93	bool connected;
	94
eb7b3a05 TS	95	struct amdtp_stream *master;
	96	struct amdtp_stream tx_stream;
	97	struct amdtp_stream rx_stream;
	98	struct cmp_connection out_conn;
	99	struct cmp_connection in_conn;
	100	atomic_t capture_substreams;
	101	atomic_t playback_substreams;
	102
	103	struct snd_bebob_stream_formation
	104	tx_stream_formations[SND_BEBOB_STRM_FMT_ENTRIES];
	105	struct snd_bebob_stream_formation
	106	rx_stream_formations[SND_BEBOB_STRM_FMT_ENTRIES];
	107
	108	int sync_input_plug;
618eabea TS	109
	110	/* for uapi */
	111	int dev_lock_count;
	112	bool dev_lock_changed;
	113	wait_queue_head_t hwdep_wait;
3149ac48 TS	114
	115	/* for M-Audio special devices */
	116	void *maudio_special_quirk;
9b1ee0b2	117	bool deferred_registration;
fd6f4b0d TS	118	};
	119
	120	static inline int
	121	snd_bebob_read_block(struct fw_unit unit, u64 addr, void buf, int size)
	122	{
	123	return snd_fw_transaction(unit, TCODE_READ_BLOCK_REQUEST,
	124	BEBOB_ADDR_REG_INFO + addr,
	125	buf, size, 0);
	126	}
	127
	128	static inline int
	129	snd_bebob_read_quad(struct fw_unit unit, u64 addr, u32 buf)
	130	{
	131	return snd_fw_transaction(unit, TCODE_READ_QUADLET_REQUEST,
	132	BEBOB_ADDR_REG_INFO + addr,
	133	(void *)buf, sizeof(u32), 0);
	134	}
	135
1fc9522a TS	136	/* AV/C Audio Subunit Specification 1.0 (Oct 2000, 1394TA) */
	137	int avc_audio_set_selector(struct fw_unit *unit, unsigned int subunit_id,
	138	unsigned int fb_id, unsigned int num);
	139	int avc_audio_get_selector(struct fw_unit *unit, unsigned int subunit_id,
	140	unsigned int fb_id, unsigned int *num);
	141
eb7b3a05 TS	142	/*
	143	* AVC command extensions, AV/C Unit and Subunit, Revision 17
	144	* (Nov 2003, BridgeCo)
	145	*/
	146	#define AVC_BRIDGECO_ADDR_BYTES 6
	147	enum avc_bridgeco_plug_dir {
	148	AVC_BRIDGECO_PLUG_DIR_IN = 0x00,
	149	AVC_BRIDGECO_PLUG_DIR_OUT = 0x01
	150	};
	151	enum avc_bridgeco_plug_mode {
	152	AVC_BRIDGECO_PLUG_MODE_UNIT = 0x00,
	153	AVC_BRIDGECO_PLUG_MODE_SUBUNIT = 0x01,
	154	AVC_BRIDGECO_PLUG_MODE_FUNCTION_BLOCK = 0x02
	155	};
	156	enum avc_bridgeco_plug_unit {
	157	AVC_BRIDGECO_PLUG_UNIT_ISOC = 0x00,
	158	AVC_BRIDGECO_PLUG_UNIT_EXT = 0x01,
	159	AVC_BRIDGECO_PLUG_UNIT_ASYNC = 0x02
	160	};
	161	enum avc_bridgeco_plug_type {
	162	AVC_BRIDGECO_PLUG_TYPE_ISOC = 0x00,
	163	AVC_BRIDGECO_PLUG_TYPE_ASYNC = 0x01,
	164	AVC_BRIDGECO_PLUG_TYPE_MIDI = 0x02,
	165	AVC_BRIDGECO_PLUG_TYPE_SYNC = 0x03,
	166	AVC_BRIDGECO_PLUG_TYPE_ANA = 0x04,
5a668812 TS	167	AVC_BRIDGECO_PLUG_TYPE_DIG = 0x05,
5a668812 TS	168	AVC_BRIDGECO_PLUG_TYPE_ADDITION = 0x06
eb7b3a05 TS	169	};
	170	static inline void
	171	avc_bridgeco_fill_unit_addr(u8 buf[AVC_BRIDGECO_ADDR_BYTES],
	172	enum avc_bridgeco_plug_dir dir,
	173	enum avc_bridgeco_plug_unit unit,
	174	unsigned int pid)
	175	{
	176	buf[0] = 0xff; /* Unit */
	177	buf[1] = dir;
	178	buf[2] = AVC_BRIDGECO_PLUG_MODE_UNIT;
	179	buf[3] = unit;
	180	buf[4] = 0xff & pid;
	181	buf[5] = 0xff; /* reserved */
	182	}
	183	static inline void
	184	avc_bridgeco_fill_msu_addr(u8 buf[AVC_BRIDGECO_ADDR_BYTES],
	185	enum avc_bridgeco_plug_dir dir,
	186	unsigned int pid)
	187	{
	188	buf[0] = 0x60; /* Music subunit */
	189	buf[1] = dir;
	190	buf[2] = AVC_BRIDGECO_PLUG_MODE_SUBUNIT;
	191	buf[3] = 0xff & pid;
	192	buf[4] = 0xff; /* reserved */
	193	buf[5] = 0xff; /* reserved */
	194	}
	195	int avc_bridgeco_get_plug_ch_pos(struct fw_unit *unit,
	196	u8 addr[AVC_BRIDGECO_ADDR_BYTES],
	197	u8 *buf, unsigned int len);
	198	int avc_bridgeco_get_plug_type(struct fw_unit *unit,
	199	u8 addr[AVC_BRIDGECO_ADDR_BYTES],
	200	enum avc_bridgeco_plug_type *type);
	201	int avc_bridgeco_get_plug_section_type(struct fw_unit *unit,
	202	u8 addr[AVC_BRIDGECO_ADDR_BYTES],
	203	unsigned int id, u8 *type);
	204	int avc_bridgeco_get_plug_input(struct fw_unit *unit,
	205	u8 addr[AVC_BRIDGECO_ADDR_BYTES],
	206	u8 input[7]);
	207	int avc_bridgeco_get_plug_strm_fmt(struct fw_unit *unit,
	208	u8 addr[AVC_BRIDGECO_ADDR_BYTES], u8 *buf,
	209	unsigned int *len, unsigned int eid);
	210
	211	/* for AMDTP streaming */
	212	int snd_bebob_stream_get_rate(struct snd_bebob bebob, unsigned int rate);
	213	int snd_bebob_stream_set_rate(struct snd_bebob *bebob, unsigned int rate);
3e254b16 TS	214	int snd_bebob_stream_get_clock_src(struct snd_bebob *bebob,
3e254b16 TS	215	enum snd_bebob_clock_type *src);
eb7b3a05	216	int snd_bebob_stream_discover(struct snd_bebob *bebob);
eb7b3a05	217	int snd_bebob_stream_init_duplex(struct snd_bebob *bebob);
4a286d55	218	int snd_bebob_stream_start_duplex(struct snd_bebob *bebob, unsigned int rate);
eb7b3a05 TS	219	void snd_bebob_stream_stop_duplex(struct snd_bebob *bebob);
	220	void snd_bebob_stream_update_duplex(struct snd_bebob *bebob);
	221	void snd_bebob_stream_destroy_duplex(struct snd_bebob *bebob);
	222
618eabea TS	223	void snd_bebob_stream_lock_changed(struct snd_bebob *bebob);
	224	int snd_bebob_stream_lock_try(struct snd_bebob *bebob);
	225	void snd_bebob_stream_lock_release(struct snd_bebob *bebob);
	226
ad9697ba TS	227	void snd_bebob_proc_init(struct snd_bebob *bebob);
ad9697ba TS	228
248b7802 TS	229	int snd_bebob_create_midi_devices(struct snd_bebob *bebob);
248b7802 TS	230
fbbebd2c TS	231	int snd_bebob_create_pcm_devices(struct snd_bebob *bebob);
fbbebd2c TS	232
618eabea TS	233	int snd_bebob_create_hwdep_device(struct snd_bebob *bebob);
618eabea TS	234
326b9cac TS	235	/* model specific operations */
	236	extern struct snd_bebob_spec phase88_rack_spec;
	237	extern struct snd_bebob_spec phase24_series_spec;
8ac98a35	238	extern struct snd_bebob_spec yamaha_go_spec;
25784ec2 TS	239	extern struct snd_bebob_spec saffirepro_26_spec;
	240	extern struct snd_bebob_spec saffirepro_10_spec;
	241	extern struct snd_bebob_spec saffire_le_spec;
	242	extern struct snd_bebob_spec saffire_spec;
9076c22d TS	243	extern struct snd_bebob_spec maudio_fw410_spec;
	244	extern struct snd_bebob_spec maudio_audiophile_spec;
	245	extern struct snd_bebob_spec maudio_solo_spec;
	246	extern struct snd_bebob_spec maudio_ozonic_spec;
	247	extern struct snd_bebob_spec maudio_nrv10_spec;
3149ac48 TS	248	extern struct snd_bebob_spec maudio_special_spec;
3149ac48 TS	249	int snd_bebob_maudio_special_discover(struct snd_bebob *bebob, bool is1814);
a2b2a779	250	int snd_bebob_maudio_load_firmware(struct fw_unit *unit);
326b9cac	251
1fc9522a	252	#define SND_BEBOB_DEV_ENTRY(vendor, model, data) \
fd6f4b0d TS	253	{ \
	254	.match_flags = IEEE1394_MATCH_VENDOR_ID \| \
	255	IEEE1394_MATCH_MODEL_ID, \
	256	.vendor_id = vendor, \
	257	.model_id = model, \
1fc9522a	258	.driver_data = (kernel_ulong_t)data \
fd6f4b0d TS	259	}
	260
	261	#endif