1e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris#ifndef _UAPI_SOUND_FIREWIRE_H_INCLUDED
2e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris#define _UAPI_SOUND_FIREWIRE_H_INCLUDED
3e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris
4e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris#include <linux/ioctl.h>
5314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris#include <linux/types.h>
6e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris
7e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris/* events can be read() from the hwdep device */
8e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris
9e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris#define SNDRV_FIREWIRE_EVENT_LOCK_STATUS	0x000010cc
10e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris#define SNDRV_FIREWIRE_EVENT_DICE_NOTIFICATION	0xd1ce004e
11314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris#define SNDRV_FIREWIRE_EVENT_EFW_RESPONSE	0x4e617475
1212e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris#define SNDRV_FIREWIRE_EVENT_DIGI00X_MESSAGE	0x746e736c
13e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris
14e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferrisstruct snd_firewire_event_common {
15e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris	unsigned int type; /* SNDRV_FIREWIRE_EVENT_xxx */
16e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris};
17e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris
18e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferrisstruct snd_firewire_event_lock_status {
19e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris	unsigned int type;
20e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris	unsigned int status; /* 0/1 = unlocked/locked */
21e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris};
22e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris
23e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferrisstruct snd_firewire_event_dice_notification {
24e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris	unsigned int type;
25e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris	unsigned int notification; /* DICE-specific bits */
26e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris};
27e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris
28314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris#define SND_EFW_TRANSACTION_USER_SEQNUM_MAX	((__u32)((__u16)~0) - 1)
29314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris/* each field should be in big endian */
30314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferrisstruct snd_efw_transaction {
31314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris	__be32 length;
32314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris	__be32 version;
33314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris	__be32 seqnum;
34314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris	__be32 category;
35314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris	__be32 command;
36314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris	__be32 status;
37314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris	__be32 params[0];
38314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris};
39314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferrisstruct snd_firewire_event_efw_response {
40314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris	unsigned int type;
41314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris	__be32 response[0];	/* some responses */
42314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris};
43314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris
4412e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferrisstruct snd_firewire_event_digi00x_message {
4512e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris	unsigned int type;
4612e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris	__u32 message;	/* Digi00x-specific message */
4712e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris};
4812e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris
49e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferrisunion snd_firewire_event {
50e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris	struct snd_firewire_event_common            common;
51e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris	struct snd_firewire_event_lock_status       lock_status;
52e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris	struct snd_firewire_event_dice_notification dice_notification;
53314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris	struct snd_firewire_event_efw_response      efw_response;
5412e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris	struct snd_firewire_event_digi00x_message   digi00x_message;
55e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris};
56e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris
57e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris
58e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris#define SNDRV_FIREWIRE_IOCTL_GET_INFO _IOR('H', 0xf8, struct snd_firewire_get_info)
59e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris#define SNDRV_FIREWIRE_IOCTL_LOCK      _IO('H', 0xf9)
60e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris#define SNDRV_FIREWIRE_IOCTL_UNLOCK    _IO('H', 0xfa)
61e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris
62e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris#define SNDRV_FIREWIRE_TYPE_DICE	1
63314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris#define SNDRV_FIREWIRE_TYPE_FIREWORKS	2
64314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris#define SNDRV_FIREWIRE_TYPE_BEBOB	3
6512e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris#define SNDRV_FIREWIRE_TYPE_OXFW	4
6612e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris#define SNDRV_FIREWIRE_TYPE_DIGI00X	5
6712e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris#define SNDRV_FIREWIRE_TYPE_TASCAM	6
6812e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris/* RME, MOTU, ... */
69e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris
70e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferrisstruct snd_firewire_get_info {
71e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris	unsigned int type; /* SNDRV_FIREWIRE_TYPE_xxx */
72e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris	unsigned int card; /* same as fw_cdev_get_info.card */
73e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris	unsigned char guid[8];
74e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris	char device_name[16]; /* device node in /dev */
75e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris};
76e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris
77e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris/*
78e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris * SNDRV_FIREWIRE_IOCTL_LOCK prevents the driver from streaming.
79e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris * Returns -EBUSY if the driver is already streaming.
80e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris */
81e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris
82e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris#endif /* _UAPI_SOUND_FIREWIRE_H_INCLUDED */
83