diff options
| author | James Munns <[email protected]> | 2025-04-03 10:35:00 +0200 |
|---|---|---|
| committer | James Munns <[email protected]> | 2025-04-03 10:35:00 +0200 |
| commit | b7e1b1ca941b3b92dede55f2a5b65fcad788ce42 (patch) | |
| tree | c184af8c541e55fa4a9b5aba12808747df0fe016 /embassy-executor/src/arch | |
| parent | 45c4f0cb0590453009994d765cde604a082d4588 (diff) | |
Fix some intra-doc links
Diffstat (limited to 'embassy-executor/src/arch')
| -rw-r--r-- | embassy-executor/src/arch/cortex_m.rs | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/embassy-executor/src/arch/cortex_m.rs b/embassy-executor/src/arch/cortex_m.rs index 5c517e0a2..1c9ddd8a0 100644 --- a/embassy-executor/src/arch/cortex_m.rs +++ b/embassy-executor/src/arch/cortex_m.rs | |||
| @@ -143,7 +143,7 @@ mod interrupt { | |||
| 143 | /// If this is not the case, you may use an interrupt from any unused peripheral. | 143 | /// If this is not the case, you may use an interrupt from any unused peripheral. |
| 144 | /// | 144 | /// |
| 145 | /// It is somewhat more complex to use, it's recommended to use the thread-mode | 145 | /// It is somewhat more complex to use, it's recommended to use the thread-mode |
| 146 | /// [`Executor`] instead, if it works for your use case. | 146 | /// [`Executor`](crate::Executor) instead, if it works for your use case. |
| 147 | pub struct InterruptExecutor { | 147 | pub struct InterruptExecutor { |
| 148 | started: Mutex<Cell<bool>>, | 148 | started: Mutex<Cell<bool>>, |
| 149 | executor: UnsafeCell<MaybeUninit<raw::Executor>>, | 149 | executor: UnsafeCell<MaybeUninit<raw::Executor>>, |
| @@ -179,11 +179,11 @@ mod interrupt { | |||
| 179 | /// The executor keeps running in the background through the interrupt. | 179 | /// The executor keeps running in the background through the interrupt. |
| 180 | /// | 180 | /// |
| 181 | /// This returns a [`SendSpawner`] you can use to spawn tasks on it. A [`SendSpawner`] | 181 | /// This returns a [`SendSpawner`] you can use to spawn tasks on it. A [`SendSpawner`] |
| 182 | /// is returned instead of a [`Spawner`](embassy_executor::Spawner) because the executor effectively runs in a | 182 | /// is returned instead of a [`Spawner`](crate::Spawner) because the executor effectively runs in a |
| 183 | /// different "thread" (the interrupt), so spawning tasks on it is effectively | 183 | /// different "thread" (the interrupt), so spawning tasks on it is effectively |
| 184 | /// sending them. | 184 | /// sending them. |
| 185 | /// | 185 | /// |
| 186 | /// To obtain a [`Spawner`](embassy_executor::Spawner) for this executor, use [`Spawner::for_current_executor()`](embassy_executor::Spawner::for_current_executor()) from | 186 | /// To obtain a [`Spawner`](crate::Spawner) for this executor, use [`Spawner::for_current_executor()`](crate::Spawner::for_current_executor()) from |
| 187 | /// a task running in it. | 187 | /// a task running in it. |
| 188 | /// | 188 | /// |
| 189 | /// # Interrupt requirements | 189 | /// # Interrupt requirements |
| @@ -195,6 +195,7 @@ mod interrupt { | |||
| 195 | /// You must set the interrupt priority before calling this method. You MUST NOT | 195 | /// You must set the interrupt priority before calling this method. You MUST NOT |
| 196 | /// do it after. | 196 | /// do it after. |
| 197 | /// | 197 | /// |
| 198 | /// [`SendSpawner`]: crate::SendSpawner | ||
| 198 | pub fn start(&'static self, irq: impl InterruptNumber) -> crate::SendSpawner { | 199 | pub fn start(&'static self, irq: impl InterruptNumber) -> crate::SendSpawner { |
| 199 | if critical_section::with(|cs| self.started.borrow(cs).replace(true)) { | 200 | if critical_section::with(|cs| self.started.borrow(cs).replace(true)) { |
| 200 | panic!("InterruptExecutor::start() called multiple times on the same executor."); | 201 | panic!("InterruptExecutor::start() called multiple times on the same executor."); |
| @@ -215,7 +216,7 @@ mod interrupt { | |||
| 215 | 216 | ||
| 216 | /// Get a SendSpawner for this executor | 217 | /// Get a SendSpawner for this executor |
| 217 | /// | 218 | /// |
| 218 | /// This returns a [`SendSpawner`] you can use to spawn tasks on this | 219 | /// This returns a [`SendSpawner`](crate::SendSpawner) you can use to spawn tasks on this |
| 219 | /// executor. | 220 | /// executor. |
| 220 | /// | 221 | /// |
| 221 | /// This MUST only be called on an executor that has already been started. | 222 | /// This MUST only be called on an executor that has already been started. |
