candev_driver Struct Reference

Structure to hold driver interface -> function mapping. More...

Detailed Description

Structure to hold driver interface -> function mapping.

Definition at line 91 of file candev.h.

#include <candev.h>

Data Fields
int(*	send )(candev_t *dev, const can_frame_t *frame)
	Send packet.
int(*	abort )(candev_t *dev, const can_frame_t *frame)
	Abort a packet sending.
int(*	init )(candev_t *dev)
	the driver's initialization function
void(*	isr )(candev_t *dev)
	a driver's user-space ISR handler
int(*	get )(candev_t *dev, canopt_t opt, void *value, size_t max_len)
	Get an option value from a given CAN device.
int(*	set )(candev_t *dev, canopt_t opt, void *value, size_t value_len)
	Set an option value for a given CAN device.
int(*	set_filter )(candev_t *dev, const struct can_filter *filter)
	Set a receive filter.
int(*	remove_filter )(candev_t *dev, const struct can_filter *filter)
	Remove a filter.

Field Documentation

abort

int(* candev_driver::abort) (candev_t *dev, const can_frame_t *frame)

Abort a packet sending.

Parameters

[in]	dev	CAN device descriptor
[in]	frame	CAN frame to abort

Returns

< 0 on error

0 on OK

Definition at line 112 of file candev.h.

get

int(* candev_driver::get) (candev_t *dev, canopt_t opt, void *value, size_t max_len)

Get an option value from a given CAN device.

Parameters

[in]	dev	CAN device descriptor
[in]	opt	option type
[out]	value	pointer to store the option's value in
[in]	max_len	maximal amount of byte that fit into value

Returns

number of bytes written to value

<0 on error

Definition at line 141 of file candev.h.

init

int(* candev_driver::init) (candev_t *dev)

the driver's initialization function

Parameters

[in]

dev

CAN device descriptor

Returns

< 0 on error, 0 on success

Definition at line 121 of file candev.h.

isr

void(* candev_driver::isr) (candev_t *dev)

a driver's user-space ISR handler

Parameters

[in]

dev

CAN device descriptor

Definition at line 128 of file candev.h.

remove_filter

int(* candev_driver::remove_filter) (candev_t *dev, const struct can_filter *filter)

Remove a filter.

Parameters

[in]	dev	CAN device descriptor
[in]	filter	filter to remove

Returns

0 on success

<0 on error

Definition at line 176 of file candev.h.

send

int(* candev_driver::send) (candev_t *dev, const can_frame_t *frame)

Send packet.

Parameters

[in]	dev	CAN device descriptor
[in]	frame	CAN frame to send

Returns

< 0 on error

mailbox id >= 0 if OK

Definition at line 101 of file candev.h.

set

int(* candev_driver::set) (candev_t *dev, canopt_t opt, void *value, size_t value_len)

Set an option value for a given CAN device.

Parameters

[in]	dev	CAN device descriptor
[in]	opt	option type
[in]	value	value to set
[in]	value_len	the length of value

Returns

number of bytes used from value

<0 on error

Definition at line 154 of file candev.h.

set_filter

int(* candev_driver::set_filter) (candev_t *dev, const struct can_filter *filter)

Set a receive filter.

Parameters

[in]	dev	CAN device descriptor
[in]	filter	filter to set

Returns

a positive filter number

<0 on error

Definition at line 165 of file candev.h.

---

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

• drivers/include/can/candev.h