max2165.c 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * Driver for Maxim MAX2165 silicon tuner
  4. *
  5. * Copyright (c) 2009 David T. L. Wong <davidtlwong@gmail.com>
  6. */
  7. #include <linux/module.h>
  8. #include <linux/moduleparam.h>
  9. #include <linux/videodev2.h>
  10. #include <linux/delay.h>
  11. #include <linux/dvb/frontend.h>
  12. #include <linux/i2c.h>
  13. #include <linux/slab.h>
  14. #include <media/dvb_frontend.h>
  15. #include "max2165.h"
  16. #include "max2165_priv.h"
  17. #include "tuner-i2c.h"
  18. #define dprintk(args...) \
  19. do { \
  20. if (debug) \
  21. printk(KERN_DEBUG "max2165: " args); \
  22. } while (0)
  23. static int debug;
  24. module_param(debug, int, 0644);
  25. MODULE_PARM_DESC(debug, "Turn on/off debugging (default:off).");
  26. static int max2165_write_reg(struct max2165_priv *priv, u8 reg, u8 data)
  27. {
  28. int ret;
  29. u8 buf[] = { reg, data };
  30. struct i2c_msg msg = { .flags = 0, .buf = buf, .len = 2 };
  31. msg.addr = priv->config->i2c_address;
  32. if (debug >= 2)
  33. dprintk("%s: reg=0x%02X, data=0x%02X\n", __func__, reg, data);
  34. ret = i2c_transfer(priv->i2c, &msg, 1);
  35. if (ret != 1)
  36. dprintk("%s: error reg=0x%x, data=0x%x, ret=%i\n",
  37. __func__, reg, data, ret);
  38. return (ret != 1) ? -EIO : 0;
  39. }
  40. static int max2165_read_reg(struct max2165_priv *priv, u8 reg, u8 *p_data)
  41. {
  42. int ret;
  43. u8 dev_addr = priv->config->i2c_address;
  44. u8 b0[] = { reg };
  45. u8 b1[] = { 0 };
  46. struct i2c_msg msg[] = {
  47. { .addr = dev_addr, .flags = 0, .buf = b0, .len = 1 },
  48. { .addr = dev_addr, .flags = I2C_M_RD, .buf = b1, .len = 1 },
  49. };
  50. ret = i2c_transfer(priv->i2c, msg, 2);
  51. if (ret != 2) {
  52. dprintk("%s: error reg=0x%x, ret=%i\n", __func__, reg, ret);
  53. return -EIO;
  54. }
  55. *p_data = b1[0];
  56. if (debug >= 2)
  57. dprintk("%s: reg=0x%02X, data=0x%02X\n",
  58. __func__, reg, b1[0]);
  59. return 0;
  60. }
  61. static int max2165_mask_write_reg(struct max2165_priv *priv, u8 reg,
  62. u8 mask, u8 data)
  63. {
  64. int ret;
  65. u8 v;
  66. data &= mask;
  67. ret = max2165_read_reg(priv, reg, &v);
  68. if (ret != 0)
  69. return ret;
  70. v &= ~mask;
  71. v |= data;
  72. ret = max2165_write_reg(priv, reg, v);
  73. return ret;
  74. }
  75. static int max2165_read_rom_table(struct max2165_priv *priv)
  76. {
  77. u8 dat[3];
  78. int i;
  79. for (i = 0; i < 3; i++) {
  80. max2165_write_reg(priv, REG_ROM_TABLE_ADDR, i + 1);
  81. max2165_read_reg(priv, REG_ROM_TABLE_DATA, &dat[i]);
  82. }
  83. priv->tf_ntch_low_cfg = dat[0] >> 4;
  84. priv->tf_ntch_hi_cfg = dat[0] & 0x0F;
  85. priv->tf_balun_low_ref = dat[1] & 0x0F;
  86. priv->tf_balun_hi_ref = dat[1] >> 4;
  87. priv->bb_filter_7mhz_cfg = dat[2] & 0x0F;
  88. priv->bb_filter_8mhz_cfg = dat[2] >> 4;
  89. dprintk("tf_ntch_low_cfg = 0x%X\n", priv->tf_ntch_low_cfg);
  90. dprintk("tf_ntch_hi_cfg = 0x%X\n", priv->tf_ntch_hi_cfg);
  91. dprintk("tf_balun_low_ref = 0x%X\n", priv->tf_balun_low_ref);
  92. dprintk("tf_balun_hi_ref = 0x%X\n", priv->tf_balun_hi_ref);
  93. dprintk("bb_filter_7mhz_cfg = 0x%X\n", priv->bb_filter_7mhz_cfg);
  94. dprintk("bb_filter_8mhz_cfg = 0x%X\n", priv->bb_filter_8mhz_cfg);
  95. return 0;
  96. }
  97. static int max2165_set_osc(struct max2165_priv *priv, u8 osc /*MHz*/)
  98. {
  99. u8 v;
  100. v = (osc / 2);
  101. if (v == 2)
  102. v = 0x7;
  103. else
  104. v -= 8;
  105. max2165_mask_write_reg(priv, REG_PLL_CFG, 0x07, v);
  106. return 0;
  107. }
  108. static int max2165_set_bandwidth(struct max2165_priv *priv, u32 bw)
  109. {
  110. u8 val;
  111. if (bw == 8000000)
  112. val = priv->bb_filter_8mhz_cfg;
  113. else
  114. val = priv->bb_filter_7mhz_cfg;
  115. max2165_mask_write_reg(priv, REG_BASEBAND_CTRL, 0xF0, val << 4);
  116. return 0;
  117. }
  118. static int fixpt_div32(u32 dividend, u32 divisor, u32 *quotient, u32 *fraction)
  119. {
  120. u32 remainder;
  121. u32 q, f = 0;
  122. int i;
  123. if (0 == divisor)
  124. return -EINVAL;
  125. q = dividend / divisor;
  126. remainder = dividend - q * divisor;
  127. for (i = 0; i < 31; i++) {
  128. remainder <<= 1;
  129. if (remainder >= divisor) {
  130. f += 1;
  131. remainder -= divisor;
  132. }
  133. f <<= 1;
  134. }
  135. *quotient = q;
  136. *fraction = f;
  137. return 0;
  138. }
  139. static int max2165_set_rf(struct max2165_priv *priv, u32 freq)
  140. {
  141. u8 tf;
  142. u8 tf_ntch;
  143. u32 t;
  144. u32 quotient, fraction;
  145. int ret;
  146. /* Set PLL divider according to RF frequency */
  147. ret = fixpt_div32(freq / 1000, priv->config->osc_clk * 1000,
  148. &quotient, &fraction);
  149. if (ret != 0)
  150. return ret;
  151. /* 20-bit fraction */
  152. fraction >>= 12;
  153. max2165_write_reg(priv, REG_NDIV_INT, quotient);
  154. max2165_mask_write_reg(priv, REG_NDIV_FRAC2, 0x0F, fraction >> 16);
  155. max2165_write_reg(priv, REG_NDIV_FRAC1, fraction >> 8);
  156. max2165_write_reg(priv, REG_NDIV_FRAC0, fraction);
  157. /* Norch Filter */
  158. tf_ntch = (freq < 725000000) ?
  159. priv->tf_ntch_low_cfg : priv->tf_ntch_hi_cfg;
  160. /* Tracking filter balun */
  161. t = priv->tf_balun_low_ref;
  162. t += (priv->tf_balun_hi_ref - priv->tf_balun_low_ref)
  163. * (freq / 1000 - 470000) / (780000 - 470000);
  164. tf = t;
  165. dprintk("tf = %X\n", tf);
  166. tf |= tf_ntch << 4;
  167. max2165_write_reg(priv, REG_TRACK_FILTER, tf);
  168. return 0;
  169. }
  170. static void max2165_debug_status(struct max2165_priv *priv)
  171. {
  172. u8 status, autotune;
  173. u8 auto_vco_success, auto_vco_active;
  174. u8 pll_locked;
  175. u8 dc_offset_low, dc_offset_hi;
  176. u8 signal_lv_over_threshold;
  177. u8 vco, vco_sub_band, adc;
  178. max2165_read_reg(priv, REG_STATUS, &status);
  179. max2165_read_reg(priv, REG_AUTOTUNE, &autotune);
  180. auto_vco_success = (status >> 6) & 0x01;
  181. auto_vco_active = (status >> 5) & 0x01;
  182. pll_locked = (status >> 4) & 0x01;
  183. dc_offset_low = (status >> 3) & 0x01;
  184. dc_offset_hi = (status >> 2) & 0x01;
  185. signal_lv_over_threshold = status & 0x01;
  186. vco = autotune >> 6;
  187. vco_sub_band = (autotune >> 3) & 0x7;
  188. adc = autotune & 0x7;
  189. dprintk("auto VCO active: %d, auto VCO success: %d\n",
  190. auto_vco_active, auto_vco_success);
  191. dprintk("PLL locked: %d\n", pll_locked);
  192. dprintk("DC offset low: %d, DC offset high: %d\n",
  193. dc_offset_low, dc_offset_hi);
  194. dprintk("Signal lvl over threshold: %d\n", signal_lv_over_threshold);
  195. dprintk("VCO: %d, VCO Sub-band: %d, ADC: %d\n", vco, vco_sub_band, adc);
  196. }
  197. static int max2165_set_params(struct dvb_frontend *fe)
  198. {
  199. struct max2165_priv *priv = fe->tuner_priv;
  200. struct dtv_frontend_properties *c = &fe->dtv_property_cache;
  201. int ret;
  202. switch (c->bandwidth_hz) {
  203. case 7000000:
  204. case 8000000:
  205. priv->frequency = c->frequency;
  206. break;
  207. default:
  208. printk(KERN_INFO "MAX2165: bandwidth %d Hz not supported.\n",
  209. c->bandwidth_hz);
  210. return -EINVAL;
  211. }
  212. dprintk("%s() frequency=%d\n", __func__, c->frequency);
  213. if (fe->ops.i2c_gate_ctrl)
  214. fe->ops.i2c_gate_ctrl(fe, 1);
  215. max2165_set_bandwidth(priv, c->bandwidth_hz);
  216. ret = max2165_set_rf(priv, priv->frequency);
  217. mdelay(50);
  218. max2165_debug_status(priv);
  219. if (fe->ops.i2c_gate_ctrl)
  220. fe->ops.i2c_gate_ctrl(fe, 0);
  221. if (ret != 0)
  222. return -EREMOTEIO;
  223. return 0;
  224. }
  225. static int max2165_get_frequency(struct dvb_frontend *fe, u32 *freq)
  226. {
  227. struct max2165_priv *priv = fe->tuner_priv;
  228. dprintk("%s()\n", __func__);
  229. *freq = priv->frequency;
  230. return 0;
  231. }
  232. static int max2165_get_bandwidth(struct dvb_frontend *fe, u32 *bw)
  233. {
  234. struct max2165_priv *priv = fe->tuner_priv;
  235. dprintk("%s()\n", __func__);
  236. *bw = priv->bandwidth;
  237. return 0;
  238. }
  239. static int max2165_get_status(struct dvb_frontend *fe, u32 *status)
  240. {
  241. struct max2165_priv *priv = fe->tuner_priv;
  242. u16 lock_status = 0;
  243. dprintk("%s()\n", __func__);
  244. if (fe->ops.i2c_gate_ctrl)
  245. fe->ops.i2c_gate_ctrl(fe, 1);
  246. max2165_debug_status(priv);
  247. *status = lock_status;
  248. if (fe->ops.i2c_gate_ctrl)
  249. fe->ops.i2c_gate_ctrl(fe, 0);
  250. return 0;
  251. }
  252. static int max2165_sleep(struct dvb_frontend *fe)
  253. {
  254. dprintk("%s()\n", __func__);
  255. return 0;
  256. }
  257. static int max2165_init(struct dvb_frontend *fe)
  258. {
  259. struct max2165_priv *priv = fe->tuner_priv;
  260. dprintk("%s()\n", __func__);
  261. if (fe->ops.i2c_gate_ctrl)
  262. fe->ops.i2c_gate_ctrl(fe, 1);
  263. /* Setup initial values */
  264. /* Fractional Mode on */
  265. max2165_write_reg(priv, REG_NDIV_FRAC2, 0x18);
  266. /* LNA on */
  267. max2165_write_reg(priv, REG_LNA, 0x01);
  268. max2165_write_reg(priv, REG_PLL_CFG, 0x7A);
  269. max2165_write_reg(priv, REG_TEST, 0x08);
  270. max2165_write_reg(priv, REG_SHUTDOWN, 0x40);
  271. max2165_write_reg(priv, REG_VCO_CTRL, 0x84);
  272. max2165_write_reg(priv, REG_BASEBAND_CTRL, 0xC3);
  273. max2165_write_reg(priv, REG_DC_OFFSET_CTRL, 0x75);
  274. max2165_write_reg(priv, REG_DC_OFFSET_DAC, 0x00);
  275. max2165_write_reg(priv, REG_ROM_TABLE_ADDR, 0x00);
  276. max2165_set_osc(priv, priv->config->osc_clk);
  277. max2165_read_rom_table(priv);
  278. max2165_set_bandwidth(priv, 8000000);
  279. if (fe->ops.i2c_gate_ctrl)
  280. fe->ops.i2c_gate_ctrl(fe, 0);
  281. return 0;
  282. }
  283. static void max2165_release(struct dvb_frontend *fe)
  284. {
  285. struct max2165_priv *priv = fe->tuner_priv;
  286. dprintk("%s()\n", __func__);
  287. kfree(priv);
  288. fe->tuner_priv = NULL;
  289. }
  290. static const struct dvb_tuner_ops max2165_tuner_ops = {
  291. .info = {
  292. .name = "Maxim MAX2165",
  293. .frequency_min_hz = 470 * MHz,
  294. .frequency_max_hz = 862 * MHz,
  295. .frequency_step_hz = 50 * kHz,
  296. },
  297. .release = max2165_release,
  298. .init = max2165_init,
  299. .sleep = max2165_sleep,
  300. .set_params = max2165_set_params,
  301. .set_analog_params = NULL,
  302. .get_frequency = max2165_get_frequency,
  303. .get_bandwidth = max2165_get_bandwidth,
  304. .get_status = max2165_get_status
  305. };
  306. struct dvb_frontend *max2165_attach(struct dvb_frontend *fe,
  307. struct i2c_adapter *i2c,
  308. struct max2165_config *cfg)
  309. {
  310. struct max2165_priv *priv = NULL;
  311. dprintk("%s(%d-%04x)\n", __func__,
  312. i2c ? i2c_adapter_id(i2c) : -1,
  313. cfg ? cfg->i2c_address : -1);
  314. priv = kzalloc(sizeof(struct max2165_priv), GFP_KERNEL);
  315. if (priv == NULL)
  316. return NULL;
  317. memcpy(&fe->ops.tuner_ops, &max2165_tuner_ops,
  318. sizeof(struct dvb_tuner_ops));
  319. priv->config = cfg;
  320. priv->i2c = i2c;
  321. fe->tuner_priv = priv;
  322. max2165_init(fe);
  323. max2165_debug_status(priv);
  324. return fe;
  325. }
  326. EXPORT_SYMBOL(max2165_attach);
  327. MODULE_AUTHOR("David T. L. Wong <davidtlwong@gmail.com>");
  328. MODULE_DESCRIPTION("Maxim MAX2165 silicon tuner driver");
  329. MODULE_LICENSE("GPL");