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