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 (at) 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 "driver.h" 55 #include <linux/time.h> 56 #include <linux/mutex.h> 57 #include "core.h" 58 #include "hwdep.h" 59 #include "timer.h" 60 #include "seq_midi_emul.h" 61 #ifdef CONFIG_SND_SEQUENCER_OSS 62 #include "seq_oss.h" 63 #include "seq_oss_legacy.h" 64 #endif 65 #include "seq_device.h" 66 #include "ainstr_fm.h" 67 68 /* 69 * Register numbers for the global registers 70 */ 71 72 #define OPL3_REG_TEST 0x01 73 #define OPL3_ENABLE_WAVE_SELECT 0x20 74 75 #define OPL3_REG_TIMER1 0x02 76 #define OPL3_REG_TIMER2 0x03 77 #define OPL3_REG_TIMER_CONTROL 0x04 /* Left side */ 78 #define OPL3_IRQ_RESET 0x80 79 #define OPL3_TIMER1_MASK 0x40 80 #define OPL3_TIMER2_MASK 0x20 81 #define OPL3_TIMER1_START 0x01 82 #define OPL3_TIMER2_START 0x02 83 84 #define OPL3_REG_CONNECTION_SELECT 0x04 /* Right side */ 85 #define OPL3_LEFT_4OP_0 0x01 86 #define OPL3_LEFT_4OP_1 0x02 87 #define OPL3_LEFT_4OP_2 0x04 88 #define OPL3_RIGHT_4OP_0 0x08 89 #define OPL3_RIGHT_4OP_1 0x10 90 #define OPL3_RIGHT_4OP_2 0x20 91 92 #define OPL3_REG_MODE 0x05 /* Right side */ 93 #define OPL3_OPL3_ENABLE 0x01 /* OPL3 mode */ 94 #define OPL3_OPL4_ENABLE 0x02 /* OPL4 mode */ 95 96 #define OPL3_REG_KBD_SPLIT 0x08 /* Left side */ 97 #define OPL3_COMPOSITE_SINE_WAVE_MODE 0x80 /* Don't use with OPL-3? */ 98 #define OPL3_KEYBOARD_SPLIT 0x40 99 100 #define OPL3_REG_PERCUSSION 0xbd /* Left side only */ 101 #define OPL3_TREMOLO_DEPTH 0x80 102 #define OPL3_VIBRATO_DEPTH 0x40 103 #define OPL3_PERCUSSION_ENABLE 0x20 104 #define OPL3_BASSDRUM_ON 0x10 105 #define OPL3_SNAREDRUM_ON 0x08 106 #define OPL3_TOMTOM_ON 0x04 107 #define OPL3_CYMBAL_ON 0x02 108 #define OPL3_HIHAT_ON 0x01 109 110 /* 111 * Offsets to the register banks for operators. To get the 112 * register number just add the operator offset to the bank offset 113 * 114 * AM/VIB/EG/KSR/Multiple (0x20 to 0x35) 115 */ 116 #define OPL3_REG_AM_VIB 0x20 117 #define OPL3_TREMOLO_ON 0x80 118 #define OPL3_VIBRATO_ON 0x40 119 #define OPL3_SUSTAIN_ON 0x20 120 #define OPL3_KSR 0x10 /* Key scaling rate */ 121 #define OPL3_MULTIPLE_MASK 0x0f /* Frequency multiplier */ 122 123 /* 124 * KSL/Total level (0x40 to 0x55) 125 */ 126 #define OPL3_REG_KSL_LEVEL 0x40 127 #define OPL3_KSL_MASK 0xc0 /* Envelope scaling bits */ 128 #define OPL3_TOTAL_LEVEL_MASK 0x3f /* Strength (volume) of OP */ 129 130 /* 131 * Attack / Decay rate (0x60 to 0x75) 132 */ 133 #define OPL3_REG_ATTACK_DECAY 0x60 134 #define OPL3_ATTACK_MASK 0xf0 135 #define OPL3_DECAY_MASK 0x0f 136 137 /* 138 * Sustain level / Release rate (0x80 to 0x95) 139 */ 140 #define OPL3_REG_SUSTAIN_RELEASE 0x80 141 #define OPL3_SUSTAIN_MASK 0xf0 142 #define OPL3_RELEASE_MASK 0x0f 143 144 /* 145 * Wave select (0xE0 to 0xF5) 146 */ 147 #define OPL3_REG_WAVE_SELECT 0xe0 148 #define OPL3_WAVE_SELECT_MASK 0x07 149 150 /* 151 * Offsets to the register banks for voices. Just add to the 152 * voice number to get the register number. 153 * 154 * F-Number low bits (0xA0 to 0xA8). 155 */ 156 #define OPL3_REG_FNUM_LOW 0xa0 157 158 /* 159 * F-number high bits / Key on / Block (octave) (0xB0 to 0xB8) 160 */ 161 #define OPL3_REG_KEYON_BLOCK 0xb0 162 #define OPL3_KEYON_BIT 0x20 163 #define OPL3_BLOCKNUM_MASK 0x1c 164 #define OPL3_FNUM_HIGH_MASK 0x03 165 166 /* 167 * Feedback / Connection (0xc0 to 0xc8) 168 * 169 * These registers have two new bits when the OPL-3 mode 170 * is selected. These bits controls connecting the voice 171 * to the stereo channels. For 4 OP voices this bit is 172 * defined in the second half of the voice (add 3 to the 173 * register offset). 174 * 175 * For 4 OP voices the connection bit is used in the 176 * both halves (gives 4 ways to connect the operators). 177 */ 178 #define OPL3_REG_FEEDBACK_CONNECTION 0xc0 179 #define OPL3_FEEDBACK_MASK 0x0e /* Valid just for 1st OP of a voice */ 180 #define OPL3_CONNECTION_BIT 0x01 181 /* 182 * In the 4 OP mode there is four possible configurations how the 183 * operators can be connected together (in 2 OP modes there is just 184 * AM or FM). The 4 OP connection mode is defined by the rightmost 185 * bit of the FEEDBACK_CONNECTION (0xC0-0xC8) on the both halves. 186 * 187 * First half Second half Mode 188 * 189 * +---+ 190 * v | 191 * 0 0 >+-1-+--2--3--4--> 192 * 193 * 194 * 195 * +---+ 196 * | | 197 * 0 1 >+-1-+--2-+ 198 * |-> 199 * >--3----4-+ 200 * 201 * +---+ 202 * | | 203 * 1 0 >+-1-+-----+ 204 * |-> 205 * >--2--3--4-+ 206 * 207 * +---+ 208 * | | 209 * 1 1 >+-1-+--+ 210 * | 211 * >--2--3-+-> 212 * | 213 * >--4----+ 214 */ 215 #define OPL3_STEREO_BITS 0x30 /* OPL-3 only */ 216 #define OPL3_VOICE_TO_LEFT 0x10 217 #define OPL3_VOICE_TO_RIGHT 0x20 218 219 /* 220 221 */ 222 223 #define OPL3_LEFT 0x0000 224 #define OPL3_RIGHT 0x0100 225 226 #define OPL3_HW_AUTO 0x0000 227 #define OPL3_HW_OPL2 0x0200 228 #define OPL3_HW_OPL3 0x0300 229 #define OPL3_HW_OPL3_SV 0x0301 /* S3 SonicVibes */ 230 #define OPL3_HW_OPL3_CS 0x0302 /* CS4232/CS4236+ */ 231 #define OPL3_HW_OPL3_FM801 0x0303 /* FM801 */ 232 #define OPL3_HW_OPL3_CS4281 0x0304 /* CS4281 */ 233 #define OPL3_HW_OPL4 0x0400 /* YMF278B/YMF295 */ 234 #define OPL3_HW_OPL4_ML 0x0401 /* YMF704/YMF721 */ 235 #define OPL3_HW_MASK 0xff00 236 237 #define MAX_OPL2_VOICES 9 238 #define MAX_OPL3_VOICES 18 239 240 struct snd_opl3; 241 242 /* 243 * A structure to keep track of each hardware voice 244 */ 245 struct snd_opl3_voice { 246 int state; /* status */ 247 #define SNDRV_OPL3_ST_OFF 0 /* Not playing */ 248 #define SNDRV_OPL3_ST_ON_2OP 1 /* 2op voice is allocated */ 249 #define SNDRV_OPL3_ST_ON_4OP 2 /* 4op voice is allocated */ 250 #define SNDRV_OPL3_ST_NOT_AVAIL -1 /* voice is not available */ 251 252 unsigned int time; /* An allocation time */ 253 unsigned char note; /* Note currently assigned to this voice */ 254 255 unsigned long note_off; /* note-off time */ 256 int note_off_check; /* check note-off time */ 257 258 unsigned char keyon_reg; /* KON register shadow */ 259 260 struct snd_midi_channel *chan; /* Midi channel for this note */ 261 }; 262 263 struct snd_opl3 { 264 unsigned long l_port; 265 unsigned long r_port; 266 struct resource *res_l_port; 267 struct resource *res_r_port; 268 unsigned short hardware; 269 /* hardware access */ 270 void (*command) (struct snd_opl3 * opl3, unsigned short cmd, unsigned char val); 271 unsigned short timer_enable; 272 int seq_dev_num; /* sequencer device number */ 273 struct snd_timer *timer1; 274 struct snd_timer *timer2; 275 spinlock_t timer_lock; 276 277 void *private_data; 278 void (*private_free)(struct snd_opl3 *); 279 280 spinlock_t reg_lock; 281 struct snd_card *card; /* The card that this belongs to */ 282 int used; /* usage flag - exclusive */ 283 unsigned char fm_mode; /* OPL mode, see SNDRV_DM_FM_MODE_XXX */ 284 unsigned char rhythm; /* percussion mode flag */ 285 unsigned char max_voices; /* max number of voices */ 286 #if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE) 287 #define SNDRV_OPL3_MODE_SYNTH 0 /* OSS - voices allocated by application */ 288 #define SNDRV_OPL3_MODE_SEQ 1 /* ALSA - driver handles voice allocation */ 289 int synth_mode; /* synth mode */ 290 int seq_client; 291 292 struct snd_seq_device *seq_dev; /* sequencer device */ 293 struct snd_midi_channel_set * chset; 294 295 #ifdef CONFIG_SND_SEQUENCER_OSS 296 struct snd_seq_device *oss_seq_dev; /* OSS sequencer device */ 297 struct snd_midi_channel_set * oss_chset; 298 #endif 299 300 struct snd_seq_kinstr_ops fm_ops; 301 struct snd_seq_kinstr_list *ilist; 302 303 struct snd_opl3_voice voices[MAX_OPL3_VOICES]; /* Voices (OPL3 'channel') */ 304 int use_time; /* allocation counter */ 305 306 unsigned short connection_reg; /* connection reg shadow */ 307 unsigned char drum_reg; /* percussion reg shadow */ 308 309 spinlock_t voice_lock; /* Lock for voice access */ 310 311 struct timer_list tlist; /* timer for note-offs and effects */ 312 int sys_timer_status; /* system timer run status */ 313 spinlock_t sys_timer_lock; /* Lock for system timer access */ 314 #endif 315 struct mutex access_mutex; /* locking */ 316 }; 317 318 /* opl3.c */ 319 void snd_opl3_interrupt(struct snd_hwdep * hw); 320 int snd_opl3_new(struct snd_card *card, unsigned short hardware, 321 struct snd_opl3 **ropl3); 322 int snd_opl3_init(struct snd_opl3 *opl3); 323 int snd_opl3_create(struct snd_card *card, 324 unsigned long l_port, unsigned long r_port, 325 unsigned short hardware, 326 int integrated, 327 struct snd_opl3 ** opl3); 328 int snd_opl3_timer_new(struct snd_opl3 * opl3, int timer1_dev, int timer2_dev); 329 int snd_opl3_hwdep_new(struct snd_opl3 * opl3, int device, int seq_device, 330 struct snd_hwdep ** rhwdep); 331 332 /* opl3_synth */ 333 int snd_opl3_open(struct snd_hwdep * hw, struct file *file); 334 int snd_opl3_ioctl(struct snd_hwdep * hw, struct file *file, 335 unsigned int cmd, unsigned long arg); 336 int snd_opl3_release(struct snd_hwdep * hw, struct file *file); 337 338 void snd_opl3_reset(struct snd_opl3 * opl3); 339 340 #endif /* __SOUND_OPL3_H */ 341
