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