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, 39*a6f91693STakashi Sakamoto // The dbs field of CIP header in tx packet is wrong. 40*a6f91693STakashi Sakamoto SND_OXFW_QUIRK_WRONG_DBS = 0x02, 41a092f000STakashi Sakamoto }; 42a092f000STakashi Sakamoto 435cd1d3f4STakashi Sakamoto /* This is an arbitrary number for convinience. */ 445cd1d3f4STakashi Sakamoto #define SND_OXFW_STREAM_FORMAT_ENTRIES 10 45e2786ca6STakashi Sakamoto struct snd_oxfw { 46e2786ca6STakashi Sakamoto struct snd_card *card; 47e2786ca6STakashi Sakamoto struct fw_unit *unit; 48e2786ca6STakashi Sakamoto struct mutex mutex; 4905588d34STakashi Sakamoto spinlock_t lock; 505cd1d3f4STakashi Sakamoto 516c29230eSTakashi Sakamoto bool registered; 526c29230eSTakashi Sakamoto struct delayed_work dwork; 536c29230eSTakashi Sakamoto 54a092f000STakashi Sakamoto // The combination of snd_oxfw_quirk enumeration-constants. 55a092f000STakashi Sakamoto unsigned int quirks; 56b0ac0009STakashi Sakamoto bool has_output; 5706a42a74STakashi Sakamoto bool has_input; 58b0ac0009STakashi Sakamoto u8 *tx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES]; 595cd1d3f4STakashi Sakamoto u8 *rx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES]; 605cd1d3f4STakashi Sakamoto bool assumed; 61b0ac0009STakashi Sakamoto struct cmp_connection out_conn; 62e2786ca6STakashi Sakamoto struct cmp_connection in_conn; 63b0ac0009STakashi Sakamoto struct amdtp_stream tx_stream; 64e2786ca6STakashi Sakamoto struct amdtp_stream rx_stream; 654a0a0472STakashi Sakamoto unsigned int substreams_count; 665cd1d3f4STakashi Sakamoto 6705588d34STakashi Sakamoto unsigned int midi_input_ports; 6805588d34STakashi Sakamoto unsigned int midi_output_ports; 6905588d34STakashi Sakamoto 708985f4acSTakashi Sakamoto int dev_lock_count; 718985f4acSTakashi Sakamoto bool dev_lock_changed; 728985f4acSTakashi Sakamoto wait_queue_head_t hwdep_wait; 7327e66635STakashi Sakamoto 7427e66635STakashi Sakamoto const struct ieee1394_device_id *entry; 75c582cc66STakashi Sakamoto void *spec; 76ac5d7786STakashi Sakamoto 77ac5d7786STakashi Sakamoto struct amdtp_domain domain; 78e2786ca6STakashi Sakamoto }; 79e2786ca6STakashi Sakamoto 805b59d809STakashi Sakamoto /* 815b59d809STakashi Sakamoto * AV/C Stream Format Information Specification 1.1 Working Draft 825b59d809STakashi Sakamoto * (Apr 2005, 1394TA) 835b59d809STakashi Sakamoto */ 845b59d809STakashi Sakamoto int avc_stream_set_format(struct fw_unit *unit, enum avc_general_plug_dir dir, 855b59d809STakashi Sakamoto unsigned int pid, u8 *format, unsigned int len); 865b59d809STakashi Sakamoto int avc_stream_get_format(struct fw_unit *unit, 875b59d809STakashi Sakamoto enum avc_general_plug_dir dir, unsigned int pid, 885b59d809STakashi Sakamoto u8 *buf, unsigned int *len, unsigned int eid); 895b59d809STakashi Sakamoto static inline int 905b59d809STakashi Sakamoto avc_stream_get_format_single(struct fw_unit *unit, 915b59d809STakashi Sakamoto enum avc_general_plug_dir dir, unsigned int pid, 925b59d809STakashi Sakamoto u8 *buf, unsigned int *len) 935b59d809STakashi Sakamoto { 945b59d809STakashi Sakamoto return avc_stream_get_format(unit, dir, pid, buf, len, 0xff); 955b59d809STakashi Sakamoto } 965b59d809STakashi Sakamoto static inline int 975b59d809STakashi Sakamoto avc_stream_get_format_list(struct fw_unit *unit, 985b59d809STakashi Sakamoto enum avc_general_plug_dir dir, unsigned int pid, 995b59d809STakashi Sakamoto u8 *buf, unsigned int *len, 1005b59d809STakashi Sakamoto unsigned int eid) 1015b59d809STakashi Sakamoto { 1025b59d809STakashi Sakamoto return avc_stream_get_format(unit, dir, pid, buf, len, eid); 1035b59d809STakashi Sakamoto } 1045b59d809STakashi Sakamoto 1055b59d809STakashi Sakamoto /* 1065b59d809STakashi Sakamoto * AV/C Digital Interface Command Set General Specification 4.2 1075b59d809STakashi Sakamoto * (Sep 2004, 1394TA) 1085b59d809STakashi Sakamoto */ 1095b59d809STakashi Sakamoto int avc_general_inquiry_sig_fmt(struct fw_unit *unit, unsigned int rate, 1105b59d809STakashi Sakamoto enum avc_general_plug_dir dir, 1115b59d809STakashi Sakamoto unsigned short pid); 1125b59d809STakashi Sakamoto 113779f0dbaSTakashi Sakamoto int snd_oxfw_stream_init_duplex(struct snd_oxfw *oxfw); 1144f380d00STakashi Sakamoto int snd_oxfw_stream_reserve_duplex(struct snd_oxfw *oxfw, 115b0ac0009STakashi Sakamoto struct amdtp_stream *stream, 1161d6a722cSTakashi Sakamoto unsigned int rate, unsigned int pcm_channels, 1173299d2a0STakashi Sakamoto unsigned int frames_per_period, 1183299d2a0STakashi Sakamoto unsigned int frames_per_buffer); 1194f380d00STakashi Sakamoto int snd_oxfw_stream_start_duplex(struct snd_oxfw *oxfw); 120779f0dbaSTakashi Sakamoto void snd_oxfw_stream_stop_duplex(struct snd_oxfw *oxfw); 121779f0dbaSTakashi Sakamoto void snd_oxfw_stream_destroy_duplex(struct snd_oxfw *oxfw); 122779f0dbaSTakashi Sakamoto void snd_oxfw_stream_update_duplex(struct snd_oxfw *oxfw); 1233713d93aSTakashi Sakamoto 1245cd1d3f4STakashi Sakamoto struct snd_oxfw_stream_formation { 1255cd1d3f4STakashi Sakamoto unsigned int rate; 1265cd1d3f4STakashi Sakamoto unsigned int pcm; 1275cd1d3f4STakashi Sakamoto unsigned int midi; 1285cd1d3f4STakashi Sakamoto }; 1295cd1d3f4STakashi Sakamoto int snd_oxfw_stream_parse_format(u8 *format, 1305cd1d3f4STakashi Sakamoto struct snd_oxfw_stream_formation *formation); 1315cd1d3f4STakashi Sakamoto int snd_oxfw_stream_get_current_formation(struct snd_oxfw *oxfw, 1325cd1d3f4STakashi Sakamoto enum avc_general_plug_dir dir, 1335cd1d3f4STakashi Sakamoto struct snd_oxfw_stream_formation *formation); 134b0ac0009STakashi Sakamoto 1355cd1d3f4STakashi Sakamoto int snd_oxfw_stream_discover(struct snd_oxfw *oxfw); 1365cd1d3f4STakashi Sakamoto 1378985f4acSTakashi Sakamoto void snd_oxfw_stream_lock_changed(struct snd_oxfw *oxfw); 1388985f4acSTakashi Sakamoto int snd_oxfw_stream_lock_try(struct snd_oxfw *oxfw); 1398985f4acSTakashi Sakamoto void snd_oxfw_stream_lock_release(struct snd_oxfw *oxfw); 1408985f4acSTakashi Sakamoto 1413713d93aSTakashi Sakamoto int snd_oxfw_create_pcm(struct snd_oxfw *oxfw); 14231514bfbSTakashi Sakamoto 1433c96101fSTakashi Sakamoto void snd_oxfw_proc_init(struct snd_oxfw *oxfw); 14405588d34STakashi Sakamoto 14505588d34STakashi Sakamoto int snd_oxfw_create_midi(struct snd_oxfw *oxfw); 1468985f4acSTakashi Sakamoto 1478985f4acSTakashi Sakamoto int snd_oxfw_create_hwdep(struct snd_oxfw *oxfw); 14829aa09acSTakashi Sakamoto 1493e2f4570STakashi Sakamoto int snd_oxfw_add_spkr(struct snd_oxfw *oxfw, bool is_lacie); 1503f47152aSTakashi Sakamoto int snd_oxfw_scs1x_add(struct snd_oxfw *oxfw); 151e3315b43STakashi Sakamoto void snd_oxfw_scs1x_update(struct snd_oxfw *oxfw); 152