1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 #ifndef __SOUND_WAVEFRONT_H__
3 #define __SOUND_WAVEFRONT_H__
6 * Driver for Turtle Beach Wavefront cards (Maui,Tropez,Tropez+)
8 * Copyright (c) by Paul Barton-Davis <pbd@op.net>
11 #if (!defined(__GNUC__) && !defined(__GNUG__))
13 You will not be able to compile this file correctly without gcc, because
14 it is necessary to pack the "wavefront_alias" structure to a size
15 of 22 bytes, corresponding to 16-bit alignment (as would have been
16 the case on the original platform, MS-DOS). If this is not done,
17 then WavePatch-format files cannot be read/written correctly.
18 The method used to do this here ("__attribute__((packed)") is
19 completely compiler dependent.
21 All other wavefront_* types end up aligned to 32 bit values and
22 still have the same (correct) size.
26 /* However, note that as of G++ 2.7.3.2, g++ was unable to
27 correctly parse *type* __attribute__ tags. It will do the
28 right thing if we use the "packed" attribute on each struct
29 member, which has the same semantics anyway.
34 /***************************** WARNING ********************************
35 PLEASE DO NOT MODIFY THIS FILE IN ANY WAY THAT AFFECTS ITS ABILITY TO
36 BE USED WITH EITHER C *OR* C++.
37 **********************************************************************/
40 #define NUM_MIDIKEYS 128
41 #endif /* NUM_MIDIKEYS */
43 #ifndef NUM_MIDICHANNELS
44 #define NUM_MIDICHANNELS 16
45 #endif /* NUM_MIDICHANNELS */
47 /* These are very useful/important. the original wavefront interface
48 was developed on a 16 bit system, where sizeof(int) = 2
49 bytes. Defining things like this makes the code much more portable, and
50 easier to understand without having to toggle back and forth
51 between a 16-bit view of the world and a 32-bit one.
55 /* keep them for compatibility */
57 typedef unsigned short u16;
59 typedef unsigned int u32;
61 typedef unsigned char u8;
70 /* Pseudo-commands not part of the WaveFront command set.
71 These are used for various driver controls and direct
75 #define WFC_DEBUG_DRIVER 0
76 #define WFC_FX_IOCTL 1
77 #define WFC_PATCH_STATUS 2
78 #define WFC_PROGRAM_STATUS 3
79 #define WFC_SAMPLE_STATUS 4
80 #define WFC_DISABLE_INTERRUPTS 5
81 #define WFC_ENABLE_INTERRUPTS 6
82 #define WFC_INTERRUPT_STATUS 7
83 #define WFC_ROMSAMPLES_RDONLY 8
84 #define WFC_IDENTIFY_SLOT_TYPE 9
86 /* Wavefront synth commands
89 #define WFC_DOWNLOAD_SAMPLE 0x80
90 #define WFC_DOWNLOAD_BLOCK 0x81
91 #define WFC_DOWNLOAD_MULTISAMPLE 0x82
92 #define WFC_DOWNLOAD_SAMPLE_ALIAS 0x83
93 #define WFC_DELETE_SAMPLE 0x84
94 #define WFC_REPORT_FREE_MEMORY 0x85
95 #define WFC_DOWNLOAD_PATCH 0x86
96 #define WFC_DOWNLOAD_PROGRAM 0x87
97 #define WFC_SET_SYNTHVOL 0x89
98 #define WFC_SET_NVOICES 0x8B
99 #define WFC_DOWNLOAD_DRUM 0x90
100 #define WFC_GET_SYNTHVOL 0x92
101 #define WFC_GET_NVOICES 0x94
102 #define WFC_DISABLE_CHANNEL 0x9A
103 #define WFC_ENABLE_CHANNEL 0x9B
104 #define WFC_MISYNTH_OFF 0x9D
105 #define WFC_MISYNTH_ON 0x9E
106 #define WFC_FIRMWARE_VERSION 0x9F
107 #define WFC_GET_NSAMPLES 0xA0
108 #define WFC_DISABLE_DRUM_PROGRAM 0xA2
109 #define WFC_UPLOAD_PATCH 0xA3
110 #define WFC_UPLOAD_PROGRAM 0xA4
111 #define WFC_SET_TUNING 0xA6
112 #define WFC_GET_TUNING 0xA7
113 #define WFC_VMIDI_ON 0xA8
114 #define WFC_VMIDI_OFF 0xA9
115 #define WFC_MIDI_STATUS 0xAA
116 #define WFC_GET_CHANNEL_STATUS 0xAB
117 #define WFC_DOWNLOAD_SAMPLE_HEADER 0xAC
118 #define WFC_UPLOAD_SAMPLE_HEADER 0xAD
119 #define WFC_UPLOAD_MULTISAMPLE 0xAE
120 #define WFC_UPLOAD_SAMPLE_ALIAS 0xAF
121 #define WFC_IDENTIFY_SAMPLE_TYPE 0xB0
122 #define WFC_DOWNLOAD_EDRUM_PROGRAM 0xB1
123 #define WFC_UPLOAD_EDRUM_PROGRAM 0xB2
124 #define WFC_SET_EDRUM_CHANNEL 0xB3
125 #define WFC_INSTOUT_LEVELS 0xB4
126 #define WFC_PEAKOUT_LEVELS 0xB5
127 #define WFC_REPORT_CHANNEL_PROGRAMS 0xB6
128 #define WFC_HARDWARE_VERSION 0xCF
129 #define WFC_UPLOAD_SAMPLE_PARAMS 0xD7
130 #define WFC_DOWNLOAD_OS 0xF1
131 #define WFC_NOOP 0xFF
133 #define WF_MAX_SAMPLE 512
134 #define WF_MAX_PATCH 256
135 #define WF_MAX_PROGRAM 128
137 #define WF_SECTION_MAX 44 /* longest OS section length */
139 /* # of bytes we send to the board when sending it various kinds of
140 substantive data, such as samples, patches and programs.
143 #define WF_PROGRAM_BYTES 32
144 #define WF_PATCH_BYTES 132
145 #define WF_SAMPLE_BYTES 27
146 #define WF_SAMPLE_HDR_BYTES 25
147 #define WF_ALIAS_BYTES 25
148 #define WF_DRUM_BYTES 9
149 #define WF_MSAMPLE_BYTES 259 /* (MIDI_KEYS * 2) + 3 */
152 #define WF_DMA_ACK 0x81
154 /* OR-values for MIDI status bits */
156 #define WF_MIDI_VIRTUAL_ENABLED 0x1
157 #define WF_MIDI_VIRTUAL_IS_EXTERNAL 0x2
158 #define WF_MIDI_IN_TO_SYNTH_DISABLED 0x4
160 /* slot indexes for struct address_info: makes code a little more mnemonic */
162 #define WF_SYNTH_SLOT 0
163 #define WF_INTERNAL_MIDI_SLOT 1
164 #define WF_EXTERNAL_MIDI_SLOT 2
166 /* Magic MIDI bytes used to switch I/O streams on the ICS2115 MPU401
167 emulation. Note these NEVER show up in output from the device and
168 should NEVER be used in input unless Virtual MIDI mode has been
169 disabled. If they do show up as input, the results are unpredictable.
172 #define WF_EXTERNAL_SWITCH 0xFD
173 #define WF_INTERNAL_SWITCH 0xF9
175 /* Debugging flags */
177 #define WF_DEBUG_CMD 0x1
178 #define WF_DEBUG_DATA 0x2
179 #define WF_DEBUG_LOAD_PATCH 0x4
180 #define WF_DEBUG_IO 0x8
182 /* WavePatch file format stuff */
184 #define WF_WAVEPATCH_VERSION 120; /* Current version number (1.2) */
185 #define WF_MAX_COMMENT 64 /* Comment length */
186 #define WF_NUM_LAYERS 4
187 #define WF_NAME_LENGTH 32
188 #define WF_SOURCE_LENGTH 260
190 #define BankFileID "Bank"
191 #define DrumkitFileID "DrumKit"
192 #define ProgramFileID "Program"
220 u8 attack_velocity:7;
223 u8 volume_velocity:7;
226 u8 keyboard_scaling:7;
229 typedef struct wf_envelope wavefront_envelope;
247 u8 wave_restart:1; /* for LFO2 only */
252 typedef struct wf_lfo wavefront_lfo;
256 s16 frequency_bias; /* ** THIS IS IN MOTOROLA FORMAT!! ** */
274 u8 filterconfig:2; /* SDK says "not used" */
293 s8 fc1_keyboard_scaling;
296 s8 fc2_keyboard_scaling;
302 struct wf_envelope envelope1;
303 struct wf_envelope envelope2;
307 typedef struct wf_patch wavefront_patch;
324 typedef struct wf_layer wavefront_layer;
328 struct wf_layer layer[WF_NUM_LAYERS];
330 typedef struct wf_program wavefront_program;
332 struct wf_sample_offset
338 typedef struct wf_sample_offset wavefront_sample_offset;
340 /* Sample slot types */
342 #define WF_ST_SAMPLE 0
343 #define WF_ST_MULTISAMPLE 1
344 #define WF_ST_ALIAS 2
345 #define WF_ST_EMPTY 3
350 #define WF_ST_PROGRAM 5
351 #define WF_ST_PATCH 6
352 #define WF_ST_SAMPLEHDR 7
354 #define WF_ST_MASK 0xf
356 /* Flags for slot status. These occupy the upper bits of the same byte
360 #define WF_SLOT_USED 0x80 /* XXX don't rely on this being accurate */
361 #define WF_SLOT_FILLED 0x40
362 #define WF_SLOT_ROM 0x20
364 #define WF_SLOT_MASK 0xf0
366 /* channel constants */
370 #define WF_CH_RIGHT 2
374 #define LINEAR_16BIT 0
375 #define WHITE_NOISE 1
376 #define LINEAR_8BIT 2
379 #define WF_SAMPLE_IS_8BIT(smpl) ((smpl)->SampleResolution&2)
384 Because most/all of the sample data we pass in via pointers has
385 never been copied (just mmap-ed into user space straight from the
386 disk), it would be nice to allow handling of multi-channel sample
387 data without forcing user-level extraction of the relevant bytes.
389 So, we need a way of specifying which channel to use (the WaveFront
390 only handles mono samples in a given slot), and the only way to do
391 this without using some struct other than wavefront_sample as the
392 interface is the awful hack of using the unused bits in a
397 0 no channel selection (use channel 1, sample is MONO)
398 1 use first channel, and skip one
399 2 use second channel, and skip one
400 3 use third channel, and skip two
401 4 use fourth channel, skip three
402 5 use fifth channel, skip four
403 6 use six channel, skip five
406 This can handle up to 4 channels, and anyone downloading >4 channels
407 of sample data just to select one of them needs to find some tools
410 NOTE: values 0, 1 and 2 correspond to WF_CH_* above. This is
415 #define WF_SET_CHANNEL(samp,chn) \
416 (samp)->Unused1 = chn & 0x1; \
417 (samp)->Unused2 = chn & 0x2; \
418 (samp)->Unused3 = chn & 0x4
420 #define WF_GET_CHANNEL(samp) \
421 (((samp)->Unused3 << 2)|((samp)->Unused2<<1)|(samp)->Unused1)
423 typedef struct wf_sample {
424 struct wf_sample_offset sampleStartOffset;
425 struct wf_sample_offset loopStartOffset;
426 struct wf_sample_offset loopEndOffset;
427 struct wf_sample_offset sampleEndOffset;
429 u8 SampleResolution:2; /* sample_format */
438 typedef struct wf_multisample {
439 s16 NumberOfSamples; /* log2 of the number of samples */
440 s16 SampleNumber[NUM_MIDIKEYS];
441 } wavefront_multisample;
443 typedef struct wf_alias {
446 struct wf_sample_offset sampleStartOffset;
447 struct wf_sample_offset loopStartOffset;
448 struct wf_sample_offset sampleEndOffset;
449 struct wf_sample_offset loopEndOffset;
453 u8 SampleResolution:2;
461 /* This structure is meant to be padded only to 16 bits on their
462 original. Of course, whoever wrote their documentation didn't
463 realize that sizeof(struct) can be >=
464 sum(sizeof(struct-fields)) and so thought that giving a C level
465 description of the structs used in WavePatch files was
466 sufficient. I suppose it was, as long as you remember the
467 standard 16->32 bit issues.
470 u8 sixteen_bit_padding;
471 } __attribute__((packed)) wavefront_alias;
473 typedef struct wf_drum {
485 typedef struct wf_drumkit {
486 struct wf_drum drum[NUM_MIDIKEYS];
489 typedef struct wf_channel_programs {
490 u8 Program[NUM_MIDICHANNELS];
491 } wavefront_channel_programs;
493 /* How to get MIDI channel status from the data returned by
494 a WFC_GET_CHANNEL_STATUS command (a struct wf_channel_programs)
497 #define WF_CHANNEL_STATUS(ch,wcp) (wcp)[(ch/7)] & (1<<((ch)%7))
499 typedef union wf_any {
501 wavefront_multisample ms;
503 wavefront_program pr;
508 /* Hannu Solvainen hoped that his "patch_info" struct in soundcard.h
509 might work for other wave-table based patch loading situations.
510 Alas, his fears were correct. The WaveFront doesn't even come with
511 just "patches", but several different kind of structures that
512 control the sound generation process.
515 typedef struct wf_patch_info {
517 /* the first two fields are used by the OSS "patch loading" interface
518 only, and are unused by the current user-level library.
521 s16 key; /* Use WAVEFRONT_PATCH here */
522 u16 devno; /* fill in when sending */
523 u8 subkey; /* WF_ST_{SAMPLE,ALIAS,etc.} */
525 #define WAVEFRONT_FIND_FREE_SAMPLE_SLOT 999
527 u16 number; /* patch/sample/prog number */
529 u32 size; /* size of any data included in
530 one of the fields in `hdrptr', or
533 NOTE: for actual samples, this is
534 the size of the *SELECTED CHANNEL*
535 even if more data is actually available.
537 So, a stereo sample (2 channels) of
538 6000 bytes total has `size' = 3000.
540 See the macros and comments for
541 WF_{GET,SET}_CHANNEL above.
544 wavefront_any __user *hdrptr; /* user-space ptr to hdr bytes */
545 u16 __user *dataptr; /* actual sample data */
547 wavefront_any hdr; /* kernel-space copy of hdr bytes */
548 } wavefront_patch_info;
550 /* The maximum number of bytes we will ever move to or from user space
551 in response to a WFC_* command. This obviously doesn't cover
555 #define WF_MAX_READ sizeof(wavefront_multisample)
556 #define WF_MAX_WRITE sizeof(wavefront_multisample)
559 This allows us to execute any WF command except the download/upload
560 ones, which are handled differently due to copyin/copyout issues as
561 well as data-nybbling to/from the card.
564 typedef struct wavefront_control {
566 char status; /* return status to user-space */
567 unsigned char rbuf[WF_MAX_READ]; /* bytes read from card */
568 unsigned char wbuf[WF_MAX_WRITE]; /* bytes written to card */
571 #define WFCTL_WFCMD 0x1
572 #define WFCTL_LOAD_SPP 0x2
574 /* Modulator table */
576 #define WF_MOD_LFO1 0
577 #define WF_MOD_LFO2 1
578 #define WF_MOD_ENV1 2
579 #define WF_MOD_ENV2 3
580 #define WF_MOD_KEYBOARD 4
581 #define WF_MOD_LOGKEY 5
582 #define WF_MOD_VELOCITY 6
583 #define WF_MOD_LOGVEL 7
584 #define WF_MOD_RANDOM 8
585 #define WF_MOD_PRESSURE 9
586 #define WF_MOD_MOD_WHEEL 10
587 #define WF_MOD_1 WF_MOD_MOD_WHEEL
588 #define WF_MOD_BREATH 11
589 #define WF_MOD_2 WF_MOD_BREATH
590 #define WF_MOD_FOOT 12
591 #define WF_MOD_4 WF_MOD_FOOT
592 #define WF_MOD_VOLUME 13
593 #define WF_MOD_7 WF_MOD_VOLUME
594 #define WF_MOD_PAN 14
595 #define WF_MOD_10 WF_MOD_PAN
596 #define WF_MOD_EXPR 15
597 #define WF_MOD_11 WF_MOD_EXPR
599 /* FX-related material */
601 typedef struct wf_fx_info {
602 int request; /* see list below */
603 long data[4]; /* we don't need much */
606 /* support for each of these will be forthcoming once I or someone
607 else has figured out which of the addresses on page 6 and page 7 of
608 the YSS225 control each parameter. Incidentally, these come from
609 the Windows driver interface, but again, Turtle Beach didn't
610 document the API to use them.
613 #define WFFX_SETOUTGAIN 0
614 #define WFFX_SETSTEREOOUTGAIN 1
615 #define WFFX_SETREVERBIN1GAIN 2
616 #define WFFX_SETREVERBIN2GAIN 3
617 #define WFFX_SETREVERBIN3GAIN 4
618 #define WFFX_SETCHORUSINPORT 5
619 #define WFFX_SETREVERBIN1PORT 6
620 #define WFFX_SETREVERBIN2PORT 7
621 #define WFFX_SETREVERBIN3PORT 8
622 #define WFFX_SETEFFECTPORT 9
623 #define WFFX_SETAUXPORT 10
624 #define WFFX_SETREVERBTYPE 11
625 #define WFFX_SETREVERBDELAY 12
626 #define WFFX_SETCHORUSLFO 13
627 #define WFFX_SETCHORUSPMD 14
628 #define WFFX_SETCHORUSAMD 15
629 #define WFFX_SETEFFECT 16
630 #define WFFX_SETBASEALL 17
631 #define WFFX_SETREVERBALL 18
632 #define WFFX_SETCHORUSALL 20
633 #define WFFX_SETREVERBDEF 22
634 #define WFFX_SETCHORUSDEF 23
635 #define WFFX_DELAYSETINGAIN 24
636 #define WFFX_DELAYSETFBGAIN 25
637 #define WFFX_DELAYSETFBLPF 26
638 #define WFFX_DELAYSETGAIN 27
639 #define WFFX_DELAYSETTIME 28
640 #define WFFX_DELAYSETFBTIME 29
641 #define WFFX_DELAYSETALL 30
642 #define WFFX_DELAYSETDEF 32
643 #define WFFX_SDELAYSETINGAIN 33
644 #define WFFX_SDELAYSETFBGAIN 34
645 #define WFFX_SDELAYSETFBLPF 35
646 #define WFFX_SDELAYSETGAIN 36
647 #define WFFX_SDELAYSETTIME 37
648 #define WFFX_SDELAYSETFBTIME 38
649 #define WFFX_SDELAYSETALL 39
650 #define WFFX_SDELAYSETDEF 41
651 #define WFFX_DEQSETINGAIN 42
652 #define WFFX_DEQSETFILTER 43
653 #define WFFX_DEQSETALL 44
654 #define WFFX_DEQSETDEF 46
656 #define WFFX_FLANGESETBALANCE 48
657 #define WFFX_FLANGESETDELAY 49
658 #define WFFX_FLANGESETDWFFX_TH 50
659 #define WFFX_FLANGESETFBGAIN 51
660 #define WFFX_FLANGESETINGAIN 52
661 #define WFFX_FLANGESETLFO 53
662 #define WFFX_FLANGESETALL 54
663 #define WFFX_FLANGESETDEF 56
664 #define WFFX_PITCHSETSHIFT 57
665 #define WFFX_PITCHSETBALANCE 58
666 #define WFFX_PITCHSETALL 59
667 #define WFFX_PITCHSETDEF 61
668 #define WFFX_SRSSETINGAIN 62
669 #define WFFX_SRSSETSPACE 63
670 #define WFFX_SRSSETCENTER 64
671 #define WFFX_SRSSETGAIN 65
672 #define WFFX_SRSSETMODE 66
673 #define WFFX_SRSSETDEF 68
675 /* Allow direct user-space control over FX memory/coefficient data.
676 In theory this could be used to download the FX microprogram,
677 but it would be a little slower, and involve some weird code.
680 #define WFFX_MEMSET 69
682 #endif /* __SOUND_WAVEFRONT_H__ */