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