2 * bebob.h - a part of driver for BeBoB based devices
4 * Copyright (c) 2013-2014 Takashi Sakamoto
6 * Licensed under the terms of the GNU General Public License, version 2.
9 #ifndef SOUND_BEBOB_H_INCLUDED
10 #define SOUND_BEBOB_H_INCLUDED
12 #include <linux/compat.h>
13 #include <linux/device.h>
14 #include <linux/firewire.h>
15 #include <linux/firewire-constants.h>
16 #include <linux/module.h>
17 #include <linux/mod_devicetable.h>
18 #include <linux/delay.h>
19 #include <linux/slab.h>
21 #include <sound/core.h>
22 #include <sound/initval.h>
23 #include <sound/info.h>
24 #include <sound/rawmidi.h>
25 #include <sound/pcm.h>
26 #include <sound/pcm_params.h>
27 #include <sound/firewire.h>
28 #include <sound/hwdep.h>
32 #include "../packets-buffer.h"
33 #include "../iso-resources.h"
37 /* basic register addresses on DM1000/DM1100/DM1500 */
38 #define BEBOB_ADDR_REG_INFO 0xffffc8020000
39 #define BEBOB_ADDR_REG_REQ 0xffffc8021000
43 #define SND_BEBOB_STRM_FMT_ENTRIES 7
44 struct snd_bebob_stream_formation
{
48 /* this is a lookup table for index of stream formations */
49 extern const unsigned int snd_bebob_rate_table
[SND_BEBOB_STRM_FMT_ENTRIES
];
51 /* device specific operations */
52 #define SND_BEBOB_CLOCK_INTERNAL "Internal"
53 struct snd_bebob_clock_spec
{
56 int (*get
)(struct snd_bebob
*bebob
, unsigned int *id
);
58 struct snd_bebob_rate_spec
{
59 int (*get
)(struct snd_bebob
*bebob
, unsigned int *rate
);
60 int (*set
)(struct snd_bebob
*bebob
, unsigned int rate
);
62 struct snd_bebob_meter_spec
{
65 int (*get
)(struct snd_bebob
*bebob
, u32
*target
, unsigned int size
);
67 struct snd_bebob_spec
{
68 struct snd_bebob_clock_spec
*clock
;
69 struct snd_bebob_rate_spec
*rate
;
70 struct snd_bebob_meter_spec
*meter
;
74 struct snd_card
*card
;
81 const struct snd_bebob_spec
*spec
;
83 unsigned int midi_input_ports
;
84 unsigned int midi_output_ports
;
86 /* for bus reset quirk */
87 struct completion bus_reset
;
90 struct amdtp_stream
*master
;
91 struct amdtp_stream tx_stream
;
92 struct amdtp_stream rx_stream
;
93 struct cmp_connection out_conn
;
94 struct cmp_connection in_conn
;
95 atomic_t capture_substreams
;
96 atomic_t playback_substreams
;
98 struct snd_bebob_stream_formation
99 tx_stream_formations
[SND_BEBOB_STRM_FMT_ENTRIES
];
100 struct snd_bebob_stream_formation
101 rx_stream_formations
[SND_BEBOB_STRM_FMT_ENTRIES
];
107 bool dev_lock_changed
;
108 wait_queue_head_t hwdep_wait
;
110 /* for M-Audio special devices */
111 void *maudio_special_quirk
;
115 snd_bebob_read_block(struct fw_unit
*unit
, u64 addr
, void *buf
, int size
)
117 return snd_fw_transaction(unit
, TCODE_READ_BLOCK_REQUEST
,
118 BEBOB_ADDR_REG_INFO
+ addr
,
123 snd_bebob_read_quad(struct fw_unit
*unit
, u64 addr
, u32
*buf
)
125 return snd_fw_transaction(unit
, TCODE_READ_QUADLET_REQUEST
,
126 BEBOB_ADDR_REG_INFO
+ addr
,
127 (void *)buf
, sizeof(u32
), 0);
130 /* AV/C Audio Subunit Specification 1.0 (Oct 2000, 1394TA) */
131 int avc_audio_set_selector(struct fw_unit
*unit
, unsigned int subunit_id
,
132 unsigned int fb_id
, unsigned int num
);
133 int avc_audio_get_selector(struct fw_unit
*unit
, unsigned int subunit_id
,
134 unsigned int fb_id
, unsigned int *num
);
137 * AVC command extensions, AV/C Unit and Subunit, Revision 17
138 * (Nov 2003, BridgeCo)
140 #define AVC_BRIDGECO_ADDR_BYTES 6
141 enum avc_bridgeco_plug_dir
{
142 AVC_BRIDGECO_PLUG_DIR_IN
= 0x00,
143 AVC_BRIDGECO_PLUG_DIR_OUT
= 0x01
145 enum avc_bridgeco_plug_mode
{
146 AVC_BRIDGECO_PLUG_MODE_UNIT
= 0x00,
147 AVC_BRIDGECO_PLUG_MODE_SUBUNIT
= 0x01,
148 AVC_BRIDGECO_PLUG_MODE_FUNCTION_BLOCK
= 0x02
150 enum avc_bridgeco_plug_unit
{
151 AVC_BRIDGECO_PLUG_UNIT_ISOC
= 0x00,
152 AVC_BRIDGECO_PLUG_UNIT_EXT
= 0x01,
153 AVC_BRIDGECO_PLUG_UNIT_ASYNC
= 0x02
155 enum avc_bridgeco_plug_type
{
156 AVC_BRIDGECO_PLUG_TYPE_ISOC
= 0x00,
157 AVC_BRIDGECO_PLUG_TYPE_ASYNC
= 0x01,
158 AVC_BRIDGECO_PLUG_TYPE_MIDI
= 0x02,
159 AVC_BRIDGECO_PLUG_TYPE_SYNC
= 0x03,
160 AVC_BRIDGECO_PLUG_TYPE_ANA
= 0x04,
161 AVC_BRIDGECO_PLUG_TYPE_DIG
= 0x05
164 avc_bridgeco_fill_unit_addr(u8 buf
[AVC_BRIDGECO_ADDR_BYTES
],
165 enum avc_bridgeco_plug_dir dir
,
166 enum avc_bridgeco_plug_unit unit
,
169 buf
[0] = 0xff; /* Unit */
171 buf
[2] = AVC_BRIDGECO_PLUG_MODE_UNIT
;
174 buf
[5] = 0xff; /* reserved */
177 avc_bridgeco_fill_msu_addr(u8 buf
[AVC_BRIDGECO_ADDR_BYTES
],
178 enum avc_bridgeco_plug_dir dir
,
181 buf
[0] = 0x60; /* Music subunit */
183 buf
[2] = AVC_BRIDGECO_PLUG_MODE_SUBUNIT
;
185 buf
[4] = 0xff; /* reserved */
186 buf
[5] = 0xff; /* reserved */
188 int avc_bridgeco_get_plug_ch_pos(struct fw_unit
*unit
,
189 u8 addr
[AVC_BRIDGECO_ADDR_BYTES
],
190 u8
*buf
, unsigned int len
);
191 int avc_bridgeco_get_plug_type(struct fw_unit
*unit
,
192 u8 addr
[AVC_BRIDGECO_ADDR_BYTES
],
193 enum avc_bridgeco_plug_type
*type
);
194 int avc_bridgeco_get_plug_section_type(struct fw_unit
*unit
,
195 u8 addr
[AVC_BRIDGECO_ADDR_BYTES
],
196 unsigned int id
, u8
*type
);
197 int avc_bridgeco_get_plug_input(struct fw_unit
*unit
,
198 u8 addr
[AVC_BRIDGECO_ADDR_BYTES
],
200 int avc_bridgeco_get_plug_strm_fmt(struct fw_unit
*unit
,
201 u8 addr
[AVC_BRIDGECO_ADDR_BYTES
], u8
*buf
,
202 unsigned int *len
, unsigned int eid
);
204 /* for AMDTP streaming */
205 int snd_bebob_stream_get_rate(struct snd_bebob
*bebob
, unsigned int *rate
);
206 int snd_bebob_stream_set_rate(struct snd_bebob
*bebob
, unsigned int rate
);
207 int snd_bebob_stream_check_internal_clock(struct snd_bebob
*bebob
,
209 int snd_bebob_stream_discover(struct snd_bebob
*bebob
);
210 int snd_bebob_stream_map(struct snd_bebob
*bebob
,
211 struct amdtp_stream
*stream
);
212 int snd_bebob_stream_init_duplex(struct snd_bebob
*bebob
);
213 int snd_bebob_stream_start_duplex(struct snd_bebob
*bebob
, int rate
);
214 void snd_bebob_stream_stop_duplex(struct snd_bebob
*bebob
);
215 void snd_bebob_stream_update_duplex(struct snd_bebob
*bebob
);
216 void snd_bebob_stream_destroy_duplex(struct snd_bebob
*bebob
);
218 void snd_bebob_stream_lock_changed(struct snd_bebob
*bebob
);
219 int snd_bebob_stream_lock_try(struct snd_bebob
*bebob
);
220 void snd_bebob_stream_lock_release(struct snd_bebob
*bebob
);
222 void snd_bebob_proc_init(struct snd_bebob
*bebob
);
224 int snd_bebob_create_midi_devices(struct snd_bebob
*bebob
);
226 int snd_bebob_create_pcm_devices(struct snd_bebob
*bebob
);
228 int snd_bebob_create_hwdep_device(struct snd_bebob
*bebob
);
230 /* model specific operations */
231 extern struct snd_bebob_spec phase88_rack_spec
;
232 extern struct snd_bebob_spec phase24_series_spec
;
233 extern struct snd_bebob_spec yamaha_go_spec
;
234 extern struct snd_bebob_spec saffirepro_26_spec
;
235 extern struct snd_bebob_spec saffirepro_10_spec
;
236 extern struct snd_bebob_spec saffire_le_spec
;
237 extern struct snd_bebob_spec saffire_spec
;
238 extern struct snd_bebob_spec maudio_fw410_spec
;
239 extern struct snd_bebob_spec maudio_audiophile_spec
;
240 extern struct snd_bebob_spec maudio_solo_spec
;
241 extern struct snd_bebob_spec maudio_ozonic_spec
;
242 extern struct snd_bebob_spec maudio_nrv10_spec
;
243 extern struct snd_bebob_spec maudio_special_spec
;
244 int snd_bebob_maudio_special_discover(struct snd_bebob
*bebob
, bool is1814
);
245 int snd_bebob_maudio_load_firmware(struct fw_unit
*unit
);
247 #define SND_BEBOB_DEV_ENTRY(vendor, model, data) \
249 .match_flags = IEEE1394_MATCH_VENDOR_ID | \
250 IEEE1394_MATCH_MODEL_ID, \
251 .vendor_id = vendor, \
253 .driver_data = (kernel_ulong_t)data \