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