root/drivers/media/usb/dvb-usb/dibusb-common.c
// SPDX-License-Identifier: GPL-2.0-only
/* Common methods for dibusb-based-receivers.
 *
 * Copyright (C) 2004-5 Patrick Boettcher (patrick.boettcher@posteo.de)
 *
 * see Documentation/driver-api/media/drivers/dvb-usb.rst for more information
 */

#include "dibusb.h"

/* Max transfer size done by I2C transfer functions */
#define MAX_XFER_SIZE  64

static int debug;
module_param(debug, int, 0644);
MODULE_PARM_DESC(debug, "set debugging level (1=info (|-able))." DVB_USB_DEBUG_STATUS);
MODULE_DESCRIPTION("Common methods for dibusb-based receivers");
MODULE_LICENSE("GPL");

#define deb_info(args...) dprintk(debug,0x01,args)

/* common stuff used by the different dibusb modules */
int dibusb_streaming_ctrl(struct dvb_usb_adapter *adap, int onoff)
{
        if (adap->priv != NULL) {
                struct dibusb_state *st = adap->priv;
                if (st->ops.fifo_ctrl != NULL)
                        if (st->ops.fifo_ctrl(adap->fe_adap[0].fe, onoff)) {
                                err("error while controlling the fifo of the demod.");
                                return -ENODEV;
                        }
        }
        return 0;
}
EXPORT_SYMBOL(dibusb_streaming_ctrl);

int dibusb_pid_filter(struct dvb_usb_adapter *adap, int index, u16 pid, int onoff)
{
        if (adap->priv != NULL) {
                struct dibusb_state *st = adap->priv;
                if (st->ops.pid_ctrl != NULL)
                        st->ops.pid_ctrl(adap->fe_adap[0].fe,
                                         index, pid, onoff);
        }
        return 0;
}
EXPORT_SYMBOL(dibusb_pid_filter);

int dibusb_pid_filter_ctrl(struct dvb_usb_adapter *adap, int onoff)
{
        if (adap->priv != NULL) {
                struct dibusb_state *st = adap->priv;
                if (st->ops.pid_parse != NULL)
                        if (st->ops.pid_parse(adap->fe_adap[0].fe, onoff) < 0)
                                err("could not handle pid_parser");
        }
        return 0;
}
EXPORT_SYMBOL(dibusb_pid_filter_ctrl);

int dibusb_power_ctrl(struct dvb_usb_device *d, int onoff)
{
        u8 *b;
        int ret;

        b = kmalloc(3, GFP_KERNEL);
        if (!b)
                return -ENOMEM;

        b[0] = DIBUSB_REQ_SET_IOCTL;
        b[1] = DIBUSB_IOCTL_CMD_POWER_MODE;
        b[2] = onoff ? DIBUSB_IOCTL_POWER_WAKEUP : DIBUSB_IOCTL_POWER_SLEEP;

        ret = dvb_usb_generic_write(d, b, 3);

        kfree(b);

        msleep(10);

        return ret;
}
EXPORT_SYMBOL(dibusb_power_ctrl);

int dibusb2_0_streaming_ctrl(struct dvb_usb_adapter *adap, int onoff)
{
        int ret;
        u8 *b;

        b = kmalloc(3, GFP_KERNEL);
        if (!b)
                return -ENOMEM;

        if ((ret = dibusb_streaming_ctrl(adap,onoff)) < 0)
                goto ret;

        if (onoff) {
                b[0] = DIBUSB_REQ_SET_STREAMING_MODE;
                b[1] = 0x00;
                ret = dvb_usb_generic_write(adap->dev, b, 2);
                if (ret  < 0)
                        goto ret;
        }

        b[0] = DIBUSB_REQ_SET_IOCTL;
        b[1] = onoff ? DIBUSB_IOCTL_CMD_ENABLE_STREAM : DIBUSB_IOCTL_CMD_DISABLE_STREAM;
        ret = dvb_usb_generic_write(adap->dev, b, 3);

ret:
        kfree(b);
        return ret;
}
EXPORT_SYMBOL(dibusb2_0_streaming_ctrl);

int dibusb2_0_power_ctrl(struct dvb_usb_device *d, int onoff)
{
        u8 *b;
        int ret;

        if (!onoff)
                return 0;

        b = kmalloc(3, GFP_KERNEL);
        if (!b)
                return -ENOMEM;

        b[0] = DIBUSB_REQ_SET_IOCTL;
        b[1] = DIBUSB_IOCTL_CMD_POWER_MODE;
        b[2] = DIBUSB_IOCTL_POWER_WAKEUP;

        ret = dvb_usb_generic_write(d, b, 3);

        kfree(b);

        return ret;
}
EXPORT_SYMBOL(dibusb2_0_power_ctrl);

static int dibusb_i2c_msg(struct dvb_usb_device *d, u8 addr,
                          u8 *wbuf, u16 wlen, u8 *rbuf, u16 rlen)
{
        u8 *sndbuf;
        int ret, wo, len;

        /* write only ? */
        wo = (rbuf == NULL || rlen == 0);

        len = 2 + wlen + (wo ? 0 : 2);

        sndbuf = kmalloc(MAX_XFER_SIZE, GFP_KERNEL);
        if (!sndbuf)
                return -ENOMEM;

        if (4 + wlen > MAX_XFER_SIZE) {
                warn("i2c wr: len=%d is too big!\n", wlen);
                ret = -EOPNOTSUPP;
                goto ret;
        }

        sndbuf[0] = wo ? DIBUSB_REQ_I2C_WRITE : DIBUSB_REQ_I2C_READ;
        sndbuf[1] = (addr << 1) | (wo ? 0 : 1);

        memcpy(&sndbuf[2], wbuf, wlen);

        if (!wo) {
                sndbuf[wlen + 2] = (rlen >> 8) & 0xff;
                sndbuf[wlen + 3] = rlen & 0xff;
        }

        ret = dvb_usb_generic_rw(d, sndbuf, len, rbuf, rlen, 0);

ret:
        kfree(sndbuf);
        return ret;
}

/*
 * I2C master xfer function
 */
static int dibusb_i2c_xfer(struct i2c_adapter *adap,struct i2c_msg msg[],int num)
{
        struct dvb_usb_device *d = i2c_get_adapdata(adap);
        int i;

        if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
                return -EAGAIN;

        for (i = 0; i < num; i++) {
                /* write/read request */
                if (i+1 < num && (msg[i].flags & I2C_M_RD) == 0
                                          && (msg[i+1].flags & I2C_M_RD)) {
                        if (dibusb_i2c_msg(d, msg[i].addr, msg[i].buf,msg[i].len,
                                                msg[i+1].buf,msg[i+1].len) < 0)
                                break;
                        i++;
                } else if ((msg[i].flags & I2C_M_RD) == 0) {
                        if (dibusb_i2c_msg(d, msg[i].addr, msg[i].buf,msg[i].len,NULL,0) < 0)
                                break;
                } else if (msg[i].addr != 0x50) {
                        /* 0x50 is the address of the eeprom - we need to protect it
                         * from dibusb's bad i2c implementation: reads without
                         * writing the offset before are forbidden */
                        if (dibusb_i2c_msg(d, msg[i].addr, NULL, 0, msg[i].buf, msg[i].len) < 0)
                                break;
                }
        }

        mutex_unlock(&d->i2c_mutex);
        return i;
}

static u32 dibusb_i2c_func(struct i2c_adapter *adapter)
{
        return I2C_FUNC_I2C;
}

struct i2c_algorithm dibusb_i2c_algo = {
        .master_xfer   = dibusb_i2c_xfer,
        .functionality = dibusb_i2c_func,
};
EXPORT_SYMBOL(dibusb_i2c_algo);

int dibusb_read_eeprom_byte(struct dvb_usb_device *d, u8 offs, u8 *val)
{
        u8 *buf;
        int rc;

        buf = kzalloc(2, GFP_KERNEL);
        if (!buf)
                return -ENOMEM;

        buf[0] = offs;

        rc = dibusb_i2c_msg(d, 0x50, &buf[0], 1, &buf[1], 1);
        *val = buf[1];
        kfree(buf);

        return rc;
}
EXPORT_SYMBOL(dibusb_read_eeprom_byte);

/*
 * common remote control stuff
 */
struct rc_map_table rc_map_dibusb_table[] = {
        /* Key codes for the little Artec T1/Twinhan/HAMA/ remote. */
        { 0x0016, KEY_POWER },
        { 0x0010, KEY_MUTE },
        { 0x0003, KEY_1 },
        { 0x0001, KEY_2 },
        { 0x0006, KEY_3 },
        { 0x0009, KEY_4 },
        { 0x001d, KEY_5 },
        { 0x001f, KEY_6 },
        { 0x000d, KEY_7 },
        { 0x0019, KEY_8 },
        { 0x001b, KEY_9 },
        { 0x0015, KEY_0 },
        { 0x0005, KEY_CHANNELUP },
        { 0x0002, KEY_CHANNELDOWN },
        { 0x001e, KEY_VOLUMEUP },
        { 0x000a, KEY_VOLUMEDOWN },
        { 0x0011, KEY_RECORD },
        { 0x0017, KEY_FAVORITES }, /* Heart symbol - Channel list. */
        { 0x0014, KEY_PLAY },
        { 0x001a, KEY_STOP },
        { 0x0040, KEY_REWIND },
        { 0x0012, KEY_FASTFORWARD },
        { 0x000e, KEY_PREVIOUS }, /* Recall - Previous channel. */
        { 0x004c, KEY_PAUSE },
        { 0x004d, KEY_SCREEN }, /* Full screen mode. */
        { 0x0054, KEY_AUDIO }, /* MTS - Switch to secondary audio. */
        /* additional keys TwinHan VisionPlus, the Artec seemingly not have */
        { 0x000c, KEY_CANCEL }, /* Cancel */
        { 0x001c, KEY_EPG }, /* EPG */
        { 0x0000, KEY_TAB }, /* Tab */
        { 0x0048, KEY_INFO }, /* Preview */
        { 0x0004, KEY_LIST }, /* RecordList */
        { 0x000f, KEY_TEXT }, /* Teletext */
        /* Key codes for the KWorld/ADSTech/JetWay remote. */
        { 0x8612, KEY_POWER },
        { 0x860f, KEY_SELECT }, /* source */
        { 0x860c, KEY_UNKNOWN }, /* scan */
        { 0x860b, KEY_EPG },
        { 0x8610, KEY_MUTE },
        { 0x8601, KEY_1 },
        { 0x8602, KEY_2 },
        { 0x8603, KEY_3 },
        { 0x8604, KEY_4 },
        { 0x8605, KEY_5 },
        { 0x8606, KEY_6 },
        { 0x8607, KEY_7 },
        { 0x8608, KEY_8 },
        { 0x8609, KEY_9 },
        { 0x860a, KEY_0 },
        { 0x8618, KEY_ZOOM },
        { 0x861c, KEY_UNKNOWN }, /* preview */
        { 0x8613, KEY_UNKNOWN }, /* snap */
        { 0x8600, KEY_UNDO },
        { 0x861d, KEY_RECORD },
        { 0x860d, KEY_STOP },
        { 0x860e, KEY_PAUSE },
        { 0x8616, KEY_PLAY },
        { 0x8611, KEY_BACK },
        { 0x8619, KEY_FORWARD },
        { 0x8614, KEY_UNKNOWN }, /* pip */
        { 0x8615, KEY_ESC },
        { 0x861a, KEY_UP },
        { 0x861e, KEY_DOWN },
        { 0x861f, KEY_LEFT },
        { 0x861b, KEY_RIGHT },

        /* Key codes for the DiBcom MOD3000 remote. */
        { 0x8000, KEY_MUTE },
        { 0x8001, KEY_TEXT },
        { 0x8002, KEY_HOME },
        { 0x8003, KEY_POWER },

        { 0x8004, KEY_RED },
        { 0x8005, KEY_GREEN },
        { 0x8006, KEY_YELLOW },
        { 0x8007, KEY_BLUE },

        { 0x8008, KEY_DVD },
        { 0x8009, KEY_AUDIO },
        { 0x800a, KEY_IMAGES },      /* Pictures */
        { 0x800b, KEY_VIDEO },

        { 0x800c, KEY_BACK },
        { 0x800d, KEY_UP },
        { 0x800e, KEY_RADIO },
        { 0x800f, KEY_EPG },

        { 0x8010, KEY_LEFT },
        { 0x8011, KEY_OK },
        { 0x8012, KEY_RIGHT },
        { 0x8013, KEY_UNKNOWN },    /* SAP */

        { 0x8014, KEY_TV },
        { 0x8015, KEY_DOWN },
        { 0x8016, KEY_MENU },       /* DVD Menu */
        { 0x8017, KEY_LAST },

        { 0x8018, KEY_RECORD },
        { 0x8019, KEY_STOP },
        { 0x801a, KEY_PAUSE },
        { 0x801b, KEY_PLAY },

        { 0x801c, KEY_PREVIOUS },
        { 0x801d, KEY_REWIND },
        { 0x801e, KEY_FASTFORWARD },
        { 0x801f, KEY_NEXT},

        { 0x8040, KEY_1 },
        { 0x8041, KEY_2 },
        { 0x8042, KEY_3 },
        { 0x8043, KEY_CHANNELUP },

        { 0x8044, KEY_4 },
        { 0x8045, KEY_5 },
        { 0x8046, KEY_6 },
        { 0x8047, KEY_CHANNELDOWN },

        { 0x8048, KEY_7 },
        { 0x8049, KEY_8 },
        { 0x804a, KEY_9 },
        { 0x804b, KEY_VOLUMEUP },

        { 0x804c, KEY_CLEAR },
        { 0x804d, KEY_0 },
        { 0x804e, KEY_ENTER },
        { 0x804f, KEY_VOLUMEDOWN },
};
EXPORT_SYMBOL(rc_map_dibusb_table);

int dibusb_rc_query(struct dvb_usb_device *d, u32 *event, int *state)
{
        u8 *buf;
        int ret;

        buf = kmalloc(5, GFP_KERNEL);
        if (!buf)
                return -ENOMEM;

        buf[0] = DIBUSB_REQ_POLL_REMOTE;

        ret = dvb_usb_generic_rw(d, buf, 1, buf, 5, 0);
        if (ret < 0)
                goto ret;

        dvb_usb_nec_rc_key_to_event(d, buf, event, state);

        if (buf[0] != 0)
                deb_info("key: %*ph\n", 5, buf);

ret:
        kfree(buf);

        return ret;
}
EXPORT_SYMBOL(dibusb_rc_query);