blob: 084d414b228cf425dc99440cc081d65459bbe175 [file] [log] [blame]
Takashi Sakamotob5b04332014-04-25 22:45:00 +09001/*
2 * fireworks.h - a part of driver for Fireworks based devices
3 *
4 * Copyright (c) 2009-2010 Clemens Ladisch
5 * Copyright (c) 2013-2014 Takashi Sakamoto
6 *
7 * Licensed under the terms of the GNU General Public License, version 2.
8 */
9#ifndef SOUND_FIREWORKS_H_INCLUDED
10#define SOUND_FIREWORKS_H_INCLUDED
11
12#include <linux/compat.h>
13#include <linux/device.h>
14#include <linux/firewire.h>
15#include <linux/firewire-constants.h>
16#include <linux/module.h>
17#include <linux/mod_devicetable.h>
18#include <linux/delay.h>
19#include <linux/slab.h>
20
21#include <sound/core.h>
22#include <sound/initval.h>
Takashi Sakamotobde8a8f2014-04-25 22:45:01 +090023#include <sound/pcm.h>
Takashi Sakamoto6a226832014-04-25 22:45:08 +090024#include <sound/info.h>
Takashi Sakamotoa63d3ff2014-04-25 22:45:09 +090025#include <sound/rawmidi.h>
Takashi Sakamotoaa02bb62014-04-25 22:45:11 +090026#include <sound/pcm_params.h>
Takashi Sakamoto594ddce2014-04-25 22:45:12 +090027#include <sound/firewire.h>
28#include <sound/hwdep.h>
Takashi Sakamotobde8a8f2014-04-25 22:45:01 +090029
Takashi Sakamoto315fd412014-04-25 22:45:02 +090030#include "../packets-buffer.h"
31#include "../iso-resources.h"
32#include "../amdtp.h"
Takashi Sakamotobde8a8f2014-04-25 22:45:01 +090033#include "../cmp.h"
34#include "../lib.h"
35
Takashi Sakamoto315fd412014-04-25 22:45:02 +090036#define SND_EFW_MAX_MIDI_OUT_PORTS 2
37#define SND_EFW_MAX_MIDI_IN_PORTS 2
38
Takashi Sakamotobde8a8f2014-04-25 22:45:01 +090039#define SND_EFW_MULTIPLIER_MODES 3
40#define HWINFO_NAME_SIZE_BYTES 32
41#define HWINFO_MAX_CAPS_GROUPS 8
42
43/*
44 * This should be greater than maximum bytes for EFW response content.
45 * Currently response against command for isochronous channel mapping is
46 * confirmed to be the maximum one. But for flexibility, use maximum data
47 * payload for asynchronous primary packets at S100 (Cable base rate) in
48 * IEEE Std 1394-1995.
49 */
50#define SND_EFW_RESPONSE_MAXIMUM_BYTES 0x200U
51
Takashi Sakamoto555e8a82014-04-25 22:45:13 +090052extern unsigned int snd_efw_resp_buf_size;
53extern bool snd_efw_resp_buf_debug;
54
Takashi Sakamotobde8a8f2014-04-25 22:45:01 +090055struct snd_efw_phys_grp {
56 u8 type; /* see enum snd_efw_grp_type */
57 u8 count;
58} __packed;
Takashi Sakamotob5b04332014-04-25 22:45:00 +090059
60struct snd_efw {
61 struct snd_card *card;
62 struct fw_unit *unit;
63 int card_index;
64
65 struct mutex mutex;
66 spinlock_t lock;
Takashi Sakamotobde8a8f2014-04-25 22:45:01 +090067
68 /* for transaction */
69 u32 seqnum;
70 bool resp_addr_changable;
Takashi Sakamoto315fd412014-04-25 22:45:02 +090071
Takashi Sakamoto69702232014-04-25 22:45:05 +090072 /* for quirks */
73 bool is_af9;
Takashi Sakamoto18f5ed32015-08-05 09:21:05 +090074 bool is_fireworks3;
Takashi Sakamotod9cd0062014-04-25 22:45:06 +090075 u32 firmware_version;
Takashi Sakamoto69702232014-04-25 22:45:05 +090076
Takashi Sakamoto315fd412014-04-25 22:45:02 +090077 unsigned int midi_in_ports;
78 unsigned int midi_out_ports;
79
80 unsigned int supported_sampling_rate;
81 unsigned int pcm_capture_channels[SND_EFW_MULTIPLIER_MODES];
82 unsigned int pcm_playback_channels[SND_EFW_MULTIPLIER_MODES];
83
84 struct amdtp_stream *master;
85 struct amdtp_stream tx_stream;
86 struct amdtp_stream rx_stream;
87 struct cmp_connection out_conn;
88 struct cmp_connection in_conn;
89 atomic_t capture_substreams;
90 atomic_t playback_substreams;
Takashi Sakamoto6a226832014-04-25 22:45:08 +090091
92 /* hardware metering parameters */
93 unsigned int phys_out;
94 unsigned int phys_in;
95 unsigned int phys_out_grp_count;
96 unsigned int phys_in_grp_count;
97 struct snd_efw_phys_grp phys_out_grps[HWINFO_MAX_CAPS_GROUPS];
98 struct snd_efw_phys_grp phys_in_grps[HWINFO_MAX_CAPS_GROUPS];
Takashi Sakamoto594ddce2014-04-25 22:45:12 +090099
100 /* for uapi */
101 int dev_lock_count;
102 bool dev_lock_changed;
103 wait_queue_head_t hwdep_wait;
Takashi Sakamoto555e8a82014-04-25 22:45:13 +0900104
105 /* response queue */
106 u8 *resp_buf;
107 u8 *pull_ptr;
108 u8 *push_ptr;
109 unsigned int resp_queues;
Takashi Sakamotob5b04332014-04-25 22:45:00 +0900110};
111
Takashi Sakamoto555e8a82014-04-25 22:45:13 +0900112int snd_efw_transaction_cmd(struct fw_unit *unit,
113 const void *cmd, unsigned int size);
Takashi Sakamotobde8a8f2014-04-25 22:45:01 +0900114int snd_efw_transaction_run(struct fw_unit *unit,
115 const void *cmd, unsigned int cmd_size,
116 void *resp, unsigned int resp_size);
117int snd_efw_transaction_register(void);
118void snd_efw_transaction_unregister(void);
119void snd_efw_transaction_bus_reset(struct fw_unit *unit);
Takashi Sakamoto555e8a82014-04-25 22:45:13 +0900120void snd_efw_transaction_add_instance(struct snd_efw *efw);
121void snd_efw_transaction_remove_instance(struct snd_efw *efw);
Takashi Sakamotobde8a8f2014-04-25 22:45:01 +0900122
123struct snd_efw_hwinfo {
124 u32 flags;
125 u32 guid_hi;
126 u32 guid_lo;
127 u32 type;
128 u32 version;
129 char vendor_name[HWINFO_NAME_SIZE_BYTES];
130 char model_name[HWINFO_NAME_SIZE_BYTES];
131 u32 supported_clocks;
132 u32 amdtp_rx_pcm_channels;
133 u32 amdtp_tx_pcm_channels;
134 u32 phys_out;
135 u32 phys_in;
136 u32 phys_out_grp_count;
137 struct snd_efw_phys_grp phys_out_grps[HWINFO_MAX_CAPS_GROUPS];
138 u32 phys_in_grp_count;
139 struct snd_efw_phys_grp phys_in_grps[HWINFO_MAX_CAPS_GROUPS];
140 u32 midi_out_ports;
141 u32 midi_in_ports;
142 u32 max_sample_rate;
143 u32 min_sample_rate;
144 u32 dsp_version;
145 u32 arm_version;
146 u32 mixer_playback_channels;
147 u32 mixer_capture_channels;
148 u32 fpga_version;
149 u32 amdtp_rx_pcm_channels_2x;
150 u32 amdtp_tx_pcm_channels_2x;
151 u32 amdtp_rx_pcm_channels_4x;
152 u32 amdtp_tx_pcm_channels_4x;
153 u32 reserved[16];
154} __packed;
155enum snd_efw_grp_type {
156 SND_EFW_CH_TYPE_ANALOG = 0,
157 SND_EFW_CH_TYPE_SPDIF = 1,
158 SND_EFW_CH_TYPE_ADAT = 2,
159 SND_EFW_CH_TYPE_SPDIF_OR_ADAT = 3,
160 SND_EFW_CH_TYPE_ANALOG_MIRRORING = 4,
161 SND_EFW_CH_TYPE_HEADPHONES = 5,
162 SND_EFW_CH_TYPE_I2S = 6,
163 SND_EFW_CH_TYPE_GUITAR = 7,
164 SND_EFW_CH_TYPE_PIEZO_GUITAR = 8,
165 SND_EFW_CH_TYPE_GUITAR_STRING = 9,
Takashi Sakamotobde8a8f2014-04-25 22:45:01 +0900166 SND_EFW_CH_TYPE_DUMMY
167};
168struct snd_efw_phys_meters {
169 u32 status; /* guitar state/midi signal/clock input detect */
170 u32 reserved0;
171 u32 reserved1;
172 u32 reserved2;
173 u32 reserved3;
174 u32 out_meters;
175 u32 in_meters;
176 u32 reserved4;
177 u32 reserved5;
178 u32 values[0];
179} __packed;
180enum snd_efw_clock_source {
181 SND_EFW_CLOCK_SOURCE_INTERNAL = 0,
182 SND_EFW_CLOCK_SOURCE_SYTMATCH = 1,
183 SND_EFW_CLOCK_SOURCE_WORDCLOCK = 2,
184 SND_EFW_CLOCK_SOURCE_SPDIF = 3,
185 SND_EFW_CLOCK_SOURCE_ADAT_1 = 4,
186 SND_EFW_CLOCK_SOURCE_ADAT_2 = 5,
187 SND_EFW_CLOCK_SOURCE_CONTINUOUS = 6 /* internal variable clock */
188};
189enum snd_efw_transport_mode {
190 SND_EFW_TRANSPORT_MODE_WINDOWS = 0,
191 SND_EFW_TRANSPORT_MODE_IEC61883 = 1,
192};
193int snd_efw_command_set_resp_addr(struct snd_efw *efw,
194 u16 addr_high, u32 addr_low);
Takashi Sakamoto93219d02014-05-28 00:14:39 +0900195int snd_efw_command_set_tx_mode(struct snd_efw *efw,
196 enum snd_efw_transport_mode mode);
Takashi Sakamotobde8a8f2014-04-25 22:45:01 +0900197int snd_efw_command_get_hwinfo(struct snd_efw *efw,
198 struct snd_efw_hwinfo *hwinfo);
199int snd_efw_command_get_phys_meters(struct snd_efw *efw,
200 struct snd_efw_phys_meters *meters,
201 unsigned int len);
202int snd_efw_command_get_clock_source(struct snd_efw *efw,
203 enum snd_efw_clock_source *source);
204int snd_efw_command_get_sampling_rate(struct snd_efw *efw, unsigned int *rate);
205int snd_efw_command_set_sampling_rate(struct snd_efw *efw, unsigned int rate);
206
Takashi Sakamoto315fd412014-04-25 22:45:02 +0900207int snd_efw_stream_init_duplex(struct snd_efw *efw);
Takashi Sakamoto4a286d52014-05-28 00:14:40 +0900208int snd_efw_stream_start_duplex(struct snd_efw *efw, unsigned int rate);
Takashi Sakamoto315fd412014-04-25 22:45:02 +0900209void snd_efw_stream_stop_duplex(struct snd_efw *efw);
210void snd_efw_stream_update_duplex(struct snd_efw *efw);
211void snd_efw_stream_destroy_duplex(struct snd_efw *efw);
Takashi Sakamoto594ddce2014-04-25 22:45:12 +0900212void snd_efw_stream_lock_changed(struct snd_efw *efw);
213int snd_efw_stream_lock_try(struct snd_efw *efw);
214void snd_efw_stream_lock_release(struct snd_efw *efw);
Takashi Sakamoto315fd412014-04-25 22:45:02 +0900215
Takashi Sakamoto6a226832014-04-25 22:45:08 +0900216void snd_efw_proc_init(struct snd_efw *efw);
217
Takashi Sakamotoa63d3ff2014-04-25 22:45:09 +0900218int snd_efw_create_midi_devices(struct snd_efw *efw);
219
Takashi Sakamotoaa02bb62014-04-25 22:45:11 +0900220int snd_efw_create_pcm_devices(struct snd_efw *efw);
221int snd_efw_get_multiplier_mode(unsigned int sampling_rate, unsigned int *mode);
222
Takashi Sakamoto594ddce2014-04-25 22:45:12 +0900223int snd_efw_create_hwdep_device(struct snd_efw *efw);
224
Takashi Sakamotob5b04332014-04-25 22:45:00 +0900225#define SND_EFW_DEV_ENTRY(vendor, model) \
226{ \
227 .match_flags = IEEE1394_MATCH_VENDOR_ID | \
228 IEEE1394_MATCH_MODEL_ID, \
229 .vendor_id = vendor,\
230 .model_id = model \
231}
232
233#endif