1
2
3
4
5
6
7
8 #ifndef SOUND_FIREFACE_H_INCLUDED
9 #define SOUND_FIREFACE_H_INCLUDED
10
11 #include <linux/device.h>
12 #include <linux/firewire.h>
13 #include <linux/firewire-constants.h>
14 #include <linux/module.h>
15 #include <linux/mod_devicetable.h>
16 #include <linux/mutex.h>
17 #include <linux/slab.h>
18 #include <linux/compat.h>
19 #include <linux/sched/signal.h>
20
21 #include <sound/core.h>
22 #include <sound/info.h>
23 #include <sound/rawmidi.h>
24 #include <sound/pcm.h>
25 #include <sound/pcm_params.h>
26 #include <sound/hwdep.h>
27 #include <sound/firewire.h>
28
29 #include "../lib.h"
30 #include "../amdtp-stream.h"
31 #include "../iso-resources.h"
32
33 #define SND_FF_MAXIMIM_MIDI_QUADS 9
34 #define SND_FF_IN_MIDI_PORTS 2
35 #define SND_FF_OUT_MIDI_PORTS 2
36
37 enum snd_ff_stream_mode {
38 SND_FF_STREAM_MODE_LOW = 0,
39 SND_FF_STREAM_MODE_MID,
40 SND_FF_STREAM_MODE_HIGH,
41 SND_FF_STREAM_MODE_COUNT,
42 };
43
44 struct snd_ff_protocol;
45 struct snd_ff_spec {
46 const char *const name;
47
48 const unsigned int pcm_capture_channels[SND_FF_STREAM_MODE_COUNT];
49 const unsigned int pcm_playback_channels[SND_FF_STREAM_MODE_COUNT];
50
51 unsigned int midi_in_ports;
52 unsigned int midi_out_ports;
53
54 const struct snd_ff_protocol *protocol;
55 u64 midi_high_addr;
56 u8 midi_addr_range;
57 u64 midi_rx_addrs[SND_FF_OUT_MIDI_PORTS];
58 };
59
60 struct snd_ff {
61 struct snd_card *card;
62 struct fw_unit *unit;
63 struct mutex mutex;
64 spinlock_t lock;
65
66 bool registered;
67 struct delayed_work dwork;
68
69 const struct snd_ff_spec *spec;
70
71
72 struct snd_rawmidi_substream *tx_midi_substreams[SND_FF_IN_MIDI_PORTS];
73 struct fw_address_handler async_handler;
74
75
76 struct snd_rawmidi_substream *rx_midi_substreams[SND_FF_OUT_MIDI_PORTS];
77 bool on_sysex[SND_FF_OUT_MIDI_PORTS];
78 __le32 msg_buf[SND_FF_OUT_MIDI_PORTS][SND_FF_MAXIMIM_MIDI_QUADS];
79 struct work_struct rx_midi_work[SND_FF_OUT_MIDI_PORTS];
80 struct fw_transaction transactions[SND_FF_OUT_MIDI_PORTS];
81 ktime_t next_ktime[SND_FF_OUT_MIDI_PORTS];
82 bool rx_midi_error[SND_FF_OUT_MIDI_PORTS];
83 unsigned int rx_bytes[SND_FF_OUT_MIDI_PORTS];
84
85 unsigned int substreams_counter;
86 struct amdtp_stream tx_stream;
87 struct amdtp_stream rx_stream;
88 struct fw_iso_resources tx_resources;
89 struct fw_iso_resources rx_resources;
90
91 int dev_lock_count;
92 bool dev_lock_changed;
93 wait_queue_head_t hwdep_wait;
94
95 struct amdtp_domain domain;
96 };
97
98 enum snd_ff_clock_src {
99 SND_FF_CLOCK_SRC_INTERNAL,
100 SND_FF_CLOCK_SRC_SPDIF,
101 SND_FF_CLOCK_SRC_ADAT1,
102 SND_FF_CLOCK_SRC_ADAT2,
103 SND_FF_CLOCK_SRC_WORD,
104 SND_FF_CLOCK_SRC_LTC,
105
106 };
107
108 struct snd_ff_protocol {
109 void (*handle_midi_msg)(struct snd_ff *ff, unsigned int offset,
110 __le32 *buf, size_t length);
111 int (*fill_midi_msg)(struct snd_ff *ff,
112 struct snd_rawmidi_substream *substream,
113 unsigned int port);
114 int (*get_clock)(struct snd_ff *ff, unsigned int *rate,
115 enum snd_ff_clock_src *src);
116 int (*switch_fetching_mode)(struct snd_ff *ff, bool enable);
117 int (*allocate_resources)(struct snd_ff *ff, unsigned int rate);
118 int (*begin_session)(struct snd_ff *ff, unsigned int rate);
119 void (*finish_session)(struct snd_ff *ff);
120 void (*dump_status)(struct snd_ff *ff, struct snd_info_buffer *buffer);
121 };
122
123 extern const struct snd_ff_protocol snd_ff_protocol_ff800;
124 extern const struct snd_ff_protocol snd_ff_protocol_ff400;
125 extern const struct snd_ff_protocol snd_ff_protocol_latter;
126
127 int snd_ff_transaction_register(struct snd_ff *ff);
128 int snd_ff_transaction_reregister(struct snd_ff *ff);
129 void snd_ff_transaction_unregister(struct snd_ff *ff);
130
131 int amdtp_ff_set_parameters(struct amdtp_stream *s, unsigned int rate,
132 unsigned int pcm_channels);
133 int amdtp_ff_add_pcm_hw_constraints(struct amdtp_stream *s,
134 struct snd_pcm_runtime *runtime);
135 int amdtp_ff_init(struct amdtp_stream *s, struct fw_unit *unit,
136 enum amdtp_stream_direction dir);
137
138 int snd_ff_stream_get_multiplier_mode(enum cip_sfc sfc,
139 enum snd_ff_stream_mode *mode);
140 int snd_ff_stream_init_duplex(struct snd_ff *ff);
141 void snd_ff_stream_destroy_duplex(struct snd_ff *ff);
142 int snd_ff_stream_reserve_duplex(struct snd_ff *ff, unsigned int rate);
143 int snd_ff_stream_start_duplex(struct snd_ff *ff, unsigned int rate);
144 void snd_ff_stream_stop_duplex(struct snd_ff *ff);
145 void snd_ff_stream_update_duplex(struct snd_ff *ff);
146
147 void snd_ff_stream_lock_changed(struct snd_ff *ff);
148 int snd_ff_stream_lock_try(struct snd_ff *ff);
149 void snd_ff_stream_lock_release(struct snd_ff *ff);
150
151 void snd_ff_proc_init(struct snd_ff *ff);
152 const char *snd_ff_proc_get_clk_label(enum snd_ff_clock_src src);
153
154 int snd_ff_create_midi_devices(struct snd_ff *ff);
155
156 int snd_ff_create_pcm_devices(struct snd_ff *ff);
157
158 int snd_ff_create_hwdep_devices(struct snd_ff *ff);
159
160 #endif