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

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * dice.h - a part of driver for Dice based devices
 *
 * Copyright (c) Clemens Ladisch
 * Copyright (c) 2014 Takashi Sakamoto
 */

#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;

	struct amdtp_domain domain;
};

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);
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);
int snd_dice_stream_reserve_duplex(struct snd_dice *dice, unsigned int rate);
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);
int snd_dice_detect_presonus_formats(struct snd_dice *dice);

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