Skip to main content

Config

Struct Config 

Source
#[non_exhaustive]
pub struct Config { /* private fields */ }
Expand description

CAN FD driver configuration.

Implementations§

Source§

impl Config

Source

pub fn with_mode(self, mode: Mode) -> Self

Assign the given value to the mode field.

Source

pub fn mode(&self) -> Mode

Bus participation mode.

Default value: Mode::Normal.

Source

pub fn with_clock_source(self, clock_source: ClockSource) -> Self

Assign the given value to the clock_source field.

Source

pub fn clock_source(&self) -> ClockSource

Function clock source.

The TRM recommends ClockSource::Xtal up to 5 Mbit/s and ClockSource::PllF80m above that.

Default value: ClockSource::PllF80m.

Source

pub fn with_nominal_timing(self, nominal_timing: Timing) -> Self

Assign the given value to the nominal_timing field.

Source

pub fn nominal_timing(&self) -> Timing

Bit timing of the arbitration phase.

Default value: 500 kbit/s from an 80 MHz function clock.

Source

pub fn with_fd_timing(self, fd_timing: Timing) -> Self

Assign the given value to the fd_timing field.

Source

pub fn fd_timing(&self) -> Timing

Bit timing of the data phase, used by bit-rate-switched frames.

Default value: 2 Mbit/s from an 80 MHz function clock.

Source

pub fn with_retransmit_limit(self, retransmit_limit: u8) -> Self

Assign the given value to the retransmit_limit field.

Source

pub fn with_retransmit_limit_none(self) -> Self

Set the value of retransmit_limit to None.

Source

pub fn retransmit_limit(&self) -> Option<u8>

Number of retransmission attempts, or None to retry forever.

The first attempt is not a retransmission. The hardware holds at most MAX_RETRANSMIT_LIMIT.

Default value: Some(3).

Source

pub fn with_secondary_sample_point_offset( self, secondary_sample_point_offset: u8, ) -> Self

Assign the given value to the secondary_sample_point_offset field.

Source

pub fn with_secondary_sample_point_offset_none(self) -> Self

Set the value of secondary_sample_point_offset to None.

Source

pub fn secondary_sample_point_offset(&self) -> Option<u8>

Secondary sample point offset in time quanta, or None to disable it.

Default value: None.

Source

pub fn with_drop_request_frames(self, drop_request_frames: bool) -> Self

Assign the given value to the drop_request_frames field.

Source

pub fn drop_request_frames(&self) -> bool

Whether received request frames are dropped instead of stored.

Default value: false.

Source

pub fn with_protocol_exception(self, protocol_exception: bool) -> Self

Assign the given value to the protocol_exception field.

Source

pub fn protocol_exception(&self) -> bool

Whether protocol exception handling is enabled.

Default value: false.

Source

pub fn with_no_transceiver(self, no_transceiver: bool) -> Self

Assign the given value to the no_transceiver field.

Source

pub fn no_transceiver(&self) -> bool

Whether the TX pin is driven open-drain with a pull-up.

Lets two nodes be wired together directly, without transceivers. Binding the RX and TX signals to the same pin then forms a single-node bus.

Default value: false.

Trait Implementations§

Source§

impl Clone for Config

Available on crate feature unstable only.
Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable)§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Config

Available on crate feature unstable only.
Source§

impl Debug for Config

Available on crate feature unstable only.
Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Config

Available on crate feature unstable only.
Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for Config

Available on crate feature unstable only.
Source§

impl Hash for Config

Available on crate feature unstable only.
Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher]. Read more
1.3.0§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher]. Read more
Source§

impl PartialEq for Config

Available on crate feature unstable only.
Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable)§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Config

Available on crate feature unstable only.

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnsafeUnpin for Config

§

impl UnwindSafe for Config

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = !

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.