2 * Copyright (c) by Uros Bizjak <uros@kss-loka.si>
4 * Routines for OPL2/OPL3/OPL4 control
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <sound/opl3.h>
23 #include <sound/asound_fm.h>
25 #if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
26 #define OPL3_SUPPORT_SYNTH
30 * There is 18 possible 2 OP voices
31 * (9 in the left and 9 in the right).
32 * The first OP is the modulator and 2nd is the carrier.
34 * The first three voices in the both sides may be connected
35 * with another voice to a 4 OP voice. For example voice 0
36 * can be connected with voice 3. The operators of voice 3 are
37 * used as operators 3 and 4 of the new 4 OP voice.
38 * In this case the 2 OP voice number 0 is the 'first half' and
39 * voice 3 is the second.
44 * Register offset table for OPL2/3 voices,
45 * OPL2 / one OPL3 register array side only
48 char snd_opl3_regmap
[MAX_OPL2_VOICES
][4] =
51 /* ------------------------ */
52 { 0x00, 0x03, 0x08, 0x0b },
53 { 0x01, 0x04, 0x09, 0x0c },
54 { 0x02, 0x05, 0x0a, 0x0d },
56 { 0x08, 0x0b, 0x00, 0x00 },
57 { 0x09, 0x0c, 0x00, 0x00 },
58 { 0x0a, 0x0d, 0x00, 0x00 },
60 { 0x10, 0x13, 0x00, 0x00 }, /* used by percussive voices */
61 { 0x11, 0x14, 0x00, 0x00 }, /* if the percussive mode */
62 { 0x12, 0x15, 0x00, 0x00 } /* is selected (only left reg block) */
65 EXPORT_SYMBOL(snd_opl3_regmap
);
70 static int snd_opl3_play_note(struct snd_opl3
* opl3
, struct snd_dm_fm_note
* note
);
71 static int snd_opl3_set_voice(struct snd_opl3
* opl3
, struct snd_dm_fm_voice
* voice
);
72 static int snd_opl3_set_params(struct snd_opl3
* opl3
, struct snd_dm_fm_params
* params
);
73 static int snd_opl3_set_mode(struct snd_opl3
* opl3
, int mode
);
74 static int snd_opl3_set_connection(struct snd_opl3
* opl3
, int connection
);
76 /* ------------------------------ */
79 * open the device exclusively
81 int snd_opl3_open(struct snd_hwdep
* hw
, struct file
*file
)
87 * ioctl for hwdep device:
89 int snd_opl3_ioctl(struct snd_hwdep
* hw
, struct file
*file
,
90 unsigned int cmd
, unsigned long arg
)
92 struct snd_opl3
*opl3
= hw
->private_data
;
93 void __user
*argp
= (void __user
*)arg
;
95 if (snd_BUG_ON(!opl3
))
100 case SNDRV_DM_FM_IOCTL_INFO
:
102 struct snd_dm_fm_info info
;
104 info
.fm_mode
= opl3
->fm_mode
;
105 info
.rhythm
= opl3
->rhythm
;
106 if (copy_to_user(argp
, &info
, sizeof(struct snd_dm_fm_info
)))
111 case SNDRV_DM_FM_IOCTL_RESET
:
112 #ifdef CONFIG_SND_OSSEMUL
113 case SNDRV_DM_FM_OSS_IOCTL_RESET
:
115 snd_opl3_reset(opl3
);
118 case SNDRV_DM_FM_IOCTL_PLAY_NOTE
:
119 #ifdef CONFIG_SND_OSSEMUL
120 case SNDRV_DM_FM_OSS_IOCTL_PLAY_NOTE
:
123 struct snd_dm_fm_note note
;
124 if (copy_from_user(¬e
, argp
, sizeof(struct snd_dm_fm_note
)))
126 return snd_opl3_play_note(opl3
, ¬e
);
129 case SNDRV_DM_FM_IOCTL_SET_VOICE
:
130 #ifdef CONFIG_SND_OSSEMUL
131 case SNDRV_DM_FM_OSS_IOCTL_SET_VOICE
:
134 struct snd_dm_fm_voice voice
;
135 if (copy_from_user(&voice
, argp
, sizeof(struct snd_dm_fm_voice
)))
137 return snd_opl3_set_voice(opl3
, &voice
);
140 case SNDRV_DM_FM_IOCTL_SET_PARAMS
:
141 #ifdef CONFIG_SND_OSSEMUL
142 case SNDRV_DM_FM_OSS_IOCTL_SET_PARAMS
:
145 struct snd_dm_fm_params params
;
146 if (copy_from_user(¶ms
, argp
, sizeof(struct snd_dm_fm_params
)))
148 return snd_opl3_set_params(opl3
, ¶ms
);
151 case SNDRV_DM_FM_IOCTL_SET_MODE
:
152 #ifdef CONFIG_SND_OSSEMUL
153 case SNDRV_DM_FM_OSS_IOCTL_SET_MODE
:
155 return snd_opl3_set_mode(opl3
, (int) arg
);
157 case SNDRV_DM_FM_IOCTL_SET_CONNECTION
:
158 #ifdef CONFIG_SND_OSSEMUL
159 case SNDRV_DM_FM_OSS_IOCTL_SET_OPL
:
161 return snd_opl3_set_connection(opl3
, (int) arg
);
163 #ifdef OPL3_SUPPORT_SYNTH
164 case SNDRV_DM_FM_IOCTL_CLEAR_PATCHES
:
165 snd_opl3_clear_patches(opl3
);
169 #ifdef CONFIG_SND_DEBUG
171 snd_printk(KERN_WARNING
"unknown IOCTL: 0x%x\n", cmd
);
180 int snd_opl3_release(struct snd_hwdep
* hw
, struct file
*file
)
182 struct snd_opl3
*opl3
= hw
->private_data
;
184 snd_opl3_reset(opl3
);
188 #ifdef OPL3_SUPPORT_SYNTH
190 * write the device - load patches
192 long snd_opl3_write(struct snd_hwdep
*hw
, const char __user
*buf
, long count
,
195 struct snd_opl3
*opl3
= hw
->private_data
;
198 struct sbi_patch inst
;
200 while (count
>= sizeof(inst
)) {
202 if (copy_from_user(&inst
, buf
, sizeof(inst
)))
204 if (!memcmp(inst
.key
, FM_KEY_SBI
, 4) ||
205 !memcmp(inst
.key
, FM_KEY_2OP
, 4))
206 type
= FM_PATCH_OPL2
;
207 else if (!memcmp(inst
.key
, FM_KEY_4OP
, 4))
208 type
= FM_PATCH_OPL3
;
209 else /* invalid type */
211 err
= snd_opl3_load_patch(opl3
, inst
.prog
, inst
.bank
, type
,
212 inst
.name
, inst
.extension
,
216 result
+= sizeof(inst
);
217 count
-= sizeof(inst
);
219 return result
> 0 ? result
: err
;
227 /* offsets for SBI params */
230 #define ATTACK_DECAY 4
231 #define SUSTAIN_RELEASE 6
232 #define WAVE_SELECT 8
234 /* offset for SBI instrument */
235 #define CONNECTION 10
236 #define OFFSET_4OP 11
239 * load a patch, obviously.
241 * loaded on the given program and bank numbers with the given type
243 * data is the pointer of SBI record _without_ header (key and name).
244 * name is the name string of the patch.
245 * ext is the extension data of 7 bytes long (stored in name of SBI
246 * data up to offset 25), or NULL to skip.
247 * return 0 if successful or a negative error code.
249 int snd_opl3_load_patch(struct snd_opl3
*opl3
,
250 int prog
, int bank
, int type
,
252 const unsigned char *ext
,
253 const unsigned char *data
)
255 struct fm_patch
*patch
;
258 patch
= snd_opl3_find_patch(opl3
, prog
, bank
, 1);
264 for (i
= 0; i
< 2; i
++) {
265 patch
->inst
.op
[i
].am_vib
= data
[AM_VIB
+ i
];
266 patch
->inst
.op
[i
].ksl_level
= data
[KSL_LEVEL
+ i
];
267 patch
->inst
.op
[i
].attack_decay
= data
[ATTACK_DECAY
+ i
];
268 patch
->inst
.op
[i
].sustain_release
= data
[SUSTAIN_RELEASE
+ i
];
269 patch
->inst
.op
[i
].wave_select
= data
[WAVE_SELECT
+ i
];
271 patch
->inst
.feedback_connection
[0] = data
[CONNECTION
];
273 if (type
== FM_PATCH_OPL3
) {
274 for (i
= 0; i
< 2; i
++) {
275 patch
->inst
.op
[i
+2].am_vib
=
276 data
[OFFSET_4OP
+ AM_VIB
+ i
];
277 patch
->inst
.op
[i
+2].ksl_level
=
278 data
[OFFSET_4OP
+ KSL_LEVEL
+ i
];
279 patch
->inst
.op
[i
+2].attack_decay
=
280 data
[OFFSET_4OP
+ ATTACK_DECAY
+ i
];
281 patch
->inst
.op
[i
+2].sustain_release
=
282 data
[OFFSET_4OP
+ SUSTAIN_RELEASE
+ i
];
283 patch
->inst
.op
[i
+2].wave_select
=
284 data
[OFFSET_4OP
+ WAVE_SELECT
+ i
];
286 patch
->inst
.feedback_connection
[1] =
287 data
[OFFSET_4OP
+ CONNECTION
];
291 patch
->inst
.echo_delay
= ext
[0];
292 patch
->inst
.echo_atten
= ext
[1];
293 patch
->inst
.chorus_spread
= ext
[2];
294 patch
->inst
.trnsps
= ext
[3];
295 patch
->inst
.fix_dur
= ext
[4];
296 patch
->inst
.modes
= ext
[5];
297 patch
->inst
.fix_key
= ext
[6];
301 strlcpy(patch
->name
, name
, sizeof(patch
->name
));
305 EXPORT_SYMBOL(snd_opl3_load_patch
);
308 * find a patch with the given program and bank numbers, returns its pointer
309 * if no matching patch is found and create_patch is set, it creates a
312 struct fm_patch
*snd_opl3_find_patch(struct snd_opl3
*opl3
, int prog
, int bank
,
315 /* pretty dumb hash key */
316 unsigned int key
= (prog
+ bank
) % OPL3_PATCH_HASH_SIZE
;
317 struct fm_patch
*patch
;
319 for (patch
= opl3
->patch_table
[key
]; patch
; patch
= patch
->next
) {
320 if (patch
->prog
== prog
&& patch
->bank
== bank
)
326 patch
= kzalloc(sizeof(*patch
), GFP_KERNEL
);
331 patch
->next
= opl3
->patch_table
[key
];
332 opl3
->patch_table
[key
] = patch
;
335 EXPORT_SYMBOL(snd_opl3_find_patch
);
338 * Clear all patches of the given OPL3 instance
340 void snd_opl3_clear_patches(struct snd_opl3
*opl3
)
343 for (i
= 0; i
< OPL3_PATCH_HASH_SIZE
; i
++) {
344 struct fm_patch
*patch
, *next
;
345 for (patch
= opl3
->patch_table
[i
]; patch
; patch
= next
) {
350 memset(opl3
->patch_table
, 0, sizeof(opl3
->patch_table
));
352 #endif /* OPL3_SUPPORT_SYNTH */
354 /* ------------------------------ */
356 void snd_opl3_reset(struct snd_opl3
* opl3
)
358 unsigned short opl3_reg
;
360 unsigned short reg_side
;
361 unsigned char voice_offset
;
365 max_voices
= (opl3
->hardware
< OPL3_HW_OPL3
) ?
366 MAX_OPL2_VOICES
: MAX_OPL3_VOICES
;
368 for (i
= 0; i
< max_voices
; i
++) {
369 /* Get register array side and offset of voice */
370 if (i
< MAX_OPL2_VOICES
) {
371 /* Left register block for voices 0 .. 8 */
372 reg_side
= OPL3_LEFT
;
375 /* Right register block for voices 9 .. 17 */
376 reg_side
= OPL3_RIGHT
;
377 voice_offset
= i
- MAX_OPL2_VOICES
;
379 opl3_reg
= reg_side
| (OPL3_REG_KSL_LEVEL
+ snd_opl3_regmap
[voice_offset
][0]);
380 opl3
->command(opl3
, opl3_reg
, OPL3_TOTAL_LEVEL_MASK
); /* Operator 1 volume */
381 opl3_reg
= reg_side
| (OPL3_REG_KSL_LEVEL
+ snd_opl3_regmap
[voice_offset
][1]);
382 opl3
->command(opl3
, opl3_reg
, OPL3_TOTAL_LEVEL_MASK
); /* Operator 2 volume */
384 opl3_reg
= reg_side
| (OPL3_REG_KEYON_BLOCK
+ voice_offset
);
385 opl3
->command(opl3
, opl3_reg
, 0x00); /* Note off */
388 opl3
->max_voices
= MAX_OPL2_VOICES
;
389 opl3
->fm_mode
= SNDRV_DM_FM_MODE_OPL2
;
391 opl3
->command(opl3
, OPL3_LEFT
| OPL3_REG_TEST
, OPL3_ENABLE_WAVE_SELECT
);
392 opl3
->command(opl3
, OPL3_LEFT
| OPL3_REG_PERCUSSION
, 0x00); /* Melodic mode */
396 EXPORT_SYMBOL(snd_opl3_reset
);
398 static int snd_opl3_play_note(struct snd_opl3
* opl3
, struct snd_dm_fm_note
* note
)
400 unsigned short reg_side
;
401 unsigned char voice_offset
;
403 unsigned short opl3_reg
;
404 unsigned char reg_val
;
406 /* Voices 0 - 8 in OPL2 mode */
407 /* Voices 0 - 17 in OPL3 mode */
408 if (note
->voice
>= ((opl3
->fm_mode
== SNDRV_DM_FM_MODE_OPL3
) ?
409 MAX_OPL3_VOICES
: MAX_OPL2_VOICES
))
412 /* Get register array side and offset of voice */
413 if (note
->voice
< MAX_OPL2_VOICES
) {
414 /* Left register block for voices 0 .. 8 */
415 reg_side
= OPL3_LEFT
;
416 voice_offset
= note
->voice
;
418 /* Right register block for voices 9 .. 17 */
419 reg_side
= OPL3_RIGHT
;
420 voice_offset
= note
->voice
- MAX_OPL2_VOICES
;
423 /* Set lower 8 bits of note frequency */
424 reg_val
= (unsigned char) note
->fnum
;
425 opl3_reg
= reg_side
| (OPL3_REG_FNUM_LOW
+ voice_offset
);
426 opl3
->command(opl3
, opl3_reg
, reg_val
);
429 /* Set output sound flag */
431 reg_val
|= OPL3_KEYON_BIT
;
433 reg_val
|= (note
->octave
<< 2) & OPL3_BLOCKNUM_MASK
;
434 /* Set higher 2 bits of note frequency */
435 reg_val
|= (unsigned char) (note
->fnum
>> 8) & OPL3_FNUM_HIGH_MASK
;
437 /* Set OPL3 KEYON_BLOCK register of requested voice */
438 opl3_reg
= reg_side
| (OPL3_REG_KEYON_BLOCK
+ voice_offset
);
439 opl3
->command(opl3
, opl3_reg
, reg_val
);
445 static int snd_opl3_set_voice(struct snd_opl3
* opl3
, struct snd_dm_fm_voice
* voice
)
447 unsigned short reg_side
;
448 unsigned char op_offset
;
449 unsigned char voice_offset
;
451 unsigned short opl3_reg
;
452 unsigned char reg_val
;
454 /* Only operators 1 and 2 */
457 /* Voices 0 - 8 in OPL2 mode */
458 /* Voices 0 - 17 in OPL3 mode */
459 if (voice
->voice
>= ((opl3
->fm_mode
== SNDRV_DM_FM_MODE_OPL3
) ?
460 MAX_OPL3_VOICES
: MAX_OPL2_VOICES
))
463 /* Get register array side and offset of voice */
464 if (voice
->voice
< MAX_OPL2_VOICES
) {
465 /* Left register block for voices 0 .. 8 */
466 reg_side
= OPL3_LEFT
;
467 voice_offset
= voice
->voice
;
469 /* Right register block for voices 9 .. 17 */
470 reg_side
= OPL3_RIGHT
;
471 voice_offset
= voice
->voice
- MAX_OPL2_VOICES
;
473 /* Get register offset of operator */
474 op_offset
= snd_opl3_regmap
[voice_offset
][voice
->op
];
477 /* Set amplitude modulation (tremolo) effect */
479 reg_val
|= OPL3_TREMOLO_ON
;
480 /* Set vibrato effect */
482 reg_val
|= OPL3_VIBRATO_ON
;
483 /* Set sustaining sound phase */
484 if (voice
->do_sustain
)
485 reg_val
|= OPL3_SUSTAIN_ON
;
486 /* Set keyboard scaling bit */
487 if (voice
->kbd_scale
)
489 /* Set harmonic or frequency multiplier */
490 reg_val
|= voice
->harmonic
& OPL3_MULTIPLE_MASK
;
492 /* Set OPL3 AM_VIB register of requested voice/operator */
493 opl3_reg
= reg_side
| (OPL3_REG_AM_VIB
+ op_offset
);
494 opl3
->command(opl3
, opl3_reg
, reg_val
);
496 /* Set decreasing volume of higher notes */
497 reg_val
= (voice
->scale_level
<< 6) & OPL3_KSL_MASK
;
498 /* Set output volume */
499 reg_val
|= ~voice
->volume
& OPL3_TOTAL_LEVEL_MASK
;
501 /* Set OPL3 KSL_LEVEL register of requested voice/operator */
502 opl3_reg
= reg_side
| (OPL3_REG_KSL_LEVEL
+ op_offset
);
503 opl3
->command(opl3
, opl3_reg
, reg_val
);
505 /* Set attack phase level */
506 reg_val
= (voice
->attack
<< 4) & OPL3_ATTACK_MASK
;
507 /* Set decay phase level */
508 reg_val
|= voice
->decay
& OPL3_DECAY_MASK
;
510 /* Set OPL3 ATTACK_DECAY register of requested voice/operator */
511 opl3_reg
= reg_side
| (OPL3_REG_ATTACK_DECAY
+ op_offset
);
512 opl3
->command(opl3
, opl3_reg
, reg_val
);
514 /* Set sustain phase level */
515 reg_val
= (voice
->sustain
<< 4) & OPL3_SUSTAIN_MASK
;
516 /* Set release phase level */
517 reg_val
|= voice
->release
& OPL3_RELEASE_MASK
;
519 /* Set OPL3 SUSTAIN_RELEASE register of requested voice/operator */
520 opl3_reg
= reg_side
| (OPL3_REG_SUSTAIN_RELEASE
+ op_offset
);
521 opl3
->command(opl3
, opl3_reg
, reg_val
);
523 /* Set inter-operator feedback */
524 reg_val
= (voice
->feedback
<< 1) & OPL3_FEEDBACK_MASK
;
525 /* Set inter-operator connection */
526 if (voice
->connection
)
527 reg_val
|= OPL3_CONNECTION_BIT
;
529 if (opl3
->fm_mode
== SNDRV_DM_FM_MODE_OPL3
) {
531 reg_val
|= OPL3_VOICE_TO_LEFT
;
533 reg_val
|= OPL3_VOICE_TO_RIGHT
;
535 /* Feedback/connection bits are applicable to voice */
536 opl3_reg
= reg_side
| (OPL3_REG_FEEDBACK_CONNECTION
+ voice_offset
);
537 opl3
->command(opl3
, opl3_reg
, reg_val
);
539 /* Select waveform */
540 reg_val
= voice
->waveform
& OPL3_WAVE_SELECT_MASK
;
541 opl3_reg
= reg_side
| (OPL3_REG_WAVE_SELECT
+ op_offset
);
542 opl3
->command(opl3
, opl3_reg
, reg_val
);
547 static int snd_opl3_set_params(struct snd_opl3
* opl3
, struct snd_dm_fm_params
* params
)
549 unsigned char reg_val
;
552 /* Set keyboard split method */
553 if (params
->kbd_split
)
554 reg_val
|= OPL3_KEYBOARD_SPLIT
;
555 opl3
->command(opl3
, OPL3_LEFT
| OPL3_REG_KBD_SPLIT
, reg_val
);
558 /* Set amplitude modulation (tremolo) depth */
559 if (params
->am_depth
)
560 reg_val
|= OPL3_TREMOLO_DEPTH
;
561 /* Set vibrato depth */
562 if (params
->vib_depth
)
563 reg_val
|= OPL3_VIBRATO_DEPTH
;
564 /* Set percussion mode */
565 if (params
->rhythm
) {
566 reg_val
|= OPL3_PERCUSSION_ENABLE
;
571 /* Play percussion instruments */
573 reg_val
|= OPL3_BASSDRUM_ON
;
575 reg_val
|= OPL3_SNAREDRUM_ON
;
577 reg_val
|= OPL3_TOMTOM_ON
;
579 reg_val
|= OPL3_CYMBAL_ON
;
581 reg_val
|= OPL3_HIHAT_ON
;
583 opl3
->command(opl3
, OPL3_LEFT
| OPL3_REG_PERCUSSION
, reg_val
);
587 static int snd_opl3_set_mode(struct snd_opl3
* opl3
, int mode
)
589 if ((mode
== SNDRV_DM_FM_MODE_OPL3
) && (opl3
->hardware
< OPL3_HW_OPL3
))
592 opl3
->fm_mode
= mode
;
593 if (opl3
->hardware
>= OPL3_HW_OPL3
)
594 opl3
->command(opl3
, OPL3_RIGHT
| OPL3_REG_CONNECTION_SELECT
, 0x00); /* Clear 4-op connections */
599 static int snd_opl3_set_connection(struct snd_opl3
* opl3
, int connection
)
601 unsigned char reg_val
;
604 if (opl3
->fm_mode
!= SNDRV_DM_FM_MODE_OPL3
)
607 reg_val
= connection
& (OPL3_RIGHT_4OP_0
| OPL3_RIGHT_4OP_1
| OPL3_RIGHT_4OP_2
|
608 OPL3_LEFT_4OP_0
| OPL3_LEFT_4OP_1
| OPL3_LEFT_4OP_2
);
609 /* Set 4-op connections */
610 opl3
->command(opl3
, OPL3_RIGHT
| OPL3_REG_CONNECTION_SELECT
, reg_val
);