1 /* SPDX-License-Identifier: GPL-2.0-only */ <<
2 /* 1 /*
3 * oxfw.h - a part of driver for OXFW970/971 b 2 * oxfw.h - a part of driver for OXFW970/971 based devices
4 * 3 *
5 * Copyright (c) Clemens Ladisch <clemens@ladi 4 * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
>> 5 * Licensed under the terms of the GNU General Public License, version 2.
6 */ 6 */
7 7
8 #include <linux/device.h> 8 #include <linux/device.h>
9 #include <linux/firewire.h> 9 #include <linux/firewire.h>
10 #include <linux/firewire-constants.h> 10 #include <linux/firewire-constants.h>
11 #include <linux/module.h> 11 #include <linux/module.h>
12 #include <linux/mod_devicetable.h> 12 #include <linux/mod_devicetable.h>
13 #include <linux/mutex.h> 13 #include <linux/mutex.h>
14 #include <linux/slab.h> 14 #include <linux/slab.h>
15 #include <linux/compat.h> 15 #include <linux/compat.h>
16 #include <linux/sched/signal.h> 16 #include <linux/sched/signal.h>
17 17
18 #include <sound/control.h> 18 #include <sound/control.h>
19 #include <sound/core.h> 19 #include <sound/core.h>
20 #include <sound/initval.h> 20 #include <sound/initval.h>
21 #include <sound/pcm.h> 21 #include <sound/pcm.h>
22 #include <sound/pcm_params.h> 22 #include <sound/pcm_params.h>
23 #include <sound/info.h> 23 #include <sound/info.h>
24 #include <sound/rawmidi.h> 24 #include <sound/rawmidi.h>
25 #include <sound/firewire.h> 25 #include <sound/firewire.h>
26 #include <sound/hwdep.h> 26 #include <sound/hwdep.h>
27 27
28 #include "../lib.h" 28 #include "../lib.h"
29 #include "../fcp.h" 29 #include "../fcp.h"
30 #include "../packets-buffer.h" 30 #include "../packets-buffer.h"
31 #include "../iso-resources.h" 31 #include "../iso-resources.h"
32 #include "../amdtp-am824.h" 32 #include "../amdtp-am824.h"
33 #include "../cmp.h" 33 #include "../cmp.h"
34 34
35 enum snd_oxfw_quirk { <<
36 // Postpone transferring packets durin <<
37 // next isochronous packet includes mo <<
38 SND_OXFW_QUIRK_JUMBO_PAYLOAD = 0x01, <<
39 // The dbs field of CIP header in tx p <<
40 SND_OXFW_QUIRK_WRONG_DBS = 0x02, <<
41 // Blocking transmission mode is used. <<
42 SND_OXFW_QUIRK_BLOCKING_TRANSMISSION = <<
43 // Stanton SCS1.d and SCS1.m support u <<
44 SND_OXFW_QUIRK_SCS_TRANSACTION = 0x08, <<
45 // Apogee Duet FireWire ignores data b <<
46 // processing, while output level mete <<
47 // the device to process audio data ev <<
48 // IEC 61883-1/6. <<
49 SND_OXFW_QUIRK_IGNORE_NO_INFO_PACKET = <<
50 // Loud Technologies Mackie Onyx 1640i <<
51 // event frequency according to events <<
52 // performs media clock recovery volun <<
53 // are ignored, thus driver should tra <<
54 SND_OXFW_QUIRK_VOLUNTARY_RECOVERY = 0x <<
55 // Miglia Harmony Audio does not suppo <<
56 SND_OXFW_QUIRK_STREAM_FORMAT_INFO_UNSU <<
57 // Miglia Harmony Audio transmits CIP <<
58 // of accumulated payload quadlets inc <<
59 SND_OXFW_QUIRK_DBC_IS_TOTAL_PAYLOAD_QU <<
60 }; <<
61 <<
62 /* This is an arbitrary number for convinience 35 /* This is an arbitrary number for convinience. */
63 #define SND_OXFW_STREAM_FORMAT_ENTRIES 10 36 #define SND_OXFW_STREAM_FORMAT_ENTRIES 10
64 struct snd_oxfw { 37 struct snd_oxfw {
65 struct snd_card *card; 38 struct snd_card *card;
66 struct fw_unit *unit; 39 struct fw_unit *unit;
67 struct mutex mutex; 40 struct mutex mutex;
68 spinlock_t lock; 41 spinlock_t lock;
69 42
70 // The combination of snd_oxfw_quirk e !! 43 bool registered;
71 unsigned int quirks; !! 44 struct delayed_work dwork;
>> 45
>> 46 bool wrong_dbs;
72 bool has_output; 47 bool has_output;
73 bool has_input; <<
74 u8 *tx_stream_formats[SND_OXFW_STREAM_ 48 u8 *tx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
75 u8 *rx_stream_formats[SND_OXFW_STREAM_ 49 u8 *rx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
76 bool assumed; 50 bool assumed;
77 struct cmp_connection out_conn; 51 struct cmp_connection out_conn;
78 struct cmp_connection in_conn; 52 struct cmp_connection in_conn;
79 struct amdtp_stream tx_stream; 53 struct amdtp_stream tx_stream;
80 struct amdtp_stream rx_stream; 54 struct amdtp_stream rx_stream;
81 unsigned int substreams_count; !! 55 unsigned int capture_substreams;
>> 56 unsigned int playback_substreams;
82 57
83 unsigned int midi_input_ports; 58 unsigned int midi_input_ports;
84 unsigned int midi_output_ports; 59 unsigned int midi_output_ports;
85 60
86 int dev_lock_count; 61 int dev_lock_count;
87 bool dev_lock_changed; 62 bool dev_lock_changed;
88 wait_queue_head_t hwdep_wait; 63 wait_queue_head_t hwdep_wait;
89 64
>> 65 const struct ieee1394_device_id *entry;
90 void *spec; 66 void *spec;
91 <<
92 struct amdtp_domain domain; <<
93 }; 67 };
94 68
95 /* 69 /*
96 * AV/C Stream Format Information Specificatio 70 * AV/C Stream Format Information Specification 1.1 Working Draft
97 * (Apr 2005, 1394TA) 71 * (Apr 2005, 1394TA)
98 */ 72 */
99 int avc_stream_set_format(struct fw_unit *unit 73 int avc_stream_set_format(struct fw_unit *unit, enum avc_general_plug_dir dir,
100 unsigned int pid, u8 74 unsigned int pid, u8 *format, unsigned int len);
101 int avc_stream_get_format(struct fw_unit *unit 75 int avc_stream_get_format(struct fw_unit *unit,
102 enum avc_general_plu 76 enum avc_general_plug_dir dir, unsigned int pid,
103 u8 *buf, unsigned in 77 u8 *buf, unsigned int *len, unsigned int eid);
104 static inline int 78 static inline int
105 avc_stream_get_format_single(struct fw_unit *u 79 avc_stream_get_format_single(struct fw_unit *unit,
106 enum avc_general_ 80 enum avc_general_plug_dir dir, unsigned int pid,
107 u8 *buf, unsigned 81 u8 *buf, unsigned int *len)
108 { 82 {
109 return avc_stream_get_format(unit, dir 83 return avc_stream_get_format(unit, dir, pid, buf, len, 0xff);
110 } 84 }
111 static inline int 85 static inline int
112 avc_stream_get_format_list(struct fw_unit *uni 86 avc_stream_get_format_list(struct fw_unit *unit,
113 enum avc_general_pl 87 enum avc_general_plug_dir dir, unsigned int pid,
114 u8 *buf, unsigned i 88 u8 *buf, unsigned int *len,
115 unsigned int eid) 89 unsigned int eid)
116 { 90 {
117 return avc_stream_get_format(unit, dir 91 return avc_stream_get_format(unit, dir, pid, buf, len, eid);
118 } 92 }
119 93
120 /* 94 /*
121 * AV/C Digital Interface Command Set General 95 * AV/C Digital Interface Command Set General Specification 4.2
122 * (Sep 2004, 1394TA) 96 * (Sep 2004, 1394TA)
123 */ 97 */
124 int avc_general_inquiry_sig_fmt(struct fw_unit 98 int avc_general_inquiry_sig_fmt(struct fw_unit *unit, unsigned int rate,
125 enum avc_gener 99 enum avc_general_plug_dir dir,
126 unsigned short 100 unsigned short pid);
127 101
128 int snd_oxfw_stream_init_duplex(struct snd_oxf !! 102 int snd_oxfw_stream_init_simplex(struct snd_oxfw *oxfw,
129 int snd_oxfw_stream_reserve_duplex(struct snd_ !! 103 struct amdtp_stream *stream);
130 struct amdt !! 104 int snd_oxfw_stream_start_simplex(struct snd_oxfw *oxfw,
131 unsigned in !! 105 struct amdtp_stream *stream,
132 unsigned in !! 106 unsigned int rate, unsigned int pcm_channels);
133 unsigned in !! 107 void snd_oxfw_stream_stop_simplex(struct snd_oxfw *oxfw,
134 int snd_oxfw_stream_start_duplex(struct snd_ox !! 108 struct amdtp_stream *stream);
135 void snd_oxfw_stream_stop_duplex(struct snd_ox !! 109 void snd_oxfw_stream_destroy_simplex(struct snd_oxfw *oxfw,
136 void snd_oxfw_stream_destroy_duplex(struct snd !! 110 struct amdtp_stream *stream);
137 void snd_oxfw_stream_update_duplex(struct snd_ !! 111 void snd_oxfw_stream_update_simplex(struct snd_oxfw *oxfw,
>> 112 struct amdtp_stream *stream);
138 113
139 struct snd_oxfw_stream_formation { 114 struct snd_oxfw_stream_formation {
140 unsigned int rate; 115 unsigned int rate;
141 unsigned int pcm; 116 unsigned int pcm;
142 unsigned int midi; 117 unsigned int midi;
143 }; 118 };
144 int snd_oxfw_stream_parse_format(const u8 *for !! 119 int snd_oxfw_stream_parse_format(u8 *format,
145 struct snd_ox 120 struct snd_oxfw_stream_formation *formation);
146 int snd_oxfw_stream_get_current_formation(stru 121 int snd_oxfw_stream_get_current_formation(struct snd_oxfw *oxfw,
147 enum avc_gener 122 enum avc_general_plug_dir dir,
148 struct snd_oxf 123 struct snd_oxfw_stream_formation *formation);
149 124
150 int snd_oxfw_stream_discover(struct snd_oxfw * 125 int snd_oxfw_stream_discover(struct snd_oxfw *oxfw);
151 126
152 void snd_oxfw_stream_lock_changed(struct snd_o 127 void snd_oxfw_stream_lock_changed(struct snd_oxfw *oxfw);
153 int snd_oxfw_stream_lock_try(struct snd_oxfw * 128 int snd_oxfw_stream_lock_try(struct snd_oxfw *oxfw);
154 void snd_oxfw_stream_lock_release(struct snd_o 129 void snd_oxfw_stream_lock_release(struct snd_oxfw *oxfw);
155 130
156 int snd_oxfw_create_pcm(struct snd_oxfw *oxfw) 131 int snd_oxfw_create_pcm(struct snd_oxfw *oxfw);
157 132
158 void snd_oxfw_proc_init(struct snd_oxfw *oxfw) 133 void snd_oxfw_proc_init(struct snd_oxfw *oxfw);
159 134
160 int snd_oxfw_create_midi(struct snd_oxfw *oxfw 135 int snd_oxfw_create_midi(struct snd_oxfw *oxfw);
161 136
162 int snd_oxfw_create_hwdep(struct snd_oxfw *oxf 137 int snd_oxfw_create_hwdep(struct snd_oxfw *oxfw);
163 138
164 int snd_oxfw_add_spkr(struct snd_oxfw *oxfw, b 139 int snd_oxfw_add_spkr(struct snd_oxfw *oxfw, bool is_lacie);
165 int snd_oxfw_scs1x_add(struct snd_oxfw *oxfw); 140 int snd_oxfw_scs1x_add(struct snd_oxfw *oxfw);
166 void snd_oxfw_scs1x_update(struct snd_oxfw *ox 141 void snd_oxfw_scs1x_update(struct snd_oxfw *oxfw);
167 142
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.