michaelh/zephyr
1
0
Fork 0
Code Releases Activity

drivers: can: mcan: document return values from typedef API functions

Browse source 
Document that the Bosch M_CAN read/write register functions are allowed to
return -ENOTSUP for unsupported registers.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
This commit is contained in:
Henrik Brix Andersen 2023-05-21 21:39:43 +02:00 • committed by Anas Nashif
commit c52499e447
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
drivers/can/can_mcan.h
View file

@ -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);