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