xref: /openbmc/linux/sound/firewire/oxfw/oxfw.h (revision ebd09753)
1 /*
2  * oxfw.h - a part of driver for OXFW970/971 based devices
3  *
4  * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
5  * Licensed under the terms of the GNU General Public License, version 2.
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 /* This is an arbitrary number for convinience. */
36 #define	SND_OXFW_STREAM_FORMAT_ENTRIES	10
37 struct snd_oxfw {
38 	struct snd_card *card;
39 	struct fw_unit *unit;
40 	struct mutex mutex;
41 	spinlock_t lock;
42 
43 	bool registered;
44 	struct delayed_work dwork;
45 
46 	bool wrong_dbs;
47 	bool has_output;
48 	u8 *tx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
49 	u8 *rx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
50 	bool assumed;
51 	struct cmp_connection out_conn;
52 	struct cmp_connection in_conn;
53 	struct amdtp_stream tx_stream;
54 	struct amdtp_stream rx_stream;
55 	unsigned int capture_substreams;
56 	unsigned int playback_substreams;
57 
58 	unsigned int midi_input_ports;
59 	unsigned int midi_output_ports;
60 
61 	int dev_lock_count;
62 	bool dev_lock_changed;
63 	wait_queue_head_t hwdep_wait;
64 
65 	const struct ieee1394_device_id *entry;
66 	void *spec;
67 };
68 
69 /*
70  * AV/C Stream Format Information Specification 1.1 Working Draft
71  * (Apr 2005, 1394TA)
72  */
73 int avc_stream_set_format(struct fw_unit *unit, enum avc_general_plug_dir dir,
74 			  unsigned int pid, u8 *format, unsigned int len);
75 int avc_stream_get_format(struct fw_unit *unit,
76 			  enum avc_general_plug_dir dir, unsigned int pid,
77 			  u8 *buf, unsigned int *len, unsigned int eid);
78 static inline int
79 avc_stream_get_format_single(struct fw_unit *unit,
80 			     enum avc_general_plug_dir dir, unsigned int pid,
81 			     u8 *buf, unsigned int *len)
82 {
83 	return avc_stream_get_format(unit, dir, pid, buf, len, 0xff);
84 }
85 static inline int
86 avc_stream_get_format_list(struct fw_unit *unit,
87 			   enum avc_general_plug_dir dir, unsigned int pid,
88 			   u8 *buf, unsigned int *len,
89 			   unsigned int eid)
90 {
91 	return avc_stream_get_format(unit, dir, pid, buf, len, eid);
92 }
93 
94 /*
95  * AV/C Digital Interface Command Set General Specification 4.2
96  * (Sep 2004, 1394TA)
97  */
98 int avc_general_inquiry_sig_fmt(struct fw_unit *unit, unsigned int rate,
99 				enum avc_general_plug_dir dir,
100 				unsigned short pid);
101 
102 int snd_oxfw_stream_init_simplex(struct snd_oxfw *oxfw,
103 				 struct amdtp_stream *stream);
104 int snd_oxfw_stream_start_simplex(struct snd_oxfw *oxfw,
105 				  struct amdtp_stream *stream,
106 				  unsigned int rate, unsigned int pcm_channels);
107 void snd_oxfw_stream_stop_simplex(struct snd_oxfw *oxfw,
108 				  struct amdtp_stream *stream);
109 void snd_oxfw_stream_destroy_simplex(struct snd_oxfw *oxfw,
110 				     struct amdtp_stream *stream);
111 void snd_oxfw_stream_update_simplex(struct snd_oxfw *oxfw,
112 				    struct amdtp_stream *stream);
113 
114 struct snd_oxfw_stream_formation {
115 	unsigned int rate;
116 	unsigned int pcm;
117 	unsigned int midi;
118 };
119 int snd_oxfw_stream_parse_format(u8 *format,
120 				 struct snd_oxfw_stream_formation *formation);
121 int snd_oxfw_stream_get_current_formation(struct snd_oxfw *oxfw,
122 				enum avc_general_plug_dir dir,
123 				struct snd_oxfw_stream_formation *formation);
124 
125 int snd_oxfw_stream_discover(struct snd_oxfw *oxfw);
126 
127 void snd_oxfw_stream_lock_changed(struct snd_oxfw *oxfw);
128 int snd_oxfw_stream_lock_try(struct snd_oxfw *oxfw);
129 void snd_oxfw_stream_lock_release(struct snd_oxfw *oxfw);
130 
131 int snd_oxfw_create_pcm(struct snd_oxfw *oxfw);
132 
133 void snd_oxfw_proc_init(struct snd_oxfw *oxfw);
134 
135 int snd_oxfw_create_midi(struct snd_oxfw *oxfw);
136 
137 int snd_oxfw_create_hwdep(struct snd_oxfw *oxfw);
138 
139 int snd_oxfw_add_spkr(struct snd_oxfw *oxfw, bool is_lacie);
140 int snd_oxfw_scs1x_add(struct snd_oxfw *oxfw);
141 void snd_oxfw_scs1x_update(struct snd_oxfw *oxfw);
142