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 #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 ((__u32)((__u16)~0) - 1) 32 /* each field should be in big endian */ 33 struct snd_efw_transaction { 34 __be32 length; 35 __be32 version; 36 __be32 seqnum; 37 __be32 category; 38 __be32 command; 39 __be32 status; 40 __be32 params[0]; 41 }; 42 struct snd_firewire_event_efw_response { 43 unsigned int type; 44 __be32 response[0]; /* some responses */ 45 }; 46 47 struct snd_firewire_event_digi00x_message { 48 unsigned int type; 49 __u32 message; /* Digi00x-specific message */ 50 }; 51 52 struct snd_firewire_event_motu_notification { 53 unsigned int type; 54 __u32 message; /* MOTU-specific bits. */ 55 }; 56 57 struct snd_firewire_tascam_change { 58 unsigned int index; 59 __be32 before; 60 __be32 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 __be32 data[SNDRV_FIREWIRE_TASCAM_STATE_COUNT]; 109 }; 110 111 // In below MOTU models, software is allowed to control their DSP by accessing to registers. 112 // - 828mk2 113 // - 896hd 114 // - Traveler 115 // - 8 pre 116 // - Ultralite 117 // - 4 pre 118 // - Audio Express 119 // 120 // On the other hand, the status of DSP is split into specific messages included in the sequence of 121 // isochronous packet. ALSA firewire-motu driver gathers the messages and allow userspace applications 122 // to read it via ioctl. In 828mk2, 896hd, and Traveler, hardware meter for all of physical inputs 123 // are put into the message, while one pair of physical outputs is selected. The selection is done by 124 // LSB one byte in asynchronous write quadlet transaction to 0x'ffff'f000'0b2c. 125 // 126 // I note that V3HD/V4HD uses asynchronous transaction for the purpose. The destination address is 127 // registered to 0x'ffff'f000'0b38 and '0b3c by asynchronous write quadlet request. The size of 128 // message differs between 23 and 51 quadlets. For the case, the number of mixer bus can be extended 129 // up to 12. 130 131 #define SNDRV_FIREWIRE_MOTU_REGISTER_DSP_METER_COUNT 40 132 133 /** 134 * struct snd_firewire_motu_register_dsp_meter - the container for meter information in DSP 135 * controlled by register access 136 * @data: Signal level meters. The mapping between position and input/output channel is 137 * model-dependent. 138 * 139 * The structure expresses the part of DSP status for hardware meter. The u8 storage includes linear 140 * value for audio signal level between 0x00 and 0x7f. 141 */ 142 struct snd_firewire_motu_register_dsp_meter { 143 __u8 data[SNDRV_FIREWIRE_MOTU_REGISTER_DSP_METER_COUNT]; 144 }; 145 146 #endif /* _UAPI_SOUND_FIREWIRE_H_INCLUDED */ 147