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