pub struct Function<T, S> { /* private fields */ }Expand description
A fixed or movable function that can be assigned to a pin
The type parameter T identifies the fixed or movable function that an
instance of Function controls. The other type paramter, State, tracks
whether this function is assigned to a pin, and which pin it is assigned to.
You can gain access to the instances of this struct that represent fixed
functions through FixedFunctions, to those that represent movable
functions through MovableFunctions.
Implementations§
Source§impl<T> Function<T, Unassigned>
impl<T> Function<T, Unassigned>
Sourcepub fn assign<P, S>(
self,
pin: Pin<P, S>,
swm: &mut Handle,
) -> (Function<T, Assigned<P>>, <Pin<P, S> as AssignFunction<T, T::Kind>>::Assigned)
pub fn assign<P, S>( self, pin: Pin<P, S>, swm: &mut Handle, ) -> (Function<T, Assigned<P>>, <Pin<P, S> as AssignFunction<T, T::Kind>>::Assigned)
Assign this function to a pin
This method is only available if a number of requirements are met:
Functionmust be in theUnassignedstate, as a function can only be assigned to one pin.- The
Pinmust be in the SWM state (pins::state::Swm). See documentation onPinfor information on pin state management. - The function must be assignable to the pin. Movable functions can be assigned to any pin, but fixed functions can be assigned to only one specific pin.
- The state of the pin must allow another function of this type to be assigned. Input functions can always be assigned, but only one output or bidirectional function can be assigned to a given pin at any time.
Code attempting to call this method while these requirement are not met, will not compile.
Consumes this instance of Function, as well as the provided Pin,
and returns new instances. The returned Function instance will have its
state set to indicate that it has been assigned to the pin. The returned
Pin will have its state updated to indicate that a function of this
Function’s type has been assigned.
§Examples
Assign one output and one input function to the same pin:
use lpc8xx_hal::Peripherals;
let p = Peripherals::take().unwrap();
let mut syscon = p.SYSCON.split();
let mut swm = p.SWM.split();
#[cfg(feature = "82x")]
let mut swm_handle = swm.handle;
#[cfg(feature = "845")]
let mut swm_handle = swm.handle.enable(&mut syscon.handle);
// Assign output function to a pin
let (u0_txd, pio0_0) = swm.movable_functions.u0_txd.assign(
p.pins.pio0_0.into_swm_pin(),
&mut swm_handle,
);
// Assign input function to the same pin
let (u1_rxd, pio0_0) = swm.movable_functions.u1_rxd.assign(
pio0_0,
&mut swm_handle,
);Source§impl<T, P> Function<T, Assigned<P>>
impl<T, P> Function<T, Assigned<P>>
Sourcepub fn unassign<S>(
self,
pin: Pin<P, S>,
swm: &mut Handle,
) -> (Function<T, Unassigned>, <Pin<P, S> as UnassignFunction<T, T::Kind>>::Unassigned)
pub fn unassign<S>( self, pin: Pin<P, S>, swm: &mut Handle, ) -> (Function<T, Unassigned>, <Pin<P, S> as UnassignFunction<T, T::Kind>>::Unassigned)
Unassign this function from a pin
This method is only available if a number of requirements are met:
- The function must be assigned to the provided pin. This means
Functionmust be in theAssignedstate, and the type parameter ofAssignedmust indicate that the function is assigned to the same pin that is provided as an argument. - The
Pinmust be in the SWM state (pins::state::Swm), and the state must indicate that a function of thisFunction’s type is currently assigned. This should always be the case, if the previous condition is met, as it should be impossible to create inconsistent states betweenFunctions andPins without usingunsafe.
Code attempting to call this method while these requirement are not met, will not compile.
Consumes this instance of Function, as well as the provided Pin,
and returns new instances. The returned Function instance will have
its state set to indicate that it is no longer assigned to a pin. The
returned Pin will have its state updated to indicate that one fewer
function of this type is now assigned.
§Examples
Unassign a function that has been previously assigned to a pin:
// U0_TXD must have been previously assigned to the pin, or the
// following code will not compile. See documentation of
// `Function::assign`.
let (u0_txd, pio0_0) = u0_txd.unassign(pio0_0, &mut swm_handle);