clk-si5351.c 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578
  1. /*
  2. * clk-si5351.c: Silicon Laboratories Si5351A/B/C I2C Clock Generator
  3. *
  4. * Sebastian Hesselbarth <sebastian.hesselbarth@gmail.com>
  5. * Rabeeh Khoury <rabeeh@solid-run.com>
  6. *
  7. * References:
  8. * [1] "Si5351A/B/C Data Sheet"
  9. * http://www.silabs.com/Support%20Documents/TechnicalDocs/Si5351.pdf
  10. * [2] "Manually Generating an Si5351 Register Map"
  11. * http://www.silabs.com/Support%20Documents/TechnicalDocs/AN619.pdf
  12. *
  13. * This program is free software; you can redistribute it and/or modify it
  14. * under the terms of the GNU General Public License as published by the
  15. * Free Software Foundation; either version 2 of the License, or (at your
  16. * option) any later version.
  17. */
  18. #include <linux/module.h>
  19. #include <linux/kernel.h>
  20. #include <linux/clkdev.h>
  21. #include <linux/clk-provider.h>
  22. #include <linux/delay.h>
  23. #include <linux/err.h>
  24. #include <linux/errno.h>
  25. #include <linux/rational.h>
  26. #include <linux/i2c.h>
  27. #include <linux/of_platform.h>
  28. #include <linux/platform_data/si5351.h>
  29. #include <linux/regmap.h>
  30. #include <linux/slab.h>
  31. #include <linux/string.h>
  32. #include <asm/div64.h>
  33. #include "clk-si5351.h"
  34. struct si5351_driver_data;
  35. struct si5351_parameters {
  36. unsigned long p1;
  37. unsigned long p2;
  38. unsigned long p3;
  39. int valid;
  40. };
  41. struct si5351_hw_data {
  42. struct clk_hw hw;
  43. struct si5351_driver_data *drvdata;
  44. struct si5351_parameters params;
  45. unsigned char num;
  46. };
  47. struct si5351_driver_data {
  48. enum si5351_variant variant;
  49. struct i2c_client *client;
  50. struct regmap *regmap;
  51. struct clk_onecell_data onecell;
  52. struct clk *pxtal;
  53. const char *pxtal_name;
  54. struct clk_hw xtal;
  55. struct clk *pclkin;
  56. const char *pclkin_name;
  57. struct clk_hw clkin;
  58. struct si5351_hw_data pll[2];
  59. struct si5351_hw_data *msynth;
  60. struct si5351_hw_data *clkout;
  61. };
  62. static const char const *si5351_input_names[] = {
  63. "xtal", "clkin"
  64. };
  65. static const char const *si5351_pll_names[] = {
  66. "plla", "pllb", "vxco"
  67. };
  68. static const char const *si5351_msynth_names[] = {
  69. "ms0", "ms1", "ms2", "ms3", "ms4", "ms5", "ms6", "ms7"
  70. };
  71. static const char const *si5351_clkout_names[] = {
  72. "clk0", "clk1", "clk2", "clk3", "clk4", "clk5", "clk6", "clk7"
  73. };
  74. /*
  75. * Si5351 i2c regmap
  76. */
  77. static inline u8 si5351_reg_read(struct si5351_driver_data *drvdata, u8 reg)
  78. {
  79. u32 val;
  80. int ret;
  81. ret = regmap_read(drvdata->regmap, reg, &val);
  82. if (ret) {
  83. dev_err(&drvdata->client->dev,
  84. "unable to read from reg%02x\n", reg);
  85. return 0;
  86. }
  87. return (u8)val;
  88. }
  89. static inline int si5351_bulk_read(struct si5351_driver_data *drvdata,
  90. u8 reg, u8 count, u8 *buf)
  91. {
  92. return regmap_bulk_read(drvdata->regmap, reg, buf, count);
  93. }
  94. static inline int si5351_reg_write(struct si5351_driver_data *drvdata,
  95. u8 reg, u8 val)
  96. {
  97. return regmap_write(drvdata->regmap, reg, val);
  98. }
  99. static inline int si5351_bulk_write(struct si5351_driver_data *drvdata,
  100. u8 reg, u8 count, const u8 *buf)
  101. {
  102. return regmap_raw_write(drvdata->regmap, reg, buf, count);
  103. }
  104. static inline int si5351_set_bits(struct si5351_driver_data *drvdata,
  105. u8 reg, u8 mask, u8 val)
  106. {
  107. return regmap_update_bits(drvdata->regmap, reg, mask, val);
  108. }
  109. static inline u8 si5351_msynth_params_address(int num)
  110. {
  111. if (num > 5)
  112. return SI5351_CLK6_PARAMETERS + (num - 6);
  113. return SI5351_CLK0_PARAMETERS + (SI5351_PARAMETERS_LENGTH * num);
  114. }
  115. static void si5351_read_parameters(struct si5351_driver_data *drvdata,
  116. u8 reg, struct si5351_parameters *params)
  117. {
  118. u8 buf[SI5351_PARAMETERS_LENGTH];
  119. switch (reg) {
  120. case SI5351_CLK6_PARAMETERS:
  121. case SI5351_CLK7_PARAMETERS:
  122. buf[0] = si5351_reg_read(drvdata, reg);
  123. params->p1 = buf[0];
  124. params->p2 = 0;
  125. params->p3 = 1;
  126. break;
  127. default:
  128. si5351_bulk_read(drvdata, reg, SI5351_PARAMETERS_LENGTH, buf);
  129. params->p1 = ((buf[2] & 0x03) << 16) | (buf[3] << 8) | buf[4];
  130. params->p2 = ((buf[5] & 0x0f) << 16) | (buf[6] << 8) | buf[7];
  131. params->p3 = ((buf[5] & 0xf0) << 12) | (buf[0] << 8) | buf[1];
  132. }
  133. params->valid = 1;
  134. }
  135. static void si5351_write_parameters(struct si5351_driver_data *drvdata,
  136. u8 reg, struct si5351_parameters *params)
  137. {
  138. u8 buf[SI5351_PARAMETERS_LENGTH];
  139. switch (reg) {
  140. case SI5351_CLK6_PARAMETERS:
  141. case SI5351_CLK7_PARAMETERS:
  142. buf[0] = params->p1 & 0xff;
  143. si5351_reg_write(drvdata, reg, buf[0]);
  144. break;
  145. default:
  146. buf[0] = ((params->p3 & 0x0ff00) >> 8) & 0xff;
  147. buf[1] = params->p3 & 0xff;
  148. /* save rdiv and divby4 */
  149. buf[2] = si5351_reg_read(drvdata, reg + 2) & ~0x03;
  150. buf[2] |= ((params->p1 & 0x30000) >> 16) & 0x03;
  151. buf[3] = ((params->p1 & 0x0ff00) >> 8) & 0xff;
  152. buf[4] = params->p1 & 0xff;
  153. buf[5] = ((params->p3 & 0xf0000) >> 12) |
  154. ((params->p2 & 0xf0000) >> 16);
  155. buf[6] = ((params->p2 & 0x0ff00) >> 8) & 0xff;
  156. buf[7] = params->p2 & 0xff;
  157. si5351_bulk_write(drvdata, reg, SI5351_PARAMETERS_LENGTH, buf);
  158. }
  159. }
  160. static bool si5351_regmap_is_volatile(struct device *dev, unsigned int reg)
  161. {
  162. switch (reg) {
  163. case SI5351_DEVICE_STATUS:
  164. case SI5351_INTERRUPT_STATUS:
  165. case SI5351_PLL_RESET:
  166. return true;
  167. }
  168. return false;
  169. }
  170. static bool si5351_regmap_is_writeable(struct device *dev, unsigned int reg)
  171. {
  172. /* reserved registers */
  173. if (reg >= 4 && reg <= 8)
  174. return false;
  175. if (reg >= 10 && reg <= 14)
  176. return false;
  177. if (reg >= 173 && reg <= 176)
  178. return false;
  179. if (reg >= 178 && reg <= 182)
  180. return false;
  181. /* read-only */
  182. if (reg == SI5351_DEVICE_STATUS)
  183. return false;
  184. return true;
  185. }
  186. static struct regmap_config si5351_regmap_config = {
  187. .reg_bits = 8,
  188. .val_bits = 8,
  189. .cache_type = REGCACHE_RBTREE,
  190. .max_register = 187,
  191. .writeable_reg = si5351_regmap_is_writeable,
  192. .volatile_reg = si5351_regmap_is_volatile,
  193. };
  194. /*
  195. * Si5351 xtal clock input
  196. */
  197. static int si5351_xtal_prepare(struct clk_hw *hw)
  198. {
  199. struct si5351_driver_data *drvdata =
  200. container_of(hw, struct si5351_driver_data, xtal);
  201. si5351_set_bits(drvdata, SI5351_FANOUT_ENABLE,
  202. SI5351_XTAL_ENABLE, SI5351_XTAL_ENABLE);
  203. return 0;
  204. }
  205. static void si5351_xtal_unprepare(struct clk_hw *hw)
  206. {
  207. struct si5351_driver_data *drvdata =
  208. container_of(hw, struct si5351_driver_data, xtal);
  209. si5351_set_bits(drvdata, SI5351_FANOUT_ENABLE,
  210. SI5351_XTAL_ENABLE, 0);
  211. }
  212. static const struct clk_ops si5351_xtal_ops = {
  213. .prepare = si5351_xtal_prepare,
  214. .unprepare = si5351_xtal_unprepare,
  215. };
  216. /*
  217. * Si5351 clkin clock input (Si5351C only)
  218. */
  219. static int si5351_clkin_prepare(struct clk_hw *hw)
  220. {
  221. struct si5351_driver_data *drvdata =
  222. container_of(hw, struct si5351_driver_data, clkin);
  223. si5351_set_bits(drvdata, SI5351_FANOUT_ENABLE,
  224. SI5351_CLKIN_ENABLE, SI5351_CLKIN_ENABLE);
  225. return 0;
  226. }
  227. static void si5351_clkin_unprepare(struct clk_hw *hw)
  228. {
  229. struct si5351_driver_data *drvdata =
  230. container_of(hw, struct si5351_driver_data, clkin);
  231. si5351_set_bits(drvdata, SI5351_FANOUT_ENABLE,
  232. SI5351_CLKIN_ENABLE, 0);
  233. }
  234. /*
  235. * CMOS clock source constraints:
  236. * The input frequency range of the PLL is 10Mhz to 40MHz.
  237. * If CLKIN is >40MHz, the input divider must be used.
  238. */
  239. static unsigned long si5351_clkin_recalc_rate(struct clk_hw *hw,
  240. unsigned long parent_rate)
  241. {
  242. struct si5351_driver_data *drvdata =
  243. container_of(hw, struct si5351_driver_data, clkin);
  244. unsigned long rate;
  245. unsigned char idiv;
  246. rate = parent_rate;
  247. if (parent_rate > 160000000) {
  248. idiv = SI5351_CLKIN_DIV_8;
  249. rate /= 8;
  250. } else if (parent_rate > 80000000) {
  251. idiv = SI5351_CLKIN_DIV_4;
  252. rate /= 4;
  253. } else if (parent_rate > 40000000) {
  254. idiv = SI5351_CLKIN_DIV_2;
  255. rate /= 2;
  256. } else {
  257. idiv = SI5351_CLKIN_DIV_1;
  258. }
  259. si5351_set_bits(drvdata, SI5351_PLL_INPUT_SOURCE,
  260. SI5351_CLKIN_DIV_MASK, idiv);
  261. dev_dbg(&drvdata->client->dev, "%s - clkin div = %d, rate = %lu\n",
  262. __func__, (1 << (idiv >> 6)), rate);
  263. return rate;
  264. }
  265. static const struct clk_ops si5351_clkin_ops = {
  266. .prepare = si5351_clkin_prepare,
  267. .unprepare = si5351_clkin_unprepare,
  268. .recalc_rate = si5351_clkin_recalc_rate,
  269. };
  270. /*
  271. * Si5351 vxco clock input (Si5351B only)
  272. */
  273. static int si5351_vxco_prepare(struct clk_hw *hw)
  274. {
  275. struct si5351_hw_data *hwdata =
  276. container_of(hw, struct si5351_hw_data, hw);
  277. dev_warn(&hwdata->drvdata->client->dev, "VXCO currently unsupported\n");
  278. return 0;
  279. }
  280. static void si5351_vxco_unprepare(struct clk_hw *hw)
  281. {
  282. }
  283. static unsigned long si5351_vxco_recalc_rate(struct clk_hw *hw,
  284. unsigned long parent_rate)
  285. {
  286. return 0;
  287. }
  288. static int si5351_vxco_set_rate(struct clk_hw *hw, unsigned long rate,
  289. unsigned long parent)
  290. {
  291. return 0;
  292. }
  293. static const struct clk_ops si5351_vxco_ops = {
  294. .prepare = si5351_vxco_prepare,
  295. .unprepare = si5351_vxco_unprepare,
  296. .recalc_rate = si5351_vxco_recalc_rate,
  297. .set_rate = si5351_vxco_set_rate,
  298. };
  299. /*
  300. * Si5351 pll a/b
  301. *
  302. * Feedback Multisynth Divider Equations [2]
  303. *
  304. * fVCO = fIN * (a + b/c)
  305. *
  306. * with 15 + 0/1048575 <= (a + b/c) <= 90 + 0/1048575 and
  307. * fIN = fXTAL or fIN = fCLKIN/CLKIN_DIV
  308. *
  309. * Feedback Multisynth Register Equations
  310. *
  311. * (1) MSNx_P1[17:0] = 128 * a + floor(128 * b/c) - 512
  312. * (2) MSNx_P2[19:0] = 128 * b - c * floor(128 * b/c) = (128*b) mod c
  313. * (3) MSNx_P3[19:0] = c
  314. *
  315. * Transposing (2) yields: (4) floor(128 * b/c) = (128 * b / MSNx_P2)/c
  316. *
  317. * Using (4) on (1) yields:
  318. * MSNx_P1 = 128 * a + (128 * b/MSNx_P2)/c - 512
  319. * MSNx_P1 + 512 + MSNx_P2/c = 128 * a + 128 * b/c
  320. *
  321. * a + b/c = (MSNx_P1 + MSNx_P2/MSNx_P3 + 512)/128
  322. * = (MSNx_P1*MSNx_P3 + MSNx_P2 + 512*MSNx_P3)/(128*MSNx_P3)
  323. *
  324. */
  325. static int _si5351_pll_reparent(struct si5351_driver_data *drvdata,
  326. int num, enum si5351_pll_src parent)
  327. {
  328. u8 mask = (num == 0) ? SI5351_PLLA_SOURCE : SI5351_PLLB_SOURCE;
  329. if (parent == SI5351_PLL_SRC_DEFAULT)
  330. return 0;
  331. if (num > 2)
  332. return -EINVAL;
  333. if (drvdata->variant != SI5351_VARIANT_C &&
  334. parent != SI5351_PLL_SRC_XTAL)
  335. return -EINVAL;
  336. si5351_set_bits(drvdata, SI5351_PLL_INPUT_SOURCE, mask,
  337. (parent == SI5351_PLL_SRC_XTAL) ? 0 : mask);
  338. return 0;
  339. }
  340. static unsigned char si5351_pll_get_parent(struct clk_hw *hw)
  341. {
  342. struct si5351_hw_data *hwdata =
  343. container_of(hw, struct si5351_hw_data, hw);
  344. u8 mask = (hwdata->num == 0) ? SI5351_PLLA_SOURCE : SI5351_PLLB_SOURCE;
  345. u8 val;
  346. val = si5351_reg_read(hwdata->drvdata, SI5351_PLL_INPUT_SOURCE);
  347. return (val & mask) ? 1 : 0;
  348. }
  349. static int si5351_pll_set_parent(struct clk_hw *hw, u8 index)
  350. {
  351. struct si5351_hw_data *hwdata =
  352. container_of(hw, struct si5351_hw_data, hw);
  353. if (hwdata->drvdata->variant != SI5351_VARIANT_C &&
  354. index > 0)
  355. return -EPERM;
  356. if (index > 1)
  357. return -EINVAL;
  358. return _si5351_pll_reparent(hwdata->drvdata, hwdata->num,
  359. (index == 0) ? SI5351_PLL_SRC_XTAL :
  360. SI5351_PLL_SRC_CLKIN);
  361. }
  362. static unsigned long si5351_pll_recalc_rate(struct clk_hw *hw,
  363. unsigned long parent_rate)
  364. {
  365. struct si5351_hw_data *hwdata =
  366. container_of(hw, struct si5351_hw_data, hw);
  367. u8 reg = (hwdata->num == 0) ? SI5351_PLLA_PARAMETERS :
  368. SI5351_PLLB_PARAMETERS;
  369. unsigned long long rate;
  370. if (!hwdata->params.valid)
  371. si5351_read_parameters(hwdata->drvdata, reg, &hwdata->params);
  372. if (hwdata->params.p3 == 0)
  373. return parent_rate;
  374. /* fVCO = fIN * (P1*P3 + 512*P3 + P2)/(128*P3) */
  375. rate = hwdata->params.p1 * hwdata->params.p3;
  376. rate += 512 * hwdata->params.p3;
  377. rate += hwdata->params.p2;
  378. rate *= parent_rate;
  379. do_div(rate, 128 * hwdata->params.p3);
  380. dev_dbg(&hwdata->drvdata->client->dev,
  381. "%s - %s: p1 = %lu, p2 = %lu, p3 = %lu, parent_rate = %lu, rate = %lu\n",
  382. __func__, __clk_get_name(hwdata->hw.clk),
  383. hwdata->params.p1, hwdata->params.p2, hwdata->params.p3,
  384. parent_rate, (unsigned long)rate);
  385. return (unsigned long)rate;
  386. }
  387. static long si5351_pll_round_rate(struct clk_hw *hw, unsigned long rate,
  388. unsigned long *parent_rate)
  389. {
  390. struct si5351_hw_data *hwdata =
  391. container_of(hw, struct si5351_hw_data, hw);
  392. unsigned long rfrac, denom, a, b, c;
  393. unsigned long long lltmp;
  394. if (rate < SI5351_PLL_VCO_MIN)
  395. rate = SI5351_PLL_VCO_MIN;
  396. if (rate > SI5351_PLL_VCO_MAX)
  397. rate = SI5351_PLL_VCO_MAX;
  398. /* determine integer part of feedback equation */
  399. a = rate / *parent_rate;
  400. if (a < SI5351_PLL_A_MIN)
  401. rate = *parent_rate * SI5351_PLL_A_MIN;
  402. if (a > SI5351_PLL_A_MAX)
  403. rate = *parent_rate * SI5351_PLL_A_MAX;
  404. /* find best approximation for b/c = fVCO mod fIN */
  405. denom = 1000 * 1000;
  406. lltmp = rate % (*parent_rate);
  407. lltmp *= denom;
  408. do_div(lltmp, *parent_rate);
  409. rfrac = (unsigned long)lltmp;
  410. b = 0;
  411. c = 1;
  412. if (rfrac)
  413. rational_best_approximation(rfrac, denom,
  414. SI5351_PLL_B_MAX, SI5351_PLL_C_MAX, &b, &c);
  415. /* calculate parameters */
  416. hwdata->params.p3 = c;
  417. hwdata->params.p2 = (128 * b) % c;
  418. hwdata->params.p1 = 128 * a;
  419. hwdata->params.p1 += (128 * b / c);
  420. hwdata->params.p1 -= 512;
  421. /* recalculate rate by fIN * (a + b/c) */
  422. lltmp = *parent_rate;
  423. lltmp *= b;
  424. do_div(lltmp, c);
  425. rate = (unsigned long)lltmp;
  426. rate += *parent_rate * a;
  427. dev_dbg(&hwdata->drvdata->client->dev,
  428. "%s - %s: a = %lu, b = %lu, c = %lu, parent_rate = %lu, rate = %lu\n",
  429. __func__, __clk_get_name(hwdata->hw.clk), a, b, c,
  430. *parent_rate, rate);
  431. return rate;
  432. }
  433. static int si5351_pll_set_rate(struct clk_hw *hw, unsigned long rate,
  434. unsigned long parent_rate)
  435. {
  436. struct si5351_hw_data *hwdata =
  437. container_of(hw, struct si5351_hw_data, hw);
  438. u8 reg = (hwdata->num == 0) ? SI5351_PLLA_PARAMETERS :
  439. SI5351_PLLB_PARAMETERS;
  440. /* write multisynth parameters */
  441. si5351_write_parameters(hwdata->drvdata, reg, &hwdata->params);
  442. /* plla/pllb ctrl is in clk6/clk7 ctrl registers */
  443. si5351_set_bits(hwdata->drvdata, SI5351_CLK6_CTRL + hwdata->num,
  444. SI5351_CLK_INTEGER_MODE,
  445. (hwdata->params.p2 == 0) ? SI5351_CLK_INTEGER_MODE : 0);
  446. dev_dbg(&hwdata->drvdata->client->dev,
  447. "%s - %s: p1 = %lu, p2 = %lu, p3 = %lu, parent_rate = %lu, rate = %lu\n",
  448. __func__, __clk_get_name(hwdata->hw.clk),
  449. hwdata->params.p1, hwdata->params.p2, hwdata->params.p3,
  450. parent_rate, rate);
  451. return 0;
  452. }
  453. static const struct clk_ops si5351_pll_ops = {
  454. .set_parent = si5351_pll_set_parent,
  455. .get_parent = si5351_pll_get_parent,
  456. .recalc_rate = si5351_pll_recalc_rate,
  457. .round_rate = si5351_pll_round_rate,
  458. .set_rate = si5351_pll_set_rate,
  459. };
  460. /*
  461. * Si5351 multisync divider
  462. *
  463. * for fOUT <= 150 MHz:
  464. *
  465. * fOUT = (fIN * (a + b/c)) / CLKOUTDIV
  466. *
  467. * with 6 + 0/1048575 <= (a + b/c) <= 1800 + 0/1048575 and
  468. * fIN = fVCO0, fVCO1
  469. *
  470. * Output Clock Multisynth Register Equations
  471. *
  472. * MSx_P1[17:0] = 128 * a + floor(128 * b/c) - 512
  473. * MSx_P2[19:0] = 128 * b - c * floor(128 * b/c) = (128*b) mod c
  474. * MSx_P3[19:0] = c
  475. *
  476. * MS[6,7] are integer (P1) divide only, P2 = 0, P3 = 0
  477. *
  478. * for 150MHz < fOUT <= 160MHz:
  479. *
  480. * MSx_P1 = 0, MSx_P2 = 0, MSx_P3 = 1, MSx_INT = 1, MSx_DIVBY4 = 11b
  481. */
  482. static int _si5351_msynth_reparent(struct si5351_driver_data *drvdata,
  483. int num, enum si5351_multisynth_src parent)
  484. {
  485. if (parent == SI5351_MULTISYNTH_SRC_DEFAULT)
  486. return 0;
  487. if (num > 8)
  488. return -EINVAL;
  489. si5351_set_bits(drvdata, SI5351_CLK0_CTRL + num, SI5351_CLK_PLL_SELECT,
  490. (parent == SI5351_MULTISYNTH_SRC_VCO0) ? 0 :
  491. SI5351_CLK_PLL_SELECT);
  492. return 0;
  493. }
  494. static unsigned char si5351_msynth_get_parent(struct clk_hw *hw)
  495. {
  496. struct si5351_hw_data *hwdata =
  497. container_of(hw, struct si5351_hw_data, hw);
  498. u8 val;
  499. val = si5351_reg_read(hwdata->drvdata, SI5351_CLK0_CTRL + hwdata->num);
  500. return (val & SI5351_CLK_PLL_SELECT) ? 1 : 0;
  501. }
  502. static int si5351_msynth_set_parent(struct clk_hw *hw, u8 index)
  503. {
  504. struct si5351_hw_data *hwdata =
  505. container_of(hw, struct si5351_hw_data, hw);
  506. return _si5351_msynth_reparent(hwdata->drvdata, hwdata->num,
  507. (index == 0) ? SI5351_MULTISYNTH_SRC_VCO0 :
  508. SI5351_MULTISYNTH_SRC_VCO1);
  509. }
  510. static unsigned long si5351_msynth_recalc_rate(struct clk_hw *hw,
  511. unsigned long parent_rate)
  512. {
  513. struct si5351_hw_data *hwdata =
  514. container_of(hw, struct si5351_hw_data, hw);
  515. u8 reg = si5351_msynth_params_address(hwdata->num);
  516. unsigned long long rate;
  517. unsigned long m;
  518. if (!hwdata->params.valid)
  519. si5351_read_parameters(hwdata->drvdata, reg, &hwdata->params);
  520. if (hwdata->params.p3 == 0)
  521. return parent_rate;
  522. /*
  523. * multisync0-5: fOUT = (128 * P3 * fIN) / (P1*P3 + P2 + 512*P3)
  524. * multisync6-7: fOUT = fIN / P1
  525. */
  526. rate = parent_rate;
  527. if (hwdata->num > 5) {
  528. m = hwdata->params.p1;
  529. } else if ((si5351_reg_read(hwdata->drvdata, reg + 2) &
  530. SI5351_OUTPUT_CLK_DIVBY4) == SI5351_OUTPUT_CLK_DIVBY4) {
  531. m = 4;
  532. } else {
  533. rate *= 128 * hwdata->params.p3;
  534. m = hwdata->params.p1 * hwdata->params.p3;
  535. m += hwdata->params.p2;
  536. m += 512 * hwdata->params.p3;
  537. }
  538. if (m == 0)
  539. return 0;
  540. do_div(rate, m);
  541. dev_dbg(&hwdata->drvdata->client->dev,
  542. "%s - %s: p1 = %lu, p2 = %lu, p3 = %lu, m = %lu, parent_rate = %lu, rate = %lu\n",
  543. __func__, __clk_get_name(hwdata->hw.clk),
  544. hwdata->params.p1, hwdata->params.p2, hwdata->params.p3,
  545. m, parent_rate, (unsigned long)rate);
  546. return (unsigned long)rate;
  547. }
  548. static long si5351_msynth_round_rate(struct clk_hw *hw, unsigned long rate,
  549. unsigned long *parent_rate)
  550. {
  551. struct si5351_hw_data *hwdata =
  552. container_of(hw, struct si5351_hw_data, hw);
  553. unsigned long long lltmp;
  554. unsigned long a, b, c;
  555. int divby4;
  556. /* multisync6-7 can only handle freqencies < 150MHz */
  557. if (hwdata->num >= 6 && rate > SI5351_MULTISYNTH67_MAX_FREQ)
  558. rate = SI5351_MULTISYNTH67_MAX_FREQ;
  559. /* multisync frequency is 1MHz .. 160MHz */
  560. if (rate > SI5351_MULTISYNTH_MAX_FREQ)
  561. rate = SI5351_MULTISYNTH_MAX_FREQ;
  562. if (rate < SI5351_MULTISYNTH_MIN_FREQ)
  563. rate = SI5351_MULTISYNTH_MIN_FREQ;
  564. divby4 = 0;
  565. if (rate > SI5351_MULTISYNTH_DIVBY4_FREQ)
  566. divby4 = 1;
  567. /* multisync can set pll */
  568. if (__clk_get_flags(hwdata->hw.clk) & CLK_SET_RATE_PARENT) {
  569. /*
  570. * find largest integer divider for max
  571. * vco frequency and given target rate
  572. */
  573. if (divby4 == 0) {
  574. lltmp = SI5351_PLL_VCO_MAX;
  575. do_div(lltmp, rate);
  576. a = (unsigned long)lltmp;
  577. } else
  578. a = 4;
  579. b = 0;
  580. c = 1;
  581. *parent_rate = a * rate;
  582. } else {
  583. unsigned long rfrac, denom;
  584. /* disable divby4 */
  585. if (divby4) {
  586. rate = SI5351_MULTISYNTH_DIVBY4_FREQ;
  587. divby4 = 0;
  588. }
  589. /* determine integer part of divider equation */
  590. a = *parent_rate / rate;
  591. if (a < SI5351_MULTISYNTH_A_MIN)
  592. a = SI5351_MULTISYNTH_A_MIN;
  593. if (hwdata->num >= 6 && a > SI5351_MULTISYNTH67_A_MAX)
  594. a = SI5351_MULTISYNTH67_A_MAX;
  595. else if (a > SI5351_MULTISYNTH_A_MAX)
  596. a = SI5351_MULTISYNTH_A_MAX;
  597. /* find best approximation for b/c = fVCO mod fOUT */
  598. denom = 1000 * 1000;
  599. lltmp = (*parent_rate) % rate;
  600. lltmp *= denom;
  601. do_div(lltmp, rate);
  602. rfrac = (unsigned long)lltmp;
  603. b = 0;
  604. c = 1;
  605. if (rfrac)
  606. rational_best_approximation(rfrac, denom,
  607. SI5351_MULTISYNTH_B_MAX, SI5351_MULTISYNTH_C_MAX,
  608. &b, &c);
  609. }
  610. /* recalculate rate by fOUT = fIN / (a + b/c) */
  611. lltmp = *parent_rate;
  612. lltmp *= c;
  613. do_div(lltmp, a * c + b);
  614. rate = (unsigned long)lltmp;
  615. /* calculate parameters */
  616. if (divby4) {
  617. hwdata->params.p3 = 1;
  618. hwdata->params.p2 = 0;
  619. hwdata->params.p1 = 0;
  620. } else {
  621. hwdata->params.p3 = c;
  622. hwdata->params.p2 = (128 * b) % c;
  623. hwdata->params.p1 = 128 * a;
  624. hwdata->params.p1 += (128 * b / c);
  625. hwdata->params.p1 -= 512;
  626. }
  627. dev_dbg(&hwdata->drvdata->client->dev,
  628. "%s - %s: a = %lu, b = %lu, c = %lu, divby4 = %d, parent_rate = %lu, rate = %lu\n",
  629. __func__, __clk_get_name(hwdata->hw.clk), a, b, c, divby4,
  630. *parent_rate, rate);
  631. return rate;
  632. }
  633. static int si5351_msynth_set_rate(struct clk_hw *hw, unsigned long rate,
  634. unsigned long parent_rate)
  635. {
  636. struct si5351_hw_data *hwdata =
  637. container_of(hw, struct si5351_hw_data, hw);
  638. u8 reg = si5351_msynth_params_address(hwdata->num);
  639. int divby4 = 0;
  640. /* write multisynth parameters */
  641. si5351_write_parameters(hwdata->drvdata, reg, &hwdata->params);
  642. if (rate > SI5351_MULTISYNTH_DIVBY4_FREQ)
  643. divby4 = 1;
  644. /* enable/disable integer mode and divby4 on multisynth0-5 */
  645. if (hwdata->num < 6) {
  646. si5351_set_bits(hwdata->drvdata, reg + 2,
  647. SI5351_OUTPUT_CLK_DIVBY4,
  648. (divby4) ? SI5351_OUTPUT_CLK_DIVBY4 : 0);
  649. si5351_set_bits(hwdata->drvdata, SI5351_CLK0_CTRL + hwdata->num,
  650. SI5351_CLK_INTEGER_MODE,
  651. (hwdata->params.p2 == 0) ? SI5351_CLK_INTEGER_MODE : 0);
  652. }
  653. dev_dbg(&hwdata->drvdata->client->dev,
  654. "%s - %s: p1 = %lu, p2 = %lu, p3 = %lu, divby4 = %d, parent_rate = %lu, rate = %lu\n",
  655. __func__, __clk_get_name(hwdata->hw.clk),
  656. hwdata->params.p1, hwdata->params.p2, hwdata->params.p3,
  657. divby4, parent_rate, rate);
  658. return 0;
  659. }
  660. static const struct clk_ops si5351_msynth_ops = {
  661. .set_parent = si5351_msynth_set_parent,
  662. .get_parent = si5351_msynth_get_parent,
  663. .recalc_rate = si5351_msynth_recalc_rate,
  664. .round_rate = si5351_msynth_round_rate,
  665. .set_rate = si5351_msynth_set_rate,
  666. };
  667. /*
  668. * Si5351 clkout divider
  669. */
  670. static int _si5351_clkout_reparent(struct si5351_driver_data *drvdata,
  671. int num, enum si5351_clkout_src parent)
  672. {
  673. u8 val;
  674. if (num > 8)
  675. return -EINVAL;
  676. switch (parent) {
  677. case SI5351_CLKOUT_SRC_MSYNTH_N:
  678. val = SI5351_CLK_INPUT_MULTISYNTH_N;
  679. break;
  680. case SI5351_CLKOUT_SRC_MSYNTH_0_4:
  681. /* clk0/clk4 can only connect to its own multisync */
  682. if (num == 0 || num == 4)
  683. val = SI5351_CLK_INPUT_MULTISYNTH_N;
  684. else
  685. val = SI5351_CLK_INPUT_MULTISYNTH_0_4;
  686. break;
  687. case SI5351_CLKOUT_SRC_XTAL:
  688. val = SI5351_CLK_INPUT_XTAL;
  689. break;
  690. case SI5351_CLKOUT_SRC_CLKIN:
  691. if (drvdata->variant != SI5351_VARIANT_C)
  692. return -EINVAL;
  693. val = SI5351_CLK_INPUT_CLKIN;
  694. break;
  695. default:
  696. return 0;
  697. }
  698. si5351_set_bits(drvdata, SI5351_CLK0_CTRL + num,
  699. SI5351_CLK_INPUT_MASK, val);
  700. return 0;
  701. }
  702. static int _si5351_clkout_set_drive_strength(
  703. struct si5351_driver_data *drvdata, int num,
  704. enum si5351_drive_strength drive)
  705. {
  706. u8 mask;
  707. if (num > 8)
  708. return -EINVAL;
  709. switch (drive) {
  710. case SI5351_DRIVE_2MA:
  711. mask = SI5351_CLK_DRIVE_STRENGTH_2MA;
  712. break;
  713. case SI5351_DRIVE_4MA:
  714. mask = SI5351_CLK_DRIVE_STRENGTH_4MA;
  715. break;
  716. case SI5351_DRIVE_6MA:
  717. mask = SI5351_CLK_DRIVE_STRENGTH_6MA;
  718. break;
  719. case SI5351_DRIVE_8MA:
  720. mask = SI5351_CLK_DRIVE_STRENGTH_8MA;
  721. break;
  722. default:
  723. return 0;
  724. }
  725. si5351_set_bits(drvdata, SI5351_CLK0_CTRL + num,
  726. SI5351_CLK_DRIVE_STRENGTH_MASK, mask);
  727. return 0;
  728. }
  729. static int _si5351_clkout_set_disable_state(
  730. struct si5351_driver_data *drvdata, int num,
  731. enum si5351_disable_state state)
  732. {
  733. u8 reg = (num < 4) ? SI5351_CLK3_0_DISABLE_STATE :
  734. SI5351_CLK7_4_DISABLE_STATE;
  735. u8 shift = (num < 4) ? (2 * num) : (2 * (num-4));
  736. u8 mask = SI5351_CLK_DISABLE_STATE_MASK << shift;
  737. u8 val;
  738. if (num > 8)
  739. return -EINVAL;
  740. switch (state) {
  741. case SI5351_DISABLE_LOW:
  742. val = SI5351_CLK_DISABLE_STATE_LOW;
  743. break;
  744. case SI5351_DISABLE_HIGH:
  745. val = SI5351_CLK_DISABLE_STATE_HIGH;
  746. break;
  747. case SI5351_DISABLE_FLOATING:
  748. val = SI5351_CLK_DISABLE_STATE_FLOAT;
  749. break;
  750. case SI5351_DISABLE_NEVER:
  751. val = SI5351_CLK_DISABLE_STATE_NEVER;
  752. break;
  753. default:
  754. return 0;
  755. }
  756. si5351_set_bits(drvdata, reg, mask, val << shift);
  757. return 0;
  758. }
  759. static int si5351_clkout_prepare(struct clk_hw *hw)
  760. {
  761. struct si5351_hw_data *hwdata =
  762. container_of(hw, struct si5351_hw_data, hw);
  763. si5351_set_bits(hwdata->drvdata, SI5351_CLK0_CTRL + hwdata->num,
  764. SI5351_CLK_POWERDOWN, 0);
  765. si5351_set_bits(hwdata->drvdata, SI5351_OUTPUT_ENABLE_CTRL,
  766. (1 << hwdata->num), 0);
  767. return 0;
  768. }
  769. static void si5351_clkout_unprepare(struct clk_hw *hw)
  770. {
  771. struct si5351_hw_data *hwdata =
  772. container_of(hw, struct si5351_hw_data, hw);
  773. si5351_set_bits(hwdata->drvdata, SI5351_CLK0_CTRL + hwdata->num,
  774. SI5351_CLK_POWERDOWN, SI5351_CLK_POWERDOWN);
  775. si5351_set_bits(hwdata->drvdata, SI5351_OUTPUT_ENABLE_CTRL,
  776. (1 << hwdata->num), (1 << hwdata->num));
  777. }
  778. static u8 si5351_clkout_get_parent(struct clk_hw *hw)
  779. {
  780. struct si5351_hw_data *hwdata =
  781. container_of(hw, struct si5351_hw_data, hw);
  782. int index = 0;
  783. unsigned char val;
  784. val = si5351_reg_read(hwdata->drvdata, SI5351_CLK0_CTRL + hwdata->num);
  785. switch (val & SI5351_CLK_INPUT_MASK) {
  786. case SI5351_CLK_INPUT_MULTISYNTH_N:
  787. index = 0;
  788. break;
  789. case SI5351_CLK_INPUT_MULTISYNTH_0_4:
  790. index = 1;
  791. break;
  792. case SI5351_CLK_INPUT_XTAL:
  793. index = 2;
  794. break;
  795. case SI5351_CLK_INPUT_CLKIN:
  796. index = 3;
  797. break;
  798. }
  799. return index;
  800. }
  801. static int si5351_clkout_set_parent(struct clk_hw *hw, u8 index)
  802. {
  803. struct si5351_hw_data *hwdata =
  804. container_of(hw, struct si5351_hw_data, hw);
  805. enum si5351_clkout_src parent = SI5351_CLKOUT_SRC_DEFAULT;
  806. switch (index) {
  807. case 0:
  808. parent = SI5351_CLKOUT_SRC_MSYNTH_N;
  809. break;
  810. case 1:
  811. parent = SI5351_CLKOUT_SRC_MSYNTH_0_4;
  812. break;
  813. case 2:
  814. parent = SI5351_CLKOUT_SRC_XTAL;
  815. break;
  816. case 3:
  817. parent = SI5351_CLKOUT_SRC_CLKIN;
  818. break;
  819. }
  820. return _si5351_clkout_reparent(hwdata->drvdata, hwdata->num, parent);
  821. }
  822. static unsigned long si5351_clkout_recalc_rate(struct clk_hw *hw,
  823. unsigned long parent_rate)
  824. {
  825. struct si5351_hw_data *hwdata =
  826. container_of(hw, struct si5351_hw_data, hw);
  827. unsigned char reg;
  828. unsigned char rdiv;
  829. if (hwdata->num > 5)
  830. reg = si5351_msynth_params_address(hwdata->num) + 2;
  831. else
  832. reg = SI5351_CLK6_7_OUTPUT_DIVIDER;
  833. rdiv = si5351_reg_read(hwdata->drvdata, reg);
  834. if (hwdata->num == 6) {
  835. rdiv &= SI5351_OUTPUT_CLK6_DIV_MASK;
  836. } else {
  837. rdiv &= SI5351_OUTPUT_CLK_DIV_MASK;
  838. rdiv >>= SI5351_OUTPUT_CLK_DIV_SHIFT;
  839. }
  840. return parent_rate >> rdiv;
  841. }
  842. static long si5351_clkout_round_rate(struct clk_hw *hw, unsigned long rate,
  843. unsigned long *parent_rate)
  844. {
  845. struct si5351_hw_data *hwdata =
  846. container_of(hw, struct si5351_hw_data, hw);
  847. unsigned char rdiv;
  848. /* clkout6/7 can only handle output freqencies < 150MHz */
  849. if (hwdata->num >= 6 && rate > SI5351_CLKOUT67_MAX_FREQ)
  850. rate = SI5351_CLKOUT67_MAX_FREQ;
  851. /* clkout freqency is 8kHz - 160MHz */
  852. if (rate > SI5351_CLKOUT_MAX_FREQ)
  853. rate = SI5351_CLKOUT_MAX_FREQ;
  854. if (rate < SI5351_CLKOUT_MIN_FREQ)
  855. rate = SI5351_CLKOUT_MIN_FREQ;
  856. /* request frequency if multisync master */
  857. if (__clk_get_flags(hwdata->hw.clk) & CLK_SET_RATE_PARENT) {
  858. /* use r divider for frequencies below 1MHz */
  859. rdiv = SI5351_OUTPUT_CLK_DIV_1;
  860. while (rate < SI5351_MULTISYNTH_MIN_FREQ &&
  861. rdiv < SI5351_OUTPUT_CLK_DIV_128) {
  862. rdiv += 1;
  863. rate *= 2;
  864. }
  865. *parent_rate = rate;
  866. } else {
  867. unsigned long new_rate, new_err, err;
  868. /* round to closed rdiv */
  869. rdiv = SI5351_OUTPUT_CLK_DIV_1;
  870. new_rate = *parent_rate;
  871. err = abs(new_rate - rate);
  872. do {
  873. new_rate >>= 1;
  874. new_err = abs(new_rate - rate);
  875. if (new_err > err || rdiv == SI5351_OUTPUT_CLK_DIV_128)
  876. break;
  877. rdiv++;
  878. err = new_err;
  879. } while (1);
  880. }
  881. rate = *parent_rate >> rdiv;
  882. dev_dbg(&hwdata->drvdata->client->dev,
  883. "%s - %s: rdiv = %u, parent_rate = %lu, rate = %lu\n",
  884. __func__, __clk_get_name(hwdata->hw.clk), (1 << rdiv),
  885. *parent_rate, rate);
  886. return rate;
  887. }
  888. static int si5351_clkout_set_rate(struct clk_hw *hw, unsigned long rate,
  889. unsigned long parent_rate)
  890. {
  891. struct si5351_hw_data *hwdata =
  892. container_of(hw, struct si5351_hw_data, hw);
  893. unsigned long new_rate, new_err, err;
  894. unsigned char rdiv;
  895. /* round to closed rdiv */
  896. rdiv = SI5351_OUTPUT_CLK_DIV_1;
  897. new_rate = parent_rate;
  898. err = abs(new_rate - rate);
  899. do {
  900. new_rate >>= 1;
  901. new_err = abs(new_rate - rate);
  902. if (new_err > err || rdiv == SI5351_OUTPUT_CLK_DIV_128)
  903. break;
  904. rdiv++;
  905. err = new_err;
  906. } while (1);
  907. /* write output divider */
  908. switch (hwdata->num) {
  909. case 6:
  910. si5351_set_bits(hwdata->drvdata, SI5351_CLK6_7_OUTPUT_DIVIDER,
  911. SI5351_OUTPUT_CLK6_DIV_MASK, rdiv);
  912. break;
  913. case 7:
  914. si5351_set_bits(hwdata->drvdata, SI5351_CLK6_7_OUTPUT_DIVIDER,
  915. SI5351_OUTPUT_CLK_DIV_MASK,
  916. rdiv << SI5351_OUTPUT_CLK_DIV_SHIFT);
  917. break;
  918. default:
  919. si5351_set_bits(hwdata->drvdata,
  920. si5351_msynth_params_address(hwdata->num) + 2,
  921. SI5351_OUTPUT_CLK_DIV_MASK,
  922. rdiv << SI5351_OUTPUT_CLK_DIV_SHIFT);
  923. }
  924. /* powerup clkout */
  925. si5351_set_bits(hwdata->drvdata, SI5351_CLK0_CTRL + hwdata->num,
  926. SI5351_CLK_POWERDOWN, 0);
  927. dev_dbg(&hwdata->drvdata->client->dev,
  928. "%s - %s: rdiv = %u, parent_rate = %lu, rate = %lu\n",
  929. __func__, __clk_get_name(hwdata->hw.clk), (1 << rdiv),
  930. parent_rate, rate);
  931. return 0;
  932. }
  933. static const struct clk_ops si5351_clkout_ops = {
  934. .prepare = si5351_clkout_prepare,
  935. .unprepare = si5351_clkout_unprepare,
  936. .set_parent = si5351_clkout_set_parent,
  937. .get_parent = si5351_clkout_get_parent,
  938. .recalc_rate = si5351_clkout_recalc_rate,
  939. .round_rate = si5351_clkout_round_rate,
  940. .set_rate = si5351_clkout_set_rate,
  941. };
  942. /*
  943. * Si5351 i2c probe and DT
  944. */
  945. #ifdef CONFIG_OF
  946. static const struct of_device_id si5351_dt_ids[] = {
  947. { .compatible = "silabs,si5351a", .data = (void *)SI5351_VARIANT_A, },
  948. { .compatible = "silabs,si5351a-msop",
  949. .data = (void *)SI5351_VARIANT_A3, },
  950. { .compatible = "silabs,si5351b", .data = (void *)SI5351_VARIANT_B, },
  951. { .compatible = "silabs,si5351c", .data = (void *)SI5351_VARIANT_C, },
  952. { }
  953. };
  954. MODULE_DEVICE_TABLE(of, si5351_dt_ids);
  955. static int si5351_dt_parse(struct i2c_client *client)
  956. {
  957. struct device_node *child, *np = client->dev.of_node;
  958. struct si5351_platform_data *pdata;
  959. const struct of_device_id *match;
  960. struct property *prop;
  961. const __be32 *p;
  962. int num = 0;
  963. u32 val;
  964. if (np == NULL)
  965. return 0;
  966. match = of_match_node(si5351_dt_ids, np);
  967. if (match == NULL)
  968. return -EINVAL;
  969. pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
  970. if (!pdata)
  971. return -ENOMEM;
  972. pdata->variant = (enum si5351_variant)match->data;
  973. pdata->clk_xtal = of_clk_get(np, 0);
  974. if (!IS_ERR(pdata->clk_xtal))
  975. clk_put(pdata->clk_xtal);
  976. pdata->clk_clkin = of_clk_get(np, 1);
  977. if (!IS_ERR(pdata->clk_clkin))
  978. clk_put(pdata->clk_clkin);
  979. /*
  980. * property silabs,pll-source : <num src>, [<..>]
  981. * allow to selectively set pll source
  982. */
  983. of_property_for_each_u32(np, "silabs,pll-source", prop, p, num) {
  984. if (num >= 2) {
  985. dev_err(&client->dev,
  986. "invalid pll %d on pll-source prop\n", num);
  987. return -EINVAL;
  988. }
  989. p = of_prop_next_u32(prop, p, &val);
  990. if (!p) {
  991. dev_err(&client->dev,
  992. "missing pll-source for pll %d\n", num);
  993. return -EINVAL;
  994. }
  995. switch (val) {
  996. case 0:
  997. pdata->pll_src[num] = SI5351_PLL_SRC_XTAL;
  998. break;
  999. case 1:
  1000. if (pdata->variant != SI5351_VARIANT_C) {
  1001. dev_err(&client->dev,
  1002. "invalid parent %d for pll %d\n",
  1003. val, num);
  1004. return -EINVAL;
  1005. }
  1006. pdata->pll_src[num] = SI5351_PLL_SRC_CLKIN;
  1007. break;
  1008. default:
  1009. dev_err(&client->dev,
  1010. "invalid parent %d for pll %d\n", val, num);
  1011. return -EINVAL;
  1012. }
  1013. }
  1014. /* per clkout properties */
  1015. for_each_child_of_node(np, child) {
  1016. if (of_property_read_u32(child, "reg", &num)) {
  1017. dev_err(&client->dev, "missing reg property of %s\n",
  1018. child->name);
  1019. return -EINVAL;
  1020. }
  1021. if (num >= 8 ||
  1022. (pdata->variant == SI5351_VARIANT_A3 && num >= 3)) {
  1023. dev_err(&client->dev, "invalid clkout %d\n", num);
  1024. return -EINVAL;
  1025. }
  1026. if (!of_property_read_u32(child, "silabs,multisynth-source",
  1027. &val)) {
  1028. switch (val) {
  1029. case 0:
  1030. pdata->clkout[num].multisynth_src =
  1031. SI5351_MULTISYNTH_SRC_VCO0;
  1032. break;
  1033. case 1:
  1034. pdata->clkout[num].multisynth_src =
  1035. SI5351_MULTISYNTH_SRC_VCO1;
  1036. break;
  1037. default:
  1038. dev_err(&client->dev,
  1039. "invalid parent %d for multisynth %d\n",
  1040. val, num);
  1041. return -EINVAL;
  1042. }
  1043. }
  1044. if (!of_property_read_u32(child, "silabs,clock-source", &val)) {
  1045. switch (val) {
  1046. case 0:
  1047. pdata->clkout[num].clkout_src =
  1048. SI5351_CLKOUT_SRC_MSYNTH_N;
  1049. break;
  1050. case 1:
  1051. pdata->clkout[num].clkout_src =
  1052. SI5351_CLKOUT_SRC_MSYNTH_0_4;
  1053. break;
  1054. case 2:
  1055. pdata->clkout[num].clkout_src =
  1056. SI5351_CLKOUT_SRC_XTAL;
  1057. break;
  1058. case 3:
  1059. if (pdata->variant != SI5351_VARIANT_C) {
  1060. dev_err(&client->dev,
  1061. "invalid parent %d for clkout %d\n",
  1062. val, num);
  1063. return -EINVAL;
  1064. }
  1065. pdata->clkout[num].clkout_src =
  1066. SI5351_CLKOUT_SRC_CLKIN;
  1067. break;
  1068. default:
  1069. dev_err(&client->dev,
  1070. "invalid parent %d for clkout %d\n",
  1071. val, num);
  1072. return -EINVAL;
  1073. }
  1074. }
  1075. if (!of_property_read_u32(child, "silabs,drive-strength",
  1076. &val)) {
  1077. switch (val) {
  1078. case SI5351_DRIVE_2MA:
  1079. case SI5351_DRIVE_4MA:
  1080. case SI5351_DRIVE_6MA:
  1081. case SI5351_DRIVE_8MA:
  1082. pdata->clkout[num].drive = val;
  1083. break;
  1084. default:
  1085. dev_err(&client->dev,
  1086. "invalid drive strength %d for clkout %d\n",
  1087. val, num);
  1088. return -EINVAL;
  1089. }
  1090. }
  1091. if (!of_property_read_u32(child, "silabs,disable-state",
  1092. &val)) {
  1093. switch (val) {
  1094. case 0:
  1095. pdata->clkout[num].disable_state =
  1096. SI5351_DISABLE_LOW;
  1097. break;
  1098. case 1:
  1099. pdata->clkout[num].disable_state =
  1100. SI5351_DISABLE_HIGH;
  1101. break;
  1102. case 2:
  1103. pdata->clkout[num].disable_state =
  1104. SI5351_DISABLE_FLOATING;
  1105. break;
  1106. case 3:
  1107. pdata->clkout[num].disable_state =
  1108. SI5351_DISABLE_NEVER;
  1109. break;
  1110. default:
  1111. dev_err(&client->dev,
  1112. "invalid disable state %d for clkout %d\n",
  1113. val, num);
  1114. return -EINVAL;
  1115. }
  1116. }
  1117. if (!of_property_read_u32(child, "clock-frequency", &val))
  1118. pdata->clkout[num].rate = val;
  1119. pdata->clkout[num].pll_master =
  1120. of_property_read_bool(child, "silabs,pll-master");
  1121. }
  1122. client->dev.platform_data = pdata;
  1123. return 0;
  1124. }
  1125. #else
  1126. static int si5351_dt_parse(struct i2c_client *client)
  1127. {
  1128. return 0;
  1129. }
  1130. #endif /* CONFIG_OF */
  1131. static int si5351_i2c_probe(struct i2c_client *client,
  1132. const struct i2c_device_id *id)
  1133. {
  1134. struct si5351_platform_data *pdata;
  1135. struct si5351_driver_data *drvdata;
  1136. struct clk_init_data init;
  1137. struct clk *clk;
  1138. const char *parent_names[4];
  1139. u8 num_parents, num_clocks;
  1140. int ret, n;
  1141. ret = si5351_dt_parse(client);
  1142. if (ret)
  1143. return ret;
  1144. pdata = client->dev.platform_data;
  1145. if (!pdata)
  1146. return -EINVAL;
  1147. drvdata = devm_kzalloc(&client->dev, sizeof(*drvdata), GFP_KERNEL);
  1148. if (drvdata == NULL) {
  1149. dev_err(&client->dev, "unable to allocate driver data\n");
  1150. return -ENOMEM;
  1151. }
  1152. i2c_set_clientdata(client, drvdata);
  1153. drvdata->client = client;
  1154. drvdata->variant = pdata->variant;
  1155. drvdata->pxtal = pdata->clk_xtal;
  1156. drvdata->pclkin = pdata->clk_clkin;
  1157. drvdata->regmap = devm_regmap_init_i2c(client, &si5351_regmap_config);
  1158. if (IS_ERR(drvdata->regmap)) {
  1159. dev_err(&client->dev, "failed to allocate register map\n");
  1160. return PTR_ERR(drvdata->regmap);
  1161. }
  1162. /* Disable interrupts */
  1163. si5351_reg_write(drvdata, SI5351_INTERRUPT_MASK, 0xf0);
  1164. /* Ensure pll select is on XTAL for Si5351A/B */
  1165. if (drvdata->variant != SI5351_VARIANT_C)
  1166. si5351_set_bits(drvdata, SI5351_PLL_INPUT_SOURCE,
  1167. SI5351_PLLA_SOURCE | SI5351_PLLB_SOURCE, 0);
  1168. /* setup clock configuration */
  1169. for (n = 0; n < 2; n++) {
  1170. ret = _si5351_pll_reparent(drvdata, n, pdata->pll_src[n]);
  1171. if (ret) {
  1172. dev_err(&client->dev,
  1173. "failed to reparent pll %d to %d\n",
  1174. n, pdata->pll_src[n]);
  1175. return ret;
  1176. }
  1177. }
  1178. for (n = 0; n < 8; n++) {
  1179. ret = _si5351_msynth_reparent(drvdata, n,
  1180. pdata->clkout[n].multisynth_src);
  1181. if (ret) {
  1182. dev_err(&client->dev,
  1183. "failed to reparent multisynth %d to %d\n",
  1184. n, pdata->clkout[n].multisynth_src);
  1185. return ret;
  1186. }
  1187. ret = _si5351_clkout_reparent(drvdata, n,
  1188. pdata->clkout[n].clkout_src);
  1189. if (ret) {
  1190. dev_err(&client->dev,
  1191. "failed to reparent clkout %d to %d\n",
  1192. n, pdata->clkout[n].clkout_src);
  1193. return ret;
  1194. }
  1195. ret = _si5351_clkout_set_drive_strength(drvdata, n,
  1196. pdata->clkout[n].drive);
  1197. if (ret) {
  1198. dev_err(&client->dev,
  1199. "failed set drive strength of clkout%d to %d\n",
  1200. n, pdata->clkout[n].drive);
  1201. return ret;
  1202. }
  1203. ret = _si5351_clkout_set_disable_state(drvdata, n,
  1204. pdata->clkout[n].disable_state);
  1205. if (ret) {
  1206. dev_err(&client->dev,
  1207. "failed set disable state of clkout%d to %d\n",
  1208. n, pdata->clkout[n].disable_state);
  1209. return ret;
  1210. }
  1211. }
  1212. /* register xtal input clock gate */
  1213. memset(&init, 0, sizeof(init));
  1214. init.name = si5351_input_names[0];
  1215. init.ops = &si5351_xtal_ops;
  1216. init.flags = 0;
  1217. if (!IS_ERR(drvdata->pxtal)) {
  1218. drvdata->pxtal_name = __clk_get_name(drvdata->pxtal);
  1219. init.parent_names = &drvdata->pxtal_name;
  1220. init.num_parents = 1;
  1221. }
  1222. drvdata->xtal.init = &init;
  1223. clk = devm_clk_register(&client->dev, &drvdata->xtal);
  1224. if (IS_ERR(clk)) {
  1225. dev_err(&client->dev, "unable to register %s\n", init.name);
  1226. return PTR_ERR(clk);
  1227. }
  1228. /* register clkin input clock gate */
  1229. if (drvdata->variant == SI5351_VARIANT_C) {
  1230. memset(&init, 0, sizeof(init));
  1231. init.name = si5351_input_names[1];
  1232. init.ops = &si5351_clkin_ops;
  1233. if (!IS_ERR(drvdata->pclkin)) {
  1234. drvdata->pclkin_name = __clk_get_name(drvdata->pclkin);
  1235. init.parent_names = &drvdata->pclkin_name;
  1236. init.num_parents = 1;
  1237. }
  1238. drvdata->clkin.init = &init;
  1239. clk = devm_clk_register(&client->dev, &drvdata->clkin);
  1240. if (IS_ERR(clk)) {
  1241. dev_err(&client->dev, "unable to register %s\n",
  1242. init.name);
  1243. return PTR_ERR(clk);
  1244. }
  1245. }
  1246. /* Si5351C allows to mux either xtal or clkin to PLL input */
  1247. num_parents = (drvdata->variant == SI5351_VARIANT_C) ? 2 : 1;
  1248. parent_names[0] = si5351_input_names[0];
  1249. parent_names[1] = si5351_input_names[1];
  1250. /* register PLLA */
  1251. drvdata->pll[0].num = 0;
  1252. drvdata->pll[0].drvdata = drvdata;
  1253. drvdata->pll[0].hw.init = &init;
  1254. memset(&init, 0, sizeof(init));
  1255. init.name = si5351_pll_names[0];
  1256. init.ops = &si5351_pll_ops;
  1257. init.flags = 0;
  1258. init.parent_names = parent_names;
  1259. init.num_parents = num_parents;
  1260. clk = devm_clk_register(&client->dev, &drvdata->pll[0].hw);
  1261. if (IS_ERR(clk)) {
  1262. dev_err(&client->dev, "unable to register %s\n", init.name);
  1263. return -EINVAL;
  1264. }
  1265. /* register PLLB or VXCO (Si5351B) */
  1266. drvdata->pll[1].num = 1;
  1267. drvdata->pll[1].drvdata = drvdata;
  1268. drvdata->pll[1].hw.init = &init;
  1269. memset(&init, 0, sizeof(init));
  1270. if (drvdata->variant == SI5351_VARIANT_B) {
  1271. init.name = si5351_pll_names[2];
  1272. init.ops = &si5351_vxco_ops;
  1273. init.flags = CLK_IS_ROOT;
  1274. init.parent_names = NULL;
  1275. init.num_parents = 0;
  1276. } else {
  1277. init.name = si5351_pll_names[1];
  1278. init.ops = &si5351_pll_ops;
  1279. init.flags = 0;
  1280. init.parent_names = parent_names;
  1281. init.num_parents = num_parents;
  1282. }
  1283. clk = devm_clk_register(&client->dev, &drvdata->pll[1].hw);
  1284. if (IS_ERR(clk)) {
  1285. dev_err(&client->dev, "unable to register %s\n", init.name);
  1286. return -EINVAL;
  1287. }
  1288. /* register clk multisync and clk out divider */
  1289. num_clocks = (drvdata->variant == SI5351_VARIANT_A3) ? 3 : 8;
  1290. parent_names[0] = si5351_pll_names[0];
  1291. if (drvdata->variant == SI5351_VARIANT_B)
  1292. parent_names[1] = si5351_pll_names[2];
  1293. else
  1294. parent_names[1] = si5351_pll_names[1];
  1295. drvdata->msynth = devm_kzalloc(&client->dev, num_clocks *
  1296. sizeof(*drvdata->msynth), GFP_KERNEL);
  1297. drvdata->clkout = devm_kzalloc(&client->dev, num_clocks *
  1298. sizeof(*drvdata->clkout), GFP_KERNEL);
  1299. drvdata->onecell.clk_num = num_clocks;
  1300. drvdata->onecell.clks = devm_kzalloc(&client->dev,
  1301. num_clocks * sizeof(*drvdata->onecell.clks), GFP_KERNEL);
  1302. if (WARN_ON(!drvdata->msynth || !drvdata->clkout ||
  1303. !drvdata->onecell.clks))
  1304. return -ENOMEM;
  1305. for (n = 0; n < num_clocks; n++) {
  1306. drvdata->msynth[n].num = n;
  1307. drvdata->msynth[n].drvdata = drvdata;
  1308. drvdata->msynth[n].hw.init = &init;
  1309. memset(&init, 0, sizeof(init));
  1310. init.name = si5351_msynth_names[n];
  1311. init.ops = &si5351_msynth_ops;
  1312. init.flags = 0;
  1313. if (pdata->clkout[n].pll_master)
  1314. init.flags |= CLK_SET_RATE_PARENT;
  1315. init.parent_names = parent_names;
  1316. init.num_parents = 2;
  1317. clk = devm_clk_register(&client->dev, &drvdata->msynth[n].hw);
  1318. if (IS_ERR(clk)) {
  1319. dev_err(&client->dev, "unable to register %s\n",
  1320. init.name);
  1321. return -EINVAL;
  1322. }
  1323. }
  1324. num_parents = (drvdata->variant == SI5351_VARIANT_C) ? 4 : 3;
  1325. parent_names[2] = si5351_input_names[0];
  1326. parent_names[3] = si5351_input_names[1];
  1327. for (n = 0; n < num_clocks; n++) {
  1328. parent_names[0] = si5351_msynth_names[n];
  1329. parent_names[1] = (n < 4) ? si5351_msynth_names[0] :
  1330. si5351_msynth_names[4];
  1331. drvdata->clkout[n].num = n;
  1332. drvdata->clkout[n].drvdata = drvdata;
  1333. drvdata->clkout[n].hw.init = &init;
  1334. memset(&init, 0, sizeof(init));
  1335. init.name = si5351_clkout_names[n];
  1336. init.ops = &si5351_clkout_ops;
  1337. init.flags = 0;
  1338. if (pdata->clkout[n].clkout_src == SI5351_CLKOUT_SRC_MSYNTH_N)
  1339. init.flags |= CLK_SET_RATE_PARENT;
  1340. init.parent_names = parent_names;
  1341. init.num_parents = num_parents;
  1342. clk = devm_clk_register(&client->dev, &drvdata->clkout[n].hw);
  1343. if (IS_ERR(clk)) {
  1344. dev_err(&client->dev, "unable to register %s\n",
  1345. init.name);
  1346. return -EINVAL;
  1347. }
  1348. drvdata->onecell.clks[n] = clk;
  1349. }
  1350. ret = of_clk_add_provider(client->dev.of_node, of_clk_src_onecell_get,
  1351. &drvdata->onecell);
  1352. if (ret) {
  1353. dev_err(&client->dev, "unable to add clk provider\n");
  1354. return ret;
  1355. }
  1356. return 0;
  1357. }
  1358. static const struct i2c_device_id si5351_i2c_ids[] = {
  1359. { "silabs,si5351", 0 },
  1360. { }
  1361. };
  1362. MODULE_DEVICE_TABLE(i2c, si5351_i2c_ids);
  1363. static struct i2c_driver si5351_driver = {
  1364. .driver = {
  1365. .name = "si5351",
  1366. .of_match_table = of_match_ptr(si5351_dt_ids),
  1367. },
  1368. .probe = si5351_i2c_probe,
  1369. .id_table = si5351_i2c_ids,
  1370. };
  1371. module_i2c_driver(si5351_driver);
  1372. MODULE_AUTHOR("Sebastian Hesselbarth <sebastian.hesselbarth@gmail.com");
  1373. MODULE_DESCRIPTION("Silicon Labs Si5351A/B/C clock generator driver");
  1374. MODULE_LICENSE("GPL");