[1/4] drm/msm/dp: Simplify the mvid/nvid calculation

Message ID 20210511042043.592802-2-bjorn.andersson@linaro.org New show [1/4] drm/msm/dp: Simplify the mvid/nvid calculation | expand

Commit Message

Bjorn Andersson May 11, 2021, 4:20 a.m. UTC
In the search for causes to timing issues seen during implementation of
eDP support for SC8180x a fair amount of time was spent concluding why
the calculated mvid/nvid values where wrong.

The overall conclusion is that the ratio of MVID/NVID describes, and
should match, the ratio between the pixel and link clock.

Downstream this calculation reads the M and N values off the pixel clock
straight from DISP_CC and are then adjusted based on knowledge of how
the link and vco_div (parent of the pixel clock) are derrived from the
common VCO.

While upstreaming, and then extracting the PHY driver, the resulting
function performs the following steps:

1) Adjust the passed link rate based on the VCO divider used in the PHY
driver, and multiply this by 10 based on the link rate divider.
2) Pick reasonable choices of M and N, by calculating the ratio between
this new clock and the pixel clock.
3) Subtract M from N and flip the bits, to match the encoding of the N
register in DISP_CC.
4) Flip the bits of N and add M, to get the value of N back.
5) Multiply M with 5, per the documentation.
6) Scale the values such that N is close to 0x8000 (or larger)
7) Multply M with 2 or 3 depending on the link rate of HBR2 or HBR3.

Presumably step 3) was added to provide step 4) with expected input, so
the two cancel each other out. The factor of 10 from step 1) goes into
the denominator and is partially cancelled by the 5 in the numerator in
step 5), resulting in step 7) simply cancelling out step 1).

Left is the code that finds the ratio between the two arguments, scaled
to keep the denominator close to or larger than 0x8000. And this is our
mvid/nvid pair.

---
drivers/gpu/drm/msm/dp/dp_catalog.c | 41 +++++------------------------
1 file changed, 6 insertions(+), 35 deletions(-)

--
2.29.2

Bjorn Andersson June 8, 2021, 8:13 p.m. UTC | #1
On Fri 28 May 18:11 CDT 2021, abhinavk@codeaurora.org wrote:

> Hi Bjorn

>

> On 2021-05-10 21:20, Bjorn Andersson wrote:

> > In the search for causes to timing issues seen during implementation of

> > eDP support for SC8180x a fair amount of time was spent concluding why

> > the calculated mvid/nvid values where wrong.

> >

> > The overall conclusion is that the ratio of MVID/NVID describes, and

> > should match, the ratio between the pixel and link clock.

> >

> > Downstream this calculation reads the M and N values off the pixel clock

> > straight from DISP_CC and are then adjusted based on knowledge of how

> > the link and vco_div (parent of the pixel clock) are derrived from the

> > common VCO.

> >

> > While upstreaming, and then extracting the PHY driver, the resulting

> > function performs the following steps:

> >

> > 1) Adjust the passed link rate based on the VCO divider used in the PHY

> >    driver, and multiply this by 10 based on the link rate divider.

> > 2) Pick reasonable choices of M and N, by calculating the ratio between

> >    this new clock and the pixel clock.

> > 3) Subtract M from N and flip the bits, to match the encoding of the N

> >    register in DISP_CC.

> > 4) Flip the bits of N and add M, to get the value of N back.

> > 5) Multiply M with 5, per the documentation.

> > 6) Scale the values such that N is close to 0x8000 (or larger)

> > 7) Multply M with 2 or 3 depending on the link rate of HBR2 or HBR3.

> >

> > Presumably step 3) was added to provide step 4) with expected input, so

> > the two cancel each other out. The factor of 10 from step 1) goes into

> > the denominator and is partially cancelled by the 5 in the numerator in

> > step 5), resulting in step 7) simply cancelling out step 1).

> >

>

> Both the multiplication of M with 5 and N with 2 or 3 is coming because of

> the

> ratio between the vco clk and the link clk.

> So we could have 2.7, 5.4 or 8.1 Gbps link clks and the factor of 2 or 3

> gets added because hbr2 is 2 * hbr and hbr3 is 3 * hbr.

>

Thanks for explaining the origin of these numbers, I had quite a
difficult time figuring out where the "magic" came from.

> Your summary is pretty much right otherwise. Let me add some more points

> here:

>

> 1) Originally we removed reading the M_VID and N_VID from the DISPCC regs

> because

> of previous upstream comments that we can potentially just recalculate

> whatever the clk driver is programming

> by using rational_best_approximation

> https://gitlab.freedesktop.org/drm/msm/-/blob/msm-next/drivers/clk/qcom/clk-rcg2.c#L1160

>

> Not having to read from DISPCC register is also useful because we dont have

> to maintain the register offset

> of the M_VID and N_VID which keeps changing across chipsets.

>

Right, so downstream we do all the math and then we scale the
denominator by 2x or 3x to compensate for the fact that we didn't
account for the division as the clock left the PLL.

As this was reworked upstream for some reason this compensation was
retained, so the denominator would always be 2x or 3x to large for HBR2
and HBR3. So the way this was solved was to divide by 2x or 3x before
calculating the ratio.

> However we discussed this again after viewing this patch. So the clk driver

> always operates on the vco clk

> and calculates the pixel clk from it and sets the M_VID and N_VID based on

> that.

> In terms of accuracy, the best way is still to re-use the M_VID and N_VID

> which the clk driver sets because

> the pixel clock was generated based on that and that is the actual pixel

> clock we are going to get.

>

> So even before this change we lost some accuracy because the pixel clock we

> are giving here to recalculate

> the M_VID and N_VID is a theoretical value. Although for most values of

> pixel clk, theoretical and actual

> should match. There could be corner cases of pixel clock where its a bit

> different. Hence ideally, re-using the M_VID

> and N_VID which the clk driver set would have been the best but not having

> to hard-code M_VID and N_VID offsets

> was a good enough reason to not go back to that again.

>

> Now, coming to this change. Here its trying to again re-calculate the M_VID

> and N_VID by using the same

> API which the clk driver uses but uses link clk and pixel clk as the

> parameters Vs the clk driver uses

> vco clk and actual pixel clock to calculate this.

>

> So even though this cleanup eliminates the adjustments we need to make to

> account for the VCO clk to link clk ratio,

> it also could bring additional difference between what was actually set by

> the clk driver and what we are calculating

> here because clk driver used vco clk as the input vs here we use link clk

> after this change.

> There might be some pixel clock rates of some resolutions where this

> difference could be risky.

>

> Hence the overall conclusion here was to keep using vco clk as the input to

> rational_best_approximation

> and not make more changes to this.

>

So what you're saying is that the reason for this obfuscation is to
replicate any rounding errors happening in the path of the link clock
generation?

If that's the case then this needs a giant comment describing exactly
what's happening and why this function needs to be impenetrable.

That said, from my attempts to write this patch (and add widebus
support) I saw a huge flexibility in getting this right, so can you
please elaborate on the value of the precision of the ratio.

Regards,
Bjorn
Abhinav Kumar June 9, 2021, 12:08 a.m. UTC | #2
Hi Bjorn

On 2021-06-08 13:13, Bjorn Andersson wrote:
> On Fri 28 May 18:11 CDT 2021, abhinavk@codeaurora.org wrote:

>

>> Hi Bjorn

>>

>> On 2021-05-10 21:20, Bjorn Andersson wrote:

>> > In the search for causes to timing issues seen during implementation of

>> > eDP support for SC8180x a fair amount of time was spent concluding why

>> > the calculated mvid/nvid values where wrong.

>> >

>> > The overall conclusion is that the ratio of MVID/NVID describes, and

>> > should match, the ratio between the pixel and link clock.

>> >

>> > Downstream this calculation reads the M and N values off the pixel clock

>> > straight from DISP_CC and are then adjusted based on knowledge of how

>> > the link and vco_div (parent of the pixel clock) are derrived from the

>> > common VCO.

>> >

>> > While upstreaming, and then extracting the PHY driver, the resulting

>> > function performs the following steps:

>> >

>> > 1) Adjust the passed link rate based on the VCO divider used in the PHY

>> >    driver, and multiply this by 10 based on the link rate divider.

>> > 2) Pick reasonable choices of M and N, by calculating the ratio between

>> >    this new clock and the pixel clock.

>> > 3) Subtract M from N and flip the bits, to match the encoding of the N

>> >    register in DISP_CC.

>> > 4) Flip the bits of N and add M, to get the value of N back.

>> > 5) Multiply M with 5, per the documentation.

>> > 6) Scale the values such that N is close to 0x8000 (or larger)

>> > 7) Multply M with 2 or 3 depending on the link rate of HBR2 or HBR3.

>> >

>> > Presumably step 3) was added to provide step 4) with expected input, so

>> > the two cancel each other out. The factor of 10 from step 1) goes into

>> > the denominator and is partially cancelled by the 5 in the numerator in

>> > step 5), resulting in step 7) simply cancelling out step 1).

>> >

>>

>> Both the multiplication of M with 5 and N with 2 or 3 is coming

>> because of

>> the

>> ratio between the vco clk and the link clk.

>> So we could have 2.7, 5.4 or 8.1 Gbps link clks and the factor of 2 or

>> 3

>> gets added because hbr2 is 2 * hbr and hbr3 is 3 * hbr.

>>

>

> Thanks for explaining the origin of these numbers, I had quite a

> difficult time figuring out where the "magic" came from.

>

>> Your summary is pretty much right otherwise. Let me add some more

>> points

>> here:

>>

>> 1) Originally we removed reading the M_VID and N_VID from the DISPCC

>> regs

>> because

>> of previous upstream comments that we can potentially just recalculate

>> whatever the clk driver is programming

>> by using rational_best_approximation

>> https://gitlab.freedesktop.org/drm/msm/-/blob/msm-next/drivers/clk/qcom/clk-rcg2.c#L1160

>>

>> Not having to read from DISPCC register is also useful because we dont

>> have

>> to maintain the register offset

>> of the M_VID and N_VID which keeps changing across chipsets.

>>

>

> Right, so downstream we do all the math and then we scale the

> denominator by 2x or 3x to compensate for the fact that we didn't

> account for the division as the clock left the PLL.

>

> As this was reworked upstream for some reason this compensation was

> retained, so the denominator would always be 2x or 3x to large for HBR2

> and HBR3. So the way this was solved was to divide by 2x or 3x before

> calculating the ratio.

>

>> However we discussed this again after viewing this patch. So the clk

>> driver

>> always operates on the vco clk

>> and calculates the pixel clk from it and sets the M_VID and N_VID

>> based on

>> that.

>> In terms of accuracy, the best way is still to re-use the M_VID and

>> N_VID

>> which the clk driver sets because

>> the pixel clock was generated based on that and that is the actual

>> pixel

>> clock we are going to get.

>>

>> So even before this change we lost some accuracy because the pixel

>> clock we

>> are giving here to recalculate

>> the M_VID and N_VID is a theoretical value. Although for most values

>> of

>> pixel clk, theoretical and actual

>> should match. There could be corner cases of pixel clock where its a

>> bit

>> different. Hence ideally, re-using the M_VID

>> and N_VID which the clk driver set would have been the best but not

>> having

>> to hard-code M_VID and N_VID offsets

>> was a good enough reason to not go back to that again.

>>

>> Now, coming to this change. Here its trying to again re-calculate the

>> M_VID

>> and N_VID by using the same

>> API which the clk driver uses but uses link clk and pixel clk as the

>> parameters Vs the clk driver uses

>> vco clk and actual pixel clock to calculate this.

>>

>> So even though this cleanup eliminates the adjustments we need to make

>> to

>> account for the VCO clk to link clk ratio,

>> it also could bring additional difference between what was actually

>> set by

>> the clk driver and what we are calculating

>> here because clk driver used vco clk as the input vs here we use link

>> clk

>> after this change.

>> There might be some pixel clock rates of some resolutions where this

>> difference could be risky.

>>

>> Hence the overall conclusion here was to keep using vco clk as the

>> input to

>> rational_best_approximation

>> and not make more changes to this.

>>

>

> So what you're saying is that the reason for this obfuscation is to

> replicate any rounding errors happening in the path of the link clock

> generation?

>

> If that's the case then this needs a giant comment describing exactly

> what's happening and why this function needs to be impenetrable.

>

>

> That said, from my attempts to write this patch (and add widebus

> support) I saw a huge flexibility in getting this right, so can you

> please elaborate on the value of the precision of the ratio.

>

The overall goal here is just to replicate whats happening in the clock
driver and clock hardware to calculate the pixel clock.
That is, use the same inputs and function as the ones used in clk driver
to calculated to set the DISPCC_MVID and DISPCC_NVID regs.

I think i have already explained why we need the *2 and *3 in the math.
If you need, sure I can document this as well in code

By obfuscation are you referring to this snippet?
https://gitlab.freedesktop.org/drm/msm/-/blob/msm-next/drivers/gpu/drm/msm/dp/dp_catalog.c#L446

This is just recalculating the dispcc rate from the pixel clock rate so
that we feed the same input
to the rational_best_approximation as what the clock driver would do and
hence making our input
and output same for the rational_best_approximation as the clock driver
to maintain consistency and I will explain why.

Let me explain a little bit more on the mnd precision i am referring to.

The clock driver will also use the same API to calculate the mnds and
generate a pixel clock.
It might not match the requested theoretical pixel clock as the mnds
calculated with this API might have some precision errors.

rational_best_approximation(dispcc_input_rate, stream_rate_khz,
(unsigned long)(1 << 16) - 1,
(unsigned long)(1 << 16) - 1, &den, &num);

By using the same input (dispcc rate) and output(pixel clk) rates, we
are getting the same mnds and hence same mvid and nvid.

If you use the link clk rate here instead, it might generate some other
mvid/nvid and the pixel clock for that might be which is different
from what is the actual pixel clock which the PLL generated ( due to the
mnd calculated using the API ).

Hence to preserve the same loss of accuracy which the clock driver would
have, we would prefer to use the same input here too.

Let me know if its still not clear.

> Regards,

> Bjorn

Patch

diff --git a/drivers/gpu/drm/msm/dp/dp_catalog.c b/drivers/gpu/drm/msm/dp/dp_catalog.c
index b1a9b1b98f5f..2eb37ee48e42 100644
--- a/drivers/gpu/drm/msm/dp/dp_catalog.c
+++ b/drivers/gpu/drm/msm/dp/dp_catalog.c
@@ -415,39 +415,16 @@  void dp_catalog_ctrl_config_msa(struct dp_catalog *dp_catalog,
u32 rate, u32 stream_rate_khz,
bool fixed_nvid)
{
-	u32 pixel_m, pixel_n;
-	u32 mvid, nvid, pixel_div = 0, dispcc_input_rate;
-	u32 const link_rate_hbr2 = 540000;
-	u32 const link_rate_hbr3 = 810000;
-	unsigned long den, num;
-
+	unsigned long mvid, nvid;
struct dp_catalog_private *catalog = container_of(dp_catalog,
struct dp_catalog_private, dp_catalog);

-		pixel_div = 6;
-	else if (rate == 1620000 || rate == 270000)
-		pixel_div = 2;
-	else if (rate == link_rate_hbr2)
-		pixel_div = 4;
-	else
-		DRM_ERROR("Invalid pixel mux divider\n");
-
-	dispcc_input_rate = (rate * 10) / pixel_div;
-
-	rational_best_approximation(dispcc_input_rate, stream_rate_khz,
-			(unsigned long)(1 << 16) - 1,
-			(unsigned long)(1 << 16) - 1, &den, &num);
-
-	den = ~(den - num);
-	den = den & 0xFFFF;
-	pixel_m = num;
-	pixel_n = den;
-
-	mvid = (pixel_m & 0xFFFF) * 5;
-	nvid = (0xFFFF & (~pixel_n)) + (pixel_m & 0xFFFF);
+	rational_best_approximation(stream_rate_khz, rate,
+				    (1 << 16) - 1, (1 << 16) - 1,
+				    &mvid, &nvid);

+	/* Adjust values so that nvid is close to DP_LINK_CONSTANT_N_VALUE */
if (nvid < nvid_fixed) {
u32 temp;

@@ -456,13 +433,7 @@  void dp_catalog_ctrl_config_msa(struct dp_catalog *dp_catalog,
nvid = temp;
}