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