embassy-cortex-m: docs

This commit is contained in:
Dario Nieuwenhuis 2022-07-19 07:57:29 +02:00
parent e5d3f01bc4
commit 3fb83898bc
2 changed files with 10 additions and 0 deletions

View File

@ -211,6 +211,7 @@ const PRIO_MASK: u8 = 0xff;
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))] #[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[repr(u8)] #[repr(u8)]
#[allow(missing_docs)]
pub enum Priority { pub enum Priority {
P0 = 0x0, P0 = 0x0,
} }
@ -222,6 +223,7 @@ pub enum Priority {
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))] #[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[repr(u8)] #[repr(u8)]
#[allow(missing_docs)]
pub enum Priority { pub enum Priority {
P0 = 0x0, P0 = 0x0,
P1 = 0x80, P1 = 0x80,
@ -234,6 +236,7 @@ pub enum Priority {
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))] #[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[repr(u8)] #[repr(u8)]
#[allow(missing_docs)]
pub enum Priority { pub enum Priority {
P0 = 0x0, P0 = 0x0,
P1 = 0x40, P1 = 0x40,
@ -248,6 +251,7 @@ pub enum Priority {
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))] #[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[repr(u8)] #[repr(u8)]
#[allow(missing_docs)]
pub enum Priority { pub enum Priority {
P0 = 0x0, P0 = 0x0,
P1 = 0x20, P1 = 0x20,
@ -266,6 +270,7 @@ pub enum Priority {
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))] #[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[repr(u8)] #[repr(u8)]
#[allow(missing_docs)]
pub enum Priority { pub enum Priority {
P0 = 0x0, P0 = 0x0,
P1 = 0x10, P1 = 0x10,
@ -292,6 +297,7 @@ pub enum Priority {
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))] #[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[repr(u8)] #[repr(u8)]
#[allow(missing_docs)]
pub enum Priority { pub enum Priority {
P0 = 0x0, P0 = 0x0,
P1 = 0x8, P1 = 0x8,
@ -334,6 +340,7 @@ pub enum Priority {
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))] #[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[repr(u8)] #[repr(u8)]
#[allow(missing_docs)]
pub enum Priority { pub enum Priority {
P0 = 0x0, P0 = 0x0,
P1 = 0x4, P1 = 0x4,
@ -408,6 +415,7 @@ pub enum Priority {
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))] #[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[repr(u8)] #[repr(u8)]
#[allow(missing_docs)]
pub enum Priority { pub enum Priority {
P0 = 0x0, P0 = 0x0,
P1 = 0x2, P1 = 0x2,
@ -546,6 +554,7 @@ pub enum Priority {
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))] #[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[repr(u8)] #[repr(u8)]
#[allow(missing_docs)]
pub enum Priority { pub enum Priority {
P0 = 0x0, P0 = 0x0,
P1 = 0x1, P1 = 0x1,

View File

@ -1,5 +1,6 @@
//! Embassy executor and interrupt handling specific to cortex-m devices. //! Embassy executor and interrupt handling specific to cortex-m devices.
#![no_std] #![no_std]
#![warn(missing_docs)]
// This mod MUST go first, so that the others see its macros. // This mod MUST go first, so that the others see its macros.
pub(crate) mod fmt; pub(crate) mod fmt;