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