xref: /OK3568_Linux_fs/kernel/include/uapi/sound/firewire.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2*4882a593Smuzhiyun #ifndef _UAPI_SOUND_FIREWIRE_H_INCLUDED
3*4882a593Smuzhiyun #define _UAPI_SOUND_FIREWIRE_H_INCLUDED
4*4882a593Smuzhiyun 
5*4882a593Smuzhiyun #include <linux/ioctl.h>
6*4882a593Smuzhiyun #include <linux/types.h>
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun /* events can be read() from the hwdep device */
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #define SNDRV_FIREWIRE_EVENT_LOCK_STATUS	0x000010cc
11*4882a593Smuzhiyun #define SNDRV_FIREWIRE_EVENT_DICE_NOTIFICATION	0xd1ce004e
12*4882a593Smuzhiyun #define SNDRV_FIREWIRE_EVENT_EFW_RESPONSE	0x4e617475
13*4882a593Smuzhiyun #define SNDRV_FIREWIRE_EVENT_DIGI00X_MESSAGE	0x746e736c
14*4882a593Smuzhiyun #define SNDRV_FIREWIRE_EVENT_MOTU_NOTIFICATION	0x64776479
15*4882a593Smuzhiyun #define SNDRV_FIREWIRE_EVENT_TASCAM_CONTROL	0x7473636d
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun struct snd_firewire_event_common {
18*4882a593Smuzhiyun 	unsigned int type; /* SNDRV_FIREWIRE_EVENT_xxx */
19*4882a593Smuzhiyun };
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun struct snd_firewire_event_lock_status {
22*4882a593Smuzhiyun 	unsigned int type;
23*4882a593Smuzhiyun 	unsigned int status; /* 0/1 = unlocked/locked */
24*4882a593Smuzhiyun };
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun struct snd_firewire_event_dice_notification {
27*4882a593Smuzhiyun 	unsigned int type;
28*4882a593Smuzhiyun 	unsigned int notification; /* DICE-specific bits */
29*4882a593Smuzhiyun };
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun #define SND_EFW_TRANSACTION_USER_SEQNUM_MAX	((__u32)((__u16)~0) - 1)
32*4882a593Smuzhiyun /* each field should be in big endian */
33*4882a593Smuzhiyun struct snd_efw_transaction {
34*4882a593Smuzhiyun 	__be32 length;
35*4882a593Smuzhiyun 	__be32 version;
36*4882a593Smuzhiyun 	__be32 seqnum;
37*4882a593Smuzhiyun 	__be32 category;
38*4882a593Smuzhiyun 	__be32 command;
39*4882a593Smuzhiyun 	__be32 status;
40*4882a593Smuzhiyun 	__be32 params[0];
41*4882a593Smuzhiyun };
42*4882a593Smuzhiyun struct snd_firewire_event_efw_response {
43*4882a593Smuzhiyun 	unsigned int type;
44*4882a593Smuzhiyun 	__be32 response[0];	/* some responses */
45*4882a593Smuzhiyun };
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun struct snd_firewire_event_digi00x_message {
48*4882a593Smuzhiyun 	unsigned int type;
49*4882a593Smuzhiyun 	__u32 message;	/* Digi00x-specific message */
50*4882a593Smuzhiyun };
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun struct snd_firewire_event_motu_notification {
53*4882a593Smuzhiyun 	unsigned int type;
54*4882a593Smuzhiyun 	__u32 message;	/* MOTU-specific bits. */
55*4882a593Smuzhiyun };
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun struct snd_firewire_tascam_change {
58*4882a593Smuzhiyun 	unsigned int index;
59*4882a593Smuzhiyun 	__be32 before;
60*4882a593Smuzhiyun 	__be32 after;
61*4882a593Smuzhiyun };
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun struct snd_firewire_event_tascam_control {
64*4882a593Smuzhiyun 	unsigned int type;
65*4882a593Smuzhiyun 	struct snd_firewire_tascam_change changes[0];
66*4882a593Smuzhiyun };
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun union snd_firewire_event {
69*4882a593Smuzhiyun 	struct snd_firewire_event_common            common;
70*4882a593Smuzhiyun 	struct snd_firewire_event_lock_status       lock_status;
71*4882a593Smuzhiyun 	struct snd_firewire_event_dice_notification dice_notification;
72*4882a593Smuzhiyun 	struct snd_firewire_event_efw_response      efw_response;
73*4882a593Smuzhiyun 	struct snd_firewire_event_digi00x_message   digi00x_message;
74*4882a593Smuzhiyun 	struct snd_firewire_event_tascam_control    tascam_control;
75*4882a593Smuzhiyun 	struct snd_firewire_event_motu_notification motu_notification;
76*4882a593Smuzhiyun };
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun #define SNDRV_FIREWIRE_IOCTL_GET_INFO _IOR('H', 0xf8, struct snd_firewire_get_info)
80*4882a593Smuzhiyun #define SNDRV_FIREWIRE_IOCTL_LOCK      _IO('H', 0xf9)
81*4882a593Smuzhiyun #define SNDRV_FIREWIRE_IOCTL_UNLOCK    _IO('H', 0xfa)
82*4882a593Smuzhiyun #define SNDRV_FIREWIRE_IOCTL_TASCAM_STATE _IOR('H', 0xfb, struct snd_firewire_tascam_state)
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun #define SNDRV_FIREWIRE_TYPE_DICE	1
85*4882a593Smuzhiyun #define SNDRV_FIREWIRE_TYPE_FIREWORKS	2
86*4882a593Smuzhiyun #define SNDRV_FIREWIRE_TYPE_BEBOB	3
87*4882a593Smuzhiyun #define SNDRV_FIREWIRE_TYPE_OXFW	4
88*4882a593Smuzhiyun #define SNDRV_FIREWIRE_TYPE_DIGI00X	5
89*4882a593Smuzhiyun #define SNDRV_FIREWIRE_TYPE_TASCAM	6
90*4882a593Smuzhiyun #define SNDRV_FIREWIRE_TYPE_MOTU	7
91*4882a593Smuzhiyun #define SNDRV_FIREWIRE_TYPE_FIREFACE	8
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun struct snd_firewire_get_info {
94*4882a593Smuzhiyun 	unsigned int type; /* SNDRV_FIREWIRE_TYPE_xxx */
95*4882a593Smuzhiyun 	unsigned int card; /* same as fw_cdev_get_info.card */
96*4882a593Smuzhiyun 	unsigned char guid[8];
97*4882a593Smuzhiyun 	char device_name[16]; /* device node in /dev */
98*4882a593Smuzhiyun };
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun /*
101*4882a593Smuzhiyun  * SNDRV_FIREWIRE_IOCTL_LOCK prevents the driver from streaming.
102*4882a593Smuzhiyun  * Returns -EBUSY if the driver is already streaming.
103*4882a593Smuzhiyun  */
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun #define SNDRV_FIREWIRE_TASCAM_STATE_COUNT	64
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun struct snd_firewire_tascam_state {
108*4882a593Smuzhiyun 	__be32 data[SNDRV_FIREWIRE_TASCAM_STATE_COUNT];
109*4882a593Smuzhiyun };
110*4882a593Smuzhiyun 
111*4882a593Smuzhiyun #endif /* _UAPI_SOUND_FIREWIRE_H_INCLUDED */
112