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 <linux/slab.h>
23 #include <linux/export.h>
24 #include <linux/nospec.h>
25 #include <sound/opl3.h>
26 #include <sound/asound_fm.h>
27 #include "opl3_voice.h"
29 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
30 #define OPL3_SUPPORT_SYNTH
34 * There is 18 possible 2 OP voices
35 * (9 in the left and 9 in the right).
36 * The first OP is the modulator and 2nd is the carrier.
38 * The first three voices in the both sides may be connected
39 * with another voice to a 4 OP voice. For example voice 0
40 * can be connected with voice 3. The operators of voice 3 are
41 * used as operators 3 and 4 of the new 4 OP voice.
42 * In this case the 2 OP voice number 0 is the 'first half' and
43 * voice 3 is the second.
48 * Register offset table for OPL2/3 voices,
49 * OPL2 / one OPL3 register array side only
52 char snd_opl3_regmap[MAX_OPL2_VOICES][4] =
55 /* ------------------------ */
56 { 0x00, 0x03, 0x08, 0x0b },
57 { 0x01, 0x04, 0x09, 0x0c },
58 { 0x02, 0x05, 0x0a, 0x0d },
60 { 0x08, 0x0b, 0x00, 0x00 },
61 { 0x09, 0x0c, 0x00, 0x00 },
62 { 0x0a, 0x0d, 0x00, 0x00 },
64 { 0x10, 0x13, 0x00, 0x00 }, /* used by percussive voices */
65 { 0x11, 0x14, 0x00, 0x00 }, /* if the percussive mode */
66 { 0x12, 0x15, 0x00, 0x00 } /* is selected (only left reg block) */
69 EXPORT_SYMBOL(snd_opl3_regmap);
74 static int snd_opl3_play_note(struct snd_opl3 * opl3, struct snd_dm_fm_note * note);
75 static int snd_opl3_set_voice(struct snd_opl3 * opl3, struct snd_dm_fm_voice * voice);
76 static int snd_opl3_set_params(struct snd_opl3 * opl3, struct snd_dm_fm_params * params);
77 static int snd_opl3_set_mode(struct snd_opl3 * opl3, int mode);
78 static int snd_opl3_set_connection(struct snd_opl3 * opl3, int connection);
80 /* ------------------------------ */
83 * open the device exclusively
85 int snd_opl3_open(struct snd_hwdep * hw, struct file *file)
91 * ioctl for hwdep device:
93 int snd_opl3_ioctl(struct snd_hwdep * hw, struct file *file,
94 unsigned int cmd, unsigned long arg)
96 struct snd_opl3 *opl3 = hw->private_data;
97 void __user *argp = (void __user *)arg;
99 if (snd_BUG_ON(!opl3))
103 /* get information */
104 case SNDRV_DM_FM_IOCTL_INFO:
106 struct snd_dm_fm_info info;
108 memset(&info, 0, sizeof(info));
110 info.fm_mode = opl3->fm_mode;
111 info.rhythm = opl3->rhythm;
112 if (copy_to_user(argp, &info, sizeof(struct snd_dm_fm_info)))
117 case SNDRV_DM_FM_IOCTL_RESET:
118 #ifdef CONFIG_SND_OSSEMUL
119 case SNDRV_DM_FM_OSS_IOCTL_RESET:
121 snd_opl3_reset(opl3);
124 case SNDRV_DM_FM_IOCTL_PLAY_NOTE:
125 #ifdef CONFIG_SND_OSSEMUL
126 case SNDRV_DM_FM_OSS_IOCTL_PLAY_NOTE:
129 struct snd_dm_fm_note note;
130 if (copy_from_user(¬e, argp, sizeof(struct snd_dm_fm_note)))
132 return snd_opl3_play_note(opl3, ¬e);
135 case SNDRV_DM_FM_IOCTL_SET_VOICE:
136 #ifdef CONFIG_SND_OSSEMUL
137 case SNDRV_DM_FM_OSS_IOCTL_SET_VOICE:
140 struct snd_dm_fm_voice voice;
141 if (copy_from_user(&voice, argp, sizeof(struct snd_dm_fm_voice)))
143 return snd_opl3_set_voice(opl3, &voice);
146 case SNDRV_DM_FM_IOCTL_SET_PARAMS:
147 #ifdef CONFIG_SND_OSSEMUL
148 case SNDRV_DM_FM_OSS_IOCTL_SET_PARAMS:
151 struct snd_dm_fm_params params;
152 if (copy_from_user(¶ms, argp, sizeof(struct snd_dm_fm_params)))
154 return snd_opl3_set_params(opl3, ¶ms);
157 case SNDRV_DM_FM_IOCTL_SET_MODE:
158 #ifdef CONFIG_SND_OSSEMUL
159 case SNDRV_DM_FM_OSS_IOCTL_SET_MODE:
161 return snd_opl3_set_mode(opl3, (int) arg);
163 case SNDRV_DM_FM_IOCTL_SET_CONNECTION:
164 #ifdef CONFIG_SND_OSSEMUL
165 case SNDRV_DM_FM_OSS_IOCTL_SET_OPL:
167 return snd_opl3_set_connection(opl3, (int) arg);
169 #ifdef OPL3_SUPPORT_SYNTH
170 case SNDRV_DM_FM_IOCTL_CLEAR_PATCHES:
171 snd_opl3_clear_patches(opl3);
175 #ifdef CONFIG_SND_DEBUG
177 snd_printk(KERN_WARNING "unknown IOCTL: 0x%x\n", cmd);
186 int snd_opl3_release(struct snd_hwdep * hw, struct file *file)
188 struct snd_opl3 *opl3 = hw->private_data;
190 snd_opl3_reset(opl3);
194 #ifdef OPL3_SUPPORT_SYNTH
196 * write the device - load patches
198 long snd_opl3_write(struct snd_hwdep *hw, const char __user *buf, long count,
201 struct snd_opl3 *opl3 = hw->private_data;
204 struct sbi_patch inst;
206 while (count >= sizeof(inst)) {
208 if (copy_from_user(&inst, buf, sizeof(inst)))
210 if (!memcmp(inst.key, FM_KEY_SBI, 4) ||
211 !memcmp(inst.key, FM_KEY_2OP, 4))
212 type = FM_PATCH_OPL2;
213 else if (!memcmp(inst.key, FM_KEY_4OP, 4))
214 type = FM_PATCH_OPL3;
215 else /* invalid type */
217 err = snd_opl3_load_patch(opl3, inst.prog, inst.bank, type,
218 inst.name, inst.extension,
222 result += sizeof(inst);
223 count -= sizeof(inst);
225 return result > 0 ? result : err;
233 /* offsets for SBI params */
236 #define ATTACK_DECAY 4
237 #define SUSTAIN_RELEASE 6
238 #define WAVE_SELECT 8
240 /* offset for SBI instrument */
241 #define CONNECTION 10
242 #define OFFSET_4OP 11
245 * load a patch, obviously.
247 * loaded on the given program and bank numbers with the given type
249 * data is the pointer of SBI record _without_ header (key and name).
250 * name is the name string of the patch.
251 * ext is the extension data of 7 bytes long (stored in name of SBI
252 * data up to offset 25), or NULL to skip.
253 * return 0 if successful or a negative error code.
255 int snd_opl3_load_patch(struct snd_opl3 *opl3,
256 int prog, int bank, int type,
258 const unsigned char *ext,
259 const unsigned char *data)
261 struct fm_patch *patch;
264 patch = snd_opl3_find_patch(opl3, prog, bank, 1);
270 for (i = 0; i < 2; i++) {
271 patch->inst.op[i].am_vib = data[AM_VIB + i];
272 patch->inst.op[i].ksl_level = data[KSL_LEVEL + i];
273 patch->inst.op[i].attack_decay = data[ATTACK_DECAY + i];
274 patch->inst.op[i].sustain_release = data[SUSTAIN_RELEASE + i];
275 patch->inst.op[i].wave_select = data[WAVE_SELECT + i];
277 patch->inst.feedback_connection[0] = data[CONNECTION];
279 if (type == FM_PATCH_OPL3) {
280 for (i = 0; i < 2; i++) {
281 patch->inst.op[i+2].am_vib =
282 data[OFFSET_4OP + AM_VIB + i];
283 patch->inst.op[i+2].ksl_level =
284 data[OFFSET_4OP + KSL_LEVEL + i];
285 patch->inst.op[i+2].attack_decay =
286 data[OFFSET_4OP + ATTACK_DECAY + i];
287 patch->inst.op[i+2].sustain_release =
288 data[OFFSET_4OP + SUSTAIN_RELEASE + i];
289 patch->inst.op[i+2].wave_select =
290 data[OFFSET_4OP + WAVE_SELECT + i];
292 patch->inst.feedback_connection[1] =
293 data[OFFSET_4OP + CONNECTION];
297 patch->inst.echo_delay = ext[0];
298 patch->inst.echo_atten = ext[1];
299 patch->inst.chorus_spread = ext[2];
300 patch->inst.trnsps = ext[3];
301 patch->inst.fix_dur = ext[4];
302 patch->inst.modes = ext[5];
303 patch->inst.fix_key = ext[6];
307 strlcpy(patch->name, name, sizeof(patch->name));
311 EXPORT_SYMBOL(snd_opl3_load_patch);
314 * find a patch with the given program and bank numbers, returns its pointer
315 * if no matching patch is found and create_patch is set, it creates a
318 struct fm_patch *snd_opl3_find_patch(struct snd_opl3 *opl3, int prog, int bank,
321 /* pretty dumb hash key */
322 unsigned int key = (prog + bank) % OPL3_PATCH_HASH_SIZE;
323 struct fm_patch *patch;
325 for (patch = opl3->patch_table[key]; patch; patch = patch->next) {
326 if (patch->prog == prog && patch->bank == bank)
332 patch = kzalloc(sizeof(*patch), GFP_KERNEL);
337 patch->next = opl3->patch_table[key];
338 opl3->patch_table[key] = patch;
341 EXPORT_SYMBOL(snd_opl3_find_patch);
344 * Clear all patches of the given OPL3 instance
346 void snd_opl3_clear_patches(struct snd_opl3 *opl3)
349 for (i = 0; i < OPL3_PATCH_HASH_SIZE; i++) {
350 struct fm_patch *patch, *next;
351 for (patch = opl3->patch_table[i]; patch; patch = next) {
356 memset(opl3->patch_table, 0, sizeof(opl3->patch_table));
358 #endif /* OPL3_SUPPORT_SYNTH */
360 /* ------------------------------ */
362 void snd_opl3_reset(struct snd_opl3 * opl3)
364 unsigned short opl3_reg;
366 unsigned short reg_side;
367 unsigned char voice_offset;
371 max_voices = (opl3->hardware < OPL3_HW_OPL3) ?
372 MAX_OPL2_VOICES : MAX_OPL3_VOICES;
374 for (i = 0; i < max_voices; i++) {
375 /* Get register array side and offset of voice */
376 if (i < MAX_OPL2_VOICES) {
377 /* Left register block for voices 0 .. 8 */
378 reg_side = OPL3_LEFT;
381 /* Right register block for voices 9 .. 17 */
382 reg_side = OPL3_RIGHT;
383 voice_offset = i - MAX_OPL2_VOICES;
385 opl3_reg = reg_side | (OPL3_REG_KSL_LEVEL + snd_opl3_regmap[voice_offset][0]);
386 opl3->command(opl3, opl3_reg, OPL3_TOTAL_LEVEL_MASK); /* Operator 1 volume */
387 opl3_reg = reg_side | (OPL3_REG_KSL_LEVEL + snd_opl3_regmap[voice_offset][1]);
388 opl3->command(opl3, opl3_reg, OPL3_TOTAL_LEVEL_MASK); /* Operator 2 volume */
390 opl3_reg = reg_side | (OPL3_REG_KEYON_BLOCK + voice_offset);
391 opl3->command(opl3, opl3_reg, 0x00); /* Note off */
394 opl3->max_voices = MAX_OPL2_VOICES;
395 opl3->fm_mode = SNDRV_DM_FM_MODE_OPL2;
397 opl3->command(opl3, OPL3_LEFT | OPL3_REG_TEST, OPL3_ENABLE_WAVE_SELECT);
398 opl3->command(opl3, OPL3_LEFT | OPL3_REG_PERCUSSION, 0x00); /* Melodic mode */
402 EXPORT_SYMBOL(snd_opl3_reset);
404 static int snd_opl3_play_note(struct snd_opl3 * opl3, struct snd_dm_fm_note * note)
406 unsigned short reg_side;
407 unsigned char voice_offset;
409 unsigned short opl3_reg;
410 unsigned char reg_val;
412 /* Voices 0 - 8 in OPL2 mode */
413 /* Voices 0 - 17 in OPL3 mode */
414 if (note->voice >= ((opl3->fm_mode == SNDRV_DM_FM_MODE_OPL3) ?
415 MAX_OPL3_VOICES : MAX_OPL2_VOICES))
418 /* Get register array side and offset of voice */
419 if (note->voice < MAX_OPL2_VOICES) {
420 /* Left register block for voices 0 .. 8 */
421 reg_side = OPL3_LEFT;
422 voice_offset = note->voice;
424 /* Right register block for voices 9 .. 17 */
425 reg_side = OPL3_RIGHT;
426 voice_offset = note->voice - MAX_OPL2_VOICES;
429 /* Set lower 8 bits of note frequency */
430 reg_val = (unsigned char) note->fnum;
431 opl3_reg = reg_side | (OPL3_REG_FNUM_LOW + voice_offset);
432 opl3->command(opl3, opl3_reg, reg_val);
435 /* Set output sound flag */
437 reg_val |= OPL3_KEYON_BIT;
439 reg_val |= (note->octave << 2) & OPL3_BLOCKNUM_MASK;
440 /* Set higher 2 bits of note frequency */
441 reg_val |= (unsigned char) (note->fnum >> 8) & OPL3_FNUM_HIGH_MASK;
443 /* Set OPL3 KEYON_BLOCK register of requested voice */
444 opl3_reg = reg_side | (OPL3_REG_KEYON_BLOCK + voice_offset);
445 opl3->command(opl3, opl3_reg, reg_val);
451 static int snd_opl3_set_voice(struct snd_opl3 * opl3, struct snd_dm_fm_voice * voice)
453 unsigned short reg_side;
454 unsigned char op_offset;
455 unsigned char voice_offset, voice_op;
457 unsigned short opl3_reg;
458 unsigned char reg_val;
460 /* Only operators 1 and 2 */
463 /* Voices 0 - 8 in OPL2 mode */
464 /* Voices 0 - 17 in OPL3 mode */
465 if (voice->voice >= ((opl3->fm_mode == SNDRV_DM_FM_MODE_OPL3) ?
466 MAX_OPL3_VOICES : MAX_OPL2_VOICES))
469 /* Get register array side and offset of voice */
470 if (voice->voice < MAX_OPL2_VOICES) {
471 /* Left register block for voices 0 .. 8 */
472 reg_side = OPL3_LEFT;
473 voice_offset = voice->voice;
475 /* Right register block for voices 9 .. 17 */
476 reg_side = OPL3_RIGHT;
477 voice_offset = voice->voice - MAX_OPL2_VOICES;
479 /* Get register offset of operator */
480 voice_offset = array_index_nospec(voice_offset, MAX_OPL2_VOICES);
481 voice_op = array_index_nospec(voice->op, 4);
482 op_offset = snd_opl3_regmap[voice_offset][voice_op];
485 /* Set amplitude modulation (tremolo) effect */
487 reg_val |= OPL3_TREMOLO_ON;
488 /* Set vibrato effect */
490 reg_val |= OPL3_VIBRATO_ON;
491 /* Set sustaining sound phase */
492 if (voice->do_sustain)
493 reg_val |= OPL3_SUSTAIN_ON;
494 /* Set keyboard scaling bit */
495 if (voice->kbd_scale)
497 /* Set harmonic or frequency multiplier */
498 reg_val |= voice->harmonic & OPL3_MULTIPLE_MASK;
500 /* Set OPL3 AM_VIB register of requested voice/operator */
501 opl3_reg = reg_side | (OPL3_REG_AM_VIB + op_offset);
502 opl3->command(opl3, opl3_reg, reg_val);
504 /* Set decreasing volume of higher notes */
505 reg_val = (voice->scale_level << 6) & OPL3_KSL_MASK;
506 /* Set output volume */
507 reg_val |= ~voice->volume & OPL3_TOTAL_LEVEL_MASK;
509 /* Set OPL3 KSL_LEVEL register of requested voice/operator */
510 opl3_reg = reg_side | (OPL3_REG_KSL_LEVEL + op_offset);
511 opl3->command(opl3, opl3_reg, reg_val);
513 /* Set attack phase level */
514 reg_val = (voice->attack << 4) & OPL3_ATTACK_MASK;
515 /* Set decay phase level */
516 reg_val |= voice->decay & OPL3_DECAY_MASK;
518 /* Set OPL3 ATTACK_DECAY register of requested voice/operator */
519 opl3_reg = reg_side | (OPL3_REG_ATTACK_DECAY + op_offset);
520 opl3->command(opl3, opl3_reg, reg_val);
522 /* Set sustain phase level */
523 reg_val = (voice->sustain << 4) & OPL3_SUSTAIN_MASK;
524 /* Set release phase level */
525 reg_val |= voice->release & OPL3_RELEASE_MASK;
527 /* Set OPL3 SUSTAIN_RELEASE register of requested voice/operator */
528 opl3_reg = reg_side | (OPL3_REG_SUSTAIN_RELEASE + op_offset);
529 opl3->command(opl3, opl3_reg, reg_val);
531 /* Set inter-operator feedback */
532 reg_val = (voice->feedback << 1) & OPL3_FEEDBACK_MASK;
533 /* Set inter-operator connection */
534 if (voice->connection)
535 reg_val |= OPL3_CONNECTION_BIT;
537 if (opl3->fm_mode == SNDRV_DM_FM_MODE_OPL3) {
539 reg_val |= OPL3_VOICE_TO_LEFT;
541 reg_val |= OPL3_VOICE_TO_RIGHT;
543 /* Feedback/connection bits are applicable to voice */
544 opl3_reg = reg_side | (OPL3_REG_FEEDBACK_CONNECTION + voice_offset);
545 opl3->command(opl3, opl3_reg, reg_val);
547 /* Select waveform */
548 reg_val = voice->waveform & OPL3_WAVE_SELECT_MASK;
549 opl3_reg = reg_side | (OPL3_REG_WAVE_SELECT + op_offset);
550 opl3->command(opl3, opl3_reg, reg_val);
555 static int snd_opl3_set_params(struct snd_opl3 * opl3, struct snd_dm_fm_params * params)
557 unsigned char reg_val;
560 /* Set keyboard split method */
561 if (params->kbd_split)
562 reg_val |= OPL3_KEYBOARD_SPLIT;
563 opl3->command(opl3, OPL3_LEFT | OPL3_REG_KBD_SPLIT, reg_val);
566 /* Set amplitude modulation (tremolo) depth */
567 if (params->am_depth)
568 reg_val |= OPL3_TREMOLO_DEPTH;
569 /* Set vibrato depth */
570 if (params->vib_depth)
571 reg_val |= OPL3_VIBRATO_DEPTH;
572 /* Set percussion mode */
573 if (params->rhythm) {
574 reg_val |= OPL3_PERCUSSION_ENABLE;
579 /* Play percussion instruments */
581 reg_val |= OPL3_BASSDRUM_ON;
583 reg_val |= OPL3_SNAREDRUM_ON;
585 reg_val |= OPL3_TOMTOM_ON;
587 reg_val |= OPL3_CYMBAL_ON;
589 reg_val |= OPL3_HIHAT_ON;
591 opl3->command(opl3, OPL3_LEFT | OPL3_REG_PERCUSSION, reg_val);
595 static int snd_opl3_set_mode(struct snd_opl3 * opl3, int mode)
597 if ((mode == SNDRV_DM_FM_MODE_OPL3) && (opl3->hardware < OPL3_HW_OPL3))
600 opl3->fm_mode = mode;
601 if (opl3->hardware >= OPL3_HW_OPL3)
602 opl3->command(opl3, OPL3_RIGHT | OPL3_REG_CONNECTION_SELECT, 0x00); /* Clear 4-op connections */
607 static int snd_opl3_set_connection(struct snd_opl3 * opl3, int connection)
609 unsigned char reg_val;
612 if (opl3->fm_mode != SNDRV_DM_FM_MODE_OPL3)
615 reg_val = connection & (OPL3_RIGHT_4OP_0 | OPL3_RIGHT_4OP_1 | OPL3_RIGHT_4OP_2 |
616 OPL3_LEFT_4OP_0 | OPL3_LEFT_4OP_1 | OPL3_LEFT_4OP_2);
617 /* Set 4-op connections */
618 opl3->command(opl3, OPL3_RIGHT | OPL3_REG_CONNECTION_SELECT, reg_val);