// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Programming the mspx4xx sound processor family
 *
 * (c) 1997-2001 Gerd Knorr <kraxel@bytesex.org>
 *
 * what works and what doesn't:
 *
 *  AM-Mono
 *      Support for Hauppauge cards added (decoding handled by tuner) added by
 *      Frederic Crozat <fcrozat@mail.dotcom.fr>
 *
 *  FM-Mono
 *      should work. The stereo modes are backward compatible to FM-mono,
 *      therefore FM-Mono should be always available.
 *
 *  FM-Stereo (B/G, used in germany)
 *      should work, with autodetect
 *
 *  FM-Stereo (satellite)
 *      should work, no autodetect (i.e. default is mono, but you can
 *      switch to stereo -- untested)
 *
 *  NICAM (B/G, L , used in UK, Scandinavia, Spain and France)
 *      should work, with autodetect. Support for NICAM was added by
 *      Pekka Pietikainen <pp@netppl.fi>
 *
 * TODO:
 *   - better SAT support
 *
 * 980623  Thomas Sailer (sailer@ife.ee.ethz.ch)
 *         using soundcore instead of OSS
 */


#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/i2c.h>
#include <linux/kthread.h>
#include <linux/freezer.h>
#include <linux/videodev2.h>
#include <media/v4l2-device.h>
#include <media/v4l2-ioctl.h>
#include <media/drv-intf/msp3400.h>
#include <media/i2c/tvaudio.h>
#include "msp3400-driver.h"

/* ---------------------------------------------------------------------- */

MODULE_DESCRIPTION("device driver for msp34xx TV sound processor");
MODULE_AUTHOR("Gerd Knorr");
MODULE_LICENSE("GPL");

/* module parameters */
static int opmode   = OPMODE_AUTO;
int msp_debug;           /* msp_debug output */
bool msp_once;           /* no continuous stereo monitoring */
bool msp_amsound;        /* hard-wire AM sound at 6.5 Hz (france),
                            the autoscan seems work well only with FM... */
int msp_standard = 1;    /* Override auto detect of audio msp_standard,
                            if needed. */
bool msp_dolby;

int msp_stereo_thresh = 0x190; /* a2 threshold for stereo/bilingual
                                        (msp34xxg only) 0x00a0-0x03c0 */

/* read-only */
module_param(opmode,           int, 0444);

/* read-write */
module_param_named(once, msp_once,                      bool, 0644);
module_param_named(debug, msp_debug,                    int,  0644);
module_param_named(stereo_threshold, msp_stereo_thresh, int,  0644);
module_param_named(standard, msp_standard,              int,  0644);
module_param_named(amsound, msp_amsound,                bool, 0644);
module_param_named(dolby, msp_dolby,                    bool, 0644);

MODULE_PARM_DESC(opmode, "Forces a MSP3400 opmode. 0=Manual, 1=Autodetect, 2=Autodetect and autoselect");
MODULE_PARM_DESC(once, "No continuous stereo monitoring");
MODULE_PARM_DESC(debug, "Enable debug messages [0-3]");
MODULE_PARM_DESC(stereo_threshold, "Sets signal threshold to activate stereo");
MODULE_PARM_DESC(standard, "Specify audio standard: 32 = NTSC, 64 = radio, Default: Autodetect");
MODULE_PARM_DESC(amsound, "Hardwire AM sound at 6.5Hz (France), FM can autoscan");
MODULE_PARM_DESC(dolby, "Activates Dolby processing");

/* ---------------------------------------------------------------------- */

/* control subaddress */
#define I2C_MSP_CONTROL 0x00
/* demodulator unit subaddress */
#define I2C_MSP_DEM     0x10
/* DSP unit subaddress */
#define I2C_MSP_DSP     0x12


/* ----------------------------------------------------------------------- */
/* functions for talking to the MSP3400C Sound processor                   */

int msp_reset(struct i2c_client *client)
{
        /* reset and read revision code */
        static u8 reset_off[3] = { I2C_MSP_CONTROL, 0x80, 0x00 };
        static u8 reset_on[3]  = { I2C_MSP_CONTROL, 0x00, 0x00 };
        static u8 write[3]     = { I2C_MSP_DSP + 1, 0x00, 0x1e };
        u8 read[2];
        struct i2c_msg reset[2] = {
                {
                        .addr = client->addr,
                        .flags = I2C_M_IGNORE_NAK,
                        .len = 3,
                        .buf = reset_off
                },
                {
                        .addr = client->addr,
                        .flags = I2C_M_IGNORE_NAK,
                        .len = 3,
                        .buf = reset_on
                },
        };
        struct i2c_msg test[2] = {
                {
                        .addr = client->addr,
                        .len = 3,
                        .buf = write
                },
                {
                        .addr = client->addr,
                        .flags = I2C_M_RD,
                        .len = 2,
                        .buf = read
                },
        };

        dev_dbg_lvl(&client->dev, 3, msp_debug, "msp_reset\n");
        if (i2c_transfer(client->adapter, &reset[0], 1) != 1 ||
            i2c_transfer(client->adapter, &reset[1], 1) != 1 ||
            i2c_transfer(client->adapter, test, 2) != 2) {
                dev_err(&client->dev, "chip reset failed\n");
                return -1;
        }
        return 0;
}

static int msp_read(struct i2c_client *client, int dev, int addr)
{
        int err, retval;
        u8 write[3];
        u8 read[2];
        struct i2c_msg msgs[2] = {
                {
                        .addr = client->addr,
                        .len = 3,
                        .buf = write
                },
                {
                        .addr = client->addr,
                        .flags = I2C_M_RD,
                        .len = 2,
                        .buf = read
                }
        };

        write[0] = dev + 1;
        write[1] = addr >> 8;
        write[2] = addr & 0xff;

        for (err = 0; err < 3; err++) {
                if (i2c_transfer(client->adapter, msgs, 2) == 2)
                        break;
                dev_warn(&client->dev, "I/O error #%d (read 0x%02x/0x%02x)\n", err,
                       dev, addr);
                schedule_timeout_interruptible(msecs_to_jiffies(10));
        }
        if (err == 3) {
                dev_warn(&client->dev, "resetting chip, sound will go off.\n");
                msp_reset(client);
                return -1;
        }
        retval = read[0] << 8 | read[1];
        dev_dbg_lvl(&client->dev, 3, msp_debug, "msp_read(0x%x, 0x%x): 0x%x\n",
                        dev, addr, retval);
        return retval;
}

int msp_read_dem(struct i2c_client *client, int addr)
{
        return msp_read(client, I2C_MSP_DEM, addr);
}

int msp_read_dsp(struct i2c_client *client, int addr)
{
        return msp_read(client, I2C_MSP_DSP, addr);
}

static int msp_write(struct i2c_client *client, int dev, int addr, int val)
{
        int err;
        u8 buffer[5];

        buffer[0] = dev;
        buffer[1] = addr >> 8;
        buffer[2] = addr &  0xff;
        buffer[3] = val  >> 8;
        buffer[4] = val  &  0xff;

        dev_dbg_lvl(&client->dev, 3, msp_debug, "msp_write(0x%x, 0x%x, 0x%x)\n",
                        dev, addr, val);
        for (err = 0; err < 3; err++) {
                if (i2c_master_send(client, buffer, 5) == 5)
                        break;
                dev_warn(&client->dev, "I/O error #%d (write 0x%02x/0x%02x)\n", err,
                       dev, addr);
                schedule_timeout_interruptible(msecs_to_jiffies(10));
        }
        if (err == 3) {
                dev_warn(&client->dev, "resetting chip, sound will go off.\n");
                msp_reset(client);
                return -1;
        }
        return 0;
}

int msp_write_dem(struct i2c_client *client, int addr, int val)
{
        return msp_write(client, I2C_MSP_DEM, addr, val);
}

int msp_write_dsp(struct i2c_client *client, int addr, int val)
{
        return msp_write(client, I2C_MSP_DSP, addr, val);
}

/* ----------------------------------------------------------------------- *
 * bits  9  8  5 - SCART DSP input Select:
 *       0  0  0 - SCART 1 to DSP input (reset position)
 *       0  1  0 - MONO to DSP input
 *       1  0  0 - SCART 2 to DSP input
 *       1  1  1 - Mute DSP input
 *
 * bits 11 10  6 - SCART 1 Output Select:
 *       0  0  0 - undefined (reset position)
 *       0  1  0 - SCART 2 Input to SCART 1 Output (for devices with 2 SCARTS)
 *       1  0  0 - MONO input to SCART 1 Output
 *       1  1  0 - SCART 1 DA to SCART 1 Output
 *       0  0  1 - SCART 2 DA to SCART 1 Output
 *       0  1  1 - SCART 1 Input to SCART 1 Output
 *       1  1  1 - Mute SCART 1 Output
 *
 * bits 13 12  7 - SCART 2 Output Select (for devices with 2 Output SCART):
 *       0  0  0 - SCART 1 DA to SCART 2 Output (reset position)
 *       0  1  0 - SCART 1 Input to SCART 2 Output
 *       1  0  0 - MONO input to SCART 2 Output
 *       0  0  1 - SCART 2 DA to SCART 2 Output
 *       0  1  1 - SCART 2 Input to SCART 2 Output
 *       1  1  0 - Mute SCART 2 Output
 *
 * Bits 4 to 0 should be zero.
 * ----------------------------------------------------------------------- */

static int scarts[3][9] = {
        /* MASK   IN1     IN2     IN3     IN4     IN1_DA  IN2_DA  MONO    MUTE   */
        /* SCART DSP Input select */
        { 0x0320, 0x0000, 0x0200, 0x0300, 0x0020, -1,     -1,     0x0100, 0x0320 },
        /* SCART1 Output select */
        { 0x0c40, 0x0440, 0x0400, 0x0000, 0x0840, 0x0c00, 0x0040, 0x0800, 0x0c40 },
        /* SCART2 Output select */
        { 0x3080, 0x1000, 0x1080, 0x2080, 0x3080, 0x0000, 0x0080, 0x2000, 0x3000 },
};

static char *scart_names[] = {
        "in1", "in2", "in3", "in4", "in1 da", "in2 da", "mono", "mute"
};

void msp_set_scart(struct i2c_client *client, int in, int out)
{
        struct msp_state *state = to_state(i2c_get_clientdata(client));

        state->in_scart = in;

        if (in >= 0 && in <= 7 && out >= 0 && out <= 2) {
                if (-1 == scarts[out][in + 1])
                        return;

                state->acb &= ~scarts[out][0];
                state->acb |=  scarts[out][in + 1];
        } else
                state->acb = 0xf60; /* Mute Input and SCART 1 Output */

        dev_dbg_lvl(&client->dev, 1, msp_debug, "scart switch: %s => %d (ACB=0x%04x)\n",
                                        scart_names[in], out, state->acb);
        msp_write_dsp(client, 0x13, state->acb);

        /* Sets I2S speed 0 = 1.024 Mbps, 1 = 2.048 Mbps */
        if (state->has_i2s_conf)
                msp_write_dem(client, 0x40, state->i2s_mode);
}

/* ------------------------------------------------------------------------ */

static void msp_wake_thread(struct i2c_client *client)
{
        struct msp_state *state = to_state(i2c_get_clientdata(client));

        if (NULL == state->kthread)
                return;
        state->watch_stereo = 0;
        state->restart = 1;
        wake_up_interruptible(&state->wq);
}

int msp_sleep(struct msp_state *state, int msec)
{
        long timeout;

        timeout = msec < 0 ? MAX_SCHEDULE_TIMEOUT : msecs_to_jiffies(msec);

        wait_event_freezable_timeout(state->wq, kthread_should_stop() ||
                                     state->restart, timeout);

        return state->restart;
}

/* ------------------------------------------------------------------------ */

static int msp_s_ctrl(struct v4l2_ctrl *ctrl)
{
        struct msp_state *state = ctrl_to_state(ctrl);
        struct i2c_client *client = v4l2_get_subdevdata(&state->sd);
        int val = ctrl->val;

        switch (ctrl->id) {
        case V4L2_CID_AUDIO_VOLUME: {
                /* audio volume cluster */
                int reallymuted = state->muted->val | state->scan_in_progress;

                if (!reallymuted)
                        val = (val * 0x7f / 65535) << 8;

                dev_dbg_lvl(&client->dev, 1, msp_debug, "mute=%s scanning=%s volume=%d\n",
                                state->muted->val ? "on" : "off",
                                state->scan_in_progress ? "yes" : "no",
                                state->volume->val);

                msp_write_dsp(client, 0x0000, val);
                msp_write_dsp(client, 0x0007, reallymuted ? 0x1 : (val | 0x1));
                if (state->has_scart2_out_volume)
                        msp_write_dsp(client, 0x0040, reallymuted ? 0x1 : (val | 0x1));
                if (state->has_headphones)
                        msp_write_dsp(client, 0x0006, val);
                break;
        }

        case V4L2_CID_AUDIO_BASS:
                val = ((val - 32768) * 0x60 / 65535) << 8;
                msp_write_dsp(client, 0x0002, val);
                if (state->has_headphones)
                        msp_write_dsp(client, 0x0031, val);
                break;

        case V4L2_CID_AUDIO_TREBLE:
                val = ((val - 32768) * 0x60 / 65535) << 8;
                msp_write_dsp(client, 0x0003, val);
                if (state->has_headphones)
                        msp_write_dsp(client, 0x0032, val);
                break;

        case V4L2_CID_AUDIO_LOUDNESS:
                val = val ? ((5 * 4) << 8) : 0;
                msp_write_dsp(client, 0x0004, val);
                if (state->has_headphones)
                        msp_write_dsp(client, 0x0033, val);
                break;

        case V4L2_CID_AUDIO_BALANCE:
                val = (u8)((val / 256) - 128);
                msp_write_dsp(client, 0x0001, val << 8);
                if (state->has_headphones)
                        msp_write_dsp(client, 0x0030, val << 8);
                break;

        default:
                return -EINVAL;
        }
        return 0;
}

void msp_update_volume(struct msp_state *state)
{
        /* Force an update of the volume/mute cluster */
        v4l2_ctrl_lock(state->volume);
        state->volume->val = state->volume->cur.val;
        state->muted->val = state->muted->cur.val;
        msp_s_ctrl(state->volume);
        v4l2_ctrl_unlock(state->volume);
}

/* --- v4l2 ioctls --- */
static int msp_s_radio(struct v4l2_subdev *sd)
{
        struct msp_state *state = to_state(sd);
        struct i2c_client *client = v4l2_get_subdevdata(sd);

        if (state->radio)
                return 0;
        state->radio = 1;
        dev_dbg_lvl(&client->dev, 1, msp_debug, "switching to radio mode\n");
        state->watch_stereo = 0;
        switch (state->opmode) {
        case OPMODE_MANUAL:
                /* set msp3400 to FM radio mode */
                msp3400c_set_mode(client, MSP_MODE_FM_RADIO);
                msp3400c_set_carrier(client, MSP_CARRIER(10.7),
                                MSP_CARRIER(10.7));
                msp_update_volume(state);
                break;
        case OPMODE_AUTODETECT:
        case OPMODE_AUTOSELECT:
                /* the thread will do for us */
                msp_wake_thread(client);
                break;
        }
        return 0;
}

static int msp_s_frequency(struct v4l2_subdev *sd, const struct v4l2_frequency *freq)
{
        struct i2c_client *client = v4l2_get_subdevdata(sd);

        /* new channel -- kick audio carrier scan */
        msp_wake_thread(client);
        return 0;
}

static int msp_querystd(struct v4l2_subdev *sd, v4l2_std_id *id)
{
        struct msp_state *state = to_state(sd);
        struct i2c_client *client = v4l2_get_subdevdata(sd);

        *id &= state->detected_std;

        dev_dbg_lvl(&client->dev, 2, msp_debug,
                "detected standard: %s(0x%08Lx)\n",
                msp_standard_std_name(state->std), state->detected_std);

        return 0;
}

static int msp_s_std(struct v4l2_subdev *sd, v4l2_std_id id)
{
        struct msp_state *state = to_state(sd);
        struct i2c_client *client = v4l2_get_subdevdata(sd);
        int update = state->radio || state->v4l2_std != id;

        state->v4l2_std = id;
        state->radio = 0;
        if (update)
                msp_wake_thread(client);
        return 0;
}

static int msp_s_routing(struct v4l2_subdev *sd,
                         u32 input, u32 output, u32 config)
{
        struct msp_state *state = to_state(sd);
        struct i2c_client *client = v4l2_get_subdevdata(sd);
        int tuner = (input >> 3) & 1;
        int sc_in = input & 0x7;
        int sc1_out = output & 0xf;
        int sc2_out = (output >> 4) & 0xf;
        u16 val, reg;
        int i;
        int extern_input = 1;

        if (state->route_in == input && state->route_out == output)
                return 0;
        state->route_in = input;
        state->route_out = output;
        /* check if the tuner input is used */
        for (i = 0; i < 5; i++) {
                if (((input >> (4 + i * 4)) & 0xf) == 0)
                        extern_input = 0;
        }
        state->mode = extern_input ? MSP_MODE_EXTERN : MSP_MODE_AM_DETECT;
        state->rxsubchans = V4L2_TUNER_SUB_STEREO;
        msp_set_scart(client, sc_in, 0);
        msp_set_scart(client, sc1_out, 1);
        msp_set_scart(client, sc2_out, 2);
        msp_set_audmode(client);
        reg = (state->opmode == OPMODE_AUTOSELECT) ? 0x30 : 0xbb;
        val = msp_read_dem(client, reg);
        msp_write_dem(client, reg, (val & ~0x100) | (tuner << 8));
        /* wake thread when a new input is chosen */
        msp_wake_thread(client);
        return 0;
}

static int msp_g_tuner(struct v4l2_subdev *sd, struct v4l2_tuner *vt)
{
        struct msp_state *state = to_state(sd);
        struct i2c_client *client = v4l2_get_subdevdata(sd);

        if (vt->type != V4L2_TUNER_ANALOG_TV)
                return 0;
        if (!state->radio) {
                if (state->opmode == OPMODE_AUTOSELECT)
                        msp_detect_stereo(client);
                vt->rxsubchans = state->rxsubchans;
        }
        vt->audmode = state->audmode;
        vt->capability |= V4L2_TUNER_CAP_STEREO |
                V4L2_TUNER_CAP_LANG1 | V4L2_TUNER_CAP_LANG2;
        return 0;
}

static int msp_s_tuner(struct v4l2_subdev *sd, const struct v4l2_tuner *vt)
{
        struct msp_state *state = to_state(sd);
        struct i2c_client *client = v4l2_get_subdevdata(sd);

        if (state->radio)  /* TODO: add mono/stereo support for radio */
                return 0;
        if (state->audmode == vt->audmode)
                return 0;
        state->audmode = vt->audmode;
        /* only set audmode */
        msp_set_audmode(client);
        return 0;
}

static int msp_s_i2s_clock_freq(struct v4l2_subdev *sd, u32 freq)
{
        struct msp_state *state = to_state(sd);
        struct i2c_client *client = v4l2_get_subdevdata(sd);

        dev_dbg_lvl(&client->dev, 1, msp_debug, "Setting I2S speed to %d\n", freq);

        switch (freq) {
                case 1024000:
                        state->i2s_mode = 0;
                        break;
                case 2048000:
                        state->i2s_mode = 1;
                        break;
                default:
                        return -EINVAL;
        }
        return 0;
}

static int msp_log_status(struct v4l2_subdev *sd)
{
        struct msp_state *state = to_state(sd);
        struct i2c_client *client = v4l2_get_subdevdata(sd);
        const char *p;
        char prefix[sizeof(sd->name) + 20];

        if (state->opmode == OPMODE_AUTOSELECT)
                msp_detect_stereo(client);
        dev_info(&client->dev, "%s rev1 = 0x%04x rev2 = 0x%04x\n",
                        client->name, state->rev1, state->rev2);
        snprintf(prefix, sizeof(prefix), "%s: Audio:    ", sd->name);
        v4l2_ctrl_handler_log_status(&state->hdl, prefix);
        switch (state->mode) {
                case MSP_MODE_AM_DETECT: p = "AM (for carrier detect)"; break;
                case MSP_MODE_FM_RADIO: p = "FM Radio"; break;
                case MSP_MODE_FM_TERRA: p = "Terrestrial FM-mono/stereo"; break;
                case MSP_MODE_FM_SAT: p = "Satellite FM-mono"; break;
                case MSP_MODE_FM_NICAM1: p = "NICAM/FM (B/G, D/K)"; break;
                case MSP_MODE_FM_NICAM2: p = "NICAM/FM (I)"; break;
                case MSP_MODE_AM_NICAM: p = "NICAM/AM (L)"; break;
                case MSP_MODE_BTSC: p = "BTSC"; break;
                case MSP_MODE_EXTERN: p = "External input"; break;
                default: p = "unknown"; break;
        }
        if (state->mode == MSP_MODE_EXTERN) {
                dev_info(&client->dev, "Mode:     %s\n", p);
        } else if (state->opmode == OPMODE_MANUAL) {
                dev_info(&client->dev, "Mode:     %s (%s%s)\n", p,
                                (state->rxsubchans & V4L2_TUNER_SUB_STEREO) ? "stereo" : "mono",
                                (state->rxsubchans & V4L2_TUNER_SUB_LANG2) ? ", dual" : "");
        } else {
                if (state->opmode == OPMODE_AUTODETECT)
                        dev_info(&client->dev, "Mode:     %s\n", p);
                dev_info(&client->dev, "Standard: %s (%s%s)\n",
                                msp_standard_std_name(state->std),
                                (state->rxsubchans & V4L2_TUNER_SUB_STEREO) ? "stereo" : "mono",
                                (state->rxsubchans & V4L2_TUNER_SUB_LANG2) ? ", dual" : "");
        }
        dev_info(&client->dev, "Audmode:  0x%04x\n", state->audmode);
        dev_info(&client->dev, "Routing:  0x%08x (input) 0x%08x (output)\n",
                        state->route_in, state->route_out);
        dev_info(&client->dev, "ACB:      0x%04x\n", state->acb);
        return 0;
}

#ifdef CONFIG_PM_SLEEP
static int msp_suspend(struct device *dev)
{
        struct i2c_client *client = to_i2c_client(dev);
        dev_dbg_lvl(&client->dev, 1, msp_debug, "suspend\n");
        msp_reset(client);
        return 0;
}

static int msp_resume(struct device *dev)
{
        struct i2c_client *client = to_i2c_client(dev);
        dev_dbg_lvl(&client->dev, 1, msp_debug, "resume\n");
        msp_wake_thread(client);
        return 0;
}
#endif

/* ----------------------------------------------------------------------- */

static const struct v4l2_ctrl_ops msp_ctrl_ops = {
        .s_ctrl = msp_s_ctrl,
};

static const struct v4l2_subdev_core_ops msp_core_ops = {
        .log_status = msp_log_status,
};

static const struct v4l2_subdev_video_ops msp_video_ops = {
        .s_std = msp_s_std,
        .querystd = msp_querystd,
};

static const struct v4l2_subdev_tuner_ops msp_tuner_ops = {
        .s_frequency = msp_s_frequency,
        .g_tuner = msp_g_tuner,
        .s_tuner = msp_s_tuner,
        .s_radio = msp_s_radio,
};

static const struct v4l2_subdev_audio_ops msp_audio_ops = {
        .s_routing = msp_s_routing,
        .s_i2s_clock_freq = msp_s_i2s_clock_freq,
};

static const struct v4l2_subdev_ops msp_ops = {
        .core = &msp_core_ops,
        .video = &msp_video_ops,
        .tuner = &msp_tuner_ops,
        .audio = &msp_audio_ops,
};

/* ----------------------------------------------------------------------- */


static const char * const opmode_str[] = {
        [OPMODE_MANUAL] = "manual",
        [OPMODE_AUTODETECT] = "autodetect",
        [OPMODE_AUTOSELECT] = "autodetect and autoselect",
};

static int msp_probe(struct i2c_client *client)
{
        const struct i2c_device_id *id = i2c_client_get_device_id(client);
        struct msp_state *state;
        struct v4l2_subdev *sd;
        struct v4l2_ctrl_handler *hdl;
        int (*thread_func)(void *data) = NULL;
        int msp_hard;
        int msp_family;
        int msp_revision;
        int msp_product, msp_prod_hi, msp_prod_lo;
        int msp_rom;
#if defined(CONFIG_MEDIA_CONTROLLER)
        int ret;
#endif

        if (!id)
                strscpy(client->name, "msp3400", sizeof(client->name));

        if (msp_reset(client) == -1) {
                dev_dbg_lvl(&client->dev, 1, msp_debug, "msp3400 not found\n");
                return -ENODEV;
        }

        state = devm_kzalloc(&client->dev, sizeof(*state), GFP_KERNEL);
        if (!state)
                return -ENOMEM;

        sd = &state->sd;
        v4l2_i2c_subdev_init(sd, client, &msp_ops);

#if defined(CONFIG_MEDIA_CONTROLLER)
        state->pads[MSP3400_PAD_IF_INPUT].flags = MEDIA_PAD_FL_SINK;
        state->pads[MSP3400_PAD_IF_INPUT].sig_type = PAD_SIGNAL_AUDIO;
        state->pads[MSP3400_PAD_OUT].flags = MEDIA_PAD_FL_SOURCE;
        state->pads[MSP3400_PAD_OUT].sig_type = PAD_SIGNAL_AUDIO;

        sd->entity.function = MEDIA_ENT_F_IF_AUD_DECODER;

        ret = media_entity_pads_init(&sd->entity, 2, state->pads);
        if (ret < 0)
                return ret;
#endif

        state->v4l2_std = V4L2_STD_NTSC;
        state->detected_std = V4L2_STD_ALL;
        state->audmode = V4L2_TUNER_MODE_STEREO;
        state->input = -1;
        state->i2s_mode = 0;
        init_waitqueue_head(&state->wq);
        /* These are the reset input/output positions */
        state->route_in = MSP_INPUT_DEFAULT;
        state->route_out = MSP_OUTPUT_DEFAULT;

        state->rev1 = msp_read_dsp(client, 0x1e);
        if (state->rev1 != -1)
                state->rev2 = msp_read_dsp(client, 0x1f);
        dev_dbg_lvl(&client->dev, 1, msp_debug, "rev1=0x%04x, rev2=0x%04x\n",
                        state->rev1, state->rev2);
        if (state->rev1 == -1 || (state->rev1 == 0 && state->rev2 == 0)) {
                dev_dbg_lvl(&client->dev, 1, msp_debug,
                                "not an msp3400 (cannot read chip version)\n");
                return -ENODEV;
        }

        msp_family = ((state->rev1 >> 4) & 0x0f) + 3;
        msp_product = (state->rev2 >> 8) & 0xff;
        msp_prod_hi = msp_product / 10;
        msp_prod_lo = msp_product % 10;
        msp_revision = (state->rev1 & 0x0f) + '@';
        msp_hard = ((state->rev1 >> 8) & 0xff) + '@';
        msp_rom = state->rev2 & 0x1f;
        /* Rev B=2, C=3, D=4, G=7 */
        state->ident = msp_family * 10000 + 4000 + msp_product * 10 +
                        msp_revision - '@';

        /* Has NICAM support: all mspx41x and mspx45x products have NICAM */
        state->has_nicam =
                msp_prod_hi == 1 || msp_prod_hi == 5;
        /* Has radio support: was added with revision G */
        state->has_radio =
                msp_revision >= 'G';
        /* Has headphones output: not for stripped down products */
        state->has_headphones =
                msp_prod_lo < 5;
        /* Has scart2 input: not in stripped down products of the '3' family */
        state->has_scart2 =
                msp_family >= 4 || msp_prod_lo < 7;
        /* Has scart3 input: not in stripped down products of the '3' family */
        state->has_scart3 =
                msp_family >= 4 || msp_prod_lo < 5;
        /* Has scart4 input: not in pre D revisions, not in stripped D revs */
        state->has_scart4 =
                msp_family >= 4 || (msp_revision >= 'D' && msp_prod_lo < 5);
        /* Has scart2 output: not in stripped down products of
         * the '3' family */
        state->has_scart2_out =
                msp_family >= 4 || msp_prod_lo < 5;
        /* Has scart2 a volume control? Not in pre-D revisions. */
        state->has_scart2_out_volume =
                msp_revision > 'C' && state->has_scart2_out;
        /* Has a configurable i2s out? */
        state->has_i2s_conf =
                msp_revision >= 'G' && msp_prod_lo < 7;
        /* Has subwoofer output: not in pre-D revs and not in stripped down
         * products */
        state->has_subwoofer =
                msp_revision >= 'D' && msp_prod_lo < 5;
        /* Has soundprocessing (bass/treble/balance/loudness/equalizer):
         *  not in stripped down products */
        state->has_sound_processing =
                msp_prod_lo < 7;
        /* Has Virtual Dolby Surround: only in msp34x1 */
        state->has_virtual_dolby_surround =
                msp_revision == 'G' && msp_prod_lo == 1;
        /* Has Virtual Dolby Surround & Dolby Pro Logic: only in msp34x2 */
        state->has_dolby_pro_logic =
                msp_revision == 'G' && msp_prod_lo == 2;
        /* The msp343xG supports BTSC only and cannot do Automatic Standard
         * Detection. */
        state->force_btsc =
                msp_family == 3 && msp_revision == 'G' && msp_prod_hi == 3;

        state->opmode = opmode;
        if (state->opmode < OPMODE_MANUAL
            || state->opmode > OPMODE_AUTOSELECT) {
                /* MSP revision G and up have both autodetect and autoselect */
                if (msp_revision >= 'G')
                        state->opmode = OPMODE_AUTOSELECT;
                /* MSP revision D and up have autodetect */
                else if (msp_revision >= 'D')
                        state->opmode = OPMODE_AUTODETECT;
                else
                        state->opmode = OPMODE_MANUAL;
        }

        hdl = &state->hdl;
        v4l2_ctrl_handler_init(hdl, 6);
        if (state->has_sound_processing) {
                v4l2_ctrl_new_std(hdl, &msp_ctrl_ops,
                        V4L2_CID_AUDIO_BASS, 0, 65535, 65535 / 100, 32768);
                v4l2_ctrl_new_std(hdl, &msp_ctrl_ops,
                        V4L2_CID_AUDIO_TREBLE, 0, 65535, 65535 / 100, 32768);
                v4l2_ctrl_new_std(hdl, &msp_ctrl_ops,
                        V4L2_CID_AUDIO_LOUDNESS, 0, 1, 1, 0);
        }
        state->volume = v4l2_ctrl_new_std(hdl, &msp_ctrl_ops,
                        V4L2_CID_AUDIO_VOLUME, 0, 65535, 65535 / 100, 58880);
        v4l2_ctrl_new_std(hdl, &msp_ctrl_ops,
                        V4L2_CID_AUDIO_BALANCE, 0, 65535, 65535 / 100, 32768);
        state->muted = v4l2_ctrl_new_std(hdl, &msp_ctrl_ops,
                        V4L2_CID_AUDIO_MUTE, 0, 1, 1, 0);
        sd->ctrl_handler = hdl;
        if (hdl->error) {
                int err = hdl->error;

                v4l2_ctrl_handler_free(hdl);
                return err;
        }

        v4l2_ctrl_cluster(2, &state->volume);
        v4l2_ctrl_handler_setup(hdl);

        dev_info(&client->dev,
                 "MSP%d4%02d%c-%c%d found on %s: supports %s%s%s, mode is %s\n",
                 msp_family, msp_product,
                 msp_revision, msp_hard, msp_rom,
                 client->adapter->name,
                 (state->has_nicam) ? "nicam" : "",
                 (state->has_nicam && state->has_radio) ? " and " : "",
                 (state->has_radio) ? "radio" : "",
                 opmode_str[state->opmode]);

        /* version-specific initialization */
        switch (state->opmode) {
        case OPMODE_MANUAL:
                thread_func = msp3400c_thread;
                break;
        case OPMODE_AUTODETECT:
                thread_func = msp3410d_thread;
                break;
        case OPMODE_AUTOSELECT:
                thread_func = msp34xxg_thread;
                break;
        }

        /* startup control thread if needed */
        if (thread_func) {
                state->kthread = kthread_run(thread_func, client, "msp34xx");

                if (IS_ERR(state->kthread))
                        dev_warn(&client->dev, "kernel_thread() failed\n");
                msp_wake_thread(client);
        }
        return 0;
}

static void msp_remove(struct i2c_client *client)
{
        struct msp_state *state = to_state(i2c_get_clientdata(client));

        v4l2_device_unregister_subdev(&state->sd);
        /* shutdown control thread */
        if (state->kthread) {
                state->restart = 1;
                kthread_stop(state->kthread);
        }
        msp_reset(client);

        v4l2_ctrl_handler_free(&state->hdl);
}

/* ----------------------------------------------------------------------- */

static const struct dev_pm_ops msp3400_pm_ops = {
        SET_SYSTEM_SLEEP_PM_OPS(msp_suspend, msp_resume)
};

static const struct i2c_device_id msp_id[] = {
        { "msp3400" },
        { }
};
MODULE_DEVICE_TABLE(i2c, msp_id);

static struct i2c_driver msp_driver = {
        .driver = {
                .name   = "msp3400",
                .pm     = &msp3400_pm_ops,
        },
        .probe          = msp_probe,
        .remove         = msp_remove,
        .id_table       = msp_id,
};

module_i2c_driver(msp_driver);