[PATCH net-next] can: bcm: Document ival1 count semantics

From: raoxu

Date: Wed Nov 11 2026 - 21:39:10 EST


From: Xu Rao <raoxu@xxxxxxxxxxxxx>

Clarify that count controls the initial transmission schedule rather
than counting successfully transmitted CAN frames. An error returned by
can_send() does not prevent the counter from advancing.

Describe the transition to ival2 when count reaches zero, or termination
if ival2 is zero.

Signed-off-by: Xu Rao <raoxu@xxxxxxxxxxxxx>
---
This documentation-only patch follows Oliver Hartkopp's suggestion to
clarify count semantics in the discussion of my earlier patch,
"can: bcm: Account cyclic transmissions only on success".
That code change has been dropped; this patch does not change BCM behavior.

Documentation/networking/can.rst | 5 +++++
1 file changed, 5 insertions(+)

diff --git a/Documentation/networking/can.rst b/Documentation/networking/can.rst
index 51bc70748f75..840d840665a4 100644
--- a/Documentation/networking/can.rst
+++ b/Documentation/networking/can.rst
@@ -892,6 +892,11 @@ only one timer is needed 'count' is set to zero and only 'ival2' is used.
When SET_TIMER and START_TIMER flag were set the timers are activated.
The timer values can be altered at runtime when only SET_TIMER is set.

+For cyclic transmission tasks, ``count`` specifies the number of
+transmission attempts scheduled at ``ival1``, not the number of
+successfully transmitted CAN frames. The counter advances even when
+``can_send()`` returns an error. When ``count`` reaches zero, the
+transmission continues at ``ival2`` if nonzero, or stops otherwise.

Broadcast Manager message sequence transmission
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
2.50.1