[deliverable/linux.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 <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"

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;

	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;
	struct fw_iso_resources rx_resources;
	struct amdtp_stream tx_stream;
	struct amdtp_stream rx_stream;
	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_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_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);

#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>
	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
	42	struct snd_dice {
	43	struct snd_card *card;
	44	struct fw_unit *unit;
	45	spinlock_t lock;
	46	struct mutex mutex;
	47
b59fb190 TS	48	bool registered;
	49	struct delayed_work dwork;
	50
7c2d4c0c TS	51	/* Offsets for sub-addresses */
	52	unsigned int global_offset;
	53	unsigned int rx_offset;
	54	unsigned int tx_offset;
	55	unsigned int sync_offset;
	56	unsigned int rsrv_offset;
	57
	58	unsigned int clock_caps;
9a02843c	59
7c2d4c0c TS	60	struct fw_address_handler notification_handler;
7c2d4c0c TS	61	int owner_generation;
9a02843c TS	62	u32 notification_bits;
	63
	64	/* For uapi */
7c2d4c0c TS	65	int dev_lock_count; /* > 0 driver, < 0 userspace */
7c2d4c0c TS	66	bool dev_lock_changed;
7c2d4c0c	67	wait_queue_head_t hwdep_wait;
9a02843c TS	68
	69	/* For streaming */
	70	struct fw_iso_resources tx_resources;
7c2d4c0c	71	struct fw_iso_resources rx_resources;
9a02843c	72	struct amdtp_stream tx_stream;
7c2d4c0c	73	struct amdtp_stream rx_stream;
9a02843c TS	74	bool global_enabled;
	75	struct completion clock_accepted;
	76	unsigned int substreams_counter;
7c2d4c0c TS	77	};
	78
	79	enum snd_dice_addr_type {
	80	SND_DICE_ADDR_TYPE_PRIVATE,
	81	SND_DICE_ADDR_TYPE_GLOBAL,
	82	SND_DICE_ADDR_TYPE_TX,
	83	SND_DICE_ADDR_TYPE_RX,
	84	SND_DICE_ADDR_TYPE_SYNC,
	85	SND_DICE_ADDR_TYPE_RSRV,
	86	};
	87
	88	int snd_dice_transaction_write(struct snd_dice *dice,
	89	enum snd_dice_addr_type type,
	90	unsigned int offset,
	91	void *buf, unsigned int len);
	92	int snd_dice_transaction_read(struct snd_dice *dice,
	93	enum snd_dice_addr_type type, unsigned int offset,
	94	void *buf, unsigned int len);
	95
	96	static inline int snd_dice_transaction_write_global(struct snd_dice *dice,
	97	unsigned int offset,
	98	void *buf, unsigned int len)
	99	{
	100	return snd_dice_transaction_write(dice,
	101	SND_DICE_ADDR_TYPE_GLOBAL, offset,
	102	buf, len);
	103	}
	104	static inline int snd_dice_transaction_read_global(struct snd_dice *dice,
	105	unsigned int offset,
	106	void *buf, unsigned int len)
	107	{
	108	return snd_dice_transaction_read(dice,
	109	SND_DICE_ADDR_TYPE_GLOBAL, offset,
	110	buf, len);
	111	}
	112	static inline int snd_dice_transaction_write_tx(struct snd_dice *dice,
	113	unsigned int offset,
	114	void *buf, unsigned int len)
	115	{
	116	return snd_dice_transaction_write(dice, SND_DICE_ADDR_TYPE_TX, offset,
	117	buf, len);
	118	}
	119	static inline int snd_dice_transaction_read_tx(struct snd_dice *dice,
	120	unsigned int offset,
	121	void *buf, unsigned int len)
	122	{
	123	return snd_dice_transaction_read(dice, SND_DICE_ADDR_TYPE_TX, offset,
	124	buf, len);
	125	}
	126	static inline int snd_dice_transaction_write_rx(struct snd_dice *dice,
	127	unsigned int offset,
	128	void *buf, unsigned int len)
	129	{
	130	return snd_dice_transaction_write(dice, SND_DICE_ADDR_TYPE_RX, offset,
	131	buf, len);
	132	}
	133	static inline int snd_dice_transaction_read_rx(struct snd_dice *dice,
	134	unsigned int offset,
	135	void *buf, unsigned int len)
	136	{
	137	return snd_dice_transaction_read(dice, SND_DICE_ADDR_TYPE_RX, offset,
	138	buf, len);
	139	}
	140	static inline int snd_dice_transaction_write_sync(struct snd_dice *dice,
141	unsigned int offset,
142	void *buf, unsigned int len)
143	{
144	return snd_dice_transaction_write(dice, SND_DICE_ADDR_TYPE_SYNC, offset,
145	buf, len);
146	}
147	static inline int snd_dice_transaction_read_sync(struct snd_dice *dice,
148	unsigned int offset,
149	void *buf, unsigned int len)
150	{
151	return snd_dice_transaction_read(dice, SND_DICE_ADDR_TYPE_SYNC, offset,
152	buf, len);
153	}
154
7c2d4c0c TS	155	int snd_dice_transaction_get_clock_source(struct snd_dice *dice,
7c2d4c0c TS	156	unsigned int *source);
7c2d4c0c TS	157	int snd_dice_transaction_get_rate(struct snd_dice dice, unsigned int rate);
	158	int snd_dice_transaction_set_enable(struct snd_dice *dice);
	159	void snd_dice_transaction_clear_enable(struct snd_dice *dice);
	160	int snd_dice_transaction_init(struct snd_dice *dice);
	161	int snd_dice_transaction_reinit(struct snd_dice *dice);
	162	void snd_dice_transaction_destroy(struct snd_dice *dice);
	163
	164	#define SND_DICE_RATES_COUNT 7
	165	extern const unsigned int snd_dice_rates[SND_DICE_RATES_COUNT];
	166
9a02843c TS	167	int snd_dice_stream_start_duplex(struct snd_dice *dice, unsigned int rate);
	168	void snd_dice_stream_stop_duplex(struct snd_dice *dice);
	169	int snd_dice_stream_init_duplex(struct snd_dice *dice);
	170	void snd_dice_stream_destroy_duplex(struct snd_dice *dice);
	171	void snd_dice_stream_update_duplex(struct snd_dice *dice);
6eb6c81e TS	172
	173	int snd_dice_stream_lock_try(struct snd_dice *dice);
	174	void snd_dice_stream_lock_release(struct snd_dice *dice);
	175
c50fb91f TS	176	int snd_dice_create_pcm(struct snd_dice *dice);
c50fb91f TS	177
19af57b4 TS	178	int snd_dice_create_hwdep(struct snd_dice *dice);
19af57b4 TS	179
04d426a0 TS	180	void snd_dice_create_proc(struct snd_dice *dice);
04d426a0 TS	181
a113ff88 TS	182	int snd_dice_create_midi(struct snd_dice *dice);
a113ff88 TS	183
7c2d4c0c	184	#endif