From c52499e447e17ab063123772a64a7b742b7c8d7a Mon Sep 17 00:00:00 2001 From: Henrik Brix Andersen Date: Sun, 21 May 2023 21:39:43 +0200 Subject: [PATCH] drivers: can: mcan: document return values from typedef API functions Document that the Bosch M_CAN read/write register functions are allowed to return -ENOTSUP for unsupported registers. Signed-off-by: Henrik Brix Andersen --- drivers/can/can_mcan.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/drivers/can/can_mcan.h b/drivers/can/can_mcan.h index 25bf5a06224..bf424925198 100644 --- a/drivers/can/can_mcan.h +++ b/drivers/can/can_mcan.h @@ -568,6 +568,7 @@ struct can_mcan_data { * @param[out] val Register value * * @retval 0 If successful. + * @retval -ENOTSUP Register not supported. * @retval -EIO General input/output error. */ typedef int (*can_mcan_read_reg_t)(const struct device *dev, uint16_t reg, uint32_t *val); @@ -580,6 +581,7 @@ typedef int (*can_mcan_read_reg_t)(const struct device *dev, uint16_t reg, uint3 * @param val Register value * * @retval 0 If successful. + * @retval -ENOTSUP Register not supported. * @retval -EIO General input/output error. */ typedef int (*can_mcan_write_reg_t)(const struct device *dev, uint16_t reg, uint32_t val);