Skip to main content

USB_HS

Struct USB_HS 

Source
#[non_exhaustive]
pub struct USB_HS<'a> { /* private fields */ }
Available on crate feature unstable only.
Expand description

USB_HS peripheral singleton

§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Implementations§

Source§

impl USB_HS<'_>

Source

pub unsafe fn steal() -> Self

Unsafely create an instance of this peripheral out of thin air.

§Safety

You must ensure that you’re only using one instance of this type at a time.

Source

pub unsafe fn clone_unchecked(&self) -> Self

Unsafely clone this peripheral reference.

§Safety

You must ensure that you’re only using one instance of this type at a time.

Source

pub fn reborrow(&mut self) -> USB_HS<'_>

Creates a new peripheral reference with a shorter lifetime.

Use this method if you would like to keep working with the peripheral after you dropped the driver that consumes this.

Source

pub fn bind_peri_interrupt(&self, handler: InterruptHandler)

Binds an interrupt handler to the corresponding interrupt for this peripheral, and enables the interrupt.

This function is a very low-level way to work with interrupts. Unless you're writing drivers, this is probably not the interrupt API you want to use.
§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Source

pub fn enable_peri_interrupt(&self, priority: Priority)

Enables the USB_OTG_HS peripheral interrupt on the given priority level.

This function is a very low-level way to work with interrupts. Unless you're writing drivers, this is probably not the interrupt API you want to use.
The interrupt handler will be enabled on the core that calls this function.

Note that a suitable interrupt handler needs to be set up before the first interrupt is triggered, otherwise the default handler will panic. To set up an interrupt handler, use Self::bind_peri_interrupt or create a function that has the same (non-mangled) name as the interrupt you want to handle.

§Examples
use esp_hal::interrupt::Priority;

#[unsafe(no_mangle)]
unsafe extern "C" fn USB_OTG_HS() {
    // do something
}

peripherals.USB_HS.enable_peri_interrupt(Priority::Priority1);
peripherals.USB_HS.disable_peri_interrupt_on_all_cores();
Source

pub fn disable_peri_interrupt(&self)

Disables the USB_OTG_HS peripheral interrupt handler on the current CPU core.

This function is a very low-level way to work with interrupts. Unless you're writing drivers, this is probably not the interrupt API you want to use.
# Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Source

pub fn disable_peri_interrupt_on_all_cores(&self)

Disables the USB_OTG_HS peripheral interrupt handler on all cores.

This function is a very low-level way to work with interrupts. Unless you're writing drivers, this is probably not the interrupt API you want to use.
Source§

impl USB_HS<'_>

Source

pub const PTR: *const <USB_OTG_HS as Deref>::Target = pac::USB_OTG_HS::PTR

Pointer to the register block

§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Source

pub const fn ptr() -> *const <USB_OTG_HS as Deref>::Target

Return the pointer to the register block

§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Source

pub fn regs<'a>() -> &'a <USB_OTG_HS as Deref>::Target

Return a reference to the register block

§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Source

pub fn register_block(&self) -> &<USB_OTG_HS as Deref>::Target

Return a reference to the register block

§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Trait Implementations§

Source§

impl<'a> Debug for USB_HS<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> !UnwindSafe for USB_HS<'a>

§

impl<'a> Freeze for USB_HS<'a>

§

impl<'a> RefUnwindSafe for USB_HS<'a>

§

impl<'a> Send for USB_HS<'a>

§

impl<'a> Sync for USB_HS<'a>

§

impl<'a> Unpin for USB_HS<'a>

§

impl<'a> UnsafeUnpin for USB_HS<'a>

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.