drivers: can: calling can_stop() shall abort any pending transmissions

henrikbrixandersen · fabiobaltieri · commit 9ca4b34035aa · 2022-09-23T17:25:01.000Z
Update the documentation for can_stop() to mention that it shall abort any pending CAN frame transmissions. Fixes: #50545 Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
diff --git a/include/zephyr/drivers/can.h b/include/zephyr/drivers/can.h
@@ -978,7 +978,8 @@ static inline int z_impl_can_start(const struct device *dev)
  * @brief Stop the CAN controller
  *
  * Bring the CAN controller into `CAN_STATE_STOPPED`. This will disallow the CAN controller from
- * participating in CAN communication and disable the CAN transceiver, if supported.
+ * participating in CAN communication, abort any pending CAN frame transmissions, and disable the
+ * CAN transceiver, if supported.
  *
  * @see can_start()
  * @see can_transceiver_disable()

Original file line number	Diff line number	Diff line change
`@@ -978,7 +978,8 @@ static inline int z_impl_can_start(const struct device *dev)`
`978`	`978`	`* @brief Stop the CAN controller`
`979`	`979`	`*`
`980`	`980`	* Bring the CAN controller into `CAN_STATE_STOPPED`. This will disallow the CAN controller from
`981`		`- * participating in CAN communication and disable the CAN transceiver, if supported.`
	`981`	`+ * participating in CAN communication, abort any pending CAN frame transmissions, and disable the`
	`982`	`+ * CAN transceiver, if supported.`
`982`	`983`	`*`
`983`	`984`	`* @see can_start()`
`984`	`985`	`* @see can_transceiver_disable()`