si2157.c 8.4 KB
Newer Older
1
/*
2
 * Silicon Labs Si2157/2158 silicon tuner driver
3 4 5 6 7 8 9 10 11 12 13 14 15 16
 *
 * 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.
 */

17 18
#include "si2157_priv.h"

19 20
static const struct dvb_tuner_ops si2157_ops;

21 22 23 24 25 26 27 28
/* execute firmware command */
static int si2157_cmd_execute(struct si2157 *s, struct si2157_cmd *cmd)
{
	int ret;
	unsigned long timeout;

	mutex_lock(&s->i2c_mutex);

29
	if (cmd->wlen) {
30
		/* write cmd and args for firmware */
31
		ret = i2c_master_send(s->client, cmd->args, cmd->wlen);
32 33
		if (ret < 0) {
			goto err_mutex_unlock;
34
		} else if (ret != cmd->wlen) {
35 36 37 38 39
			ret = -EREMOTEIO;
			goto err_mutex_unlock;
		}
	}

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
	if (cmd->rlen) {
		/* wait cmd execution terminate */
		#define TIMEOUT 80
		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;
56 57
		}

O
Olli Salonen 已提交
58
		dev_dbg(&s->client->dev, "cmd execution took %d ms\n",
59 60
				jiffies_to_msecs(jiffies) -
				(jiffies_to_msecs(timeout) - TIMEOUT));
61

62 63 64 65
		if (!((cmd->args[0] >> 7) & 0x01)) {
			ret = -ETIMEDOUT;
			goto err_mutex_unlock;
		}
66 67
	}

68 69
	ret = 0;

70 71 72 73 74 75 76
err_mutex_unlock:
	mutex_unlock(&s->i2c_mutex);
	if (ret)
		goto err;

	return 0;
err:
O
Olli Salonen 已提交
77
	dev_dbg(&s->client->dev, "failed=%d\n", ret);
78 79 80 81 82 83
	return ret;
}

static int si2157_init(struct dvb_frontend *fe)
{
	struct si2157 *s = fe->tuner_priv;
84
	int ret, len, remaining;
85
	struct si2157_cmd cmd;
86 87
	const struct firmware *fw = NULL;
	u8 *fw_file;
88
	unsigned int chip_id;
89

O
Olli Salonen 已提交
90
	dev_dbg(&s->client->dev, "\n");
91

92 93 94 95
	if (s->fw_loaded)
		goto warm;

	/* power up */
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
	memcpy(cmd.args, "\xc0\x00\x0c\x00\x00\x01\x01\x01\x01\x01\x01\x02\x00\x00\x01", 15);
	cmd.wlen = 15;
	cmd.rlen = 1;
	ret = si2157_cmd_execute(s, &cmd);
	if (ret)
		goto err;

	/* query chip revision */
	memcpy(cmd.args, "\x02", 1);
	cmd.wlen = 1;
	cmd.rlen = 13;
	ret = si2157_cmd_execute(s, &cmd);
	if (ret)
		goto err;

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
	chip_id = cmd.args[1] << 24 | cmd.args[2] << 16 | cmd.args[3] << 8 |
			cmd.args[4] << 0;

	#define SI2158_A20 ('A' << 24 | 58 << 16 | '2' << 8 | '0' << 0)
	#define SI2157_A30 ('A' << 24 | 57 << 16 | '3' << 8 | '0' << 0)

	switch (chip_id) {
	case SI2158_A20:
		fw_file = SI2158_A20_FIRMWARE;
		break;
	case SI2157_A30:
		goto skip_fw_download;
		break;
	default:
		dev_err(&s->client->dev,
O
Olli Salonen 已提交
126 127
				"unknown chip version Si21%d-%c%c%c\n",
				cmd.args[2], cmd.args[1],
128 129 130 131
				cmd.args[3], cmd.args[4]);
		ret = -EINVAL;
		goto err;
	}
132

133
	/* cold state - try to download firmware */
O
Olli Salonen 已提交
134 135
	dev_info(&s->client->dev, "found a '%s' in cold state\n",
			si2157_ops.info.name);
136

137 138 139
	/* request the firmware, this will block and timeout */
	ret = request_firmware(&fw, fw_file, &s->client->dev);
	if (ret) {
O
Olli Salonen 已提交
140 141
		dev_err(&s->client->dev, "firmware file '%s' not found\n",
				fw_file);
142 143
		goto err;
	}
144

145 146
	/* firmware should be n chunks of 17 bytes */
	if (fw->size % 17 != 0) {
O
Olli Salonen 已提交
147 148
		dev_err(&s->client->dev, "firmware file '%s' is invalid\n",
				fw_file);
149 150 151
		ret = -EINVAL;
		goto err;
	}
152

O
Olli Salonen 已提交
153 154
	dev_info(&s->client->dev, "downloading firmware from file '%s'\n",
			fw_file);
155

156 157 158 159 160 161 162 163
	for (remaining = fw->size; remaining > 0; remaining -= 17) {
		len = fw->data[fw->size - remaining];
		memcpy(cmd.args, &fw->data[(fw->size - remaining) + 1], len);
		cmd.wlen = len;
		cmd.rlen = 1;
		ret = si2157_cmd_execute(s, &cmd);
		if (ret) {
			dev_err(&s->client->dev,
O
Olli Salonen 已提交
164 165
					"firmware download failed=%d\n",
					ret);
166
			goto err;
167 168 169
		}
	}

170 171 172 173
	release_firmware(fw);
	fw = NULL;

skip_fw_download:
174 175 176 177 178 179 180 181
	/* reboot the tuner with new firmware? */
	memcpy(cmd.args, "\x01\x01", 2);
	cmd.wlen = 2;
	cmd.rlen = 1;
	ret = si2157_cmd_execute(s, &cmd);
	if (ret)
		goto err;

182
	s->fw_loaded = true;
183

184 185
warm:
	s->active = true;
186
	return 0;
187

188
err:
189 190 191
	if (fw)
		release_firmware(fw);

O
Olli Salonen 已提交
192
	dev_dbg(&s->client->dev, "failed=%d\n", ret);
193
	return ret;
194 195 196 197 198
}

static int si2157_sleep(struct dvb_frontend *fe)
{
	struct si2157 *s = fe->tuner_priv;
199 200
	int ret;
	struct si2157_cmd cmd;
201

O
Olli Salonen 已提交
202
	dev_dbg(&s->client->dev, "\n");
203 204 205

	s->active = false;

206 207 208 209
	/* standby */
	memcpy(cmd.args, "\x16\x00", 2);
	cmd.wlen = 2;
	cmd.rlen = 1;
210 211 212 213
	ret = si2157_cmd_execute(s, &cmd);
	if (ret)
		goto err;

214
	return 0;
215
err:
O
Olli Salonen 已提交
216
	dev_dbg(&s->client->dev, "failed=%d\n", ret);
217
	return ret;
218 219 220 221 222 223 224 225
}

static int si2157_set_params(struct dvb_frontend *fe)
{
	struct si2157 *s = fe->tuner_priv;
	struct dtv_frontend_properties *c = &fe->dtv_property_cache;
	int ret;
	struct si2157_cmd cmd;
226
	u8 bandwidth, delivery_system;
227 228

	dev_dbg(&s->client->dev,
O
Olli Salonen 已提交
229 230
			"delivery_system=%d frequency=%u bandwidth_hz=%u\n",
			c->delivery_system, c->frequency,
231 232 233 234 235 236 237
			c->bandwidth_hz);

	if (!s->active) {
		ret = -EAGAIN;
		goto err;
	}

238 239 240 241 242 243 244 245 246 247
	if (c->bandwidth_hz <= 6000000)
		bandwidth = 0x06;
	else if (c->bandwidth_hz <= 7000000)
		bandwidth = 0x07;
	else if (c->bandwidth_hz <= 8000000)
		bandwidth = 0x08;
	else
		bandwidth = 0x0f;

	switch (c->delivery_system) {
248 249 250
	case SYS_ATSC:
			delivery_system = 0x00;
			break;
251 252 253 254 255 256 257 258 259 260 261 262 263 264
	case SYS_DVBT:
	case SYS_DVBT2: /* it seems DVB-T and DVB-T2 both are 0x20 here */
			delivery_system = 0x20;
			break;
	case SYS_DVBC_ANNEX_A:
			delivery_system = 0x30;
			break;
	default:
			ret = -EINVAL;
			goto err;
	}

	memcpy(cmd.args, "\x14\x00\x03\x07\x00\x00", 6);
	cmd.args[4] = delivery_system | bandwidth;
265 266
	if (s->inversion)
		cmd.args[5] = 0x01;
267 268 269 270 271 272
	cmd.wlen = 6;
	cmd.rlen = 1;
	ret = si2157_cmd_execute(s, &cmd);
	if (ret)
		goto err;

273
	/* set frequency */
274
	memcpy(cmd.args, "\x41\x00\x00\x00\x00\x00\x00\x00", 8);
275 276 277 278
	cmd.args[4] = (c->frequency >>  0) & 0xff;
	cmd.args[5] = (c->frequency >>  8) & 0xff;
	cmd.args[6] = (c->frequency >> 16) & 0xff;
	cmd.args[7] = (c->frequency >> 24) & 0xff;
279 280
	cmd.wlen = 8;
	cmd.rlen = 1;
281 282 283 284 285 286
	ret = si2157_cmd_execute(s, &cmd);
	if (ret)
		goto err;

	return 0;
err:
O
Olli Salonen 已提交
287
	dev_dbg(&s->client->dev, "failed=%d\n", ret);
288 289 290
	return ret;
}

291 292 293 294 295 296
static int si2157_get_if_frequency(struct dvb_frontend *fe, u32 *frequency)
{
	*frequency = 5000000; /* default value of property 0x0706 */
	return 0;
}

297
static const struct dvb_tuner_ops si2157_ops = {
298
	.info = {
299
		.name           = "Silicon Labs Si2157/Si2158",
300
		.frequency_min  = 110000000,
301 302 303 304 305 306
		.frequency_max  = 862000000,
	},

	.init = si2157_init,
	.sleep = si2157_sleep,
	.set_params = si2157_set_params,
307
	.get_if_frequency = si2157_get_if_frequency,
308 309 310 311 312 313 314 315 316 317 318 319 320 321
};

static int si2157_probe(struct i2c_client *client,
		const struct i2c_device_id *id)
{
	struct si2157_config *cfg = client->dev.platform_data;
	struct dvb_frontend *fe = cfg->fe;
	struct si2157 *s;
	struct si2157_cmd cmd;
	int ret;

	s = kzalloc(sizeof(struct si2157), GFP_KERNEL);
	if (!s) {
		ret = -ENOMEM;
O
Olli Salonen 已提交
322
		dev_err(&client->dev, "kzalloc() failed\n");
323 324 325 326 327
		goto err;
	}

	s->client = client;
	s->fe = cfg->fe;
328
	s->inversion = cfg->inversion;
329
	s->fw_loaded = false;
330 331 332
	mutex_init(&s->i2c_mutex);

	/* check if the tuner is there */
333 334
	cmd.wlen = 0;
	cmd.rlen = 1;
335 336 337 338 339
	ret = si2157_cmd_execute(s, &cmd);
	if (ret)
		goto err;

	fe->tuner_priv = s;
340
	memcpy(&fe->ops.tuner_ops, &si2157_ops,
341 342 343 344 345
			sizeof(struct dvb_tuner_ops));

	i2c_set_clientdata(client, s);

	dev_info(&s->client->dev,
O
Olli Salonen 已提交
346
			"Silicon Labs Si2157/Si2158 successfully attached\n");
347 348
	return 0;
err:
O
Olli Salonen 已提交
349
	dev_dbg(&client->dev, "failed=%d\n", ret);
350 351 352 353 354 355 356 357 358 359
	kfree(s);

	return ret;
}

static int si2157_remove(struct i2c_client *client)
{
	struct si2157 *s = i2c_get_clientdata(client);
	struct dvb_frontend *fe = s->fe;

O
Olli Salonen 已提交
360
	dev_dbg(&client->dev, "\n");
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386

	memset(&fe->ops.tuner_ops, 0, sizeof(struct dvb_tuner_ops));
	fe->tuner_priv = NULL;
	kfree(s);

	return 0;
}

static const struct i2c_device_id si2157_id[] = {
	{"si2157", 0},
	{}
};
MODULE_DEVICE_TABLE(i2c, si2157_id);

static struct i2c_driver si2157_driver = {
	.driver = {
		.owner	= THIS_MODULE,
		.name	= "si2157",
	},
	.probe		= si2157_probe,
	.remove		= si2157_remove,
	.id_table	= si2157_id,
};

module_i2c_driver(si2157_driver);

387
MODULE_DESCRIPTION("Silicon Labs Si2157/Si2158 silicon tuner driver");
388 389
MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
MODULE_LICENSE("GPL");
390
MODULE_FIRMWARE(SI2158_A20_FIRMWARE);