diff options
| author | Dario Nieuwenhuis <[email protected]> | 2022-07-19 07:57:29 +0200 |
|---|---|---|
| committer | Dario Nieuwenhuis <[email protected]> | 2022-07-19 07:58:29 +0200 |
| commit | 3fb83898bc2ed0c8c9eccdf17a4852457b0bcebb (patch) | |
| tree | f776d2ac275f9c82d2535dda994d3ccd95b50441 | |
| parent | e5d3f01bc444c257dbdfc75e504767e8e13d2a02 (diff) | |
embassy-cortex-m: docs
| -rw-r--r-- | embassy-cortex-m/src/interrupt.rs | 9 | ||||
| -rw-r--r-- | embassy-cortex-m/src/lib.rs | 1 |
2 files changed, 10 insertions, 0 deletions
diff --git a/embassy-cortex-m/src/interrupt.rs b/embassy-cortex-m/src/interrupt.rs index 8a63b18b1..715f00381 100644 --- a/embassy-cortex-m/src/interrupt.rs +++ b/embassy-cortex-m/src/interrupt.rs | |||
| @@ -211,6 +211,7 @@ const PRIO_MASK: u8 = 0xff; | |||
| 211 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] | 211 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] |
| 212 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] | 212 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] |
| 213 | #[repr(u8)] | 213 | #[repr(u8)] |
| 214 | #[allow(missing_docs)] | ||
| 214 | pub enum Priority { | 215 | pub enum Priority { |
| 215 | P0 = 0x0, | 216 | P0 = 0x0, |
| 216 | } | 217 | } |
| @@ -222,6 +223,7 @@ pub enum Priority { | |||
| 222 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] | 223 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] |
| 223 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] | 224 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] |
| 224 | #[repr(u8)] | 225 | #[repr(u8)] |
| 226 | #[allow(missing_docs)] | ||
| 225 | pub enum Priority { | 227 | pub enum Priority { |
| 226 | P0 = 0x0, | 228 | P0 = 0x0, |
| 227 | P1 = 0x80, | 229 | P1 = 0x80, |
| @@ -234,6 +236,7 @@ pub enum Priority { | |||
| 234 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] | 236 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] |
| 235 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] | 237 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] |
| 236 | #[repr(u8)] | 238 | #[repr(u8)] |
| 239 | #[allow(missing_docs)] | ||
| 237 | pub enum Priority { | 240 | pub enum Priority { |
| 238 | P0 = 0x0, | 241 | P0 = 0x0, |
| 239 | P1 = 0x40, | 242 | P1 = 0x40, |
| @@ -248,6 +251,7 @@ pub enum Priority { | |||
| 248 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] | 251 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] |
| 249 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] | 252 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] |
| 250 | #[repr(u8)] | 253 | #[repr(u8)] |
| 254 | #[allow(missing_docs)] | ||
| 251 | pub enum Priority { | 255 | pub enum Priority { |
| 252 | P0 = 0x0, | 256 | P0 = 0x0, |
| 253 | P1 = 0x20, | 257 | P1 = 0x20, |
| @@ -266,6 +270,7 @@ pub enum Priority { | |||
| 266 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] | 270 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] |
| 267 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] | 271 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] |
| 268 | #[repr(u8)] | 272 | #[repr(u8)] |
| 273 | #[allow(missing_docs)] | ||
| 269 | pub enum Priority { | 274 | pub enum Priority { |
| 270 | P0 = 0x0, | 275 | P0 = 0x0, |
| 271 | P1 = 0x10, | 276 | P1 = 0x10, |
| @@ -292,6 +297,7 @@ pub enum Priority { | |||
| 292 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] | 297 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] |
| 293 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] | 298 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] |
| 294 | #[repr(u8)] | 299 | #[repr(u8)] |
| 300 | #[allow(missing_docs)] | ||
| 295 | pub enum Priority { | 301 | pub enum Priority { |
| 296 | P0 = 0x0, | 302 | P0 = 0x0, |
| 297 | P1 = 0x8, | 303 | P1 = 0x8, |
| @@ -334,6 +340,7 @@ pub enum Priority { | |||
| 334 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] | 340 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] |
| 335 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] | 341 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] |
| 336 | #[repr(u8)] | 342 | #[repr(u8)] |
| 343 | #[allow(missing_docs)] | ||
| 337 | pub enum Priority { | 344 | pub enum Priority { |
| 338 | P0 = 0x0, | 345 | P0 = 0x0, |
| 339 | P1 = 0x4, | 346 | P1 = 0x4, |
| @@ -408,6 +415,7 @@ pub enum Priority { | |||
| 408 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] | 415 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] |
| 409 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] | 416 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] |
| 410 | #[repr(u8)] | 417 | #[repr(u8)] |
| 418 | #[allow(missing_docs)] | ||
| 411 | pub enum Priority { | 419 | pub enum Priority { |
| 412 | P0 = 0x0, | 420 | P0 = 0x0, |
| 413 | P1 = 0x2, | 421 | P1 = 0x2, |
| @@ -546,6 +554,7 @@ pub enum Priority { | |||
| 546 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] | 554 | #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] |
| 547 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] | 555 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] |
| 548 | #[repr(u8)] | 556 | #[repr(u8)] |
| 557 | #[allow(missing_docs)] | ||
| 549 | pub enum Priority { | 558 | pub enum Priority { |
| 550 | P0 = 0x0, | 559 | P0 = 0x0, |
| 551 | P1 = 0x1, | 560 | P1 = 0x1, |
diff --git a/embassy-cortex-m/src/lib.rs b/embassy-cortex-m/src/lib.rs index 680c2c8db..fba23367b 100644 --- a/embassy-cortex-m/src/lib.rs +++ b/embassy-cortex-m/src/lib.rs | |||
| @@ -1,5 +1,6 @@ | |||
| 1 | //! Embassy executor and interrupt handling specific to cortex-m devices. | 1 | //! Embassy executor and interrupt handling specific to cortex-m devices. |
| 2 | #![no_std] | 2 | #![no_std] |
| 3 | #![warn(missing_docs)] | ||
| 3 | 4 | ||
| 4 | // This mod MUST go first, so that the others see its macros. | 5 | // This mod MUST go first, so that the others see its macros. |
| 5 | pub(crate) mod fmt; | 6 | pub(crate) mod fmt; |
