/* * Silicon Labs Si2168 DVB-T/T2/C demodulator driver * * Copyright (C) 2014 Antti Palosaari <crope@iki.fi> * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. */ #include "si2168_priv.h" static const struct dvb_frontend_ops si2168_ops; /* execute firmware command */ static int si2168_cmd_execute(struct si2168 *s, struct si2168_cmd *cmd) { int ret; unsigned long timeout; mutex_lock(&s->i2c_mutex); if (cmd->wlen) { /* write cmd and args for firmware */ ret = i2c_master_send(s->client, cmd->args, cmd->wlen); if (ret < 0) { goto err_mutex_unlock; } else if (ret != cmd->wlen) { ret = -EREMOTEIO; goto err_mutex_unlock; } } if (cmd->rlen) { /* wait cmd execution terminate */ #define TIMEOUT 50 timeout = jiffies + msecs_to_jiffies(TIMEOUT); while (!time_after(jiffies, timeout)) { ret = i2c_master_recv(s->client, cmd->args, cmd->rlen); if (ret < 0) { goto err_mutex_unlock; } else if (ret != cmd->rlen) { ret = -EREMOTEIO; goto err_mutex_unlock; } /* firmware ready? */ if ((cmd->args[0] >> 7) & 0x01) break; } dev_dbg(&s->client->dev, "cmd execution took %d ms\n", jiffies_to_msecs(jiffies) - (jiffies_to_msecs(timeout) - TIMEOUT)); if (!((cmd->args[0] >> 7) & 0x01)) { ret = -ETIMEDOUT; goto err_mutex_unlock; } } ret = 0; err_mutex_unlock: mutex_unlock(&s->i2c_mutex); if (ret) goto err; return 0; err: dev_dbg(&s->client->dev, "failed=%d\n", ret); return ret; } static int si2168_read_status(struct dvb_frontend *fe, fe_status_t *status) { struct si2168 *s = fe->demodulator_priv; struct dtv_frontend_properties *c = &fe->dtv_property_cache; int ret; struct si2168_cmd cmd; *status = 0; if (!s->active) { ret = -EAGAIN; goto err; } switch (c->delivery_system) { case SYS_DVBT: memcpy(cmd.args, "\xa0\x01", 2); cmd.wlen = 2; cmd.rlen = 13; break; case SYS_DVBC_ANNEX_A: memcpy(cmd.args, "\x90\x01", 2); cmd.wlen = 2; cmd.rlen = 9; break; case SYS_DVBT2: memcpy(cmd.args, "\x50\x01", 2); cmd.wlen = 2; cmd.rlen = 14; break; default: ret = -EINVAL; goto err; } ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; /* * Possible values seen, in order from strong signal to weak: * 16 0001 0110 full lock * 1e 0001 1110 partial lock * 1a 0001 1010 partial lock * 18 0001 1000 no lock * * [b3:b1] lock bits * [b4] statistics ready? Set in a few secs after lock is gained. */ switch ((cmd.args[2] >> 1) & 0x03) { case 0x01: *status = FE_HAS_SIGNAL | FE_HAS_CARRIER; break; case 0x03: *status = FE_HAS_SIGNAL | FE_HAS_CARRIER | FE_HAS_VITERBI | FE_HAS_SYNC | FE_HAS_LOCK; break; } s->fe_status = *status; if (*status & FE_HAS_LOCK) { c->cnr.len = 1; c->cnr.stat[0].scale = FE_SCALE_DECIBEL; c->cnr.stat[0].svalue = cmd.args[3] * 1000 / 4; } else { c->cnr.len = 1; c->cnr.stat[0].scale = FE_SCALE_NOT_AVAILABLE; } dev_dbg(&s->client->dev, "status=%02x args=%*ph\n", *status, cmd.rlen, cmd.args); return 0; err: dev_dbg(&s->client->dev, "failed=%d\n", ret); return ret; } static int si2168_set_frontend(struct dvb_frontend *fe) { struct si2168 *s = fe->demodulator_priv; struct dtv_frontend_properties *c = &fe->dtv_property_cache; int ret; struct si2168_cmd cmd; u8 bandwidth, delivery_system; dev_dbg(&s->client->dev, "delivery_system=%u modulation=%u frequency=%u bandwidth_hz=%u symbol_rate=%u inversion=%u, stream_id=%d\n", c->delivery_system, c->modulation, c->frequency, c->bandwidth_hz, c->symbol_rate, c->inversion, c->stream_id); if (!s->active) { ret = -EAGAIN; goto err; } switch (c->delivery_system) { case SYS_DVBT: delivery_system = 0x20; break; case SYS_DVBC_ANNEX_A: delivery_system = 0x30; break; case SYS_DVBT2: delivery_system = 0x70; break; default: ret = -EINVAL; goto err; } if (c->bandwidth_hz <= 5000000) bandwidth = 0x05; else if (c->bandwidth_hz <= 6000000) bandwidth = 0x06; else if (c->bandwidth_hz <= 7000000) bandwidth = 0x07; else if (c->bandwidth_hz <= 8000000) bandwidth = 0x08; else if (c->bandwidth_hz <= 9000000) bandwidth = 0x09; else if (c->bandwidth_hz <= 10000000) bandwidth = 0x0a; else bandwidth = 0x0f; /* program tuner */ if (fe->ops.tuner_ops.set_params) { ret = fe->ops.tuner_ops.set_params(fe); if (ret) goto err; } memcpy(cmd.args, "\x88\x02\x02\x02\x02", 5); cmd.wlen = 5; cmd.rlen = 5; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; /* that has no big effect */ if (c->delivery_system == SYS_DVBT) memcpy(cmd.args, "\x89\x21\x06\x11\xff\x98", 6); else if (c->delivery_system == SYS_DVBC_ANNEX_A) memcpy(cmd.args, "\x89\x21\x06\x11\x89\xf0", 6); else if (c->delivery_system == SYS_DVBT2) memcpy(cmd.args, "\x89\x21\x06\x11\x89\x20", 6); cmd.wlen = 6; cmd.rlen = 3; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; if (c->delivery_system == SYS_DVBT2) { /* select PLP */ cmd.args[0] = 0x52; cmd.args[1] = c->stream_id & 0xff; cmd.args[2] = c->stream_id == NO_STREAM_ID_FILTER ? 0 : 1; cmd.wlen = 3; cmd.rlen = 1; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; } memcpy(cmd.args, "\x51\x03", 2); cmd.wlen = 2; cmd.rlen = 12; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; memcpy(cmd.args, "\x12\x08\x04", 3); cmd.wlen = 3; cmd.rlen = 3; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; memcpy(cmd.args, "\x14\x00\x0c\x10\x12\x00", 6); cmd.wlen = 6; cmd.rlen = 4; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; memcpy(cmd.args, "\x14\x00\x06\x10\x24\x00", 6); cmd.wlen = 6; cmd.rlen = 4; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; memcpy(cmd.args, "\x14\x00\x07\x10\x00\x24", 6); cmd.wlen = 6; cmd.rlen = 4; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; memcpy(cmd.args, "\x14\x00\x0a\x10\x00\x00", 6); cmd.args[4] = delivery_system | bandwidth; cmd.wlen = 6; cmd.rlen = 4; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; /* set DVB-C symbol rate */ if (c->delivery_system == SYS_DVBC_ANNEX_A) { memcpy(cmd.args, "\x14\x00\x02\x11", 4); cmd.args[4] = (c->symbol_rate / 1000) & 0xff; cmd.args[5] = ((c->symbol_rate / 1000) >> 8) & 0xff; cmd.wlen = 6; cmd.rlen = 4; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; } memcpy(cmd.args, "\x14\x00\x0f\x10\x10\x00", 6); cmd.wlen = 6; cmd.rlen = 4; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; memcpy(cmd.args, "\x14\x00\x09\x10\xe3\x18", 6); cmd.wlen = 6; cmd.rlen = 4; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; memcpy(cmd.args, "\x14\x00\x08\x10\xd7\x15", 6); cmd.wlen = 6; cmd.rlen = 4; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; memcpy(cmd.args, "\x14\x00\x01\x12\x00\x00", 6); cmd.wlen = 6; cmd.rlen = 4; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; memcpy(cmd.args, "\x14\x00\x01\x03\x0c\x00", 6); cmd.wlen = 6; cmd.rlen = 4; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; memcpy(cmd.args, "\x85", 1); cmd.wlen = 1; cmd.rlen = 1; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; s->delivery_system = c->delivery_system; return 0; err: dev_dbg(&s->client->dev, "failed=%d\n", ret); return ret; } static int si2168_init(struct dvb_frontend *fe) { struct si2168 *s = fe->demodulator_priv; int ret, len, remaining; const struct firmware *fw = NULL; u8 *fw_file; const unsigned int i2c_wr_max = 8; struct si2168_cmd cmd; unsigned int chip_id; dev_dbg(&s->client->dev, "\n"); /* initialize */ memcpy(cmd.args, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00", 13); cmd.wlen = 13; cmd.rlen = 0; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; if (s->fw_loaded) { /* resume */ memcpy(cmd.args, "\xc0\x06\x08\x0f\x00\x20\x21\x01", 8); cmd.wlen = 8; cmd.rlen = 1; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; memcpy(cmd.args, "\x85", 1); cmd.wlen = 1; cmd.rlen = 1; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; goto warm; } /* power up */ memcpy(cmd.args, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8); cmd.wlen = 8; cmd.rlen = 1; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; /* query chip revision */ memcpy(cmd.args, "\x02", 1); cmd.wlen = 1; cmd.rlen = 13; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; chip_id = cmd.args[1] << 24 | cmd.args[2] << 16 | cmd.args[3] << 8 | cmd.args[4] << 0; #define SI2168_A20 ('A' << 24 | 68 << 16 | '2' << 8 | '0' << 0) #define SI2168_A30 ('A' << 24 | 68 << 16 | '3' << 8 | '0' << 0) #define SI2168_B40 ('B' << 24 | 68 << 16 | '4' << 8 | '0' << 0) switch (chip_id) { case SI2168_A20: fw_file = SI2168_A20_FIRMWARE; break; case SI2168_A30: fw_file = SI2168_A30_FIRMWARE; break; case SI2168_B40: fw_file = SI2168_B40_FIRMWARE; break; default: dev_err(&s->client->dev, "unknown chip version Si21%d-%c%c%c\n", cmd.args[2], cmd.args[1], cmd.args[3], cmd.args[4]); ret = -EINVAL; goto err; } /* cold state - try to download firmware */ dev_info(&s->client->dev, "found a '%s' in cold state\n", si2168_ops.info.name); /* request the firmware, this will block and timeout */ ret = request_firmware(&fw, fw_file, &s->client->dev); if (ret) { /* fallback mechanism to handle old name for Si2168 B40 fw */ if (chip_id == SI2168_B40) { fw_file = SI2168_B40_FIRMWARE_FALLBACK; ret = request_firmware(&fw, fw_file, &s->client->dev); } if (ret == 0) { dev_notice(&s->client->dev, "please install firmware file '%s'\n", SI2168_B40_FIRMWARE); } else { dev_err(&s->client->dev, "firmware file '%s' not found\n", fw_file); goto err; } } dev_info(&s->client->dev, "downloading firmware from file '%s'\n", fw_file); for (remaining = fw->size; remaining > 0; remaining -= i2c_wr_max) { len = remaining; if (len > i2c_wr_max) len = i2c_wr_max; memcpy(cmd.args, &fw->data[fw->size - remaining], len); cmd.wlen = len; cmd.rlen = 1; ret = si2168_cmd_execute(s, &cmd); if (ret) { dev_err(&s->client->dev, "firmware download failed=%d\n", ret); goto err; } } release_firmware(fw); fw = NULL; memcpy(cmd.args, "\x01\x01", 2); cmd.wlen = 2; cmd.rlen = 1; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; /* set ts mode */ memcpy(cmd.args, "\x14\x00\x01\x10\x10\x00", 6); cmd.args[4] |= s->ts_mode; cmd.wlen = 6; cmd.rlen = 4; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; s->fw_loaded = true; warm: dev_info(&s->client->dev, "found a '%s' in warm state\n", si2168_ops.info.name); s->active = true; return 0; err: if (fw) release_firmware(fw); dev_dbg(&s->client->dev, "failed=%d\n", ret); return ret; } static int si2168_sleep(struct dvb_frontend *fe) { struct si2168 *s = fe->demodulator_priv; int ret; struct si2168_cmd cmd; dev_dbg(&s->client->dev, "\n"); s->active = false; memcpy(cmd.args, "\x13", 1); cmd.wlen = 1; cmd.rlen = 0; ret = si2168_cmd_execute(s, &cmd); if (ret) goto err; return 0; err: dev_dbg(&s->client->dev, "failed=%d\n", ret); return ret; } static int si2168_get_tune_settings(struct dvb_frontend *fe, struct dvb_frontend_tune_settings *s) { s->min_delay_ms = 900; return 0; } /* * I2C gate logic * We must use unlocked i2c_transfer() here because I2C lock is already taken * by tuner driver. */ static int si2168_select(struct i2c_adapter *adap, void *mux_priv, u32 chan) { struct si2168 *s = mux_priv; int ret; struct i2c_msg gate_open_msg = { .addr = s->client->addr, .flags = 0, .len = 3, .buf = "\xc0\x0d\x01", }; mutex_lock(&s->i2c_mutex); /* open tuner I2C gate */ ret = __i2c_transfer(s->client->adapter, &gate_open_msg, 1); if (ret != 1) { dev_warn(&s->client->dev, "i2c write failed=%d\n", ret); if (ret >= 0) ret = -EREMOTEIO; } else { ret = 0; } return ret; } static int si2168_deselect(struct i2c_adapter *adap, void *mux_priv, u32 chan) { struct si2168 *s = mux_priv; int ret; struct i2c_msg gate_close_msg = { .addr = s->client->addr, .flags = 0, .len = 3, .buf = "\xc0\x0d\x00", }; /* close tuner I2C gate */ ret = __i2c_transfer(s->client->adapter, &gate_close_msg, 1); if (ret != 1) { dev_warn(&s->client->dev, "i2c write failed=%d\n", ret); if (ret >= 0) ret = -EREMOTEIO; } else { ret = 0; } mutex_unlock(&s->i2c_mutex); return ret; } static const struct dvb_frontend_ops si2168_ops = { .delsys = {SYS_DVBT, SYS_DVBT2, SYS_DVBC_ANNEX_A}, .info = { .name = "Silicon Labs Si2168", .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 | FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 | FE_CAN_FEC_AUTO | FE_CAN_QPSK | FE_CAN_QAM_16 | FE_CAN_QAM_32 | FE_CAN_QAM_64 | FE_CAN_QAM_128 | FE_CAN_QAM_256 | FE_CAN_QAM_AUTO | FE_CAN_TRANSMISSION_MODE_AUTO | FE_CAN_GUARD_INTERVAL_AUTO | FE_CAN_HIERARCHY_AUTO | FE_CAN_MUTE_TS | FE_CAN_2G_MODULATION | FE_CAN_MULTISTREAM }, .get_tune_settings = si2168_get_tune_settings, .init = si2168_init, .sleep = si2168_sleep, .set_frontend = si2168_set_frontend, .read_status = si2168_read_status, }; static int si2168_probe(struct i2c_client *client, const struct i2c_device_id *id) { struct si2168_config *config = client->dev.platform_data; struct si2168 *s; int ret; dev_dbg(&client->dev, "\n"); s = kzalloc(sizeof(struct si2168), GFP_KERNEL); if (!s) { ret = -ENOMEM; dev_err(&client->dev, "kzalloc() failed\n"); goto err; } s->client = client; mutex_init(&s->i2c_mutex); /* create mux i2c adapter for tuner */ s->adapter = i2c_add_mux_adapter(client->adapter, &client->dev, s, 0, 0, 0, si2168_select, si2168_deselect); if (s->adapter == NULL) { ret = -ENODEV; goto err; } /* create dvb_frontend */ memcpy(&s->fe.ops, &si2168_ops, sizeof(struct dvb_frontend_ops)); s->fe.demodulator_priv = s; *config->i2c_adapter = s->adapter; *config->fe = &s->fe; s->ts_mode = config->ts_mode; s->fw_loaded = false; i2c_set_clientdata(client, s); dev_info(&s->client->dev, "Silicon Labs Si2168 successfully attached\n"); return 0; err: kfree(s); dev_dbg(&client->dev, "failed=%d\n", ret); return ret; } static int si2168_remove(struct i2c_client *client) { struct si2168 *s = i2c_get_clientdata(client); dev_dbg(&client->dev, "\n"); i2c_del_mux_adapter(s->adapter); s->fe.ops.release = NULL; s->fe.demodulator_priv = NULL; kfree(s); return 0; } static const struct i2c_device_id si2168_id[] = { {"si2168", 0}, {} }; MODULE_DEVICE_TABLE(i2c, si2168_id); static struct i2c_driver si2168_driver = { .driver = { .owner = THIS_MODULE, .name = "si2168", }, .probe = si2168_probe, .remove = si2168_remove, .id_table = si2168_id, }; module_i2c_driver(si2168_driver); MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>"); MODULE_DESCRIPTION("Silicon Labs Si2168 DVB-T/T2/C demodulator driver"); MODULE_LICENSE("GPL"); MODULE_FIRMWARE(SI2168_A20_FIRMWARE); MODULE_FIRMWARE(SI2168_A30_FIRMWARE); MODULE_FIRMWARE(SI2168_B40_FIRMWARE);