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

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * oxfw.h - a part of driver for OXFW970/971 based devices
 *
 * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
 */

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

#include <sound/control.h>
#include <sound/core.h>
#include <sound/initval.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/info.h>
#include <sound/rawmidi.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-am824.h"
#include "../cmp.h"

/* This is an arbitrary number for convinience. */
#define	SND_OXFW_STREAM_FORMAT_ENTRIES	10
struct snd_oxfw {
	struct snd_card *card;
	struct fw_unit *unit;
	struct mutex mutex;
	spinlock_t lock;

	bool registered;
	struct delayed_work dwork;

	bool wrong_dbs;
	bool has_output;
	u8 *tx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
	u8 *rx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
	bool assumed;
	struct cmp_connection out_conn;
	struct cmp_connection in_conn;
	struct amdtp_stream tx_stream;
	struct amdtp_stream rx_stream;
	unsigned int substreams_count;

	unsigned int midi_input_ports;
	unsigned int midi_output_ports;

	int dev_lock_count;
	bool dev_lock_changed;
	wait_queue_head_t hwdep_wait;

	const struct ieee1394_device_id *entry;
	void *spec;

	struct amdtp_domain domain;
};

/*
 * AV/C Stream Format Information Specification 1.1 Working Draft
 * (Apr 2005, 1394TA)
 */
int avc_stream_set_format(struct fw_unit *unit, enum avc_general_plug_dir dir,
			  unsigned int pid, u8 *format, unsigned int len);
int avc_stream_get_format(struct fw_unit *unit,
			  enum avc_general_plug_dir dir, unsigned int pid,
			  u8 *buf, unsigned int *len, unsigned int eid);
static inline int
avc_stream_get_format_single(struct fw_unit *unit,
			     enum avc_general_plug_dir dir, unsigned int pid,
			     u8 *buf, unsigned int *len)
{
	return avc_stream_get_format(unit, dir, pid, buf, len, 0xff);
}
static inline int
avc_stream_get_format_list(struct fw_unit *unit,
			   enum avc_general_plug_dir dir, unsigned int pid,
			   u8 *buf, unsigned int *len,
			   unsigned int eid)
{
	return avc_stream_get_format(unit, dir, pid, buf, len, eid);
}

/*
 * AV/C Digital Interface Command Set General Specification 4.2
 * (Sep 2004, 1394TA)
 */
int avc_general_inquiry_sig_fmt(struct fw_unit *unit, unsigned int rate,
				enum avc_general_plug_dir dir,
				unsigned short pid);

int snd_oxfw_stream_init_duplex(struct snd_oxfw *oxfw);
int snd_oxfw_stream_reserve_duplex(struct snd_oxfw *oxfw,
				   struct amdtp_stream *stream,
				   unsigned int rate, unsigned int pcm_channels);
int snd_oxfw_stream_start_duplex(struct snd_oxfw *oxfw);
void snd_oxfw_stream_stop_duplex(struct snd_oxfw *oxfw);
void snd_oxfw_stream_destroy_duplex(struct snd_oxfw *oxfw);
void snd_oxfw_stream_update_duplex(struct snd_oxfw *oxfw);

struct snd_oxfw_stream_formation {
	unsigned int rate;
	unsigned int pcm;
	unsigned int midi;
};
int snd_oxfw_stream_parse_format(u8 *format,
				 struct snd_oxfw_stream_formation *formation);
int snd_oxfw_stream_get_current_formation(struct snd_oxfw *oxfw,
				enum avc_general_plug_dir dir,
				struct snd_oxfw_stream_formation *formation);

int snd_oxfw_stream_discover(struct snd_oxfw *oxfw);

void snd_oxfw_stream_lock_changed(struct snd_oxfw *oxfw);
int snd_oxfw_stream_lock_try(struct snd_oxfw *oxfw);
void snd_oxfw_stream_lock_release(struct snd_oxfw *oxfw);

int snd_oxfw_create_pcm(struct snd_oxfw *oxfw);

void snd_oxfw_proc_init(struct snd_oxfw *oxfw);

int snd_oxfw_create_midi(struct snd_oxfw *oxfw);

int snd_oxfw_create_hwdep(struct snd_oxfw *oxfw);

int snd_oxfw_add_spkr(struct snd_oxfw *oxfw, bool is_lacie);
int snd_oxfw_scs1x_add(struct snd_oxfw *oxfw);
void snd_oxfw_scs1x_update(struct snd_oxfw *oxfw);
Commit	Line	Data
da607e19	1	/* SPDX-License-Identifier: GPL-2.0-only */
e2786ca6 TS	2	/*
	3	* oxfw.h - a part of driver for OXFW970/971 based devices
	4	*
	5	* Copyright (c) Clemens Ladisch <clemens@ladisch.de>
e2786ca6 TS	6	*/
	7
	8	#include <linux/device.h>
	9	#include <linux/firewire.h>
	10	#include <linux/firewire-constants.h>
	11	#include <linux/module.h>
	12	#include <linux/mod_devicetable.h>
	13	#include <linux/mutex.h>
	14	#include <linux/slab.h>
8985f4ac	15	#include <linux/compat.h>
174cd4b1	16	#include <linux/sched/signal.h>
e2786ca6 TS	17
	18	#include <sound/control.h>
	19	#include <sound/core.h>
	20	#include <sound/initval.h>
	21	#include <sound/pcm.h>
	22	#include <sound/pcm_params.h>
3c96101f	23	#include <sound/info.h>
05588d34	24	#include <sound/rawmidi.h>
8985f4ac TS	25	#include <sound/firewire.h>
8985f4ac TS	26	#include <sound/hwdep.h>
e2786ca6 TS	27
	28	#include "../lib.h"
	29	#include "../fcp.h"
	30	#include "../packets-buffer.h"
	31	#include "../iso-resources.h"
5955815e	32	#include "../amdtp-am824.h"
e2786ca6 TS	33	#include "../cmp.h"
e2786ca6 TS	34
5cd1d3f4 TS	35	/* This is an arbitrary number for convinience. */
5cd1d3f4 TS	36	#define SND_OXFW_STREAM_FORMAT_ENTRIES 10
e2786ca6 TS	37	struct snd_oxfw {
	38	struct snd_card *card;
	39	struct fw_unit *unit;
e2786ca6	40	struct mutex mutex;
05588d34	41	spinlock_t lock;
5cd1d3f4	42
6c29230e TS	43	bool registered;
	44	struct delayed_work dwork;
	45
13f3a46d	46	bool wrong_dbs;
b0ac0009 TS	47	bool has_output;
b0ac0009 TS	48	u8 *tx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
5cd1d3f4 TS	49	u8 *rx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
5cd1d3f4 TS	50	bool assumed;
b0ac0009	51	struct cmp_connection out_conn;
e2786ca6	52	struct cmp_connection in_conn;
b0ac0009	53	struct amdtp_stream tx_stream;
e2786ca6	54	struct amdtp_stream rx_stream;
4a0a0472	55	unsigned int substreams_count;
5cd1d3f4	56
05588d34 TS	57	unsigned int midi_input_ports;
	58	unsigned int midi_output_ports;
	59
8985f4ac TS	60	int dev_lock_count;
	61	bool dev_lock_changed;
	62	wait_queue_head_t hwdep_wait;
27e66635 TS	63
27e66635 TS	64	const struct ieee1394_device_id *entry;
c582cc66	65	void *spec;
ac5d7786 TS	66
ac5d7786 TS	67	struct amdtp_domain domain;
e2786ca6 TS	68	};
e2786ca6 TS	69
5b59d809 TS	70	/*
	71	* AV/C Stream Format Information Specification 1.1 Working Draft
	72	* (Apr 2005, 1394TA)
	73	*/
	74	int avc_stream_set_format(struct fw_unit *unit, enum avc_general_plug_dir dir,
	75	unsigned int pid, u8 *format, unsigned int len);
	76	int avc_stream_get_format(struct fw_unit *unit,
	77	enum avc_general_plug_dir dir, unsigned int pid,
	78	u8 buf, unsigned int len, unsigned int eid);
	79	static inline int
	80	avc_stream_get_format_single(struct fw_unit *unit,
	81	enum avc_general_plug_dir dir, unsigned int pid,
	82	u8 buf, unsigned int len)
	83	{
	84	return avc_stream_get_format(unit, dir, pid, buf, len, 0xff);
	85	}
	86	static inline int
	87	avc_stream_get_format_list(struct fw_unit *unit,
	88	enum avc_general_plug_dir dir, unsigned int pid,
	89	u8 buf, unsigned int len,
	90	unsigned int eid)
	91	{
	92	return avc_stream_get_format(unit, dir, pid, buf, len, eid);
	93	}
	94
	95	/*
	96	* AV/C Digital Interface Command Set General Specification 4.2
	97	* (Sep 2004, 1394TA)
	98	*/
	99	int avc_general_inquiry_sig_fmt(struct fw_unit *unit, unsigned int rate,
	100	enum avc_general_plug_dir dir,
	101	unsigned short pid);
	102
779f0dba	103	int snd_oxfw_stream_init_duplex(struct snd_oxfw *oxfw);
4f380d00 TS	104	int snd_oxfw_stream_reserve_duplex(struct snd_oxfw *oxfw,
	105	struct amdtp_stream *stream,
	106	unsigned int rate, unsigned int pcm_channels);
	107	int snd_oxfw_stream_start_duplex(struct snd_oxfw *oxfw);
779f0dba TS	108	void snd_oxfw_stream_stop_duplex(struct snd_oxfw *oxfw);
	109	void snd_oxfw_stream_destroy_duplex(struct snd_oxfw *oxfw);
	110	void snd_oxfw_stream_update_duplex(struct snd_oxfw *oxfw);
3713d93a	111
5cd1d3f4 TS	112	struct snd_oxfw_stream_formation {
	113	unsigned int rate;
	114	unsigned int pcm;
	115	unsigned int midi;
	116	};
	117	int snd_oxfw_stream_parse_format(u8 *format,
	118	struct snd_oxfw_stream_formation *formation);
	119	int snd_oxfw_stream_get_current_formation(struct snd_oxfw *oxfw,
	120	enum avc_general_plug_dir dir,
	121	struct snd_oxfw_stream_formation *formation);
b0ac0009	122
5cd1d3f4 TS	123	int snd_oxfw_stream_discover(struct snd_oxfw *oxfw);
5cd1d3f4 TS	124
8985f4ac TS	125	void snd_oxfw_stream_lock_changed(struct snd_oxfw *oxfw);
	126	int snd_oxfw_stream_lock_try(struct snd_oxfw *oxfw);
	127	void snd_oxfw_stream_lock_release(struct snd_oxfw *oxfw);
	128
3713d93a	129	int snd_oxfw_create_pcm(struct snd_oxfw *oxfw);
31514bfb	130
3c96101f	131	void snd_oxfw_proc_init(struct snd_oxfw *oxfw);
05588d34 TS	132
05588d34 TS	133	int snd_oxfw_create_midi(struct snd_oxfw *oxfw);
8985f4ac TS	134
8985f4ac TS	135	int snd_oxfw_create_hwdep(struct snd_oxfw *oxfw);
29aa09ac	136
3e2f4570	137	int snd_oxfw_add_spkr(struct snd_oxfw *oxfw, bool is_lacie);
3f47152a	138	int snd_oxfw_scs1x_add(struct snd_oxfw *oxfw);
e3315b43	139	void snd_oxfw_scs1x_update(struct snd_oxfw *oxfw);