1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * ff.h - a part of driver for RME Fireface series 4 * 5 * Copyright (c) 2015-2017 Takashi Sakamoto 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_unit_version { 38 SND_FF_UNIT_VERSION_FF800 = 0x000001, 39 SND_FF_UNIT_VERSION_FF400 = 0x000002, 40 SND_FF_UNIT_VERSION_UCX = 0x000004, 41 }; 42 43 enum snd_ff_stream_mode { 44 SND_FF_STREAM_MODE_LOW = 0, 45 SND_FF_STREAM_MODE_MID, 46 SND_FF_STREAM_MODE_HIGH, 47 SND_FF_STREAM_MODE_COUNT, 48 }; 49 50 struct snd_ff_protocol; 51 struct snd_ff_spec { 52 const char *const name; 53 54 const unsigned int pcm_capture_channels[SND_FF_STREAM_MODE_COUNT]; 55 const unsigned int pcm_playback_channels[SND_FF_STREAM_MODE_COUNT]; 56 57 unsigned int midi_in_ports; 58 unsigned int midi_out_ports; 59 60 const struct snd_ff_protocol *protocol; 61 u64 midi_high_addr; 62 u8 midi_addr_range; 63 u64 midi_rx_addrs[SND_FF_OUT_MIDI_PORTS]; 64 }; 65 66 struct snd_ff { 67 struct snd_card *card; 68 struct fw_unit *unit; 69 struct mutex mutex; 70 spinlock_t lock; 71 72 bool registered; 73 struct delayed_work dwork; 74 75 const struct snd_ff_spec *spec; 76 77 /* To handle MIDI tx. */ 78 struct snd_rawmidi_substream *tx_midi_substreams[SND_FF_IN_MIDI_PORTS]; 79 struct fw_address_handler async_handler; 80 81 /* TO handle MIDI rx. */ 82 struct snd_rawmidi_substream *rx_midi_substreams[SND_FF_OUT_MIDI_PORTS]; 83 bool on_sysex[SND_FF_OUT_MIDI_PORTS]; 84 __le32 msg_buf[SND_FF_OUT_MIDI_PORTS][SND_FF_MAXIMIM_MIDI_QUADS]; 85 struct work_struct rx_midi_work[SND_FF_OUT_MIDI_PORTS]; 86 struct fw_transaction transactions[SND_FF_OUT_MIDI_PORTS]; 87 ktime_t next_ktime[SND_FF_OUT_MIDI_PORTS]; 88 bool rx_midi_error[SND_FF_OUT_MIDI_PORTS]; 89 unsigned int rx_bytes[SND_FF_OUT_MIDI_PORTS]; 90 91 unsigned int substreams_counter; 92 struct amdtp_stream tx_stream; 93 struct amdtp_stream rx_stream; 94 struct fw_iso_resources tx_resources; 95 struct fw_iso_resources rx_resources; 96 97 int dev_lock_count; 98 bool dev_lock_changed; 99 wait_queue_head_t hwdep_wait; 100 101 struct amdtp_domain domain; 102 }; 103 104 enum snd_ff_clock_src { 105 SND_FF_CLOCK_SRC_INTERNAL, 106 SND_FF_CLOCK_SRC_SPDIF, 107 SND_FF_CLOCK_SRC_ADAT1, 108 SND_FF_CLOCK_SRC_ADAT2, 109 SND_FF_CLOCK_SRC_WORD, 110 SND_FF_CLOCK_SRC_LTC, 111 /* TODO: perhaps TCO exists. */ 112 }; 113 114 struct snd_ff_protocol { 115 void (*handle_midi_msg)(struct snd_ff *ff, unsigned int offset, 116 __le32 *buf, size_t length); 117 int (*fill_midi_msg)(struct snd_ff *ff, 118 struct snd_rawmidi_substream *substream, 119 unsigned int port); 120 int (*get_clock)(struct snd_ff *ff, unsigned int *rate, 121 enum snd_ff_clock_src *src); 122 int (*switch_fetching_mode)(struct snd_ff *ff, bool enable); 123 int (*allocate_resources)(struct snd_ff *ff, unsigned int rate); 124 int (*begin_session)(struct snd_ff *ff, unsigned int rate); 125 void (*finish_session)(struct snd_ff *ff); 126 void (*dump_status)(struct snd_ff *ff, struct snd_info_buffer *buffer); 127 }; 128 129 extern const struct snd_ff_protocol snd_ff_protocol_ff800; 130 extern const struct snd_ff_protocol snd_ff_protocol_ff400; 131 extern const struct snd_ff_protocol snd_ff_protocol_latter; 132 133 int snd_ff_transaction_register(struct snd_ff *ff); 134 int snd_ff_transaction_reregister(struct snd_ff *ff); 135 void snd_ff_transaction_unregister(struct snd_ff *ff); 136 137 int amdtp_ff_set_parameters(struct amdtp_stream *s, unsigned int rate, 138 unsigned int pcm_channels); 139 int amdtp_ff_add_pcm_hw_constraints(struct amdtp_stream *s, 140 struct snd_pcm_runtime *runtime); 141 int amdtp_ff_init(struct amdtp_stream *s, struct fw_unit *unit, 142 enum amdtp_stream_direction dir); 143 144 int snd_ff_stream_get_multiplier_mode(enum cip_sfc sfc, 145 enum snd_ff_stream_mode *mode); 146 int snd_ff_stream_init_duplex(struct snd_ff *ff); 147 void snd_ff_stream_destroy_duplex(struct snd_ff *ff); 148 int snd_ff_stream_reserve_duplex(struct snd_ff *ff, unsigned int rate, 149 unsigned int frames_per_period, 150 unsigned int frames_per_buffer); 151 int snd_ff_stream_start_duplex(struct snd_ff *ff, unsigned int rate); 152 void snd_ff_stream_stop_duplex(struct snd_ff *ff); 153 void snd_ff_stream_update_duplex(struct snd_ff *ff); 154 155 void snd_ff_stream_lock_changed(struct snd_ff *ff); 156 int snd_ff_stream_lock_try(struct snd_ff *ff); 157 void snd_ff_stream_lock_release(struct snd_ff *ff); 158 159 void snd_ff_proc_init(struct snd_ff *ff); 160 const char *snd_ff_proc_get_clk_label(enum snd_ff_clock_src src); 161 162 int snd_ff_create_midi_devices(struct snd_ff *ff); 163 164 int snd_ff_create_pcm_devices(struct snd_ff *ff); 165 166 int snd_ff_create_hwdep_devices(struct snd_ff *ff); 167 168 #endif 169