sound/firewire/oxfw/oxfw.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * oxfw.h - a part of driver for OXFW970/971 based devices
   4  *
   5  * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
   6  */
   7
   8 #include <linux/device.h>
   9 #include <linux/firewire.h>
  10 #include <linux/firewire-constants.h>
  11 #include <linux/module.h>
  12 #include <linux/mod_devicetable.h>
  13 #include <linux/mutex.h>
  14 #include <linux/slab.h>
  15 #include <linux/compat.h>
  16 #include <linux/sched/signal.h>
  17
  18 #include <sound/control.h>
  19 #include <sound/core.h>
  20 #include <sound/initval.h>
  21 #include <sound/pcm.h>
  22 #include <sound/pcm_params.h>
  23 #include <sound/info.h>
  24 #include <sound/rawmidi.h>
  25 #include <sound/firewire.h>
  26 #include <sound/hwdep.h>
  27
  28 #include "../lib.h"
  29 #include "../fcp.h"
  30 #include "../packets-buffer.h"
  31 #include "../iso-resources.h"
  32 #include "../amdtp-am824.h"
  33 #include "../cmp.h"
  34
  35 enum snd_oxfw_quirk {
  36         // Postpone transferring packets during handling asynchronous transaction. As a result,
  37         // next isochronous packet includes more events than one packet can include.
  38         SND_OXFW_QUIRK_JUMBO_PAYLOAD = 0x01,
  39 };
  40
  41 /* This is an arbitrary number for convinience. */
  42 #define SND_OXFW_STREAM_FORMAT_ENTRIES  10
  43 struct snd_oxfw {
  44         struct snd_card *card;
  45         struct fw_unit *unit;
  46         struct mutex mutex;
  47         spinlock_t lock;
  48
  49         bool registered;
  50         struct delayed_work dwork;
  51
  52         // The combination of snd_oxfw_quirk enumeration-constants.
  53         unsigned int quirks;
  54         bool wrong_dbs;
  55         bool has_output;
  56         bool has_input;
  57         u8 *tx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
  58         u8 *rx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
  59         bool assumed;
  60         struct cmp_connection out_conn;
  61         struct cmp_connection in_conn;
  62         struct amdtp_stream tx_stream;
  63         struct amdtp_stream rx_stream;
  64         unsigned int substreams_count;
  65
  66         unsigned int midi_input_ports;
  67         unsigned int midi_output_ports;
  68
  69         int dev_lock_count;
  70         bool dev_lock_changed;
  71         wait_queue_head_t hwdep_wait;
  72
  73         const struct ieee1394_device_id *entry;
  74         void *spec;
  75
  76         struct amdtp_domain domain;
  77 };
  78
  79 /*
  80  * AV/C Stream Format Information Specification 1.1 Working Draft
  81  * (Apr 2005, 1394TA)
  82  */
  83 int avc_stream_set_format(struct fw_unit *unit, enum avc_general_plug_dir dir,
  84                           unsigned int pid, u8 *format, unsigned int len);
  85 int avc_stream_get_format(struct fw_unit *unit,
  86                           enum avc_general_plug_dir dir, unsigned int pid,
  87                           u8 *buf, unsigned int *len, unsigned int eid);
  88 static inline int
  89 avc_stream_get_format_single(struct fw_unit *unit,
  90                              enum avc_general_plug_dir dir, unsigned int pid,
  91                              u8 *buf, unsigned int *len)
  92 {
  93         return avc_stream_get_format(unit, dir, pid, buf, len, 0xff);
  94 }
  95 static inline int
  96 avc_stream_get_format_list(struct fw_unit *unit,
  97                            enum avc_general_plug_dir dir, unsigned int pid,
  98                            u8 *buf, unsigned int *len,
  99                            unsigned int eid)
 100 {
 101         return avc_stream_get_format(unit, dir, pid, buf, len, eid);
 102 }
 103
 104 /*
 105  * AV/C Digital Interface Command Set General Specification 4.2
 106  * (Sep 2004, 1394TA)
 107  */
 108 int avc_general_inquiry_sig_fmt(struct fw_unit *unit, unsigned int rate,
 109                                 enum avc_general_plug_dir dir,
 110                                 unsigned short pid);
 111
 112 int snd_oxfw_stream_init_duplex(struct snd_oxfw *oxfw);
 113 int snd_oxfw_stream_reserve_duplex(struct snd_oxfw *oxfw,
 114                                    struct amdtp_stream *stream,
 115                                    unsigned int rate, unsigned int pcm_channels,
 116                                    unsigned int frames_per_period,
 117                                    unsigned int frames_per_buffer);
 118 int snd_oxfw_stream_start_duplex(struct snd_oxfw *oxfw);
 119 void snd_oxfw_stream_stop_duplex(struct snd_oxfw *oxfw);
 120 void snd_oxfw_stream_destroy_duplex(struct snd_oxfw *oxfw);
 121 void snd_oxfw_stream_update_duplex(struct snd_oxfw *oxfw);
 122
 123 struct snd_oxfw_stream_formation {
 124         unsigned int rate;
 125         unsigned int pcm;
 126         unsigned int midi;
 127 };
 128 int snd_oxfw_stream_parse_format(u8 *format,
 129                                  struct snd_oxfw_stream_formation *formation);
 130 int snd_oxfw_stream_get_current_formation(struct snd_oxfw *oxfw,
 131                                 enum avc_general_plug_dir dir,
 132                                 struct snd_oxfw_stream_formation *formation);
 133
 134 int snd_oxfw_stream_discover(struct snd_oxfw *oxfw);
 135
 136 void snd_oxfw_stream_lock_changed(struct snd_oxfw *oxfw);
 137 int snd_oxfw_stream_lock_try(struct snd_oxfw *oxfw);
 138 void snd_oxfw_stream_lock_release(struct snd_oxfw *oxfw);
 139
 140 int snd_oxfw_create_pcm(struct snd_oxfw *oxfw);
 141
 142 void snd_oxfw_proc_init(struct snd_oxfw *oxfw);
 143
 144 int snd_oxfw_create_midi(struct snd_oxfw *oxfw);
 145
 146 int snd_oxfw_create_hwdep(struct snd_oxfw *oxfw);
 147
 148 int snd_oxfw_add_spkr(struct snd_oxfw *oxfw, bool is_lacie);
 149 int snd_oxfw_scs1x_add(struct snd_oxfw *oxfw);
 150 void snd_oxfw_scs1x_update(struct snd_oxfw *oxfw);