xref: /openbmc/linux/sound/firewire/oxfw/oxfw.h (revision 07a35edc59d1f461a02c83235d0fe63b4c313920)
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 enum snd_oxfw_quirk {
36 	// Postpone transferring packets during handling asynchronous transaction. As a result,
37 	// next isochronous packet includes more events than one packet can include.
38 	SND_OXFW_QUIRK_JUMBO_PAYLOAD = 0x01,
39 	// The dbs field of CIP header in tx packet is wrong.
40 	SND_OXFW_QUIRK_WRONG_DBS = 0x02,
41 	// Blocking transmission mode is used.
42 	SND_OXFW_QUIRK_BLOCKING_TRANSMISSION = 0x04,
43 };
44 
45 /* This is an arbitrary number for convinience. */
46 #define	SND_OXFW_STREAM_FORMAT_ENTRIES	10
47 struct snd_oxfw {
48 	struct snd_card *card;
49 	struct fw_unit *unit;
50 	struct mutex mutex;
51 	spinlock_t lock;
52 
53 	bool registered;
54 	struct delayed_work dwork;
55 
56 	// The combination of snd_oxfw_quirk enumeration-constants.
57 	unsigned int quirks;
58 	bool has_output;
59 	bool has_input;
60 	u8 *tx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
61 	u8 *rx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
62 	bool assumed;
63 	struct cmp_connection out_conn;
64 	struct cmp_connection in_conn;
65 	struct amdtp_stream tx_stream;
66 	struct amdtp_stream rx_stream;
67 	unsigned int substreams_count;
68 
69 	unsigned int midi_input_ports;
70 	unsigned int midi_output_ports;
71 
72 	int dev_lock_count;
73 	bool dev_lock_changed;
74 	wait_queue_head_t hwdep_wait;
75 
76 	const struct ieee1394_device_id *entry;
77 	void *spec;
78 
79 	struct amdtp_domain domain;
80 };
81 
82 /*
83  * AV/C Stream Format Information Specification 1.1 Working Draft
84  * (Apr 2005, 1394TA)
85  */
86 int avc_stream_set_format(struct fw_unit *unit, enum avc_general_plug_dir dir,
87 			  unsigned int pid, u8 *format, unsigned int len);
88 int avc_stream_get_format(struct fw_unit *unit,
89 			  enum avc_general_plug_dir dir, unsigned int pid,
90 			  u8 *buf, unsigned int *len, unsigned int eid);
91 static inline int
92 avc_stream_get_format_single(struct fw_unit *unit,
93 			     enum avc_general_plug_dir dir, unsigned int pid,
94 			     u8 *buf, unsigned int *len)
95 {
96 	return avc_stream_get_format(unit, dir, pid, buf, len, 0xff);
97 }
98 static inline int
99 avc_stream_get_format_list(struct fw_unit *unit,
100 			   enum avc_general_plug_dir dir, unsigned int pid,
101 			   u8 *buf, unsigned int *len,
102 			   unsigned int eid)
103 {
104 	return avc_stream_get_format(unit, dir, pid, buf, len, eid);
105 }
106 
107 /*
108  * AV/C Digital Interface Command Set General Specification 4.2
109  * (Sep 2004, 1394TA)
110  */
111 int avc_general_inquiry_sig_fmt(struct fw_unit *unit, unsigned int rate,
112 				enum avc_general_plug_dir dir,
113 				unsigned short pid);
114 
115 int snd_oxfw_stream_init_duplex(struct snd_oxfw *oxfw);
116 int snd_oxfw_stream_reserve_duplex(struct snd_oxfw *oxfw,
117 				   struct amdtp_stream *stream,
118 				   unsigned int rate, unsigned int pcm_channels,
119 				   unsigned int frames_per_period,
120 				   unsigned int frames_per_buffer);
121 int snd_oxfw_stream_start_duplex(struct snd_oxfw *oxfw);
122 void snd_oxfw_stream_stop_duplex(struct snd_oxfw *oxfw);
123 void snd_oxfw_stream_destroy_duplex(struct snd_oxfw *oxfw);
124 void snd_oxfw_stream_update_duplex(struct snd_oxfw *oxfw);
125 
126 struct snd_oxfw_stream_formation {
127 	unsigned int rate;
128 	unsigned int pcm;
129 	unsigned int midi;
130 };
131 int snd_oxfw_stream_parse_format(u8 *format,
132 				 struct snd_oxfw_stream_formation *formation);
133 int snd_oxfw_stream_get_current_formation(struct snd_oxfw *oxfw,
134 				enum avc_general_plug_dir dir,
135 				struct snd_oxfw_stream_formation *formation);
136 
137 int snd_oxfw_stream_discover(struct snd_oxfw *oxfw);
138 
139 void snd_oxfw_stream_lock_changed(struct snd_oxfw *oxfw);
140 int snd_oxfw_stream_lock_try(struct snd_oxfw *oxfw);
141 void snd_oxfw_stream_lock_release(struct snd_oxfw *oxfw);
142 
143 int snd_oxfw_create_pcm(struct snd_oxfw *oxfw);
144 
145 void snd_oxfw_proc_init(struct snd_oxfw *oxfw);
146 
147 int snd_oxfw_create_midi(struct snd_oxfw *oxfw);
148 
149 int snd_oxfw_create_hwdep(struct snd_oxfw *oxfw);
150 
151 int snd_oxfw_add_spkr(struct snd_oxfw *oxfw, bool is_lacie);
152 int snd_oxfw_scs1x_add(struct snd_oxfw *oxfw);
153 void snd_oxfw_scs1x_update(struct snd_oxfw *oxfw);
154