xref: /openbmc/linux/include/uapi/sound/firewire.h (revision dc36a9755a572781903d79f8437d109b72662da5)
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 #ifndef _UAPI_SOUND_FIREWIRE_H_INCLUDED
3 #define _UAPI_SOUND_FIREWIRE_H_INCLUDED
4 
5 #include <linux/ioctl.h>
6 #include <linux/types.h>
7 
8 /* events can be read() from the hwdep device */
9 
10 #define SNDRV_FIREWIRE_EVENT_LOCK_STATUS	0x000010cc
11 #define SNDRV_FIREWIRE_EVENT_DICE_NOTIFICATION	0xd1ce004e
12 #define SNDRV_FIREWIRE_EVENT_EFW_RESPONSE	0x4e617475
13 #define SNDRV_FIREWIRE_EVENT_DIGI00X_MESSAGE	0x746e736c
14 #define SNDRV_FIREWIRE_EVENT_MOTU_NOTIFICATION	0x64776479
15 #define SNDRV_FIREWIRE_EVENT_TASCAM_CONTROL	0x7473636d
16 
17 struct snd_firewire_event_common {
18 	unsigned int type; /* SNDRV_FIREWIRE_EVENT_xxx */
19 };
20 
21 struct snd_firewire_event_lock_status {
22 	unsigned int type;
23 	unsigned int status; /* 0/1 = unlocked/locked */
24 };
25 
26 struct snd_firewire_event_dice_notification {
27 	unsigned int type;
28 	unsigned int notification; /* DICE-specific bits */
29 };
30 
31 #define SND_EFW_TRANSACTION_USER_SEQNUM_MAX	((__u32)((__u16)~0) - 1)
32 /* each field should be in big endian */
33 struct snd_efw_transaction {
34 	__be32 length;
35 	__be32 version;
36 	__be32 seqnum;
37 	__be32 category;
38 	__be32 command;
39 	__be32 status;
40 	__be32 params[0];
41 };
42 struct snd_firewire_event_efw_response {
43 	unsigned int type;
44 	__be32 response[0];	/* some responses */
45 };
46 
47 struct snd_firewire_event_digi00x_message {
48 	unsigned int type;
49 	__u32 message;	/* Digi00x-specific message */
50 };
51 
52 struct snd_firewire_event_motu_notification {
53 	unsigned int type;
54 	__u32 message;	/* MOTU-specific bits. */
55 };
56 
57 struct snd_firewire_tascam_change {
58 	unsigned int index;
59 	__be32 before;
60 	__be32 after;
61 };
62 
63 struct snd_firewire_event_tascam_control {
64 	unsigned int type;
65 	struct snd_firewire_tascam_change changes[0];
66 };
67 
68 union snd_firewire_event {
69 	struct snd_firewire_event_common            common;
70 	struct snd_firewire_event_lock_status       lock_status;
71 	struct snd_firewire_event_dice_notification dice_notification;
72 	struct snd_firewire_event_efw_response      efw_response;
73 	struct snd_firewire_event_digi00x_message   digi00x_message;
74 	struct snd_firewire_event_tascam_control    tascam_control;
75 	struct snd_firewire_event_motu_notification motu_notification;
76 };
77 
78 
79 #define SNDRV_FIREWIRE_IOCTL_GET_INFO _IOR('H', 0xf8, struct snd_firewire_get_info)
80 #define SNDRV_FIREWIRE_IOCTL_LOCK      _IO('H', 0xf9)
81 #define SNDRV_FIREWIRE_IOCTL_UNLOCK    _IO('H', 0xfa)
82 #define SNDRV_FIREWIRE_IOCTL_TASCAM_STATE _IOR('H', 0xfb, struct snd_firewire_tascam_state)
83 #define SNDRV_FIREWIRE_IOCTL_MOTU_REGISTER_DSP_METER	_IOR('H', 0xfc, struct snd_firewire_motu_register_dsp_meter)
84 #define SNDRV_FIREWIRE_IOCTL_MOTU_COMMAND_DSP_METER	_IOR('H', 0xfd, struct snd_firewire_motu_command_dsp_meter)
85 
86 #define SNDRV_FIREWIRE_TYPE_DICE	1
87 #define SNDRV_FIREWIRE_TYPE_FIREWORKS	2
88 #define SNDRV_FIREWIRE_TYPE_BEBOB	3
89 #define SNDRV_FIREWIRE_TYPE_OXFW	4
90 #define SNDRV_FIREWIRE_TYPE_DIGI00X	5
91 #define SNDRV_FIREWIRE_TYPE_TASCAM	6
92 #define SNDRV_FIREWIRE_TYPE_MOTU	7
93 #define SNDRV_FIREWIRE_TYPE_FIREFACE	8
94 
95 struct snd_firewire_get_info {
96 	unsigned int type; /* SNDRV_FIREWIRE_TYPE_xxx */
97 	unsigned int card; /* same as fw_cdev_get_info.card */
98 	unsigned char guid[8];
99 	char device_name[16]; /* device node in /dev */
100 };
101 
102 /*
103  * SNDRV_FIREWIRE_IOCTL_LOCK prevents the driver from streaming.
104  * Returns -EBUSY if the driver is already streaming.
105  */
106 
107 #define SNDRV_FIREWIRE_TASCAM_STATE_COUNT	64
108 
109 struct snd_firewire_tascam_state {
110 	__be32 data[SNDRV_FIREWIRE_TASCAM_STATE_COUNT];
111 };
112 
113 // In below MOTU models, software is allowed to control their DSP by accessing to registers.
114 //  - 828mk2
115 //  - 896hd
116 //  - Traveler
117 //  - 8 pre
118 //  - Ultralite
119 //  - 4 pre
120 //  - Audio Express
121 //
122 // On the other hand, the status of DSP is split into specific messages included in the sequence of
123 // isochronous packet. ALSA firewire-motu driver gathers the messages and allow userspace applications
124 // to read it via ioctl. In 828mk2, 896hd, and Traveler, hardware meter for all of physical inputs
125 // are put into the message, while one pair of physical outputs is selected. The selection is done by
126 // LSB one byte in asynchronous write quadlet transaction to 0x'ffff'f000'0b2c.
127 //
128 // I note that V3HD/V4HD uses asynchronous transaction for the purpose. The destination address is
129 // registered to 0x'ffff'f000'0b38 and '0b3c by asynchronous write quadlet request. The size of
130 // message differs between 23 and 51 quadlets. For the case, the number of mixer bus can be extended
131 // up to 12.
132 
133 #define SNDRV_FIREWIRE_MOTU_REGISTER_DSP_METER_COUNT	40
134 
135 /**
136  * struct snd_firewire_motu_register_dsp_meter - the container for meter information in DSP
137  *						 controlled by register access
138  * @data: Signal level meters. The mapping between position and input/output channel is
139  *	  model-dependent.
140  *
141  * The structure expresses the part of DSP status for hardware meter. The u8 storage includes linear
142  * value for audio signal level between 0x00 and 0x7f.
143  */
144 struct snd_firewire_motu_register_dsp_meter {
145 	__u8 data[SNDRV_FIREWIRE_MOTU_REGISTER_DSP_METER_COUNT];
146 };
147 
148 #define SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_COUNT		4
149 #define SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_SRC_COUNT	20
150 
151 /**
152  * snd_firewire_motu_register_dsp_parameter - the container for parameters of DSP controlled
153  *					      by register access.
154  * @mixer.source.gain: The gain of source to mixer.
155  * @mixer.source.pan: The L/R balance of source to mixer.
156  * @mixer.source.flag: The flag of source to mixer, including mute, solo.
157  * @mixer.source.paired_balance: The L/R balance of paired source to mixer, only for 4 pre and
158  *				 Audio Express.
159  * @mixer.source.paired_width: The width of paired source to mixer, only for 4 pre and
160  *			       Audio Express.
161  *
162  * The structure expresses the set of parameters for DSP controlled by register access.
163  */
164 struct snd_firewire_motu_register_dsp_parameter {
165 	struct {
166 		struct {
167 			__u8 gain[SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_SRC_COUNT];
168 			__u8 pan[SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_SRC_COUNT];
169 			__u8 flag[SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_SRC_COUNT];
170 			__u8 paired_balance[SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_SRC_COUNT];
171 			__u8 paired_width[SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_SRC_COUNT];
172 		} source[SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_COUNT];
173 	} mixer;
174 };
175 
176 // In below MOTU models, software is allowed to control their DSP by command in frame of
177 // asynchronous transaction to 0x'ffff'0001'0000:
178 //
179 //  - 828 mk3 (FireWire only and Hybrid)
180 //  - 896 mk3 (FireWire only and Hybrid)
181 //  - Ultralite mk3 (FireWire only and Hybrid)
182 //  - Traveler mk3
183 //  - Track 16
184 //
185 // On the other hand, the states of hardware meter is split into specific messages included in the
186 // sequence of isochronous packet. ALSA firewire-motu driver gathers the message and allow userspace
187 // application to read it via ioctl.
188 
189 #define SNDRV_FIREWIRE_MOTU_COMMAND_DSP_METER_COUNT	400
190 
191 /**
192  * struct snd_firewire_motu_command_dsp_meter - the container for meter information in DSP
193  *						controlled by command
194  * @data: Signal level meters. The mapping between position and signal channel is model-dependent.
195  *
196  * The structure expresses the part of DSP status for hardware meter. The 32 bit storage is
197  * estimated to include IEEE 764 32 bit single precision floating point (binary32) value. It is
198  * expected to be linear value (not logarithm) for audio signal level between 0.0 and +1.0. However,
199  * the last two quadlets (data[398] and data[399]) are filled with 0xffffffff since they are the
200  * marker of one period.
201  */
202 struct snd_firewire_motu_command_dsp_meter {
203 	__u32 data[SNDRV_FIREWIRE_MOTU_COMMAND_DSP_METER_COUNT];
204 };
205 
206 #endif /* _UAPI_SOUND_FIREWIRE_H_INCLUDED */
207