xref: /netbsd/sys/dev/isa/ymvar.h (revision bf9ec67e)
1 /*	$NetBSD: ymvar.h,v 1.8 2002/03/10 13:57:11 itohy Exp $	*/
2 
3 /*-
4  * Copyright (c) 1999-2000, 2002 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by ITOH Yasufumi.
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 /*
40  * Copyright (c) 1994 John Brezak
41  * Copyright (c) 1991-1993 Regents of the University of California.
42  * All rights reserved.
43  *
44  * Redistribution and use in source and binary forms, with or without
45  * modification, are permitted provided that the following conditions
46  * are met:
47  * 1. Redistributions of source code must retain the above copyright
48  *    notice, this list of conditions and the following disclaimer.
49  * 2. Redistributions in binary form must reproduce the above copyright
50  *    notice, this list of conditions and the following disclaimer in the
51  *    documentation and/or other materials provided with the distribution.
52  * 3. All advertising materials mentioning features or use of this software
53  *    must display the following acknowledgement:
54  *	This product includes software developed by the Computer Systems
55  *	Engineering Group at Lawrence Berkeley Laboratory.
56  * 4. Neither the name of the University nor of the Laboratory may be used
57  *    to endorse or promote products derived from this software without
58  *    specific prior written permission.
59  *
60  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
61  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
62  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
63  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
64  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
65  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
66  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
67  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
68  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
69  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
70  * SUCH DAMAGE.
71  *
72  */
73 
74 #include <sys/callout.h>
75 
76 /*
77  *  Original code from OpenBSD.
78  */
79 
80 /*
81  * Mixer devices
82  */
83 #define YM_DAC_LVL		0	/* inputs.dac */
84 #define YM_MIDI_LVL		1	/* inputs.midi */
85 #define YM_CD_LVL		2	/* inputs.cd */
86 #define YM_LINE_LVL		3	/* inputs.line */
87 #define YM_SPEAKER_LVL		4	/* inputs.speaker */
88 #define YM_MIC_LVL		5	/* inputs.mic */
89 #define YM_MONITOR_LVL		6	/* monitor.monitor */
90 #define YM_DAC_MUTE		7	/* inputs.dac.mute */
91 #define YM_MIDI_MUTE		8	/* inputs.midi.mute */
92 #define YM_CD_MUTE		9	/* inputs.cd.mute */
93 #define YM_LINE_MUTE		10	/* inputs.line.mute */
94 #define YM_SPEAKER_MUTE		11	/* inputs.speaker.mute */
95 #define YM_MIC_MUTE		12	/* inputs.mic.mute */
96 #define YM_MONITOR_MUTE		13	/* monitor.monitor.mute */
97 
98 #define YM_REC_LVL		14	/* record.record */
99 #define YM_RECORD_SOURCE	15	/* record.record.source */
100 
101 #define YM_OUTPUT_LVL		16	/* outputs.master */
102 #define YM_OUTPUT_MUTE		17	/* outputs.master.mute */
103 
104 #ifndef AUDIO_NO_POWER_CTL
105 #define YM_PWR_MODE		18	/* power.save */
106 #define YM_PWR_TIMEOUT		19	/* power.save.timeout */
107 #endif
108 
109 /* Classes - don't change this without looking at mixer_classes array */
110 #ifdef AUDIO_NO_POWER_CTL
111 #define YM_CLASS_TOP		18
112 #else
113 #define YM_CLASS_TOP		20
114 #endif
115 #define YM_INPUT_CLASS		(YM_CLASS_TOP + 0)
116 #define YM_RECORD_CLASS		(YM_CLASS_TOP + 1)
117 #define YM_OUTPUT_CLASS		(YM_CLASS_TOP + 2)
118 #define YM_MONITOR_CLASS	(YM_CLASS_TOP + 3)
119 #ifdef AUDIO_NO_POWER_CTL
120 #define YM_EQ_CLASS		(YM_CLASS_TOP + 4)
121 #else
122 #define YM_PWR_CLASS		(YM_CLASS_TOP + 4)
123 #define YM_EQ_CLASS		(YM_CLASS_TOP + 5)
124 #endif
125 
126 /* equalizer is SA3 only */
127 #define YM_MASTER_EQMODE	(YM_EQ_CLASS+1)	/* equalization.mode */
128 #define YM_MASTER_TREBLE	(YM_EQ_CLASS+2)	/* equalization.treble */
129 #define YM_MASTER_BASS		(YM_EQ_CLASS+3)	/* equalization.bass */
130 #define YM_MASTER_WIDE		(YM_EQ_CLASS+4)	/* equalization.surround */
131 
132 #define YM_MIXER_SA3_ONLY(m)	((m) >= YM_EQ_CLASS)
133 
134 /* XXX should be in <sys/audioio.h> */
135 #define AudioNdesktop		"desktop"
136 #define AudioNlaptop		"laptop"
137 #define AudioNsubnote		"subnote"
138 #define AudioNhifi		"hifi"
139 
140 #ifndef AUDIO_NO_POWER_CTL
141 #define AudioCpower		"power"
142 #define AudioNsave		"save"
143 #define AudioNtimeout		"timeout"
144 #define AudioNpowerdown		"powerdown"
145 #define AudioNpowersave		"powersave"
146 #define AudioNnosave		"nosave"
147 #endif
148 
149 
150 struct ym_softc {
151 	struct	ad1848_isa_softc sc_ad1848;
152 #define ym_irq		sc_ad1848.sc_irq
153 #define ym_playdrq	sc_ad1848.sc_playdrq
154 #define ym_recdrq	sc_ad1848.sc_recdrq
155 
156 	bus_space_tag_t sc_iot;		/* tag */
157 	bus_space_handle_t sc_ioh;	/* handle */
158 	isa_chipset_tag_t sc_ic;
159 
160 	bus_space_handle_t sc_controlioh;
161 	bus_space_handle_t sc_opl_ioh;
162 	bus_space_handle_t sc_sb_ioh;	/* only used to disable it */
163 
164 	struct callout sc_powerdown_ch;
165 
166 	int  master_mute, mic_mute;
167 	struct ad1848_volume master_gain;
168 	u_int8_t mic_gain;
169 
170 	u_int8_t sc_external_sources;	/* non-zero value prevents power down */
171 
172 	u_int8_t sc_version;		/* hardware version */
173 #define YM_IS_SA3(sc)	((sc)->sc_version > SA3_MISC_VER_711)
174 
175 	/* 3D encehamcement */
176 	u_int8_t sc_eqmode;
177 	struct ad1848_volume sc_treble, sc_bass, sc_wide;
178 	/*
179 	 * The equalizer of OPL3-SA3 is ``flat'' if it is turned off.
180 	 * For compatibility with other drivers, however, make it flat
181 	 * if it is set at center (or smaller).
182 	 */
183 #define YM_EQ_REDUCE_BIT	1	/* use only 128 values from 256 */
184 #define YM_EQ_FLAT_OFFSET	128	/* center */
185 #define YM_EQ_EXPAND_VALUE(v)	\
186     ((v) < YM_EQ_FLAT_OFFSET? 0 : ((v) - YM_EQ_FLAT_OFFSET) << YM_EQ_REDUCE_BIT)
187 
188 #define YM_3D_ON_MIN	((AUDIO_MAX_GAIN + 1) / (SA3_3D_BITS + 1))
189 #define YM_EQ_ON_MIN	((YM_3D_ON_MIN >> YM_EQ_REDUCE_BIT) + YM_EQ_FLAT_OFFSET)
190 
191 #define YM_EQ_OFF(v)	((v)->left < YM_EQ_ON_MIN && (v)->right < YM_EQ_ON_MIN)
192 #define YM_WIDE_OFF(v)	((v)->left < YM_3D_ON_MIN && (v)->right < YM_3D_ON_MIN)
193 
194 	struct device *sc_audiodev;
195 
196 #if NMPU_YM > 0
197 	bus_space_handle_t sc_mpu_ioh;
198 	struct device *sc_mpudev;
199 #endif
200 
201 #ifndef AUDIO_NO_POWER_CTL
202 	enum ym_pow_mode {
203 		YM_POWER_POWERDOWN, YM_POWER_POWERSAVE, YM_POWER_NOSAVE
204 	} sc_pow_mode;
205 	int	sc_pow_timeout;
206 
207 	u_int8_t sc_codec_scan[0x20];
208 #define YM_SAVE_REG_MAX_SA3	SA3_HVOL_INTR_CNF
209 #define YM_SAVE_REG_MAX_SA2	SA3_DMA_CNT_REC_HIGH
210 	u_int8_t sc_sa3_scan[YM_SAVE_REG_MAX_SA3 + 1];
211 
212 	u_int16_t sc_on_blocks;
213 	u_int16_t sc_turning_off;
214 
215 	int	sc_in_power_ctl;
216 #define YM_POWER_CTL_INUSE	1
217 #define YM_POWER_CTL_WANTED	2
218 #endif /* not AUDIO_NO_POWER_CTL */
219 };
220 
221 #ifndef AUDIO_NO_POWER_CTL
222 /* digital */
223 #define YM_POWER_CODEC_P	SA3_DPWRDWN_WSS_P
224 #define YM_POWER_CODEC_R	SA3_DPWRDWN_WSS_R
225 #define YM_POWER_OPL3		SA3_DPWRDWN_FM
226 #define YM_POWER_MPU401		SA3_DPWRDWN_MPU
227 #define YM_POWER_JOYSTICK	SA3_DPWRDWN_JOY
228 /* analog */
229 #define YM_POWER_3D		(SA3_APWRDWN_WIDE << 8)
230 #define YM_POWER_CODEC_DA	(SA3_APWRDWN_DA << 8)
231 #define YM_POWER_CODEC_AD	(SA3_APWRDWN_AD << 8)
232 #define YM_POWER_OPL3_DA	(SA3_APWRDWN_FMDAC << 8)
233 /* pseudo */
234 #define YM_POWER_CODEC_CTL	0x4000
235 #define YM_POWER_EXT_SRC	0x8000
236 #define YM_POWER_CODEC_PSEUDO	(YM_POWER_CODEC_CTL | YM_POWER_EXT_SRC)
237 
238 #define YM_POWER_CODEC_DIGITAL	\
239 		(YM_POWER_CODEC_P | YM_POWER_CODEC_R | YM_POWER_CODEC_CTL)
240 /* 3D enhance is passive */
241 #define YM_POWER_ACTIVE		(0xffff & ~YM_POWER_3D)
242 
243 /* external input sources */
244 #define YM_XS_CD	1
245 #define YM_XS_LINE	2
246 #define YM_XS_SPEAKER	4
247 #define YM_XS_MIC	8
248 
249 #if YM_CD_MUTE + 1 != YM_LINE_MUTE || YM_CD_MUTE + 2 != YM_SPEAKER_MUTE || YM_CD_MUTE + 3 != YM_MIC_MUTE
250  #error YM_CD_MUTE, YM_LINE_MUTE and YM_SPEAKER_MUTE should be contiguous
251 #endif
252 #define YM_MIXER_TO_XS(m)	(1 << ((m) - YM_CD_MUTE))
253 
254 #ifdef _KERNEL
255 void	ym_power_ctl __P((struct ym_softc *, int, int));
256 #endif
257 #endif /* not AUDIO_NO_POWER_CTL */
258 
259 #ifdef _KERNEL
260 void	ym_attach __P((struct ym_softc *));
261 #endif
262