xref: /openbmc/linux/include/uapi/sound/firewire.h (revision e2c75e76)
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 
16 struct snd_firewire_event_common {
17 	unsigned int type; /* SNDRV_FIREWIRE_EVENT_xxx */
18 };
19 
20 struct snd_firewire_event_lock_status {
21 	unsigned int type;
22 	unsigned int status; /* 0/1 = unlocked/locked */
23 };
24 
25 struct snd_firewire_event_dice_notification {
26 	unsigned int type;
27 	unsigned int notification; /* DICE-specific bits */
28 };
29 
30 #define SND_EFW_TRANSACTION_USER_SEQNUM_MAX	((__u32)((__u16)~0) - 1)
31 /* each field should be in big endian */
32 struct snd_efw_transaction {
33 	__be32 length;
34 	__be32 version;
35 	__be32 seqnum;
36 	__be32 category;
37 	__be32 command;
38 	__be32 status;
39 	__be32 params[0];
40 };
41 struct snd_firewire_event_efw_response {
42 	unsigned int type;
43 	__be32 response[0];	/* some responses */
44 };
45 
46 struct snd_firewire_event_digi00x_message {
47 	unsigned int type;
48 	__u32 message;	/* Digi00x-specific message */
49 };
50 
51 struct snd_firewire_event_motu_notification {
52 	unsigned int type;
53 	__u32 message;	/* MOTU-specific bits. */
54 };
55 
56 union snd_firewire_event {
57 	struct snd_firewire_event_common            common;
58 	struct snd_firewire_event_lock_status       lock_status;
59 	struct snd_firewire_event_dice_notification dice_notification;
60 	struct snd_firewire_event_efw_response      efw_response;
61 	struct snd_firewire_event_digi00x_message   digi00x_message;
62 	struct snd_firewire_event_motu_notification motu_notification;
63 };
64 
65 
66 #define SNDRV_FIREWIRE_IOCTL_GET_INFO _IOR('H', 0xf8, struct snd_firewire_get_info)
67 #define SNDRV_FIREWIRE_IOCTL_LOCK      _IO('H', 0xf9)
68 #define SNDRV_FIREWIRE_IOCTL_UNLOCK    _IO('H', 0xfa)
69 
70 #define SNDRV_FIREWIRE_TYPE_DICE	1
71 #define SNDRV_FIREWIRE_TYPE_FIREWORKS	2
72 #define SNDRV_FIREWIRE_TYPE_BEBOB	3
73 #define SNDRV_FIREWIRE_TYPE_OXFW	4
74 #define SNDRV_FIREWIRE_TYPE_DIGI00X	5
75 #define SNDRV_FIREWIRE_TYPE_TASCAM	6
76 #define SNDRV_FIREWIRE_TYPE_MOTU	7
77 #define SNDRV_FIREWIRE_TYPE_FIREFACE	8
78 
79 struct snd_firewire_get_info {
80 	unsigned int type; /* SNDRV_FIREWIRE_TYPE_xxx */
81 	unsigned int card; /* same as fw_cdev_get_info.card */
82 	unsigned char guid[8];
83 	char device_name[16]; /* device node in /dev */
84 };
85 
86 /*
87  * SNDRV_FIREWIRE_IOCTL_LOCK prevents the driver from streaming.
88  * Returns -EBUSY if the driver is already streaming.
89  */
90 
91 #endif /* _UAPI_SOUND_FIREWIRE_H_INCLUDED */
92