xref: /openbmc/linux/sound/firewire/oxfw/oxfw.h (revision 329fec2f)
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 
17 #include <sound/control.h>
18 #include <sound/core.h>
19 #include <sound/initval.h>
20 #include <sound/pcm.h>
21 #include <sound/pcm_params.h>
22 #include <sound/info.h>
23 #include <sound/rawmidi.h>
24 #include <sound/firewire.h>
25 #include <sound/hwdep.h>
26 
27 #include "../lib.h"
28 #include "../fcp.h"
29 #include "../packets-buffer.h"
30 #include "../iso-resources.h"
31 #include "../amdtp-am824.h"
32 #include "../cmp.h"
33 
34 /* This is an arbitrary number for convinience. */
35 #define	SND_OXFW_STREAM_FORMAT_ENTRIES	10
36 struct snd_oxfw {
37 	struct snd_card *card;
38 	struct fw_unit *unit;
39 	struct mutex mutex;
40 	spinlock_t lock;
41 
42 	bool wrong_dbs;
43 	bool has_output;
44 	u8 *tx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
45 	u8 *rx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
46 	bool assumed;
47 	struct cmp_connection out_conn;
48 	struct cmp_connection in_conn;
49 	struct amdtp_stream tx_stream;
50 	struct amdtp_stream rx_stream;
51 	unsigned int capture_substreams;
52 	unsigned int playback_substreams;
53 
54 	unsigned int midi_input_ports;
55 	unsigned int midi_output_ports;
56 
57 	int dev_lock_count;
58 	bool dev_lock_changed;
59 	wait_queue_head_t hwdep_wait;
60 
61 	const struct ieee1394_device_id *entry;
62 	void *spec;
63 };
64 
65 /*
66  * AV/C Stream Format Information Specification 1.1 Working Draft
67  * (Apr 2005, 1394TA)
68  */
69 int avc_stream_set_format(struct fw_unit *unit, enum avc_general_plug_dir dir,
70 			  unsigned int pid, u8 *format, unsigned int len);
71 int avc_stream_get_format(struct fw_unit *unit,
72 			  enum avc_general_plug_dir dir, unsigned int pid,
73 			  u8 *buf, unsigned int *len, unsigned int eid);
74 static inline int
75 avc_stream_get_format_single(struct fw_unit *unit,
76 			     enum avc_general_plug_dir dir, unsigned int pid,
77 			     u8 *buf, unsigned int *len)
78 {
79 	return avc_stream_get_format(unit, dir, pid, buf, len, 0xff);
80 }
81 static inline int
82 avc_stream_get_format_list(struct fw_unit *unit,
83 			   enum avc_general_plug_dir dir, unsigned int pid,
84 			   u8 *buf, unsigned int *len,
85 			   unsigned int eid)
86 {
87 	return avc_stream_get_format(unit, dir, pid, buf, len, eid);
88 }
89 
90 /*
91  * AV/C Digital Interface Command Set General Specification 4.2
92  * (Sep 2004, 1394TA)
93  */
94 int avc_general_inquiry_sig_fmt(struct fw_unit *unit, unsigned int rate,
95 				enum avc_general_plug_dir dir,
96 				unsigned short pid);
97 
98 int snd_oxfw_stream_init_simplex(struct snd_oxfw *oxfw,
99 				 struct amdtp_stream *stream);
100 int snd_oxfw_stream_start_simplex(struct snd_oxfw *oxfw,
101 				  struct amdtp_stream *stream,
102 				  unsigned int rate, unsigned int pcm_channels);
103 void snd_oxfw_stream_stop_simplex(struct snd_oxfw *oxfw,
104 				  struct amdtp_stream *stream);
105 void snd_oxfw_stream_destroy_simplex(struct snd_oxfw *oxfw,
106 				     struct amdtp_stream *stream);
107 void snd_oxfw_stream_update_simplex(struct snd_oxfw *oxfw,
108 				    struct amdtp_stream *stream);
109 
110 struct snd_oxfw_stream_formation {
111 	unsigned int rate;
112 	unsigned int pcm;
113 	unsigned int midi;
114 };
115 int snd_oxfw_stream_parse_format(u8 *format,
116 				 struct snd_oxfw_stream_formation *formation);
117 int snd_oxfw_stream_get_current_formation(struct snd_oxfw *oxfw,
118 				enum avc_general_plug_dir dir,
119 				struct snd_oxfw_stream_formation *formation);
120 
121 int snd_oxfw_stream_discover(struct snd_oxfw *oxfw);
122 
123 void snd_oxfw_stream_lock_changed(struct snd_oxfw *oxfw);
124 int snd_oxfw_stream_lock_try(struct snd_oxfw *oxfw);
125 void snd_oxfw_stream_lock_release(struct snd_oxfw *oxfw);
126 
127 int snd_oxfw_create_pcm(struct snd_oxfw *oxfw);
128 
129 void snd_oxfw_proc_init(struct snd_oxfw *oxfw);
130 
131 int snd_oxfw_create_midi(struct snd_oxfw *oxfw);
132 
133 int snd_oxfw_create_hwdep(struct snd_oxfw *oxfw);
134 
135 int snd_oxfw_add_spkr(struct snd_oxfw *oxfw, bool is_lacie);
136 int snd_oxfw_scs1x_add(struct snd_oxfw *oxfw);
137 void snd_oxfw_scs1x_update(struct snd_oxfw *oxfw);
138