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

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

#ifndef SOUND_DICE_H_INCLUDED
#define SOUND_DICE_H_INCLUDED

#include <linux/compat.h>
#include <linux/completion.h>
#include <linux/delay.h>
#include <linux/device.h>
#include <linux/firewire.h>
#include <linux/firewire-constants.h>
#include <linux/jiffies.h>
#include <linux/module.h>
#include <linux/mod_devicetable.h>
#include <linux/mutex.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/wait.h>
#include <linux/sched/signal.h>

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

#include "../amdtp-am824.h"
#include "../iso-resources.h"
#include "../lib.h"
#include "dice-interface.h"

/*
 * This module support maximum 2 pairs of tx/rx isochronous streams for
 * our convinience.
 *
 * In documents for ASICs called with a name of 'DICE':
 *  - ASIC for DICE II:
 *   - Maximum 2 tx and 4 rx are supported.
 *   - A packet supports maximum 16 data channels.
 *  - TCD2210/2210-E (so-called 'Dice Mini'):
 *   - Maximum 2 tx and 2 rx are supported.
 *   - A packet supports maximum 16 data channels.
 *  - TCD2220/2220-E (so-called 'Dice Jr.')
 *   - 2 tx and 2 rx are supported.
 *   - A packet supports maximum 16 data channels.
 *  - TCD3070-CH (so-called 'Dice III')
 *   - Maximum 2 tx and 2 rx are supported.
 *   - A packet supports maximum 32 data channels.
 *
 * For the above, MIDI conformant data channel is just on the first isochronous
 * stream.
 */
#define MAX_STREAMS	2

enum snd_dice_rate_mode {
	SND_DICE_RATE_MODE_LOW = 0,
	SND_DICE_RATE_MODE_MIDDLE,
	SND_DICE_RATE_MODE_HIGH,
	SND_DICE_RATE_MODE_COUNT,
};

struct snd_dice;
typedef int (*snd_dice_detect_formats_t)(struct snd_dice *dice);

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

	bool registered;
	struct delayed_work dwork;

	/* Offsets for sub-addresses */
	unsigned int global_offset;
	unsigned int rx_offset;
	unsigned int tx_offset;
	unsigned int sync_offset;
	unsigned int rsrv_offset;

	unsigned int clock_caps;
	unsigned int tx_pcm_chs[MAX_STREAMS][SND_DICE_RATE_MODE_COUNT];
	unsigned int rx_pcm_chs[MAX_STREAMS][SND_DICE_RATE_MODE_COUNT];
	unsigned int tx_midi_ports[MAX_STREAMS];
	unsigned int rx_midi_ports[MAX_STREAMS];
	snd_dice_detect_formats_t detect_formats;

	struct fw_address_handler notification_handler;
	int owner_generation;
	u32 notification_bits;

	/* For uapi */
	int dev_lock_count; /* > 0 driver, < 0 userspace */
	bool dev_lock_changed;
	wait_queue_head_t hwdep_wait;

	/* For streaming */
	struct fw_iso_resources tx_resources[MAX_STREAMS];
	struct fw_iso_resources rx_resources[MAX_STREAMS];
	struct amdtp_stream tx_stream[MAX_STREAMS];
	struct amdtp_stream rx_stream[MAX_STREAMS];
	bool global_enabled;
	struct completion clock_accepted;
	unsigned int substreams_counter;
};

enum snd_dice_addr_type {
	SND_DICE_ADDR_TYPE_PRIVATE,
	SND_DICE_ADDR_TYPE_GLOBAL,
	SND_DICE_ADDR_TYPE_TX,
	SND_DICE_ADDR_TYPE_RX,
	SND_DICE_ADDR_TYPE_SYNC,
	SND_DICE_ADDR_TYPE_RSRV,
};

int snd_dice_transaction_write(struct snd_dice *dice,
			       enum snd_dice_addr_type type,
			       unsigned int offset,
			       void *buf, unsigned int len);
int snd_dice_transaction_read(struct snd_dice *dice,
			      enum snd_dice_addr_type type, unsigned int offset,
			      void *buf, unsigned int len);

static inline int snd_dice_transaction_write_global(struct snd_dice *dice,
						    unsigned int offset,
						    void *buf, unsigned int len)
{
	return snd_dice_transaction_write(dice,
					  SND_DICE_ADDR_TYPE_GLOBAL, offset,
					  buf, len);
}
static inline int snd_dice_transaction_read_global(struct snd_dice *dice,
						   unsigned int offset,
						   void *buf, unsigned int len)
{
	return snd_dice_transaction_read(dice,
					 SND_DICE_ADDR_TYPE_GLOBAL, offset,
					 buf, len);
}
static inline int snd_dice_transaction_write_tx(struct snd_dice *dice,
						unsigned int offset,
						void *buf, unsigned int len)
{
	return snd_dice_transaction_write(dice, SND_DICE_ADDR_TYPE_TX, offset,
					  buf, len);
}
static inline int snd_dice_transaction_read_tx(struct snd_dice *dice,
					       unsigned int offset,
					       void *buf, unsigned int len)
{
	return snd_dice_transaction_read(dice, SND_DICE_ADDR_TYPE_TX, offset,
					 buf, len);
}
static inline int snd_dice_transaction_write_rx(struct snd_dice *dice,
						unsigned int offset,
						void *buf, unsigned int len)
{
	return snd_dice_transaction_write(dice, SND_DICE_ADDR_TYPE_RX, offset,
					  buf, len);
}
static inline int snd_dice_transaction_read_rx(struct snd_dice *dice,
					       unsigned int offset,
					       void *buf, unsigned int len)
{
	return snd_dice_transaction_read(dice, SND_DICE_ADDR_TYPE_RX, offset,
					 buf, len);
}
static inline int snd_dice_transaction_write_sync(struct snd_dice *dice,
						  unsigned int offset,
						  void *buf, unsigned int len)
{
	return snd_dice_transaction_write(dice, SND_DICE_ADDR_TYPE_SYNC, offset,
					  buf, len);
}
static inline int snd_dice_transaction_read_sync(struct snd_dice *dice,
						 unsigned int offset,
						 void *buf, unsigned int len)
{
	return snd_dice_transaction_read(dice, SND_DICE_ADDR_TYPE_SYNC, offset,
					 buf, len);
}

int snd_dice_transaction_get_clock_source(struct snd_dice *dice,
					  unsigned int *source);
int snd_dice_transaction_get_rate(struct snd_dice *dice, unsigned int *rate);
int snd_dice_transaction_set_enable(struct snd_dice *dice);
void snd_dice_transaction_clear_enable(struct snd_dice *dice);
int snd_dice_transaction_init(struct snd_dice *dice);
int snd_dice_transaction_reinit(struct snd_dice *dice);
void snd_dice_transaction_destroy(struct snd_dice *dice);

#define SND_DICE_RATES_COUNT	7
extern const unsigned int snd_dice_rates[SND_DICE_RATES_COUNT];

int snd_dice_stream_get_rate_mode(struct snd_dice *dice, unsigned int rate,
				  enum snd_dice_rate_mode *mode);
int snd_dice_stream_start_duplex(struct snd_dice *dice, unsigned int rate);
void snd_dice_stream_stop_duplex(struct snd_dice *dice);
int snd_dice_stream_init_duplex(struct snd_dice *dice);
void snd_dice_stream_destroy_duplex(struct snd_dice *dice);
void snd_dice_stream_update_duplex(struct snd_dice *dice);
int snd_dice_stream_detect_current_formats(struct snd_dice *dice);

int snd_dice_stream_lock_try(struct snd_dice *dice);
void snd_dice_stream_lock_release(struct snd_dice *dice);

int snd_dice_create_pcm(struct snd_dice *dice);

int snd_dice_create_hwdep(struct snd_dice *dice);

void snd_dice_create_proc(struct snd_dice *dice);

int snd_dice_create_midi(struct snd_dice *dice);

int snd_dice_detect_tcelectronic_formats(struct snd_dice *dice);
int snd_dice_detect_alesis_formats(struct snd_dice *dice);
int snd_dice_detect_extension_formats(struct snd_dice *dice);
int snd_dice_detect_mytek_formats(struct snd_dice *dice);

#endif
Commit	Line	Data
7c2d4c0c TS	1	/*
	2	* dice.h - a part of driver for Dice based devices
	3	*
	4	* Copyright (c) Clemens Ladisch
	5	* Copyright (c) 2014 Takashi Sakamoto
	6	*
	7	* Licensed under the terms of the GNU General Public License, version 2.
	8	*/
	9
	10	#ifndef SOUND_DICE_H_INCLUDED
	11	#define SOUND_DICE_H_INCLUDED
	12
	13	#include <linux/compat.h>
	14	#include <linux/completion.h>
	15	#include <linux/delay.h>
	16	#include <linux/device.h>
	17	#include <linux/firewire.h>
	18	#include <linux/firewire-constants.h>
	19	#include <linux/jiffies.h>
	20	#include <linux/module.h>
	21	#include <linux/mod_devicetable.h>
	22	#include <linux/mutex.h>
	23	#include <linux/slab.h>
	24	#include <linux/spinlock.h>
	25	#include <linux/wait.h>
174cd4b1	26	#include <linux/sched/signal.h>
7c2d4c0c TS	27
	28	#include <sound/control.h>
	29	#include <sound/core.h>
	30	#include <sound/firewire.h>
	31	#include <sound/hwdep.h>
	32	#include <sound/info.h>
	33	#include <sound/initval.h>
	34	#include <sound/pcm.h>
	35	#include <sound/pcm_params.h>
a113ff88	36	#include <sound/rawmidi.h>
7c2d4c0c	37
5955815e	38	#include "../amdtp-am824.h"
7c2d4c0c TS	39	#include "../iso-resources.h"
	40	#include "../lib.h"
	41	#include "dice-interface.h"
	42
8ae25b76 TS	43	/*
	44	* This module support maximum 2 pairs of tx/rx isochronous streams for
	45	* our convinience.
	46	*
	47	* In documents for ASICs called with a name of 'DICE':
	48	* - ASIC for DICE II:
	49	* - Maximum 2 tx and 4 rx are supported.
	50	* - A packet supports maximum 16 data channels.
	51	* - TCD2210/2210-E (so-called 'Dice Mini'):
	52	* - Maximum 2 tx and 2 rx are supported.
	53	* - A packet supports maximum 16 data channels.
	54	* - TCD2220/2220-E (so-called 'Dice Jr.')
	55	* - 2 tx and 2 rx are supported.
	56	* - A packet supports maximum 16 data channels.
	57	* - TCD3070-CH (so-called 'Dice III')
	58	* - Maximum 2 tx and 2 rx are supported.
	59	* - A packet supports maximum 32 data channels.
	60	*
	61	* For the above, MIDI conformant data channel is just on the first isochronous
	62	* stream.
	63	*/
	64	#define MAX_STREAMS 2
	65
8feda7dd TS	66	enum snd_dice_rate_mode {
	67	SND_DICE_RATE_MODE_LOW = 0,
	68	SND_DICE_RATE_MODE_MIDDLE,
	69	SND_DICE_RATE_MODE_HIGH,
	70	SND_DICE_RATE_MODE_COUNT,
	71	};
	72
f1f0f330 TS	73	struct snd_dice;
	74	typedef int (snd_dice_detect_formats_t)(struct snd_dice dice);
	75
7c2d4c0c TS	76	struct snd_dice {
	77	struct snd_card *card;
	78	struct fw_unit *unit;
	79	spinlock_t lock;
	80	struct mutex mutex;
	81
b59fb190 TS	82	bool registered;
	83	struct delayed_work dwork;
	84
7c2d4c0c TS	85	/* Offsets for sub-addresses */
	86	unsigned int global_offset;
	87	unsigned int rx_offset;
	88	unsigned int tx_offset;
	89	unsigned int sync_offset;
	90	unsigned int rsrv_offset;
	91
	92	unsigned int clock_caps;
8feda7dd TS	93	unsigned int tx_pcm_chs[MAX_STREAMS][SND_DICE_RATE_MODE_COUNT];
	94	unsigned int rx_pcm_chs[MAX_STREAMS][SND_DICE_RATE_MODE_COUNT];
	95	unsigned int tx_midi_ports[MAX_STREAMS];
	96	unsigned int rx_midi_ports[MAX_STREAMS];
f1f0f330	97	snd_dice_detect_formats_t detect_formats;
9a02843c	98
7c2d4c0c TS	99	struct fw_address_handler notification_handler;
7c2d4c0c TS	100	int owner_generation;
9a02843c TS	101	u32 notification_bits;
	102
	103	/* For uapi */
7c2d4c0c TS	104	int dev_lock_count; /* > 0 driver, < 0 userspace */
7c2d4c0c TS	105	bool dev_lock_changed;
7c2d4c0c	106	wait_queue_head_t hwdep_wait;
9a02843c TS	107
9a02843c TS	108	/* For streaming */
8ae25b76 TS	109	struct fw_iso_resources tx_resources[MAX_STREAMS];
	110	struct fw_iso_resources rx_resources[MAX_STREAMS];
	111	struct amdtp_stream tx_stream[MAX_STREAMS];
	112	struct amdtp_stream rx_stream[MAX_STREAMS];
9a02843c TS	113	bool global_enabled;
	114	struct completion clock_accepted;
	115	unsigned int substreams_counter;
7c2d4c0c TS	116	};
	117
	118	enum snd_dice_addr_type {
	119	SND_DICE_ADDR_TYPE_PRIVATE,
	120	SND_DICE_ADDR_TYPE_GLOBAL,
	121	SND_DICE_ADDR_TYPE_TX,
	122	SND_DICE_ADDR_TYPE_RX,
	123	SND_DICE_ADDR_TYPE_SYNC,
	124	SND_DICE_ADDR_TYPE_RSRV,
	125	};
	126
	127	int snd_dice_transaction_write(struct snd_dice *dice,
	128	enum snd_dice_addr_type type,
	129	unsigned int offset,
	130	void *buf, unsigned int len);
	131	int snd_dice_transaction_read(struct snd_dice *dice,
	132	enum snd_dice_addr_type type, unsigned int offset,
	133	void *buf, unsigned int len);
	134
	135	static inline int snd_dice_transaction_write_global(struct snd_dice *dice,
	136	unsigned int offset,
	137	void *buf, unsigned int len)
	138	{
	139	return snd_dice_transaction_write(dice,
	140	SND_DICE_ADDR_TYPE_GLOBAL, offset,
	141	buf, len);
	142	}
	143	static inline int snd_dice_transaction_read_global(struct snd_dice *dice,
	144	unsigned int offset,
	145	void *buf, unsigned int len)
	146	{
	147	return snd_dice_transaction_read(dice,
	148	SND_DICE_ADDR_TYPE_GLOBAL, offset,
	149	buf, len);
	150	}
	151	static inline int snd_dice_transaction_write_tx(struct snd_dice *dice,
	152	unsigned int offset,
	153	void *buf, unsigned int len)
	154	{
	155	return snd_dice_transaction_write(dice, SND_DICE_ADDR_TYPE_TX, offset,
	156	buf, len);
	157	}
	158	static inline int snd_dice_transaction_read_tx(struct snd_dice *dice,
	159	unsigned int offset,
	160	void *buf, unsigned int len)
	161	{
	162	return snd_dice_transaction_read(dice, SND_DICE_ADDR_TYPE_TX, offset,
	163	buf, len);
	164	}
	165	static inline int snd_dice_transaction_write_rx(struct snd_dice *dice,
	166	unsigned int offset,
	167	void *buf, unsigned int len)
	168	{
	169	return snd_dice_transaction_write(dice, SND_DICE_ADDR_TYPE_RX, offset,
	170	buf, len);
	171	}
	172	static inline int snd_dice_transaction_read_rx(struct snd_dice *dice,
	173	unsigned int offset,
	174	void *buf, unsigned int len)
	175	{
	176	return snd_dice_transaction_read(dice, SND_DICE_ADDR_TYPE_RX, offset,
	177	buf, len);
	178	}
	179	static inline int snd_dice_transaction_write_sync(struct snd_dice *dice,
180	unsigned int offset,
181	void *buf, unsigned int len)
182	{
183	return snd_dice_transaction_write(dice, SND_DICE_ADDR_TYPE_SYNC, offset,
184	buf, len);
185	}
186	static inline int snd_dice_transaction_read_sync(struct snd_dice *dice,
187	unsigned int offset,
188	void *buf, unsigned int len)
189	{
190	return snd_dice_transaction_read(dice, SND_DICE_ADDR_TYPE_SYNC, offset,
191	buf, len);
192	}
193
7c2d4c0c TS	194	int snd_dice_transaction_get_clock_source(struct snd_dice *dice,
7c2d4c0c TS	195	unsigned int *source);
7c2d4c0c TS	196	int snd_dice_transaction_get_rate(struct snd_dice dice, unsigned int rate);
	197	int snd_dice_transaction_set_enable(struct snd_dice *dice);
	198	void snd_dice_transaction_clear_enable(struct snd_dice *dice);
	199	int snd_dice_transaction_init(struct snd_dice *dice);
	200	int snd_dice_transaction_reinit(struct snd_dice *dice);
	201	void snd_dice_transaction_destroy(struct snd_dice *dice);
	202
	203	#define SND_DICE_RATES_COUNT 7
	204	extern const unsigned int snd_dice_rates[SND_DICE_RATES_COUNT];
	205
b60152f7 TS	206	int snd_dice_stream_get_rate_mode(struct snd_dice *dice, unsigned int rate,
b60152f7 TS	207	enum snd_dice_rate_mode *mode);
9a02843c TS	208	int snd_dice_stream_start_duplex(struct snd_dice *dice, unsigned int rate);
	209	void snd_dice_stream_stop_duplex(struct snd_dice *dice);
	210	int snd_dice_stream_init_duplex(struct snd_dice *dice);
	211	void snd_dice_stream_destroy_duplex(struct snd_dice *dice);
	212	void snd_dice_stream_update_duplex(struct snd_dice *dice);
b60152f7	213	int snd_dice_stream_detect_current_formats(struct snd_dice *dice);
6eb6c81e TS	214
	215	int snd_dice_stream_lock_try(struct snd_dice *dice);
	216	void snd_dice_stream_lock_release(struct snd_dice *dice);
	217
c50fb91f TS	218	int snd_dice_create_pcm(struct snd_dice *dice);
c50fb91f TS	219
19af57b4 TS	220	int snd_dice_create_hwdep(struct snd_dice *dice);
19af57b4 TS	221
04d426a0 TS	222	void snd_dice_create_proc(struct snd_dice *dice);
04d426a0 TS	223
a113ff88 TS	224	int snd_dice_create_midi(struct snd_dice *dice);
a113ff88 TS	225
f1f0f330	226	int snd_dice_detect_tcelectronic_formats(struct snd_dice *dice);
28b208f6	227	int snd_dice_detect_alesis_formats(struct snd_dice *dice);
58579c05	228	int snd_dice_detect_extension_formats(struct snd_dice *dice);
7c1543f6	229	int snd_dice_detect_mytek_formats(struct snd_dice *dice);
f1f0f330	230
7c2d4c0c	231	#endif