]> Pileus Git - ~andy/linux/blob - drivers/media/dvb/dvb-usb/friio-fe.c
Merge git://git.kernel.org/pub/scm/linux/kernel/git/sfrench/cifs-2.6
[~andy/linux] / drivers / media / dvb / dvb-usb / friio-fe.c
1 /* DVB USB compliant Linux driver for the Friio USB2.0 ISDB-T receiver.
2  *
3  * Copyright (C) 2009 Akihiro Tsukada <tskd2@yahoo.co.jp>
4  *
5  * This module is based off the the gl861 and vp702x modules.
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License as published by the Free
9  * Software Foundation, version 2.
10  *
11  * see Documentation/dvb/README.dvb-usb for more information
12  */
13 #include <linux/init.h>
14 #include <linux/string.h>
15 #include <linux/slab.h>
16
17 #include "friio.h"
18
19 struct jdvbt90502_state {
20         struct i2c_adapter *i2c;
21         struct dvb_frontend frontend;
22         struct jdvbt90502_config config;
23 };
24
25 /* NOTE: TC90502 has 16bit register-address? */
26 /* register 0x0100 is used for reading PLL status, so reg is u16 here */
27 static int jdvbt90502_reg_read(struct jdvbt90502_state *state,
28                                const u16 reg, u8 *buf, const size_t count)
29 {
30         int ret;
31         u8 wbuf[3];
32         struct i2c_msg msg[2];
33
34         wbuf[0] = reg & 0xFF;
35         wbuf[1] = 0;
36         wbuf[2] = reg >> 8;
37
38         msg[0].addr = state->config.demod_address;
39         msg[0].flags = 0;
40         msg[0].buf = wbuf;
41         msg[0].len = sizeof(wbuf);
42
43         msg[1].addr = msg[0].addr;
44         msg[1].flags = I2C_M_RD;
45         msg[1].buf = buf;
46         msg[1].len = count;
47
48         ret = i2c_transfer(state->i2c, msg, 2);
49         if (ret != 2) {
50                 deb_fe(" reg read failed.\n");
51                 return -EREMOTEIO;
52         }
53         return 0;
54 }
55
56 /* currently 16bit register-address is not used, so reg is u8 here */
57 static int jdvbt90502_single_reg_write(struct jdvbt90502_state *state,
58                                        const u8 reg, const u8 val)
59 {
60         struct i2c_msg msg;
61         u8 wbuf[2];
62
63         wbuf[0] = reg;
64         wbuf[1] = val;
65
66         msg.addr = state->config.demod_address;
67         msg.flags = 0;
68         msg.buf = wbuf;
69         msg.len = sizeof(wbuf);
70
71         if (i2c_transfer(state->i2c, &msg, 1) != 1) {
72                 deb_fe(" reg write failed.");
73                 return -EREMOTEIO;
74         }
75         return 0;
76 }
77
78 static int _jdvbt90502_write(struct dvb_frontend *fe, u8 *buf, int len)
79 {
80         struct jdvbt90502_state *state = fe->demodulator_priv;
81         int err, i;
82         for (i = 0; i < len - 1; i++) {
83                 err = jdvbt90502_single_reg_write(state,
84                                                   buf[0] + i, buf[i + 1]);
85                 if (err)
86                         return err;
87         }
88
89         return 0;
90 }
91
92 /* read pll status byte via the demodulator's I2C register */
93 /* note: Win box reads it by 8B block at the I2C addr 0x30 from reg:0x80 */
94 static int jdvbt90502_pll_read(struct jdvbt90502_state *state, u8 *result)
95 {
96         int ret;
97
98         /* +1 for reading */
99         u8 pll_addr_byte = (state->config.pll_address << 1) + 1;
100
101         *result = 0;
102
103         ret = jdvbt90502_single_reg_write(state, JDVBT90502_2ND_I2C_REG,
104                                           pll_addr_byte);
105         if (ret)
106                 goto error;
107
108         ret = jdvbt90502_reg_read(state, 0x0100, result, 1);
109         if (ret)
110                 goto error;
111
112         deb_fe("PLL read val:%02x\n", *result);
113         return 0;
114
115 error:
116         deb_fe("%s:ret == %d\n", __func__, ret);
117         return -EREMOTEIO;
118 }
119
120
121 /* set pll frequency via the demodulator's I2C register */
122 static int jdvbt90502_pll_set_freq(struct jdvbt90502_state *state, u32 freq)
123 {
124         int ret;
125         int retry;
126         u8 res1;
127         u8 res2[9];
128
129         u8 pll_freq_cmd[PLL_CMD_LEN];
130         u8 pll_agc_cmd[PLL_CMD_LEN];
131         struct i2c_msg msg[2];
132         u32 f;
133
134         deb_fe("%s: freq=%d, step=%d\n", __func__, freq,
135                state->frontend.ops.info.frequency_stepsize);
136         /* freq -> oscilator frequency conversion. */
137         /* freq: 473,000,000 + n*6,000,000 (no 1/7MHz shift to center freq) */
138         /* add 400[1/7 MHZ] = 57.142857MHz.   57MHz for the IF,  */
139         /*                                   1/7MHz for center freq shift */
140         f = freq / state->frontend.ops.info.frequency_stepsize;
141         f += 400;
142         pll_freq_cmd[DEMOD_REDIRECT_REG] = JDVBT90502_2ND_I2C_REG; /* 0xFE */
143         pll_freq_cmd[ADDRESS_BYTE] = state->config.pll_address << 1;
144         pll_freq_cmd[DIVIDER_BYTE1] = (f >> 8) & 0x7F;
145         pll_freq_cmd[DIVIDER_BYTE2] = f & 0xFF;
146         pll_freq_cmd[CONTROL_BYTE] = 0xB2; /* ref.divider:28, 4MHz/28=1/7MHz */
147         pll_freq_cmd[BANDSWITCH_BYTE] = 0x08;   /* UHF band */
148
149         msg[0].addr = state->config.demod_address;
150         msg[0].flags = 0;
151         msg[0].buf = pll_freq_cmd;
152         msg[0].len = sizeof(pll_freq_cmd);
153
154         ret = i2c_transfer(state->i2c, &msg[0], 1);
155         if (ret != 1)
156                 goto error;
157
158         udelay(50);
159
160         pll_agc_cmd[DEMOD_REDIRECT_REG] = pll_freq_cmd[DEMOD_REDIRECT_REG];
161         pll_agc_cmd[ADDRESS_BYTE] = pll_freq_cmd[ADDRESS_BYTE];
162         pll_agc_cmd[DIVIDER_BYTE1] = pll_freq_cmd[DIVIDER_BYTE1];
163         pll_agc_cmd[DIVIDER_BYTE2] = pll_freq_cmd[DIVIDER_BYTE2];
164         pll_agc_cmd[CONTROL_BYTE] = 0x9A; /*  AGC_CTRL instead of BANDSWITCH */
165         pll_agc_cmd[AGC_CTRL_BYTE] = 0x50;
166         /* AGC Time Constant 2s, AGC take-over point:103dBuV(lowest) */
167
168         msg[1].addr = msg[0].addr;
169         msg[1].flags = 0;
170         msg[1].buf = pll_agc_cmd;
171         msg[1].len = sizeof(pll_agc_cmd);
172
173         ret = i2c_transfer(state->i2c, &msg[1], 1);
174         if (ret != 1)
175                 goto error;
176
177         /* I don't know what these cmds are for,  */
178         /* but the USB log on a windows box contains them */
179         ret = jdvbt90502_single_reg_write(state, 0x01, 0x40);
180         ret |= jdvbt90502_single_reg_write(state, 0x01, 0x00);
181         if (ret)
182                 goto error;
183         udelay(100);
184
185         /* wait for the demod to be ready? */
186 #define RETRY_COUNT 5
187         for (retry = 0; retry < RETRY_COUNT; retry++) {
188                 ret = jdvbt90502_reg_read(state, 0x0096, &res1, 1);
189                 if (ret)
190                         goto error;
191                 /* if (res1 != 0x00) goto error; */
192                 ret = jdvbt90502_reg_read(state, 0x00B0, res2, sizeof(res2));
193                 if (ret)
194                         goto error;
195                 if (res2[0] >= 0xA7)
196                         break;
197                 msleep(100);
198         }
199         if (retry >= RETRY_COUNT) {
200                 deb_fe("%s: FE does not get ready after freq setting.\n",
201                        __func__);
202                 return -EREMOTEIO;
203         }
204
205         return 0;
206 error:
207         deb_fe("%s:ret == %d\n", __func__, ret);
208         return -EREMOTEIO;
209 }
210
211 static int jdvbt90502_read_status(struct dvb_frontend *fe, fe_status_t *state)
212 {
213         u8 result;
214         int ret;
215
216         *state = FE_HAS_SIGNAL;
217
218         ret = jdvbt90502_pll_read(fe->demodulator_priv, &result);
219         if (ret) {
220                 deb_fe("%s:ret == %d\n", __func__, ret);
221                 return -EREMOTEIO;
222         }
223
224         *state = FE_HAS_SIGNAL
225                 | FE_HAS_CARRIER
226                 | FE_HAS_VITERBI
227                 | FE_HAS_SYNC;
228
229         if (result & PLL_STATUS_LOCKED)
230                 *state |= FE_HAS_LOCK;
231
232         return 0;
233 }
234
235 static int jdvbt90502_read_ber(struct dvb_frontend *fe, u32 *ber)
236 {
237         *ber = 0;
238         return 0;
239 }
240
241 static int jdvbt90502_read_signal_strength(struct dvb_frontend *fe,
242                                            u16 *strength)
243 {
244         int ret;
245         u8 rbuf[37];
246
247         *strength = 0;
248
249         /* status register (incl. signal strength) : 0x89  */
250         /* TODO: read just the necessary registers [0x8B..0x8D]? */
251         ret = jdvbt90502_reg_read(fe->demodulator_priv, 0x0089,
252                                   rbuf, sizeof(rbuf));
253
254         if (ret) {
255                 deb_fe("%s:ret == %d\n", __func__, ret);
256                 return -EREMOTEIO;
257         }
258
259         /* signal_strength: rbuf[2-4] (24bit BE), use lower 16bit for now. */
260         *strength = (rbuf[3] << 8) + rbuf[4];
261         if (rbuf[2])
262                 *strength = 0xffff;
263
264         return 0;
265 }
266
267 static int jdvbt90502_read_snr(struct dvb_frontend *fe, u16 *snr)
268 {
269         *snr = 0x0101;
270         return 0;
271 }
272
273 static int jdvbt90502_read_ucblocks(struct dvb_frontend *fe, u32 *ucblocks)
274 {
275         *ucblocks = 0;
276         return 0;
277 }
278
279 static int jdvbt90502_get_tune_settings(struct dvb_frontend *fe,
280                                         struct dvb_frontend_tune_settings *fs)
281 {
282         fs->min_delay_ms = 500;
283         fs->step_size = 0;
284         fs->max_drift = 0;
285
286         return 0;
287 }
288
289 static int jdvbt90502_get_frontend(struct dvb_frontend *fe,
290                                    struct dvb_frontend_parameters *p)
291 {
292         p->inversion = INVERSION_AUTO;
293         p->u.ofdm.bandwidth = BANDWIDTH_6_MHZ;
294         p->u.ofdm.code_rate_HP = FEC_AUTO;
295         p->u.ofdm.code_rate_LP = FEC_AUTO;
296         p->u.ofdm.constellation = QAM_64;
297         p->u.ofdm.transmission_mode = TRANSMISSION_MODE_AUTO;
298         p->u.ofdm.guard_interval = GUARD_INTERVAL_AUTO;
299         p->u.ofdm.hierarchy_information = HIERARCHY_AUTO;
300         return 0;
301 }
302
303 static int jdvbt90502_set_frontend(struct dvb_frontend *fe,
304                                    struct dvb_frontend_parameters *p)
305 {
306         /**
307          * NOTE: ignore all the paramters except frequency.
308          *       others should be fixed to the proper value for ISDB-T,
309          *       but don't check here.
310          */
311
312         struct jdvbt90502_state *state = fe->demodulator_priv;
313         int ret;
314
315         deb_fe("%s: Freq:%d\n", __func__, p->frequency);
316
317         ret = jdvbt90502_pll_set_freq(state, p->frequency);
318         if (ret) {
319                 deb_fe("%s:ret == %d\n", __func__, ret);
320                 return -EREMOTEIO;
321         }
322
323         return 0;
324 }
325
326 static int jdvbt90502_sleep(struct dvb_frontend *fe)
327 {
328         deb_fe("%s called.\n", __func__);
329         return 0;
330 }
331
332
333 /**
334  * (reg, val) commad list to initialize this module.
335  *  captured on a Windows box.
336  */
337 static u8 init_code[][2] = {
338         {0x01, 0x40},
339         {0x04, 0x38},
340         {0x05, 0x40},
341         {0x07, 0x40},
342         {0x0F, 0x4F},
343         {0x11, 0x21},
344         {0x12, 0x0B},
345         {0x13, 0x2F},
346         {0x14, 0x31},
347         {0x16, 0x02},
348         {0x21, 0xC4},
349         {0x22, 0x20},
350         {0x2C, 0x79},
351         {0x2D, 0x34},
352         {0x2F, 0x00},
353         {0x30, 0x28},
354         {0x31, 0x31},
355         {0x32, 0xDF},
356         {0x38, 0x01},
357         {0x39, 0x78},
358         {0x3B, 0x33},
359         {0x3C, 0x33},
360         {0x48, 0x90},
361         {0x51, 0x68},
362         {0x5E, 0x38},
363         {0x71, 0x00},
364         {0x72, 0x08},
365         {0x77, 0x00},
366         {0xC0, 0x21},
367         {0xC1, 0x10},
368         {0xE4, 0x1A},
369         {0xEA, 0x1F},
370         {0x77, 0x00},
371         {0x71, 0x00},
372         {0x71, 0x00},
373         {0x76, 0x0C},
374 };
375
376 const static int init_code_len = sizeof(init_code) / sizeof(u8[2]);
377
378 static int jdvbt90502_init(struct dvb_frontend *fe)
379 {
380         int i = -1;
381         int ret;
382         struct i2c_msg msg;
383
384         struct jdvbt90502_state *state = fe->demodulator_priv;
385
386         deb_fe("%s called.\n", __func__);
387
388         msg.addr = state->config.demod_address;
389         msg.flags = 0;
390         msg.len = 2;
391         for (i = 0; i < init_code_len; i++) {
392                 msg.buf = init_code[i];
393                 ret = i2c_transfer(state->i2c, &msg, 1);
394                 if (ret != 1)
395                         goto error;
396         }
397         msleep(100);
398
399         return 0;
400
401 error:
402         deb_fe("%s: init_code[%d] failed. ret==%d\n", __func__, i, ret);
403         return -EREMOTEIO;
404 }
405
406
407 static void jdvbt90502_release(struct dvb_frontend *fe)
408 {
409         struct jdvbt90502_state *state = fe->demodulator_priv;
410         kfree(state);
411 }
412
413
414 static struct dvb_frontend_ops jdvbt90502_ops;
415
416 struct dvb_frontend *jdvbt90502_attach(struct dvb_usb_device *d)
417 {
418         struct jdvbt90502_state *state = NULL;
419
420         deb_info("%s called.\n", __func__);
421
422         /* allocate memory for the internal state */
423         state = kzalloc(sizeof(struct jdvbt90502_state), GFP_KERNEL);
424         if (state == NULL)
425                 goto error;
426
427         /* setup the state */
428         state->i2c = &d->i2c_adap;
429         memcpy(&state->config, &friio_fe_config, sizeof(friio_fe_config));
430
431         /* create dvb_frontend */
432         memcpy(&state->frontend.ops, &jdvbt90502_ops,
433                sizeof(jdvbt90502_ops));
434         state->frontend.demodulator_priv = state;
435
436         if (jdvbt90502_init(&state->frontend) < 0)
437                 goto error;
438
439         return &state->frontend;
440
441 error:
442         kfree(state);
443         return NULL;
444 }
445
446 static struct dvb_frontend_ops jdvbt90502_ops = {
447
448         .info = {
449                 .name                   = "Comtech JDVBT90502 ISDB-T",
450                 .type                   = FE_OFDM,
451                 .frequency_min          = 473000000, /* UHF 13ch, center */
452                 .frequency_max          = 767142857, /* UHF 62ch, center */
453                 .frequency_stepsize     = JDVBT90502_PLL_CLK /
454                                                         JDVBT90502_PLL_DIVIDER,
455                 .frequency_tolerance    = 0,
456
457                 /* NOTE: this driver ignores all parameters but frequency. */
458                 .caps = FE_CAN_INVERSION_AUTO |
459                         FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
460                         FE_CAN_FEC_4_5 | FE_CAN_FEC_5_6 | FE_CAN_FEC_6_7 |
461                         FE_CAN_FEC_7_8 | FE_CAN_FEC_8_9 | FE_CAN_FEC_AUTO |
462                         FE_CAN_QAM_16 | FE_CAN_QAM_64 | FE_CAN_QAM_AUTO |
463                         FE_CAN_TRANSMISSION_MODE_AUTO |
464                         FE_CAN_GUARD_INTERVAL_AUTO |
465                         FE_CAN_HIERARCHY_AUTO,
466         },
467
468         .release = jdvbt90502_release,
469
470         .init = jdvbt90502_init,
471         .sleep = jdvbt90502_sleep,
472         .write = _jdvbt90502_write,
473
474         .set_frontend = jdvbt90502_set_frontend,
475         .get_frontend = jdvbt90502_get_frontend,
476         .get_tune_settings = jdvbt90502_get_tune_settings,
477
478         .read_status = jdvbt90502_read_status,
479         .read_ber = jdvbt90502_read_ber,
480         .read_signal_strength = jdvbt90502_read_signal_strength,
481         .read_snr = jdvbt90502_read_snr,
482         .read_ucblocks = jdvbt90502_read_ucblocks,
483 };