CAN Transceiver

Interfaces for CAN transceivers. More...

Files
file	transceiver.h
	Header file for CAN transceiver driver API.

Data Structures
struct	can_transceiver_driver_api
	@driver_ops{CAN Transceiver} More...

Functions
static int	can_transceiver_enable (const struct device *dev, can_mode_t mode)
	Enable CAN transceiver.
static int	can_transceiver_disable (const struct device *dev)
	Disable CAN transceiver.
typedef int(*	can_transceiver_enable_t) (const struct device *dev, can_mode_t mode)
	@def_driverbackendgroup{CAN Transceiver,can_transceiver}
typedef int(*	can_transceiver_disable_t) (const struct device *dev)
	Callback API upon disabling CAN transceiver.

Detailed Description

Interfaces for CAN transceivers.

Since

3.1

Version

0.1.0

Typedef Documentation

can_transceiver_disable_t

typedef int(* can_transceiver_disable_t) (const struct device *dev)

#include <transceiver.h>

Callback API upon disabling CAN transceiver.

See can_transceiver_disable() for argument description

can_transceiver_enable_t

typedef int(* can_transceiver_enable_t) (const struct device *dev, can_mode_t mode)

#include <transceiver.h>

@def_driverbackendgroup{CAN Transceiver,can_transceiver}

Callback API upon enabling CAN transceiver. See can_transceiver_enable() for argument description

Function Documentation

can_transceiver_disable()

int can_transceiver_disable ( const struct device * dev )

inlinestatic

#include <transceiver.h>

Disable CAN transceiver.

Disable the CAN transceiver.

Note

The CAN transceiver is controlled by the CAN controller driver and should not normally be controlled by the application.

See also

can_stop()

Parameters

dev	Pointer to the device structure for the driver instance.

Return values

0	If successful.
-EIO	General input/output error, failed to disable device.

can_transceiver_enable()

int can_transceiver_enable ( const struct device * dev, can_mode_t mode )

inlinestatic

#include <transceiver.h>

Enable CAN transceiver.

Enable the CAN transceiver.

Note

The CAN transceiver is controlled by the CAN controller driver and should not normally be controlled by the application.

See also

can_start()

Parameters

dev	Pointer to the device structure for the driver instance.
mode	Operation mode.

Return values

0	If successful.
-EIO	General input/output error, failed to enable device.