linux-can.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Stefan Mätje" <Stefan.Maetje@esd.eu>
To: "mailhol.vincent@wanadoo.fr" <mailhol.vincent@wanadoo.fr>
Cc: "linux-can@vger.kernel.org" <linux-can@vger.kernel.org>,
	"mkl@pengutronix.de" <mkl@pengutronix.de>
Subject: Re: [RFC PATCH v4 4/4] iplink_can: add new CAN FD bittiming parameters: Transmitter Delay Compensation (TDC)
Date: Mon, 9 Aug 2021 14:44:58 +0000	[thread overview]
Message-ID: <d9dfe2f1df48f0f4a7ee413f9263f741ca1014f8.camel@esd.eu> (raw)
In-Reply-To: <CAMZ6Rq+8hYtaPJEqrNA_hR-KRureu6Gx+sJc79OwLQ8MFe2Pig@mail.gmail.com>

Some late comments on this ...

Am Freitag, den 09.07.2021, 15:32 +0200 schrieb Vincent MAILHOL:
> Hi Stefan,
> 
> On Wed. 7 Jul 2021 at 18:21, Stefan Mätje <Stefan.Maetje@esd.eu> wrote:
> > Hi Vincent,
> > 
> > it took some time to get an opinion on the proposed implementation of the user
> > interface to control TDC.
> 
> Thanks for your involvement, I am always happy to get constructive feedback!
> 
> > At first I've inspected the driver implementations for the following CAN cores
> > in the Linux tree (FlexCAN, ifi_canfd, MCAN, mcp251xfd) on how the TDC is
> > implemented currently. All the drivers for these controllers by default use the
> > automatic measurement of TDCV and set up the TDCO value in a way that the SSP
> > occurs in the delayed received bit at the same position as the sample point is
> > set for the remote receivers (provided the same bitrate setting is used).
> 
> ACK. This means that TDCO = SP and that:
>   SSP = TDCV + TDCO
>       = TDCV + SP
> 
> And that’s also the formula I used in can_calc_tdco():
> https://elixir.bootlin.com/linux/latest/source/drivers/net/can/dev/bittiming.c#L178

A nitpick on the can_calc_tdco() function. There you calculate the sample_point_in_tq
like this:

	u32 sample_point_in_tq = can_bit_time(dbt) * dbt->sample_point / 1000;

You use there dbt->sample_point which is a calculated value and the whole formula may
undergo rounding and truncation (even already the input value dbt->sample_point has).
A formula where you even don't need to think about this issue would be:

	u32 sample_point_in_tq = can_bit_time(dbt) - dbt->phase_seg2;

> 
> > This is the default mode for TDC, i. e. the TDC is always enabled in FD mode
> > (sometimes only for higher data bitrates) and the TDCO is derived from the data
> > bitrate settings. This works and the measurement of TDCV compensates for changes
> > in delay over time and temperature. This is also the recommended setting of the
> > SSP.
> 
> Out of curiosity, when you say that this is the "recommended
> setting", do you have any references? I agree that this is the
> most natural way to calculate TDC but I never found good
> references.

The basic idea behind the setting of the TDCO is that all nodes on the bus (the
transmitter and the receiving nodes) should sample their received bits at the same
offset during the bit-time. Because the TDCV value compensates the tranmitter round
trip delay (TX -> RX pin) the TDCO value should be the number of CAN clock cycles
to reach the Sample Point Offset (SP) in the bit time which is 

TDCO = (1 SYNC_Tq + PROP_Segment_Tqs + TSEG1_Tqs) * DBRP

I found a recommendation for this in the FlexCAN controller's description in the 
reference manual for a NXP embedded controller family:

S32K1xx Series Reference Manual, Document Number: S32K1XXRM, Rev. 13, 04/2020

On page 1921, section "55.5.9.3 Transceiver delay compensation" you can find this 
recommendated formula:

	Offset = (FPSEG1 + FPROPSEG + 2) x (FPRESDIV + 1)

which boils down to the formula for TDCO shown before if you replace the register
contents of the formula for "Offset" by the "real" values shown in the formula
for TDCO.

Written differently with "real" values in {} (compare the cited reference manual
on page 1874 about the register contents):

	Offset = ({FPSEG1 +1} + {FPROPSEG} + {SYNC_Tq}) * ({FPRESDIV + 1})
	Offset = (TSEG1_Tqs + Prop_Segment_Tqs + SYNC_Tq) * (DBRP)


> > So the opportunity to change the TDC control values is only needed in a test
> > enviroment or when trying to tune the behavior to evaluate corner cases.
> > 
> > Need to mention that the TDCV and TDCO values (if implemented) for all mentioned
> > controllers are in CAN clock period (Tc) counts and NOT in time quanta (Tq)
> > counts!
> > The CAN clock period (Tc) also defines the "minimum time quantum" which
> > is referenced in the ISO 11898 description of the TDC operation.
> 
> Thanks for the clarification. I completely missed the nuances
> between the "time quantum" and the "minimum time quantum" and
> wrongly assumed that the TDC parameters were also expressed in
> time quanta similar to the other bittiming parameters.
> 
> Using the time quantum instead of the clock period is my mistake.
> 
> > See below for further comments ...
> > 
> > Best regards,
> >     Stefan
> > 
> > 
> > Am Dienstag, den 29.06.2021, 00:44 +0900 schrieb Vincent Mailhol:
> > > At high bit rates, the propagation delay from the TX pin to the RX pin
> > > of the transceiver causes measurement errors: the sample point on the
> > > RX pin might occur on the previous bit.
> > > 
> > > This issue is addressed in ISO 11898-1 section 11.3.3 "Transmitter
> > > delay compensation" (TDC).
> > > 
> > > This patch brings command line support to nine TDC parameters which
> > > were recently added to the kernel's CAN netlink interface in order to
> > > implement TDC:
> > >   - IFLA_CAN_TDC_TDCV_MIN: Transmitter Delay Compensation Value
> > >     minimum value
> > >   - IFLA_CAN_TDC_TDCV_MAX: Transmitter Delay Compensation Value
> > >     maximum value
> > >   - IFLA_CAN_TDC_TDCO_MIN: Transmitter Delay Compensation Offset
> > >     minimum value
> > >   - IFLA_CAN_TDC_TDCO_MAX: Transmitter Delay Compensation Offset
> > >     maximum value
> > >   - IFLA_CAN_TDC_TDCF_MIN: Transmitter Delay Compensation Filter
> > >     window minimum value
> > >   - IFLA_CAN_TDC_TDCF_MAX: Transmitter Delay Compensation Filter
> > >     window maximum value
> > >   - IFLA_CAN_TDC_TDCV: Transmitter Delay Compensation Value
> > >   - IFLA_CAN_TDC_TDCO: Transmitter Delay Compensation Offset
> > >   - IFLA_CAN_TDC_TDCF: Transmitter Delay Compensation Filter window
> > > 
> > > TDCV is reported only if the device supports
> > > CAN_CTRLMODE_TDC_MANUAL.
> > 
> > I think the TDCV value should be reported in any case. Assume the interface is
> > in default mode (as described before and selected by omitting the tdc-mode
> > parameter) or in your auto mode then the TDCV value reported should be the
> > measured value of the TDCV if available. This could then serve as a useful
> > starting point for manual configuration experiments. If the measured TDCV is not
> > available from the controller registers it should return zero.
> 
> Your comment is valid. The reason I did not implement it is
> because I do not own a device capable of reporting the value.
> 
> I can propose to add a virtual function in struct can_priv:
> +
> 
>  int (*do_get_auto_tdcv)(struct net_device *dev);
> 
> If the function is implemented, use it to report TDCV when in auto mode.

I also think that this function is needed because when the netlink interface
call runs through the kernel there must be driver / controller specific code
to extract the current TDCV value from the CAN controller.


> I disagree on one point: if the value is not available, I think
> it is better not report TDCV rather than reporting zero. As I
> commented in my other patches, zero is a valid value for TDCV, we
> can not use it to mean "not available" or "not set".

This is fine with me. But aren't the TDCx values put in a single structure
(NFLA_NESTED...?). And how can the user level detect that the TDCV value
is provided or not?

Ok, on a second look it seems that there is the choice to add the IFLA_CAN_TDC_TDCV
"structure" in can_fill_info() or not ...


> > A similar idea holds true for the TDCO value. When the driver calulates a
> > suitable value for the TDCO (in default mode) the "ip -details link show" should
> > report the TDCO value set by the driver.
> 
> That should be the current behavior. In either auto or manual
> modes, the TDCO value inputted by the user should be returned. In
> default (i.e. no parameters calculated), the TDCO value is
> reported only if TDC is on (c.f. can_calculate_tdco() function).
> Did you witnessed TDCO not being reported after TDC being set?
> 
> > > TDCF is reported only if tdcf_max is not
> > > zero.
> > 
> > Note: I think TDCF is only supported by MCAN so far.
> 
> FYI, the SAM E70/S70/V70/V71 Family from Microchip also support TDCF:
> https://elixir.bootlin.com/linux/latest/source/drivers/net/can/usb/etas_es58x/es58x_fd.c#L511

I would like to mention that the controller implemented in the SAM E70* controller
family is a MCAN implementation / IP core. So I think we're both right ;-)


> > > All those new parameters are nested together into the attribute
> > > IFLA_CAN_TDC.
> > > 
> > > A tdc-mode parameter allow to specify how to opperate. Valid options
> > > are:
> > > 
> > >   * auto: the transmitter automatically measures TDCV. As such, TDCV
> > >     values can not be manually provided. In this mode, the user must
> > >     specify TDCO and may also specify TDCF if supported.
> > > 
> > >   * manual: Use the TDCV value provided by the user are used. In this
> > >     mode, the user must specify both TDCF and TDCO and may also
> > >     specify TDCF if supported.
> > > 
> > >   * off: TDC is explicitely disabled.
> > > 
> > >   * tdc-mode parameter omitted: the kernel decides whether TDC should
> > >     be enabled or not and if so, it calculates the TDC values.
> > 
> > This mode with tdc-mode parameter omitted I have called "default mode" in my
> > introduction.
> 
> ACK. This is also my intent to use it as default mode.
> I will add a comment to the patch description to reflect this.
> 
> > For reference, here are a few samples of how the output looks like:
> > > 
> > > $ ip link set can0 type can bitrate 1000000 dbitrate 8000000 fd on tdco 7 tdcf
> > > 8 tdc-mode auto
> > 
> > So switching from a setting with "tdc-mode auto" (like before) back to the
> > default mode should then be done by
> > 
> > $ ip link set can0 type can bitrate 1000000 dbitrate 8000000 fd on
> 
> Yes
> 
> > But as far as I understand without any TDC parameters the ip tool does not send
> > the IFLA_CAN_TDC structure to the kernel. So on the kernel level this is the
> > signal to switch back to "default mode" for TDC?
> 
> The signal is on the CAN_CTRLMODE_TDC_{AUTO,MANUAL} flags:
>   * If the flags are omitted (not set): default mode (parameter omitted)
>   * If both are set to false: TDC off
>   * If CAN_CTRLMODE_TDC_AUTO is set to true: TDC auto mode
>   * If CAN_CTRLMODE_TDC_MANUAL is set to true: TDC manual mode
> 
> N.B.: The kernel forbids both CAN_CTRLMODE_TDC_{AUTO,MANUAL} to be
> both set to true at the same time.
:
Lots of stuff cut away
:
> > So I would propose to change the documentation in include/linux/can/bittiming.h
> > to say that the TDCx values are based on the CAN clock period (Tc). Then the
> > code for can_tdc_changelink() checks for the correct limits. And also the help
> > output of "ip link help can" should explicitely state that the TDCx values are
> > NOT based on time quanta.
> > 
> > I think the confusion of the user is less with that approach because it is not
> > so far away from the documented register interface of the CAN controllers. Even
> > if it would be the only point in the CAN area where settings are not based on
> > time quanta (Tq) but on CAN clock periods (Tc).
> 
> ACK.
> 
> > And as I mentioned above the "normal" user should never need to set TDC values
> > and always use the "default" mode. The expert user should perhaps be able to
> > understand the different time bases for TDCx values and other timing parameters.
> 
> ACK. This is also my intent.
> 
> > And in a testing and evaluation environment the higher resolution of the Tc
> > based TDCx values may also be a benefit. I. e. when reading the measured TDCV
> > value to monitor the change of the delay over time and temperature.
> 
> From your comments, I see two immediate actions:
>   * Change the unit from time quanta to clock period (Tc)
>   * Add a method to retrieve TDCV value when in auto mode

That would be cool. Thanks.

> Right now, I am in holiday, with no access to my usual testing
> gears.  I will prepare a version of the patches but you might
> have to wait until August.
> 
> 
> Yours sincerely,
> Vincent

Hope you had nice holidays ...

Best regards,
    Stefan

-- 
Stefan Mätje
System Design

Phone: +49-511-37298-146
E-Mail: stefan.maetje@esd.eu
_______________________________________
esd electronics gmbh
Vahrenwalder Str. 207
30165 Hannover
www.esd.eu

Quality Products – Made in Germany
_______________________________________

Register Hannover HRB 51373 - VAT-ID DE 115672832
General Manager: Klaus Detering


  reply	other threads:[~2021-08-09 14:45 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-28 15:43 [RFC PATCH v4 0/4] iplink_can: cleaning, fixes and adding TDC support Vincent Mailhol
2021-06-28 15:43 ` [RFC PATCH v4 1/4] iplink_can: fix configuration ranges in print_usage() Vincent Mailhol
2021-06-28 15:44 ` [RFC PATCH v4 2/4] iplink_can: use PRINT_ANY to factorize code and fix signedness Vincent Mailhol
2021-06-28 15:44 ` [RFC PATCH v4 3/4] iplink_can: print brp and dbrp bittiming variables Vincent Mailhol
2021-07-07 16:33   ` Stefan Mätje
2021-07-09 12:17     ` Vincent MAILHOL
2021-08-09 12:27       ` Stefan Mätje
2021-06-28 15:44 ` [RFC PATCH v4 4/4] iplink_can: add new CAN FD bittiming parameters: Transmitter Delay Compensation (TDC) Vincent Mailhol
2021-07-07 16:21   ` Stefan Mätje
2021-07-09 13:32     ` Vincent MAILHOL
2021-08-09 14:44       ` Stefan Mätje [this message]
2021-08-14  9:51         ` Vincent MAILHOL

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=d9dfe2f1df48f0f4a7ee413f9263f741ca1014f8.camel@esd.eu \
    --to=stefan.maetje@esd.eu \
    --cc=linux-can@vger.kernel.org \
    --cc=mailhol.vincent@wanadoo.fr \
    --cc=mkl@pengutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).