/*-
* Copyright (c) 1999-2002, 2008 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by ITOH Yasufumi.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*
* Copyright (c) 1998 Constantine Sapuntzakis. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*
* Mute all external sources. If you change this, you must
* also change the initial value of sc->sc_external_sources
* (currently 0 --- no external source is active).
*/
sc->mic_mute = 1;
ym_mute(sc, SA3_MIC_VOL, sc->mic_mute);
ad1848_mute_channel(ac, AD1848_AUX1_CHANNEL, MUTE_ALL); /* CD */
ad1848_mute_channel(ac, AD1848_LINE_CHANNEL, MUTE_ALL); /* line */
ac->mute[AD1848_AUX1_CHANNEL] = MUTE_ALL;
ac->mute[AD1848_LINE_CHANNEL] = MUTE_ALL;
/* speaker is muted by default */
/* We use only one IRQ (IRQ-A). */
ym_write(sc, SA3_IRQ_CONF, SA3_IRQ_CONF_MPU_A | SA3_IRQ_CONF_WSS_A);
ym_write(sc, SA3_HVOL_INTR_CNF, SA3_HVOL_INTR_CNF_A);
/* audio at ym attachment */
sc->sc_audiodev = audio_attach_mi(&ym_hw_if, ac, ac->sc_dev);
/* opl at ym attachment */
if (sc->sc_opl_ioh) {
arg.type = AUDIODEV_TYPE_OPL;
arg.hwif = 0;
arg.hdl = 0;
(void)config_found(ac->sc_dev, &arg, audioprint,
CFARGS(.iattr = "ym"));
}
if (!pmf_device_register(ac->sc_dev, ym_suspend, ym_resume)) {
aprint_error_dev(ac->sc_dev,
"cannot set power mgmt handler\n");
}
#endif
/* Set tone control to the default position. */
mctl.un.value.num_channels = 1;
mctl.un.value.level[AUDIO_MIXER_LEVEL_MONO] = YM_DEFAULT_TREBLE;
mctl.dev = YM_MASTER_TREBLE;
ym_mixer_set_port(sc, &mctl);
mctl.un.value.level[AUDIO_MIXER_LEVEL_MONO] = YM_DEFAULT_BASS;
mctl.dev = YM_MASTER_BASS;
ym_mixer_set_port(sc, &mctl);
/* Unmute the output now if the chip is on. */
#ifndef AUDIO_NO_POWER_CTL
if (sc->sc_on_blocks & YM_POWER_ACTIVE)
#endif
{
ym_mute(sc, SA3_VOL_L, sc->master_mute);
ym_mute(sc, SA3_VOL_R, sc->master_mute);
}
}
static inline int
ym_read(struct ym_softc *sc, int reg)
{
/* OPL3-SA3 */
/* Figure out which part can be power down. */
dpd = SA3_DPWRDWN_SB /* we never use SB */
#if NMPU_YM > 0
| (sc->sc_mpu_ioh ? 0 : SA3_DPWRDWN_MPU)
#else
| SA3_DPWRDWN_MPU
#endif
#if NJOY == 0
| SA3_DPWRDWN_JOY
#endif
| SA3_DPWRDWN_PNP /* ISA Plug and Play is done */
/*
* The master clock is for external wavetable synthesizer
* OPL4-ML (YMF704) or OPL4-ML2 (YMF721),
* and is currently unused.
*/
| SA3_DPWRDWN_MCLKO;
apd = SA3_APWRDWN_SBDAC; /* we never use SB */
/* Power down OPL3 if not attached. */
if (sc->sc_opl_ioh == 0) {
dpd |= SA3_DPWRDWN_FM;
apd |= SA3_APWRDWN_FMDAC;
}
/* CODEC is always attached. */
/* Power down unused digital parts. */
ym_write(sc, SA3_DPWRDWN, dpd);
/* Power down unused analog parts. */
ym_write(sc, SA3_APWRDWN, apd);
}
/*
* Read current setting of master volume from hardware
* and update the software value if changed.
* [SA3] This function clears hardware volume interrupt.
*/
static void
ym_hvol_to_master_gain(struct ym_softc *sc)
{
u_int prevval, val;
int changed;
case YM_MASTER_TREBLE:
ym_set_3d(sc, cp, &sc->sc_treble, SA3_3D_TREBLE);
goto out;
case YM_MASTER_BASS:
ym_set_3d(sc, cp, &sc->sc_bass, SA3_3D_BASS);
goto out;
case YM_MASTER_WIDE:
ym_set_3d(sc, cp, &sc->sc_wide, SA3_3D_WIDE);
goto out;
#ifndef AUDIO_NO_POWER_CTL
case YM_PWR_MODE:
if ((unsigned) cp->un.ord > YM_POWER_NOSAVE)
error = EINVAL;
else
sc->sc_pow_mode = cp->un.ord;
goto out;
case YM_PWR_TIMEOUT:
if (cp->un.value.num_channels != 1)
error = EINVAL;
else
sc->sc_pow_timeout =
cp->un.value.level[AUDIO_MIXER_LEVEL_MONO];
goto out;
/*
* Needs power-up to hear external sources.
*/
case YM_CD_MUTE:
case YM_LINE_MUTE:
case YM_SPEAKER_MUTE:
case YM_MIC_MUTE:
extsources = YM_MIXER_TO_XS(cp->dev);
if (cp->un.ord) {
if ((sc->sc_external_sources &= ~extsources) == 0) {
/*
* All the external sources are muted
* --- no need to keep the chip on.
*/
ym_power_ctl(sc, YM_POWER_EXT_SRC, 0);
DPRINTF(("%s: ym_mixer_set_port: off for ext\n",
DVNAME(sc)));
}
} else {
/* mute off - power-up the chip */
sc->sc_external_sources |= extsources;
ym_power_ctl(sc, YM_POWER_EXT_SRC, 1);
DPRINTF(("%s: ym_mixer_set_port: on for ext\n",
DVNAME(sc)));
}
break; /* fall to ad1848_mixer_set_port() */
/*
* Power on/off the playback part for monitoring.
*/
case YM_MONITOR_MUTE:
if ((ac->open_mode & (FREAD | FWRITE)) == FREAD)
ym_power_ctl(sc, YM_POWER_CODEC_P | YM_POWER_CODEC_DA,
cp->un.ord == 0);
break; /* fall to ad1848_mixer_set_port() */
#endif
}
ac = addr;
sc = ac->parent;
/* SA2 doesn't have equalizer */
if (!YM_IS_SA3(sc) && YM_MIXER_SA3_ONLY(dip->index))
return ENXIO;
dip->next = dip->prev = AUDIO_MIXER_LAST;
switch(dip->index) {
case YM_INPUT_CLASS:
case YM_OUTPUT_CLASS:
case YM_MONITOR_CLASS:
case YM_RECORD_CLASS:
#ifndef AUDIO_NO_POWER_CTL
case YM_PWR_CLASS:
#endif
case YM_EQ_CLASS:
dip->type = AUDIO_MIXER_CLASS;
dip->mixer_class = dip->index;
strcpy(dip->label.name,
mixer_classes[dip->index - YM_INPUT_CLASS]);
break;
case YM_DAC_LVL:
case YM_MIDI_LVL:
case YM_CD_LVL:
case YM_LINE_LVL:
case YM_SPEAKER_LVL:
case YM_MIC_LVL:
case YM_MONITOR_LVL:
dip->type = AUDIO_MIXER_VALUE;
if (dip->index == YM_MONITOR_LVL)
dip->mixer_class = YM_MONITOR_CLASS;
else
dip->mixer_class = YM_INPUT_CLASS;
DPRINTF(("%s: ym_save_codec_regs\n", DVNAME(sc)));
ac = &sc->sc_ad1848.sc_ad1848;
for (i = 0; i <= 0x1f; i++)
sc->sc_codec_scan[i] = ad_read(ac, i);
}
static void
ym_restore_codec_regs(struct ym_softc *sc)
{
struct ad1848_softc *ac;
int i, t;
DPRINTF(("%s: ym_restore_codec_regs\n", DVNAME(sc)));
ac = &sc->sc_ad1848.sc_ad1848;
for (i = 0; i <= 0x1f; i++) {
/*
* Wait til the chip becomes ready.
* This is required after suspend/resume.
*/
for (t = 0;
t < 100000 && ADREAD(ac, AD1848_IADDR) & SP_IN_INIT; t++)
;
#ifdef AUDIO_DEBUG
if (t)
DPRINTF(("%s: ym_restore_codec_regs: reg %d, t %d\n",
DVNAME(sc), i, t));
#endif
ad_write(ac, i, sc->sc_codec_scan[i]);
}
}
/*
* Save and restore the state on suspending / resumning.
*
* XXX This is not complete.
* Currently only the parameters, such as output gain, are restored.
* DMA state should also be restored. FIXME.
*/
static bool
ym_suspend(device_t self, const pmf_qual_t *qual)
{
struct ym_softc *sc = device_private(self);
/*
* suspending...
*/
callout_halt(&sc->sc_powerdown_ch,
&sc->sc_ad1848.sc_ad1848.sc_intr_lock);
if (sc->sc_turning_off)
ym_powerdown_blocks(sc);
/*
* Save CODEC registers.
* Note that the registers read incorrect
* if the CODEC part is in power-down mode.
*/
if (sc->sc_on_blocks & YM_POWER_CODEC_DIGITAL)
ym_save_codec_regs(sc);
/*
* Save OPL3-SA3 control registers and power-down the chip.
* Note that the registers read incorrect
* if the chip is in global power-down mode.
*/
sc->sc_sa3_scan[SA3_PWR_MNG] = ym_read(sc, SA3_PWR_MNG);
if (sc->sc_on_blocks)
ym_chip_powerdown(sc);
mutex_spin_exit(&sc->sc_ad1848.sc_ad1848.sc_intr_lock);
return true;
}
static bool
ym_resume(device_t self, const pmf_qual_t *qual)
{
struct ym_softc *sc = device_private(self);
int i, xmax;
/* Restore control registers. */
xmax = YM_IS_SA3(sc)? YM_SAVE_REG_MAX_SA3 : YM_SAVE_REG_MAX_SA2;
for (i = SA3_PWR_MNG + 1; i <= xmax; i++) {
if (i == SA3_SB_SCAN || i == SA3_SB_SCAN_DATA ||
i == SA3_DPWRDWN)
continue;
ym_write(sc, i, sc->sc_sa3_scan[i]);
}
if (flags != 0) {
parts = 0;
if (flags & FREAD) {
parts |= YM_POWER_CODEC_R | YM_POWER_CODEC_AD;
if (ac->mute[AD1848_MONITOR_CHANNEL] == 0)
parts |= YM_POWER_CODEC_P | YM_POWER_CODEC_DA;
}
if (flags & FWRITE)
parts |= YM_POWER_CODEC_P | YM_POWER_CODEC_DA;
} else
parts = YM_POWER_CODEC_P | YM_POWER_CODEC_R |
YM_POWER_CODEC_DA | YM_POWER_CODEC_AD;
ym_power_ctl(sc, parts, flags);
return 0;
}
/*
* Enter Power Save mode or Global Power Down mode.
* Total dissipation becomes 5mA and 10uA (typ.) respective.
*/
static void
ym_chip_powerdown(struct ym_softc *sc)
{
int i, xmax;
/* Be sure not to change the state of the chip. Save it first. */
sv = bus_space_read_1(sc->sc_iot, sc->sc_controlioh, SA3_CTL_INDEX);
parts = sc->sc_turning_off;
if (on_blocks & ~parts & YM_POWER_CODEC_CTL)
parts &= ~(YM_POWER_CODEC_P | YM_POWER_CODEC_R);
if (parts & YM_POWER_CODEC_CTL) {
if ((on_blocks & YM_POWER_CODEC_P) == 0)
parts |= YM_POWER_CODEC_P;
if ((on_blocks & YM_POWER_CODEC_R) == 0)
parts |= YM_POWER_CODEC_R;
}
parts &= ~YM_POWER_CODEC_PSEUDO;
/* If CODEC is being off, save the state. */
if ((sc->sc_on_blocks & YM_POWER_CODEC_DIGITAL) &&
(sc->sc_on_blocks & ~sc->sc_turning_off &
YM_POWER_CODEC_DIGITAL) == 0)
ym_save_codec_regs(sc);
if (YM_IS_SA3(sc)) {
/* OPL3-SA3 */
ym_write(sc, SA3_DPWRDWN,
ym_read(sc, SA3_DPWRDWN) | (u_int8_t) parts);
ym_write(sc, SA3_APWRDWN,
ym_read(sc, SA3_APWRDWN) | (parts >> 8));
} else {
/* OPL3-SA2 (only OPL3 can be off partially) */
if (parts & YM_POWER_OPL3)
ym_write(sc, SA3_PWR_MNG,
ym_read(sc, SA3_PWR_MNG) | SA2_PWR_MNG_FMPS);
}
if (((sc->sc_on_blocks &= ~sc->sc_turning_off) & YM_POWER_ACTIVE) == 0)
ym_chip_powerdown(sc);
sc->sc_turning_off = 0;
/* Restore the state of the chip. */
bus_space_write_1(sc->sc_iot, sc->sc_controlioh, SA3_CTL_INDEX, sv);
}
/*
* Power control entry point.
*/
void
ym_power_ctl(struct ym_softc *sc, int parts, int onoff)
{
int need_restore_codec;
/* This function may sleep --- needs locking. */
while (sc->sc_in_power_ctl & YM_POWER_CTL_INUSE) {
sc->sc_in_power_ctl |= YM_POWER_CTL_WANTED;
DPRINTF(("%s: ym_power_ctl: sleeping\n", DVNAME(sc)));
cv_wait(&sc->sc_cv, &sc->sc_ad1848.sc_ad1848.sc_intr_lock);
DPRINTF(("%s: ym_power_ctl: awaken\n", DVNAME(sc)));
}
sc->sc_in_power_ctl |= YM_POWER_CTL_INUSE;
/* If ON requested to parts which are scheduled to OFF, cancel it. */
if (onoff && sc->sc_turning_off && (sc->sc_turning_off &= ~parts) == 0)
callout_halt(&sc->sc_powerdown_ch,
&sc->sc_ad1848.sc_ad1848.sc_intr_lock);
if (!onoff && sc->sc_turning_off)
parts &= ~sc->sc_turning_off;
/* Discard bits which are currently {on,off}. */
parts &= onoff ? ~sc->sc_on_blocks : sc->sc_on_blocks;
/* Cancel previous timeout if needed. */
if (parts != 0 && sc->sc_turning_off)
callout_halt(&sc->sc_powerdown_ch,
&sc->sc_ad1848.sc_ad1848.sc_intr_lock);
if (parts == 0)
goto unlock; /* no work to do */
if (onoff) {
/* Turning on is done immediately. */
/* If the chip is off, turn it on. */
if ((sc->sc_on_blocks & YM_POWER_ACTIVE) == 0)
ym_chip_powerup(sc, 0);