xref: /netbsd/sys/dev/ic/oplreg.h (revision bf9ec67e)
1 /*	$NetBSD: oplreg.h,v 1.3 1998/11/25 22:17:06 augustss Exp $	*/
2 
3 /*
4  * Copyright (c) 1997 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Lennart Augustsson (augustss@netbsd.org).
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /* Offsets from base address */
40 #define OPL_L				0
41 #define OPL_R				2
42 
43 /* Offsets from base+[OPL_L|OPL_R] */
44 #define OPL_STATUS			0
45 #define   OPL_STATUS_IRQ		0x80
46 #define   OPL_STATUS_FT1		0x40
47 #define   OPL_STATUS_FT2		0x20
48 #define   OPL_STATUS_MASK		0xE0
49 #define OPL_ADDR			0
50 #define OPL_DATA			1
51 
52 #define OPL_TEST			0x01
53 #define   OPL_ENABLE_WAVE_SELECT	0x20
54 
55 #define OPL_TIMER1			0x02
56 #define OPL_TIMER2			0x03
57 
58 #define OPL_TIMER_CONTROL		0x04	/* Left */
59 #define   OPL_TIMER1_START		0x01
60 #define   OPL_TIMER2_START		0x02
61 #define   OPL_TIMER2_MASK		0x20
62 #define   OPL_TIMER1_MASK		0x40
63 #define   OPL_IRQ_RESET			0x80
64 
65 #define OPL_CONNECTION_SELECT		0x04	/* Right */
66 #define   OPL_NOCONNECTION		0x00
67 #define   OPL_R_4OP_0			0x01
68 #define   OPL_R_4OP_1			0x02
69 #define   OPL_R_4OP_2			0x04
70 #define   OPL_L_4OP_0			0x08
71 #define   OPL_L_4OP_1			0x10
72 #define   OPL_L_4OP_2			0x20
73 
74 #define OPL_MODE			0x05	/* Right */
75 #define   OPL3_ENABLE			0x01
76 #define   OPL4_ENABLE			0x02
77 
78 #define OPL_KBD_SPLIT			0x08	/* Left */
79 #define   OPL_KEYBOARD_SPLIT		0x40
80 #define   OPL_COMPOSITE_SINE_WAVE_MODE	0x80
81 
82 #define OPL_PERCUSSION			0xbd	/* Left */
83 #define   OPL_NOPERCUSSION		0x00
84 #define   OPL_HIHAT			0x01
85 #define   OPL_CYMBAL			0x02
86 #define   OPL_TOMTOM			0x04
87 #define   OPL_SNAREDRUM			0x08
88 #define   OPL_BASSDRUM			0x10
89 #define	  OPL_PERCUSSION_ENABLE		0x20
90 #define   OPL_VIBRATO_DEPTH		0x40
91 #define   OPL_TREMOLO_DEPTH		0x80
92 
93 /*
94  * Offsets to the register banks for operators.
95  */
96 /* AM/VIB/EG/KSR/Multiple (0x20 to 0x35) */
97 #define OPL_AM_VIB			0x20
98 #define   OPL_KSR			0x10
99 #define   OPL_SUSTAIN			0x20
100 #define   OPL_VIBRATO			0x40
101 #define   OPL_TREMOLO			0x80
102 #define   OPL_MULTIPLE_MASK		0x0f
103 
104 /* KSL/Total level (0x40 to 0x55) */
105 #define OPL_KSL_LEVEL			0x40
106 #define   OPL_KSL_MASK			0xc0	/* Envelope scaling bits */
107 #define   OPL_TOTAL_LEVEL_MASK		0x3f	/* Strength (volume) of OP */
108 
109 /* Attack / Decay rate (0x60 to 0x75) */
110 #define OPL_ATTACK_DECAY		0x60
111 #define   OPL_ATTACK_MASK		0xf0
112 #define   DECAY_MASK			0x0f
113 
114 /* Sustain level / Release rate (0x80 to 0x95) */
115 #define OPL_SUSTAIN_RELEASE		0x80
116 #define   OPL_SUSTAIN_MASK		0xf0
117 #define   OPL_RELEASE_MASK		0x0f
118 
119 /* Wave select (0xE0 to 0xF5) */
120 #define OPL_WAVE_SELECT			0xe0
121 
122 #define OPL_MAXREG			0xf5
123 
124 /*
125  * Offsets to the register banks for voices.
126  */
127 /* F-Number low bits (0xA0 to 0xA8). */
128 #define OPL_FNUM_LOW			0xa0
129 
130 /* F-number high bits / Key on / Block (octave) (0xB0 to 0xB8) */
131 #define OPL_KEYON_BLOCK			0xb0
132 #define	  OPL_KEYON_BIT			0x20
133 #define	  OPL_BLOCKNUM_MASK		0x1c
134 #define   OPL_FNUM_HIGH_MASK		0x03
135 
136 /* Feedback / Connection (0xc0 to 0xc8) */
137 #define OPL_FEEDBACK_CONNECTION		0xc0
138 #define   OPL_FEEDBACK_MASK		0x0e
139 #define   OPL_CONNECTION_BIT		0x01
140 #define   OPL_STEREO_BITS		0x30	/* OPL-3 only */
141 #define     OPL_VOICE_TO_LEFT		0x10
142 #define     OPL_VOICE_TO_RIGHT		0x20
143 
144 #define OPL2_NVOICE 9
145 #define OPL3_NVOICE 18
146