clk: fractional-divider: Document the arithmetics used behind the code
authorAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Thu, 12 Aug 2021 17:00:25 +0000 (20:00 +0300)
committerStephen Boyd <sboyd@kernel.org>
Thu, 12 Aug 2021 19:42:00 +0000 (12:42 -0700)
commite81b917a78c7ed08007de5b502a14535daa106bf
tree8ea00bf1135b1c066cfe8844437a0c81db94432b
parent82f53f9ee5770177eb102446cc3513bf07e2668a
clk: fractional-divider: Document the arithmetics used behind the code

It appears that some code lines raise the question why they are needed
and how they are participated in the calculus of the resulting values.

Document this in a form of the top comment in the module file.

Reported-by: Liu Ying <victor.liu@nxp.com>
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Link: https://lore.kernel.org/r/20210812170025.67074-4-andriy.shevchenko@linux.intel.com
[sboyd@kernel.org: Remove "die" as it isn't relevant]
Signed-off-by: Stephen Boyd <sboyd@kernel.org>
drivers/clk/clk-fractional-divider.c