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/mutex.h>
13 #include <linux/slab.h>
14 #include <linux/compat.h>
15 #include <linux/sched/signal.h>
16
17 #include <sound/control.h>
18 #include <sound/core.h>
19 #include <sound/initval.h>
20 #include <sound/pcm.h>
21 #include <sound/pcm_params.h>
22 #include <sound/info.h>
23 #include <sound/rawmidi.h>
24 #include <sound/firewire.h>
25 #include <sound/hwdep.h>
26
27 #include "../lib.h"
28 #include "../fcp.h"
29 #include "../packets-buffer.h"
30 #include "../iso-resources.h"
31 #include "../amdtp-am824.h"
32 #include "../cmp.h"
33
34 enum snd_oxfw_quirk {
35 // Postpone transferring packets during handling asynchronous transaction. As a result,
36 // next isochronous packet includes more events than one packet can include.
37 SND_OXFW_QUIRK_JUMBO_PAYLOAD = 0x01,
38 // The dbs field of CIP header in tx packet is wrong.
39 SND_OXFW_QUIRK_WRONG_DBS = 0x02,
40 // Blocking transmission mode is used.
41 SND_OXFW_QUIRK_BLOCKING_TRANSMISSION = 0x04,
42 // Stanton SCS1.d and SCS1.m support unique transaction.
43 SND_OXFW_QUIRK_SCS_TRANSACTION = 0x08,
44 // Apogee Duet FireWire ignores data blocks in packet with NO_INFO for audio data
45 // processing, while output level meter moves. Any value in syt field of packet takes
46 // the device to process audio data even if the value is invalid in a point of
47 // IEC 61883-1/6.
48 SND_OXFW_QUIRK_IGNORE_NO_INFO_PACKET = 0x10,
49 // Loud Technologies Mackie Onyx 1640i seems to configure OXFW971 ASIC so that it decides
50 // event frequency according to events in received isochronous packets. The device looks to
51 // performs media clock recovery voluntarily. In the recovery, the packets with NO_INFO
52 // are ignored, thus driver should transfer packets with timestamp.
53 SND_OXFW_QUIRK_VOLUNTARY_RECOVERY = 0x20,
54 // Miglia Harmony Audio does not support AV/C Stream Format Information command.
55 SND_OXFW_QUIRK_STREAM_FORMAT_INFO_UNSUPPORTED = 0x40,
56 // Miglia Harmony Audio transmits CIP in which the value of dbc field expresses the number
57 // of accumulated payload quadlets including the packet.
58 SND_OXFW_QUIRK_DBC_IS_TOTAL_PAYLOAD_QUADLETS = 0x80,
59 };
60
61 /* This is an arbitrary number for convinience. */
62 #define SND_OXFW_STREAM_FORMAT_ENTRIES 10
63 struct snd_oxfw {
64 struct snd_card *card;
65 struct fw_unit *unit;
66 struct mutex mutex;
67 spinlock_t lock;
68
69 // The combination of snd_oxfw_quirk enumeration-constants.
70 unsigned int quirks;
71 bool has_output;
72 bool has_input;
73 u8 *tx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
74 u8 *rx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
75 bool assumed;
76 struct cmp_connection out_conn;
77 struct cmp_connection in_conn;
78 struct amdtp_stream tx_stream;
79 struct amdtp_stream rx_stream;
80 unsigned int substreams_count;
81
82 unsigned int midi_input_ports;
83 unsigned int midi_output_ports;
84
85 int dev_lock_count;
86 bool dev_lock_changed;
87 wait_queue_head_t hwdep_wait;
88
89 void *spec;
90
91 struct amdtp_domain domain;
92 };
93
94 /*
95 * AV/C Stream Format Information Specification 1.1 Working Draft
96 * (Apr 2005, 1394TA)
97 */
98 int avc_stream_set_format(struct fw_unit *unit, enum avc_general_plug_dir dir,
99 unsigned int pid, u8 *format, unsigned int len);
100 int avc_stream_get_format(struct fw_unit *unit,
101 enum avc_general_plug_dir dir, unsigned int pid,
102 u8 *buf, unsigned int *len, unsigned int eid);
103 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)104 avc_stream_get_format_single(struct fw_unit *unit,
105 enum avc_general_plug_dir dir, unsigned int pid,
106 u8 *buf, unsigned int *len)
107 {
108 return avc_stream_get_format(unit, dir, pid, buf, len, 0xff);
109 }
110 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)111 avc_stream_get_format_list(struct fw_unit *unit,
112 enum avc_general_plug_dir dir, unsigned int pid,
113 u8 *buf, unsigned int *len,
114 unsigned int eid)
115 {
116 return avc_stream_get_format(unit, dir, pid, buf, len, eid);
117 }
118
119 /*
120 * AV/C Digital Interface Command Set General Specification 4.2
121 * (Sep 2004, 1394TA)
122 */
123 int avc_general_inquiry_sig_fmt(struct fw_unit *unit, unsigned int rate,
124 enum avc_general_plug_dir dir,
125 unsigned short pid);
126
127 int snd_oxfw_stream_init_duplex(struct snd_oxfw *oxfw);
128 int snd_oxfw_stream_reserve_duplex(struct snd_oxfw *oxfw,
129 struct amdtp_stream *stream,
130 unsigned int rate, unsigned int pcm_channels,
131 unsigned int frames_per_period,
132 unsigned int frames_per_buffer);
133 int snd_oxfw_stream_start_duplex(struct snd_oxfw *oxfw);
134 void snd_oxfw_stream_stop_duplex(struct snd_oxfw *oxfw);
135 void snd_oxfw_stream_destroy_duplex(struct snd_oxfw *oxfw);
136 void snd_oxfw_stream_update_duplex(struct snd_oxfw *oxfw);
137
138 struct snd_oxfw_stream_formation {
139 unsigned int rate;
140 unsigned int pcm;
141 unsigned int midi;
142 };
143 int snd_oxfw_stream_parse_format(const u8 *format,
144 struct snd_oxfw_stream_formation *formation);
145 int snd_oxfw_stream_get_current_formation(struct snd_oxfw *oxfw,
146 enum avc_general_plug_dir dir,
147 struct snd_oxfw_stream_formation *formation);
148
149 int snd_oxfw_stream_discover(struct snd_oxfw *oxfw);
150
151 void snd_oxfw_stream_lock_changed(struct snd_oxfw *oxfw);
152 int snd_oxfw_stream_lock_try(struct snd_oxfw *oxfw);
153 void snd_oxfw_stream_lock_release(struct snd_oxfw *oxfw);
154
155 int snd_oxfw_create_pcm(struct snd_oxfw *oxfw);
156
157 void snd_oxfw_proc_init(struct snd_oxfw *oxfw);
158
159 int snd_oxfw_create_midi(struct snd_oxfw *oxfw);
160
161 int snd_oxfw_create_hwdep(struct snd_oxfw *oxfw);
162
163 int snd_oxfw_add_spkr(struct snd_oxfw *oxfw, bool is_lacie);
164 int snd_oxfw_scs1x_add(struct snd_oxfw *oxfw);
165 void snd_oxfw_scs1x_update(struct snd_oxfw *oxfw);
166