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 <sys/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	((uint32_t)((uint16_t)~0) - 1)
32 /* each field should be in big endian */
33 struct snd_efw_transaction {
34 	uint32_t length;
35 	uint32_t version;
36 	uint32_t seqnum;
37 	uint32_t category;
38 	uint32_t command;
39 	uint32_t status;
40 	uint32_t params[0];
41 };
42 struct snd_firewire_event_efw_response {
43 	unsigned int type;
44 	uint32_t response[0];	/* some responses */
45 };
46 
47 struct snd_firewire_event_digi00x_message {
48 	unsigned int type;
49 	uint32_t message;	/* Digi00x-specific message */
50 };
51 
52 struct snd_firewire_event_motu_notification {
53 	unsigned int type;
54 	uint32_t message;	/* MOTU-specific bits. */
55 };
56 
57 struct snd_firewire_tascam_change {
58 	unsigned int index;
59 	uint32_t before;
60 	uint32_t 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 
84 #define SNDRV_FIREWIRE_TYPE_DICE	1
85 #define SNDRV_FIREWIRE_TYPE_FIREWORKS	2
86 #define SNDRV_FIREWIRE_TYPE_BEBOB	3
87 #define SNDRV_FIREWIRE_TYPE_OXFW	4
88 #define SNDRV_FIREWIRE_TYPE_DIGI00X	5
89 #define SNDRV_FIREWIRE_TYPE_TASCAM	6
90 #define SNDRV_FIREWIRE_TYPE_MOTU	7
91 #define SNDRV_FIREWIRE_TYPE_FIREFACE	8
92 
93 struct snd_firewire_get_info {
94 	unsigned int type; /* SNDRV_FIREWIRE_TYPE_xxx */
95 	unsigned int card; /* same as fw_cdev_get_info.card */
96 	unsigned char guid[8];
97 	char device_name[16]; /* device node in /dev */
98 };
99 
100 /*
101  * SNDRV_FIREWIRE_IOCTL_LOCK prevents the driver from streaming.
102  * Returns -EBUSY if the driver is already streaming.
103  */
104 
105 #define SNDRV_FIREWIRE_TASCAM_STATE_COUNT	64
106 
107 struct snd_firewire_tascam_state {
108 	uint32_t data[SNDRV_FIREWIRE_TASCAM_STATE_COUNT];
109 };
110 
111 #endif /* _UAPI_SOUND_FIREWIRE_H_INCLUDED */
112