xref: /netbsd-src/sys/dev/isa/ymvar.h (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1 /*	$NetBSD: ymvar.h,v 1.6 2000/03/23 07:01:36 thorpej Exp $	*/
2 
3 /*-
4  * Copyright (c) 1999 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
84 #define YM_MIDI_LVL		1
85 #define YM_CD_LVL		2
86 #define YM_LINE_LVL		3
87 #define YM_SPEAKER_LVL		4
88 #define YM_MIC_LVL		5
89 #define YM_MONITOR_LVL		6
90 #define YM_DAC_MUTE		7
91 #define YM_MIDI_MUTE		8
92 #define YM_CD_MUTE		9
93 #define YM_LINE_MUTE		10
94 #define YM_SPEAKER_MUTE		11
95 #define YM_MIC_MUTE		12
96 #define YM_MONITOR_MUTE		13
97 
98 #define YM_REC_LVL		14
99 #define YM_RECORD_SOURCE	15
100 
101 #define YM_OUTPUT_LVL		16
102 #define YM_OUTPUT_MUTE		17
103 
104 #define YM_MASTER_EQMODE	18
105 #define YM_MASTER_TREBLE	19
106 #define YM_MASTER_BASS		20
107 #define YM_MASTER_WIDE		21
108 
109 #ifndef AUDIO_NO_POWER_CTL
110 #define YM_PWR_MODE		22
111 #define YM_PWR_TIMEOUT		23
112 #endif
113 
114 /* Classes - don't change this without looking at mixer_classes array */
115 #ifdef AUDIO_NO_POWER_CTL
116 #define YM_CLASS_TOP		22
117 #else
118 #define YM_CLASS_TOP		24
119 #endif
120 #define YM_INPUT_CLASS		(YM_CLASS_TOP + 0)
121 #define YM_RECORD_CLASS		(YM_CLASS_TOP + 1)
122 #define YM_OUTPUT_CLASS		(YM_CLASS_TOP + 2)
123 #define YM_MONITOR_CLASS	(YM_CLASS_TOP + 3)
124 #define YM_EQ_CLASS		(YM_CLASS_TOP + 4)
125 #ifndef AUDIO_NO_POWER_CTL
126 #define YM_PWR_CLASS		(YM_CLASS_TOP + 5)
127 #endif
128 
129 /* XXX should be in <sys/audioio.h> */
130 #define AudioNmode		"mode"
131 #define AudioNdesktop		"desktop"
132 #define AudioNlaptop		"laptop"
133 #define AudioNsubnote		"subnote"
134 #define AudioNhifi		"hifi"
135 
136 #ifndef AUDIO_NO_POWER_CTL
137 #define AudioCpower		"power"
138 #define AudioNsave		"save"
139 #define AudioNtimeout		"timeout"
140 #define AudioNpowerdown		"powerdown"
141 #define AudioNpowersave		"powersave"
142 #define AudioNnosave		"nosave"
143 #endif
144 
145 
146 struct ym_softc {
147 	struct	ad1848_isa_softc sc_ad1848;
148 #define ym_irq		sc_ad1848.sc_irq
149 #define ym_playdrq	sc_ad1848.sc_playdrq
150 #define ym_recdrq	sc_ad1848.sc_recdrq
151 
152 	bus_space_tag_t sc_iot;		/* tag */
153 	bus_space_handle_t sc_ioh;	/* handle */
154 	isa_chipset_tag_t sc_ic;
155 
156 	bus_space_handle_t sc_controlioh;
157 	bus_space_handle_t sc_opl_ioh;
158 	bus_space_handle_t sc_sb_ioh;	/* only used to disable it */
159 
160 	struct callout sc_powerdown_ch;
161 
162 	int  master_mute, mic_mute;
163 	struct ad1848_volume master_gain;
164 	u_int8_t mic_gain;
165 
166 	u_int8_t sc_external_sources;	/* non-zero value prevents power down */
167 
168 	u_int8_t sc_version;		/* hardware version */
169 
170 	/* 3D encehamcement */
171 	u_int8_t sc_eqmode;
172 	struct ad1848_volume sc_treble, sc_bass, sc_wide;
173 #define YM_EQ_OFF(v)	\
174 	((v)->left < (AUDIO_MAX_GAIN + 1) / (SA3_3D_BITS + 1) &&	\
175 	(v)->right < (AUDIO_MAX_GAIN + 1) / (SA3_3D_BITS + 1))
176 
177 	struct device *sc_audiodev;
178 
179 #if NMPU_YM > 0
180 	bus_space_handle_t sc_mpu_ioh;
181 	struct device *sc_mpudev;
182 #endif
183 
184 #ifndef AUDIO_NO_POWER_CTL
185 	enum ym_pow_mode {
186 		YM_POWER_POWERDOWN, YM_POWER_POWERSAVE, YM_POWER_NOSAVE
187 	} sc_pow_mode;
188 	int	sc_pow_timeout;
189 
190 	u_int8_t sc_codec_scan[0x20];
191 #define YM_SAVE_REG_MAX	SA3_HVOL_INTR_CNF
192 	u_int8_t sc_sa3_scan[YM_SAVE_REG_MAX + 1];
193 
194 	u_int16_t sc_on_blocks;
195 	u_int16_t sc_turning_off;
196 
197 	int	sc_in_power_ctl;
198 #define YM_POWER_CTL_INUSE	1
199 #define YM_POWER_CTL_WANTED	2
200 #endif /* not AUDIO_NO_POWER_CTL */
201 };
202 
203 #ifndef AUDIO_NO_POWER_CTL
204 /* digital */
205 #define YM_POWER_CODEC_P	SA3_DPWRDWN_WSS_P
206 #define YM_POWER_CODEC_R	SA3_DPWRDWN_WSS_R
207 #define YM_POWER_OPL3		SA3_DPWRDWN_FM
208 #define YM_POWER_MPU401		SA3_DPWRDWN_MPU
209 #define YM_POWER_JOYSTICK	SA3_DPWRDWN_JOY
210 /* analog */
211 #define YM_POWER_3D		(SA3_APWRDWN_WIDE << 8)
212 #define YM_POWER_CODEC_DA	(SA3_APWRDWN_DA << 8)
213 #define YM_POWER_CODEC_AD	(SA3_APWRDWN_AD << 8)
214 #define YM_POWER_OPL3_DA	(SA3_APWRDWN_FMDAC << 8)
215 /* pseudo */
216 #define YM_POWER_CODEC_CTL	0x4000
217 #define YM_POWER_EXT_SRC	0x8000
218 #define YM_POWER_CODEC_PSEUDO	(YM_POWER_CODEC_CTL | YM_POWER_EXT_SRC)
219 
220 #define YM_POWER_CODEC_DIGITAL	\
221 		(YM_POWER_CODEC_P | YM_POWER_CODEC_R | YM_POWER_CODEC_CTL)
222 /* 3D enhance is passive */
223 #define YM_POWER_ACTIVE		(0xffff & ~YM_POWER_3D)
224 
225 /* external input sources */
226 #define YM_XS_CD	1
227 #define YM_XS_LINE	2
228 #define YM_XS_SPEAKER	4
229 
230 #if YM_CD_MUTE + 1 != YM_LINE_MUTE || YM_CD_MUTE + 2 != YM_SPEAKER_MUTE
231  #error YM_CD_MUTE, YM_LINE_MUTE and YM_SPEAKER_MUTE should be contiguous
232 #endif
233 #define YM_MIXER_TO_XS(m)	(1 << ((m) - YM_CD_MUTE))
234 
235 #ifdef _KERNEL
236 void	ym_power_ctl __P((struct ym_softc *, int, int));
237 #endif
238 #endif /* not AUDIO_NO_POWER_CTL */
239 
240 #ifdef _KERNEL
241 void	ym_attach __P((struct ym_softc *));
242 #endif
243