1da607e19SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */ 2e2786ca6STakashi Sakamoto /* 3e2786ca6STakashi Sakamoto * oxfw.h - a part of driver for OXFW970/971 based devices 4e2786ca6STakashi Sakamoto * 5e2786ca6STakashi Sakamoto * Copyright (c) Clemens Ladisch <clemens@ladisch.de> 6e2786ca6STakashi Sakamoto */ 7e2786ca6STakashi Sakamoto 8e2786ca6STakashi Sakamoto #include <linux/device.h> 9e2786ca6STakashi Sakamoto #include <linux/firewire.h> 10e2786ca6STakashi Sakamoto #include <linux/firewire-constants.h> 11e2786ca6STakashi Sakamoto #include <linux/module.h> 12e2786ca6STakashi Sakamoto #include <linux/mod_devicetable.h> 13e2786ca6STakashi Sakamoto #include <linux/mutex.h> 14e2786ca6STakashi Sakamoto #include <linux/slab.h> 158985f4acSTakashi Sakamoto #include <linux/compat.h> 16174cd4b1SIngo Molnar #include <linux/sched/signal.h> 17e2786ca6STakashi Sakamoto 18e2786ca6STakashi Sakamoto #include <sound/control.h> 19e2786ca6STakashi Sakamoto #include <sound/core.h> 20e2786ca6STakashi Sakamoto #include <sound/initval.h> 21e2786ca6STakashi Sakamoto #include <sound/pcm.h> 22e2786ca6STakashi Sakamoto #include <sound/pcm_params.h> 233c96101fSTakashi Sakamoto #include <sound/info.h> 2405588d34STakashi Sakamoto #include <sound/rawmidi.h> 258985f4acSTakashi Sakamoto #include <sound/firewire.h> 268985f4acSTakashi Sakamoto #include <sound/hwdep.h> 27e2786ca6STakashi Sakamoto 28e2786ca6STakashi Sakamoto #include "../lib.h" 29e2786ca6STakashi Sakamoto #include "../fcp.h" 30e2786ca6STakashi Sakamoto #include "../packets-buffer.h" 31e2786ca6STakashi Sakamoto #include "../iso-resources.h" 325955815eSTakashi Sakamoto #include "../amdtp-am824.h" 33e2786ca6STakashi Sakamoto #include "../cmp.h" 34e2786ca6STakashi Sakamoto 35a092f000STakashi Sakamoto enum snd_oxfw_quirk { 36a092f000STakashi Sakamoto // Postpone transferring packets during handling asynchronous transaction. As a result, 37a092f000STakashi Sakamoto // next isochronous packet includes more events than one packet can include. 38a092f000STakashi Sakamoto SND_OXFW_QUIRK_JUMBO_PAYLOAD = 0x01, 39a6f91693STakashi Sakamoto // The dbs field of CIP header in tx packet is wrong. 40a6f91693STakashi Sakamoto SND_OXFW_QUIRK_WRONG_DBS = 0x02, 4107a35edcSTakashi Sakamoto // Blocking transmission mode is used. 4207a35edcSTakashi Sakamoto SND_OXFW_QUIRK_BLOCKING_TRANSMISSION = 0x04, 43b566e972STakashi Sakamoto // Stanton SCS1.d and SCS1.m support unique transaction. 44b566e972STakashi Sakamoto SND_OXFW_QUIRK_SCS_TRANSACTION = 0x08, 45*67bb66d3STakashi Sakamoto // Apogee Duet FireWire ignores data blocks in packet with NO_INFO for audio data 46*67bb66d3STakashi Sakamoto // processing, while output level meter moves. Any value in syt field of packet takes 47*67bb66d3STakashi Sakamoto // the device to process audio data even if the value is invalid in a point of 48*67bb66d3STakashi Sakamoto // IEC 61883-1/6. 49*67bb66d3STakashi Sakamoto SND_OXFW_QUIRK_IGNORE_NO_INFO_PACKET = 0x10, 50a092f000STakashi Sakamoto }; 51a092f000STakashi Sakamoto 525cd1d3f4STakashi Sakamoto /* This is an arbitrary number for convinience. */ 535cd1d3f4STakashi Sakamoto #define SND_OXFW_STREAM_FORMAT_ENTRIES 10 54e2786ca6STakashi Sakamoto struct snd_oxfw { 55e2786ca6STakashi Sakamoto struct snd_card *card; 56e2786ca6STakashi Sakamoto struct fw_unit *unit; 57e2786ca6STakashi Sakamoto struct mutex mutex; 5805588d34STakashi Sakamoto spinlock_t lock; 595cd1d3f4STakashi Sakamoto 60a092f000STakashi Sakamoto // The combination of snd_oxfw_quirk enumeration-constants. 61a092f000STakashi Sakamoto unsigned int quirks; 62b0ac0009STakashi Sakamoto bool has_output; 6306a42a74STakashi Sakamoto bool has_input; 64b0ac0009STakashi Sakamoto u8 *tx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES]; 655cd1d3f4STakashi Sakamoto u8 *rx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES]; 665cd1d3f4STakashi Sakamoto bool assumed; 67b0ac0009STakashi Sakamoto struct cmp_connection out_conn; 68e2786ca6STakashi Sakamoto struct cmp_connection in_conn; 69b0ac0009STakashi Sakamoto struct amdtp_stream tx_stream; 70e2786ca6STakashi Sakamoto struct amdtp_stream rx_stream; 714a0a0472STakashi Sakamoto unsigned int substreams_count; 725cd1d3f4STakashi Sakamoto 7305588d34STakashi Sakamoto unsigned int midi_input_ports; 7405588d34STakashi Sakamoto unsigned int midi_output_ports; 7505588d34STakashi Sakamoto 768985f4acSTakashi Sakamoto int dev_lock_count; 778985f4acSTakashi Sakamoto bool dev_lock_changed; 788985f4acSTakashi Sakamoto wait_queue_head_t hwdep_wait; 7927e66635STakashi Sakamoto 80c582cc66STakashi Sakamoto void *spec; 81ac5d7786STakashi Sakamoto 82ac5d7786STakashi Sakamoto struct amdtp_domain domain; 83e2786ca6STakashi Sakamoto }; 84e2786ca6STakashi Sakamoto 855b59d809STakashi Sakamoto /* 865b59d809STakashi Sakamoto * AV/C Stream Format Information Specification 1.1 Working Draft 875b59d809STakashi Sakamoto * (Apr 2005, 1394TA) 885b59d809STakashi Sakamoto */ 895b59d809STakashi Sakamoto int avc_stream_set_format(struct fw_unit *unit, enum avc_general_plug_dir dir, 905b59d809STakashi Sakamoto unsigned int pid, u8 *format, unsigned int len); 915b59d809STakashi Sakamoto int avc_stream_get_format(struct fw_unit *unit, 925b59d809STakashi Sakamoto enum avc_general_plug_dir dir, unsigned int pid, 935b59d809STakashi Sakamoto u8 *buf, unsigned int *len, unsigned int eid); 945b59d809STakashi Sakamoto static inline int 955b59d809STakashi Sakamoto avc_stream_get_format_single(struct fw_unit *unit, 965b59d809STakashi Sakamoto enum avc_general_plug_dir dir, unsigned int pid, 975b59d809STakashi Sakamoto u8 *buf, unsigned int *len) 985b59d809STakashi Sakamoto { 995b59d809STakashi Sakamoto return avc_stream_get_format(unit, dir, pid, buf, len, 0xff); 1005b59d809STakashi Sakamoto } 1015b59d809STakashi Sakamoto static inline int 1025b59d809STakashi Sakamoto avc_stream_get_format_list(struct fw_unit *unit, 1035b59d809STakashi Sakamoto enum avc_general_plug_dir dir, unsigned int pid, 1045b59d809STakashi Sakamoto u8 *buf, unsigned int *len, 1055b59d809STakashi Sakamoto unsigned int eid) 1065b59d809STakashi Sakamoto { 1075b59d809STakashi Sakamoto return avc_stream_get_format(unit, dir, pid, buf, len, eid); 1085b59d809STakashi Sakamoto } 1095b59d809STakashi Sakamoto 1105b59d809STakashi Sakamoto /* 1115b59d809STakashi Sakamoto * AV/C Digital Interface Command Set General Specification 4.2 1125b59d809STakashi Sakamoto * (Sep 2004, 1394TA) 1135b59d809STakashi Sakamoto */ 1145b59d809STakashi Sakamoto int avc_general_inquiry_sig_fmt(struct fw_unit *unit, unsigned int rate, 1155b59d809STakashi Sakamoto enum avc_general_plug_dir dir, 1165b59d809STakashi Sakamoto unsigned short pid); 1175b59d809STakashi Sakamoto 118779f0dbaSTakashi Sakamoto int snd_oxfw_stream_init_duplex(struct snd_oxfw *oxfw); 1194f380d00STakashi Sakamoto int snd_oxfw_stream_reserve_duplex(struct snd_oxfw *oxfw, 120b0ac0009STakashi Sakamoto struct amdtp_stream *stream, 1211d6a722cSTakashi Sakamoto unsigned int rate, unsigned int pcm_channels, 1223299d2a0STakashi Sakamoto unsigned int frames_per_period, 1233299d2a0STakashi Sakamoto unsigned int frames_per_buffer); 1244f380d00STakashi Sakamoto int snd_oxfw_stream_start_duplex(struct snd_oxfw *oxfw); 125779f0dbaSTakashi Sakamoto void snd_oxfw_stream_stop_duplex(struct snd_oxfw *oxfw); 126779f0dbaSTakashi Sakamoto void snd_oxfw_stream_destroy_duplex(struct snd_oxfw *oxfw); 127779f0dbaSTakashi Sakamoto void snd_oxfw_stream_update_duplex(struct snd_oxfw *oxfw); 1283713d93aSTakashi Sakamoto 1295cd1d3f4STakashi Sakamoto struct snd_oxfw_stream_formation { 1305cd1d3f4STakashi Sakamoto unsigned int rate; 1315cd1d3f4STakashi Sakamoto unsigned int pcm; 1325cd1d3f4STakashi Sakamoto unsigned int midi; 1335cd1d3f4STakashi Sakamoto }; 1345cd1d3f4STakashi Sakamoto int snd_oxfw_stream_parse_format(u8 *format, 1355cd1d3f4STakashi Sakamoto struct snd_oxfw_stream_formation *formation); 1365cd1d3f4STakashi Sakamoto int snd_oxfw_stream_get_current_formation(struct snd_oxfw *oxfw, 1375cd1d3f4STakashi Sakamoto enum avc_general_plug_dir dir, 1385cd1d3f4STakashi Sakamoto struct snd_oxfw_stream_formation *formation); 139b0ac0009STakashi Sakamoto 1405cd1d3f4STakashi Sakamoto int snd_oxfw_stream_discover(struct snd_oxfw *oxfw); 1415cd1d3f4STakashi Sakamoto 1428985f4acSTakashi Sakamoto void snd_oxfw_stream_lock_changed(struct snd_oxfw *oxfw); 1438985f4acSTakashi Sakamoto int snd_oxfw_stream_lock_try(struct snd_oxfw *oxfw); 1448985f4acSTakashi Sakamoto void snd_oxfw_stream_lock_release(struct snd_oxfw *oxfw); 1458985f4acSTakashi Sakamoto 1463713d93aSTakashi Sakamoto int snd_oxfw_create_pcm(struct snd_oxfw *oxfw); 14731514bfbSTakashi Sakamoto 1483c96101fSTakashi Sakamoto void snd_oxfw_proc_init(struct snd_oxfw *oxfw); 14905588d34STakashi Sakamoto 15005588d34STakashi Sakamoto int snd_oxfw_create_midi(struct snd_oxfw *oxfw); 1518985f4acSTakashi Sakamoto 1528985f4acSTakashi Sakamoto int snd_oxfw_create_hwdep(struct snd_oxfw *oxfw); 15329aa09acSTakashi Sakamoto 1543e2f4570STakashi Sakamoto int snd_oxfw_add_spkr(struct snd_oxfw *oxfw, bool is_lacie); 1553f47152aSTakashi Sakamoto int snd_oxfw_scs1x_add(struct snd_oxfw *oxfw); 156e3315b43STakashi Sakamoto void snd_oxfw_scs1x_update(struct snd_oxfw *oxfw); 157