Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
lin_driver_api Struct Reference

Driver Operations LIN Controller driver operations More...

#include <zephyr/drivers/lin.h>

Data Fields

lin_start_t start
  REQ Start LIN controller.
lin_stop_t stop
  REQ Stop LIN controller.
lin_configure_t configure
  REQ Configure LIN controller.
lin_get_config_t get_config
  REQ Get current LIN configuration.
lin_set_rx_filter_t set_rx_filter
  OPT Set a LIN RX filter (responder mode only).
lin_send_t send
  REQ Send LIN message (commander mode only).
lin_receive_t receive
  REQ Receive LIN message (commander mode only).
lin_response_t response
  OPT Respond to a received header (responder mode only).
lin_read_t read
  OPT Start data reception (responder mode only).
lin_wakeup_send_t wakeup_send
  OPT Send LIN wakeup signal.
lin_set_event_callback_t set_event_callback
  REQ Set LIN event callback.

Detailed Description

Driver Operations LIN Controller driver operations

This is the driver API structure any LIN Controller driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also
DEVICE_DT_INST_DEFINE()
DEVICE_DT_DEFINE()
DEVICE_API()

Field Documentation

◆ configure

lin_configure_t lin_driver_api::configure

REQ Configure LIN controller.

◆ get_config

lin_get_config_t lin_driver_api::get_config

REQ Get current LIN configuration.

◆ read

lin_read_t lin_driver_api::read

OPT Start data reception (responder mode only).

◆ receive

lin_receive_t lin_driver_api::receive

REQ Receive LIN message (commander mode only).

◆ response

lin_response_t lin_driver_api::response

OPT Respond to a received header (responder mode only).

◆ send

lin_send_t lin_driver_api::send

REQ Send LIN message (commander mode only).

◆ set_event_callback

lin_set_event_callback_t lin_driver_api::set_event_callback

REQ Set LIN event callback.

◆ set_rx_filter

lin_set_rx_filter_t lin_driver_api::set_rx_filter

OPT Set a LIN RX filter (responder mode only).

◆ start

lin_start_t lin_driver_api::start

REQ Start LIN controller.

◆ stop

lin_stop_t lin_driver_api::stop

REQ Stop LIN controller.

◆ wakeup_send

lin_wakeup_send_t lin_driver_api::wakeup_send

OPT Send LIN wakeup signal.


The documentation for this struct was generated from the following file: