hal_can_driver Struct Reference

Structure representing an CAN driver. More...

#include <hal_can_lld.h>

Collaboration diagram for hal_can_driver:

Data Fields
canstate_t	state
	Driver state.
const CANConfig *	config
	Current configuration data.
threads_queue_t	txqueue
	Transmission threads queue.
threads_queue_t	rxqueue
	Receive threads queue.
event_source_t	rxfull_event
	One or more frames become available.
event_source_t	txempty_event
	One or more transmission mailbox become available.
event_source_t	error_event
	A CAN bus error happened.
event_source_t	sleep_event
	Entering sleep state event.
event_source_t	wakeup_event
	Exiting sleep state event.

Detailed Description

Structure representing an CAN driver.

Definition at line 150 of file hal_can_lld.h.

Field Documentation

state

canstate_t hal_can_driver::state

Driver state.

Definition at line 154 of file hal_can_lld.h.

Referenced by can_lld_start(), can_lld_stop(), canObjectInit(), canReceiveTimeout(), canSleep(), canStart(), canStop(), canTransmitTimeout(), canTryReceiveI(), canTryTransmitI(), and canWakeup().

config

const CANConfig* hal_can_driver::config

Current configuration data.

Definition at line 158 of file hal_can_lld.h.

Referenced by canObjectInit(), canStart(), and canStop().

txqueue

threads_queue_t hal_can_driver::txqueue

Transmission threads queue.

Definition at line 162 of file hal_can_lld.h.

Referenced by canObjectInit(), canStop(), and canTransmitTimeout().

rxqueue

threads_queue_t hal_can_driver::rxqueue

Receive threads queue.

Definition at line 166 of file hal_can_lld.h.

Referenced by canObjectInit(), canReceiveTimeout(), and canStop().

rxfull_event

event_source_t hal_can_driver::rxfull_event

One or more frames become available.

Note

After broadcasting this event it will not be broadcasted again until the received frames queue has been completely emptied. It is not broadcasted for each received frame. It is responsibility of the application to empty the queue by repeatedly invoking chReceive() when listening to this event. This behavior minimizes the interrupt served by the system because CAN traffic.

The flags associated to the listeners will indicate which receive mailboxes become non-empty.

Definition at line 180 of file hal_can_lld.h.

Referenced by canObjectInit().

txempty_event

event_source_t hal_can_driver::txempty_event

One or more transmission mailbox become available.

Note

The flags associated to the listeners will indicate which transmit mailboxes become empty.

Definition at line 186 of file hal_can_lld.h.

Referenced by canObjectInit().

error_event

event_source_t hal_can_driver::error_event

A CAN bus error happened.

Note

The flags associated to the listeners will indicate the error(s) that have occurred.

Definition at line 192 of file hal_can_lld.h.

Referenced by canObjectInit().

sleep_event

event_source_t hal_can_driver::sleep_event

Entering sleep state event.

Definition at line 197 of file hal_can_lld.h.

Referenced by canObjectInit(), and canSleep().

wakeup_event

event_source_t hal_can_driver::wakeup_event

Exiting sleep state event.

Definition at line 201 of file hal_can_lld.h.

Referenced by canObjectInit(), and canWakeup().