Struct can_bit_timings_core::CanBitTiming

pub struct CanBitTiming {
    pub bs1: u8,
    pub bs2: u8,
    pub sjw: u8,
    pub prescaler: u16,
}

This struct holds parts of bit timing for CAN. Field descriptions quote descriptions from this site.

Fields

bs1: u8

bs1 = PROP_SEG + PHASE_SEG1

PROP_SEG is programmable to be 1, 2,... 8 Time Quanta long. It is used to compensate for signal delays across the network.

PHASE_SEG1 is programmable to be 1,2, ... 8 Time Quanta long. It is used to compensate for edge phase errors and may be lengthened during resynchronization.

bs2: u8

bs2 = PHASE_SEG2 (Seg 2) is the maximum of PHASE_SEG1 and the Information Processing Time long. It is also used to compensate edge phase errors and may be shortened during resynchronization. For this the minimum value of PHASE_SEG2 is the value of SJW. Information Processing Time is less than or equal to 2 Time Quanta long.

sjw: u8

Synchronization Jump Width

prescaler: u16

Prescaler value

Implementations

impl CanBitTiming

pub fn bxcan(&self) -> u32

Converts CanBitTiming struct to a u32 register as used by bxcan module.

pub fn total_time_quanta(&self) -> u16

Outputs total time quanta used to clock a CAN bus module

Trait Implementations

impl Clone for CanBitTiming

fn clone(&self) -> CanBitTiming

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for CanBitTiming

impl Debug for CanBitTiming

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CanBitTiming> for CanBitTiming

fn eq(&self, other: &CanBitTiming) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CanBitTiming) -> bool

This method tests for !=.

impl PartialOrd<CanBitTiming> for CanBitTiming

fn partial_cmp(&self, other: &CanBitTiming) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for CanBitTiming