pub struct Reg<U, REG> { /* private fields */ }Expand description
This structure provides volatile access to registers.
Implementations§
Source§impl<U, REG> Reg<U, REG>
impl<U, REG> Reg<U, REG>
Sourcepub fn read(&self) -> R<U, Self>
pub fn read(&self) -> R<U, Self>
Reads the contents of a Readable register.
You can read the raw contents of a register by using bits:
ⓘ
let bits = periph.reg.read().bits();or get the content of a particular field of a register:
ⓘ
let reader = periph.reg.read();
let bits = reader.field1().bits();
let flag = reader.field2().bit_is_set();Source§impl<U, REG> Reg<U, REG>
impl<U, REG> Reg<U, REG>
Sourcepub fn write<F>(&self, f: F)
pub fn write<F>(&self, f: F)
Writes bits to a Writable register.
You can write raw bits into a register:
ⓘ
periph.reg.write(|w| unsafe { w.bits(rawbits) });or write only the fields you need:
ⓘ
periph.reg.write(|w| w
.field1().bits(newfield1bits)
.field2().set_bit()
.field3().variant(VARIANT)
);In the latter case, other fields will be set to their reset value.
Source§impl<U, REG> Reg<U, REG>
impl<U, REG> Reg<U, REG>
Sourcepub fn write_with_zero<F>(&self, f: F)
pub fn write_with_zero<F>(&self, f: F)
Writes 0 to a Writable register.
Similar to write, but unused bits will contain 0.
Source§impl<U, REG> Reg<U, REG>
impl<U, REG> Reg<U, REG>
Sourcepub fn modify<F>(&self, f: F)
pub fn modify<F>(&self, f: F)
Modifies the contents of the register by reading and then writing it.
E.g. to do a read-modify-write sequence to change parts of a register:
ⓘ
periph.reg.modify(|r, w| unsafe { w.bits(
r.bits() | 3
) });or
ⓘ
periph.reg.modify(|_, w| w
.field1().bits(newfield1bits)
.field2().set_bit()
.field3().variant(VARIANT)
);Other fields will have the value they had before the call to modify.
Trait Implementations§
Auto Trait Implementations§
impl<U, REG> !Freeze for Reg<U, REG>
impl<U, REG> !RefUnwindSafe for Reg<U, REG>
impl<U, REG> !Sync for Reg<U, REG>
impl<U, REG> Unpin for Reg<U, REG>
impl<U, REG> UnwindSafe for Reg<U, REG>where
REG: UnwindSafe,
U: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more