root/sound/pci/echoaudio/mia_dsp.c
// SPDX-License-Identifier: GPL-2.0-only
/****************************************************************************

   Copyright Echo Digital Audio Corporation (c) 1998 - 2004
   All rights reserved
   www.echoaudio.com

   This file is part of Echo Digital Audio's generic driver library.
   *************************************************************************

 Translation from C++ and adaptation for use in ALSA-Driver
 were made by Giuliano Pochini <pochini@shiny.it>

****************************************************************************/


static int set_input_clock(struct echoaudio *chip, u16 clock);
static int set_professional_spdif(struct echoaudio *chip, char prof);
static int update_flags(struct echoaudio *chip);
static int set_vmixer_gain(struct echoaudio *chip, u16 output, u16 pipe,
                           int gain);
static int update_vmixer_level(struct echoaudio *chip);


static int init_hw(struct echoaudio *chip, u16 device_id, u16 subdevice_id)
{
        int err;

        if (snd_BUG_ON((subdevice_id & 0xfff0) != MIA))
                return -ENODEV;

        err = init_dsp_comm_page(chip);
        if (err) {
                dev_err(chip->card->dev,
                        "init_hw - could not initialize DSP comm page\n");
                return err;
        }

        chip->device_id = device_id;
        chip->subdevice_id = subdevice_id;
        chip->bad_board = true;
        chip->dsp_code_to_load = FW_MIA_DSP;
        /* Since this card has no ASIC, mark it as loaded so everything
           works OK */
        chip->asic_loaded = true;
        if ((subdevice_id & 0x0000f) == MIA_MIDI_REV)
                chip->has_midi = true;
        chip->input_clock_types = ECHO_CLOCK_BIT_INTERNAL |
                ECHO_CLOCK_BIT_SPDIF;

        err = load_firmware(chip);
        if (err < 0)
                return err;
        chip->bad_board = false;

        return err;
}



static int set_mixer_defaults(struct echoaudio *chip)
{
        return init_line_levels(chip);
}



static u32 detect_input_clocks(const struct echoaudio *chip)
{
        u32 clocks_from_dsp, clock_bits;

        /* Map the DSP clock detect bits to the generic driver clock
           detect bits */
        clocks_from_dsp = le32_to_cpu(chip->comm_page->status_clocks);

        clock_bits = ECHO_CLOCK_BIT_INTERNAL;

        if (clocks_from_dsp & GLDM_CLOCK_DETECT_BIT_SPDIF)
                clock_bits |= ECHO_CLOCK_BIT_SPDIF;

        return clock_bits;
}



/* The Mia has no ASIC. Just do nothing */
static int load_asic(struct echoaudio *chip)
{
        return 0;
}



static int set_sample_rate(struct echoaudio *chip, u32 rate)
{
        u32 control_reg;

        switch (rate) {
        case 96000:
                control_reg = MIA_96000;
                break;
        case 88200:
                control_reg = MIA_88200;
                break;
        case 48000:
                control_reg = MIA_48000;
                break;
        case 44100:
                control_reg = MIA_44100;
                break;
        case 32000:
                control_reg = MIA_32000;
                break;
        default:
                dev_err(chip->card->dev,
                        "set_sample_rate: %d invalid!\n", rate);
                return -EINVAL;
        }

        /* Override the clock setting if this Mia is set to S/PDIF clock */
        if (chip->input_clock == ECHO_CLOCK_SPDIF)
                control_reg |= MIA_SPDIF;

        /* Set the control register if it has changed */
        if (control_reg != le32_to_cpu(chip->comm_page->control_register)) {
                if (wait_handshake(chip))
                        return -EIO;

                chip->comm_page->sample_rate = cpu_to_le32(rate);       /* ignored by the DSP */
                chip->comm_page->control_register = cpu_to_le32(control_reg);
                chip->sample_rate = rate;

                clear_handshake(chip);
                return send_vector(chip, DSP_VC_UPDATE_CLOCKS);
        }
        return 0;
}



static int set_input_clock(struct echoaudio *chip, u16 clock)
{
        dev_dbg(chip->card->dev, "set_input_clock(%d)\n", clock);
        if (snd_BUG_ON(clock != ECHO_CLOCK_INTERNAL &&
                       clock != ECHO_CLOCK_SPDIF))
                return -EINVAL;

        chip->input_clock = clock;
        return set_sample_rate(chip, chip->sample_rate);
}



/* This function routes the sound from a virtual channel to a real output */
static int set_vmixer_gain(struct echoaudio *chip, u16 output, u16 pipe,
                           int gain)
{
        int index;

        if (snd_BUG_ON(pipe >= num_pipes_out(chip) ||
                       output >= num_busses_out(chip)))
                return -EINVAL;

        if (wait_handshake(chip))
                return -EIO;

        chip->vmixer_gain[output][pipe] = gain;
        index = output * num_pipes_out(chip) + pipe;
        chip->comm_page->vmixer[index] = gain;

        dev_dbg(chip->card->dev,
                "set_vmixer_gain: pipe %d, out %d = %d\n", pipe, output, gain);
        return 0;
}



/* Tell the DSP to read and update virtual mixer levels in comm page. */
static int update_vmixer_level(struct echoaudio *chip)
{
        if (wait_handshake(chip))
                return -EIO;
        clear_handshake(chip);
        return send_vector(chip, DSP_VC_SET_VMIXER_GAIN);
}



/* Tell the DSP to reread the flags from the comm page */
static int update_flags(struct echoaudio *chip)
{
        if (wait_handshake(chip))
                return -EIO;
        clear_handshake(chip);
        return send_vector(chip, DSP_VC_UPDATE_FLAGS);
}



static int set_professional_spdif(struct echoaudio *chip, char prof)
{
        dev_dbg(chip->card->dev, "set_professional_spdif %d\n", prof);
        if (prof)
                chip->comm_page->flags |=
                        cpu_to_le32(DSP_FLAG_PROFESSIONAL_SPDIF);
        else
                chip->comm_page->flags &=
                        ~cpu_to_le32(DSP_FLAG_PROFESSIONAL_SPDIF);
        chip->professional_spdif = prof;
        return update_flags(chip);
}