include/sound/opl3.h

   1 #ifndef __SOUND_OPL3_H
   2 #define __SOUND_OPL3_H
   3
   4 /*
   5  * Definitions of the OPL-3 registers.
   6  *
   7  * Copyright (c) by Jaroslav Kysela <perex@perex.cz>,
   8  *                  Hannu Savolainen 1993-1996
   9  *
  10  *
  11  *      The OPL-3 mode is switched on by writing 0x01, to the offset 5
  12  *      of the right side.
  13  *
  14  *      Another special register at the right side is at offset 4. It contains
  15  *      a bit mask defining which voices are used as 4 OP voices.
  16  *
  17  *      The percussive mode is implemented in the left side only.
  18  *
  19  *      With the above exceptions the both sides can be operated independently.
  20  *
  21  *      A 4 OP voice can be created by setting the corresponding
  22  *      bit at offset 4 of the right side.
  23  *
  24  *      For example setting the rightmost bit (0x01) changes the
  25  *      first voice on the right side to the 4 OP mode. The fourth
  26  *      voice is made inaccessible.
  27  *
  28  *      If a voice is set to the 2 OP mode, it works like 2 OP modes
  29  *      of the original YM3812 (AdLib). In addition the voice can
  30  *      be connected the left, right or both stereo channels. It can
  31  *      even be left unconnected. This works with 4 OP voices also.
  32  *
  33  *      The stereo connection bits are located in the FEEDBACK_CONNECTION
  34  *      register of the voice (0xC0-0xC8). In 4 OP voices these bits are
  35  *      in the second half of the voice.
  36  *
  37  *
  38  *   This program is free software; you can redistribute it and/or modify
  39  *   it under the terms of the GNU General Public License as published by
  40  *   the Free Software Foundation; either version 2 of the License, or
  41  *   (at your option) any later version.
  42  *
  43  *   This program is distributed in the hope that it will be useful,
  44  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  45  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  46  *   GNU General Public License for more details.
  47  *
  48  *   You should have received a copy of the GNU General Public License
  49  *   along with this program; if not, write to the Free Software
  50  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  51  *
  52  */
  53
  54 #include <sound/core.h>
  55 #include <sound/hwdep.h>
  56 #include <sound/timer.h>
  57 #include <sound/seq_midi_emul.h>
  58 #include <sound/seq_oss.h>
  59 #include <sound/seq_oss_legacy.h>
  60 #include <sound/seq_device.h>
  61 #include <sound/asound_fm.h>
  62
  63 /*
  64  *    Register numbers for the global registers
  65  */
  66
  67 #define OPL3_REG_TEST                   0x01
  68 #define   OPL3_ENABLE_WAVE_SELECT       0x20
  69
  70 #define OPL3_REG_TIMER1                 0x02
  71 #define OPL3_REG_TIMER2                 0x03
  72 #define OPL3_REG_TIMER_CONTROL          0x04    /* Left side */
  73 #define   OPL3_IRQ_RESET                0x80
  74 #define   OPL3_TIMER1_MASK              0x40
  75 #define   OPL3_TIMER2_MASK              0x20
  76 #define   OPL3_TIMER1_START             0x01
  77 #define   OPL3_TIMER2_START             0x02
  78
  79 #define OPL3_REG_CONNECTION_SELECT      0x04    /* Right side */
  80 #define   OPL3_LEFT_4OP_0               0x01
  81 #define   OPL3_LEFT_4OP_1               0x02
  82 #define   OPL3_LEFT_4OP_2               0x04
  83 #define   OPL3_RIGHT_4OP_0              0x08
  84 #define   OPL3_RIGHT_4OP_1              0x10
  85 #define   OPL3_RIGHT_4OP_2              0x20
  86
  87 #define OPL3_REG_MODE                   0x05    /* Right side */
  88 #define   OPL3_OPL3_ENABLE              0x01    /* OPL3 mode */
  89 #define   OPL3_OPL4_ENABLE              0x02    /* OPL4 mode */
  90
  91 #define OPL3_REG_KBD_SPLIT              0x08    /* Left side */
  92 #define   OPL3_COMPOSITE_SINE_WAVE_MODE 0x80    /* Don't use with OPL-3? */
  93 #define   OPL3_KEYBOARD_SPLIT           0x40
  94
  95 #define OPL3_REG_PERCUSSION             0xbd    /* Left side only */
  96 #define   OPL3_TREMOLO_DEPTH            0x80
  97 #define   OPL3_VIBRATO_DEPTH            0x40
  98 #define   OPL3_PERCUSSION_ENABLE        0x20
  99 #define   OPL3_BASSDRUM_ON              0x10
 100 #define   OPL3_SNAREDRUM_ON             0x08
 101 #define   OPL3_TOMTOM_ON                0x04
 102 #define   OPL3_CYMBAL_ON                0x02
 103 #define   OPL3_HIHAT_ON                 0x01
 104
 105 /*
 106  *    Offsets to the register banks for operators. To get the
 107  *      register number just add the operator offset to the bank offset
 108  *
 109  *      AM/VIB/EG/KSR/Multiple (0x20 to 0x35)
 110  */
 111 #define OPL3_REG_AM_VIB                 0x20
 112 #define   OPL3_TREMOLO_ON               0x80
 113 #define   OPL3_VIBRATO_ON               0x40
 114 #define   OPL3_SUSTAIN_ON               0x20
 115 #define   OPL3_KSR                      0x10    /* Key scaling rate */
 116 #define   OPL3_MULTIPLE_MASK            0x0f    /* Frequency multiplier */
 117
 118  /*
 119   *   KSL/Total level (0x40 to 0x55)
 120   */
 121 #define OPL3_REG_KSL_LEVEL              0x40
 122 #define   OPL3_KSL_MASK                 0xc0    /* Envelope scaling bits */
 123 #define   OPL3_TOTAL_LEVEL_MASK         0x3f    /* Strength (volume) of OP */
 124
 125 /*
 126  *    Attack / Decay rate (0x60 to 0x75)
 127  */
 128 #define OPL3_REG_ATTACK_DECAY           0x60
 129 #define   OPL3_ATTACK_MASK              0xf0
 130 #define   OPL3_DECAY_MASK               0x0f
 131
 132 /*
 133  * Sustain level / Release rate (0x80 to 0x95)
 134  */
 135 #define OPL3_REG_SUSTAIN_RELEASE        0x80
 136 #define   OPL3_SUSTAIN_MASK             0xf0
 137 #define   OPL3_RELEASE_MASK             0x0f
 138
 139 /*
 140  * Wave select (0xE0 to 0xF5)
 141  */
 142 #define OPL3_REG_WAVE_SELECT            0xe0
 143 #define   OPL3_WAVE_SELECT_MASK         0x07
 144
 145 /*
 146  *    Offsets to the register banks for voices. Just add to the
 147  *      voice number to get the register number.
 148  *
 149  *      F-Number low bits (0xA0 to 0xA8).
 150  */
 151 #define OPL3_REG_FNUM_LOW               0xa0
 152
 153 /*
 154  *    F-number high bits / Key on / Block (octave) (0xB0 to 0xB8)
 155  */
 156 #define OPL3_REG_KEYON_BLOCK            0xb0
 157 #define   OPL3_KEYON_BIT                0x20
 158 #define   OPL3_BLOCKNUM_MASK            0x1c
 159 #define   OPL3_FNUM_HIGH_MASK           0x03
 160
 161 /*
 162  *    Feedback / Connection (0xc0 to 0xc8)
 163  *
 164  *      These registers have two new bits when the OPL-3 mode
 165  *      is selected. These bits controls connecting the voice
 166  *      to the stereo channels. For 4 OP voices this bit is
 167  *      defined in the second half of the voice (add 3 to the
 168  *      register offset).
 169  *
 170  *      For 4 OP voices the connection bit is used in the
 171  *      both halves (gives 4 ways to connect the operators).
 172  */
 173 #define OPL3_REG_FEEDBACK_CONNECTION    0xc0
 174 #define   OPL3_FEEDBACK_MASK            0x0e    /* Valid just for 1st OP of a voice */
 175 #define   OPL3_CONNECTION_BIT           0x01
 176 /*
 177  *    In the 4 OP mode there is four possible configurations how the
 178  *      operators can be connected together (in 2 OP modes there is just
 179  *      AM or FM). The 4 OP connection mode is defined by the rightmost
 180  *      bit of the FEEDBACK_CONNECTION (0xC0-0xC8) on the both halves.
 181  *
 182  *      First half      Second half     Mode
 183  *
 184  *                                       +---+
 185  *                                       v   |
 186  *      0               0               >+-1-+--2--3--4-->
 187  *
 188  *
 189  *
 190  *                                       +---+
 191  *                                       |   |
 192  *      0               1               >+-1-+--2-+
 193  *                                                |->
 194  *                                      >--3----4-+
 195  *
 196  *                                       +---+
 197  *                                       |   |
 198  *      1               0               >+-1-+-----+
 199  *                                                 |->
 200  *                                      >--2--3--4-+
 201  *
 202  *                                       +---+
 203  *                                       |   |
 204  *      1               1               >+-1-+--+
 205  *                                              |
 206  *                                      >--2--3-+->
 207  *                                              |
 208  *                                      >--4----+
 209  */
 210 #define   OPL3_STEREO_BITS              0x30    /* OPL-3 only */
 211 #define     OPL3_VOICE_TO_LEFT          0x10
 212 #define     OPL3_VOICE_TO_RIGHT         0x20
 213
 214 /*
 215
 216  */
 217
 218 #define OPL3_LEFT               0x0000
 219 #define OPL3_RIGHT              0x0100
 220
 221 #define OPL3_HW_AUTO            0x0000
 222 #define OPL3_HW_OPL2            0x0200
 223 #define OPL3_HW_OPL3            0x0300
 224 #define OPL3_HW_OPL3_SV         0x0301  /* S3 SonicVibes */
 225 #define OPL3_HW_OPL3_CS         0x0302  /* CS4232/CS4236+ */
 226 #define OPL3_HW_OPL3_FM801      0x0303  /* FM801 */
 227 #define OPL3_HW_OPL3_CS4281     0x0304  /* CS4281 */
 228 #define OPL3_HW_OPL4            0x0400  /* YMF278B/YMF295 */
 229 #define OPL3_HW_OPL4_ML         0x0401  /* YMF704/YMF721 */
 230 #define OPL3_HW_MASK            0xff00
 231
 232 #define MAX_OPL2_VOICES         9
 233 #define MAX_OPL3_VOICES         18
 234
 235 struct snd_opl3;
 236
 237 /*
 238  * Instrument record, aka "Patch"
 239  */
 240
 241 /* FM operator */
 242 struct fm_operator {
 243         unsigned char am_vib;
 244         unsigned char ksl_level;
 245         unsigned char attack_decay;
 246         unsigned char sustain_release;
 247         unsigned char wave_select;
 248 } __attribute__((packed));
 249
 250 /* Instrument data */
 251 struct fm_instrument {
 252         struct fm_operator op[4];
 253         unsigned char feedback_connection[2];
 254         unsigned char echo_delay;
 255         unsigned char echo_atten;
 256         unsigned char chorus_spread;
 257         unsigned char trnsps;
 258         unsigned char fix_dur;
 259         unsigned char modes;
 260         unsigned char fix_key;
 261 };
 262
 263 /* type */
 264 #define FM_PATCH_OPL2   0x01            /* OPL2 2 operators FM instrument */
 265 #define FM_PATCH_OPL3   0x02            /* OPL3 4 operators FM instrument */
 266
 267 /* Instrument record */
 268 struct fm_patch {
 269         unsigned char prog;
 270         unsigned char bank;
 271         unsigned char type;
 272         struct fm_instrument inst;
 273         char name[24];
 274         struct fm_patch *next;
 275 };
 276
 277
 278 /*
 279  * A structure to keep track of each hardware voice
 280  */
 281 struct snd_opl3_voice {
 282         int  state;             /* status */
 283 #define SNDRV_OPL3_ST_OFF               0       /* Not playing */
 284 #define SNDRV_OPL3_ST_ON_2OP    1       /* 2op voice is allocated */
 285 #define SNDRV_OPL3_ST_ON_4OP    2       /* 4op voice is allocated */
 286 #define SNDRV_OPL3_ST_NOT_AVAIL -1      /* voice is not available */
 287
 288         unsigned int time;      /* An allocation time */
 289         unsigned char note;     /* Note currently assigned to this voice */
 290
 291         unsigned long note_off; /* note-off time */
 292         int note_off_check;     /* check note-off time */
 293
 294         unsigned char keyon_reg;        /* KON register shadow */
 295
 296         struct snd_midi_channel *chan;  /* Midi channel for this note */
 297 };
 298
 299 struct snd_opl3 {
 300         unsigned long l_port;
 301         unsigned long r_port;
 302         struct resource *res_l_port;
 303         struct resource *res_r_port;
 304         unsigned short hardware;
 305         /* hardware access */
 306         void (*command) (struct snd_opl3 * opl3, unsigned short cmd, unsigned char val);
 307         unsigned short timer_enable;
 308         int seq_dev_num;        /* sequencer device number */
 309         struct snd_timer *timer1;
 310         struct snd_timer *timer2;
 311         spinlock_t timer_lock;
 312
 313         void *private_data;
 314         void (*private_free)(struct snd_opl3 *);
 315
 316         struct snd_hwdep *hwdep;
 317         spinlock_t reg_lock;
 318         struct snd_card *card;          /* The card that this belongs to */
 319         unsigned char fm_mode;          /* OPL mode, see SNDRV_DM_FM_MODE_XXX */
 320         unsigned char rhythm;           /* percussion mode flag */
 321         unsigned char max_voices;       /* max number of voices */
 322 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
 323 #define SNDRV_OPL3_MODE_SYNTH 0         /* OSS - voices allocated by application */
 324 #define SNDRV_OPL3_MODE_SEQ 1           /* ALSA - driver handles voice allocation */
 325         int synth_mode;                 /* synth mode */
 326         int seq_client;
 327
 328         struct snd_seq_device *seq_dev; /* sequencer device */
 329         struct snd_midi_channel_set * chset;
 330
 331 #if IS_ENABLED(CONFIG_SND_SEQUENCER_OSS)
 332         struct snd_seq_device *oss_seq_dev;     /* OSS sequencer device */
 333         struct snd_midi_channel_set * oss_chset;
 334 #endif
 335
 336 #define OPL3_PATCH_HASH_SIZE    32
 337         struct fm_patch *patch_table[OPL3_PATCH_HASH_SIZE];
 338
 339         struct snd_opl3_voice voices[MAX_OPL3_VOICES]; /* Voices (OPL3 'channel') */
 340         int use_time;                   /* allocation counter */
 341
 342         unsigned short connection_reg;  /* connection reg shadow */
 343         unsigned char drum_reg;         /* percussion reg shadow */
 344
 345         spinlock_t voice_lock;          /* Lock for voice access */
 346
 347         struct timer_list tlist;        /* timer for note-offs and effects */
 348         int sys_timer_status;           /* system timer run status */
 349         spinlock_t sys_timer_lock;      /* Lock for system timer access */
 350 #endif
 351 };
 352
 353 /* opl3.c */
 354 void snd_opl3_interrupt(struct snd_hwdep * hw);
 355 int snd_opl3_new(struct snd_card *card, unsigned short hardware,
 356                  struct snd_opl3 **ropl3);
 357 int snd_opl3_init(struct snd_opl3 *opl3);
 358 int snd_opl3_create(struct snd_card *card,
 359                     unsigned long l_port, unsigned long r_port,
 360                     unsigned short hardware,
 361                     int integrated,
 362                     struct snd_opl3 ** opl3);
 363 int snd_opl3_timer_new(struct snd_opl3 * opl3, int timer1_dev, int timer2_dev);
 364 int snd_opl3_hwdep_new(struct snd_opl3 * opl3, int device, int seq_device,
 365                        struct snd_hwdep ** rhwdep);
 366
 367 /* opl3_synth */
 368 int snd_opl3_open(struct snd_hwdep * hw, struct file *file);
 369 int snd_opl3_ioctl(struct snd_hwdep * hw, struct file *file,
 370                    unsigned int cmd, unsigned long arg);
 371 int snd_opl3_release(struct snd_hwdep * hw, struct file *file);
 372
 373 void snd_opl3_reset(struct snd_opl3 * opl3);
 374
 375 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
 376 long snd_opl3_write(struct snd_hwdep *hw, const char __user *buf, long count,
 377                     loff_t *offset);
 378 int snd_opl3_load_patch(struct snd_opl3 *opl3,
 379                         int prog, int bank, int type,
 380                         const char *name,
 381                         const unsigned char *ext,
 382                         const unsigned char *data);
 383 struct fm_patch *snd_opl3_find_patch(struct snd_opl3 *opl3, int prog, int bank,
 384                                      int create_patch);
 385 void snd_opl3_clear_patches(struct snd_opl3 *opl3);
 386 #else
 387 #define snd_opl3_write  NULL
 388 static inline void snd_opl3_clear_patches(struct snd_opl3 *opl3) {}
 389 #endif
 390
 391 #endif /* __SOUND_OPL3_H */